org.jboss.msc.service

Class DelegatingServiceContainer

java.lang.Object

org.jboss.msc.service.DelegatingServiceContainer

All Implemented Interfaces:

ServiceContainer, ServiceRegistry, ServiceTarget

public class DelegatingServiceContainer
extends java.lang.Object
implements ServiceContainer

A delegating container for things which depend on a service container rather than a specific target or registry instance.

Author:

David M. Lloyd, Richard Opalka

Nested Class Summary

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

ServiceContainer.Factory, ServiceContainer.TerminateListener

Constructor Summary

Constructors

Constructor and Description
DelegatingServiceContainer(ServiceTarget serviceTargetDelegate, ServiceRegistry serviceRegistryDelegate) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
ServiceContainer	addDependency(java.util.Collection<ServiceName> dependencies) Add a collection of dependencies that will be added to the all ServiceBuilders installed in this target
ServiceContainer	addDependency(ServiceName... dependencies) Add a list of dependencies that will be added to the all ServiceBuilders installed in this target.
ServiceContainer	addDependency(ServiceName dependency) Add a dependency that will be added to the all ServiceBuilders installed in this target.
ServiceContainer	addListener(java.util.Collection<ServiceListener<java.lang.Object>> listeners) Deprecated.
ServiceContainer	addListener(LifecycleListener listener) Add a service lifecycle listener that will be added to this service.
ServiceContainer	addListener(ServiceListener<java.lang.Object>... listeners) Deprecated.
ServiceContainer	addListener(ServiceListener<java.lang.Object> listener) Deprecated.
ServiceTarget	addMonitor(StabilityMonitor monitor) Add a stability monitor that will be added to all the ServiceBuilders installed in this target.
ServiceTarget	addMonitors(StabilityMonitor... monitors) Add a stability monitors that will be added to all the ServiceBuilders installed in this target.
<T> ServiceBuilder<T>	addService(ServiceName name, Service<T> service) Get a builder which can be used to add a service to this target.
<T> ServiceBuilder<T>	addServiceValue(ServiceName name, Value<? extends Service<T>> value) Get a builder which can be used to add a service to this target.
void	addTerminateListener(ServiceContainer.TerminateListener listener) Add a terminate listener to this container.
void	awaitStability() Causes the current thread to wait until the container is stable.
boolean	awaitStability(long timeout, java.util.concurrent.TimeUnit unit) Causes the current thread to wait until the container is stable.
boolean	awaitStability(long timeout, java.util.concurrent.TimeUnit unit, java.util.Set<? super ServiceController<?>> failed, java.util.Set<? super ServiceController<?>> problem) Causes the current thread to wait until the container is stable.
void	awaitStability(java.util.Set<? super ServiceController<?>> failed, java.util.Set<? super ServiceController<?>> problem) Causes the current thread to wait until the container is stable.
void	awaitTermination() Causes the current thread to wait until the container is shutdown.
void	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit) Causes the current thread to wait until the container is shutdown.
BatchServiceTarget	batchTarget() Create a new batch service target, which is used to install described services in this target.
void	dumpServices() Dump a complete list of services to System.out.
void	dumpServices(java.io.PrintStream stream) Dump a complete list of services to the given stream.
java.util.Set<ServiceName>	getDependencies() Returns a set of all dependencies added to this target.
java.util.Set<ServiceListener<java.lang.Object>>	getListeners() Returns a set of the listeners added to this target.
java.util.Set<StabilityMonitor>	getMonitors() Returns a set of the monitors added to this target.
java.lang.String	getName() Get the name of this service container.
ServiceController<?>	getRequiredService(ServiceName serviceName) Get a service, throwing an exception if it is not found.
ServiceController<?>	getService(ServiceName serviceName) Get a service, returning null if it is not found.
java.util.List<ServiceName>	getServiceNames() Get a list of service names installed in this registry.
protected ServiceRegistry	getServiceRegistryDelegate() Get the ServiceRegistry delegate.
protected ServiceTarget	getServiceTargetDelegate() Get the ServiceTarget delegate.
boolean	isShutdown() Whether container have been shut down.
boolean	isShutdownComplete() Determine whether the container is completely shut down.
ServiceContainer	removeDependency(ServiceName dependency) Remove a dependency from this target.
ServiceContainer	removeListener(LifecycleListener listener) Remove a lifecycle listener from this target, if it exists.
ServiceContainer	removeListener(ServiceListener<java.lang.Object> listener) Deprecated.
ServiceTarget	removeMonitor(StabilityMonitor monitor) Remove a monitor from this target, if it exists.
void	shutdown() Stop all services within this container.
ServiceTarget	subTarget() Create a sub-target using this as the parent target.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingServiceContainer

public DelegatingServiceContainer(ServiceTarget serviceTargetDelegate,
                                  ServiceRegistry serviceRegistryDelegate)

Construct a new instance.

Parameters:

serviceTargetDelegate - the delegate to forward service target requests to

