Package com.tangosol.coherence.config.scheme

Class WrapperCachingScheme

java.lang.Object

com.tangosol.coherence.config.scheme.WrapperCachingScheme

All Implemented Interfaces:

BackingMapManagerBuilder, MapBuilder, NamedCacheBuilder, CachingScheme, Scheme, ServiceScheme

Direct Known Subclasses:

PagedTopicStorageScheme

public class WrapperCachingScheme
extends Object
implements CachingScheme

A simple implementation of the CachingScheme interface built as a wrapper around another CachingScheme implementation.

Since:

Coherence 14.1.1

Author:

jk 2015.05.29

Nested Class Summary

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

MapBuilder.Dependencies

Field Summary

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

DELIM_APPLICATION_SCOPE, DELIM_DOMAIN_PARTITION

Constructor Summary

Constructors

Constructor	Description
WrapperCachingScheme(CachingScheme innerScheme)	Create a WrapperCachingScheme that wraps a specified CachingScheme.

Method Summary

Modifier and Type	Method	Description
CachingScheme	getCachingScheme()	Obtain the wrapped CachingScheme.
List<NamedEventInterceptorBuilder>	getEventInterceptorBuilders()	Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.
String	getSchemeName()	Obtains the name of the Scheme.
String	getScopedServiceName()	Return the service name with any scoping applied.
ServiceBuilder	getServiceBuilder()	Return the ServiceBuilder that is needed to build a service.
String	getServiceName()	Return the service name.
String	getServiceType()	Return the service type.
boolean	isAnonymous()	Determines if the Scheme is a defined and thus useful name.
boolean	isAutoStart()	Return true if the service has auto-start enabled.
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.
Map	realizeMap(ParameterResolver resolver, MapBuilder.Dependencies dependencies)	Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.

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

getNamedCollectionBuilder, getScopedServiceNameForProperty

Constructor Details

WrapperCachingScheme

public WrapperCachingScheme(CachingScheme innerScheme)

Create a WrapperCachingScheme that wraps a specified CachingScheme.

Parameters:

innerScheme - the CachingScheme being wrapped

Method Details

getCachingScheme

public CachingScheme getCachingScheme()

Obtain the wrapped CachingScheme.

Returns:

the wrapped CachingScheme

realizeBackingMapManager

public BackingMapManager realizeBackingMapManager(ConfigurableCacheFactory ccf)

Description copied from interface: BackingMapManagerBuilder

Realize a BackingMapManager to be scoped by the specified ConfigurableCacheFactory.

Specified by:

realizeBackingMapManager in interface BackingMapManagerBuilder

Parameters:

ccf - the ConfigurableCacheFactory

Returns:

a BackingMapManager

realizeMap

public Map realizeMap(ParameterResolver resolver,
 MapBuilder.Dependencies dependencies)

Description copied from interface: MapBuilder

Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.

Specified by:

realizeMap in interface MapBuilder

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder.Dependencies for realizing the Map

Returns:

a Map

realizeCache

public NamedCache realizeCache(ParameterResolver resolver,
 MapBuilder.Dependencies dependencies)

Description copied from interface: NamedCacheBuilder

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

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder dependencies

Returns:

a NamedCache

isAutoStart

public boolean isAutoStart()

Description copied from interface: ServiceScheme

Return true if the service has auto-start enabled.

Specified by:

isAutoStart in interface ServiceScheme

Returns:

the auto-start flag.

getServiceName

public String getServiceName()

Description copied from interface: ServiceScheme

Return the service name.

Specified by:

getServiceName in interface ServiceScheme

Returns:

the service name

getScopedServiceName

public String getScopedServiceName()

Description copied from interface: ServiceScheme

Return the service name with any scoping applied. The scoped name in general has the following format:

   [<domain-partition-name>'/'] [<application-scope>':'] <service-name>
 

Specified by:

getScopedServiceName in interface ServiceScheme

Returns:

the scoped service name

getServiceType

public String getServiceType()

Description copied from interface: ServiceScheme

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

Returns:

the service type

getServiceBuilder

public ServiceBuilder getServiceBuilder()

Description copied from interface: ServiceScheme

Return the ServiceBuilder that is needed to build a service.

Specified by:

getServiceBuilder in interface ServiceScheme

Returns:

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

getEventInterceptorBuilders

public List<NamedEventInterceptorBuilder> getEventInterceptorBuilders()

Description copied from interface: ServiceScheme

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

Returns:

an List over NamedEventInterceptorBuilders

getSchemeName

public String getSchemeName()

Description copied from interface: Scheme

Obtains the name of the Scheme.

Specified by:

getSchemeName in interface Scheme

Returns:

the scheme name

isAnonymous

public boolean isAnonymous()

Description copied from interface: Scheme

Determines if the Scheme is a defined and thus useful name.

Specified by:

isAnonymous in interface Scheme

Returns:

if the Scheme has a name.