com.aquenos.cassandra.pvarchiver.server.web.admin.controller

Class UiController

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.web.admin.controller.UiController

@Controller
 @RequestMapping(value="/admin/ui")
public class UiController
extends Object

Controller handling requests to the administrative user-interface. This controller exposes the interface through the /admin/ui URI.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
UiController()

Method Summary

Modifier and Type	Method and Description
ModelAndView	about() Returns the about view.
ModelAndView	accountChangePasswordGet() Returns the change-password view with an empty form.
ModelAndView	accountChangePasswordPost(com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.ChangePasswordForm form, BindingResult formBindingResult) Processes the change-password form and returns the change-password view.
ModelAndView	accountSignIn(Authentication authentication) Returns the sign-in view.
ModelAndView	accountSignOut(Authentication authentication) Returns the sign-out view.
ModelAndView	channelAddGet() Returns the channel-add view.
ModelAndView	channelAddPost(com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.AddChannelForm form, BindingResult formBindingResult, HttpServletResponse response) Processes a form submitted from the channel-add view.
ModelAndView	channelByServerAddGet(UUID serverIdFromPath, HttpServletResponse response) Returns the channel-add view.
ModelAndView	channelByServerAddPost(UUID serverIdFromPath, com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.AddChannelForm form, BindingResult formBindingResult, HttpServletResponse response) Processes a form submitted from the channel-add view.
ModelAndView	channelByServerDetails(UUID serverId, String channelName, HttpServletResponse response) Returns the channel-details view.
ModelAndView	channelByServerEditGet(UUID serverId, String channelName, HttpServletResponse response) Returns the channel-edit view.
ModelAndView	channelByServerEditPost(UUID serverId, String channelName, com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.EditChannelForm form, BindingResult formBindingResult, HttpServletResponse response) Processes a form submitted from the channel-edit view.
ModelAndView	channelByServerMoveGet(UUID serverId, String channelName, HttpServletResponse response) Returns the channel-move view.
ModelAndView	channelByServerMovePost(UUID serverId, String channelName, UUID oldServerId, UUID newServerId, HttpServletResponse response) Processes a form submitted from the channel-move view.
ModelAndView	channelByServerReinitialize(UUID serverId, String channelName, HttpServletResponse response) Reinitializes a channel.
ModelAndView	channelByServerRemoveGet(UUID serverId, String channelName, HttpServletResponse response) Returns the channel-remove view.
ModelAndView	channelByServerRemovePost(UUID serverId, String channelName, HttpServletResponse response) Processes a form submitted from the channel-remove view.
ModelAndView	channelByServerRenameGet(UUID serverId, String channelName, HttpServletResponse response) Returns the channel-rename view.
ModelAndView	channelByServerRenamePost(UUID serverId, String oldChannelName, String newChannelName, HttpServletResponse response) Processes a form submitted from the channel-rename view.
ModelAndView	channelDetails(String channelName, HttpServletResponse response) Returns the channel-details view.
ModelAndView	channelEditGet(String channelName, HttpServletResponse response) Returns the channel-edit view.
ModelAndView	channelEditPost(String channelName, com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.EditChannelForm form, BindingResult formBindingResult, HttpServletResponse response) Processes a form submitted from the channel-edit view.
ModelAndView	channelMoveGet(String channelName, HttpServletResponse response) Returns the channel-move view.
ModelAndView	channelMovePost(String channelName, UUID oldServerId, UUID newServerId, HttpServletResponse response) Processes a form submitted from the channel-move view.
ModelAndView	channelReinitialize(String channelName, HttpServletResponse response) Reinitializes a channel.
ModelAndView	channelRemoveGet(String channelName, HttpServletResponse response) Returns the channel-remove view.
ModelAndView	channelRemovePost(String channelName, HttpServletResponse response) Processes a form submitted from the channel-remove view.
ModelAndView	channelRenameGet(String channelName, HttpServletResponse response) Returns the channel-rename view.
ModelAndView	channelRenamePost(String oldChannelName, String newChannelName, HttpServletResponse response) Processes a form submitted from the channel-rename view.
ModelAndView	channels(HttpServletResponse response) Returns the channels-overview view.
ModelAndView	channelsAll() Returns the all channels view.
ModelAndView	channelsByServer(UUID serverId, HttpServletResponse response) Returns the channels-by-server view.
ModelAndView	channelsByServerExport(UUID serverId, HttpServletResponse response) Returns an XML export of the channel configuration for the specified server.
ModelAndView	channelsByServerImportGet(UUID serverId) Returns the channels-import view.
ModelAndView	channelsByServerImportPost(UUID serverId, MultipartFile file, boolean addChannels, boolean updateChannels, boolean removeChannels) Processes a form submitted from the channels-import view.
ModelAndView	dashboard() Returns the dashboard view.
void	initBinder(WebDataBinder binder) Configures the web data-binder used for this controller.
ModelAndView	serversRemove(UUID serverId, HttpServletResponse response) Removes the specified server from the cluster.
void	setArchiveConfigurationService(ArchiveConfigurationService archiveConfigurationService) Sets the archive configuration service used by this controller.
void	setArchiveUserDetailsManager(ArchiveUserDetailsManager archiveUserDetailsManager) Sets the archive user-details manager.
void	setArchivingService(ArchivingService archivingService) Sets the archiving service.
void	setCassandraProvider(CassandraProvider cassandraProvider) Sets the Cassandra provider used by this controller.
void	setChannelInformationCache(ChannelInformationCache channelInformationCache) Sets the channel information cache.
void	setChannelMetaDataDAO(ChannelMetaDataDAO channelMetaDataDAO) Sets the DAO for reading and modifying meta-data related to channels.
void	setClusterManagementService(ClusterManagementService clusterManagementService) Sets the cluster management service used by this controller.
void	setControlSystemSupportRegistry(ControlSystemSupportRegistry controlSystemSupportRegistry) Sets the control-system support registry.
void	setInterNodeCommunicationService(InterNodeCommunicationService interNodeCommunicationService) Sets the inter-node communication service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UiController

