com.hazelcast.cache.impl

Class AbstractCacheService

java.lang.Object

com.hazelcast.cache.impl.AbstractCacheService

All Implemented Interfaces:

ICacheService, EventPublishingService<Object,CacheEventListener>, ManagedService, MigrationAwareService, PartitionAwareService, PostJoinAwareService, QuorumAwareService, RemoteService, SplitBrainHandlerService

Direct Known Subclasses:

CacheService

public abstract class AbstractCacheService
extends Object
implements ICacheService, PostJoinAwareService, PartitionAwareService, QuorumAwareService, SplitBrainHandlerService

Field Summary

Fields

Modifier and Type	Field and Description
protected ConstructorFunction<String,CacheContext>	cacheContexesConstructorFunction
protected ConcurrentMap<String,CacheContext>	cacheContexts
protected com.hazelcast.cache.impl.CacheEventHandler	cacheEventHandler
protected com.hazelcast.cache.impl.CacheSplitBrainHandler	cacheSplitBrainHandler
protected ConstructorFunction<String,CacheStatisticsImpl>	cacheStatisticsConstructorFunction
protected ConcurrentMap<String,Closeable>	closeableListeners
protected ConcurrentMap<String,CacheConfig>	configs
protected ILogger	logger
protected NodeEngine	nodeEngine
protected ConcurrentMap<String,CacheOperationProvider>	operationProviderCache
protected ConcurrentMap<String,Set<Closeable>>	resources
protected CachePartitionSegment[]	segments
protected ConcurrentMap<String,CacheStatisticsImpl>	statistics

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

CACHE_SUPPORT_NOT_AVAILABLE_ERROR_MESSAGE, SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractCacheService()

Method Summary

