com.hazelcast.cache.impl

Class CacheService

java.lang.Object

com.hazelcast.cache.impl.CacheService

All Implemented Interfaces:

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

public class CacheService
extends Object
implements ManagedService, RemoteService, MigrationAwareService, EventPublishingService<Object,CacheEventListener>

Cache Service is the base access point of jcache impl to manage cache data on a node. This service is an optionally registered service which is enable if the javax.cache.Caching class is found on classpath. If enable this service will provide all cache data operation for all partitions of the node which it is registered on.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Service name

Constructor Summary

Constructors

Constructor and Description
CacheService()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeMigration(PartitionMigrationEvent event)
void	clearPartitionReplica(int partitionId)
void	commitMigration(PartitionMigrationEvent event)
boolean	createCacheConfigIfAbsent(CacheConfig config, boolean isLocal)
CacheStatisticsImpl	createCacheStatIfAbsent(String name)
protected <K,V> void	createConfigOnAllMembers(CacheConfig<K,V> cacheConfig)
DistributedObject	createDistributedObject(String objectName)
void	deleteCacheConfig(String name)
void	deleteCacheStat(String name)
void	deregisterAllListener(String name)
boolean	deregisterListener(String name, String registrationId)
void	destroyCache(String objectName, boolean isLocal, String callerUuid)
protected void	destroyCacheOnAllMembers(String objectName, String callerUuid)
void	destroyDistributedObject(String objectName)
void	dispatchEvent(Object event, CacheEventListener listener)
void	enableManagement(String cacheNameWithPrefix, boolean enabled)
void	enableStatistics(String cacheNameWithPrefix, boolean enabled)
ICacheRecordStore	getCache(String name, int partitionId)
CacheConfig	getCacheConfig(String name)
Collection<CacheConfig>	getCacheConfigs()
NodeEngine	getNodeEngine()
ICacheRecordStore	getOrCreateCache(String name, int partitionId)
CacheStatisticsImpl	getStatistics(String name)
void	init(NodeEngine nodeEngine, Properties properties) Initializes this ManagedService
Operation	prepareReplicationOperation(PartitionReplicationEvent event)
void	publishEvent(String cacheName, CacheEventSet eventSet, int orderKey)
void	publishEvent(String cacheName, CacheEventType eventType, Data dataKey, Data dataValue, Data dataOldValue, boolean isOldValueAvailable, int orderKey)
String	registerListener(String distributedObjectName, CacheEventListener listener)
void	reset() reset this ManagedService back to initial state.
void	rollbackMigration(PartitionMigrationEvent event)
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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Service name

See Also:

Constant Field Values

Constructor Detail

CacheService

public CacheService()

Method Detail

init

public void init(NodeEngine nodeEngine,
        Properties properties)

Description copied from interface: ManagedService

Initializes this ManagedService

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine this ManagedService belongs to.

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

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

createDistributedObject

public DistributedObject createDistributedObject(String objectName)

Specified by:

createDistributedObject in interface RemoteService

destroyDistributedObject

public void destroyDistributedObject(String objectName)

Specified by:

destroyDistributedObject in interface RemoteService

prepareReplicationOperation

public Operation prepareReplicationOperation(PartitionReplicationEvent event)

Specified by:

prepareReplicationOperation in interface MigrationAwareService

beforeMigration

public void beforeMigration(PartitionMigrationEvent event)

Specified by:

beforeMigration in interface MigrationAwareService

commitMigration

public void commitMigration(PartitionMigrationEvent event)

Specified by:

commitMigration in interface MigrationAwareService

rollbackMigration

public void rollbackMigration(PartitionMigrationEvent event)

Specified by:

rollbackMigration in interface MigrationAwareService

clearPartitionReplica

public void clearPartitionReplica(int partitionId)

Specified by:

clearPartitionReplica in interface MigrationAwareService

getOrCreateCache

public ICacheRecordStore getOrCreateCache(String name,
                                 int partitionId)

getCache

public ICacheRecordStore getCache(String name,
                         int partitionId)

destroyCache

public void destroyCache(String objectName,
                boolean isLocal,
                String callerUuid)

destroyCacheOnAllMembers

protected void destroyCacheOnAllMembers(String objectName,
                            String callerUuid)

createCacheConfigIfAbsent

public boolean createCacheConfigIfAbsent(CacheConfig config,
                                boolean isLocal)

createConfigOnAllMembers

protected <K,V> void createConfigOnAllMembers(CacheConfig<K,V> cacheConfig)

deleteCacheConfig

public void deleteCacheConfig(String name)

createCacheStatIfAbsent

public CacheStatisticsImpl createCacheStatIfAbsent(String name)

deleteCacheStat

public void deleteCacheStat(String name)

enableStatistics

public void enableStatistics(String cacheNameWithPrefix,
                    boolean enabled)

enableManagement

public void enableManagement(String cacheNameWithPrefix,
                    boolean enabled)

getCacheConfig

public CacheConfig getCacheConfig(String name)

getCacheConfigs

public Collection<CacheConfig> getCacheConfigs()

toObject

public Object toObject(Object data)

toData

public Data toData(Object object)

publishEvent

public void publishEvent(String cacheName,
                CacheEventType eventType,
                Data dataKey,
                Data dataValue,
                Data dataOldValue,
                boolean isOldValueAvailable,
                int orderKey)

publishEvent

public void publishEvent(String cacheName,
                CacheEventSet eventSet,
                int orderKey)

getNodeEngine

public NodeEngine getNodeEngine()

dispatchEvent

public void dispatchEvent(Object event,
                 CacheEventListener listener)

Specified by:

dispatchEvent in interface EventPublishingService<Object,CacheEventListener>

registerListener

public String registerListener(String distributedObjectName,
                      CacheEventListener listener)

deregisterListener

public boolean deregisterListener(String name,
                         String registrationId)

deregisterAllListener

public void deregisterAllListener(String name)

getStatistics

public CacheStatisticsImpl getStatistics(String name)