Skip navigation links

com.tangosol.coherence.config.scheme
Interface ServiceScheme

All Superinterfaces:

Scheme

All Known Subinterfaces:

CachingScheme, ObservableCachingScheme

All Known Implementing Classes:

AbstractBundlingScheme, AbstractCachingScheme, AbstractCompositeScheme, AbstractJournalScheme, AbstractLocalCachingScheme, AbstractServiceScheme, BackingMapScheme, ClassScheme, CustomScheme, DistributedScheme, ExternalScheme, FlashJournalScheme, InvocationScheme, LocalScheme, NearScheme, OptimisticScheme, OverflowScheme, PagedExternalScheme, ProxyScheme, RamJournalScheme, ReadWriteBackingMapScheme, RemoteCacheScheme, RemoteInvocationScheme, ReplicatedScheme, TransactionalScheme

public interface ServiceScheme

extends Scheme

This interface exposes service related scheme information. Other schemes, such as CachingScheme, extend this class to add support for caches and maps.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.30

Method Summary

java.util.List	getEventInterceptorBuilders() Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.
java.lang.String	getScopedServiceName() Return the service name with any scoping applied.
java.lang.String	getScopedServiceName(java.lang.String sScopeNameOverride) Return the service name with any scoping applied.
ServiceBuilder	getServiceBuilder() Return the ServiceBuilder that is needed to build a service.
java.lang.String	getServiceName() Return the service name.
java.lang.String	getServiceType() Return the service type.
boolean	isAutoStart() Return true if the service has auto-start enabled.

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

getSchemeName, isAnonymous

Method Detail

isAutoStart

boolean isAutoStart()

Return true if the service has auto-start enabled.

Returns:

the auto-start flag.

getServiceName

java.lang.String getServiceName()

Return the service name.

Returns:

the service name

getScopedServiceName

java.lang.String getScopedServiceName()

Return the service name with any scoping applied.

Returns:

the scoped service name

getScopedServiceName

java.lang.String getScopedServiceName(java.lang.String sScopeNameOverride)

Return the service name with any scoping applied.

Parameters:

sScopeNameOverride - the scope name to be used in preference to a configured scope name

Returns:

the scoped service name

getServiceType

java.lang.String getServiceType()

Return the service type.

Returns:

the service type

getServiceBuilder

ServiceBuilder getServiceBuilder()

Return the ServiceBuilder that is needed to build a service.

Returns:

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

getEventInterceptorBuilders

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.

Returns:

an List over NamedEventInterceptorBuilders

Skip navigation links