org.jboss.msc.service
Interface ServiceBuilder<T>

Type Parameters:

T - the service type

All Known Implementing Classes:

DelegatingServiceBuilder

public interface ServiceBuilder<T>

A builder for an individual service in a ServiceTarget. Create an instance via the ServiceTarget.addService(ServiceName, Service), ServiceTarget.addServiceValue(ServiceName, Value) or methods.

Author:

David M. Lloyd

Nested Class Summary

static class

ServiceBuilder.DependencyType The dependency type.

Method Summary

ServiceBuilder<T>	addAliases(ServiceName... aliases) Add aliases for this service.
ServiceBuilder<T>	addDependencies(Iterable<ServiceName> dependencies) Add multiple, non-injected dependencies.
ServiceBuilder<T>	addDependencies(ServiceBuilder.DependencyType dependencyType, Iterable<ServiceName> dependencies) Add multiple, non-injected dependencies.
ServiceBuilder<T>	addDependencies(ServiceBuilder.DependencyType dependencyType, ServiceName... dependencies) Add multiple, non-injected dependencies.
ServiceBuilder<T>	addDependencies(ServiceName... dependencies) Add multiple, non-injected dependencies.
ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency) Add a dependency.
<I> ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency, Class<I> type, Injector<I> target) Add a service dependency.
ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency, Injector<Object> target) Add a service dependency.
ServiceBuilder<T>	addDependency(ServiceName dependency) Add a dependency.
<I> ServiceBuilder<T>	addDependency(ServiceName dependency, Class<I> type, Injector<I> target) Add a service dependency.
ServiceBuilder<T>	addDependency(ServiceName dependency, Injector<Object> target) Add a service dependency.
<I> ServiceBuilder<T>	addInjection(Injector<? super I> target, I value) Add an injection.
ServiceBuilder<T>	addInjection(Injector<? super T> target) Add an injection of this service into another target.
<I> ServiceBuilder<T>	addInjectionValue(Injector<? super I> target, Value<I> value) Add an injection value.
ServiceBuilder<T>	addListener(Collection<? extends ServiceListener<? super T>> listeners) Add service listeners that will be added to this service.
ServiceBuilder<T>	addListener(ServiceListener<? super T>... listeners) Add service listeners that will be added to this service.
ServiceBuilder<T>	addListener(ServiceListener<? super T> listener) Add a service listener that will be added to this service.
ServiceBuilder<T>	addOptionalDependencies(Iterable<ServiceName> dependencies) Deprecated. use #addDependencies(DependencyType, Iterable) instead
ServiceBuilder<T>	addOptionalDependencies(ServiceName... dependencies) Deprecated. use addDependencies(DependencyType, ServiceName...) instead
ServiceBuilder<T>	addOptionalDependency(ServiceName dependency) Deprecated. use addDependency(DependencyType, ServiceName) instead
<I> ServiceBuilder<T>	addOptionalDependency(ServiceName dependency, Class<I> type, Injector<I> target) Deprecated. use addDependency(DependencyType, ServiceName, Class, Injector) instead
ServiceBuilder<T>	addOptionalDependency(ServiceName dependency, Injector<Object> target) Deprecated. use #addDependency(DependencyType, ServiceName, Injector
ServiceController<T>	install() Install the defined service into the container.
ServiceBuilder<T>	setInitialMode(ServiceController.Mode mode) Set the initial mode.
ServiceBuilder<T>	setLocation() Set the service definition location to be the caller's location.
ServiceBuilder<T>	setLocation(Location location) Set the service definition location, if any.

Method Detail

addAliases

ServiceBuilder<T> addAliases(ServiceName... aliases)

Add aliases for this service.

Parameters:

aliases - the service names to use as aliases

Returns:

the builder

setLocation

ServiceBuilder<T> setLocation()

Set the service definition location to be the caller's location.

Returns:

this builder

setLocation

ServiceBuilder<T> setLocation(Location location)

