com.terracotta.entity.ehcache

Class ToolkitBackedClusteredCacheManager

java.lang.Object

com.terracotta.entity.ehcache.ToolkitBackedClusteredCacheManager

All Implemented Interfaces:

ClusteredEntity<ClusteredCacheManagerConfiguration>, ClusteredCacheManager, InternalRootEntity, LockingEntity, ToolkitAwareEntity, RootEntity<ClusteredCacheManagerConfiguration>, Serializable

public class ToolkitBackedClusteredCacheManager
extends Object
implements ClusteredCacheManager, ToolkitAwareEntity, LockingEntity, InternalRootEntity

ClusteredCacheManager

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ToolkitBackedClusteredCacheManager(String cacheManagerName, ClusteredCacheManagerConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
ClusteredCache	addCacheIfAbsent(String cacheName, ClusteredCache clusteredCache) Method for adding a ClusteredCache to this ClusteredCacheManager.
void	addCacheMetaInfo(String cacheName, org.terracotta.toolkit.ToolkitObjectType type, String dsName)
void	addKeyRemoveInfo(String cacheName, String toolkitMapName, String keytoBeRemoved)
void	alive()
void	destroy()
boolean	destroyCache(ClusteredCache clusteredCache) Method for destroying a cache entity This method will follow these steps: Put cache entity in exclusive maintenance mode If this fails, throws IllegalStateException Verify the cache entity passed in matches the current known cache entity If this fails, throws IllegalArgumentException Update the cache entity state to ClusteredEntityState.DESTROY_IN_PROGRESS and save it If this fails, throws UnsupportedOperationException Perform the destroy operation
ClusteredCache	getCache(String cacheName)
org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock	getCacheLock(String cacheName)
Map<String,ClusteredCache>	getCaches()
ClusteredCacheManagerConfiguration	getConfiguration()
org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock	getEntityLock()
ClusteredEntityState	getState()
boolean	isCacheUsed(ClusteredCache clusteredCache)
boolean	isUsed()
void	markCacheInUse(ClusteredCache clusteredCache)
void	markDestroying()
void	markInUse()
void	releaseCacheUse(ClusteredCache clusteredCache)
void	releaseUse()
void	setEntityLockHandler(EntityLockHandler entityLockHandler)
void	setToolkit(org.terracotta.toolkit.Toolkit toolkit)

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolkitBackedClusteredCacheManager

public ToolkitBackedClusteredCacheManager(String cacheManagerName,
                                          ClusteredCacheManagerConfiguration configuration)

Method Detail

getConfiguration

public ClusteredCacheManagerConfiguration getConfiguration()

Specified by:

getConfiguration in interface ClusteredEntity<ClusteredCacheManagerConfiguration>

getState

public ClusteredEntityState getState()

Specified by:

getState in interface ClusteredEntity<ClusteredCacheManagerConfiguration>

setToolkit

public void setToolkit(org.terracotta.toolkit.Toolkit toolkit)

Specified by:

setToolkit in interface ToolkitAwareEntity

setEntityLockHandler

public void setEntityLockHandler(EntityLockHandler entityLockHandler)

Specified by:

setEntityLockHandler in interface LockingEntity

getCaches

public Map<String,ClusteredCache> getCaches()

Specified by:

getCaches in interface ClusteredCacheManager

getCache

public ClusteredCache getCache(String cacheName)

Specified by:

getCache in interface ClusteredCacheManager

addCacheIfAbsent

public ClusteredCache addCacheIfAbsent(String cacheName,
                                       ClusteredCache clusteredCache)

Description copied from interface: ClusteredCacheManager

Method for adding a ClusteredCache to this ClusteredCacheManager.
If a ClusteredCache with that name is already known, it will be returned and the clusteredCache passed in will not be added.

Specified by:

addCacheIfAbsent in interface ClusteredCacheManager

Parameters:

cacheName - the name of the cache

clusteredCache - the clustered cache

Returns:

the current known mapping if any, null otherwise

destroyCache

public boolean destroyCache(ClusteredCache clusteredCache)

Description copied from interface: ClusteredCacheManager

Method for destroying a cache entity
This method will follow these steps:

1. Put cache entity in exclusive maintenance mode If this fails, throws IllegalStateException
2. Verify the cache entity passed in matches the current known cache entity If this fails, throws IllegalArgumentException
3. Update the cache entity state to ClusteredEntityState.DESTROY_IN_PROGRESS and save it If this fails, throws UnsupportedOperationException
4. Perform the destroy operation

Specified by:

destroyCache in interface ClusteredCacheManager

Parameters:

clusteredCache - the cache entity to destroy

Returns:

true if entity was effectively destroyed, false if entity does not exist

addCacheMetaInfo

public void addCacheMetaInfo(String cacheName,
                             org.terracotta.toolkit.ToolkitObjectType type,
                             String dsName)

addKeyRemoveInfo

public void addKeyRemoveInfo(String cacheName,
                             String toolkitMapName,
                             String keytoBeRemoved)

getCacheLock

public org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock getCacheLock(String cacheName)

Specified by:

getCacheLock in interface ClusteredCacheManager

getEntityLock

public org.terracotta.toolkit.concurrent.locks.ToolkitReadWriteLock getEntityLock()

Specified by:

getEntityLock in interface InternalRootEntity

markInUse

public void markInUse()

Specified by:

markInUse in interface ClusteredCacheManager

releaseUse

public void releaseUse()

Specified by:

releaseUse in interface ClusteredCacheManager

isUsed

public boolean isUsed()

Specified by:

isUsed in interface ClusteredCacheManager

markCacheInUse

public void markCacheInUse(ClusteredCache clusteredCache)

Specified by:

markCacheInUse in interface ClusteredCacheManager

releaseCacheUse

public void releaseCacheUse(ClusteredCache clusteredCache)

Specified by:

releaseCacheUse in interface ClusteredCacheManager

isCacheUsed

public boolean isCacheUsed(ClusteredCache clusteredCache)

Specified by:

isCacheUsed in interface ClusteredCacheManager

destroy

public void destroy()

Specified by:

destroy in interface InternalRootEntity

markDestroying

public void markDestroying()

Specified by:

markDestroying in interface InternalRootEntity

alive

public void alive()

Specified by:

alive in interface InternalRootEntity