com.terracotta.entity.ehcache

Interface ClusteredCacheManager

All Superinterfaces:

ClusteredEntity<ClusteredCacheManagerConfiguration>, RootEntity<ClusteredCacheManagerConfiguration>, Serializable

All Known Implementing Classes:

ToolkitBackedClusteredCacheManager

public interface ClusteredCacheManager
extends RootEntity<ClusteredCacheManagerConfiguration>

ClusteredCacheManager

Method Summary

Modifier and Type	Method and Description
ClusteredCache	addCacheIfAbsent(String cacheName, ClusteredCache clusteredCache) Method for adding a ClusteredCache to this ClusteredCacheManager.
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()
boolean	isCacheUsed(ClusteredCache clusteredCache)
boolean	isUsed()
void	markCacheInUse(ClusteredCache clusteredCache)
void	markInUse()
void	releaseCacheUse(ClusteredCache clusteredCache)
void	releaseUse()

Methods inherited from interface com.terracotta.entity.ClusteredEntity

getConfiguration, getState

Method Detail

getCaches

Map<String,ClusteredCache> getCaches()

getCache

ClusteredCache getCache(String cacheName)

addCacheIfAbsent

ClusteredCache addCacheIfAbsent(String cacheName,
                                ClusteredCache clusteredCache)

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.

Parameters:

cacheName - the name of the cache

clusteredCache - the clustered cache

Returns:

the current known mapping if any, null otherwise

destroyCache

boolean destroyCache(ClusteredCache clusteredCache)

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

Parameters:

clusteredCache - the cache entity to destroy

Returns:

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

getCacheLock

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

markInUse

void markInUse()

releaseUse

void releaseUse()

isUsed

boolean isUsed()

markCacheInUse

void markCacheInUse(ClusteredCache clusteredCache)

releaseCacheUse

void releaseCacheUse(ClusteredCache clusteredCache)

isCacheUsed

boolean isCacheUsed(ClusteredCache clusteredCache)