org.jboss.msc.service

Class DelegatingServiceController<S>

java.lang.Object

org.jboss.msc.service.DelegatingServiceController<S>

All Implemented Interfaces:

ServiceController<S>, Value<S>

public class DelegatingServiceController<S>
extends Object
implements ServiceController<S>

A service controller which delegates to another service controller.

Author:

Richard Opalka

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.msc.service.ServiceController

ServiceController.Mode, ServiceController.State, ServiceController.Substate, ServiceController.Transition

Constructor Summary

Constructors

Constructor and Description
DelegatingServiceController(ServiceController<S> delegate) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	addListener(LifecycleListener listener) Add a service lifecycle listener.
void	addListener(ServiceListener<? super S> listener) Deprecated.
S	awaitValue() Deprecated.
S	awaitValue(long time, TimeUnit unit) Deprecated.
boolean	compareAndSetMode(ServiceController.Mode expected, ServiceController.Mode newMode) Compare the current mode against expected; if it matches, change it to newMode.
ServiceName[]	getAliases() Get other names this service is known as.
protected ServiceController<S>	getDelegate() Get the ServiceController delegate.
Set<ServiceName>	getImmediateUnavailableDependencies() Get the complete list of immediate dependencies that are unavailable.
ServiceController.Mode	getMode() Get the service controller's current mode.
ServiceName	getName() Get the name of this service, if any.
ServiceController<?>	getParent() Get this service's parent service, or null if there is none.
Service<S>	getService() Get the service.
ServiceContainer	getServiceContainer() Get the service container associated with this controller.
StartException	getStartException() Get the reason why the last start failed.
ServiceController.State	getState() Get the current service controller state.
ServiceController.Substate	getSubstate() Deprecated.
Collection<ServiceName>	getUnavailableDependencies() Get the complete list of dependencies that are unavailable.
S	getValue() Deprecated.
void	removeListener(LifecycleListener listener) Remove a lifecycle listener.
void	removeListener(ServiceListener<? super S> listener) Deprecated.
void	retry() Retry a failed service.
void	setMode(ServiceController.Mode mode) Change the service controller's current mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingServiceController

public DelegatingServiceController(ServiceController<S> delegate)

Construct a new instance.

Parameters:

delegate - the controller to delegate to

Method Detail

getDelegate

protected ServiceController<S> getDelegate()

Get the ServiceController delegate.

Returns:

ServiceController delegate

getParent

public ServiceController<?> getParent()

Get this service's parent service, or null if there is none.

Specified by:

getParent in interface ServiceController<S>

Returns:

the parent service or null if this service has no parent

getServiceContainer

public ServiceContainer getServiceContainer()

Get the service container associated with this controller.

Specified by:

getServiceContainer in interface ServiceController<S>

Returns:

the container

getMode

public ServiceController.Mode getMode()

Get the service controller's current mode.

Specified by:

getMode in interface ServiceController<S>

Returns:

the controller mode

compareAndSetMode

public boolean compareAndSetMode(ServiceController.Mode expected,
                                 ServiceController.Mode newMode)

Compare the current mode against expected; if it matches, change it to newMode. The return value is true when the mode was matched and changed.

Specified by:

compareAndSetMode in interface ServiceController<S>

Parameters:

expected - the expected mode

newMode - the new mode

Returns:

true if the mode was changed

setMode

public void setMode(ServiceController.Mode mode)

Change the service controller's current mode. Might result in the service starting or stopping. The mode may only be changed if it was not already set to ServiceController.Mode.REMOVE. Calling this method with the controller's current mode has no effect and is always allowed.

Specified by:

setMode in interface ServiceController<S>

Parameters:

mode - the new controller mode

getState

public ServiceController.State getState()

Get the current service controller state.

Specified by:

getState in interface ServiceController<S>

Returns:

the current state

getSubstate

@Deprecated
public ServiceController.Substate getSubstate()

Deprecated.

Get the current service controller substate.

Specified by:

getSubstate in interface ServiceController<S>

Returns:

the current substate

getValue

@Deprecated
public S getValue()
                       throws IllegalStateException

Deprecated.

Get the service value.

Specified by:

getValue in interface ServiceController<S>

Specified by:

getValue in interface Value<S>

Returns:

the service value

Throws:

IllegalStateException - if the service is not available (i.e. it is not up)

awaitValue

@Deprecated
public S awaitValue()
                         throws IllegalStateException,
                                InterruptedException

Deprecated.

Wait for a service to come up, and then return its value.

Specified by:

awaitValue in interface ServiceController<S>

Returns:

the service value

Throws:

IllegalStateException - if the service is not available (i.e. it was removed or failed)

InterruptedException - if the wait operation was interrupted

awaitValue

@Deprecated
public S awaitValue(long time,
                                TimeUnit unit)
                         throws IllegalStateException,
                                InterruptedException,
                                TimeoutException

Deprecated.

Wait for a service to come up for a certain amount of time, and then return its value.

Specified by:

awaitValue in interface ServiceController<S>

Parameters:

time - the amount of time to wait

unit - the unit of time to wait

Returns:

the service value

Throws:

IllegalStateException - if the service is not available (i.e. it was removed or failed)

InterruptedException - if the wait operation was interrupted

TimeoutException

getService

public Service<S> getService()
                      throws IllegalStateException

Get the service.

Specified by:

getService in interface ServiceController<S>

Returns:

the service

Throws:

IllegalStateException - if the service is not available (i.e. it is not up)

getName

public ServiceName getName()

Get the name of this service, if any.

Specified by:

getName in interface ServiceController<S>

Returns:

the name, or null if none was specified.

getAliases

public ServiceName[] getAliases()

Get other names this service is known as.

Specified by:

getAliases in interface ServiceController<S>

Returns:

the aliases

addListener

public void addListener(LifecycleListener listener)

Add a service lifecycle listener.

Specified by:

addListener in interface ServiceController<S>

Parameters:

listener - the lifecycle listener

addListener

@Deprecated
public void addListener(ServiceListener<? super S> listener)

Deprecated.

Add a service listener. The listener's "listener added" callback will be invoked from the same thread that calls this method. Then, the method corresponding to the current service state is called.

Specified by:

addListener in interface ServiceController<S>

Parameters:

listener - the service listener

removeListener

public void removeListener(LifecycleListener listener)

Remove a lifecycle listener.

Specified by:

removeListener in interface ServiceController<S>

Parameters:

listener - the lifecycle listener to remove

removeListener

@Deprecated
public void removeListener(ServiceListener<? super S> listener)

Deprecated.

Remove a service listener.

Specified by:

removeListener in interface ServiceController<S>

Parameters:

listener - the service listener to remove

getStartException

public StartException getStartException()

Get the reason why the last start failed.

Specified by:

getStartException in interface ServiceController<S>

Returns:

the last start exception, or null if the last start succeeded or the service has not yet started

retry

public void retry()

Retry a failed service. Does nothing if the state is not ServiceController.State.START_FAILED.

Specified by:

retry in interface ServiceController<S>

getImmediateUnavailableDependencies

public Set<ServiceName> getImmediateUnavailableDependencies()

Get the complete list of immediate dependencies that are unavailable.

Specified by:

getImmediateUnavailableDependencies in interface ServiceController<S>

Returns:

a set containing the names of all unavailable immediate dependencies

getUnavailableDependencies

public Collection<ServiceName> getUnavailableDependencies()

Get the complete list of dependencies that are unavailable.

Specified by:

getUnavailableDependencies in interface ServiceController<S>

Returns:

a set containing the names of all unavailable dependencies