Skip navigation links

com.tangosol.net
Interface Service

All Superinterfaces:

ClassLoaderAware, Controllable, Service

All Known Subinterfaces:

CacheService, DistributedCacheService, InvocationService, NameService, PartitionedService, ProxyService

All Known Implementing Classes:

WrapperCacheService, WrapperInvocationService

public interface Service

extends Service

This Service interface represents a controllable service that operates in a clustered network environment.

Since:

Coherence 1.1

Author:

gg 2002.02.08

Nested Class Summary

static interface

Service.MemberJoinAction MemberJoinAction is taken to allow a new member to join a clustered Service.

Method Summary

void	addMemberListener(MemberListener listener) Add a Member listener.
Cluster	getCluster() Return the Cluster object that this Service is a part of.
ServiceInfo	getInfo() Return the ServiceInfo object for this Service.
Serializer	getSerializer() Return a Serializer used by this Service.
java.lang.Object	getUserContext() Return the user context object associated with this Service.
void	removeMemberListener(MemberListener listener) Remove a Member listener.
void	setDependencies(ServiceDependencies deps) Configure the Service.
void	setUserContext(java.lang.Object oCtx) Associate a user context object with this Service.

Methods inherited from interface com.tangosol.util.Service

addServiceListener, removeServiceListener

Methods inherited from interface com.tangosol.util.Controllable

configure, isRunning, shutdown, start, stop

Methods inherited from interface com.tangosol.io.ClassLoaderAware

getContextClassLoader, setContextClassLoader

Method Detail

getCluster

Cluster getCluster()

Return the Cluster object that this Service is a part of.

Returns:

the Cluster object

getInfo

ServiceInfo getInfo()

Return the ServiceInfo object for this Service.

Returns:

the ServiceInfo object

addMemberListener

void addMemberListener(MemberListener listener)

Add a Member listener.

Parameters:

listener - the MemberListener to add

removeMemberListener

void removeMemberListener(MemberListener listener)

Remove a Member listener.

Parameters:

listener - the MemberListener to remove

getUserContext

java.lang.Object getUserContext()

Return the user context object associated with this Service.

The data type and semantics of this context object are entirely application specific and are opaque to the Service itself.

Returns:

an associated user context object or null if a context has not been set

Since:

Coherence 3.0

setUserContext

void setUserContext(java.lang.Object oCtx)

Associate a user context object with this Service.

Parameters:

oCtx - a user context object

Since:

Coherence 3.0

getSerializer

Serializer getSerializer()

Return a Serializer used by this Service.

Returns:

the Serializer object

Since:

Coherence 3.4

setDependencies

void setDependencies(ServiceDependencies deps)

Configure the Service.

This method can only be called before the Service is started.

Parameters:

deps - the dependencies object carrying configuration information specific to this Service

Throws:

java.lang.IllegalStateException - thrown if the Service is already running

java.lang.IllegalArgumentException - thrown if the configuration information is invalid

Since:

Coherence 12.1.3

Skip navigation links