org.jboss.msc.service

Interface ServiceBuilder<T>

Type Parameters:

T - service value type if service provides single value

All Known Implementing Classes:

DelegatingServiceBuilder

public interface ServiceBuilder<T>

Builder to configure service before installing it into the container.

Service may require multiple dependencies (named values) to be satisfied before starting. Every dependency requirement must be specified via requires(ServiceName) method.

Single service can provide multiple values which can be requested by dependent services. Every named value service provides must be specified via provides(ServiceName...) method.

Once all required and provided dependencies are defined, references to all Values and Injectors should be passed to service instance so they can be accessed by service at runtime.

Implementations of this interface are not thread safe.

Author:

David M. Lloyd, Richard Opalka

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServiceBuilder.DependencyType Deprecated. Optional dependencies are unsafe and should not be used. This enum will be removed in future releases.

Method Summary

Modifier and Type	Method and Description
ServiceBuilder<T>	addAliases(ServiceName... aliases) Adds aliases for this service.
ServiceBuilder<T>	addDependencies(java.lang.Iterable<ServiceName> dependencies) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
ServiceBuilder<T>	addDependencies(ServiceBuilder.DependencyType dependencyType, java.lang.Iterable<ServiceName> dependencies) Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.
ServiceBuilder<T>	addDependencies(ServiceBuilder.DependencyType dependencyType, ServiceName... dependencies) Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.
ServiceBuilder<T>	addDependencies(ServiceName... dependencies) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency) Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.
<I> ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency, java.lang.Class<I> type, Injector<I> target) Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.
ServiceBuilder<T>	addDependency(ServiceBuilder.DependencyType dependencyType, ServiceName dependency, Injector<java.lang.Object> target) Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.
ServiceBuilder<T>	addDependency(ServiceName dependency) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
<I> ServiceBuilder<T>	addDependency(ServiceName dependency, java.lang.Class<I> type, Injector<I> target) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
ServiceBuilder<T>	addDependency(ServiceName dependency, Injector<java.lang.Object> target) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
<I> ServiceBuilder<T>	addInjection(Injector<? super I> target, I value) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
ServiceBuilder<T>	addInjection(Injector<? super T> target) Deprecated. use provides(ServiceName...) instead This method will be removed in future releases.
<I> ServiceBuilder<T>	addInjectionValue(Injector<? super I> target, Value<I> value) Deprecated. use requires(ServiceName) instead This method will be removed in future releases.
ServiceBuilder<T>	addListener(java.util.Collection<? extends ServiceListener<? super T>> listeners) Deprecated. use addListener(LifecycleListener) instead. This method will be removed in future releases.
ServiceBuilder<T>	addListener(LifecycleListener listener) Adds a service listener to be added to the service.
ServiceBuilder<T>	addListener(ServiceListener<? super T>... listeners) Deprecated. use addListener(LifecycleListener) instead This method will be removed in future releases.
ServiceBuilder<T>	addListener(ServiceListener<? super T> listener) Deprecated. use addListener(LifecycleListener) instead This method will be removed in future releases.
ServiceBuilder<T>	addMonitor(StabilityMonitor monitor) Adds a stability monitor to be added to the service.
ServiceBuilder<T>	addMonitors(StabilityMonitor... monitors) Deprecated. use addMonitor(StabilityMonitor) instead This method will be removed in future releases.
ServiceController<T>	install() Installs configured service into the container.
<V> java.util.function.Consumer<V>	provides(ServiceName... names) Specifies injector provided by service.
<V> java.util.function.Supplier<V>	requires(ServiceName name) Specifies dependency value required by service.
ServiceBuilder<T>	setInitialMode(ServiceController.Mode mode) Sets initial service mode.
ServiceBuilder<T>	setInstance(Service service) Sets service instance.

Method Detail

addAliases

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

Adds aliases for this service.

Parameters:

aliases - the service names to use as aliases

Returns:

the builder

Throws:

java.lang.UnsupportedOperationException - if this service builder wasn't created via ServiceTarget.addService(ServiceName) method.

requires

<V> java.util.function.Supplier<V> requires(ServiceName name)

Specifies dependency value required by service. There can be multiple dependencies service may depend on.

Type Parameters:

V - required dependency value type

Parameters:

name - required dependency name

Returns:

readonly dependency reference

Throws:

java.lang.IllegalStateException - if this method have been called after setInstance(org.jboss.msc.Service) method.

java.lang.UnsupportedOperationException - if this service builder wasn't created via ServiceTarget.addService(ServiceName) method.

provides

<V> java.util.function.Consumer<V> provides(ServiceName... names)

Specifies injector provided by service. There can be multiple injectors service may provide.

Type Parameters:

V - provided dependency value type

Parameters:

names - provided dependency names

Returns:

writable dependency reference

Throws:

java.lang.IllegalStateException - if this method have been called after setInstance(org.jboss.msc.Service) method.

java.lang.UnsupportedOperationException - if this service builder wasn't created via ServiceTarget.addService(ServiceName) method.

setInitialMode

ServiceBuilder<T> setInitialMode(ServiceController.Mode mode)

Sets initial service mode.

Parameters:

mode - initial service mode

Returns:

this builder

setInstance

ServiceBuilder<T> setInstance(Service service)

