Package 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<Map>

com.tangosol.coherence.config.scheme.CustomScheme

All Implemented Interfaces:

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

public class CustomScheme
extends AbstractLocalCachingScheme<Map>

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.

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.

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

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
CustomScheme(ParameterizedBuilder<Map> bldr)	Construct a CustomScheme.

Method Summary

Modifier and Type	Method	Description
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.
Service	realizeService(ParameterResolver resolver, 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

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

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

getSchemeName, isAnonymous, setSchemeName

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

getNamedCollectionBuilder, getScopedServiceName, getScopedServiceNameForProperty, getServiceBuilder, getServiceName, isAutoStart

Constructor Details

CustomScheme

public CustomScheme(ParameterizedBuilder<Map> bldr)

Construct a CustomScheme.

Parameters:

bldr - the InstanceBuilder to wrap

Method Details

realizeService

public Service realizeService(ParameterResolver resolver,
 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 ParameterResolver

loader - the ClassLoader

cluster - the Cluster which will already be running if necessary

Returns:

the Service

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

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

validate

protected void validate()

Validate the builder properties.

Overrides:

validate in class AbstractScheme