org.adroitlogic.x.management.rest.service

Class ClusterCommandManagementService

java.lang.Object

org.adroitlogic.x.management.rest.service.ClusterCommandManagementService

public class ClusterCommandManagementService
extends Object

Service defined for cluster management.

Since:

17.01

Author:

Imesha Sudasingha

Constructor Summary

Constructors

Constructor and Description
ClusterCommandManagementService()

Method Summary

Modifier and Type	Method and Description
CommandView	getPublishedCommand(String commandId) Retrive a single command view with given command version
Map<Integer,CommandView>	getPublishedCommands() Gets the currently published cluster commands.
String	publishCommand(String marshaledCommand) Publishes a XControlCommand through the XClusterManager's command framework.
void	retryCommand(int commandId) Retries a given XControlCommand.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterCommandManagementService

public ClusterCommandManagementService()

Method Detail

getPublishedCommands

public Map<Integer,CommandView> getPublishedCommands()
                                              throws ManagementServiceException

Gets the currently published cluster commands.

Returns:

A map of commands published up to this point

Throws:

ManagementServiceException - If unable to fetch the commands

getPublishedCommand

public CommandView getPublishedCommand(String commandId)
                                throws ManagementServiceException

Retrive a single command view with given command version

Parameters:

commandId - command version

Returns:

command view

Throws:

ManagementServiceException - if any error occur when fetching the command view

retryCommand

public void retryCommand(int commandId)
                  throws ManagementServiceException

Retries a given XControlCommand. The command instance will be identified by the commandId which is the command version number.

Parameters:

commandId - command version number

Throws:

ManagementServiceException - in case of a failure to retry the command

publishCommand

public String publishCommand(String marshaledCommand)
                      throws ManagementServiceException

Publishes a XControlCommand through the XClusterManager's command framework. The command should be given as a string (marshaled).

Parameters:

marshaledCommand - XControlCommand to be published as marshaled string

Returns:

newly created command's name (sequential ZNode name)

Throws:

ManagementServiceException - if unable to publish