AbstractCacheService (Hazelcast Root 3.12 API)

java.lang.Object
- com.hazelcast.cache.impl.AbstractCacheService

All Implemented Interfaces:

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

Direct Known Subclasses:

CacheService
```
public abstract class AbstractCacheService
extends Object
implements ICacheService, PreJoinAwareService, PartitionAwareService, QuorumAwareService, SplitBrainHandlerService, ClusterStateListener
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected ConcurrentMap<String,CacheContext>`	`cacheContexts` Map from full prefixed cache name to `CacheContext`
`protected ConstructorFunction<String,CacheContext>`	`cacheContextsConstructorFunction`
`protected CacheEventHandler`	`cacheEventHandler`
`protected ConstructorFunction<String,Set<Closeable>>`	`cacheResourcesConstructorFunction`
`protected ContextMutexFactory`	`cacheResourcesMutexFactory`
`protected ConstructorFunction<String,CacheStatisticsImpl>`	`cacheStatisticsConstructorFunction`
`protected CacheClearExpiredRecordsTask`	`clearExpiredRecordsTask`
`protected ConcurrentMap<String,Closeable>`	`closeableListeners`
`protected ConcurrentMap<String,CacheConfig>`	`configs` Map from full prefixed cache name to `CacheConfig`
`protected RingbufferCacheEventJournalImpl`	`eventJournal`
`protected ExpirationManager`	`expirationManager`
`protected ILogger`	`logger`
`protected CacheMergePolicyProvider`	`mergePolicyProvider`
`protected NodeEngine`	`nodeEngine`
`protected ConcurrentMap<String,CacheOperationProvider>`	`operationProviderCache`
`protected ConcurrentMap<String,Set<Closeable>>`	`resources` Map from full prefixed cache name to set of `Closeable` resources
`protected CachePartitionSegment[]`	`segments`
`protected com.hazelcast.cache.impl.CacheSplitBrainHandlerService`	`splitBrainHandlerService`
`protected ConcurrentMap<String,CacheStatisticsImpl>`	`statistics` Map from full prefixed cache name to `CacheStatisticsImpl`
`static String`	`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

AbstractCacheService()

Constructors
Constructor and Description
`AbstractCacheService()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCacheResource(String cacheNameWithPrefix, Closeable resource)`
`String`	`addInvalidationListener(String cacheNameWithPrefix, CacheEventListener listener, boolean localOnly)` Registers and `CacheEventListener` for specified `cacheNameWithPrefix`
`void`	`beforeMigration(PartitionMigrationEvent event)` Called before migration process starts, on both source and destination members.
`void`	`cacheEntryListenerDeregistered(String name, javax.cache.configuration.CacheEntryListenerConfiguration cacheEntryListenerConfiguration)`
`void`	`cacheEntryListenerRegistered(String name, javax.cache.configuration.CacheEntryListenerConfiguration cacheEntryListenerConfiguration)`
`protected void`	`closeSegments(String name)`
`void`	`commitMigration(PartitionMigrationEvent event)` Commits the migration process for this service, on both source and destination members.
`<K,V> void`	`createCacheConfigOnAllMembers(PreJoinCacheConfig<K,V> cacheConfig)` Creates the given CacheConfig on all members of the cluster synchronously.
`<K,V> ICompletableFuture`	`createCacheConfigOnAllMembersAsync(PreJoinCacheConfig<K,V> cacheConfig)`
`CacheStatisticsImpl`	`createCacheStatIfAbsent(String cacheNameWithPrefix)`
`DistributedObject`	`createDistributedObject(String cacheNameWithPrefix)` Creates a distributed object.
`protected abstract ICacheRecordStore`	`createNewRecordStore(String cacheNameWithPrefix, int partitionId)`
`protected abstract CacheOperationProvider`	`createOperationProvider(String nameWithPrefix, InMemoryFormat inMemoryFormat)`
`void`	`deleteCache(String cacheNameWithPrefix, String callerUuid, boolean destroy)`
`CacheConfig`	`deleteCacheConfig(String cacheNameWithPrefix)`
`protected void`	`deleteCacheResources(String name)`
`void`	`deleteCacheStat(String cacheNameWithPrefix)`
`void`	`deregisterAllListener(String cacheNameWithPrefix)`
`boolean`	`deregisterListener(String cacheNameWithPrefix, String registrationId)`
`void`	`destroyDistributedObject(String objectName)` Destroys a distributed object.
`protected void`	`destroySegments(CacheConfig cacheConfig)`
`void`	`dispatchEvent(Object event, CacheEventListener listener)` Notifies the service of a published event.
`CacheConfig`	`findCacheConfig(String simpleName)`
`CacheConfig`	`getCacheConfig(String cacheNameWithPrefix)`
`Collection<CacheConfig>`	`getCacheConfigs()`
`CacheContext`	`getCacheContext(String name)`
`CacheEventHandler`	`getCacheEventHandler()`
`CacheOperationProvider`	`getCacheOperationProvider(String cacheNameWithPrefix, InMemoryFormat inMemoryFormat)` Creates cache operations according to the storage-type of the cache
`ConcurrentMap<String,CacheConfig>`	`getConfigs()`
`CacheEventJournal`	`getEventJournal()` Returns an interface for interacting with the cache event journals.
`ExpirationManager`	`getExpirationManager()`
`Object`	`getMergePolicy(String name)`
`CacheMergePolicyProvider`	`getMergePolicyProvider()`
`NodeEngine`	`getNodeEngine()`
`CacheContext`	`getOrCreateCacheContext(String cacheNameWithPrefix)`
`ICacheRecordStore`	`getOrCreateRecordStore(String cacheNameWithPrefix, int partitionId)` Gets or creates a cache record store with the prefixed `cacheNameWithPrefix` and partition ID.
`CachePartitionSegment[]`	`getPartitionSegments()`
`Operation`	`getPreJoinOperation()` An operation to be executed on the joining member before it is set as joined.
`String`	`getQuorumName(String cacheName)` Gets the name of the quorum associated with specified cache
`ICacheRecordStore`	`getRecordStore(String cacheNameWithPrefix, int partitionId)` Returns a cache record store with the prefixed `cacheNameWithPrefix` and partition ID or `null` if one doesn't exist.
`CachePartitionSegment`	`getSegment(int partitionId)`
`CacheStatisticsImpl`	`getStatistics(String cacheNameWithPrefix)`
`void`	`init(NodeEngine nodeEngine, Properties properties)` Initializes this service.
`protected abstract CachePartitionSegment`	`newPartitionSegment(int partitionId)`
`void`	`onClusterStateChange(ClusterState newState)` Called when cluster state is changed
`void`	`onPartitionLost(IPartitionLostEvent partitionLostEvent)` Invoked when a partition lost is detected
`protected void`	`postInit(NodeEngine nodeEngine, Properties properties)`
`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.
`protected void`	`publishCachePartitionLostEvent(String cacheName, int partitionId)`
`void`	`publishEvent(CacheEventContext cacheEventContext)`
`void`	`publishEvent(String cacheNameWithPrefix, CacheEventSet eventSet, int orderKey)`
`CacheConfig`	`putCacheConfigIfAbsent(CacheConfig config)`
`String`	`registerListener(String cacheNameWithPrefix, CacheEventListener listener, boolean isLocal)`
`String`	`registerListener(String cacheNameWithPrefix, CacheEventListener listener, EventFilter eventFilter, boolean isLocal)`
`protected String`	`registerListenerInternal(String cacheNameWithPrefix, CacheEventListener listener, EventFilter eventFilter, boolean isLocal)`
`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`	`sendInvalidationEvent(String cacheNameWithPrefix, Data key, String sourceUuid)` Sends an invalidation event for given `cacheName` with specified `key` from mentioned source with `sourceUuid`.
`void`	`setManagementEnabled(CacheConfig cacheConfig, String cacheNameWithPrefix, boolean enabled)`
`void`	`setStatisticsEnabled(CacheConfig cacheConfig, String cacheNameWithPrefix, boolean enabled)`
`void`	`setTenantControl(CacheConfig cacheConfig)`
`void`	`shutdown(boolean terminate)` Shuts down this service.
`Data`	`toData(Object object)`
`Object`	`toObject(Object data)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hazelcast.cache.impl.ICacheService
getCacheWanEventPublisher, isWanReplicationEnabled

Methods inherited from interface com.hazelcast.spi.FragmentedMigrationAwareService
getAllServiceNamespaces, isKnownServiceNamespace, prepareReplicationOperation

Methods inherited from interface com.hazelcast.spi.MigrationAwareService
prepareReplicationOperation

- Field Detail
  - TENANT_CONTROL_FACTORY
```
public static final String TENANT_CONTROL_FACTORY
```
    See Also:
    
    Constant Field Values
  - configs
```
protected final ConcurrentMap<String,CacheConfig> configs
```
    Map from full prefixed cache name to CacheConfig
  - cacheContexts
```
protected final ConcurrentMap<String,CacheContext> cacheContexts
```
    Map from full prefixed cache name to CacheContext
  - statistics
```
protected final ConcurrentMap<String,CacheStatisticsImpl> statistics
```
    Map from full prefixed cache name to CacheStatisticsImpl
  - resources
```
protected final ConcurrentMap<String,Set<Closeable>> resources
```
    Map from full prefixed cache name to set of Closeable resources
  - closeableListeners
```
protected final ConcurrentMap<String,Closeable> closeableListeners
```
  - operationProviderCache
```
protected final ConcurrentMap<String,CacheOperationProvider> operationProviderCache
```
  - cacheContextsConstructorFunction
```
protected final ConstructorFunction<String,CacheContext> cacheContextsConstructorFunction
```
  - cacheStatisticsConstructorFunction
```
protected final ConstructorFunction<String,CacheStatisticsImpl> cacheStatisticsConstructorFunction
```
  - cacheResourcesMutexFactory
```
protected final ContextMutexFactory cacheResourcesMutexFactory
```
  - cacheResourcesConstructorFunction
```
protected final ConstructorFunction<String,Set<Closeable>> cacheResourcesConstructorFunction
```
  - logger
```
protected ILogger logger
```
  - nodeEngine
```
protected NodeEngine nodeEngine
```
  - segments
```
protected CachePartitionSegment[] segments
```
  - cacheEventHandler
```
protected CacheEventHandler cacheEventHandler
```
  - eventJournal
```
protected RingbufferCacheEventJournalImpl eventJournal
```
  - mergePolicyProvider
```
protected CacheMergePolicyProvider mergePolicyProvider
```
  - splitBrainHandlerService
```
protected com.hazelcast.cache.impl.CacheSplitBrainHandlerService splitBrainHandlerService
```
  - clearExpiredRecordsTask
```
protected CacheClearExpiredRecordsTask clearExpiredRecordsTask
```
  - expirationManager
```
protected ExpirationManager expirationManager
```
- Constructor Detail
  - AbstractCacheService
```
public AbstractCacheService()
```
- Method Detail
  - init
```
public final 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)
  - getMergePolicyProvider
