org.onosproject.cluster

Interface ClusterAdminService

All Superinterfaces:

ClusterService, ListenerService<ClusterEvent,ClusterEventListener>

public interface ClusterAdminService
extends ClusterService

Service for administering the cluster node membership.

Method Summary

Modifier and Type	Method and Description
ControllerNode	addNode(NodeId nodeId, IpAddress ip, int tcpPort) Adds a new controller node to the cluster.
void	formCluster(java.util.Set<ControllerNode> nodes) Forms cluster configuration based on the specified set of node information. This method resets and restarts the controller instance.
void	formCluster(java.util.Set<ControllerNode> nodes, int partitionSize) Forms cluster configuration based on the specified set of node information. This method resets and restarts the controller instance.
void	markFullyStarted(boolean started) Marks the current node as fully started or not.
void	removeNode(NodeId nodeId) Removes the specified node from the cluster node list.

Methods inherited from interface org.onosproject.cluster.ClusterService

getLastUpdated, getLastUpdatedInstant, getLocalNode, getNode, getNodes, getState, getVersion

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

formCluster

void formCluster(java.util.Set<ControllerNode> nodes)

Forms cluster configuration based on the specified set of node information. This method resets and restarts the controller instance.

Parameters:

nodes - set of nodes that form the cluster

formCluster

void formCluster(java.util.Set<ControllerNode> nodes,
                 int partitionSize)

Forms cluster configuration based on the specified set of node information. This method resets and restarts the controller instance.

Parameters:

nodes - set of nodes that form the cluster

partitionSize - number of nodes to compose a partition

addNode

ControllerNode addNode(NodeId nodeId,
                       IpAddress ip,
                       int tcpPort)

Adds a new controller node to the cluster.

Parameters:

nodeId - controller node identifier

ip - node IP listen address

tcpPort - tcp listen port

Returns:

newly added node

removeNode

void removeNode(NodeId nodeId)

Removes the specified node from the cluster node list.

Parameters:

nodeId - controller node identifier

markFullyStarted

void markFullyStarted(boolean started)

Marks the current node as fully started or not.

Parameters:

started - true indicates all components have been started