serviceRegistryDelegate - the delegate to forward registry requests to

Method Detail

getServiceTargetDelegate

protected ServiceTarget getServiceTargetDelegate()

Get the ServiceTarget delegate.

Returns:

ServiceTarget delegate

getServiceRegistryDelegate

protected ServiceRegistry getServiceRegistryDelegate()

Get the ServiceRegistry delegate.

Returns:

ServiceRegistry delegate

addServiceValue

public <T> ServiceBuilder<T> addServiceValue(ServiceName name,
                                             Value<? extends Service<T>> value)
                                      throws java.lang.IllegalArgumentException

Get a builder which can be used to add a service to this target.

Specified by:

addServiceValue in interface ServiceTarget

Parameters:

name - the service name

value - the service value

Returns:

the builder for the service

Throws:

java.lang.IllegalArgumentException

addService

public <T> ServiceBuilder<T> addService(ServiceName name,
                                        Service<T> service)
                                 throws java.lang.IllegalArgumentException

Get a builder which can be used to add a service to this target.

Specified by:

addService in interface ServiceTarget

Parameters:

name - the service name

service - the service

Returns:

the builder for the service

Throws:

java.lang.IllegalArgumentException

addListener

public ServiceContainer addListener(LifecycleListener listener)

Add a service lifecycle listener that will be added to this service.

Specified by:

addListener in interface ServiceTarget

Parameters:

listener - the lifecycle listener to add to the service

Returns:

this target

addListener

@Deprecated
public ServiceContainer addListener(ServiceListener<java.lang.Object> listener)

Deprecated.

Add a service listener that will be added to all the ServiceBuilders installed in this target.

Specified by:

addListener in interface ServiceTarget

Parameters:

listener - the listener to add to the target

Returns:

this target

addListener

@Deprecated
public ServiceContainer addListener(ServiceListener<java.lang.Object>... listeners)

Deprecated.

Add a list of service listener that will be added to all ServiceBuilders installed in this target.

Specified by:

addListener in interface ServiceTarget

Parameters:

listeners - a list of listeners to add to the target

Returns:

this target

addListener

@Deprecated
public ServiceContainer addListener(java.util.Collection<ServiceListener<java.lang.Object>> listeners)

Deprecated.

Add a collection of service listener that will be added to all ServiceBuilders installed in this target.

Specified by:

addListener in interface ServiceTarget

Parameters:

listeners - a collection of listeners to add to the target

Returns:

this target

removeListener

public ServiceContainer removeListener(LifecycleListener listener)

Remove a lifecycle listener from this target, if it exists.

Specified by:

removeListener in interface ServiceTarget

Parameters:

listener - the lifecycle listener to remove

Returns:

this target

removeListener

@Deprecated
public ServiceContainer removeListener(ServiceListener<java.lang.Object> listener)

Deprecated.

Remove a listener from this target, if it exists.

Specified by:

removeListener in interface ServiceTarget

Parameters:

listener - the listener to remove

Returns:

this target

getListeners

public java.util.Set<ServiceListener<java.lang.Object>> getListeners()

Returns a set of the listeners added to this target.

Specified by:

getListeners in interface ServiceTarget

Returns:

the listeners added to this target

addMonitor

public ServiceTarget addMonitor(StabilityMonitor monitor)

Add a stability monitor that will be added to all the ServiceBuilders installed in this target.

Specified by:

addMonitor in interface ServiceTarget

Parameters:

monitor - the monitor to add to the target

Returns:

this target

addMonitors

public ServiceTarget addMonitors(StabilityMonitor... monitors)

Add a stability monitors that will be added to all the ServiceBuilders installed in this target.

Specified by:

addMonitors in interface ServiceTarget

Parameters:

monitors - the monitors to add to the target

Returns:

this target

removeMonitor

public ServiceTarget removeMonitor(StabilityMonitor monitor)

Remove a monitor from this target, if it exists.

Specified by:

removeMonitor in interface ServiceTarget

Parameters:

monitor - the monitor to remove

Returns:

this target

getMonitors

public java.util.Set<StabilityMonitor> getMonitors()

Returns a set of the monitors added to this target.

Specified by:

getMonitors in interface ServiceTarget

Returns:

the monitors added to this target

addDependency

public ServiceContainer addDependency(ServiceName dependency)

Add a dependency that will be added to the all ServiceBuilders installed in this target.

Specified by:

addDependency in interface ServiceTarget

Parameters:

dependency - the dependency to add to the target

Returns:

this target

addDependency

public ServiceContainer addDependency(ServiceName... dependencies)

Add a list of dependencies that will be added to the all ServiceBuilders installed in this target.

Specified by:

addDependency in interface ServiceTarget

Parameters:

dependencies - a list of dependencies to add to the target

Returns:

this target

addDependency

public ServiceContainer addDependency(java.util.Collection<ServiceName> dependencies)

Add a collection of dependencies that will be added to the all ServiceBuilders installed in this target

