com.hazelcast.multimap.impl

Class MultiMapService

java.lang.Object

com.hazelcast.multimap.impl.MultiMapService

All Implemented Interfaces:

EventPublishingService<EventData,EntryListener>, FragmentedMigrationAwareService, LockInterceptorService<Data>, ManagedService, MigrationAwareService, QuorumAwareService, RemoteService, SplitBrainHandlerService, StatisticsAwareService<LocalMultiMapStats>, TransactionalService

public class MultiMapService
extends Object
implements ManagedService, RemoteService, FragmentedMigrationAwareService, EventPublishingService<EventData,EntryListener>, TransactionalService, StatisticsAwareService<LocalMultiMapStats>, QuorumAwareService, SplitBrainHandlerService, LockInterceptorService<Data>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
MultiMapService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
String	addListener(String name, EventListener listener, Data key, boolean includeValue, boolean local)
void	beforeMigration(PartitionMigrationEvent partitionMigrationEvent) Called before migration process starts, on both source and destination members.
void	commitMigration(PartitionMigrationEvent event) Commits the migration process for this service, on both source and destination members.
DistributedObject	createDistributedObject(String name) Creates a distributed object.
LocalMultiMapStats	createStats(String name)
<T extends TransactionalObject> T	createTransactionalObject(String name, Transaction transaction)
void	destroyDistributedObject(String name) Destroys a distributed object.
void	dispatchEvent(EventData event, EntryListener listener) Notifies the service of a published event.
void	ensureQuorumPresent(String distributedObjectName, QuorumType requiredQuorumPermissionType)
Collection<ServiceNamespace>	getAllServiceNamespaces(PartitionReplicationEvent event) Returns all known namespaces for given replication event.
LocalMultiMapStatsImpl	getLocalMultiMapStatsImpl(String name)
NodeEngine	getNodeEngine()
MultiMapContainer	getOrCreateCollectionContainer(int partitionId, String name)
MultiMapContainer	getOrCreateCollectionContainerWithoutAccess(int partitionId, String name)
MultiMapPartitionContainer	getPartitionContainer(int partitionId)
String	getQuorumName(String name) Gets the name of the quorum associated with specified operation name.
SerializationService	getSerializationService()
Map<String,LocalMultiMapStats>	getStats() Return the service statistics for the local instance.
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	insertMigratedData(int partitionId, Map<String,Map<Data,MultiMapValue>> map)
boolean	isKnownServiceNamespace(ServiceNamespace namespace) Returns true if namespace is known by this service, false otherwise
Set<Data>	localKeySet(String name)
void	onBeforeLock(String distributedObjectName, Data key)
Runnable	prepareMergeRunnable() When the two separate clusters merge (resolve a split-brain), this method is called to return a Runnable, that will merge the clusters.
Operation	prepareReplicationOperation(PartitionReplicationEvent event) Returns an operation to replicate service data and/or state for a specific partition replica on another cluster member.
Operation	prepareReplicationOperation(PartitionReplicationEvent event, Collection<ServiceNamespace> namespaces) Returns an operation to replicate service data and/or state for a specific partition replica and namespaces on another cluster member.
void	publishEntryEvent(String multiMapName, EntryEventType eventType, Data key, Object newValue, Object oldValue)
void	publishMultiMapEvent(String mapName, EntryEventType eventType, int numberOfEntriesAffected)
boolean	removeListener(String name, String registrationId)
void	reset() Resets this service back to its initial state.
void	rollbackMigration(PartitionMigrationEvent event) Rollback the migration process for this service, on both source and destination members.
void	rollbackTransaction(String transactionId)
void	shutdown(boolean terminate) Shuts down this service.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

MultiMapService

public MultiMapService(NodeEngine nodeEngine)

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)

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

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

getOrCreateCollectionContainer

public MultiMapContainer getOrCreateCollectionContainer(int partitionId,
                                                        String name)

getOrCreateCollectionContainerWithoutAccess

public MultiMapContainer getOrCreateCollectionContainerWithoutAccess(int partitionId,
                                                                     String name)

getPartitionContainer

public MultiMapPartitionContainer getPartitionContainer(int partitionId)

createDistributedObject

public DistributedObject createDistributedObject(String name)

Description copied from interface: RemoteService

Creates a distributed object.

Specified by:

createDistributedObject in interface RemoteService

Parameters:

name - the name for the created distributed object

Returns:

the created distributed object

destroyDistributedObject

public void destroyDistributedObject(String name)

Description copied from interface: RemoteService

Destroys a distributed object.

Specified by:

destroyDistributedObject in interface RemoteService

Parameters:

name - the name of the distributed object to destroy

localKeySet

public Set<Data> localKeySet(String name)

getSerializationService

public SerializationService getSerializationService()

getNodeEngine

public NodeEngine getNodeEngine()

publishMultiMapEvent

public void publishMultiMapEvent(String mapName,
                                 EntryEventType eventType,
                                 int numberOfEntriesAffected)

publishEntryEvent

public final void publishEntryEvent(String multiMapName,
                                    EntryEventType eventType,
                                    Data key,
                                    Object newValue,
                                    Object oldValue)

addListener

public String addListener(String name,
                          EventListener listener,
                          Data key,
                          boolean includeValue,
                          boolean local)

removeListener

public boolean removeListener(String name,
                              String registrationId)

getAllServiceNamespaces

public Collection<ServiceNamespace> getAllServiceNamespaces(PartitionReplicationEvent event)

Description copied from interface: FragmentedMigrationAwareService