```
public CacheMergePolicyProvider getMergePolicyProvider()
```
  - getMergePolicy
```
public Object getMergePolicy(String name)
```
  - getConfigs
```
public ConcurrentMap<String,CacheConfig> getConfigs()
```
  - postInit
```
protected void postInit(NodeEngine nodeEngine,
                        Properties properties)
```
  - newPartitionSegment
```
protected abstract CachePartitionSegment newPartitionSegment(int partitionId)
```
  - createNewRecordStore
```
protected abstract ICacheRecordStore createNewRecordStore(String cacheNameWithPrefix,
                                                          int partitionId)
```
  - 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
  - getPartitionSegments
```
public CachePartitionSegment[] getPartitionSegments()
```
    Specified by:
    
    getPartitionSegments in interface ICacheService
  - createDistributedObject
```
public DistributedObject createDistributedObject(String cacheNameWithPrefix)
```
    Description copied from interface: RemoteService
    
    Creates a distributed object.
    
    Specified by:
    
    createDistributedObject in interface RemoteService
    
    Parameters:
    
    cacheNameWithPrefix - 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
  - 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
  - getOrCreateRecordStore
```
public ICacheRecordStore getOrCreateRecordStore(String cacheNameWithPrefix,
                                                int partitionId)
```
    Description copied from interface: ICacheService
    
    Gets or creates a cache record store with the prefixed cacheNameWithPrefix and partition ID.
    
    Specified by:
    
    getOrCreateRecordStore in interface ICacheService
    
    Parameters:
    
    cacheNameWithPrefix - the full name of the ICache, including the manager scope prefix
    
    partitionId - the record store partition ID
    
    Returns:
    
    the cache partition record store
  - getRecordStore
