com.hazelcast.cache.impl

Class CacheService

java.lang.Object

com.hazelcast.cache.impl.AbstractCacheService

com.hazelcast.cache.impl.CacheService

All Implemented Interfaces:

ICacheService, ClusterStateListener, EventPublishingService<Object,CacheEventListener>, FragmentedMigrationAwareService, ManagedService, MigrationAwareService, PartitionAwareService, PreJoinAwareService, QuorumAwareService, RemoteService, SplitBrainHandlerService

public class CacheService
extends AbstractCacheService

Cache Service is the main access point of JCache implementation.

This service is responsible for:

• Creating and/or accessing the named CacheRecordStore.
• Creating/Deleting the cache configuration of the named ICache.
• Registering/Deregistering of cache listeners.
• Publish/dispatch cache events.
• Enabling/Disabling statistic and management.
• Data migration commit/rollback through MigrationAwareService.

WARNING:This service is an optionally registered service which is enabled when JCache is located on the classpath, as determined by JCacheDetector.isJCacheAvailable(ClassLoader).

If registered, it will provide all the above cache operations for all partitions of the node which it is registered on.

Distributed Cache Name is used for providing a unique name to a cache object to overcome cache manager scoping which depends on URI and class loader parameters. It's a simple concatenation of CacheNamePrefix and cache name where CacheNamePrefix is calculated by each cache manager using AbstractHazelcastCacheManager.getCacheNamePrefix().

Field Summary

Fields inherited from class com.hazelcast.cache.impl.AbstractCacheService

cacheContexts, cacheContextsConstructorFunction, cacheEventHandler, cacheResourcesConstructorFunction, cacheResourcesMutexFactory, cacheStatisticsConstructorFunction, clearExpiredRecordsTask, closeableListeners, configs, eventJournal, expirationManager, logger, mergePolicyProvider, nodeEngine, operationProviderCache, resources, segments, splitBrainHandlerService, statistics, TENANT_CONTROL_FACTORY

Fields inherited from interface com.hazelcast.cache.impl.ICacheService

CACHE_SUPPORT_NOT_AVAILABLE_ERROR_MESSAGE, MAX_ADD_CACHE_CONFIG_RETRIES, SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
CacheService()

Method Summary

Modifier and Type	Method and Description
void	commitMigration(PartitionMigrationEvent event) Commits the migration process for this service, on both source and destination members.
protected ICacheRecordStore	createNewRecordStore(String cacheNameWithPrefix, int partitionId)
protected CacheOperationProvider	createOperationProvider(String nameWithPrefix, InMemoryFormat inMemoryFormat)
Collection<ServiceNamespace>	getAllServiceNamespaces(PartitionReplicationEvent event) Returns all known namespaces for given replication event.
CacheWanEventPublisher	getCacheWanEventPublisher() Returns the WAN event publisher responsible for publishing primary and backup WAN events for caches.
static ObjectNamespace	getObjectNamespace(String cacheName)
boolean	isKnownServiceNamespace(ServiceNamespace namespace) Returns true if namespace is known by this service, false otherwise
boolean	isWanReplicationEnabled(String cacheNameWithPrefix) Returns true if WAN replication is enabled for the cache named cacheNameWithPrefix.
protected CacheReplicationOperation	newCacheReplicationOperation()
protected CachePartitionSegment	newPartitionSegment(int partitionId)
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	rollbackMigration(PartitionMigrationEvent event) Rollback the migration process for this service, on both source and destination members.
String	toString()

Methods inherited from class com.hazelcast.cache.impl.AbstractCacheService

addCacheResource, addInvalidationListener, beforeMigration, cacheEntryListenerDeregistered, cacheEntryListenerRegistered, closeSegments, createCacheConfigOnAllMembers, createCacheConfigOnAllMembersAsync, createCacheStatIfAbsent, createDistributedObject, deleteCache, deleteCacheConfig, deleteCacheResources, deleteCacheStat, deregisterAllListener, deregisterListener, destroyDistributedObject, destroySegments, dispatchEvent, findCacheConfig, getCacheConfig, getCacheConfigs, getCacheContext, getCacheEventHandler, getCacheOperationProvider, getConfigs, getEventJournal, getExpirationManager, getMergePolicy, getMergePolicyProvider, getNodeEngine, getOrCreateCacheContext, getOrCreateRecordStore, getPartitionSegments, getPreJoinOperation, getQuorumName, getRecordStore, getSegment, getStatistics, init, onClusterStateChange, onPartitionLost, postInit, prepareMergeRunnable, publishCachePartitionLostEvent, publishEvent, publishEvent, putCacheConfigIfAbsent, registerListener, registerListener, registerListenerInternal, reset, sendInvalidationEvent, setManagementEnabled, setStatisticsEnabled, setTenantControl, shutdown, toData, toObject

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheService

public CacheService()

Method Detail

newPartitionSegment

protected CachePartitionSegment newPartitionSegment(int partitionId)

Specified by:

newPartitionSegment in class AbstractCacheService

createNewRecordStore

protected ICacheRecordStore createNewRecordStore(String cacheNameWithPrefix,
                                                 int partitionId)

Specified by:

createNewRecordStore in class AbstractCacheService

createOperationProvider

protected CacheOperationProvider createOperationProvider(String nameWithPrefix,
                                                         InMemoryFormat inMemoryFormat)

Specified by:

createOperationProvider in class AbstractCacheService

getAllServiceNamespaces

public Collection<ServiceNamespace> getAllServiceNamespaces(PartitionReplicationEvent event)

Description copied from interface: FragmentedMigrationAwareService

Returns all known namespaces for given replication event.

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

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.

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.

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)

newCacheReplicationOperation

protected CacheReplicationOperation newCacheReplicationOperation()

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

Overrides:

commitMigration in class AbstractCacheService

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

Overrides:

rollbackMigration in class AbstractCacheService

Parameters:

event - migration event

toString

public String toString()

Overrides:

toString in class Object

isWanReplicationEnabled

public boolean isWanReplicationEnabled(String cacheNameWithPrefix)

Description copied from interface: ICacheService

Returns true if WAN replication is enabled for the cache named cacheNameWithPrefix.

Parameters:

cacheNameWithPrefix - the full name of the ICache, including the manager scope prefix

getCacheWanEventPublisher

public CacheWanEventPublisher getCacheWanEventPublisher()

Description copied from interface: ICacheService

Returns the WAN event publisher responsible for publishing primary and backup WAN events for caches.

getObjectNamespace

public static ObjectNamespace getObjectNamespace(String cacheName)