Returns all known namespaces for given replication event.

Specified by:

getAllServiceNamespaces in interface FragmentedMigrationAwareService

Parameters:

event - replication event

Returns:

all known service namespaces for the replication

isKnownServiceNamespace

public boolean isKnownServiceNamespace(ServiceNamespace namespace)

Description copied from interface: FragmentedMigrationAwareService

Returns true if namespace is known by this service, false otherwise

Specified by:

isKnownServiceNamespace in interface FragmentedMigrationAwareService

Parameters:

namespace - namespace

Returns:

true if namespace is known by this service, false otherwise

beforeMigration

public void beforeMigration(PartitionMigrationEvent partitionMigrationEvent)

Description copied from interface: MigrationAwareService

Called before migration process starts, on both source and destination members.

Service can take actions required before migration. Migration process will block until this method returns. If this method fails by throwing an exception, migration process for specific partition will fail and will be rolled back.

Specified by:

beforeMigration in interface MigrationAwareService

Parameters:

partitionMigrationEvent - migration event

prepareReplicationOperation

public Operation prepareReplicationOperation(PartitionReplicationEvent event)

Description copied from interface: MigrationAwareService

Returns an operation to replicate service data and/or state for a specific partition replica on another cluster member.

This method will be called on source member whenever partitioning system requires to copy/replicate a partition replica. Returned operation will be executed on destination member. If operation fails by throwing exception, migration process will fail and will be rolled back.

Returning null is allowed and means service does not have anything to replicate.

Specified by:

prepareReplicationOperation in interface MigrationAwareService

Parameters:

event - replication

Returns:

replication operation or null if nothing will be replicated

prepareReplicationOperation

public Operation prepareReplicationOperation(PartitionReplicationEvent event,
                                             Collection<ServiceNamespace> namespaces)

Description copied from interface: FragmentedMigrationAwareService

Returns an operation to replicate service data and/or state for a specific partition replica and namespaces on another cluster member. This method is very similar to MigrationAwareService.prepareReplicationOperation(PartitionReplicationEvent), instead of copying whole partition replica, allows copying only some portion of replica, specified by given namespaces.

This method will be called on source member whenever partitioning system requires to copy/replicate a partition replica. Returned operation will be executed on destination member. If operation fails by throwing exception, migration process will fail and will be rolled back.

Returning null is allowed and means service does not have anything to replicate.

Specified by:

prepareReplicationOperation in interface FragmentedMigrationAwareService

Parameters:

event - replication event

namespaces - replica fragment namespaces to replicate

Returns:

replication operation or null if nothing will be replicated

See Also:

MigrationAwareService.prepareReplicationOperation(PartitionReplicationEvent)

insertMigratedData

public void insertMigratedData(int partitionId,
                               Map<String,Map<Data,MultiMapValue>> map)

commitMigration

public void commitMigration(PartitionMigrationEvent event)

Description copied from interface: MigrationAwareService

Commits the migration process for this service, on both source and destination members. This method will be called after all replication operations are executed successfully on destination and master member receives success response from all participants.

Commit is not expected to fail at this point, all exceptions will be suppressed and logged. Implementations of this method must be thread safe as this method may be called concurrently for different migrations on different partitions.

Specified by:

commitMigration in interface MigrationAwareService

Parameters:

event - migration event

rollbackMigration

public void rollbackMigration(PartitionMigrationEvent event)

Description copied from interface: MigrationAwareService

Rollback the migration process for this service, on both source and destination members. This method will be called when migration process fails at any moment. Reasons for failure may be an exception thrown on any migration step or failure(s) of any of the migration participants; either master or source or destination.

Rollback is not expected to fail at this point, all exceptions will be suppressed and logged. Implementations of this method must be thread safe as this method may be called concurrently for different migrations on different partitions.

Specified by:

rollbackMigration in interface MigrationAwareService

Parameters:

event - migration event

createStats

public LocalMultiMapStats createStats(String name)

getLocalMultiMapStatsImpl

public LocalMultiMapStatsImpl getLocalMultiMapStatsImpl(String name)

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

dispatchEvent

public void dispatchEvent(EventData event,
                          EntryListener listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<EventData,EntryListener>

Parameters:

event - the published event

listener - the listener registered for this event

getStats

public Map<String,LocalMultiMapStats> getStats()

Description copied from interface: StatisticsAwareService

Return the service statistics for the local instance.

Specified by:

getStats in interface StatisticsAwareService<LocalMultiMapStats>

Returns:

the statistics, grouped by distributed object name

getQuorumName

public String getQuorumName(String name)

Description copied from interface: QuorumAwareService

Gets the name of the quorum associated with specified operation name.

Specified by:

getQuorumName in interface QuorumAwareService

Parameters:

name - the operation name for which the quorum name is retured

Returns:

name of the associated quorum, null if there is no associated quorum

ensureQuorumPresent

public void ensureQuorumPresent(String distributedObjectName,
                                QuorumType requiredQuorumPermissionType)

prepareMergeRunnable

public Runnable prepareMergeRunnable()

Description copied from interface: SplitBrainHandlerService

When the two separate clusters merge (resolve a split-brain), this method is called to return a Runnable, that will merge the clusters.

Specified by:

prepareMergeRunnable in interface SplitBrainHandlerService

Returns:

a Runnable that will merge the clusters

onBeforeLock

public void onBeforeLock(String distributedObjectName,
                         Data key)

Specified by:

onBeforeLock in interface LockInterceptorService<Data>