```
public ICacheRecordStore getRecordStore(String cacheNameWithPrefix,
                                        int partitionId)
```
    Description copied from interface: ICacheService
    
    Returns a cache record store with the prefixed cacheNameWithPrefix and partition ID or null if one doesn't exist.
    
    Specified by:
    
    getRecordStore in interface ICacheService
    
    Parameters:
    
    cacheNameWithPrefix - the full name of the ICache, including the manager scope prefix
    
    partitionId - the record store partition ID
    
    Returns:
    
    the cache partition record store or null if it doesn't exist
  - getSegment
```
public CachePartitionSegment getSegment(int partitionId)
```
    Specified by:
    
    getSegment in interface ICacheService
  - destroySegments
```
protected void destroySegments(CacheConfig cacheConfig)
```
  - closeSegments
```
protected void closeSegments(String name)
```
  - deleteCache
```
public void deleteCache(String cacheNameWithPrefix,
                        String callerUuid,
                        boolean destroy)
```
    Specified by:
    
    deleteCache in interface ICacheService
  - putCacheConfigIfAbsent
```
public CacheConfig putCacheConfigIfAbsent(CacheConfig config)
```
    Specified by:
    
    putCacheConfigIfAbsent in interface ICacheService
  - deleteCacheConfig
```
public CacheConfig deleteCacheConfig(String cacheNameWithPrefix)
```
    Specified by:
    
    deleteCacheConfig in interface ICacheService
  - getExpirationManager
