Package com.tangosol.coherence.config.scheme

Class AbstractCachingScheme<D extends ServiceDependencies>

java.lang.Object

com.tangosol.coherence.config.scheme.AbstractScheme

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

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

All Implemented Interfaces:

BackingMapManagerBuilder, MapBuilder, NamedCacheBuilder, ServiceBuilder, CachingScheme, ObservableCachingScheme, Scheme, ServiceScheme

Direct Known Subclasses:

AbstractLocalCachingScheme, BaseGrpcScheme, DistributedScheme, ProxyScheme, RemoteCacheScheme, ReplicatedScheme, TransactionalScheme

public abstract class AbstractCachingScheme<D extends ServiceDependencies>
extends AbstractServiceScheme<D>
implements ObservableCachingScheme

An AbstractCachingScheme is a base implementation for an CachingScheme.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.28

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
AbstractCachingScheme()

Method Summary

Modifier and Type	Method	Description
void	establishMapListeners(Map map, ParameterResolver resolver, MapBuilder.Dependencies dependencies)	Establishes an appropriate MapListener (provided by the ObservableCachingScheme.getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.
ParameterResolver	getDefaultParameterResolver()	Obtains the ParameterResolver to use when resolving parameters without one being available in a context.
ParameterizedBuilder<MapListener>	getListenerBuilder()	Obtains a ParameterizedBuilder for a MapListener that can be used for building MapListeners those of which may be later added to the Maps or NamedCaches realized by the CachingScheme.
BackingMapManager	realizeBackingMapManager(ConfigurableCacheFactory ccf)	Realize a BackingMapManager to be scoped by the specified ConfigurableCacheFactory.
NamedCache	realizeCache(ParameterResolver resolver, MapBuilder.Dependencies dependencies)	Realizes a NamedCache (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.
Map	realizeMap(ParameterResolver resolver, MapBuilder.Dependencies dependencies)	Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.
void	setListenerBuilder(ParameterizedBuilder<MapListener> bldr)	Set the ParameterizedBuilder that builds a MapListener.
protected void	validate(ParameterResolver resolver)	Validate the properties.

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

ensureService, getDefaultServiceName, getEventInterceptorBuilders, getScopedServiceName, getScopeName, getServiceBuilder, getServiceDependencies, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, isRunningClusterNeeded, 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

getEventInterceptorBuilders, getScopedServiceName, getServiceBuilder, getServiceName, getServiceType, isAutoStart

Constructor Detail

AbstractCachingScheme

public AbstractCachingScheme()

Method Detail

realizeCache

public NamedCache realizeCache(ParameterResolver resolver,
                               MapBuilder.Dependencies dependencies)

Realizes a NamedCache (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.

The MapBuilder dependencies are required to satisfy the requirement when realizing a NamedCache additionally involves realizing one or more internal Maps.

Specified by:

realizeCache in interface NamedCacheBuilder

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder dependencies

Returns:

a NamedCache

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

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder.Dependencies for realizing the Map

Returns:

a Map

realizeBackingMapManager

public BackingMapManager realizeBackingMapManager(ConfigurableCacheFactory ccf)

Realize a BackingMapManager to be scoped by the specified ConfigurableCacheFactory.

Specified by:

realizeBackingMapManager in interface BackingMapManagerBuilder

Parameters:

ccf - the ConfigurableCacheFactory

Returns:

a BackingMapManager

getListenerBuilder

public ParameterizedBuilder<MapListener> getListenerBuilder()

Obtains a ParameterizedBuilder for a MapListener that can be used for building MapListeners those of which may be later added to the Maps or NamedCaches realized by the CachingScheme.

Specified by:

getListenerBuilder in interface ObservableCachingScheme

Returns:

a ParameterizedBuilder for MapListeners

establishMapListeners

public void establishMapListeners(Map map,
                                  ParameterResolver resolver,
                                  MapBuilder.Dependencies dependencies)

Establishes an appropriate MapListener (provided by the ObservableCachingScheme.getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.

This method will automatically inject the following types and named values into realized classes that have been annotated with @Injectable.

1. BackingMapManagerContext (optionally named "manager-context")
2. ConfigurableCacheFactory
3. Cache Name (as a String.class named "cache-name")
4. Context ClassLoader (optionally named "class-loader")
5. ResourceRegistry
6. CacheConfig
7. together with any other resource, named or otherwise, available in the ResourceRegistry provided by the ConfigurableCacheFactory.

Specified by:

establishMapListeners in interface ObservableCachingScheme

Parameters:

map - an ObservableMap to which to add a MapListener (if the map is not observable, no listeners are added)

resolver - the ParameterResolver to use for resolving builder parameters

dependencies - the MapBuilder dependencies from which to obtain builder information

See Also:

Injectable

setListenerBuilder

@Injectable("listener")
public void setListenerBuilder(ParameterizedBuilder<MapListener> bldr)

Set the ParameterizedBuilder that builds a MapListener.

Parameters:

bldr - the ParameterizedBuilder

getDefaultParameterResolver

public ParameterResolver getDefaultParameterResolver()

Obtains the ParameterResolver to use when resolving parameters without one being available in a context.

Returns:

a ParameterResolver

validate

protected void validate(ParameterResolver resolver)

Validate the properties.

Parameters:

resolver - the ParameterResolver needed to resolve expressions