org.swblocks.jbl.lifecycle

Interface ComponentLifecycle

All Known Implementing Classes:

ComponentLifecycleManager

public interface ComponentLifecycle

A common interface defining methods for start/stop lifecycle control for components to implement and can be integrated into the JBL lifecycle process. The startup process begins with the lowest phase value and ends with the highest phase value (Integer.MIN_VALUE is the lowest possible, and Integer.MAX_VALUE is the highest possible). The shutdown process will apply the reverse order. Any components with the same value will be arbitrarily ordered within the same phase.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PHASE

Method Summary

Modifier and Type	Method and Description
default int	getPhase() Return the phase value of this object.
boolean	isRunning() Check whether this component is currently running.
default void	start() Start this component.
default void	stop() Stops this component in a synchronous call, such that the component is fully stopped upon return of this method.

Field Detail

DEFAULT_PHASE

static final int DEFAULT_PHASE

See Also:

Constant Field Values

Method Detail

isRunning

boolean isRunning()

Check whether this component is currently running.

Returns:

true if component thinks it is running, false otherwise.

start

default void start()

Start this component. Does nothing if component is already running.

stop

default void stop()

Stops this component in a synchronous call, such that the component is fully stopped upon return of this method.

getPhase

default int getPhase()

Return the phase value of this object.

The lower the value, the earlier in the startup sequence the process will start.

Returns:

The phase value of this object