com.hazelcast.client.proxy

Class ClientClusterProxy

java.lang.Object

com.hazelcast.client.proxy.ClientClusterProxy

All Implemented Interfaces:

Cluster

public class ClientClusterProxy
extends Object
implements Cluster

Client implementation of the Cluster.

Constructor Summary

Constructors

Constructor and Description
ClientClusterProxy(ClientClusterServiceImpl clusterService)

Method Summary

Methods

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 transactionOptions) Changes state of the cluster to the given state transactionally.
ClusterState	getClusterState() Returns the state of the cluster.
long	getClusterTime() Returns the cluster-wide time in milliseconds.
Member	getLocalMember() Returns this Hazelcast instance member.
Set<Member>	getMembers() Set of the current members in the cluster.
boolean	removeMembershipListener(String registrationId) Removes the specified MembershipListener.
void	shutdown() Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node.
void	shutdown(TransactionOptions transactionOptions) Changes state of the cluster to the ClusterState.PASSIVE transactionally, then triggers the shutdown process on each node.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientClusterProxy

public ClientClusterProxy(ClientClusterServiceImpl clusterService)

Method Detail

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)

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

getLocalMember

public Member getLocalMember()

Description copied from interface: Cluster

Returns this Hazelcast instance member.

Specified by:

getLocalMember in interface Cluster

Returns:

this Hazelcast instance member

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

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

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 transactionOptions)

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

transactionOptions - transaction options

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. 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:

com.hazelcast.instance.GroupProperty#CLUSTER_SHUTDOWN_TIMEOUT_SECONDS}, #changeClusterState(ClusterState)}, ClusterState#PASSIVE}

shutdown

public void shutdown(TransactionOptions transactionOptions)

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. 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:

transactionOptions - transaction options

See Also:

com.hazelcast.instance.GroupProperty#CLUSTER_SHUTDOWN_TIMEOUT_SECONDS}, #changeClusterState(ClusterState)}, ClusterState#PASSIVE}