Skip navigation links

com.tangosol.coherence.config.scheme
Class CustomScheme

java.lang.Object
com.tangosol.coherence.config.scheme.AbstractScheme
com.tangosol.coherence.config.scheme.AbstractServiceScheme
com.tangosol.coherence.config.scheme.AbstractCachingScheme
com.tangosol.coherence.config.scheme.AbstractLocalCachingScheme
com.tangosol.coherence.config.scheme.CustomScheme

All Implemented Interfaces:

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

public class CustomScheme

extends AbstractLocalCachingScheme

A CustomScheme is an adapter for a ParameterizedBuilder that builds a Map.

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

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

Since:

Coherence 12.1.2

Author:

pfm 2011.12.06

See Also:

Injectable

Nested Class Summary

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

MapBuilder.Dependencies

Constructor Summary

CustomScheme(ParameterizedBuilder bldr)
Construct a CustomScheme.

Method Summary

NamedCache	realizeCache(com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Realizes a NamedCache (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.
java.util.Map	realizeMap(com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.
Service	realizeService(com.tangosol.config.expression.ParameterResolver resolver, java.lang.ClassLoader loader, Cluster cluster) Realize (ensure) a Service.
protected void	validate() Validate the builder 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, setListenerBuilder, validate

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

getScopedServiceName, getScopedServiceName, getScopeName, getServiceBuilder, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, setAutoStart, setScopeName, setServiceName, setXml

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

getSchemeName, isAnonymous, setSchemeName

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

getScopedServiceName, getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

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

getSchemeName, isAnonymous

Constructor Detail

CustomScheme

public CustomScheme(ParameterizedBuilder bldr)

Construct a CustomScheme.

Parameters:

bldr - the InstanceBuilder to wrap

Method Detail

realizeService

public Service realizeService(com.tangosol.config.expression.ParameterResolver resolver,
                              java.lang.ClassLoader loader,
                              Cluster cluster)

Realize (ensure) a Service. The returned Service is fully configured and ready to be used.

Specified by:

realizeService in interface ServiceBuilder

Overrides:

realizeService in class AbstractServiceScheme

Parameters:

resolver - the ParameterResover

loader - the ClassLoader

cluster - the Cluster which will already be running if necessary

Returns:

the Service

realizeCache

public NamedCache realizeCache(com.tangosol.config.expression.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

realizeMap

public java.util.Map realizeMap(com.tangosol.config.expression.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

validate

protected void validate()

Validate the builder properties.

Overrides:

validate in class AbstractServiceScheme

Skip navigation links