com.tangosol.net

Class ExtensibleConfigurableCacheFactory.Manager

java.lang.Object

com.tangosol.util.Base

com.tangosol.net.AbstractBackingMapManager

com.tangosol.net.ExtensibleConfigurableCacheFactory.Manager

All Implemented Interfaces:

BackingMapManager

Enclosing class:

ExtensibleConfigurableCacheFactory

public static class ExtensibleConfigurableCacheFactory.Manager
extends AbstractBackingMapManager

The Manager class uses builders to create the required backing maps and provides client access to those maps.

This class also implements methods to create/release backup maps as needed by PartitionedCache$Storage$BackingManager.

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter, Base.StackFrame

Field Summary

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors

Constructor and Description
Manager(ExtensibleConfigurableCacheFactory factory) Construct the backing map manager.

Method Summary

Modifier and Type	Method and Description
protected CachingScheme	findCachingScheme(String sName) Return the CachingScheme for a given cache name.
protected DistributedScheme	findDistributedScheme(String sName) Return the DistributedScheme for a given cache name.
Map	getBackingMap(String sName) Get the backing Map associated with a given cache.
ExtensibleConfigurableCacheFactory	getCacheFactory() Obtain the "container" ConfigurableCacheFactory that created this manager and which this manager is bound to.
protected com.tangosol.config.expression.ParameterResolver	getResolver(String sName) Return the ParameterResolver for the given cache.
protected com.tangosol.config.expression.ScopedParameterResolver	getScopedResolver(String sName) Return the ScopedParameterResolver for the given cache.
StorageAccessAuthorizer	getStorageAccessAuthorizer(String sName) Determine the StorageAccessAuthorizer that is used by a CacheService to secure access to the NamedCache with the specified name.
void	init(BackingMapManagerContext context) Called by a CacheService to indicate to this manager that the manager is being associated with the CacheService.
Map	instantiateBackingMap(String sName) Instantiate a [thread safe] Map that should be used by a CacheService to store cached values for a NamedCache with the specified name.
Map	instantiateBackupMap(String sName) Instantiate a [thread safe] Map that should be used by a CacheService to store cached values for a NamedCache with the specified name.
protected Map	instantiatePartitionedBackingMap(MapBuilder bldrMap, com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies, CachingScheme scheme) Instantiate a partitioned backing map (an instance of ObservableSplittingBackingMap) using ExtensibleConfigurableCacheFactory.PartitionedBackingMapManager.
boolean	isBackingMapPersistent(String sName) Determine if the contents of the Map that is used by a CacheService to store cached values for a NamedCache with the specified name should be persisted.
boolean	isBackingMapSlidingExpiry(String sName) Determine if the Map that is used by a CacheService to store cached values for a NamedCache with specified name enables the sliding expiry - the expiry delay being extended by the read operations.
boolean	isBackupPartitioned(String sName) Return true if the backup map should be partitioned.
void	releaseBackingMap(String sName, Map map) Release the specified Map that was created using the BackingMapManager.instantiateBackingMap(String) method.
void	releaseBackupMap(String sName, Map map, Map mapListeners) Release the specified Map that was created using the instantiateBackupMap(String) method.
protected void	setBackingMap(String sName, Map map) Associate the specified backing Map with a given name.

Methods inherited from class com.tangosol.net.AbstractBackingMapManager

getContext

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.net.BackingMapManager

isBackingMapPersistent

Constructor Detail

Manager

public Manager(ExtensibleConfigurableCacheFactory factory)

Construct the backing map manager.

Parameters:

factory - the factory associated with this manager

Method Detail

init

public void init(BackingMapManagerContext context)

Called by a CacheService to indicate to this manager that the manager is being associated with the CacheService. This method is called once immediately upon the startup of the CacheService, before any NamedCache objects are created by the CacheService.

Important note: BackingMapManager cannot be associated with more then one instance of a CacheService. However, in a situation when a CacheService automatically restarts, it is possible that this manager instance is re-used by a newly created (restarted) CacheService calling this method once again providing a new context.

Important note: BackingMapManager cannot be associated with more than one instance of a CacheService. However, in a situation when a CacheService automatically restarts, it is possible that this manager instance is re-used by a newly created (restarted) CacheService calling this method once again providing a new context.

Specified by:

init in interface BackingMapManager

Overrides:

init in class AbstractBackingMapManager

Parameters:

context - the BackingMapManagerContext object for this BackingMapManager

instantiateBackingMap

public Map instantiateBackingMap(String sName)

Instantiate a [thread safe] Map that should be used by a CacheService to store cached values for a NamedCache with the specified name.

If the contents of the Map can be modified by anything other than the CacheService itself (e.g. if the Map automatically expires its entries periodically or size-limits its contents), then the returned object must implement the ObservableMap interface.

Parameters:

sName - the name of the NamedCache for which this backing map is being created

Returns:

