com.hazelcast.client.proxy

Class PartitionServiceProxy

java.lang.Object

com.hazelcast.client.proxy.PartitionServiceProxy

All Implemented Interfaces:

PartitionService

public final class PartitionServiceProxy
extends Object
implements PartitionService

Author:

mdogan 5/16/13

Constructor Summary

Constructors

Constructor and Description
PartitionServiceProxy(ClientPartitionService partitionService)

Method Summary

Methods

Modifier and Type	Method and Description
String	addMigrationListener(MigrationListener migrationListener) Adds a MigrationListener.
boolean	forceLocalMemberToBeSafe(long timeout, TimeUnit unit) Force local member to be safe by checking and syncing partitions those owned by local member with at least one of the backups.
Partition	getPartition(Object key) Returns partition which given key belongs to.
Set<Partition>	getPartitions() Returns a set containing all the Partitions in the cluster.
boolean	isClusterSafe() Checks whether the cluster is in a safe state.
boolean	isLocalMemberSafe() Check if local member is safe to shutdown, means check if at least one backup of the partitions those owned by local member are in sync with primary.
boolean	isMemberSafe(Member member) Check if the given member is safe to shutdown, means check if at least one backup of the partitions those owned by given member are in sync with primary.
String	randomPartitionKey() Generates a random partition key.
boolean	removeMigrationListener(String registrationId) Removes a MigrationListener.

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionServiceProxy

public PartitionServiceProxy(ClientPartitionService partitionService)

Method Detail

randomPartitionKey

public String randomPartitionKey()

Description copied from interface: PartitionService

Generates a random partition key. This is useful if you want to partition data in the same partition, but don't care which partition it is going to be.

The returned value will never be null.

Specified by:

randomPartitionKey in interface PartitionService

Returns:

the random partition key.

getPartitions

public Set<Partition> getPartitions()

Description copied from interface: PartitionService

Returns a set containing all the Partitions in the cluster.

Specified by:

getPartitions in interface PartitionService

Returns:

all partitions

getPartition

public Partition getPartition(Object key)

Description copied from interface: PartitionService

Returns partition which given key belongs to.

Specified by:

getPartition in interface PartitionService

Parameters:

key - key

Returns:

partition which given key belongs to todo: what about null.

addMigrationListener

public String addMigrationListener(MigrationListener migrationListener)

Description copied from interface: PartitionService

Adds a MigrationListener.

The addMigrationListener returns a register-id. This id is needed to remove the MigrationListener using the PartitionService.removeMigrationListener(String) method.

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

Specified by:

addMigrationListener in interface PartitionService

Parameters:

migrationListener - listener

Returns:

returns registration id.

See Also:

PartitionService.removeMigrationListener(String)

removeMigrationListener

public boolean removeMigrationListener(String registrationId)

Description copied from interface: PartitionService

Removes a MigrationListener.

If the same MigrationListener is registered multiple times, it needs to be removed multiple times.

This method can safely be called multiple times for the same registration-id; every subsequent call is just ignored.

Specified by:

removeMigrationListener in interface PartitionService

Parameters:

registrationId - Id of listener registration.

Returns:

true if listener is removed, false otherwise.

See Also:

PartitionService.addMigrationListener(MigrationListener)

isClusterSafe

public boolean isClusterSafe()

Description copied from interface: PartitionService

Checks whether the cluster is in a safe state. When in a safe state it is permissible to shut down a server instance.

Specified by:

isClusterSafe in interface PartitionService

Returns:

true if there are no partitions being migrated, and there are sufficient backups for each partition per the configuration, otherwise false.

isMemberSafe

public boolean isMemberSafe(Member member)

Description copied from interface: PartitionService

Check if the given member is safe to shutdown, means check if at least one backup of the partitions those owned by given member are in sync with primary.

Specified by:

isMemberSafe in interface PartitionService

Parameters:

member - Cluster member to query.

Returns:

true if member in a safe state, other wise false.

isLocalMemberSafe

public boolean isLocalMemberSafe()

Description copied from interface: PartitionService

Check if local member is safe to shutdown, means check if at least one backup of the partitions those owned by local member are in sync with primary.

Specified by:

isLocalMemberSafe in interface PartitionService

forceLocalMemberToBeSafe

public boolean forceLocalMemberToBeSafe(long timeout,
                               TimeUnit unit)

Description copied from interface: PartitionService

Force local member to be safe by checking and syncing partitions those owned by local member with at least one of the backups.

Specified by:

forceLocalMemberToBeSafe in interface PartitionService