Modifier and Type	Method and Description
void	addCacheResource(String name, Closeable resource)
String	addInvalidationListener(String name, CacheEventListener listener, boolean localOnly) Registers and CacheEventListener for specified cacheName.
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	checkCacheConfig(String cacheName, CacheConfig cacheConfig)
protected void	checkCacheSimpleConfig(String cacheName, CacheSimpleConfig cacheSimpleConfig)
protected void	closeSegments(String name)
void	commitMigration(PartitionMigrationEvent event) Commits the migration process for this service, on both source and destination members.
CacheStatisticsImpl	createCacheStatIfAbsent(String name)
DistributedObject	createDistributedObject(String fullCacheName) Creates a distributed object.
protected abstract ICacheRecordStore	createNewRecordStore(String name, int partitionId)
protected abstract CacheOperationProvider	createOperationProvider(String nameWithPrefix, InMemoryFormat inMemoryFormat)
void	deleteCache(String name, String callerUuid, boolean destroy)
CacheConfig	deleteCacheConfig(String name)
void	deleteCacheStat(String name)
void	deregisterAllListener(String name)
boolean	deregisterListener(String name, String registrationId)
void	destroyDistributedObject(String objectName) Destroys a distributed object.
protected void	destroySegments(String name)
void	dispatchEvent(Object event, CacheEventListener listener)
CacheSimpleConfig	findCacheConfig(String simpleName)
CacheConfig	getCacheConfig(String name)
Collection<CacheConfig>	getCacheConfigs()
CacheContext	getCacheContext(String name)
CacheOperationProvider	getCacheOperationProvider(String nameWithPrefix, InMemoryFormat inMemoryFormat) Creates cache operations according to the storage-type of the cache
NodeEngine	getNodeEngine()
CacheContext	getOrCreateCacheContext(String name)
ICacheRecordStore	getOrCreateRecordStore(String name, int partitionId)
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!
String	getQuorumName(String cacheName) Gets the name of the quorum associated with specified cache
ICacheRecordStore	getRecordStore(String name, int partitionId)
CachePartitionSegment	getSegment(int partitionId)
CacheStatisticsImpl	getStatistics(String name)
void	init(NodeEngine nodeEngine, Properties properties) Initializes this ManagedService
protected boolean	isNativeInMemoryFormatSupported()
protected abstract CachePartitionSegment	newPartitionSegment(int partitionId)
void	onPartitionLost(IPartitionLostEvent partitionLostEvent) Invoked when a partition lost is detected
protected void	postInit(NodeEngine nodeEngine, Properties properties)
Runnable	prepareMergeRunnable() When the 2 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 cacheName, CacheEventSet eventSet, int orderKey)
CacheConfig	putCacheConfigIfAbsent(CacheConfig config)
String	registerListener(String name, CacheEventListener listener, boolean isLocal)
String	registerListener(String name, CacheEventListener listener, EventFilter eventFilter, boolean isLocal)
protected String	registerListenerInternal(String name, CacheEventListener listener, EventFilter eventFilter, boolean isLocal)
void	reset() reset this ManagedService back to initial state.
void	rollbackMigration(PartitionMigrationEvent event) Rollback the migration process for this service, on both source and destination members.
void	sendInvalidationEvent(String name, 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	shutdown(boolean terminate) Shuts down this ManagedService.
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.MigrationAwareService

prepareReplicationOperation

Field Detail

configs

protected final ConcurrentMap<String,CacheConfig> configs

cacheContexts

protected final ConcurrentMap<String,CacheContext> cacheContexts

statistics

protected final ConcurrentMap<String,CacheStatisticsImpl> statistics

resources

protected final ConcurrentMap<String,Set<Closeable>> resources

closeableListeners

protected final ConcurrentMap<String,Closeable> closeableListeners

operationProviderCache

protected final ConcurrentMap<String,CacheOperationProvider> operationProviderCache

cacheContexesConstructorFunction

protected final ConstructorFunction<String,CacheContext> cacheContexesConstructorFunction

cacheStatisticsConstructorFunction

protected final ConstructorFunction<String,CacheStatisticsImpl> cacheStatisticsConstructorFunction

nodeEngine

protected NodeEngine nodeEngine

segments

protected CachePartitionSegment[] segments

cacheEventHandler

protected com.hazelcast.cache.impl.CacheEventHandler cacheEventHandler

cacheSplitBrainHandler

protected com.hazelcast.cache.impl.CacheSplitBrainHandler cacheSplitBrainHandler

logger

protected ILogger logger

Constructor Detail

AbstractCacheService

public AbstractCacheService()

Method Detail

init

public final void init(NodeEngine nodeEngine,
                       Properties properties)

Description copied from interface: ManagedService

Initializes this ManagedService

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this ManagedService belongs to.

properties - the Properties. Can be used to pass settings to the service.

postInit

protected void postInit(NodeEngine nodeEngine,
                        Properties properties)

newPartitionSegment

protected abstract CachePartitionSegment newPartitionSegment(int partitionId)

createNewRecordStore

protected abstract ICacheRecordStore createNewRecordStore(String name,
                                                          int partitionId)

reset

public void reset()

Description copied from interface: ManagedService

reset this ManagedService back to 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 ManagedService. todo: what is the purpose of the terminate variable.

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down the ManagedService

createDistributedObject

public DistributedObject createDistributedObject(String fullCacheName)

Description copied from interface: RemoteService

Creates a distributed object.

Specified by:

createDistributedObject in interface RemoteService

Parameters:

fullCacheName - the name for the created distributed object

Returns:

the created distributed object

isNativeInMemoryFormatSupported

protected boolean isNativeInMemoryFormatSupported()

checkCacheSimpleConfig

protected void checkCacheSimpleConfig(String cacheName,
                                      CacheSimpleConfig cacheSimpleConfig)

checkCacheConfig

protected void checkCacheConfig(String cacheName,
                                CacheConfig cacheConfig)

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.

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.

Specified by:

rollbackMigration in interface MigrationAwareService

Parameters:

event - migration event

getOrCreateRecordStore

public ICacheRecordStore getOrCreateRecordStore(String name,
                                                int partitionId)

Specified by:

getOrCreateRecordStore in interface ICacheService

getRecordStore

public ICacheRecordStore getRecordStore(String name,
                                        int partitionId)

Specified by:

getRecordStore in interface ICacheService

getSegment

public CachePartitionSegment getSegment(int partitionId)

Specified by:

getSegment in interface ICacheService

destroySegments

protected void destroySegments(String name)

closeSegments

protected void closeSegments(String name)

deleteCache

public void deleteCache(String name,
                        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 name)

Specified by:

deleteCacheConfig in interface ICacheService

createCacheStatIfAbsent

public CacheStatisticsImpl createCacheStatIfAbsent(String name)

Specified by:

createCacheStatIfAbsent in interface ICacheService

getCacheContext

public CacheContext getCacheContext(String name)

getOrCreateCacheContext

public CacheContext getOrCreateCacheContext(String name)

Specified by:

getOrCreateCacheContext in interface ICacheService

deleteCacheStat

public void deleteCacheStat(String name)

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

Specified by:

getCacheConfig in interface ICacheService

findCacheConfig

public CacheSimpleConfig findCacheConfig(String simpleName)

Specified by:

findCacheConfig 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 cacheName,
                         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)

Specified by:

dispatchEvent in interface EventPublishingService<Object,CacheEventListener>

registerListener

public String registerListener(String name,
                               CacheEventListener listener,
                               boolean isLocal)

Specified by:

registerListener in interface ICacheService

registerListener

public String registerListener(String name,
                               CacheEventListener listener,
                               EventFilter eventFilter,
                               boolean isLocal)

Specified by:

registerListener in interface ICacheService

registerListenerInternal

protected String registerListenerInternal(String name,
                                          CacheEventListener listener,
                                          EventFilter eventFilter,
                                          boolean isLocal)

deregisterListener

public boolean deregisterListener(String name,
                                  String registrationId)

Specified by:

deregisterListener in interface ICacheService

deregisterAllListener

public void deregisterAllListener(String name)

Specified by:

deregisterAllListener in interface ICacheService

getStatistics

public CacheStatisticsImpl getStatistics(String name)

Specified by:

getStatistics in interface ICacheService

getCacheOperationProvider

public CacheOperationProvider getCacheOperationProvider(String nameWithPrefix,
                                                        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 name,
                             Closeable resource)

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!

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.

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 name,
                                      CacheEventListener listener,
                                      boolean localOnly)

Registers and CacheEventListener for specified cacheName.

Specified by:

addInvalidationListener in interface ICacheService

Parameters:

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

listener - the CacheEventListener to be registered for specified cache

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

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

prepareMergeRunnable

public Runnable prepareMergeRunnable()

Description copied from interface: SplitBrainHandlerService

When the 2 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