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

Class ApiController

java.lang.Object

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

@Controller
 @RequestMapping(value="/admin/api")
public class ApiController
extends Object

Controller handling requests to the administrative API. This controller implements a REST-style API using the JSON protocol and exposes it at the /admin/api URI.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ApiController()

Method Summary

Modifier and Type	Method and Description
ChannelResponse	channelByServerDetails(String serverId, String channelName, HttpServletResponse response) Returns the details (configuration and status) for a single channel.
ChannelResponse	channelDetails(String channelName, HttpServletResponse response) Returns the details (configuration and status) for a single channel.
ChannelsAllResponse	channelsAll(HttpServletResponse response) Returns the list of all channels.
ChannelsByServerResponse	channelsByServer(String serverId, HttpServletResponse response) Returns the list of channels for the specified server.
ChannelsByServerExportResponse	channelsByServerExport(String serverId, HttpServletResponse response) Returns the exported channel configuration for the specified server..
ChannelsByServerImportResponse	channelsByServerImport(String serverId, ChannelsByServerImportRequest importRequest, HttpServletResponse response) Imports the channel configuration for an archive server from a configuration file.
ClusterStatusResponse	clusterStatus(HttpServletResponse response) Returns status information about the archiving cluster.
RunArchiveConfigurationCommandsResponse	runArchiveConfigurationCommands(RunArchiveConfigurationCommandsRequest request, HttpServletResponse response) Runs archive configuration commands.
ServerStatusResponse	serverStatus() Returns status information for this server.
void	setArchiveConfigurationService(ArchiveConfigurationService archiveConfigurationService) Sets the archive configuration service used by this controller.
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

ApiController

public ApiController()

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.

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.

channelByServerDetails

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

Returns the details (configuration and status) for a single 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 requested information cannot be gathered successfully.

Returns:

channel details. May be null if the request could not be processed.

channelDetails

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

Returns the details (configuration and status) for a single channel.

Parameters:

channelName - name of the channel

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

Returns:

channel details. May be null if the request could not be processed.

channelsAll

@RequestMapping(value="/1.0/channels/all",
                method=GET)
 @ResponseBody
public ChannelsAllResponse channelsAll(HttpServletResponse response)

Returns the list of all channels. This means all channels, regardless of the server they belong to.

Parameters:

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

Returns:

list of all channels.

channelsByServer

@RequestMapping(value="/1.0/channels/by-server/{serverId}",
                method=GET)
 @ResponseBody
public ChannelsByServerResponse channelsByServer(@PathVariable
                                                                                                                                                        String serverId,
                                                                                                                                                        HttpServletResponse response)

Returns the list of channels for the specified server.

Parameters:

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

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

Returns:

list of channels for the specified server.

channelsByServerExport

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

Returns the exported channel configuration for the specified server..

Parameters:

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

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

Returns:

configuration file for the specified server.

channelsByServerImport

@RequestMapping(value="/1.0/channels/by-server/{serverId}/import",
                method=POST)
 @ResponseBody
 @Secured(value="ROLE_ADMIN")
public ChannelsByServerImportResponse channelsByServerImport(@PathVariable
                                                                                                                                                                                                          String serverId,
                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                          ChannelsByServerImportRequest importRequest,
                                                                                                                                                                                                          HttpServletResponse response)

Imports the channel configuration for an archive server from a configuration file.

Parameters:

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

importRequest - request object specifying the configuration file an other options that shall be used for the import operation.

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

Returns:

response object indicating the result of the import operation.

clusterStatus

@RequestMapping(value="/1.0/cluster-status")
 @ResponseBody
public ClusterStatusResponse clusterStatus(HttpServletResponse response)

Returns status information about the archiving cluster.

Parameters:

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

Returns:

status information about the cluster.

runArchiveConfigurationCommands

@RequestMapping(value="/1.0/run-archive-configuration-commands",
                method=POST)
 @ResponseBody
 @Secured(value="ROLE_ADMIN")
public RunArchiveConfigurationCommandsResponse runArchiveConfigurationCommands(@RequestBody
                                                                                                                                                                                                                          RunArchiveConfigurationCommandsRequest request,
                                                                                                                                                                                                                          HttpServletResponse response)

Runs archive configuration commands.

Parameters:

request - request object wrapping the list of archive configuration commands that shall be run.

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

Returns:

response object indicating the results of the executed commands.

serverStatus

@RequestMapping(value="/1.0/server-status/this-server")
 @ResponseBody
public ServerStatusResponse serverStatus()

Returns status information for this server.

Returns:

status information for this server.