Package com.tangosol.coherence.config.scheme

Class NearScheme

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<T>

com.tangosol.coherence.config.scheme.AbstractCompositeScheme<NearCache>

com.tangosol.coherence.config.scheme.NearScheme

All Implemented Interfaces:

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

public class NearScheme
extends AbstractCompositeScheme<NearCache>
implements NamedCacheBuilder

The NearScheme is used to realize (create) an instance of a NearCache.

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

Modifier and Type	Field	Description
protected static String	TYPE_NEAR	Service type for near caches.

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

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.
String	getInvalidationStrategy(ParameterResolver resolver)	Return the invalidation strategy.
ServiceBuilder	getServiceBuilder()	Return the ServiceBuilder that is needed to build a service.
String	getServiceType()	Return the service type.
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.
void	setInvalidationStrategy(Expression<String> expr)	Set the invalidation strategy.

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

getBackScheme, getFrontScheme, setBackScheme, setFrontScheme, validate

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

getCustomBuilder, getEventInterceptorBuilders, isRunningClusterNeeded, setCustomBuilder

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

getDefaultParameterResolver, getListenerBuilder, realizeMap, setListenerBuilder

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

ensureService, getDefaultServiceName, getScopedServiceName, getScopeName, 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, getServiceName, isAutoStart

Field Detail

TYPE_NEAR

protected static final String TYPE_NEAR

Service type for near caches.

Since:

12.2.1.4.19

See Also:

Constant Field Values

Constructor Detail

NearScheme

public NearScheme()

Method Detail

getServiceBuilder

public ServiceBuilder getServiceBuilder()

Return the ServiceBuilder that is needed to build a service.

Specified by:

getServiceBuilder in interface ServiceScheme

Overrides:

getServiceBuilder in class AbstractServiceScheme

Returns:

the ServiceBuilder or null if the scheme does not support services.

getServiceType

public String getServiceType()

Description copied from class: AbstractLocalCachingScheme

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

Overrides:

getServiceType in class AbstractLocalCachingScheme<NearCache>

Returns:

the service type

realizeBackingMapManager

public BackingMapManager realizeBackingMapManager(ConfigurableCacheFactory ccf)

Realize a BackingMapManager to be scoped by the specified ConfigurableCacheFactory.

Specified by:

realizeBackingMapManager in interface BackingMapManagerBuilder

Overrides:

realizeBackingMapManager in class AbstractCachingScheme

Parameters:

ccf - the ConfigurableCacheFactory

Returns:

a BackingMapManager

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

Overrides:

realizeCache in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder dependencies

Returns:

a NamedCache

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

Overrides:

establishMapListeners in class AbstractCachingScheme

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

getInvalidationStrategy

public String getInvalidationStrategy(ParameterResolver resolver)

Return the invalidation strategy.

Parameters:

resolver - the ParameterResolver

Returns:

the invalidation strategy

setInvalidationStrategy

@Injectable
public void setInvalidationStrategy(Expression<String> expr)

Set the invalidation strategy.

Parameters:

expr - the invalidation strategy