Package com.tangosol.coherence.config.builder

Interface ServiceBuilder

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, ProxyScheme, RamJournalScheme, ReadWriteBackingMapScheme, RemoteCacheScheme, RemoteInvocationScheme, ReplicatedScheme, TransactionalScheme, ViewScheme

public interface ServiceBuilder

The ServiceBuilder interface is used by a builder that creates a Service.

Since:

Coherence 12.1.2

Author:

pfm 2011.12.14

Method Summary

Modifier and Type	Method	Description
String	getScopeName()	Return the scope name.
XmlElement	getXml()	Deprecated.
boolean	isRunningClusterNeeded()	Return true if a running cluster is needed before using a service.
Service	realizeService(ParameterResolver resolver, ClassLoader loader, Cluster cluster)	Realize (ensure) a Service.
void	setXml(XmlElement element)	Deprecated.

Method Detail

isRunningClusterNeeded

boolean isRunningClusterNeeded()

Return true if a running cluster is needed before using a service.

Returns:

true if a running cluster is needed before using a service

getScopeName

String getScopeName()

Return the scope name.

Returns:

the scope name

getXml

@Deprecated
XmlElement getXml()

Deprecated.

Return the XmlElement that may be used to realize a Service by the ServiceBuilder.

Note: There's no guarantee an implementation of this interface will use the returned XmlElement.

Returns:

the XmlElement

setXml

@Deprecated
void setXml(XmlElement element)

Deprecated.

Set the XmlElement that may be used to realize a Service.

Note: There's no guarantee an implementation of this interface will use the specified XmlElement.

Parameters:

element - the XmlElement

realizeService

Service realizeService(ParameterResolver resolver,
                       ClassLoader loader,
                       Cluster cluster)

Realize (ensure) a Service. The returned Service is fully configured and ready to be used.

Parameters:

resolver - the ParameterResolver

loader - the ClassLoader

cluster - the Cluster which will already be running if necessary

Returns:

the Service