com.hazelcast.internal.cluster.impl

Class ClusterServiceImpl

java.lang.Object

com.hazelcast.internal.cluster.impl.ClusterServiceImpl

All Implemented Interfaces:

Cluster, ClusterService, ConnectionListener, CoreService, EventPublishingService<MembershipEvent,MembershipListener>, ManagedService, TransactionalService

public class ClusterServiceImpl
extends Object
implements ClusterService, ConnectionListener, ManagedService, EventPublishingService<MembershipEvent,MembershipListener>, TransactionalService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME
static String	SPLIT_BRAIN_HANDLER_EXECUTOR_NAME

Constructor Summary

Constructors

Constructor and Description
ClusterServiceImpl(Node node, MemberImpl localMember)

Method Summary

Modifier and Type	Method and Description
String	addMembershipListener(MembershipListener listener) Adds MembershipListener to listen for membership updates.
void	changeClusterState(ClusterState newState) Changes state of the cluster to the given state transactionally.
void	changeClusterState(ClusterState newState, TransactionOptions options) Changes state of the cluster to the given state transactionally.
void	changeClusterVersion(Version version) Changes the cluster version transactionally.
void	changeClusterVersion(Version version, com.hazelcast.internal.cluster.impl.MemberMap memberMap)
void	changeClusterVersion(Version version, TransactionOptions options) Changes the cluster version transactionally, with the transaction options provided.
void	connectionAdded(Connection connection)
void	connectionRemoved(Connection connection)
<T extends TransactionalObject> T	createTransactionalObject(String name, Transaction transaction)
void	dispatchEvent(MembershipEvent event, MembershipListener listener) Notifies the service of a published event.
boolean	finalizeJoin(MembersView membersView, Address callerAddress, String callerUuid, String targetUuid, String clusterId, ClusterState clusterState, Version clusterVersion, long clusterStartTime, long masterTime, OnJoinOp preJoinOp)
Collection<Member>	getActiveAndMissingMembers()
ClusterClockImpl	getClusterClock() Returns the ClusterClock of the cluster.
ClusterHeartbeatManager	getClusterHeartbeatManager()
String	getClusterId() Returns UUID for the cluster.
ClusterJoinManager	getClusterJoinManager()
ClusterState	getClusterState() Returns the state of the cluster.
ClusterStateManager	getClusterStateManager()
long	getClusterTime() Returns the cluster-wide time in milliseconds.
Version	getClusterVersion() The cluster version indicates the operating version of the cluster.
HotRestartService	getHotRestartService() Returns the Hot Restart service for interacting with Hot Restart.
MemberImpl	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(Address address, String uuid) Gets the member with the given UUID and address.
MemberImpl	getMember(String uuid) Gets the member with the given UUID.
Collection<Address>	getMemberAddresses()
Collection<MemberImpl>	getMemberImpls() Gets the collection of members.
int	getMemberListJoinVersion() Returns the member list join version of the local member instance.
String	getMemberListString()
int	getMemberListVersion() Returns the current version of member list.
Set<Member>	getMembers() Set of the current members in the cluster.
Collection<Member>	getMembers(MemberSelector selector) Returns a collection of the members that satisfy the given MemberSelector.
MembershipManager	getMembershipManager()
NodeEngineImpl	getNodeEngine()
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.
String	getThisUuid()
void	handleExplicitSuspicion(MembersViewMetadata expectedMembersViewMetadata, Address suspectedAddress)
void	handleExplicitSuspicionTrigger(Address caller, int callerMemberListVersion, MembersViewMetadata suspectedMembersViewMetadata)
MembersView	handleMastershipClaim(Address candidateAddress, String candidateUuid)
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
boolean	isJoined() Returns whether this member joined to a cluster.
boolean	isMaster() Checks if this member is the master.
boolean	isMissingMember(Address address, String uuid) Returns whether member with given identity (either UUID or Address depending on Hot Restart is enabled or not) is a known missing member or not.
void	merge(Address newTargetAddress)
void	notifyForRemovedMember(MemberImpl member)
void	promoteLocalLiteMember() Promotes local lite member to data member.
boolean	removeMembershipListener(String registrationId) Removes the specified MembershipListener.
void	reset() Resets this service back to its initial state.
void	resetJoinState()
void	rollbackTransaction(String transactionId)
void	sendLocalMembershipEvent()
boolean	setMasterAddressToJoin(Address master)
void	shrinkMissingMembers(Collection<String> memberUuidsToRemove)
void	shutdown() Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node.
void	shutdown(boolean terminate) Shuts down this service.
void	shutdown(TransactionOptions options) Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node.
void	suspectAddressIfNotConnected(Address address)
void	suspectMember(Member suspectedMember, String reason, boolean destroyConnection)
String	toString()
void	updateMemberAttribute(String uuid, MemberAttributeOperationType operationType, String key, Object value)
boolean	updateMembers(MembersView membersView, Address callerAddress, String callerUuid, String targetUuid)

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