an object implementing the Map interface that will provide backing storage for the specified cache name

instantiatePartitionedBackingMap

protected Map instantiatePartitionedBackingMap(MapBuilder bldrMap,
                                               com.tangosol.config.expression.ParameterResolver resolver,
                                               MapBuilder.Dependencies dependencies,
                                               CachingScheme scheme)

Instantiate a partitioned backing map (an instance of ObservableSplittingBackingMap) using ExtensibleConfigurableCacheFactory.PartitionedBackingMapManager. If the provided scheme is an instance of ReadWriteBackingMapScheme, the internal scheme's map builder is used to build the backing map.

Parameters:

bldrMap - the MapBuilder for partitions

resolver - the ParameterizedBuilder

dependencies - the ExtensibleConfigurableCacheFactory.Dependencies for MapBuilders

scheme - the CachingScheme of the requested cache

Returns:

partitioned backing map that will provide backing storage for the specified cache

isBackingMapPersistent

public boolean isBackingMapPersistent(String sName)

Determine if the contents of the Map that is used by a CacheService to store cached values for a NamedCache with the specified name should be persisted.

Parameters:

sName - the name of the NamedCache

Returns:

true if the CacheService should persist the backing storage of the specified NamedCache

isBackingMapSlidingExpiry

public boolean isBackingMapSlidingExpiry(String sName)

Determine if the Map that is used by a CacheService to store cached values for a NamedCache with specified name enables the sliding expiry - the expiry delay being extended by the read operations.

Parameters:

sName - the name of the NamedCache

Returns:

true if the backing map of the specified NamedCache enables the sliding expiry

getStorageAccessAuthorizer

public StorageAccessAuthorizer getStorageAccessAuthorizer(String sName)

Determine the StorageAccessAuthorizer that is used by a CacheService to secure access to the NamedCache with the specified name.

Parameters:

sName - the name of the NamedCache

Returns:

the StorageAccessAuthorizer or null if the authorizer is not configured

releaseBackingMap

public void releaseBackingMap(String sName,
                              Map map)

Release the specified Map that was created using the BackingMapManager.instantiateBackingMap(String) method. This method is invoked by the CacheService when the CacheService no longer requires the specified Map object.

Specified by:

releaseBackingMap in interface BackingMapManager

Overrides:

releaseBackingMap in class AbstractBackingMapManager

Parameters:

sName - the name of the NamedCache for which the specified Map object has acted as the backing map

map - the Map object that is being released

instantiateBackupMap

public Map instantiateBackupMap(String sName)

Instantiate a [thread safe] Map that should be used by a CacheService to store cached values for a NamedCache with the specified name.

Parameters:

sName - the name of the NamedCache for which this map is being created

Returns:

an object implementing the Map interface that will provide backing storage for the specified cache name

releaseBackupMap

public void releaseBackupMap(String sName,
                             Map map,
                             Map mapListeners)

Release the specified Map that was created using the instantiateBackupMap(String) method. This method is invoked by the CacheService when the CacheService no longer requires the specified Map object.

Parameters:

sName - the cache name

map - the Map object that is being released

mapListeners - the map of listeners for the map

isBackupPartitioned

public boolean isBackupPartitioned(String sName)

Return true if the backup map should be partitioned.

Parameters:

sName - the cache name

Returns:

true if the backup map should be partitioned

getCacheFactory

public ExtensibleConfigurableCacheFactory getCacheFactory()

Obtain the "container" ConfigurableCacheFactory that created this manager and which this manager is bound to.

Returns:

the ConfigurableCacheFactory that created this manager

getResolver

protected com.tangosol.config.expression.ParameterResolver getResolver(String sName)

Return the ParameterResolver for the given cache.

Parameters:

sName - the cache name

Returns:

the ParameterResolver

getScopedResolver

protected com.tangosol.config.expression.ScopedParameterResolver getScopedResolver(String sName)

Return the ScopedParameterResolver for the given cache. A scoped resolver is needed so that a sub-class (like TransactionScheme.Manager) can add a parameter to the resolver.

Parameters:

sName - the cache name

Returns:

the ScopedParameterResolver

getBackingMap

public Map getBackingMap(String sName)

Get the backing Map associated with a given cache.

Parameters:

sName - the cache name

Returns:

a Map associated with the specified name

setBackingMap

protected void setBackingMap(String sName,
                             Map map)

Associate the specified backing Map with a given name.

Parameters:

sName - the cache name

map - the backing map associated with the specified name

findDistributedScheme

protected DistributedScheme findDistributedScheme(String sName)

Return the DistributedScheme for a given cache name.

Parameters:

sName - the cache name

Returns:

the DistributedScheme or null

findCachingScheme

protected CachingScheme findCachingScheme(String sName)

Return the CachingScheme for a given cache name. If the caching scheme is a near cache then return the back scheme.

Parameters:

sName - the cache name

Returns:

the CachingScheme or null