public UiController()

Method Detail

setArchiveConfigurationService

@Autowired
public void setArchiveConfigurationService(ArchiveConfigurationService archiveConfigurationService)

Sets the archive configuration service used by this controller. The archive configuration service is used to make changes to the archive configuration when requested by the user. Typically, this method is called automatically by the Spring container.

Parameters:

archiveConfigurationService - archive configuration service for this server.

setArchiveUserDetailsManager

@Autowired
public void setArchiveUserDetailsManager(ArchiveUserDetailsManager archiveUserDetailsManager)

Sets the archive user-details manager. The archive user-details manager is used for changing the user's password when requested by the user. Typically, this method is called automatically by the Spring container.

Parameters:

archiveUserDetailsManager - archive user-details manager that manages the users for the archiving cluster.

setArchivingService

@Autowired
public void setArchivingService(ArchivingService archivingService)

Sets the archiving service. The archiving service is used to display the current archiving status. Typically, this method is called automatically by the Spring container.

Parameters:

archivingService - archiving service for this server.

setCassandraProvider

@Autowired
public void setCassandraProvider(CassandraProvider cassandraProvider)

Sets the Cassandra provider used by this controller. The Cassandra provider is used to get information about the server's connection to the database. Typically, this method is called automatically by the Spring container.

Parameters:

cassandraProvider - Cassandra provider used by the archiving server.

setChannelInformationCache

@Autowired
public void setChannelInformationCache(ChannelInformationCache channelInformationCache)

Sets the channel information cache. The cache is used for reading ChannelMetaDataDAO.ChannelInformation objects from the database without having to query the database every time. Typically, this method is called automatically by the Spring container.

Parameters:

channelInformationCache - channel information cache for getting ChannelMetaDataDAO.ChannelInformation objects.

setChannelMetaDataDAO

@Autowired
public void setChannelMetaDataDAO(ChannelMetaDataDAO channelMetaDataDAO)

Sets the DAO for reading and modifying meta-data related to channels. The controller uses this DAO to read information about channels if the service usually used for retrieving this information is temporarily not available. Typically, this method is called automatically by the Spring container.

Parameters:

channelMetaDataDAO - channel meta-data DAO to be used by this object.

setClusterManagementService

@Autowired
public void setClusterManagementService(ClusterManagementService clusterManagementService)

