com.hazelcast.internal.cluster

Interface ClusterService

All Superinterfaces:

Cluster, CoreService

All Known Implementing Classes:

ClusterServiceImpl

public interface ClusterService
extends CoreService, Cluster

A service responsible for member related functionality. So members joining, leaving etc.

This API is an internal API; the end user will use the Cluster interface.

Method Summary

Modifier and Type	Method and Description
ClusterClock	getClusterClock() Returns the ClusterClock of the cluster.
String	getClusterId() Returns UUID for the cluster.
Member	getLocalMember() Gets the local member instance.
Address	getMasterAddress() Returns the address of the master member.
MemberImpl	getMember(Address address) Gets the member for the given address.
MemberImpl	getMember(String uuid) Gets the member with the given uuid.
Collection<MemberImpl>	getMemberImpls() Gets the collection of members.
Collection<Member>	getMembers(MemberSelector selector) Returns a collection of the members that satisfy the given MemberSelector.
int	getSize() Gets the current number of members.
int	getSize(MemberSelector selector) Gets the number of members that satisfy the given MemberSelector instance.
Address	getThisAddress() Gets the address of this member.
boolean	isJoined() Returns whether this member joined to a cluster.
boolean	isMaster() Checks if this member is the master.

Methods inherited from interface com.hazelcast.core.Cluster

addMembershipListener, changeClusterState, changeClusterState, changeClusterVersion, changeClusterVersion, getClusterState, getClusterTime, getClusterVersion, getHotRestartService, getMembers, promoteLocalLiteMember, removeMembershipListener, shutdown, shutdown

Method Detail

getMember

MemberImpl getMember(Address address)

Gets the member for the given address.

Parameters:

address - the address of the member to lookup.

Returns:

the found member, or null if not found. If address is null, null is returned.

getMember

MemberImpl getMember(String uuid)

Gets the member with the given uuid.

Parameters:

uuid - the uuid of the member

Returns:

the found member, or null if not found. If uuid is null, null is returned.

getMemberImpls

Collection<MemberImpl> getMemberImpls()

Gets the collection of members.

if we take care of the generics.

Returns:

the collection of member. Null will never be returned.

getMembers

Collection<Member> getMembers(MemberSelector selector)

Returns a collection of the members that satisfy the given MemberSelector.

Parameters:

selector - MemberSelector instance to filter members to return

Returns:

members that satisfy the given MemberSelector.

getMasterAddress

Address getMasterAddress()

Returns the address of the master member.

Returns:

the address of the master member. Could be null if the master is not yet known.

isMaster

boolean isMaster()

Checks if this member is the master.

Returns:

true if master, false otherwise.

isJoined

boolean isJoined()

Returns whether this member joined to a cluster.

Returns:

true if this member is joined to a cluster, false otherwise

getThisAddress

Address getThisAddress()

Gets the address of this member.

Returns:

the address of this member. The returned value will never be null.

getLocalMember

Member getLocalMember()

Gets the local member instance.

The returned value will never be null, but it may change when local lite member is promoted to a data member via Cluster.promoteLocalLiteMember() or when this member merges to a new cluster after split-brain detected. Returned value should not be cached but instead this method should be called each time when local member is needed.

Specified by:

getLocalMember in interface Cluster

Returns:

the local member instance. The returned value will never be null.

getSize

int getSize()

Gets the current number of members.

Returns:

the current number of members.

getSize

int getSize(MemberSelector selector)

Gets the number of members that satisfy the given MemberSelector instance.

Parameters:

selector - MemberSelector instance that filters members to be counted.

Returns:

the number of members that satisfy the given MemberSelector instance.

getClusterClock

ClusterClock getClusterClock()

Returns the ClusterClock of the cluster. The returned value will never be null and will never change.

Returns:

the ClusterClock.

getClusterId

String getClusterId()

Returns UUID for the cluster.

Returns:

unique Id for cluster