org.onosproject.ui.model.topo

Class UiClusterMember

java.lang.Object

org.onosproject.ui.model.topo.UiElement

org.onosproject.ui.model.topo.UiClusterMember

public class UiClusterMember
extends UiElement

Represents an individual member of the cluster (ONOS instance).

Constructor Summary

Constructors

Constructor and Description
UiClusterMember(UiTopology topology, ControllerNode cnode) Constructs a UI cluster member, with a reference to the parent topology instance and the specified controller node instance.

Method Summary

Modifier and Type	Method and Description
ControllerNode	backingNode() Returns the controller node instance backing this UI cluster member.
int	deviceCount() Returns the number of devices for which this cluster member is master.
NodeId	id() Returns the identity of the cluster member.
String	idAsString() Returns a string representation of the element identifier.
org.onlab.packet.IpAddress	ip() Returns the IP address of the cluster member.
boolean	isOnline() Returns true if this cluster member is online (active).
boolean	isReady() Returns true if this cluster member is considered ready.
Set<DeviceId>	masterOf() Returns the list of devices for which this cluster member is master.
boolean	masterOf(DeviceId deviceId) Returns true if the specified device is one for which this cluster member is master.
void	setMastership(Set<DeviceId> mastership) Sets the collection of identities of devices for which this controller node is master.
void	setState(ControllerNode.State state) Sets the state of this cluster member.
String	toString()

Methods inherited from class org.onosproject.ui.model.topo.UiElement

destroy, name

Methods inherited from class java.lang.Object

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

Constructor Detail

UiClusterMember

public UiClusterMember(UiTopology topology,
                       ControllerNode cnode)

Constructs a UI cluster member, with a reference to the parent topology instance and the specified controller node instance.

Parameters:

topology - parent topology containing this cluster member

cnode - underlying controller node.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

idAsString

public String idAsString()

Description copied from class: UiElement

Returns a string representation of the element identifier.

Specified by:

idAsString in class UiElement

Returns:

the element unique identifier

backingNode

public ControllerNode backingNode()

Returns the controller node instance backing this UI cluster member.

Returns:

the backing controller node instance

setState

public void setState(ControllerNode.State state)

Sets the state of this cluster member.

Parameters:

state - the state

setMastership

public void setMastership(Set<DeviceId> mastership)

Sets the collection of identities of devices for which this controller node is master.

Parameters:

mastership - device IDs

id

public NodeId id()

Returns the identity of the cluster member.

Returns:

member identifier

ip

public org.onlab.packet.IpAddress ip()

Returns the IP address of the cluster member.

Returns:

the IP address

isOnline

public boolean isOnline()

Returns true if this cluster member is online (active).

Returns:

true if online, false otherwise

isReady

public boolean isReady()

Returns true if this cluster member is considered ready.

Returns:

true if ready, false otherwise

deviceCount

public int deviceCount()

Returns the number of devices for which this cluster member is master.

Returns:

number of devices for which this member is master

masterOf

public Set<DeviceId> masterOf()

Returns the list of devices for which this cluster member is master.

Returns:

list of devices for which this member is master

masterOf

public boolean masterOf(DeviceId deviceId)

Returns true if the specified device is one for which this cluster member is master.

Parameters:

deviceId - device ID

Returns:

true if this cluster member is master for the given device