Sets the cluster management service used by this controller. The cluster management service is used to get information about the cluster status and to remove servers from the cluster when requested by the user. Typically, this method is called automatically by the Spring container.

Parameters:

clusterManagementService - cluster manager used by the archiving server.

setControlSystemSupportRegistry

@Autowired
public void setControlSystemSupportRegistry(ControlSystemSupportRegistry controlSystemSupportRegistry)

Sets the control-system support registry. The registry is used to gain access to the control-system supports available on this archiving server. Typically, this method is called automatically by the Spring container.

Parameters:

controlSystemSupportRegistry - control-system support registry for this archiving server.

setInterNodeCommunicationService

@Autowired
public void setInterNodeCommunicationService(InterNodeCommunicationService interNodeCommunicationService)

Sets the inter-node communication service. The inter-node communication service is needed to communicate with other servers in the cluster when displaying status information for them. Typically, this method is called automatically by the Spring container.

Parameters:

interNodeCommunicationService - inter-node communication service.

dashboard

@RequestMapping(value="/")
public ModelAndView dashboard()

Returns the dashboard view.

Returns:

dashboard view and associated model parameters.

initBinder

@InitBinder
public void initBinder(WebDataBinder binder)

Configures the web data-binder used for this controller. The data binder is used by Spring when binding request parameters to bean properties. This method replaces the validators of the binder with its own implementation that effectively wraps each validator, running some extra actions before and after the validation.

If this custom validator detects a target bean of a certain type, it will run some preparations before the regular validator is run. This way, the controller can deal with requests that do not fulfill all the constraints of the target bean but can easily and automatically be adjusted. After running the original validator, it will perform some extra validation that must pass in addition to the validation performed by the standard validators.

Parameters:

binder - data binder that is augmented with the custom validator implementation.

about

@RequestMapping(value="/about",
                method=GET)
public ModelAndView about()

Returns the about view.

Returns:

about view and associated model parameters.

accountChangePasswordGet

@RequestMapping(value="/account/change-password",
                method=GET)
 @Secured(value="ROLE_AUTHENTICATED_USER")
public ModelAndView accountChangePasswordGet()

Returns the change-password view with an empty form.

Returns:

change-password view with empty form.

accountChangePasswordPost

@RequestMapping(value="/account/change-password",
                method=POST)
 @Secured(value="ROLE_AUTHENTICATED_USER")
public ModelAndView accountChangePasswordPost(@ModelAttribute(value="form")
                                                                                                                                                                        com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.ChangePasswordForm form,
                                                                                                                                                                        BindingResult formBindingResult)

Processes the change-password form and returns the change-password view. If the form data has no errors, an attempt to change the password is made. When this attempt is successful, this is indicated by a flag in the model. Otherwise, the formBindingResult is populated with a message that indicates the origin of the problem.

Parameters:

form - change-password form.

formBindingResult - form-binding result for the change-password form. This binding result is already prepopulated with the results of the annotation-based validation of the form. It is augmented with the results of the additional checks performed by this method.

Returns:

change-password and the associated model.

accountSignIn

@RequestMapping(value="/account/sign-in",
                method=GET)
public ModelAndView accountSignIn(Authentication authentication)

Returns the sign-in view. This view presents a form for signing in. The actual sign-in process is not handled by this method but handled by a filter. If the user is already logged in (the authentication is not anonymous), this method redirects to the dashboard.

Parameters:

authentication - authentication object representing the current authentication.

Returns:

sign-in view or redirect to the dashboard, depending on the current authentication state.

accountSignOut

@RequestMapping(value="/account/sign-out",
                method=GET)
public ModelAndView accountSignOut(Authentication authentication)

Returns the sign-out view. This view presents a form signing out. The actual sign-out process is not handled by this method but handled by a filter. If the user is already logged out (the authentication is null or anonymous), this method redirects to the sign-in page.

Parameters:

authentication - authentication object representing the current authentication.

Returns:

sign-out view or redirect to the sign-in page, depending on the current authentication state.

channels

@RequestMapping(value="/channels",
                method=GET)
public ModelAndView channels(HttpServletResponse response)

Returns the channels-overview view. The channels overview presents all servers with information about their channels.

Parameters:

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the details view cannot be gathered successfully.

