org.onosproject.cluster

Interface MembershipService

public interface MembershipService

Service for obtaining information about the individual members of the controller cluster.

Method Summary

Modifier and Type	Method and Description
MembershipGroup	getGroup(Version version) Returns the membership group for the given version.
java.util.Collection<MembershipGroup>	getGroups() Returns the set of membership groups in the cluster.
MembershipGroup	getLocalGroup() Returns the group associated with the local member.
Member	getLocalMember() Returns the local member.
Member	getMember(NodeId nodeId) Returns the specified controller node.
java.util.Set<Member>	getMembers() Returns the set of current cluster members in the local group.
java.util.Set<Member>	getMembers(Version version) Returns the set of members in the given version.

Method Detail

getLocalMember

Member getLocalMember()

Returns the local member.

Returns:

local member

getLocalGroup

MembershipGroup getLocalGroup()

Returns the group associated with the local member.

Returns:

the group associated with the local member

getMembers

java.util.Set<Member> getMembers()

Returns the set of current cluster members in the local group.

Returns:

set of cluster members in the local group

getGroups

java.util.Collection<MembershipGroup> getGroups()

Returns the set of membership groups in the cluster.

Returns:

the set of membership groups in the cluster

getGroup

MembershipGroup getGroup(Version version)

Returns the membership group for the given version.

Parameters:

version - the version for which to return the membership group

Returns:

the membership group for the given version

getMembers

java.util.Set<Member> getMembers(Version version)

Returns the set of members in the given version.

Parameters:

version - the version for which to return the set of members

Returns:

the set of members for the given version

getMember

Member getMember(NodeId nodeId)

Returns the specified controller node.

Parameters:

nodeId - controller node identifier

Returns:

controller node