com.hazelcast.cache.impl

Class EnterpriseCacheService

java.lang.Object

com.hazelcast.cache.impl.AbstractCacheService

com.hazelcast.cache.impl.CacheService

com.hazelcast.cache.impl.EnterpriseCacheService

All Implemented Interfaces:

com.hazelcast.cache.impl.ICacheService, com.hazelcast.internal.cluster.ClusterStateListener, com.hazelcast.spi.EventPublishingService<Object,com.hazelcast.cache.impl.CacheEventListener>, com.hazelcast.spi.FragmentedMigrationAwareService, com.hazelcast.spi.hotrestart.RamStoreRegistry, com.hazelcast.spi.ManagedService, com.hazelcast.spi.MigrationAwareService, com.hazelcast.spi.PartitionAwareService, com.hazelcast.spi.PreJoinAwareService, com.hazelcast.spi.QuorumAwareService, com.hazelcast.spi.RemoteService, com.hazelcast.spi.ReplicationSupportingService, com.hazelcast.spi.SplitBrainHandlerService

public class EnterpriseCacheService
extends com.hazelcast.cache.impl.CacheService
implements com.hazelcast.spi.ReplicationSupportingService, com.hazelcast.spi.hotrestart.RamStoreRegistry

The ICacheService implementation specified for enterprise usage.

This EnterpriseCacheService implementation mainly handles

• ICacheRecordStore creation of caches with specified partition ID
• Destroying segments and caches
• Mediating for cache events and listeners

When interacting with Hot Restart persistent stores, cache configurations must be persisted in the serialized form of PreJoinCacheConfig.

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
EnterpriseCacheService()

Method Summary

Modifier and Type	Method and Description
void	clearAll(int originalPartitionId) Clears all record stores on the partitions owned by partition thread of original partition.
protected com.hazelcast.cache.impl.ICacheRecordStore	createNewRecordStore(String cacheNameWithPrefix, int partitionId) Creates new ICacheRecordStore as specified InMemoryFormat.
protected com.hazelcast.cache.impl.CacheOperationProvider	createOperationProvider(String cacheNameWithPrefix, com.hazelcast.config.InMemoryFormat inMemoryFormat) Creates a CacheOperationProvider as specified InMemoryFormat for specified cacheNameWithPrefix.
com.hazelcast.config.CacheConfig	deleteCacheConfig(String cacheNameWithPrefix)
protected void	destroySegments(com.hazelcast.config.CacheConfig cacheConfig) Destroys the segments for specified cache.
int	forceEvict(String name, int originalPartitionId) Does forced eviction on one or more caches.
int	forceEvictOnAll(int originalPartitionId) Does forced eviction on all caches.
int	forceEvictOnOthers(String name, int originalPartitionId) Does forced eviction on other caches.
com.hazelcast.cache.impl.CacheOperationProvider	getCacheOperationProvider(String cacheNameWithPrefix, com.hazelcast.config.InMemoryFormat inMemoryFormat)
com.hazelcast.cache.impl.event.CacheWanEventPublisher	getCacheWanEventPublisher()
HiDensityStorageInfo	getOrCreateHiDensityCacheInfo(String cacheNameWithPrefix) Gets or creates (if there is no cache info for that Hi-Density cache) HiDensityStorageInfo instance which holds live information about cache.
EnterpriseSerializationService	getSerializationService() Gets the EnterpriseSerializationService used by this ICacheService.
boolean	isWanReplicationEnabled(String cacheNameWithPrefix)
protected com.hazelcast.cache.impl.operation.CacheReplicationOperation	newCacheReplicationOperation() Creates a HiDensityCacheReplicationOperation to start the replication.
com.hazelcast.spi.hotrestart.HotRestartStore	offHeapHotRestartStoreForPartition(int partitionId)
com.hazelcast.spi.hotrestart.HotRestartStore	onHeapHotRestartStoreForPartition(int partitionId)
void	onReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)
protected void	postInit(com.hazelcast.spi.NodeEngine nodeEngine, Properties properties)
int	prefixToThreadId(long prefix)
void	publishWanEvent(com.hazelcast.cache.impl.CacheEventContext cacheEventContext)
void	publishWanEvent(String cacheNameWithPrefix, com.hazelcast.wan.WanReplicationEvent wanReplicationEvent) Publishes a WAN event for the provided cacheNameWithPrefix if there is a publisher initialized for the cache.
com.hazelcast.config.CacheConfig	putCacheConfigIfAbsent(com.hazelcast.config.CacheConfig config)
com.hazelcast.spi.hotrestart.RamStore	ramStoreForPrefix(long prefix)
void	reset() Resets the cache service without closing.
com.hazelcast.spi.hotrestart.RamStore	restartingRamStoreForPrefix(long prefix)
void	shutdown(boolean terminate) Shutdowns the cache service and destroy the caches with their segments.

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