Returns:

channels-overview view and associated model parameters.

channelsAll

@RequestMapping(value="/channels/all",
                method=GET)
public ModelAndView channelsAll()

Returns the all channels view. This view presents all channels, regardless of the server they belong to.

Returns:

all channels view and associated model parameters.

channelsByServer

@RequestMapping(value="/channels/by-server/{serverId}",
                method=GET)
public ModelAndView channelsByServer(@PathVariable
                                                                                                                         UUID serverId,
                                                                                                                         HttpServletResponse response)

Returns the channels-by-server view. This view presents all the channels that belong to a server with their status.

Parameters:

serverId - ID of the server for which the channels are to be displayed.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the details view cannot be gathered successfully.

Returns:

channels-by-server view and associated model parameters.

channelsByServerExport

@RequestMapping(value="/channels/by-server/{serverId}/export",
                method=GET)
public ModelAndView channelsByServerExport(@PathVariable
                                                                                                                                      UUID serverId,
                                                                                                                                      HttpServletResponse response)

Returns an XML export of the channel configuration for the specified server. If the channel configuration cannot be loaded, this method redirects to the channels-by-server view.

Parameters:

serverId - ID of the server for which the channel configuration shall be exported.

response - HTTP servlet response. On success, this method writes the XML document directly to the response.

Returns:

null on success, redirect to channel-details view on error.

channelsByServerImportGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/import",
                method=GET)
public ModelAndView channelsByServerImportGet(@PathVariable
                                                                                                                                                                       UUID serverId)

Returns the channels-import view.

Parameters:

serverId - ID of the server for which channels shall be imported. This method does not check whether the server actually exists because there might be reasons to import channels for a server that does not exist yet.

Returns:

channels-import view and associated model paramters.

channelsByServerImportPost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/import",
                method=POST)
public ModelAndView channelsByServerImportPost(@PathVariable
                                                                                                                                                                         UUID serverId,
                                                                                                                                                                         @RequestParam(required=false)
                                                                                                                                                                         MultipartFile file,
                                                                                                                                                                         @RequestParam(defaultValue="false")
                                                                                                                                                                         boolean addChannels,
                                                                                                                                                                         @RequestParam(defaultValue="false")
                                                                                                                                                                         boolean updateChannels,
                                                                                                                                                                         @RequestParam(defaultValue="false")
                                                                                                                                                                         boolean removeChannels)

Processes a form submitted from the channels-import view. After successfully processing the form data and importing the channels, the channels-import view is returned with the results of the import operation. If there is a problem with the form data, the channels-import view is shown again with the form and appropriate error messages.

Parameters:

serverId - ID of the server for which channels shall be imported. This method does not check whether the server actually exists because there might be reasons to import channels for a server that does not exist yet.

file - uploaded configuration file. This file is processed by ArchiveServerConfigurationXmlImport.

addChannels - tells whether channels should be added to the server configuration. If true channels that exist in the configuration file but not on the server are added. If false channels that exist in the configuration file but not on the server are not added.

updateChannels - tells whether channels on the server should be updated. If true, channels that exist in the configuration file and on the server are updated with the configuration specified in the configuration file. If false, channels in the configuration file that also exist on the server are not touched.

removeChannels - tells whether channels that only exist on the server should be removed. If true, channels that exist on the server but not in the configuration file are removed. If false, channels that exist on the server but not in the configuration file are simply ignored.

Returns:

channels-import view and associated model paramters.

channelAddGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/add",
                method=GET)
public ModelAndView channelAddGet()

Returns the channel-add view.

Returns:

channel-add view and associated model parameters.

channelAddPost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/add",
                method=POST)
public ModelAndView channelAddPost(@ModelAttribute(value="form")
                                                                                                                                         com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.AddChannelForm form,
                                                                                                                                         BindingResult formBindingResult,
                                                                                                                                         HttpServletResponse response)

Processes a form submitted from the channel-add view. In case of error, the channel-add view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

form - bean storing the form data.

formBindingResult - validation result of the form bean.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-add view on error. In case of a severe error that results in an error page to be sent directly, null is returned.

channelDetails

@RequestMapping(value="/channels/all/by-name/{channelName}",
                method=GET)