```
public ExpirationManager getExpirationManager()
```
    Specified by:
    
    getExpirationManager in interface ICacheService
  - createCacheStatIfAbsent
```
public CacheStatisticsImpl createCacheStatIfAbsent(String cacheNameWithPrefix)
```
    Specified by:
    
    createCacheStatIfAbsent in interface ICacheService
  - getCacheContext
```
public CacheContext getCacheContext(String name)
```
  - getOrCreateCacheContext
```
public CacheContext getOrCreateCacheContext(String cacheNameWithPrefix)
```
    Specified by:
    
    getOrCreateCacheContext in interface ICacheService
  - deleteCacheStat
```
public void deleteCacheStat(String cacheNameWithPrefix)
```
    Specified by:
    
    deleteCacheStat in interface ICacheService
  - setStatisticsEnabled
```
public void setStatisticsEnabled(CacheConfig cacheConfig,
                                 String cacheNameWithPrefix,
                                 boolean enabled)
```
    Specified by:
    
    setStatisticsEnabled in interface ICacheService
  - setManagementEnabled
```
public void setManagementEnabled(CacheConfig cacheConfig,
                                 String cacheNameWithPrefix,
                                 boolean enabled)
```
    Specified by:
    
    setManagementEnabled in interface ICacheService
  - getCacheConfig
```
public CacheConfig getCacheConfig(String cacheNameWithPrefix)
```
    Specified by:
    
    getCacheConfig in interface ICacheService
  - findCacheConfig
```
public CacheConfig findCacheConfig(String simpleName)
```
    Specified by:
    
    findCacheConfig in interface ICacheService
  - setTenantControl
```
public void setTenantControl(CacheConfig cacheConfig)
```
    Specified by:
    
    setTenantControl in interface ICacheService
  - getCacheConfigs
```
public Collection<CacheConfig> getCacheConfigs()
```
    Specified by:
    
    getCacheConfigs in interface ICacheService
  - toObject
```
public Object toObject(Object data)
```
  - toData
```
public Data toData(Object object)
```
  - publishEvent
```
public void publishEvent(CacheEventContext cacheEventContext)
```
    Specified by:
    
    publishEvent in interface ICacheService
  - publishEvent
