com.fredhopper.lifecycle

Interface LifeCycle

All Superinterfaces:

Resumable, Stateful, Supplier<State>

All Known Implementing Classes:

AbstractLifeCycle, Container

public interface LifeCycle
extends Resumable, Stateful

A LifeCycle is an abstraction that

• owns a State,
• potentially owns a collection of StateListener to publish changes of state to,
• changes its state through life cycle methods initLifeCycle(), startLifeCycle(), and stopLifeCycle().

In addition, a LifeCycle is Resumable in order to support Resumable.pause() and Resumable.resume() behavior.

Author:

bnobakht

See Also:

State, Resumable

Method Summary

Modifier and Type	Method and Description
void	initLifeCycle() Initializes the life cycle before invoking startLifeCycle().
void	startLifeCycle() Starts the life cycle.
void	stopLifeCycle() Stops the life cycle.

Methods inherited from interface com.fredhopper.lifecycle.Resumable

pause, resume

Methods inherited from interface com.fredhopper.lifecycle.Stateful

get, getState, getStateListeners

Method Detail

initLifeCycle

void initLifeCycle()
            throws Exception

Initializes the life cycle before invoking startLifeCycle(). It is expected that Stateful.getState() should be State.INITIALIZED after completion of this method.

Throws:

Exception - expected to be thrown if the initialization cannot be complete.

startLifeCycle

void startLifeCycle()
             throws Exception

Starts the life cycle. It is expected that Stateful.getState() should be State.STARTING while the method is not finished and State.RUNNING on successful completion.

Throws:

Exception - should be thrown if the starting of the life cycle object cannot complete.

stopLifeCycle

void stopLifeCycle()
            throws Exception

Stops the life cycle. It is expected that Stateful.getState() should be State.STOPPING while the method is not finished and State.STOPPED on successful completion.

Throws:

Exception - should be thrown if the stopping fails. It is recommended to perform clean-up guidelines. In addition, it is recommended to still fail in a state such that killing JVM process does not have a corruptive effect on the state.