public ModelAndView channelDetails(@PathVariable
                                                                                                                            String channelName,
                                                                                                                            HttpServletResponse response)

Returns the channel-details view. This view presents the status and the configuration of a specific channel. This method is used when a channel is accessed from the "all channels" list.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the details view cannot be gathered successfully.

Returns:

channel-details view and associated model parameters.

See Also:

channelByServerDetails(UUID, String, HttpServletResponse)

channelEditGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/edit",
                method=GET)
public ModelAndView channelEditGet(@PathVariable
                                                                                                                                                               String channelName,
                                                                                                                                                               HttpServletResponse response)

Returns the channel-edit view.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the edit view cannot be gathered successfully.

Returns:

channel-edit view and associated model parameters.

channelEditPost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/edit",
                method=POST)
public ModelAndView channelEditPost(@PathVariable
                                                                                                                                                                 String channelName,
                                                                                                                                                                 @ModelAttribute(value="form")
                                                                                                                                                                 com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.EditChannelForm form,
                                                                                                                                                                 BindingResult formBindingResult,
                                                                                                                                                                 HttpServletResponse response)

Processes a form submitted from the channel-edit view. In case of error, the channel-edit view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

channelName - name of the channel.

form - bean storing the form data.

formBindingResult - validation result of the form bean.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-edit view on error.

channelMoveGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/move",
                method=GET)
public ModelAndView channelMoveGet(@PathVariable
                                                                                                                                                               String channelName,
                                                                                                                                                               HttpServletResponse response)

Returns the channel-move view.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-move view cannot be gathered successfully.

Returns:

channel-move view and associated model parameters.

channelMovePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/move",
                method=POST)
public ModelAndView channelMovePost(@PathVariable
                                                                                                                                                                 String channelName,
                                                                                                                                                                 @RequestParam
                                                                                                                                                                 UUID oldServerId,
                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                 UUID newServerId,
                                                                                                                                                                 HttpServletResponse response)

Processes a form submitted from the channel-move view. In case of error, the channel-move view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

channelName - old name of the channel.

oldServerId - ID of the server from which the channel shall be moved.

newServerId - ID of the server to which the channel shall be moved.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-move view on error.

channelReinitialize

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/reinitialize",
                method=POST)
public ModelAndView channelReinitialize(@PathVariable
                                                                                                                                                                             String channelName,
                                                                                                                                                                             HttpServletResponse response)

Reinitializes a channel. In case of error, the reinitialize-channel view is shown. On success, the user is redirected to the channel-details view.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-reinitialize view on error.

channelRemoveGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/remove",
                method=GET)
public ModelAndView channelRemoveGet(@PathVariable
                                                                                                                                                                   String channelName,
                                                                                                                                                                   HttpServletResponse response)

Returns the channel-remove view.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-remove view cannot be gathered successfully.

Returns:

channel-remove view and associated model parameters.

channelRemovePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/remove",
                method=POST)
public ModelAndView channelRemovePost(@PathVariable
                                                                                                                                                                     String channelName,
                                                                                                                                                                     HttpServletResponse response)

Processes a form submitted from the channel-remove view. In case of error, the channel-remove view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-remove view on error.

channelRenameGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{channelName}/rename",
                method=GET)
public ModelAndView channelRenameGet(@PathVariable
                                                                                                                                                                   String channelName,
                                                                                                                                                                   HttpServletResponse response)

Returns the channel-rename view.

Parameters:

channelName - old name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-rename view cannot be gathered successfully.

Returns:

channel-rename view and associated model parameters.

channelRenamePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/all/by-name/{oldChannelName}/rename",
                method=POST)
public ModelAndView channelRenamePost(@PathVariable
                                                                                                                                                                        String oldChannelName,
                                                                                                                                                                        @RequestParam(required=false)
                                                                                                                                                                        String newChannelName,
                                                                                                                                                                        HttpServletResponse response)

Processes a form submitted from the channel-rename view. In case of error, the channel-rename view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

oldChannelName - old name of the channel.

newChannelName - new name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-rename view on error.

channelByServerAddGet

@RequestMapping(value="/channels/by-server/{serverIdFromPath}/add",
                method=GET)
 @Secured(value="ROLE_ADMIN")