Sets service instance. If install() method call is issued without this method being called then NULL service will be installed into the container.

When this method have been called then all subsequent calls of requires(ServiceName), and provides(ServiceName...) methods will fail.

Parameters:

service - the service instance

Returns:

this configurator

addMonitor

ServiceBuilder<T> addMonitor(StabilityMonitor monitor)

Adds a stability monitor to be added to the service.

Parameters:

monitor - the monitor to add to the service

Returns:

this builder

addListener

ServiceBuilder<T> addListener(LifecycleListener listener)

Adds a service listener to be added to the service.

Parameters:

listener - the listener to add to the service

Returns:

this builder

install

ServiceController<T> install()

Installs configured service into the container.

Returns:

installed service controller

Throws:

ServiceRegistryException - if installation fails for any reason

addDependencies

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

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

Add multiple, non-injected dependencies.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependencies

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

Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.

Add multiple, non-injected dependencies.

Parameters:

dependencyType - the dependency type; must not be null

dependencies - the service names to depend on

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependencies

@Deprecated
ServiceBuilder<T> addDependencies(java.lang.Iterable<ServiceName> dependencies)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

Add multiple, non-injected dependencies.

Parameters:

dependencies - the service names to depend on

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependencies

@Deprecated
ServiceBuilder<T> addDependencies(ServiceBuilder.DependencyType dependencyType,
                                              java.lang.Iterable<ServiceName> dependencies)

Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.

Add multiple, non-injected dependencies.

Parameters:

dependencyType - the dependency type; must not be null

dependencies - the service names to depend on

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

@Deprecated
ServiceBuilder<T> addDependency(ServiceName dependency)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

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

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

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

Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.

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

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

@Deprecated
ServiceBuilder<T> addDependency(ServiceName dependency,
                                            Injector<java.lang.Object> target)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

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

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

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

Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.

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

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

@Deprecated
<I> ServiceBuilder<T> addDependency(ServiceName dependency,
                                                java.lang.Class<I> type,
                                                Injector<I> target)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

Add a service dependency. The type of the dependency is checked before it is passed into the (type-safe) injector instance. 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.

Type Parameters:

I - the type of the value of the dependency

Parameters:

dependency - the name of the dependency

type - the class of the value of the dependency

target - the injector into which the dependency should be stored

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addDependency

@Deprecated
<I> ServiceBuilder<T> addDependency(ServiceBuilder.DependencyType dependencyType,
                                                ServiceName dependency,
                                                java.lang.Class<I> type,
                                                Injector<I> target)

Deprecated. Optional dependencies are unsafe and should not be used. This method will be removed in future releases.

Add a service dependency. The type of the dependency is checked before it is passed into the (type-safe) injector instance. 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.

Type Parameters:

I - the type of the value of the dependency

Parameters:

dependencyType - the dependency type; must not be null

dependency - the name of the dependency

type - the class of the value of the dependency

target - the injector into which the dependency should be stored

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addInjection

@Deprecated
<I> ServiceBuilder<T> addInjection(Injector<? super I> target,
                                               I value)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

Add an injection. The given value will be injected into the given injector before service start, and uninjected after service stop.

Type Parameters:

I - the injection type

Parameters:

target - the injection target

value - the injection value

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addInjectionValue

@Deprecated
<I> ServiceBuilder<T> addInjectionValue(Injector<? super I> target,
                                                    Value<I> value)

Deprecated. use requires(ServiceName) instead This method will be removed in future releases.

Add an injection value. The given value will be injected into the given injector before service start, and uninjected after service stop.

Type Parameters:

I - the injection type

Parameters:

target - the injection target

value - the injection value

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addInjection

@Deprecated
ServiceBuilder<T> addInjection(Injector<? super T> target)

Deprecated. use provides(ServiceName...) instead This method will be removed in future releases.

Add an injection of this service into another target. The given injector will be given this service after start, and uninjected when this service stops.

Differently from other injection types, failures to perform an outward injection will not result in a failure to start the service.

Parameters:

target - the injector target

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addMonitors

@Deprecated
ServiceBuilder<T> addMonitors(StabilityMonitor... monitors)

Deprecated. use addMonitor(StabilityMonitor) instead This method will be removed in future releases.

Add service stability monitors that will be added to this service.

Parameters:

monitors - a list of stability monitors to add to the service

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addListener

@Deprecated
ServiceBuilder<T> addListener(ServiceListener<? super T> listener)

Deprecated. use addListener(LifecycleListener) instead This method will be removed in future releases.

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

Parameters:

listener - the listener to add to the service

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addListener

@Deprecated
ServiceBuilder<T> addListener(ServiceListener<? super T>... listeners)

Deprecated. use addListener(LifecycleListener) instead This method will be removed in future releases.

Add service listeners that will be added to this service.

Parameters:

listeners - a list of listeners to add to the service

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.

addListener

@Deprecated
ServiceBuilder<T> addListener(java.util.Collection<? extends ServiceListener<? super T>> listeners)

Deprecated. use addListener(LifecycleListener) instead. This method will be removed in future releases.

Add service listeners that will be added to this service.

Parameters:

listeners - a collection of listeners to add to the service

Returns:

this builder

Throws:

java.lang.UnsupportedOperationException - if this service builder was created via ServiceTarget.addService(ServiceName) method.