Package com.tangosol.coherence.config.scheme

Class TransactionalScheme

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.TransactionalScheme

All Implemented Interfaces:

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

public class TransactionalScheme
extends AbstractCachingScheme

The TransactionalScheme class builds a transactional cache. The transactional cache is a logical cache backed by a set of distributed caches. A distributed service is used to handle the internal txn caches, since they are all distributed caches. Because the transactional cache is logical, it implements the realizeNamedCache used by ECCF.ensureCache. There is no backing map for transactional caches (because they are logical) so realizeMap is not needed. However, the internal distributed txn caches do have backing maps which are handled by the normal DistributedScheme code.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.06

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

Method Summary

Modifier and Type	Method	Description
String	getServiceType()	Return the service type.
boolean	isRunningClusterNeeded()	Return true if a running cluster is needed before using a service.
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.
Service	realizeService(ParameterResolver resolver, ClassLoader loader, Cluster cluster)	Realize (ensure) a Service.

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

establishMapListeners, getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeMap, setListenerBuilder, validate

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

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

Constructor Detail

TransactionalScheme

public TransactionalScheme()

Method Detail

getServiceType

public String getServiceType()

Return the service type.

Returns:

the service type

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

isRunningClusterNeeded

public boolean isRunningClusterNeeded()

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

Specified by:

isRunningClusterNeeded in interface ServiceBuilder

Specified by:

isRunningClusterNeeded in class AbstractServiceScheme

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