public ModelAndView channelByServerAddGet(@PathVariable
                                                                                                                                                                        UUID serverIdFromPath,
                                                                                                                                                                        HttpServletResponse response)

Returns the channel-add view.

Parameters:

serverIdFromPath - server ID specified as part of the URI path. This is the server to which the user wants to add a channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

channel-add view and associated model parameters.

channelByServerAddPost

@RequestMapping(value="/channels/by-server/{serverIdFromPath}/add",
                method=POST)
 @Secured(value="ROLE_ADMIN")
public ModelAndView channelByServerAddPost(@PathVariable
                                                                                                                                                                          UUID serverIdFromPath,
                                                                                                                                                                          @ModelAttribute(value="form")
                                                                                                                                                                          com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.AddChannelForm form,
                                                                                                                                                                          BindingResult formBindingResult,
                                                                                                                                                                          HttpServletResponse response)

Processes a form submitted from the channel-add view. In case of error, the channel-add view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

serverIdFromPath - server ID specified as part of the URI path. This must match the server ID specified in the form data.

form - bean storing the form data.

formBindingResult - validation result of the form bean.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-add view on error. In case of a severe error that results in an error page to be sent directly, null is returned.

channelByServerDetails

@RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}",
                method=GET)
public ModelAndView channelByServerDetails(@PathVariable
                                                                                                                                                     UUID serverId,
                                                                                                                                                     @PathVariable
                                                                                                                                                     String channelName,
                                                                                                                                                     HttpServletResponse response)

Returns the channel-details view. This view presents the status and the configuration of a specific channel. This method is used when a channel is accessed from the "channels by server" list. If the specified server does not own the channel but the channel exists, the user is redirected to the corresponding view of the server that actually owns the channel.

Parameters:

serverId - ID of the server that is supposed to own the channel.

channelName - name of the channel

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the details view cannot be gathered successfully.

Returns:

channel-details view and associated model parameters.

See Also:

channelDetails(String, HttpServletResponse)

channelByServerEditGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/edit",
                method=GET)
public ModelAndView channelByServerEditGet(@PathVariable
                                                                                                                                                                                        UUID serverId,
                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                        String channelName,
                                                                                                                                                                                        HttpServletResponse response)

Returns the channel-edit view. If the specified server does not own the channel but the channel exists, the user is redirected to the corresponding view of the server that actually owns the channel.

Parameters:

serverId - ID of the server that is supposed to own the channel.

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the edit view cannot be gathered successfully.

Returns:

channel-edit view and associated model parameters.

channelByServerEditPost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/edit",
                method=POST)
public ModelAndView channelByServerEditPost(@PathVariable
                                                                                                                                                                                          UUID serverId,
                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                          String channelName,
                                                                                                                                                                                          @ModelAttribute(value="form")
                                                                                                                                                                                          com.aquenos.cassandra.pvarchiver.server.web.admin.controller.internal.EditChannelForm form,
                                                                                                                                                                                          BindingResult formBindingResult,
                                                                                                                                                                                          HttpServletResponse response)

Processes a form submitted from the channel-edit view. In case of error, the channel-edit view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

serverId - server ID specified as part of the URI path. However, this information is not really used because a redirect for a POST request is problematic.

channelName - name of the channel.

form - bean storing the form data.

formBindingResult - validation result of the form bean.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-edit view on error.

channelByServerMoveGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/move",
                method=GET)
public ModelAndView channelByServerMoveGet(@PathVariable
                                                                                                                                                                                        UUID serverId,
                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                        String channelName,
                                                                                                                                                                                        HttpServletResponse response)

Returns the channel-move view. If the specified server does not own the channel but the channel exists, the user is redirected to the corresponding view of the server that actually owns the channel.

Parameters:

serverId - ID of the server that is supposed to own the channel.

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-move view cannot be gathered successfully.

Returns:

channel-move view and associated model parameters.

channelByServerMovePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/move",
                method=POST)
public ModelAndView channelByServerMovePost(@PathVariable
                                                                                                                                                                                          UUID serverId,
                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                          String channelName,
                                                                                                                                                                                          @RequestParam
                                                                                                                                                                                          UUID oldServerId,
                                                                                                                                                                                          @RequestParam(required=false)
                                                                                                                                                                                          UUID newServerId,
                                                                                                                                                                                          HttpServletResponse response)

