Package com.opencloud.rhino.management.scattercast

Interface ScattercastMBean

public interface ScattercastMBean

The ScattercastMBean interface defines operations for managing savanna clusters configured to use scattercast.

If scattercast is not configured for use by a node, attempting to invoke any of these operations on that node will result in an UnsupportedOperationException being thrown.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_NAME

Method Summary

Modifier and Type	Method	Description
CompositeData	createScattercastNodes(List<String> newNodes)	Creates new scattercast mappings for nodes.
CompositeData	deleteScattercastNodes(int[] removedNodes)	Remove scattercast endpoints for nodes that are being taken permanently offline.
boolean	isScattercastMode()	Returns true if this is a scattercast cluster.
TabularData	readScattercastEndpointsState()	Gets the current state of scattercast endpoints cluster wide.
void	updateScattercastEndpointsState(List<String> args)	Updates scattercast endpoints for existing nodes.

Field Detail

OBJECT_NAME

static final String OBJECT_NAME

See Also:

Constant Field Values

Method Detail

readScattercastEndpointsState

TabularData readScattercastEndpointsState()
                                   throws InvalidStateException

Gets the current state of scattercast endpoints cluster wide.

Throws:

InvalidStateException - if unable to aquire the management lock.

createScattercastNodes

CompositeData createScattercastNodes(List<String> newNodes)
                              throws ManagementException,
                                     InvalidArgumentException

Creates new scattercast mappings for nodes. Requires that none of the listed nodeID’s or endpoints are currently used. Does not permit duplicate elements in the list. Does not permit wildcard (0.0.0.0) IP addresses, or Localhost addresses.

Parameters:

newNodes - A list of strings containing nodeID to address/port pairs for each new node.

Returns:

Either a String error message, or the new scattercast state, as agreed by all nodes.

Throws:

InvalidArgumentException - if unable to correctly parse arguments

ManagementException - if unable to acquire the management lock.

updateScattercastEndpointsState

void updateScattercastEndpointsState(List<String> args)
                              throws ManagementException,
                                     InvalidArgumentException,
                                     InvalidStateException

Updates scattercast endpoints for existing nodes. Requires that all nodes to be updated are currently members of the cluster. Does not permit duplicate elements in the list. Does not permit wildcard (0.0.0.0) IP addresses, or Localhost addresses.

Parameters:

args - A list of strings containing nodeID to address/port pairs for each new node.

Throws:

ManagementException - if unable to shut down the cluster cleanly after updating.

InvalidArgumentException - if unable to correctly parse arguments

InvalidStateException - if the slee is not stopped.

ManagementException - if unable to acquire the management lock.

deleteScattercastNodes

CompositeData deleteScattercastNodes(int[] removedNodes)
                              throws InvalidArgumentException,
                                     InvalidStateException,
                                     ManagementException

Remove scattercast endpoints for nodes that are being taken permanently offline. WARNING: A removed node cannot be booted successfully after this command. Does not permit duplicate elements in the list.

Parameters:

removedNodes - A list of NodeIDs to remove

Throws:

InvalidArgumentException - if unable to correctly parse arguments

InvalidStateException - if node to be removed is running.

ManagementException - if unable to acquire the management lock.

isScattercastMode

boolean isScattercastMode()
                   throws InvalidStateException

Returns true if this is a scattercast cluster.

Throws:

InvalidStateException