Package com.tangosol.coherence.config.scheme

Interface ServiceScheme

All Superinterfaces:

Scheme

All Known Subinterfaces:

CachingScheme, NamedTopicScheme, ObservableCachingScheme, TopicScheme<C,S>

All Known Implementing Classes:

AbstractCachingScheme, AbstractCompositeScheme, AbstractJournalScheme, AbstractLocalCachingScheme, AbstractServiceScheme, BackingMapScheme, BaseGrpcCacheScheme, BaseGrpcScheme, CaffeineScheme, ClassScheme, ContinuousQueryCacheScheme, CustomScheme, DistributedScheme, ExternalScheme, FlashJournalScheme, InvocationScheme, LocalScheme, NearScheme, OptimisticScheme, OverflowScheme, PagedExternalScheme, PagedTopicScheme, PagedTopicStorageScheme, ProxyScheme, RamJournalScheme, ReadWriteBackingMapScheme, RemoteCacheScheme, RemoteInvocationScheme, ReplicatedScheme, TransactionalScheme, ViewScheme, WrapperCachingScheme

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	DELIM_APPLICATION_SCOPE	Delimiter for the Application Scope in the scoped service name
static String	DELIM_DOMAIN_PARTITION	Delimiter for the Domain Partition name in the scoped service name

Method Summary

Modifier and Type	Method	Description
List<NamedEventInterceptorBuilder>	getEventInterceptorBuilders()	Obtains the List of NamedEventInterceptorBuilders that have been defined for the ServiceScheme.
String	getScopedServiceName()	Return the service name with any scoping applied.
static String	getScopedServiceName(String sScopeName, String sServiceName)	Return a scoped service name
static String	getScopePrefix(String sScopeName, com.tangosol.application.ContainerContext context)	Return a scope name prefixed with any tenancy name.
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	isAutoStart()	Return true if the service has auto-start enabled.

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

getSchemeName, isAnonymous

Field Detail

DELIM_DOMAIN_PARTITION

static final String DELIM_DOMAIN_PARTITION

Delimiter for the Domain Partition name in the scoped service name

See Also:

Constant Field Values

DELIM_APPLICATION_SCOPE

static final String DELIM_APPLICATION_SCOPE

Delimiter for the Application Scope in the scoped service name

See Also:

Constant Field Values

Method Detail

isAutoStart

boolean isAutoStart()

Return true if the service has auto-start enabled.

Returns:

the auto-start flag.

getServiceName

String getServiceName()

Return the service name.

Returns:

the service name

getScopedServiceName

String getScopedServiceName()

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

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

Returns:

the scoped service name

getServiceType

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

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.

Returns:

an List over NamedEventInterceptorBuilders

getScopePrefix

static String getScopePrefix(String sScopeName,
                             com.tangosol.application.ContainerContext context)

Return a scope name prefixed with any tenancy name.

Parameters:

sScopeName - the scope name to prefix

context - an optional container name to use to obtain the domain partition

Returns:

a scope name with a domain partition prefix, or the plain scope name if there is no domain partition

getScopedServiceName

static String getScopedServiceName(String sScopeName,
                                   String sServiceName)

Return a scoped service name

Parameters:

sScopeName - the optional scope name

sServiceName - the service name

Returns:

the scoped service name