```
public void publishEvent(String cacheNameWithPrefix,
                         CacheEventSet eventSet,
                         int orderKey)
```
    Specified by:
    
    publishEvent in interface ICacheService
  - getNodeEngine
```
public NodeEngine getNodeEngine()
```
    Specified by:
    
    getNodeEngine in interface ICacheService
  - dispatchEvent
```
public void dispatchEvent(Object event,
                          CacheEventListener listener)
```
    Description copied from interface: EventPublishingService
    
    Notifies the service of a published event.
    
    Specified by:
    
    dispatchEvent in interface EventPublishingService<Object,CacheEventListener>
    
    Parameters:
    
    event - the published event
    
    listener - the listener registered for this event
  - registerListener
```
public String registerListener(String cacheNameWithPrefix,
                               CacheEventListener listener,
                               boolean isLocal)
```
    Specified by:
    
    registerListener in interface ICacheService
  - registerListener
```
public String registerListener(String cacheNameWithPrefix,
                               CacheEventListener listener,
                               EventFilter eventFilter,
                               boolean isLocal)
```
    Specified by:
    
    registerListener in interface ICacheService
  - registerListenerInternal
```
protected String registerListenerInternal(String cacheNameWithPrefix,
                                          CacheEventListener listener,
                                          EventFilter eventFilter,
                                          boolean isLocal)
```
  - deregisterListener
```
public boolean deregisterListener(String cacheNameWithPrefix,
                                  String registrationId)
```
    Specified by:
    
    deregisterListener in interface ICacheService
  - deregisterAllListener
```
public void deregisterAllListener(String cacheNameWithPrefix)
```
    Specified by:
    
    deregisterAllListener in interface ICacheService
  - getStatistics
```
public CacheStatisticsImpl getStatistics(String cacheNameWithPrefix)
```
    Specified by:
    
    getStatistics in interface ICacheService
  - getCacheOperationProvider
```
public CacheOperationProvider getCacheOperationProvider(String cacheNameWithPrefix,
                                                        InMemoryFormat inMemoryFormat)
```
    Description copied from interface: ICacheService
    
    Creates cache operations according to the storage-type of the cache
    
    Specified by:
    
    getCacheOperationProvider in interface ICacheService
  - createOperationProvider
```
protected abstract CacheOperationProvider createOperationProvider(String nameWithPrefix,
                                                                  InMemoryFormat inMemoryFormat)
```
  - addCacheResource
```
public void addCacheResource(String cacheNameWithPrefix,
                             Closeable resource)
```
  - deleteCacheResources
```
protected void deleteCacheResources(String name)
```
  - getPreJoinOperation
```
public Operation getPreJoinOperation()
```
    Description copied from interface: PreJoinAwareService
    
    An operation to be executed on the joining member before it is set as joined. As is the case with PostJoinAwareService.getPostJoinOperation()s, no partition locks, no key-based locks, no service level locks, no database interaction are allowed. Additionally, a pre-join operation is executed while the cluster lock is being held on the joining member, so it is important that the operation finishes quickly and does not interact with other locks. The Operation.getPartitionId() method should return a negative value. This means that the operations should not implement PartitionAwareOperation.
    Pre join operations should return response, which may also be a null response.
    
    Specified by:
    
    getPreJoinOperation in interface PreJoinAwareService
    
    Returns:
    
    an operation to be executed on joining member before it is set as joined. Can be null.
  - publishCachePartitionLostEvent
```
protected void publishCachePartitionLostEvent(String cacheName,
                                              int partitionId)
```
  - 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
  - cacheEntryListenerRegistered
```
public void cacheEntryListenerRegistered(String name,
                                         javax.cache.configuration.CacheEntryListenerConfiguration cacheEntryListenerConfiguration)
```
  - cacheEntryListenerDeregistered
```
public void cacheEntryListenerDeregistered(String name,
                                           javax.cache.configuration.CacheEntryListenerConfiguration cacheEntryListenerConfiguration)
```
  - getQuorumName
```
public String getQuorumName(String cacheName)
```
    Gets the name of the quorum associated with specified cache
    
    Specified by:
    
    getQuorumName in interface QuorumAwareService
    
    Parameters:
    
    cacheName - name of the cache
    
    Returns:
    
    name of the associated quorum null if there is no associated quorum
  - addInvalidationListener
