org.terracotta.modules.ehcache

Interface ToolkitInstanceFactory

All Known Implementing Classes:

ToolkitInstanceFactoryImpl

public interface ToolkitInstanceFactory

Factory used for creating Toolkit instances used for implementing clustered ehcache

Method Summary

Modifier and Type	Method and Description
void	clusterRejoined()
boolean	destroy(String cacheManagerName, String cacheName) Destorys any clustered state associated with the given cache.
org.terracotta.toolkit.internal.collections.ToolkitListInternal	getAsyncProcessingBucket(String bucketName, String cacheName)
String	getFullyQualifiedCacheName(Ehcache cache) Returns a fully qualified name for the cache
org.terracotta.toolkit.concurrent.locks.ToolkitLock	getLockForCache(Ehcache cache, String lockName)
SerializedToolkitCache<ClusteredSoftLockIDKey,SerializedReadCommittedClusteredSoftLock>	getOrCreateAllSoftLockMap(String cacheManagerName, String cacheName)
org.terracotta.toolkit.collections.ToolkitMap<String,AsyncConfig>	getOrCreateAsyncConfigMap()
org.terracotta.toolkit.collections.ToolkitMap<String,Set<String>>	getOrCreateAsyncListNamesMap(String fullAsyncName, String cacheName)
org.terracotta.toolkit.collections.ToolkitMap<String,String>	getOrCreateAttributeMap(String cacheManagerName, String cacheName) Returns a ToolkitMap that will be used internally by Toolkit to store attribute schema.
org.terracotta.toolkit.events.ToolkitNotifier<CacheDisposalNotification>	getOrCreateCacheDisposalNotifier(Ehcache cache)
org.terracotta.toolkit.events.ToolkitNotifier<CacheEventNotificationMsg>	getOrCreateCacheEventNotifier(Ehcache cache) Returns a ToolkitNotifier for the cachse to notify CacheEventNotificationMsg across the cluster
org.terracotta.toolkit.collections.ToolkitMap<String,Serializable>	getOrCreateCacheManagerMetaInfoMap(String cacheManagerName)
org.terracotta.toolkit.collections.ToolkitMap<String,Serializable>	getOrCreateClusteredStoreConfigMap(String cacheManagerName, String cacheName)
org.terracotta.toolkit.events.ToolkitNotifier<CacheConfigChangeNotificationMsg>	getOrCreateConfigChangeNotifier(Ehcache cache) Returns a ToolkitNotifier for the cache for notifying CacheConfigChangeNotificationMsg across the cluster
org.terracotta.toolkit.collections.ToolkitMap<String,AttributeExtractor>	getOrCreateExtractorsMap(String cacheManagerName, String cacheName) Returns a ToolkitMap for storing serialized extractors for the cache
org.terracotta.toolkit.collections.ToolkitMap<SerializedReadCommittedClusteredSoftLock,Integer>	getOrCreateNewSoftLocksSet(String cacheManagerName, String cacheName)
org.terracotta.toolkit.concurrent.locks.ToolkitLock	getOrCreateStoreLock(Ehcache cache) Returns a ToolkitReadWriteLock for protecting the cache's store cluster wide
org.terracotta.toolkit.internal.cache.ToolkitCacheInternal<String,Serializable>	getOrCreateToolkitCache(Ehcache cache) Returns the backend ToolkitCacheInternal to be used for the cache
SerializedToolkitCache<TransactionID,Decision>	getOrCreateTransactionCommitStateMap(String cacheManagerName) Return the map used for storing commit state of ehcache transactions
WanAwareToolkitCache<String,Serializable>	getOrCreateWanAwareToolkitCache(String cacheManagerName, String cacheName, CacheConfiguration ehcacheConfig, boolean masterCache, boolean bidirectional) This method should only be used by the Orchestrator for fetching a WanAwareToolkitCache
org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock	getSoftLockFreezeLock(String cacheManagerName, String cacheName, TransactionID transactionID, Object key)
org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock	getSoftLockNotifierLock(String cacheManagerName, String cacheName, TransactionID transactionID, Object key)
org.terracotta.toolkit.concurrent.locks.ToolkitLock	getSoftLockWriteLock(String cacheManagerName, String cacheName, TransactionID transactionID, Object key)
org.terracotta.toolkit.Toolkit	getToolkit() Returns the toolkit associated with this factory
void	linkClusteredCacheManager(String cacheManagerName, Configuration configuration) Links a terracotta enabled cache manager to the cluster
void	markCacheWanDisabled(String cacheManagerName, String cacheName)
void	removeNonStopConfigforCache(Ehcache cache)
void	shutdown() Shutdown
void	unlinkCache(String cacheName) Un-links a terracotta enabled cache from the cluster
void	waitForOrchestrator(String cacheManagerName)

Method Detail

getToolkit

org.terracotta.toolkit.Toolkit getToolkit()

Returns the toolkit associated with this factory

getFullyQualifiedCacheName

String getFullyQualifiedCacheName(Ehcache cache)

Returns a fully qualified name for the cache

getOrCreateToolkitCache

org.terracotta.toolkit.internal.cache.ToolkitCacheInternal<String,Serializable> getOrCreateToolkitCache(Ehcache cache)

Returns the backend ToolkitCacheInternal to be used for the cache

getOrCreateConfigChangeNotifier

org.terracotta.toolkit.events.ToolkitNotifier<CacheConfigChangeNotificationMsg> getOrCreateConfigChangeNotifier(Ehcache cache)

