com.tangosol.net

Class WrapperService

java.lang.Object

com.tangosol.net.WrapperService

All Implemented Interfaces:

ClassLoaderAware, Controllable, Service

Direct Known Subclasses:

WrapperCacheService, WrapperInvocationService

public class WrapperService
extends Object
implements Service

Service implementation that delegates to a wrapped Service instance.

Author:

jh 2010.03.17

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.net.Service

Service.MemberJoinAction

Field Summary

Fields

Modifier and Type	Field and Description
protected Service	m_service The (wrapped) Service.

Constructor Summary

Constructors

Constructor and Description
WrapperService(Service service) Create a new WrapperService that delegates to the given Service instance.

Method Summary

Modifier and Type	Method and Description
void	addMemberListener(MemberListener listener) Add a Member listener.
void	addServiceListener(ServiceListener listener) Register a ServiceListener that will receive events pertaining to the lifecycle of this Service.
void	configure(XmlElement xml) Configure the controllable service.
Cluster	getCluster() Return the Cluster object that this Service is a part of.
ClassLoader	getContextClassLoader() Retrieve the context ClassLoader for this object.
ServiceDependencies	getDependencies() Return the service's dependencies.
ServiceInfo	getInfo() Return the ServiceInfo object for this Service.
int	getMinimumServiceVersion() Return the minimum version for the members in this set.
ResourceRegistry	getResourceRegistry() Retrieves a Service scoped ResourceRegistry.
Serializer	getSerializer() Return a Serializer used by this Service.
Service	getService() Return the wrapped Service.
Object	getUserContext() Return the user context object associated with this Service.
boolean	isRunning() Determine whether or not the controllable service is running.
boolean	isVersionCompatible(int nVersion) Check whether the members of this service run a version that is greater than or equal to the specified version.
boolean	isVersionCompatible(int nYear, int nMonth, int nPatch) Check whether the members of this service run a version that is greater than or equal to the specified version.
boolean	isVersionCompatible(int nMajor, int nMinor, int nMicro, int nPatchSet, int nPatch) Check whether the members of this service run a version that is greater than or equal to the specified version.
boolean	isVersionCompatible(IntPredicate predicate) Check whether the members of this service run a minimum service version that matches a specified IntPredicate.
void	removeMemberListener(MemberListener listener) Remove a Member listener.
void	removeServiceListener(ServiceListener listener) Unregister a ServiceListener from this ConnectionManager.
void	setContextClassLoader(ClassLoader loader) Specify the context ClassLoader for this object.
void	setDependencies(ServiceDependencies deps) Configure the Service.
void	setUserContext(Object oCtx) Associate a user context object with this Service.
void	shutdown() Stop the controllable service.
void	start() Start the controllable service.
void	stop() Hard-stop the controllable service.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_service

protected Service m_service

The (wrapped) Service.

Constructor Detail

WrapperService

public WrapperService(Service service)

Create a new WrapperService that delegates to the given Service instance.

Parameters:

service - the Service to wrap

Method Detail

getDependencies

public ServiceDependencies getDependencies()

Return the service's dependencies.

Returns:

the service's dependencies

getCluster

public Cluster getCluster()

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

Returns:

the Cluster object

getInfo

public ServiceInfo getInfo()

Return the ServiceInfo object for this Service.

Returns:

the ServiceInfo object

addMemberListener

public void addMemberListener(MemberListener listener)

Add a Member listener.

MemberListeners will be invoked in the order in which they are registered.

Parameters:

listener - the MemberListener to add

removeMemberListener

public void removeMemberListener(MemberListener listener)

Remove a Member listener.

Parameters:

listener - the MemberListener to remove

getUserContext

public 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

setUserContext

public void setUserContext(Object oCtx)

Associate a user context object with this Service.

Parameters:

oCtx - a user context object

getSerializer

public Serializer getSerializer()

Return a Serializer used by this Service.

Returns:

the Serializer object

addServiceListener

public void addServiceListener(ServiceListener listener)

Register a ServiceListener that will receive events pertaining to the lifecycle of this Service.

Specified by:

addServiceListener in interface Service

Parameters:

listener - the new ServiceListener to register; if the listener has already been registered, this method has no effect

removeServiceListener

public void removeServiceListener(ServiceListener listener)

Unregister a ServiceListener from this ConnectionManager.