```
public String addInvalidationListener(String cacheNameWithPrefix,
                                      CacheEventListener listener,
                                      boolean localOnly)
```
    Registers and CacheEventListener for specified cacheNameWithPrefix
    
    Specified by:
    
    addInvalidationListener in interface ICacheService
    
    Parameters:
    
    cacheNameWithPrefix - the full name of the cache (including manager scope prefix) that CacheEventListener will be registered for
    
    listener - the CacheEventListener to be registered for specified cacheNameWithPrefix
    
    localOnly - true if only events originated from this member wants be listened, false if all invalidation events in the cluster wants to be listened
    
    Returns:
    
    the ID which is unique for current registration
  - sendInvalidationEvent
```
public void sendInvalidationEvent(String cacheNameWithPrefix,
                                  Data key,
                                  String sourceUuid)
```
    Sends an invalidation event for given cacheName with specified key from mentioned source with sourceUuid.
    
    Specified by:
    
    sendInvalidationEvent in interface ICacheService
    
    Parameters:
    
    cacheNameWithPrefix - the name of the cache that invalidation event is sent for
    
    key - the Data represents the invalidation event
    
    sourceUuid - an ID that represents the source for invalidation event
  - 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
  - getCacheEventHandler
```
public CacheEventHandler getCacheEventHandler()
```
  - getEventJournal
```
public CacheEventJournal getEventJournal()
```
    Description copied from interface: ICacheService
    
    Returns an interface for interacting with the cache event journals.
    
    Specified by:
    
    getEventJournal in interface ICacheService
  - createCacheConfigOnAllMembers
```
public <K,V> void createCacheConfigOnAllMembers(PreJoinCacheConfig<K,V> cacheConfig)
```
    Description copied from interface: ICacheService
    
    Creates the given CacheConfig on all members of the cluster synchronously. When used with cluster version 3.10 or greater, the cluster-wide invocation ensures that all members of the cluster will receive the cache config even in the face of cluster membership changes.
    
    Specified by:
    
    createCacheConfigOnAllMembers in interface ICacheService
    
    Type Parameters:
    
    K - key type parameter
    
    V - value type parameter
    
    Parameters:
    
    cacheConfig - the cache config to create on all members of the cluster
  - createCacheConfigOnAllMembersAsync
```
public <K,V> ICompletableFuture createCacheConfigOnAllMembersAsync(PreJoinCacheConfig<K,V> cacheConfig)
```
  - 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

Class AbstractCacheService

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.spi.FragmentedMigrationAwareService

Methods inherited from interface com.hazelcast.spi.MigrationAwareService

Field Detail

TENANT_CONTROL_FACTORY

configs

cacheContexts

statistics

resources

closeableListeners

operationProviderCache

cacheContextsConstructorFunction

cacheStatisticsConstructorFunction

cacheResourcesMutexFactory

cacheResourcesConstructorFunction

logger

nodeEngine

segments

cacheEventHandler

eventJournal

mergePolicyProvider

splitBrainHandlerService

clearExpiredRecordsTask

expirationManager

Constructor Detail

AbstractCacheService

Method Detail

init

getMergePolicyProvider

getMergePolicy

getConfigs

postInit

newPartitionSegment

createNewRecordStore

reset

shutdown

getPartitionSegments

createDistributedObject

destroyDistributedObject

beforeMigration

commitMigration

rollbackMigration

getOrCreateRecordStore

getRecordStore

getSegment

destroySegments

closeSegments

deleteCache

putCacheConfigIfAbsent

deleteCacheConfig

getExpirationManager

createCacheStatIfAbsent

getCacheContext

getOrCreateCacheContext

deleteCacheStat

setStatisticsEnabled

setManagementEnabled

getCacheConfig

findCacheConfig

setTenantControl

getCacheConfigs

toObject

toData

publishEvent

publishEvent

getNodeEngine

dispatchEvent

registerListener

registerListener

registerListenerInternal

deregisterListener

deregisterAllListener

getStatistics

getCacheOperationProvider