com.hazelcast.cache.impl

Class CacheService

java.lang.Object

com.hazelcast.cache.impl.AbstractCacheService

com.hazelcast.cache.impl.CacheService

All Implemented Interfaces:

ICacheService, EventPublishingService<Object,CacheEventListener>, ManagedService, MigrationAwareService, PostJoinAwareService, RemoteService

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 Caching class is found on the classpath.

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.cacheNamePrefix().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CacheService.CacheBatchInvalidationMessageSender

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	cacheBatchInvalidationMessageSenderInProgress
protected ScheduledFuture	cacheBatchInvalidationMessageSenderScheduler
protected boolean	invalidationMessageBatchEnabled
protected int	invalidationMessageBatchSize
protected ConcurrentMap<String,Queue<CacheSingleInvalidationMessage>>	invalidationMessageMap

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

cacheStatisticsConstructorFunction, closeableListeners, configs, nodeEngine, operationProviderCache, resources, segments, statistics

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

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
CacheService()

Method Summary

Methods

Modifier and Type	Method and Description
String	addInvalidationListener(String name, CacheEventListener listener) Registers and CacheInvalidationListener for specified cacheName.
protected ICacheRecordStore	createNewRecordStore(String name, int partitionId)
protected void	flushInvalidationMessages(String cacheName, Queue<CacheSingleInvalidationMessage> invalidationMessageQueue)
protected void	postInit(NodeEngine nodeEngine, Properties properties)
Operation	prepareReplicationOperation(PartitionReplicationEvent event)
void	reset() reset this ManagedService back to initial state.
protected void	sendBatchInvalidationEvent(String name, Data key, String sourceUuid)
void	sendInvalidationEvent(String name, Data key, String sourceUuid) Sends an invalidation event for given cacheName with specified key from mentioned source with sourceUuid.
protected void	sendSingleInvalidationEvent(String name, Data key, String sourceUuid)
void	shutdown(boolean terminate) Shuts down this ManagedService.

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

addCacheResource, beforeMigration, clearPartitionReplica, commitMigration, createCacheConfigIfAbsent, createCacheStatIfAbsent, createDistributedObject, deleteCacheConfig, deleteCacheStat, deregisterAllListener, deregisterListener, destroyCache, destroyCacheOnAllMembers, destroyDistributedObject, destroySegments, dispatchEvent, findCacheConfig, getCacheConfig, getCacheConfigFromPartition, getCacheConfigs, getCacheOperationProvider, getCacheRecordStore, getNodeEngine, getOrCreateCache, getPostJoinOperation, getSegment, getStatistics, init, publishEvent, publishEvent, registerListener, rollbackMigration, setManagementEnabled, setStatisticsEnabled, toData, toObject

Methods inherited from class java.lang.Object

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

Field Detail

invalidationMessageBatchEnabled

protected boolean invalidationMessageBatchEnabled

invalidationMessageBatchSize

protected int invalidationMessageBatchSize

invalidationMessageMap

protected final ConcurrentMap<String,Queue<CacheSingleInvalidationMessage>> invalidationMessageMap

cacheBatchInvalidationMessageSenderScheduler

protected ScheduledFuture cacheBatchInvalidationMessageSenderScheduler

cacheBatchInvalidationMessageSenderInProgress

protected final AtomicBoolean cacheBatchInvalidationMessageSenderInProgress

Constructor Detail

CacheService

public CacheService()

Method Detail

createNewRecordStore

protected ICacheRecordStore createNewRecordStore(String name,
                                     int partitionId)

Specified by:

createNewRecordStore in class AbstractCacheService

postInit

protected void postInit(NodeEngine nodeEngine,
            Properties properties)

Overrides:

postInit in class AbstractCacheService

reset

public void reset()

Description copied from interface: ManagedService

reset this ManagedService back to initial state. todo: what is the purpose of reset

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this ManagedService. todo: what is the purpose of the terminate variable.

Parameters:

terminate - true to shut down the ManagedService

prepareReplicationOperation

public Operation prepareReplicationOperation(PartitionReplicationEvent event)

addInvalidationListener

public String addInvalidationListener(String name,
                             CacheEventListener listener)

Registers and CacheInvalidationListener for specified cacheName.

Parameters:

name - the name of the cache that CacheEventListener will be registered for

listener - the CacheEventListener to be registered for specified cache

Returns:

the id which is unique for current registration

sendInvalidationEvent

public void sendInvalidationEvent(String name,
                         Data key,
                         String sourceUuid)

Sends an invalidation event for given cacheName with specified key from mentioned source with sourceUuid.

Parameters:

name - 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

sendSingleInvalidationEvent

protected void sendSingleInvalidationEvent(String name,
                               Data key,
                               String sourceUuid)

sendBatchInvalidationEvent

protected void sendBatchInvalidationEvent(String name,
                              Data key,
                              String sourceUuid)

flushInvalidationMessages

protected void flushInvalidationMessages(String cacheName,
                             Queue<CacheSingleInvalidationMessage> invalidationMessageQueue)