com.hazelcast.map.impl

Class MapService

java.lang.Object

com.hazelcast.map.impl.MapService

All Implemented Interfaces:

ClusterStateListener, ClientAwareService, EventPublishingService<Object,ListenerAdapter>, FragmentedMigrationAwareService, LockInterceptorService<Data>, ManagedService, MigrationAwareService, NotifiableEventListener, PartitionAwareService, PostJoinAwareService, QuorumAwareService, RemoteService, ReplicationSupportingService, SplitBrainHandlerService, StatisticsAwareService<LocalMapStats>, TransactionalService

public class MapService
extends Object
implements ManagedService, FragmentedMigrationAwareService, TransactionalService, RemoteService, EventPublishingService<Object,ListenerAdapter>, PostJoinAwareService, SplitBrainHandlerService, ReplicationSupportingService, StatisticsAwareService<LocalMapStats>, PartitionAwareService, ClientAwareService, QuorumAwareService, NotifiableEventListener, ClusterStateListener, LockInterceptorService<Data>

Defines map service behavior.

See Also:

MapManagedService, MapMigrationAwareService, MapTransactionalService, MapRemoteService, MapEventPublishingService, MapPostJoinAwareService, MapSplitBrainHandlerService, MapReplicationSupportingService, MapStatisticsAwareService, MapPartitionAwareService, MapQuorumAwareService, MapClientAwareService, MapServiceContext

Field Summary

Fields

Modifier and Type	Field and Description
protected ClientAwareService	clientAwareService
protected EventPublishingService	eventPublishingService
protected ManagedService	managedService
protected MapServiceContext	mapServiceContext
protected CountingMigrationAwareService	migrationAwareService
protected PartitionAwareService	partitionAwareService
protected PostJoinAwareService	postJoinAwareService
protected MapQuorumAwareService	quorumAwareService
protected RemoteService	remoteService
protected ReplicationSupportingService	replicationSupportingService
static String	SERVICE_NAME
protected SplitBrainHandlerService	splitBrainHandlerService
protected StatisticsAwareService	statisticsAwareService
protected TransactionalService	transactionalService

Constructor Summary

Constructors

Constructor and Description
MapService()

Method Summary

Modifier and Type	Method and Description
void	beforeMigration(PartitionMigrationEvent event) Called before migration process starts, on both source and destination members.
void	clientDisconnected(String clientUuid) Invoked when a client disconnects from a member.
void	commitMigration(PartitionMigrationEvent event) Commits the migration process for this service, on both source and destination members.
DistributedObject	createDistributedObject(String objectName) Creates a distributed object.
<T extends TransactionalObject> T	createTransactionalObject(String name, Transaction transaction)
void	destroyDistributedObject(String objectName) Destroys a distributed object.
void	dispatchEvent(Object event, ListenerAdapter listener) Notifies the service of a published event.
Collection<ServiceNamespace>	getAllServiceNamespaces(PartitionReplicationEvent event) Returns all known namespaces for given replication event.
MapServiceContext	getMapServiceContext()
int	getMigrationStamp()
static ObjectNamespace	getObjectNamespace(String mapName)
Operation	getPostJoinOperation() Post join operations must be lock free, meaning no locks at all: no partition locks, no key-based locks, no service level locks, no database interaction! The Operation.getPartitionId() method should return a negative value.
String	getQuorumName(String name) Gets the name of the quorum associated with specified operation name.
Map<String,LocalMapStats>	getStats() Return the service statistics for the local instance.
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
boolean	isKnownServiceNamespace(ServiceNamespace namespace) Returns true if namespace is known by this service, false otherwise
void	onBeforeLock(String distributedObjectName, Data key)
void	onClusterStateChange(ClusterState newState) Called when cluster state is changed
void	onDeregister(Object service, String serviceName, String topic, EventRegistration registration) Called when this listener deregistered from EventService.
void	onPartitionLost(IPartitionLostEvent partitionLostEvent) Invoked when a partition lost is detected
void	onRegister(Object service, String serviceName, String topic, EventRegistration registration) Called when this listener registered to EventService.
void	onReplicationEvent(WanReplicationEvent replicationEvent) Processes a WAN replication event
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	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.
boolean	validateMigrationStamp(int stamp)

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

managedService

protected ManagedService managedService

migrationAwareService

protected CountingMigrationAwareService migrationAwareService

transactionalService

protected TransactionalService transactionalService

remoteService

protected RemoteService remoteService

eventPublishingService

protected EventPublishingService eventPublishingService

postJoinAwareService

protected PostJoinAwareService postJoinAwareService

splitBrainHandlerService

