Package com.tangosol.coherence.config.scheme

Class PagedExternalScheme

java.lang.Object

com.tangosol.coherence.config.scheme.AbstractScheme

com.tangosol.coherence.config.scheme.AbstractServiceScheme<D>

com.tangosol.coherence.config.scheme.AbstractCachingScheme

com.tangosol.coherence.config.scheme.AbstractLocalCachingScheme<Map>

com.tangosol.coherence.config.scheme.PagedExternalScheme

All Implemented Interfaces:

BackingMapManagerBuilder, BuilderCustomization<Map>, MapBuilder, NamedCacheBuilder, ServiceBuilder, BinaryStoreManagerBuilderCustomization, CachingScheme, ObservableCachingScheme, Scheme, ServiceScheme

public class PagedExternalScheme
extends AbstractLocalCachingScheme<Map>
implements BinaryStoreManagerBuilderCustomization

The PagedExternalScheme class is responsible for building a fully configured instance of a PagedExternalCache.

Since:

Coherence 12.1.2

Author:

pfm 2011.11.30

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.coherence.config.builder.MapBuilder

MapBuilder.Dependencies

Field Summary

Fields inherited from class com.tangosol.coherence.config.scheme.AbstractServiceScheme

m_serviceDependencies

Fields inherited from interface com.tangosol.coherence.config.scheme.ServiceScheme

DELIM_APPLICATION_SCOPE, DELIM_DOMAIN_PARTITION

Constructor Summary

Constructors

Constructor	Description
PagedExternalScheme()

Method Summary

Modifier and Type	Method	Description
BinaryStoreManagerBuilder	getBinaryStoreManagerBuilder()	Obtains the BinaryStoreManagerBuilder for the BinaryStoreManager.
Seconds	getPageDurationSeconds(ParameterResolver resolver)	Return the length of time that a page in the cache is current.
int	getPageLimit(ParameterResolver resolver)	Return the maximum number of pages that the cache manages before older pages are destroyed.
protected SerializationPagedCache	instantiateSerializationPagedCache(BinaryStoreManager storeMgr, int cPages, int cPageSecs, boolean fBinaryMap, boolean fPassive)	Construct an SerializationPagedCache using the specified parameters.
protected SerializationPagedCache	instantiateSerializationPagedCache(BinaryStoreManager storeMgr, int cPages, int cPageSecs, ClassLoader loader)	Construct an SerializationPagedCache using the specified parameters.
Map	realizeMap(ParameterResolver resolver, MapBuilder.Dependencies dependencies)	Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.
void	setBinaryStoreManagerBuilder(BinaryStoreManagerBuilder bldr)	Sets the BinaryStoreManagerBuilder for the BinaryStoreManager.
void	setPageDurationSeconds(Expression<Seconds> expr)	Set the page duration.
void	setPageLimit(Expression<Integer> expr)	Set the page limit.
protected void	validate(ParameterResolver resolver)	Validate the properties.

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractLocalCachingScheme

getCustomBuilder, getEventInterceptorBuilders, getServiceType, isRunningClusterNeeded, setCustomBuilder

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractCachingScheme

establishMapListeners, getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeCache, setListenerBuilder

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractServiceScheme

ensureService, getDefaultServiceName, getScopedServiceName, getScopeName, getServiceBuilder, getServiceDependencies, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, realizeService, setAutoStart, setScopeName, setServiceDependencies, setServiceName, setXml

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractScheme

getSchemeName, isAnonymous, setSchemeName, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.coherence.config.scheme.Scheme

getSchemeName, isAnonymous

Methods inherited from interface com.tangosol.coherence.config.scheme.ServiceScheme

getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

Constructor Detail

PagedExternalScheme

public PagedExternalScheme()

Method Detail

realizeMap

public Map realizeMap(ParameterResolver resolver,
                      MapBuilder.Dependencies dependencies)

Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.

Specified by:

realizeMap in interface MapBuilder

Overrides:

realizeMap in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder.Dependencies for realizing the Map

Returns:

a Map

getBinaryStoreManagerBuilder

public BinaryStoreManagerBuilder getBinaryStoreManagerBuilder()

Obtains the BinaryStoreManagerBuilder for the BinaryStoreManager.

Specified by:

getBinaryStoreManagerBuilder in interface BinaryStoreManagerBuilderCustomization

Returns:

the BinaryStoreManagerBuilder

setBinaryStoreManagerBuilder

public void setBinaryStoreManagerBuilder(BinaryStoreManagerBuilder bldr)

Sets the BinaryStoreManagerBuilder for the BinaryStoreManager.

Specified by:

setBinaryStoreManagerBuilder in interface BinaryStoreManagerBuilderCustomization

Parameters:

bldr - the BinaryStoreManagerBuilder

getPageDurationSeconds

public Seconds getPageDurationSeconds(ParameterResolver resolver)

Return the length of time that a page in the cache is current. After the duration is exceeded, the page is closed and a new current page is created. Legal values are zero or values between 5 and 604800 seconds (one week).

Parameters:

resolver - the ParameterResolver

Returns:

the page duration

setPageDurationSeconds

@Injectable("page-duration")
public void setPageDurationSeconds(Expression<Seconds> expr)

Set the page duration.

Parameters:

expr - the page duration expression

getPageLimit

public int getPageLimit(ParameterResolver resolver)

Return the maximum number of pages that the cache manages before older pages are destroyed. Legal values are zero or positive integers between 2 and 3600.

Parameters:

resolver - the ParameterResolver

Returns:

the page limit

setPageLimit

@Injectable
public void setPageLimit(Expression<Integer> expr)

Set the page limit.

Parameters:

expr - the page limit expression

instantiateSerializationPagedCache

protected SerializationPagedCache instantiateSerializationPagedCache(BinaryStoreManager storeMgr,
                                                                     int cPages,
                                                                     int cPageSecs,
                                                                     ClassLoader loader)

Construct an SerializationPagedCache using the specified parameters.

This method exposes a corresponding SerializationPagedCache constructor and is provided for the express purpose of allowing its override.

Parameters:

storeMgr - the BinaryStoreManager that provides BinaryStore objects that the serialized objects are written to

cPages - the maximum number of pages to have active at a time

cPageSecs - the length of time, in seconds, that a 'page' is current

loader - the ClassLoader to use for deserialization

Returns:

the instantiated SerializationPagedCache

instantiateSerializationPagedCache

protected SerializationPagedCache instantiateSerializationPagedCache(BinaryStoreManager storeMgr,
                                                                     int cPages,
                                                                     int cPageSecs,
                                                                     boolean fBinaryMap,
                                                                     boolean fPassive)

Construct an SerializationPagedCache using the specified parameters.

This method exposes a corresponding SerializationPagedCache constructor and is provided for the express purpose of allowing its override.

Parameters:

storeMgr - the BinaryStoreManager that provides BinaryStore objects that the serialized objects are written to

cPages - the maximum number of pages to have active at a time

cPageSecs - the length of time, in seconds, that a 'page' is current

fBinaryMap - true indicates that this map will only manage binary keys and values

fPassive - true indicates that this map is a passive cache, which means that it is just a backup of the cache and does not actively expire data

Returns:

the instantiated SerializationPagedCache

validate

protected void validate(ParameterResolver resolver)

Validate the properties.

Overrides:

validate in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver needed to resolve expressions