Package org.wildfly.service

Class Installer.AbstractBuilder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB,DSB extends ServiceBuilder<?>>

java.lang.Object

org.wildfly.service.Installer.AbstractBuilder<B,I,ST,SB,DSB>

All Implemented Interfaces:

Installer.Builder<B,I,ST,DSB>, Installer.Configuration<SB,DSB>

Direct Known Subclasses:

Installer.AbstractNullaryBuilder, Installer.AbstractUnaryBuilder

Enclosing interface:

Installer<ST extends ServiceTarget>

public abstract static class Installer.AbstractBuilder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB,DSB extends ServiceBuilder<?>>
extends Object
implements Installer.Builder<B,I,ST,DSB>, Installer.Configuration<SB,DSB>

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	asActive()	Configures the installed service to start immediately after installation, forcing any dependencies to start.
B	asPassive()	Configures the installed service to automatically start when all of its dependencies are available and to automatically stop when any of its dependencies are no longer available.
protected abstract B	builder()
Consumer<DSB>	getDependency()	Returns the dependency of this service
ServiceController.Mode	getInitialMode()	Returns the initial mode of the installed service.
Map<LifecycleEvent,Collection<Runnable>>	getLifecycleTasks()	Returns tasks to be run per lifecycle event.
B	onRemove(Runnable task)	Configures the specified task to be run upon removal of the installed service.
B	onStart(Runnable task)	Configures the specified task to be run after the installed service is started.
B	onStop(Runnable task)	Configures the specified task to be run after the installed service is stopped.
B	requires(Consumer<DSB> dependency)	Configures a dependency of the installed service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.service.Installer.Builder

build, requires

Methods inherited from interface org.wildfly.service.Installer.Configuration

getServiceFactory

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

builder

protected abstract B builder()

asPassive

public B asPassive()

Description copied from interface: Installer.Builder

Configures the installed service to automatically start when all of its dependencies are available and to automatically stop when any of its dependencies are no longer available.

Specified by:

asPassive in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Returns:

a reference to this builder

asActive

public B asActive()

Description copied from interface: Installer.Builder

Configures the installed service to start immediately after installation, forcing any dependencies to start.

Specified by:

asActive in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Returns:

a reference to this builder

requires

public B requires(Consumer<DSB> dependency)

Description copied from interface: Installer.Builder

Configures a dependency of the installed service.

Specified by:

requires in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Parameters:

dependency - a dependency

Returns:

a reference to this builder

onStart

public B onStart(Runnable task)

Description copied from interface: Installer.Builder

Configures the specified task to be run after the installed service is started.

Specified by:

onStart in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Parameters:

task - a task to execute upon service start

Returns:

a reference to this builder

onStop

public B onStop(Runnable task)

Description copied from interface: Installer.Builder

Configures the specified task to be run after the installed service is stopped.

Specified by:

onStop in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Parameters:

task - a task to execute upon service stop

Returns:

a reference to this builder

onRemove

public B onRemove(Runnable task)

Description copied from interface: Installer.Builder

Configures the specified task to be run upon removal of the installed service.

Specified by:

onRemove in interface Installer.Builder<B,I extends Installer<ST>,ST extends ServiceTarget,SB extends DSB>

Parameters:

task - a task to execute upon service removal

Returns:

a reference to this builder

getInitialMode

public ServiceController.Mode getInitialMode()

Description copied from interface: Installer.Configuration

Returns the initial mode of the installed service.

Specified by:

getInitialMode in interface Installer.Configuration<B,I extends Installer<ST>>

Returns:

a service mode

getDependency

public Consumer<DSB> getDependency()

Description copied from interface: Installer.Configuration

Returns the dependency of this service

Specified by:

getDependency in interface Installer.Configuration<B,I extends Installer<ST>>

Returns:

a service dependency

getLifecycleTasks

public Map<LifecycleEvent,Collection<Runnable>> getLifecycleTasks()

Description copied from interface: Installer.Configuration

Returns tasks to be run per lifecycle event. The returned map is either fully populated, or an empty map, if this service has no lifecycle tasks.

Specified by:

getLifecycleTasks in interface Installer.Configuration<B,I extends Installer<ST>>

Returns:

a potentially empty map of tasks to be run per lifecycle event.