Package com.tangosol.coherence.config

Class CacheConfig

java.lang.Object

com.tangosol.coherence.config.CacheConfig

public class CacheConfig
extends Object

A CacheConfig is the top-level container for Coherence Cache Configuration, that of which is used at runtime to establish caches and services.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.2

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOP_LEVEL_ELEMENT_NAME	Top-level element name.

Constructor Summary

Constructors

Constructor	Description
CacheConfig(ParameterResolver defaultParameterResolver)	Construct a CacheConfig.

Method Summary

Modifier and Type	Method	Description
void	addCacheMappingRegistry(SchemeMappingRegistry registry)	Add cache scheme mappings to the SchemeMappingRegistry.
void	addRegistrySchemeMapping(SchemeMappingRegistry registry)	Add topic scheme mappings to scheme SchemeMappingRegistry if no mapping already exists for the same patter.
CachingScheme	findSchemeByCacheName(String sCacheName)	Find the CachingScheme for the specified cache name.
ServiceScheme	findSchemeBySchemeName(String sSchemeName)	Find the ServiceScheme given the scheme name.
ServiceScheme	findSchemeByServiceName(String sServiceName)	Find the ServiceScheme given the service name.
NamedTopicScheme	findSchemeByTopicName(String sTopicName)	Find the CachingScheme for the specified topic name.
CacheMappingRegistry	getCacheMappingRegistry()	Deprecated. As of Coherence 14.1.1, replaced by getMappingRegistry().
ParameterResolver	getDefaultParameterResolver()	Obtain the ParameterResolver to use for the CacheConfig when no other is available or in context.
List<NamedEventInterceptorBuilder>	getEventInterceptorBuilders()	Obtain the List of NamedEventInterceptorBuilders for this CacheConfig.
ResourceMappingRegistry	getMappingRegistry()	Obtain the cache/topic ResourceMappingRegistry for the CacheConfig.
String	getScopeName()	Obtain the scope name of the CacheConfig.
ServiceSchemeRegistry	getServiceSchemeRegistry()	Obtain the ServiceSchemeRegistry for the CacheConfig.
void	setCacheMappingRegistry(CacheMappingRegistry registry)	Deprecated. As of Coherence 14.1.1, replaced by addCacheMappingRegistry(SchemeMappingRegistry).
void	setEventInterceptorBuilders(List<NamedEventInterceptorBuilder> listBuilders)	Set the List of NamedEventInterceptorBuilders for this CacheConfig.
void	setScopeName(String sScopeName)	Deprecated.
void	setServiceSchemeRegistry(ServiceSchemeRegistry registry)	Set the ServiceSchemeRegistry for the CacheConfig.
CacheConfig	validate(ResourceRegistry registry)	Validate the cache configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOP_LEVEL_ELEMENT_NAME

public static final String TOP_LEVEL_ELEMENT_NAME

Top-level element name.

See Also:

Constant Field Values

Constructor Detail

CacheConfig

public CacheConfig(ParameterResolver defaultParameterResolver)

Construct a CacheConfig.

Method Detail

getScopeName

public String getScopeName()

Obtain the scope name of the CacheConfig.

setScopeName

@Injectable("scope-name")
@Deprecated
public void setScopeName(String sScopeName)

Deprecated.

Set the scope name of this CacheConfig (which will be trimmed)

Parameters:

sScopeName - the scope name

getEventInterceptorBuilders

public List<NamedEventInterceptorBuilder> getEventInterceptorBuilders()

Obtain the List of NamedEventInterceptorBuilders for this CacheConfig.

Returns:

a List of NamedEventInterceptorBuilders or null if unspecified

setEventInterceptorBuilders

@Injectable("interceptors")
public void setEventInterceptorBuilders(List<NamedEventInterceptorBuilder> listBuilders)

Set the List of NamedEventInterceptorBuilders for this CacheConfig.

Parameters:

listBuilders - the List of NamedEventInterceptorBuilders for this CacheConfig

getMappingRegistry

public ResourceMappingRegistry getMappingRegistry()

Obtain the cache/topic ResourceMappingRegistry for the CacheConfig.

Returns:

the cache/topic ResourceMappingRegistry

Since:

Coherence 14.1.1

getCacheMappingRegistry

public CacheMappingRegistry getCacheMappingRegistry()

Deprecated.

As of Coherence 14.1.1, replaced by getMappingRegistry().

Obtain the CacheMappingRegistry for the CacheConfig.

Returns:

the CacheMappingRegistry

setCacheMappingRegistry

public void setCacheMappingRegistry(CacheMappingRegistry registry)

Deprecated.

As of Coherence 14.1.1, replaced by addCacheMappingRegistry(SchemeMappingRegistry).

Set the CacheMappingRegistry.

Parameters:

registry - the CacheMappingRegistry

addCacheMappingRegistry

@Injectable("caching-scheme-mapping")
public void addCacheMappingRegistry(SchemeMappingRegistry registry)

Add cache scheme mappings to the SchemeMappingRegistry.

Parameters:

registry - the SchemeMappingRegistry

Since:

Coherence 14.1.1

addRegistrySchemeMapping

@Injectable("topic-scheme-mapping")
public void addRegistrySchemeMapping(SchemeMappingRegistry registry)

Add topic scheme mappings to scheme SchemeMappingRegistry if no mapping already exists for the same patter.

Parameters:

registry - the SchemeMappingRegistry

Since:

Coherence 14.1.1

getServiceSchemeRegistry

public ServiceSchemeRegistry getServiceSchemeRegistry()

Obtain the ServiceSchemeRegistry for the CacheConfig.

Returns:

the ServiceSchemeRegistry

setServiceSchemeRegistry

@Injectable("caching-schemes")
public void setServiceSchemeRegistry(ServiceSchemeRegistry registry)

Set the ServiceSchemeRegistry for the CacheConfig.

Parameters:

registry - the ServiceSchemeRegistry

findSchemeByCacheName

public CachingScheme findSchemeByCacheName(String sCacheName)

Find the CachingScheme for the specified cache name.

Parameters:

sCacheName - the cache name

Returns:

the CachingScheme or null if not found

findSchemeByTopicName

public NamedTopicScheme findSchemeByTopicName(String sTopicName)

Find the CachingScheme for the specified topic name.

Parameters:

sTopicName - the topic name

Returns:

the NamedTopicScheme or null if not found

Since:

Coherence 14.1.1

findSchemeByServiceName

public ServiceScheme findSchemeByServiceName(String sServiceName)

Find the ServiceScheme given the service name.

Parameters:

sServiceName - the service name to match

Returns:

the ServiceScheme or null

findSchemeBySchemeName

public ServiceScheme findSchemeBySchemeName(String sSchemeName)

Find the ServiceScheme given the scheme name.

Parameters:

sSchemeName - the scheme name to match

Returns:

the ServiceScheme or null

getDefaultParameterResolver

public ParameterResolver getDefaultParameterResolver()

Obtain the ParameterResolver to use for the CacheConfig when no other is available or in context.

Returns:

the default ParameterResolver

validate

public CacheConfig validate(ResourceRegistry registry)

Validate the cache configuration.

Parameters:

registry - the ResourceRegistry associated with this configuration.

Returns:

this object