Specified by:

addDependency in interface ServiceTarget

Parameters:

dependencies - a collection of dependencies to add to this target

Returns:

this target

removeDependency

public ServiceContainer removeDependency(ServiceName dependency)

Remove a dependency from this target. Subsequently defined services will not have this dependency.

Specified by:

removeDependency in interface ServiceTarget

Parameters:

dependency - the dependency

Returns:

this target

getDependencies

public java.util.Set<ServiceName> getDependencies()

Returns a set of all dependencies added to this target.

Specified by:

getDependencies in interface ServiceTarget

Returns:

all dependencies of this target

subTarget

public ServiceTarget subTarget()

Create a sub-target using this as the parent target.

Specified by:

subTarget in interface ServiceTarget

Returns:

the new service target

batchTarget

public BatchServiceTarget batchTarget()

Create a new batch service target, which is used to install described services in this target.

Specified by:

batchTarget in interface ServiceTarget

Returns:

the new batch service target

getRequiredService

public ServiceController<?> getRequiredService(ServiceName serviceName)
                                        throws ServiceNotFoundException

Get a service, throwing an exception if it is not found.

Specified by:

getRequiredService in interface ServiceRegistry

Parameters:

serviceName - the service name

Returns:

the service controller for the corresponding service

Throws:

ServiceNotFoundException - if the service is not present in the registry

getService

public ServiceController<?> getService(ServiceName serviceName)

Get a service, returning null if it is not found.

Specified by:

getService in interface ServiceRegistry

Parameters:

serviceName - the service name

Returns:

the service controller for the corresponding service, or null if it is not found

getServiceNames

public java.util.List<ServiceName> getServiceNames()

Get a list of service names installed in this registry.

Specified by:

getServiceNames in interface ServiceRegistry

Returns:

the list

getName

public java.lang.String getName()

Get the name of this service container.

Specified by:

getName in interface ServiceContainer

Returns:

the container name

shutdown

public void shutdown()

Stop all services within this container.

Specified by:

shutdown in interface ServiceContainer

isShutdown

public boolean isShutdown()

Whether container have been shut down.

Specified by:

isShutdown in interface ServiceContainer

Returns:

true if container is shutting down

isShutdownComplete

public boolean isShutdownComplete()

Determine whether the container is completely shut down.

Specified by:

isShutdownComplete in interface ServiceContainer

Returns:

true if shutdown is complete

dumpServices

public void dumpServices()

Dump a complete list of services to System.out.

Specified by:

dumpServices in interface ServiceContainer

dumpServices

public void dumpServices(java.io.PrintStream stream)

Dump a complete list of services to the given stream.

Specified by:

dumpServices in interface ServiceContainer

Parameters:

stream - the stream to which the service list should be written

addTerminateListener

public void addTerminateListener(ServiceContainer.TerminateListener listener)

Add a terminate listener to this container. The added listener will be invoked when this container shutdown process is complete.

Specified by:

addTerminateListener in interface ServiceContainer

Parameters:

listener - the listener

awaitTermination

public void awaitTermination()

Causes the current thread to wait until the container is shutdown.

Specified by:

awaitTermination in interface ServiceContainer

awaitTermination

public void awaitTermination(long timeout,
                             java.util.concurrent.TimeUnit unit)
                      throws java.lang.InterruptedException

Causes the current thread to wait until the container is shutdown.

Specified by:

awaitTermination in interface ServiceContainer

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

awaitStability

public void awaitStability()
                    throws java.lang.InterruptedException

Causes the current thread to wait until the container is stable.

Specified by:

awaitStability in interface ServiceContainer

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

awaitStability

public boolean awaitStability(long timeout,
                              java.util.concurrent.TimeUnit unit)
                       throws java.lang.InterruptedException

Causes the current thread to wait until the container is stable.

Specified by:

awaitStability in interface ServiceContainer

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if this container achieved stability, false if the timeout elapsed before stability

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

awaitStability

public void awaitStability(java.util.Set<? super ServiceController<?>> failed,
                           java.util.Set<? super ServiceController<?>> problem)
                    throws java.lang.InterruptedException

Causes the current thread to wait until the container is stable.

Specified by:

awaitStability in interface ServiceContainer

Parameters:

failed - a set into which failed services should be copied

problem - a set into which problem services should be copied

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting

awaitStability

public boolean awaitStability(long timeout,
                              java.util.concurrent.TimeUnit unit,
                              java.util.Set<? super ServiceController<?>> failed,
                              java.util.Set<? super ServiceController<?>> problem)
                       throws java.lang.InterruptedException

Causes the current thread to wait until the container is stable.

Specified by:

awaitStability in interface ServiceContainer

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

failed - a set into which failed services should be copied

problem - a set into which problem services should be copied

Returns:

true if this container achieved stability, false if the timeout elapsed before stability

Throws:

java.lang.InterruptedException - if the current thread is interrupted while waiting