After a ServiceListener is removed, it will no longer receive events pertaining to the lifecycle of this Service.

Specified by:

removeServiceListener in interface Service

Parameters:

listener - the ServiceListener to deregister; if the listener has not previously been registered, this method has no effect

configure

public void configure(XmlElement xml)

Configure the controllable service.

This method can only be called before the controllable service is started.

Specified by:

configure in interface Controllable

Parameters:

xml - an XmlElement carrying configuration information specific to the Controllable object

start

public void start()

Start the controllable service.

This method should only be called once per the life cycle of the Controllable service. This method has no affect if the service is already running.

Specified by:

start in interface Controllable

isRunning

public boolean isRunning()

Determine whether or not the controllable service is running. This method returns false before a service is started, while the service is starting, while a service is shutting down and after the service has stopped. It only returns true after completing its start processing and before beginning its shutdown processing.

Specified by:

isRunning in interface Controllable

Returns:

true if the service is running; false otherwise

shutdown

public void shutdown()

Stop the controllable service. This is a controlled shut-down, and is preferred to the Controllable.stop() method.

This method should only be called once per the life cycle of the controllable service. Calling this method for a service that has already stopped has no effect.

Specified by:

shutdown in interface Controllable

stop

public void stop()

Hard-stop the controllable service. Use Controllable.shutdown() for normal service termination. Calling this method for a service that has already stopped has no effect.

Specified by:

stop in interface Controllable

getContextClassLoader

public ClassLoader getContextClassLoader()

Retrieve the context ClassLoader for this object. The context ClassLoader is provided by the creator of the object for use by the object when loading classes and resources.

Specified by:

getContextClassLoader in interface ClassLoaderAware

Returns:

the context ClassLoader for this object

See Also:

Thread.getContextClassLoader()

setContextClassLoader

public void setContextClassLoader(ClassLoader loader)

Specify the context ClassLoader for this object. The context ClassLoader can be set when the object is created, and allows the creator to provide the appropriate class loader to be used by the object when when loading classes and resources.

Specified by:

setContextClassLoader in interface ClassLoaderAware

Parameters:

loader - the context ClassLoader for this object

setDependencies

public 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

getResourceRegistry

public ResourceRegistry getResourceRegistry()

Retrieves a Service scoped ResourceRegistry. The resource registry is used to:

• Register resources with the Service and make them accessible to the application code bound to this Service.
• Dispose of resources when the Service is shut down; see the ResourceRegistry API for details on how to enable cleanup of resources.

Returns:

a Service scoped resource registry

isVersionCompatible

public boolean isVersionCompatible(int nMajor,
                                   int nMinor,
                                   int nMicro,
                                   int nPatchSet,
                                   int nPatch)

Description copied from interface: Service

Check whether the members of this service run a version that is greater than or equal to the specified version.

Parameters:

nMajor - the major version number

nMinor - the minor version number

nMicro - the micro version number

nPatchSet - the patch set version number

nPatch - the patch version number

Returns:

true if the members of the service are all running a version that is greater than or equal to the specified version

isVersionCompatible

public boolean isVersionCompatible(int nYear,
                                   int nMonth,
                                   int nPatch)

Description copied from interface: Service

Check whether the members of this service run a version that is greater than or equal to the specified version.

Parameters:

nYear - the year version number

nMonth - the month version number

nPatch - the patch version number

Returns:

true if the members of the service are all running a version that is greater than or equal to the specified version

isVersionCompatible

public boolean isVersionCompatible(int nVersion)

Description copied from interface: Service

Check whether the members of this service run a version that is greater than or equal to the specified version.

Parameters:

nVersion - the encoded version to compare

Returns:

true if the members of the service are all running a version that is greater than or equal to the specified version

isVersionCompatible

public boolean isVersionCompatible(IntPredicate predicate)

Description copied from interface: Service

Check whether the members of this service run a minimum service version that matches a specified IntPredicate.

Parameters:

predicate - an IntPredicate to apply to the minimum encoded service version

Returns:

true if the minimum service version matches the predicate

getMinimumServiceVersion

public int getMinimumServiceVersion()

Description copied from interface: Service

Return the minimum version for the members in this set.

The version is the int encoded version (see VersionHelper).

Returns:

the minimum version for the members in this set

toString

public String toString()

Overrides:

toString in class Object

getService

public Service getService()

Return the wrapped Service.

Returns:

the wrapped Service