Set the service definition location, if any.

Parameters:

location - the location

Returns:

this builder

setInitialMode

ServiceBuilder<T> setInitialMode(ServiceController.Mode mode)

Set the initial mode.

Parameters:

mode - the initial mode

Returns:

this builder

addDependencies

ServiceBuilder<T> addDependencies(ServiceName... dependencies)

Add multiple, non-injected dependencies.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

addDependencies

ServiceBuilder<T> addDependencies(ServiceBuilder.DependencyType dependencyType,
                                  ServiceName... dependencies)

Add multiple, non-injected dependencies.

Parameters:

dependencyType - the dependency type; must not be null

dependencies - the service names to depend on

Returns:

this builder

addOptionalDependencies

ServiceBuilder<T> addOptionalDependencies(ServiceName... dependencies)

Deprecated. use addDependencies(DependencyType, ServiceName...) instead

Add multiple, optional, non-injected dependencies. If the dependencies do not exist, it will not stop the service from starting.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

addDependencies

ServiceBuilder<T> addDependencies(Iterable<ServiceName> dependencies)

Add multiple, non-injected dependencies.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

addDependencies

ServiceBuilder<T> addDependencies(ServiceBuilder.DependencyType dependencyType,
                                  Iterable<ServiceName> dependencies)

Add multiple, non-injected dependencies.

Parameters:

dependencyType - the dependency type; must not be null

dependencies - the service names to depend on

Returns:

this builder

addOptionalDependencies

ServiceBuilder<T> addOptionalDependencies(Iterable<ServiceName> dependencies)

Deprecated. use #addDependencies(DependencyType, Iterable) instead

Add multiple, optional, non-injected dependencies. If the dependencies do not exist, it will not stop the service from starting.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

addDependency

ServiceBuilder<T> addDependency(ServiceName dependency)

Add a dependency. Calling this method multiple times for the same service name will only add it as a dependency one time; however this may be useful to specify multiple injections for one dependency.

Parameters:

dependency - the name of the dependency

Returns:

an injection builder for optionally injecting the dependency

addDependency

ServiceBuilder<T> addDependency(ServiceBuilder.DependencyType dependencyType,
                                ServiceName dependency)

Add a dependency. Calling this method multiple times for the same service name will only add it as a dependency one time; however this may be useful to specify multiple injections for one dependency.

Parameters:

dependencyType - the dependency type; must not be null

dependency - the name of the dependency

Returns:

an injection builder for optionally injecting the dependency

addOptionalDependency

ServiceBuilder<T> addOptionalDependency(ServiceName dependency)

Deprecated. use addDependency(DependencyType, ServiceName) instead

Add an optional dependency. Calling this method multiple times for the same service name will only add it as a dependency one time; however this may be useful to specify multiple injections for one dependency. If the dependencies do not exist, it will not stop the service from starting.

Parameters:

dependency - the name of the dependency

Returns:

an injection builder for optionally injecting the dependency

addDependency

ServiceBuilder<T> addDependency(ServiceName dependency,
                                Injector<Object> target)

Add a service dependency. Calling this method multiple times for the same service name will only add it as a dependency one time; however this may be useful to specify multiple injections for one dependency.

Parameters:

dependency - the name of the dependency

target - the injector into which the dependency should be stored

Returns:

this builder

addDependency

ServiceBuilder<T> addDependency(ServiceBuilder.DependencyType dependencyType,
                                ServiceName dependency,
                                Injector<Object> target)

Add a service dependency. Calling this method multiple times for the same service name will only add it as a dependency one time; however this may be useful to specify multiple injections for one dependency.

Parameters:

dependencyType - the dependency type; must not be null

dependency - the name of the dependency

target - the injector into which the dependency should be stored

Returns:

this builder

addOptionalDependency

ServiceBuilder<T> addOptionalDependency(ServiceName dependency,
                                        Injector<Object> target)

Deprecated. use #addDependency(DependencyType, ServiceName, Injector