Returns a ToolkitNotifier for the cache for notifying CacheConfigChangeNotificationMsg across the cluster

getOrCreateStoreLock

org.terracotta.toolkit.concurrent.locks.ToolkitLock getOrCreateStoreLock(Ehcache cache)

Returns a ToolkitReadWriteLock for protecting the cache's store cluster wide

getOrCreateAsyncConfigMap

org.terracotta.toolkit.collections.ToolkitMap<String,AsyncConfig> getOrCreateAsyncConfigMap()

getOrCreateAsyncListNamesMap

org.terracotta.toolkit.collections.ToolkitMap<String,Set<String>> getOrCreateAsyncListNamesMap(String fullAsyncName,
                                                                                               String cacheName)

getOrCreateCacheEventNotifier

org.terracotta.toolkit.events.ToolkitNotifier<CacheEventNotificationMsg> getOrCreateCacheEventNotifier(Ehcache cache)

Returns a ToolkitNotifier for the cachse to notify CacheEventNotificationMsg across the cluster

getOrCreateExtractorsMap

org.terracotta.toolkit.collections.ToolkitMap<String,AttributeExtractor> getOrCreateExtractorsMap(String cacheManagerName,
                                                                                                  String cacheName)

Returns a ToolkitMap for storing serialized extractors for the cache

Parameters:

cacheManagerName -

cacheName -

Throws:

UnsupportedOperationException - if search is not supported

getOrCreateAttributeMap

org.terracotta.toolkit.collections.ToolkitMap<String,String> getOrCreateAttributeMap(String cacheManagerName,
                                                                                     String cacheName)

Returns a ToolkitMap that will be used internally by Toolkit to store attribute schema.

Parameters:

cacheName -

destroy

boolean destroy(String cacheManagerName,
                String cacheName)

Destorys any clustered state associated with the given cache.

Parameters:

cacheManagerName -

cacheName -

shutdown

void shutdown()

Shutdown

getOrCreateTransactionCommitStateMap

SerializedToolkitCache<TransactionID,Decision> getOrCreateTransactionCommitStateMap(String cacheManagerName)

Return the map used for storing commit state of ehcache transactions

getOrCreateAllSoftLockMap

SerializedToolkitCache<ClusteredSoftLockIDKey,SerializedReadCommittedClusteredSoftLock> getOrCreateAllSoftLockMap(String cacheManagerName,
                                                                                                                  String cacheName)

getOrCreateNewSoftLocksSet

org.terracotta.toolkit.collections.ToolkitMap<SerializedReadCommittedClusteredSoftLock,Integer> getOrCreateNewSoftLocksSet(String cacheManagerName,
                                                                                                                           String cacheName)

getOrCreateClusteredStoreConfigMap

org.terracotta.toolkit.collections.ToolkitMap<String,Serializable> getOrCreateClusteredStoreConfigMap(String cacheManagerName,
                                                                                                      String cacheName)

getOrCreateCacheManagerMetaInfoMap

org.terracotta.toolkit.collections.ToolkitMap<String,Serializable> getOrCreateCacheManagerMetaInfoMap(String cacheManagerName)

getSoftLockWriteLock

org.terracotta.toolkit.concurrent.locks.ToolkitLock getSoftLockWriteLock(String cacheManagerName,
                                                                         String cacheName,
                                                                         TransactionID transactionID,
                                                                         Object key)

getSoftLockFreezeLock

org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock getSoftLockFreezeLock(String cacheManagerName,
                                                                                   String cacheName,
                                                                                   TransactionID transactionID,
                                                                                   Object key)

getSoftLockNotifierLock

org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock getSoftLockNotifierLock(String cacheManagerName,
                                                                                     String cacheName,
                                                                                     TransactionID transactionID,
                                                                                     Object key)

removeNonStopConfigforCache

void removeNonStopConfigforCache(Ehcache cache)

getLockForCache

org.terracotta.toolkit.concurrent.locks.ToolkitLock getLockForCache(Ehcache cache,
                                                                    String lockName)

getOrCreateCacheDisposalNotifier

org.terracotta.toolkit.events.ToolkitNotifier<CacheDisposalNotification> getOrCreateCacheDisposalNotifier(Ehcache cache)

getOrCreateWanAwareToolkitCache

WanAwareToolkitCache<String,Serializable> getOrCreateWanAwareToolkitCache(String cacheManagerName,
                                                                          String cacheName,
                                                                          CacheConfiguration ehcacheConfig,
                                                                          boolean masterCache,
                                                                          boolean bidirectional)

This method should only be used by the Orchestrator for fetching a WanAwareToolkitCache

waitForOrchestrator

void waitForOrchestrator(String cacheManagerName)

markCacheWanDisabled

void markCacheWanDisabled(String cacheManagerName,
                          String cacheName)

linkClusteredCacheManager

void linkClusteredCacheManager(String cacheManagerName,
                               Configuration configuration)

Links a terracotta enabled cache manager to the cluster

Parameters:

cacheManagerName - the cache manager name

configuration -

unlinkCache

void unlinkCache(String cacheName)

Un-links a terracotta enabled cache from the cluster

Parameters:

cacheName - the cache name

getAsyncProcessingBucket

org.terracotta.toolkit.internal.collections.ToolkitListInternal getAsyncProcessingBucket(String bucketName,
                                                                                         String cacheName)

clusterRejoined

void clusterRejoined()