Package com.tangosol.coherence.config.scheme

Class ClassScheme

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

com.tangosol.coherence.config.scheme.ClassScheme

All Implemented Interfaces:

BackingMapManagerBuilder, BuilderCustomization<Object>, MapBuilder, NamedCacheBuilder, ParameterizedBuilder<Object>, ParameterizedBuilder.ReflectionSupport, ServiceBuilder, CachingScheme, ObservableCachingScheme, Scheme, ServiceScheme

public class ClassScheme
extends AbstractLocalCachingScheme<Object>
implements ParameterizedBuilder<Object>, ParameterizedBuilder.ReflectionSupport

The ClassScheme class is responsible for building custom CachingSchemes and custom CacheStoreSchemes.

Note: The ParameterizedBuilder interface is needed by both CacheStoreScheme and ElementProcessorHelper.

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 2012.02.27

See Also:

• Injectable

Nested Class Summary

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

MapBuilder.Dependencies

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

ParameterizedBuilder.ReflectionSupport

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

Method Summary

Modifier and Type	Method	Description
List<NamedEventInterceptorBuilder>	getEventInterceptorBuilders()	Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.
String	getServiceType()	Return the service type.
boolean	isRunningClusterNeeded()	Return true if a running cluster is needed before using a service.
Object	realize(ParameterResolver resolver, ClassLoader loader, ParameterList listParameters)	Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.
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.
boolean	realizes(Class<?> clzClass, ParameterResolver resolver, ClassLoader loader)	Determines if the ParameterizedBuilder will realize an instance of the specified class (without requiring the builder to actually realize an object).
protected void	validate()	Validate the ClassScheme properties.

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

getCustomBuilder, 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, realizeService, 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

getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

Constructor Details

ClassScheme

public ClassScheme()

Method Details

getServiceType

public String getServiceType()

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

Overrides:

getServiceType in class AbstractLocalCachingScheme<Object>

Returns:

the service type

getEventInterceptorBuilders

public List<NamedEventInterceptorBuilder> getEventInterceptorBuilders()

Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.

Note: For those ServiceSchemes don't support event interceptors, the returned value must be an empty list.

Specified by:

getEventInterceptorBuilders in interface ServiceScheme

Overrides:

getEventInterceptorBuilders in class AbstractLocalCachingScheme<Object>

Returns:

an List over NamedEventInterceptorBuilders

isRunningClusterNeeded

public boolean isRunningClusterNeeded()

Return true if a running cluster is needed before using a service.

Specified by:

isRunningClusterNeeded in interface ServiceBuilder

Overrides:

isRunningClusterNeeded in class AbstractLocalCachingScheme<Object>

Returns:

true if a running cluster is needed before using a 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

realize

public Object realize(ParameterResolver resolver,
 ClassLoader loader,
 ParameterList listParameters)

Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.

Specified by:

realize in interface ParameterizedBuilder<Object>

Parameters:

resolver - the ParameterResolver for resolving named Parameters

loader - the ClassLoader for loading any necessary classes and if null the ClassLoader used to load the builder will be used instead

listParameters - an optional ParameterList (may be null) to be used for realizing the instance, eg: used as constructor parameters

Returns:

an instance of T

realizes

public boolean realizes(Class<?> clzClass,
 ParameterResolver resolver,
 ClassLoader loader)

Determines if the ParameterizedBuilder will realize an instance of the specified class (without requiring the builder to actually realize an object).

This method is synonymous with the Java keyword instanceof but allows dynamic runtime type querying of the types of objects a builder may realize.

Specified by:

realizes in interface ParameterizedBuilder.ReflectionSupport

Parameters:

clzClass - the expected type

resolver - the ParameterResolver to use for resolving necessary Parameters

loader - the ClassLoader for loading any necessary classes and if null the ClassLoader used to load the builder will be used instead

Returns:

true if the ParameterizedBuilder will realize an instance of the class, false otherwise

validate

protected void validate()

Validate the ClassScheme properties.

Overrides:

validate in class AbstractScheme