JBoss Modular Service Kernel API 1.0.0.CR2

org.jboss.msc.service
Interface ServiceTarget

All Known Subinterfaces:
BatchServiceTarget, ServiceContainer
All Known Implementing Classes:
DelegatingServiceContainer, DelegatingServiceTarget

public interface ServiceTarget

The target of ServiceBuilder installations. ServicesBuilders to be installed on a target should be retrieved by calling one of the addService methods (addService(ServiceName, Service), addServiceValue(ServiceName, Value). Notice that installation will only take place after ServiceBuilder.install() is invoked. ServiceBuilders that are not installed are ignored.

Author:
Flavia Rainone

Method Summary
 ServiceTarget addDependency(Collection<ServiceName> dependencies)
          Add a collection of dependencies that will be added to the all ServiceBuilders installed in this target
 ServiceTarget addDependency(ServiceName... dependencies)
          Add a list of dependencies that will be added to the all ServiceBuilders installed in this target.
 ServiceTarget addDependency(ServiceName dependency)
          Add a dependency that will be added to the all ServiceBuilders installed in this target.
 ServiceTarget addListener(Collection<ServiceListener<Object>> listeners)
          Add a collection of service listener that will be added to all ServiceBuilders installed in this target.
 ServiceTarget addListener(ServiceListener.Inheritance inheritance, Collection<ServiceListener<Object>> listeners)
          Add a collection of service listener that will be added to all ServiceBuilders installed in this target.
 ServiceTarget addListener(ServiceListener.Inheritance inheritance, ServiceListener<Object>... listeners)
          Add a list of service listener that will be added to all ServiceBuilders installed in this target.
 ServiceTarget addListener(ServiceListener.Inheritance inheritance, ServiceListener<Object> listener)
          Add a service listener that will be added to all the ServiceBuilders installed in this target.
 ServiceTarget addListener(ServiceListener<Object>... listeners)
          Add a list of service listener that will be added to all ServiceBuilders installed in this target.
 ServiceTarget addListener(ServiceListener<Object> listener)
          Add a service listener 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.
 BatchServiceTarget batchTarget()
          Create a new batch service target, which is used to install described services in this target.
 Set<ServiceName> getDependencies()
          Returns a set of all dependencies added to this target.
 Set<ServiceListener<Object>> getListeners()
          Returns a set of the listeners added to this target.
 ServiceTarget removeDependency(ServiceName dependency)
          Remove a dependency from this target.
 ServiceTarget removeListener(ServiceListener<Object> listener)
          Remove a listener from this target, if it exists.
 ServiceTarget subTarget()
          Create a sub-target using this as the parent target.
 

Method Detail

addServiceValue

<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.

Parameters:
name - the service name
value - the service value
Returns:
the builder for the service

addService

<T> ServiceBuilder<T> addService(ServiceName name,
                                 Service<T> service)
Get a builder which can be used to add a service to this target.

Parameters:
name - the service name
service - the service
Returns:
the builder for the service

addListener

ServiceTarget addListener(ServiceListener<Object> listener)
Add a service listener that will be added to all the ServiceBuilders installed in this target.

Parameters:
listener - the listener to add to the target
Returns:
this target

addListener

ServiceTarget addListener(ServiceListener<Object>... listeners)
Add a list of service listener that will be added to all ServiceBuilders installed in this target.

Parameters:
listeners - a list of listeners to add to the target
Returns:
this target

addListener

ServiceTarget addListener(Collection<ServiceListener<Object>> listeners)
Add a collection of service listener that will be added to all ServiceBuilders installed in this target.

Parameters:
listeners - a collection of listeners to add to the target
Returns:
this target

addListener

ServiceTarget addListener(ServiceListener.Inheritance inheritance,
                          ServiceListener<Object> listener)
Add a service listener that will be added to all the ServiceBuilders installed in this target.

Parameters:
inheritance - the inheritance type for this listener
listener - the listener to add to the target
Returns:
this target

addListener

ServiceTarget addListener(ServiceListener.Inheritance inheritance,
                          ServiceListener<Object>... listeners)
Add a list of service listener that will be added to all ServiceBuilders installed in this target.

Parameters:
inheritance - the inheritance type for this listener
listeners - a list of listeners to add to the target
Returns:
this target

addListener

ServiceTarget addListener(ServiceListener.Inheritance inheritance,
                          Collection<ServiceListener<Object>> listeners)
Add a collection of service listener that will be added to all ServiceBuilders installed in this target.

Parameters:
inheritance - the inheritance type for this listener
listeners - a collection of listeners to add to the target
Returns:
this target

removeListener

ServiceTarget removeListener(ServiceListener<Object> listener)
Remove a listener from this target, if it exists.

Parameters:
listener - the listener to remove
Returns:
this target

getListeners

Set<ServiceListener<Object>> getListeners()
Returns a set of the listeners added to this target.

Returns:
the listeners added to this target

addDependency

ServiceTarget addDependency(ServiceName dependency)
Add a dependency that will be added to the all ServiceBuilders installed in this target.

Parameters:
dependency - the dependency to add to the target
Returns:
this target

addDependency

ServiceTarget addDependency(ServiceName... dependencies)
Add a list of dependencies that will be added to the all ServiceBuilders installed in this target.

Parameters:
dependencies - a list of dependencies to add to the target
Returns:
this target

addDependency

ServiceTarget addDependency(Collection<ServiceName> dependencies)
Add a collection of dependencies that will be added to the all ServiceBuilders installed in this target

Parameters:
dependencies - a collection of dependencies to add to this target
Returns:
this target

removeDependency

ServiceTarget removeDependency(ServiceName dependency)
Remove a dependency from this target. Subsequently defined services will not have this dependency.

Parameters:
dependency - the dependency
Returns:
this target

getDependencies

Set<ServiceName> getDependencies()
Returns a set of all dependencies added to this target.

Returns:
all dependencies of this target

subTarget

ServiceTarget subTarget()
Create a sub-target using this as the parent target.

Returns:
the new service target

batchTarget

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

Returns:
the new batch service target

JBoss Modular Service Kernel API 1.0.0.CR2

Copyright © 2011 JBoss, a division of Red Hat, Inc.