Package com.tangosol.coherence.config.scheme

Class DistributedScheme

java.lang.Object

com.tangosol.coherence.config.scheme.AbstractScheme

com.tangosol.coherence.config.scheme.AbstractServiceScheme<D>

com.tangosol.coherence.config.scheme.AbstractCachingScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>

com.tangosol.coherence.config.scheme.DistributedScheme

All Implemented Interfaces:

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

Direct Known Subclasses:

PagedTopicScheme

public class DistributedScheme
extends AbstractCachingScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>
implements ClusteredCachingScheme, BundlingScheme

The DistributedScheme class builds a distributed cache.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.06

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DistributedScheme.BackupConfig	The DistributedScheme.BackupConfig class manages configuration for the partitioned cache backup map.

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

Modifier	Constructor	Description
	DistributedScheme()	Constructs a DistributedScheme.
protected	DistributedScheme(com.tangosol.internal.net.service.grid.PartitionedCacheDependencies deps)	Constructs a DistributedScheme.

Method Summary

Modifier and Type	Method	Description
BackingMapScheme	getBackingMapScheme()	Return the BackingMapScheme which builds the backing map for the clustered scheme.
BackupMapConfig	getBackupMapConfig()	Return the BackupMapConfig which is used to configure the backup map.
BundleManager	getBundleManager()	Obtains the BundleManager.
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.
void	setBackingMapScheme(BackingMapScheme scheme)	Set the BackingMapScheme which builds the backing map for the clustered scheme.
void	setBackupMapConfig(BackupMapConfig config)	Set the BackupMapConfig which is used to configure a backup map.
void	setBundleManager(BundleManager mgrBundle)	Set the BundleManager.
void	setEventInterceptorBuilders(List<NamedEventInterceptorBuilder> listBuilders)	Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.

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

establishMapListeners, getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeCache, realizeMap, 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, 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

getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

Constructor Detail

DistributedScheme

public DistributedScheme()

Constructs a DistributedScheme.

DistributedScheme

protected DistributedScheme(com.tangosol.internal.net.service.grid.PartitionedCacheDependencies deps)

Constructs a DistributedScheme.

Parameters:

deps - the PartitionedCacheDependencies to use

Method Detail

getServiceType

public String getServiceType()

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

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 AbstractServiceScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>

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

Specified by:

isRunningClusterNeeded in class AbstractServiceScheme<com.tangosol.internal.net.service.grid.PartitionedCacheDependencies>

Returns:

true if a running cluster is needed before using a service

getBundleManager

public BundleManager getBundleManager()

Obtains the BundleManager.

Specified by:

getBundleManager in interface BundlingScheme

Returns:

the BundleManager

getBackingMapScheme

public BackingMapScheme getBackingMapScheme()

Return the BackingMapScheme which builds the backing map for the clustered scheme.

Specified by:

getBackingMapScheme in interface ClusteredCachingScheme

Returns:

the scheme

setBackingMapScheme

@Injectable("backing-map-scheme")
public void setBackingMapScheme(BackingMapScheme scheme)

Set the BackingMapScheme which builds the backing map for the clustered scheme.

Parameters:

scheme - the scheme builder

getBackupMapConfig

public BackupMapConfig getBackupMapConfig()

Return the BackupMapConfig which is used to configure the backup map.

Returns:

the backup map configuration

setBundleManager

@Injectable("operation-bundling")
public void setBundleManager(BundleManager mgrBundle)

Set the BundleManager.

Parameters:

mgrBundle - the BundleManager

setBackupMapConfig

@Injectable("backup-storage")
public void setBackupMapConfig(BackupMapConfig config)

Set the BackupMapConfig which is used to configure a backup map.

Parameters:

config - the backup map configuration

setEventInterceptorBuilders

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

Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.

Parameters:

listBuilders - the List of NamedEventInterceptorBuilders