org.onosproject.cluster

Interface ClusterService

public interface ClusterService

Service for obtaining information about the individual nodes within the controller cluster.

Method Summary

Modifier and Type	Method and Description
void	addListener(ClusterEventListener listener) Adds the specified cluster event listener.
ControllerNode	getLocalNode() Returns the local controller node.
ControllerNode	getNode(NodeId nodeId) Returns the specified controller node.
Set<ControllerNode>	getNodes() Returns the set of current cluster members.
ControllerNode.State	getState(NodeId nodeId) Returns the availability state of the specified controller node.
void	removeListener(ClusterEventListener listener) Removes the specified cluster event listener.

Method Detail

getLocalNode

ControllerNode getLocalNode()

Returns the local controller node.

Returns:

local controller node

getNodes

Set<ControllerNode> getNodes()

Returns the set of current cluster members.

Returns:

set of cluster members

getNode

ControllerNode getNode(NodeId nodeId)

Returns the specified controller node.

Parameters:

nodeId - controller node identifier

Returns:

controller node

getState

ControllerNode.State getState(NodeId nodeId)

Returns the availability state of the specified controller node.

Parameters:

nodeId - controller node identifier

Returns:

availability state

addListener

void addListener(ClusterEventListener listener)

Adds the specified cluster event listener.

Parameters:

listener - the cluster listener

removeListener

void removeListener(ClusterEventListener listener)

Removes the specified cluster event listener.

Parameters:

listener - the cluster listener