com.hazelcast.core

Interface PartitionService

All Known Implementing Classes:

PartitionServiceProxy, PartitionServiceProxy

public interface PartitionService

PartitionService allows to query Partitions and attach/detach MigrationListeners to listen to partition migration events. The methods on the PartitionService are thread-safe.

See Also:

Partition, MigrationListener

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.

Method Detail

getPartitions

Set<Partition> getPartitions()

Returns a set containing all the Partitions in the cluster.

Returns:

all partitions

getPartition

Partition getPartition(Object key)

Returns partition which given key belongs to.

Parameters:

key - key

Returns:

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

randomPartitionKey

String randomPartitionKey()

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.

Returns:

the random partition key.

addMigrationListener

String addMigrationListener(MigrationListener migrationListener)

Adds a MigrationListener.

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

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

Parameters:

migrationListener - listener

Returns:

returns registration id.

Throws:

NullPointerException - if migrationListener is null.

UnsupportedOperationException - if this operation isn't supported. For example on the client side it isn't possible to add a MigrationListener.

See Also:

removeMigrationListener(String)

removeMigrationListener

boolean removeMigrationListener(String registrationId)

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.

Parameters:

registrationId - Id of listener registration.

Returns:

true if listener is removed, false otherwise.

Throws:

NullPointerException - if registrationId is null.

UnsupportedOperationException - if this operation isn't supported. For example on the client side it isn't possible to add/remove a MigrationListener.

See Also:

addMigrationListener(MigrationListener)

isClusterSafe

boolean isClusterSafe()

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

Returns:

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

Since:

3.3

isMemberSafe

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.

Parameters:

member - Cluster member to query.

Returns:

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

Since:

3.3

isLocalMemberSafe

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.

Since:

3.3

forceLocalMemberToBeSafe

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.

Since:

3.3