Skip navigation links

com.tangosol.coherence.config.scheme
Class DistributedScheme

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.AbstractBundlingScheme
com.tangosol.coherence.config.scheme.DistributedScheme

All Implemented Interfaces:

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

public class DistributedScheme

extends AbstractBundlingScheme

implements ClusteredCachingScheme

The DistributedScheme class builds a distributed cache. The super class AbstractBundlingScheme realizes the cache and applies bundling to that cache.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.06

Nested Class Summary

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

Constructor Summary

DistributedScheme()

Method Summary

BackingMapScheme	getBackingMapScheme() Return the BackingMapScheme which builds the backing map for the clustered scheme.
BackupMapConfig	getBackupMapConfig() Return the BackupMapConfig which which is used to configure the backup map.
java.util.List	getEventInterceptorBuilders() Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.
java.lang.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 which is used to configure a backup map.
void	setEventInterceptorBuilders(java.util.List listBuilders) Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.
void	setXml(XmlElement xml) Set the XML so that we can create a Service using the SafeCluster.ensureService.

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

getBundleManager, realizeCache, setBundleManager

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

getScopedServiceName, getScopedServiceName, getScopeName, getServiceBuilder, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, realizeService, setAutoStart, setScopeName, setServiceName, validate

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

getSchemeName, isAnonymous, setSchemeName

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

getScopedServiceName, getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

Methods inherited from interface com.tangosol.coherence.config.scheme.Scheme

getSchemeName, isAnonymous

Constructor Detail

DistributedScheme

public DistributedScheme()

Method Detail

getServiceType

public java.lang.String getServiceType()

Return the service type.

Specified by:

getServiceType in interface ServiceScheme

Returns:

the service type

getEventInterceptorBuilders

public java.util.List 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

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

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(value="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 which is used to configure the backup map.

Returns:

the backup map configuration

setBackupMapConfig

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

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

Parameters:

config - the backup map configuration

setEventInterceptorBuilders

@Injectable(value="interceptors")
public void setEventInterceptorBuilders(java.util.List listBuilders)

Sets the List of NamedEventInterceptorBuilders for the DistributedScheme.

Parameters:

listBuilders - the List of NamedEventInterceptorBuilders

setXml

public void setXml(XmlElement xml)

Set the XML so that we can create a Service using the SafeCluster.ensureService.

Specified by:

setXml in interface ServiceBuilder

Overrides:

setXml in class AbstractServiceScheme

Parameters:

xml - the distributed-scheme XML

Skip navigation links