protected SplitBrainHandlerService splitBrainHandlerService

replicationSupportingService

protected ReplicationSupportingService replicationSupportingService

statisticsAwareService

protected StatisticsAwareService statisticsAwareService

partitionAwareService

protected PartitionAwareService partitionAwareService

clientAwareService

protected ClientAwareService clientAwareService

quorumAwareService

protected MapQuorumAwareService quorumAwareService

mapServiceContext

protected MapServiceContext mapServiceContext

Constructor Detail

MapService

public MapService()

Method Detail

dispatchEvent

public void dispatchEvent(Object event,
                          ListenerAdapter listener)

Description copied from interface: EventPublishingService

Notifies the service of a published event.

Specified by:

dispatchEvent in interface EventPublishingService<Object,ListenerAdapter>

Parameters:

event - the published event

listener - the listener registered for this event

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

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

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)

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

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

getPostJoinOperation

public Operation getPostJoinOperation()

Description copied from interface: PostJoinAwareService

Post join operations must be lock free, meaning no locks at all: no partition locks, no key-based locks, no service level locks, no database interaction! The Operation.getPartitionId() method should return a negative value. This means that the operations should not implement PartitionAwareOperation.

Post join operations should return response, at least a null response.

Specified by:

getPostJoinOperation in interface PostJoinAwareService

Returns:

a response from the post join operation. Can be null.

createDistributedObject

public DistributedObject createDistributedObject(String objectName)

Description copied from interface: RemoteService

Creates a distributed object.

Specified by:

createDistributedObject in interface RemoteService

Parameters:

objectName - the name for the created distributed object

Returns:

the created distributed object

destroyDistributedObject

public void destroyDistributedObject(String objectName)

Description copied from interface: RemoteService

Destroys a distributed object.

Specified by:

destroyDistributedObject in interface RemoteService

Parameters:

objectName - the name of the distributed object to destroy

onReplicationEvent

public void onReplicationEvent(WanReplicationEvent replicationEvent)

Description copied from interface: ReplicationSupportingService

Processes a WAN replication event

Specified by:

onReplicationEvent in interface ReplicationSupportingService

Parameters:

replicationEvent - the event

onPartitionLost

public void onPartitionLost(IPartitionLostEvent partitionLostEvent)

Description copied from interface: PartitionAwareService

Invoked when a partition lost is detected

Specified by:

onPartitionLost in interface PartitionAwareService

Parameters:

partitionLostEvent - The event object that contains the partition ID and the number of replicas that is lost

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

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

getStats

public Map<String,LocalMapStats> getStats()

Description copied from interface: StatisticsAwareService

Return the service statistics for the local instance.

Specified by:

getStats in interface StatisticsAwareService<LocalMapStats>

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

getMapServiceContext

public MapServiceContext getMapServiceContext()

clientDisconnected

public void clientDisconnected(String clientUuid)

Description copied from interface: ClientAwareService

Invoked when a client disconnects from a member.

Specified by:

clientDisconnected in interface ClientAwareService

Parameters:

clientUuid - the UUID of the client that disconnected from a member

onRegister

public void onRegister(Object service,
                       String serviceName,
                       String topic,
                       EventRegistration registration)

Description copied from interface: NotifiableEventListener

Called when this listener registered to EventService.

Specified by:

onRegister in interface NotifiableEventListener

Parameters:

service - the service instance that event belongs to

serviceName - name of the service that event belongs to

topic - name of the topic that event belongs to

registration - the EventRegistration instance that holds information about the registration

onDeregister

public void onDeregister(Object service,
                         String serviceName,
                         String topic,
                         EventRegistration registration)

Description copied from interface: NotifiableEventListener

Called when this listener deregistered from EventService.

Specified by:

onDeregister in interface NotifiableEventListener

Parameters:

service - the service instance that event belongs to

serviceName - name of the service that event belongs to

topic - name of the topic that event belongs to

registration - the EventRegistration instance that holds information about the registration

getMigrationStamp

public int getMigrationStamp()

validateMigrationStamp

public boolean validateMigrationStamp(int stamp)

onClusterStateChange

public void onClusterStateChange(ClusterState newState)

Description copied from interface: ClusterStateListener

Called when cluster state is changed

Specified by:

onClusterStateChange in interface ClusterStateListener

Parameters:

newState - new cluster state

See Also:

ClusterState

onBeforeLock

public void onBeforeLock(String distributedObjectName,
                         Data key)

Specified by:

onBeforeLock in interface LockInterceptorService<Data>

getObjectNamespace

public static ObjectNamespace getObjectNamespace(String mapName)