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

Class ApiController

java.lang.Object

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

@Controller
 @RequestMapping(value="/inter-node/api")
public class ApiController
extends Object

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

This controller does not check the authentication or authorization of requests. These checks are expected to be made before a request is passed to this controller.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ApiController()

Method Summary

Modifier and Type	Method and Description
ArchivingStatusResponse	archivingStatus() Returns a response with the archiving status of all channels handled by this server.
ChannelStatus	archivingStatusForChannel(String channelName) Returns the archiving status of the specified channel.
CurrentSystemTimeResponse	currentSystemTime() Returns a response with the current system time (as returned by System.currentTimeMillis()).
ListenableFuture<RunArchiveConfigurationCommandsResponse>	runArchiveConfigurationCommands(RunArchiveConfigurationCommandsRequest request) Runs archive configuration commands on this server.
void	setArchiveConfigurationService(ArchiveConfigurationService archiveConfigurationService) Sets the archive configuration service used by this controller.
void	setArchivingService(ArchivingService archivingService) Sets the archiving service.
void	setChannelInformationCache(ChannelInformationCache channelInformationCache) Sets the channel information cache.
ListenableFuture<Void>	updateChannelInformation(UpdateChannelInformationRequest request) Updates the channel cache and forwards the update to other servers if requested.

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 execute configuration commands that have been received from other servers in the cluster. 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 provide status information when requested. Typically, this method is called automatically by the Spring container.

Parameters:

archivingService - archiving service for this server.

setChannelInformationCache

@Autowired
public void setChannelInformationCache(ChannelInformationCache channelInformationCache)

Sets the channel information cache. The cache is updated when this controller receives updated channel information. Typically, this method is called automatically by the Spring container.

Parameters:

channelInformationCache - channel information cache for this server.

archivingStatus

@RequestMapping(value="/1.0/archiving-status",
                method=GET)
 @ResponseBody
public ArchivingStatusResponse archivingStatus()

Returns a response with the archiving status of all channels handled by this server.

Returns:

archiving status of all channels wrapped in an object suitable for JSON serialization.

archivingStatusForChannel

@RequestMapping(value="/1.0/archiving-status-for-channel/{channelName}",
                method=GET)
 @ResponseBody
public ChannelStatus archivingStatusForChannel(@PathVariable
                                                                                                                                                                   String channelName)

Returns the archiving status of the specified channel. This method returns null if the specified channel is not known by this server's archiving service.

Parameters:

channelName - name of the channel.

Returns:

archiving status of the specified channel or null if the specified channel is not known.

currentSystemTime

@RequestMapping(value="/1.0/current-system-time",
                method=GET)
 @ResponseBody
public CurrentSystemTimeResponse currentSystemTime()

Returns a response with the current system time (as returned by System.currentTimeMillis()).

Returns:

current system time wrapped in an object suitable for JSON serialization.

runArchiveConfigurationCommands

@RequestMapping(value="/1.0/run-archive-configuration-commands",
                method=POST)
 @ResponseBody
public ListenableFuture<RunArchiveConfigurationCommandsResponse> runArchiveConfigurationCommands(@RequestBody
                                                                                                                                                                                                              RunArchiveConfigurationCommandsRequest request)

Runs archive configuration commands on this server. This URI is only used by other servers in the same cluster. Typically, the future returned by this method will not throw an exception but signal failure of individual commands by a corresponding result instead. However, if there is some general error that prevents all commands from being executed, the future might throw an exception.

Parameters:

request - request object wrapping the commands that shall be executed by this server's ArchiveConfigurationService.

Returns:

response to the request exposed through a future. This allows the container to reuse the calling thread while waiting for the operation to finish.

updateChannelInformation

@RequestMapping(value="/1.0/update-channel-information",
                method=POST)
 @ResponseBody
public ListenableFuture<Void> updateChannelInformation(@RequestBody
                                                                                                                                                            UpdateChannelInformationRequest request)

Updates the channel cache and forwards the update to other servers if requested. This URI is only used by other servers in the same cluster. The future returned by this method completes when the local cache has been updated and the update has been forwarded to the specified servers. The future only indicates failure if there is a general problem with the update. If the forwarding to individual servers fails, this does not result in the returned future to fail.

Parameters:

request - channel-information update request.

Returns:

future that completes when the update operation completes. This allows the container to reuse the calling thread while waiting for the operation to finish.