commitMigration, getAllServiceNamespaces, getObjectNamespace, isKnownServiceNamespace, newPartitionSegment, prepareReplicationOperation, prepareReplicationOperation, rollbackMigration, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EnterpriseCacheService

public EnterpriseCacheService()

Method Detail

postInit

protected void postInit(com.hazelcast.spi.NodeEngine nodeEngine,
                        Properties properties)

Overrides:

postInit in class com.hazelcast.cache.impl.AbstractCacheService

ramStoreForPrefix

public com.hazelcast.spi.hotrestart.RamStore ramStoreForPrefix(long prefix)

Specified by:

ramStoreForPrefix in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

restartingRamStoreForPrefix

public com.hazelcast.spi.hotrestart.RamStore restartingRamStoreForPrefix(long prefix)

Specified by:

restartingRamStoreForPrefix in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

prefixToThreadId

public int prefixToThreadId(long prefix)

Specified by:

prefixToThreadId in interface com.hazelcast.spi.hotrestart.RamStoreRegistry

onHeapHotRestartStoreForPartition

public com.hazelcast.spi.hotrestart.HotRestartStore onHeapHotRestartStoreForPartition(int partitionId)

offHeapHotRestartStoreForPartition

public com.hazelcast.spi.hotrestart.HotRestartStore offHeapHotRestartStoreForPartition(int partitionId)

createNewRecordStore

protected com.hazelcast.cache.impl.ICacheRecordStore createNewRecordStore(String cacheNameWithPrefix,
                                                                          int partitionId)

Creates new ICacheRecordStore as specified InMemoryFormat.

Overrides:

createNewRecordStore in class com.hazelcast.cache.impl.CacheService

Parameters:

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

partitionId - the partition ID which cache record store is created on

Returns:

the created ICacheRecordStore

See Also:

CacheRecordStore, HiDensityNativeMemoryCacheRecordStore

destroySegments

protected void destroySegments(com.hazelcast.config.CacheConfig cacheConfig)

Destroys the segments for specified cache.

Overrides:

destroySegments in class com.hazelcast.cache.impl.AbstractCacheService

Parameters:

cacheConfig - the configuration of the cache whose segments will be destroyed

shutdown

public void shutdown(boolean terminate)

Shutdowns the cache service and destroy the caches with their segments.

Specified by:

shutdown in interface com.hazelcast.spi.ManagedService

Overrides:

shutdown in class com.hazelcast.cache.impl.AbstractCacheService

Parameters:

terminate - condition about cache service will be closed or not

reset

public void reset()

Resets the cache service without closing.

Specified by:

reset in interface com.hazelcast.spi.ManagedService

Overrides:

reset in class com.hazelcast.cache.impl.AbstractCacheService

forceEvict

public int forceEvict(String name,
                      int originalPartitionId)

Does forced eviction on one or more caches. Runs on the operation threads.

Parameters:

name - the name of the cache to be evicted

originalPartitionId - the partition ID of the record store stores the records of cache

Returns:

the number of evicted records

forceEvictOnOthers

public int forceEvictOnOthers(String name,
                              int originalPartitionId)

Does forced eviction on other caches. Runs on the operation threads.

Parameters:

name - the name of the cache not to be evicted.

originalPartitionId - the partition ID of the record store that stores the records of cache

Returns:

the number of evicted records

forceEvictOnAll

public int forceEvictOnAll(int originalPartitionId)

Does forced eviction on all caches. Runs on the operation threads.

Parameters:

originalPartitionId - the partition ID of the record store that stores the records of cache

Returns:

the number of evicted records

clearAll

public void clearAll(int originalPartitionId)

Clears all record stores on the partitions owned by partition thread of original partition.

Parameters:

originalPartitionId - the ID of original partition

newCacheReplicationOperation

protected com.hazelcast.cache.impl.operation.CacheReplicationOperation newCacheReplicationOperation()

Creates a HiDensityCacheReplicationOperation to start the replication.

Overrides:

newCacheReplicationOperation in class com.hazelcast.cache.impl.CacheService

createOperationProvider

protected com.hazelcast.cache.impl.CacheOperationProvider createOperationProvider(String cacheNameWithPrefix,
                                                                                  com.hazelcast.config.InMemoryFormat inMemoryFormat)

Creates a CacheOperationProvider as specified InMemoryFormat for specified cacheNameWithPrefix.

Overrides:

createOperationProvider in class com.hazelcast.cache.impl.CacheService

Parameters:

cacheNameWithPrefix - the name of the cache (including manager prefix) that operation works on

inMemoryFormat - the format of memory such as BINARY, OBJECT or NATIVE

getCacheOperationProvider

public com.hazelcast.cache.impl.CacheOperationProvider getCacheOperationProvider(String cacheNameWithPrefix,
                                                                                 com.hazelcast.config.InMemoryFormat inMemoryFormat)

Specified by:

getCacheOperationProvider in interface com.hazelcast.cache.impl.ICacheService

Overrides:

getCacheOperationProvider in class com.hazelcast.cache.impl.AbstractCacheService

getSerializationService

public EnterpriseSerializationService getSerializationService()

Gets the EnterpriseSerializationService used by this ICacheService.

Returns:

the used EnterpriseSerializationService

getOrCreateHiDensityCacheInfo

public HiDensityStorageInfo getOrCreateHiDensityCacheInfo(String cacheNameWithPrefix)

Gets or creates (if there is no cache info for that Hi-Density cache) HiDensityStorageInfo instance which holds live information about cache.

Parameters:

cacheNameWithPrefix - Name (including prefix) of the cache whose live information is requested

Returns:

the HiDensityStorageInfo instance which holds live information about Hi-Density cache

putCacheConfigIfAbsent

public com.hazelcast.config.CacheConfig putCacheConfigIfAbsent(com.hazelcast.config.CacheConfig config)

Specified by:

putCacheConfigIfAbsent in interface com.hazelcast.cache.impl.ICacheService

Overrides:

putCacheConfigIfAbsent in class com.hazelcast.cache.impl.AbstractCacheService

deleteCacheConfig

public com.hazelcast.config.CacheConfig deleteCacheConfig(String cacheNameWithPrefix)

Specified by:

deleteCacheConfig in interface com.hazelcast.cache.impl.ICacheService

Overrides:

deleteCacheConfig in class com.hazelcast.cache.impl.AbstractCacheService

onReplicationEvent

public void onReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

Specified by:

onReplicationEvent in interface com.hazelcast.spi.ReplicationSupportingService

publishWanEvent

public void publishWanEvent(com.hazelcast.cache.impl.CacheEventContext cacheEventContext)

publishWanEvent

public void publishWanEvent(String cacheNameWithPrefix,
                            com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

Publishes a WAN event for the provided cacheNameWithPrefix if there is a publisher initialized for the cache. It is possible that the publisher has not been initialised yet for this cache which means that the event may not be published at this point but may be published at a later point.

Parameters:

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

wanReplicationEvent - the WAN event to be published

isWanReplicationEnabled

public boolean isWanReplicationEnabled(String cacheNameWithPrefix)

Specified by:

isWanReplicationEnabled in interface com.hazelcast.cache.impl.ICacheService

Overrides:

isWanReplicationEnabled in class com.hazelcast.cache.impl.CacheService

getCacheWanEventPublisher

public com.hazelcast.cache.impl.event.CacheWanEventPublisher getCacheWanEventPublisher()

Specified by:

getCacheWanEventPublisher in interface com.hazelcast.cache.impl.ICacheService

Overrides:

getCacheWanEventPublisher in class com.hazelcast.cache.impl.CacheService