Processes a form submitted from the channel-move view. In case of error, the channel-move view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

serverId - server ID specified as part of the URI path. However, this information is not really used because a redirect for a POST request is problematic.

channelName - old name of the channel.

oldServerId - ID of the server from which the channel shall be moved.

newServerId - ID of the server to which the channel shall be moved.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-move view on error.

channelByServerReinitialize

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/reinitialize",
                method=POST)
public ModelAndView channelByServerReinitialize(@PathVariable
                                                                                                                                                                                                      UUID serverId,
                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                      String channelName,
                                                                                                                                                                                                      HttpServletResponse response)

Reinitializes a channel. In case of error, the reinitialize-channel view is shown. On success, the user is redirected to the channel-details view.

Parameters:

serverId - ID of the server on which the channel is supposed to be reinitialized.

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-reinitialize view on error.

channelByServerRemoveGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/remove",
                method=GET)
public ModelAndView channelByServerRemoveGet(@PathVariable
                                                                                                                                                                                            UUID serverId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String channelName,
                                                                                                                                                                                            HttpServletResponse response)

Returns the channel-remove view. If the specified server does not own the channel but the channel exists, the user is redirected to the corresponding view of the server that actually owns the channel.

Parameters:

serverId - ID of the server that is supposed to own the channel.

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-remove view cannot be gathered successfully.

Returns:

channel-remove view and associated model parameters.

channelByServerRemovePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/remove",
                method=POST)
public ModelAndView channelByServerRemovePost(@PathVariable
                                                                                                                                                                                              UUID serverId,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String channelName,
                                                                                                                                                                                              HttpServletResponse response)

Processes a form submitted from the channel-remove view. In case of error, the channel-remove view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

serverId - server ID specified as part of the URI path. However, this information is not really used because a redirect for a POST request is problematic.

channelName - name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-remove view on error.

channelByServerRenameGet

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{channelName}/rename",
                method=GET)
public ModelAndView channelByServerRenameGet(@PathVariable
                                                                                                                                                                                            UUID serverId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String channelName,
                                                                                                                                                                                            HttpServletResponse response)

Returns the channel-rename view. If the specified server does not own the channel but the channel exists, the user is redirected to the corresponding view of the server that actually owns the channel.

Parameters:

serverId - ID of the server that is supposed to own the channel.

channelName - old name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case the information for the channel-rename view cannot be gathered successfully.

Returns:

channel-rename view and associated model parameters.

channelByServerRenamePost

@Secured(value="ROLE_ADMIN")
 @RequestMapping(value="/channels/by-server/{serverId}/by-name/{oldChannelName}/rename",
                method=POST)
public ModelAndView channelByServerRenamePost(@PathVariable
                                                                                                                                                                                                 UUID serverId,
                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                 String oldChannelName,
                                                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                                                 String newChannelName,
                                                                                                                                                                                                 HttpServletResponse response)

Processes a form submitted from the channel-rename view. In case of error, the channel-rename view is shown again. In case of success, the user is redirected to the channel-details view.

Parameters:

serverId - server ID specified as part of the URI path. However, this information is not really used because a redirect for a POST request is problematic.

oldChannelName - old name of the channel.

newChannelName - new name of the channel.

response - HTTP servlet response. The response is used to send the appropriate status code in case of an error.

Returns:

redirect to channel-details view on success and channel-rename view on error.

serversRemove

@RequestMapping(value="/servers/{serverId}/remove",
                method=POST)
 @Secured(value="ROLE_ADMIN")
public ModelAndView serversRemove(@PathVariable
                                                                                                                                                 UUID serverId,
                                                                                                                                                 HttpServletResponse response)

Removes the specified server from the cluster. This is a privileged operation that requires administrative privileges. After removing the server, this method redirects to the dashboard.

Parameters:

serverId - unique identifier of the server to be removed.

response - HTTP servlet response. The response is used to send the appropriate status code in case the server cannot be removed.

Returns:

redirect to the dashboard view or null if the response has already been sent.

Throws:

IllegalArgumentException - if the server with the specified ID may not be removed.