SPLIT_BRAIN_HANDLER_EXECUTOR_NAME

public static final String SPLIT_BRAIN_HANDLER_EXECUTOR_NAME

See Also:

Constant Field Values

Constructor Detail

ClusterServiceImpl

public ClusterServiceImpl(Node node,
                          MemberImpl localMember)

Method Detail

init

public void init(NodeEngine nodeEngine,
                 Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

sendLocalMembershipEvent

public void sendLocalMembershipEvent()

handleExplicitSuspicion

public void handleExplicitSuspicion(MembersViewMetadata expectedMembersViewMetadata,
                                    Address suspectedAddress)

handleExplicitSuspicionTrigger

public void handleExplicitSuspicionTrigger(Address caller,
                                           int callerMemberListVersion,
                                           MembersViewMetadata suspectedMembersViewMetadata)

suspectMember

public void suspectMember(Member suspectedMember,
                          String reason,
                          boolean destroyConnection)

suspectAddressIfNotConnected

public void suspectAddressIfNotConnected(Address address)

handleMastershipClaim

public MembersView handleMastershipClaim(Address candidateAddress,
                                         String candidateUuid)

merge

public void merge(Address newTargetAddress)

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

resetJoinState

public void resetJoinState()

finalizeJoin

public boolean finalizeJoin(MembersView membersView,
                            Address callerAddress,
                            String callerUuid,
                            String targetUuid,
                            String clusterId,
                            ClusterState clusterState,
                            Version clusterVersion,
                            long clusterStartTime,
                            long masterTime,
                            OnJoinOp preJoinOp)

updateMembers

public boolean updateMembers(MembersView membersView,
                             Address callerAddress,
                             String callerUuid,
                             String targetUuid)

updateMemberAttribute

public void updateMemberAttribute(String uuid,
                                  MemberAttributeOperationType operationType,
                                  String key,
                                  Object value)

connectionAdded

public void connectionAdded(Connection connection)

Specified by:

connectionAdded in interface ConnectionListener

connectionRemoved

public void connectionRemoved(Connection connection)

Specified by:

connectionRemoved in interface ConnectionListener

getNodeEngine

public NodeEngineImpl getNodeEngine()

isMissingMember

public boolean isMissingMember(Address address,
                               String uuid)

Returns whether member with given identity (either UUID or Address depending on Hot Restart is enabled or not) is a known missing member or not.

Parameters:

address - Address of the missing member

uuid - Uuid of the missing member

Returns:

true if it's a known missing member, false otherwise

getActiveAndMissingMembers

public Collection<Member> getActiveAndMissingMembers()

notifyForRemovedMember

public void notifyForRemovedMember(MemberImpl member)

shrinkMissingMembers

public void shrinkMissingMembers(Collection<String> memberUuidsToRemove)

getMember

public MemberImpl getMember(Address address)

Description copied from interface: ClusterService

Gets the member for the given address.

Specified by:

getMember in interface ClusterService

Parameters:

address - the address of the member to lookup

Returns:

the found member, or null if not found (if the address is null, null is returned)

getMember

public MemberImpl getMember(String uuid)

Description copied from interface: ClusterService

Gets the member with the given UUID.

Specified by:

getMember in interface ClusterService

Parameters:

uuid - the UUID of the member

Returns:

the found member, or null if not found (if the UUID is null, null is returned)

getMember

public MemberImpl getMember(Address address,
                            String uuid)

Description copied from interface: ClusterService

Gets the member with the given UUID and address.

Specified by:

getMember in interface ClusterService

Parameters:

address - the address of the member

uuid - the UUID of the member

Returns:

the found member, or null if not found (if the UUID and/or address is null, null is returned)

getMemberImpls

public Collection<MemberImpl> getMemberImpls()

Description copied from interface: ClusterService

Gets the collection of members.

If we take care of the generics.

Specified by:

getMemberImpls in interface ClusterService

Returns:

the collection of member (the returned value will never be null)

getMemberAddresses

public Collection<Address> getMemberAddresses()

getMembers

public Set<Member> getMembers()

Description copied from interface: Cluster

Set of the current members in the cluster. The returned set is an immutable set; it can't be modified.

The returned set is backed by an ordered set. Every member in the cluster returns the 'members' in the same order. To obtain the oldest member (the master) in the cluster, you can retrieve the first item in the set using 'getMembers().iterator().next()'.

Specified by:

getMembers in interface Cluster

Returns:

current members in the cluster

getMembers

public Collection<Member> getMembers(MemberSelector selector)

Description copied from interface: ClusterService

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

Specified by:

getMembers in interface ClusterService

Parameters:

selector - MemberSelector instance to filter members to return

Returns:

members that satisfy the given MemberSelector

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service

setMasterAddressToJoin

public boolean setMasterAddressToJoin(Address master)

getMasterAddress

public Address getMasterAddress()

Description copied from interface: ClusterService

Returns the address of the master member.

Specified by:

getMasterAddress in interface ClusterService

Returns:

the address of the master member (can be null if the master is not yet known)

isMaster

public boolean isMaster()

Description copied from interface: ClusterService

Checks if this member is the master.

Specified by:

isMaster in interface ClusterService

Returns:

true if master, false otherwise

getThisAddress

public Address getThisAddress()

Description copied from interface: ClusterService

Gets the address of this member.

Specified by:

getThisAddress in interface ClusterService

Returns:

the address of this member (the returned value will never be null)

getLocalMember

public MemberImpl getLocalMember()

Description copied from interface: ClusterService

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

Specified by:

getLocalMember in interface ClusterService

Returns:

the local member instance (the returned value will never be null)

getThisUuid

public String getThisUuid()

isJoined

public boolean isJoined()

Description copied from interface: ClusterService

Returns whether this member joined to a cluster.

Specified by:

isJoined in interface ClusterService

Returns:

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

getSize

public int getSize()

Description copied from interface: ClusterService

Gets the current number of members.

Specified by:

getSize in interface ClusterService

Returns:

the current number of members

getSize

public int getSize(MemberSelector selector)

Description copied from interface: ClusterService

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

Specified by:

getSize in interface ClusterService

Parameters:

selector - MemberSelector instance that filters members to be counted

Returns:

the number of members that satisfy the given MemberSelector instance

getClusterClock

public ClusterClockImpl getClusterClock()

Description copied from interface: ClusterService

Returns the ClusterClock of the cluster.

The returned value will never be null and will never change.

Specified by:

getClusterClock in interface ClusterService

Returns:

the ClusterClock

getClusterTime

public long getClusterTime()

Description copied from interface: Cluster

Returns the cluster-wide time in milliseconds.

Cluster tries to keep a cluster-wide time which might be different than the member's own system time. Cluster-wide time is -almost- the same on all members of the cluster.

Specified by:

getClusterTime in interface Cluster

Returns:

cluster-wide time

getClusterId

public String getClusterId()

Description copied from interface: ClusterService

Returns UUID for the cluster.

Specified by:

getClusterId in interface ClusterService

Returns:

unique UUID for cluster

addMembershipListener

public String addMembershipListener(MembershipListener listener)

Description copied from interface: Cluster

Adds MembershipListener to listen for membership updates.

The addMembershipListener method returns a register ID. This ID is needed to remove the MembershipListener using the Cluster.removeMembershipListener(String) method.

If the MembershipListener implements the InitialMembershipListener interface, it will also receive the InitialMembershipEvent.

There is no check for duplicate registrations, so if you register the listener twice, it will get events twice.

Specified by:

addMembershipListener in interface Cluster

Parameters:

listener - membership listener

Returns:

the registration ID

See Also:

Cluster.removeMembershipListener(String)

removeMembershipListener

public boolean removeMembershipListener(String registrationId)

Description copied from interface: Cluster

Removes the specified MembershipListener.

If the same MembershipListener is registered multiple times, it needs to be removed multiple times. This method can safely be called multiple times for the same registration ID; subsequent calls are ignored.

Specified by:

removeMembershipListener in interface Cluster

Parameters:

registrationId - the registrationId of MembershipListener to remove

Returns:

true if the registration is removed, false otherwise

See Also:

Cluster.addMembershipListener(MembershipListener)

dispatchEvent

public void dispatchEvent(MembershipEvent event,
                          MembershipListener listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<MembershipEvent,MembershipListener>

Parameters:

event - the published event

listener - the listener registered for this event

getMemberListString

public String getMemberListString()

getClusterState

public ClusterState getClusterState()

Description copied from interface: Cluster

Returns the state of the cluster.

If cluster state change is in process, ClusterState.IN_TRANSITION will be returned.

This is a local operation, state will be read directly from local member.

Specified by:

getClusterState in interface Cluster

Returns:

state of the cluster

createTransactionalObject

public <T extends TransactionalObject> T createTransactionalObject(String name,
                                                                   Transaction transaction)

Specified by:

createTransactionalObject in interface TransactionalService

rollbackTransaction

public void rollbackTransaction(String transactionId)

Specified by:

rollbackTransaction in interface TransactionalService

changeClusterState

public void changeClusterState(ClusterState newState)

Description copied from interface: Cluster

Changes state of the cluster to the given state transactionally. Transaction will be TWO_PHASE and will have 1 durability by default. If you want to override transaction options, use Cluster.changeClusterState(ClusterState, TransactionOptions).

If the given state is already same as current state of the cluster, then this method will have no effect.

If there's an ongoing state change transaction in the cluster, this method will fail immediately with a TransactionException.

If a membership change occurs in the cluster during state change, a new member joins or an existing member leaves, then this method will fail with an IllegalStateException.

If there are ongoing/pending migration/replication operations, because of re-balancing due to member join or leave, then trying to change from ACTIVE to FROZEN or PASSIVE will fail with an IllegalStateException.

If transaction timeouts during state change, then this method will fail with a TransactionException.

Specified by:

changeClusterState in interface Cluster

Parameters:

newState - new state of the cluster

changeClusterState

public void changeClusterState(ClusterState newState,
                               TransactionOptions options)

Description copied from interface: Cluster

Changes state of the cluster to the given state transactionally. Transaction must be a TWO_PHASE transaction.

If the given state is already same as current state of the cluster, then this method will have no effect.

If there's an ongoing state change transaction in the cluster, this method will fail immediately with a TransactionException.

If a membership change occurs in the cluster during state change, a new member joins or an existing member leaves, then this method will fail with an IllegalStateException.

If there are ongoing/pending migration/replication operations, because of re-balancing due to member join or leave, then trying to change from ACTIVE to FROZEN or PASSIVE will fail with an IllegalStateException.

If transaction timeouts during state change, then this method will fail with a TransactionException.

Specified by:

changeClusterState in interface Cluster

Parameters:

newState - new state of the cluster

options - transaction options

getClusterVersion

public Version getClusterVersion()

Description copied from interface: Cluster

The cluster version indicates the operating version of the cluster. It is separate from each node's codebase version, as it may be acceptable for a node to operate at a different compatibility version than its codebase version. This method may return Version.UNKNOWN if invoked after the ClusterService is constructed and before the node forms a cluster, either by joining existing members or becoming master of its standalone cluster if it is the first node on the cluster. Importantly, this is the time during which a lifecycle event with state LifecycleEvent.LifecycleState.STARTING is triggered.

For example, consider a cluster comprised of nodes running on hazelcast-3.8.0.jar. Each node's codebase version is 3.8.0 and on startup the cluster version is 3.8. After a while, another node joins, running on hazelcast-3.9.jar; this node's codebase version is 3.9.0. If deemed compatible, it is allowed to join the cluster. At this point, the cluster version is still 3.8 and the 3.9.0 member should be able to adapt its behaviour to be compatible with the other 3.8.0 members. Once all 3.8.0 members have been shutdown and replaced by other members on codebase version 3.9.0, still the cluster version will be 3.8. At this point, it is possible to update the cluster version to 3.9, since all cluster members will be compatible with the new cluster version. Once cluster version is updated to 3.9, further communication among members will take place in 3.9 and all new features and functionality of version 3.9 will be available.

Specified by:

getClusterVersion in interface Cluster

Returns:

the version at which this cluster operates.

getHotRestartService

public HotRestartService getHotRestartService()

Description copied from interface: Cluster

Returns the Hot Restart service for interacting with Hot Restart.

Specified by:

getHotRestartService in interface Cluster

Returns:

the hot restart service

changeClusterVersion

public void changeClusterVersion(Version version)

Description copied from interface: Cluster

Changes the cluster version transactionally. Internally this method uses the same transaction infrastructure as Cluster.changeClusterState(ClusterState) and the transaction defaults are the same in this case as well (TWO_PHASE transaction with durability 1 by default).

If the requested cluster version is same as the current one, nothing happens.

If a member of the cluster is not compatible with the given cluster version, as implemented by NodeExtension.isNodeVersionCompatibleWith(Version), then a VersionMismatchException is thrown.

If an invalid version transition is requested, for example changing to a different major version, an IllegalArgumentException is thrown.

If a membership change occurs in the cluster during locking phase, a new member joins or an existing member leaves, then this method will fail with an IllegalStateException.

Likewise, once locking phase is completed successfully, Cluster.getClusterState() will report being ClusterState.IN_TRANSITION, disallowing membership changes until the new cluster version is committed.

Specified by:

changeClusterVersion in interface Cluster

Parameters:

version - new version of the cluster

changeClusterVersion

public void changeClusterVersion(Version version,
                                 com.hazelcast.internal.cluster.impl.MemberMap memberMap)

changeClusterVersion

public void changeClusterVersion(Version version,
                                 TransactionOptions options)

Description copied from interface: Cluster

Changes the cluster version transactionally, with the transaction options provided. Internally this method uses the same transaction infrastructure as Cluster.changeClusterState(ClusterState, TransactionOptions). The transaction options must specify a TWO_PHASE transaction.

If the requested cluster version is same as the current one, nothing happens.

If a member of the cluster is not compatible with the given cluster version, as implemented by NodeExtension.isNodeVersionCompatibleWith(Version), then a VersionMismatchException is thrown.

If an invalid version transition is requested, for example changing to a different major version, an IllegalArgumentException is thrown.

If a membership change occurs in the cluster during locking phase, a new member joins or an existing member leaves, then this method will fail with an IllegalStateException.

Likewise, once locking phase is completed successfully, Cluster.getClusterState() will report being ClusterState.IN_TRANSITION, disallowing membership changes until the new cluster version is committed.

Specified by:

changeClusterVersion in interface Cluster

Parameters:

version - new version of the cluster

options - options by which to execute the transaction

getMemberListJoinVersion

public int getMemberListJoinVersion()

Description copied from interface: ClusterService

Returns the member list join version of the local member instance.

The join algorithm assigns different member list join versions to each member in the cluster. If two members join at the same time, they will appear on different version of member list.

The uniqueness guarantee of member list join versions is provided except the following scenario: when there is a split-brain issue, if a new node joins to any sub-cluster, it can get a duplicate member list join version, i.e., its member list join version can be assigned to another node in the other sub-cluster(s).

When duplicate member list join version is assigned during network split, the returned value can change to make it unique again. Therefore the caller should call this method repeatedly.

Specified by:

getMemberListJoinVersion in interface ClusterService

Returns:

the member list join version of the local member instance

shutdown

public void shutdown()

Description copied from interface: Cluster

Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node. Transaction will be TWO_PHASE and will have 1 durability by default. If you want to override transaction options, use Cluster.shutdown(TransactionOptions).

If the cluster is already in ClusterState.PASSIVE, shutdown process begins immediately. All the node join / leave rules described in ClusterState.PASSIVE state also applies here.

Any node can start the shutdown process. A shutdown command is sent to other nodes periodically until either all other nodes leave the cluster or a configurable timeout occurs (see GroupProperty.CLUSTER_SHUTDOWN_TIMEOUT_SECONDS). If some of the nodes do not shutdown before the timeout duration, shutdown can be also invoked on them.

Specified by:

shutdown in interface Cluster

See Also:

GroupProperty.CLUSTER_SHUTDOWN_TIMEOUT_SECONDS, Cluster.changeClusterState(ClusterState), ClusterState.PASSIVE

shutdown

public void shutdown(TransactionOptions options)

Description copied from interface: Cluster

Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node. Transaction must be a TWO_PHASE transaction.

If the cluster is already in ClusterState.PASSIVE, shutdown process begins immediately. All the node join / leave rules described in ClusterState.PASSIVE state also applies here.

Any node can start the shutdown process. A shutdown command is sent to other nodes periodically until either all other nodes leave the cluster or a configurable timeout occurs (see GroupProperty.CLUSTER_SHUTDOWN_TIMEOUT_SECONDS). If some of the nodes do not shutdown before the timeout duration, shutdown can be also invoked on them.

Specified by:

shutdown in interface Cluster

Parameters:

options - transaction options

See Also:

GroupProperty.CLUSTER_SHUTDOWN_TIMEOUT_SECONDS, Cluster.changeClusterState(ClusterState), ClusterState.PASSIVE

getMembershipManager

public MembershipManager getMembershipManager()

getClusterStateManager

public ClusterStateManager getClusterStateManager()

getClusterJoinManager

public ClusterJoinManager getClusterJoinManager()

getClusterHeartbeatManager

public ClusterHeartbeatManager getClusterHeartbeatManager()

promoteLocalLiteMember

public void promoteLocalLiteMember()

Description copied from interface: Cluster

Promotes local lite member to data member. When this method returns both Cluster.getLocalMember() and Cluster.getMembers() reflects the promotion.

Specified by:

promoteLocalLiteMember in interface Cluster

getMemberListVersion

public int getMemberListVersion()

Description copied from interface: ClusterService

Returns the current version of member list.

Specified by:

getMemberListVersion in interface ClusterService

Returns:

current version of member list

toString

public String toString()

Overrides:

toString in class Object