com.hazelcast.collection.impl.collection

Class CollectionService

java.lang.Object

com.hazelcast.collection.impl.collection.CollectionService

All Implemented Interfaces:

EventPublishingService<CollectionEvent,ItemListener<Data>>, ManagedService, MigrationAwareService, QuorumAwareService, RemoteService, SplitBrainHandlerService, TransactionalService

Direct Known Subclasses:

ListService, SetService

public abstract class CollectionService
extends Object
implements ManagedService, RemoteService, EventPublishingService<CollectionEvent,ItemListener<Data>>, TransactionalService, MigrationAwareService, QuorumAwareService, SplitBrainHandlerService

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeEngine	nodeEngine
protected IPartitionService	partitionService
protected SerializationService	serializationService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
void	addContainer(String name, CollectionContainer container)
void	beforeMigration(PartitionMigrationEvent event) 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.
void	destroyDistributedObject(String name) Destroys a distributed object.
void	dispatchEvent(CollectionEvent event, ItemListener<Data> listener) Notifies the service of a published event.
abstract ConcurrentMap<String,? extends CollectionContainer>	getContainerMap()
protected Map<String,CollectionContainer>	getMigrationData(PartitionReplicationEvent event)
abstract CollectionContainer	getOrCreateContainer(String name, boolean backup)
abstract String	getServiceName()
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
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.
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

Methods inherited from interface com.hazelcast.spi.RemoteService

createDistributedObject

Methods inherited from interface com.hazelcast.spi.TransactionalService

createTransactionalObject

Methods inherited from interface com.hazelcast.spi.MigrationAwareService

prepareReplicationOperation

Methods inherited from interface com.hazelcast.spi.QuorumAwareService

getQuorumName

Field Detail

nodeEngine

protected final NodeEngine nodeEngine

serializationService

protected final SerializationService serializationService

partitionService

protected final IPartitionService partitionService

Constructor Detail

CollectionService

protected CollectionService(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

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

getOrCreateContainer

public abstract CollectionContainer getOrCreateContainer(String name,
                                                         boolean backup)

getContainerMap

public abstract ConcurrentMap<String,? extends CollectionContainer> getContainerMap()

getServiceName

public abstract String getServiceName()

dispatchEvent

public void dispatchEvent(CollectionEvent event,
                          ItemListener<Data> listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<CollectionEvent,ItemListener<Data>>

Parameters:

event - the published event

listener - the listener registered for this event

rollbackTransaction

public void rollbackTransaction(String transactionId)

Specified by:

rollbackTransaction in interface TransactionalService

beforeMigration

public void beforeMigration(PartitionMigrationEvent event)

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:

event - migration event

getMigrationData

protected Map<String,CollectionContainer> getMigrationData(PartitionReplicationEvent event)

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

addContainer

public void addContainer(String name,
                         CollectionContainer container)

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