com.hazelcast.cache.impl

Interface ICacheService

All Superinterfaces:

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

All Known Implementing Classes:

AbstractCacheService, CacheService

public interface ICacheService
extends ManagedService, RemoteService, FragmentedMigrationAwareService, EventPublishingService<Object,CacheEventListener>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_SUPPORT_NOT_AVAILABLE_ERROR_MESSAGE
static int	MAX_ADD_CACHE_CONFIG_RETRIES Maximum retries for adding cache config cluster-wide on stable cluster
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
String	addInvalidationListener(String cacheNameWithPrefix, CacheEventListener listener, boolean localOnly)
<K,V> void	createCacheConfigOnAllMembers(PreJoinCacheConfig<K,V> cacheConfig) Creates the given CacheConfig on all members of the cluster synchronously.
CacheStatisticsImpl	createCacheStatIfAbsent(String cacheNameWithPrefix)
void	deleteCache(String cacheNameWithPrefix, String callerUuid, boolean destroy)
CacheConfig	deleteCacheConfig(String cacheNameWithPrefix)
void	deleteCacheStat(String cacheNameWithPrefix)
void	deregisterAllListener(String cacheNameWithPrefix)
boolean	deregisterListener(String cacheNameWithPrefix, String registrationId)
CacheConfig	findCacheConfig(String simpleName)
CacheConfig	getCacheConfig(String cacheNameWithPrefix)
Collection<CacheConfig>	getCacheConfigs()
CacheOperationProvider	getCacheOperationProvider(String cacheNameWithPrefix, InMemoryFormat storageType) Creates cache operations according to the storage-type of the cache
CacheWanEventPublisher	getCacheWanEventPublisher() Returns the WAN event publisher responsible for publishing primary and backup WAN events for caches.
CacheEventJournal	getEventJournal() Returns an interface for interacting with the cache event journals.
ExpirationManager	getExpirationManager()
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()
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)
CacheStatistics	getStatistics(String cacheNameWithPrefix)
boolean	isWanReplicationEnabled(String cacheNameWithPrefix) Returns true if WAN replication is enabled for the cache named cacheNameWithPrefix.
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)
void	sendInvalidationEvent(String cacheNameWithPrefix, Data key, String sourceUuid)
void	setManagementEnabled(CacheConfig cacheConfig, String cacheNameWithPrefix, boolean enabled)
void	setStatisticsEnabled(CacheConfig cacheConfig, String cacheNameWithPrefix, boolean enabled)

Methods inherited from interface com.hazelcast.spi.ManagedService

init, reset, shutdown

Methods inherited from interface com.hazelcast.spi.RemoteService

createDistributedObject, destroyDistributedObject

Methods inherited from interface com.hazelcast.spi.FragmentedMigrationAwareService

getAllServiceNamespaces, isKnownServiceNamespace, prepareReplicationOperation

Methods inherited from interface com.hazelcast.spi.MigrationAwareService

beforeMigration, commitMigration, prepareReplicationOperation, rollbackMigration

Methods inherited from interface com.hazelcast.spi.EventPublishingService

dispatchEvent

Field Detail

CACHE_SUPPORT_NOT_AVAILABLE_ERROR_MESSAGE

static final String CACHE_SUPPORT_NOT_AVAILABLE_ERROR_MESSAGE

See Also:

Constant Field Values

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

MAX_ADD_CACHE_CONFIG_RETRIES

static final int MAX_ADD_CACHE_CONFIG_RETRIES

Maximum retries for adding cache config cluster-wide on stable cluster

See Also:

Constant Field Values

Method Detail

getOrCreateRecordStore

ICacheRecordStore getOrCreateRecordStore(String cacheNameWithPrefix,
                                         int partitionId)

Gets or creates a cache record store with the prefixed cacheNameWithPrefix and partition ID.

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

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.

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

CachePartitionSegment getSegment(int partitionId)

putCacheConfigIfAbsent

CacheConfig putCacheConfigIfAbsent(CacheConfig config)

getCacheConfig

CacheConfig getCacheConfig(String cacheNameWithPrefix)

findCacheConfig

CacheConfig findCacheConfig(String simpleName)

getCacheConfigs

Collection<CacheConfig> getCacheConfigs()

deleteCacheConfig

CacheConfig deleteCacheConfig(String cacheNameWithPrefix)

getPartitionSegments

CachePartitionSegment[] getPartitionSegments()

createCacheStatIfAbsent

CacheStatisticsImpl createCacheStatIfAbsent(String cacheNameWithPrefix)

getOrCreateCacheContext

CacheContext getOrCreateCacheContext(String cacheNameWithPrefix)

deleteCache

void deleteCache(String cacheNameWithPrefix,
                 String callerUuid,
                 boolean destroy)

deleteCacheStat

void deleteCacheStat(String cacheNameWithPrefix)

setStatisticsEnabled

void setStatisticsEnabled(CacheConfig cacheConfig,
                          String cacheNameWithPrefix,
                          boolean enabled)

setManagementEnabled

void setManagementEnabled(CacheConfig cacheConfig,
                          String cacheNameWithPrefix,
                          boolean enabled)

publishEvent

void publishEvent(CacheEventContext cacheEventContext)

publishEvent

void publishEvent(String cacheNameWithPrefix,
                  CacheEventSet eventSet,
                  int orderKey)

getNodeEngine

NodeEngine getNodeEngine()

registerListener

String registerListener(String cacheNameWithPrefix,
                        CacheEventListener listener,
                        boolean isLocal)

registerListener

String registerListener(String cacheNameWithPrefix,
                        CacheEventListener listener,
                        EventFilter eventFilter,
                        boolean isLocal)

deregisterListener

boolean deregisterListener(String cacheNameWithPrefix,
                           String registrationId)

deregisterAllListener

void deregisterAllListener(String cacheNameWithPrefix)

getStatistics

CacheStatistics getStatistics(String cacheNameWithPrefix)

getExpirationManager

ExpirationManager getExpirationManager()

getCacheOperationProvider

CacheOperationProvider getCacheOperationProvider(String cacheNameWithPrefix,
                                                 InMemoryFormat storageType)

Creates cache operations according to the storage-type of the cache

addInvalidationListener

String addInvalidationListener(String cacheNameWithPrefix,
                               CacheEventListener listener,
                               boolean localOnly)

sendInvalidationEvent

void sendInvalidationEvent(String cacheNameWithPrefix,
                           Data key,
                           String sourceUuid)

isWanReplicationEnabled

boolean isWanReplicationEnabled(String cacheNameWithPrefix)

Returns true if WAN replication is enabled for the cache named cacheNameWithPrefix.

Parameters:

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

getCacheWanEventPublisher

CacheWanEventPublisher getCacheWanEventPublisher()

Returns the WAN event publisher responsible for publishing primary and backup WAN events for caches.

getEventJournal

CacheEventJournal getEventJournal()

Returns an interface for interacting with the cache event journals.

createCacheConfigOnAllMembers

<K,V> void createCacheConfigOnAllMembers(PreJoinCacheConfig<K,V> cacheConfig)

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.

Type Parameters:

K - key type parameter

V - value type parameter

Parameters:

cacheConfig - the cache config to create on all members of the cluster

Since:

3.10