org.wso2.broker.coordination

Interface CoordinationStrategy

All Known Implementing Classes:

RdbmsCoordinationStrategy

public interface CoordinationStrategy

The interface representing the coordination algorithm used to elect/identify the coordinator in the cluster.

Method Summary

Modifier and Type	Method and Description
List<NodeDetail>	getAllNodeDetails() Retrieve node details of all the nodes.
List<String>	getAllNodeIdentifiers() Retrieve IDs of all the nodes.
String	getNodeIdentifierOfCoordinator() Retrieve the node ID of the coordinator node.
boolean	isCoordinator() Used to query if the current node is the coordinator.
void	start() Meant to be invoked when the coordination algorithm should start working.
void	stop() Meant to be invoked when the coordination algorithm should stop working.

Method Detail

isCoordinator

boolean isCoordinator()

Used to query if the current node is the coordinator.

Returns:

true if the current node is the coordinator, false otherwise

getNodeIdentifierOfCoordinator

String getNodeIdentifierOfCoordinator()
                               throws CoordinationException

Retrieve the node ID of the coordinator node.

Returns:

node ID of the coordinator

Throws:

CoordinationException

getAllNodeIdentifiers

List<String> getAllNodeIdentifiers()
                            throws CoordinationException

Retrieve IDs of all the nodes.

Returns:

list of member IDs

Throws:

CoordinationException

getAllNodeDetails

List<NodeDetail> getAllNodeDetails()
                            throws CoordinationException

Retrieve node details of all the nodes.

Returns:

list of node details

Throws:

CoordinationException

start

void start()

Meant to be invoked when the coordination algorithm should start working. This is typically invoked during the server start up.

stop

void stop()

Meant to be invoked when the coordination algorithm should stop working. This is typically during the server shutdown.