org.mule.runtime.core.api.lifecycle

Interface LifecycleManager

All Known Implementing Classes:

AbstractLifecycleManager, ComponentLifecycleManager, DefaultLifecycleManager, FlowConstructLifecycleManager, MuleContextLifecycleManager, RegistryBrokerLifecycleManager, RegistryLifecycleManager, SimpleLifecycleManager

public interface LifecycleManager

The LifecycleManager is responsible for managing the different lifecycle phases of the server and managing the transitions between lifecycle phases.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
void	applyCompletedPhases(Object object) Successively applies all completed lifecycle phase to an object.
void	applyPhase(Object object, String startPhase, String toPhase) Applies lifecycle phase to an object independent of the current lifecycle phase.
void	checkPhase(String name) Will check that the phase passed in is a valid next phase for this lifecycle manager.
void	fireLifecycle(String phase) Applies lifecycle phase to a collection of objects.
String	getCurrentPhase() The current phase for the lifecycle manager.
String	getExecutingPhase() Returns the lifecycle phase being executed.
LifecycleState	getState() Provides access to a state machine for this lifecycle manager.
boolean	isDirectTransition(String phase)
boolean	isPhaseComplete(String phaseName) Checks that a phase has completed
void	reset() Reset the lifecycle manager state back to 'not in lifecycle' phase

Method Detail

fireLifecycle

void fireLifecycle(String phase)
            throws org.mule.runtime.api.lifecycle.LifecycleException

Applies lifecycle phase to a collection of objects.

Parameters:

phase - that phase to execute next

Throws:

org.mule.runtime.api.lifecycle.LifecycleException - if the phase is not a valid transition of does not exist on this lifecycle manager

getCurrentPhase

String getCurrentPhase()

The current phase for the lifecycle manager. While in transition this will reflect the last completed phase not the currently executing phase, use getExecutingPhase() to get the phase being executed.

Returns:

The current completed phase for the lifecycle manager

getExecutingPhase

String getExecutingPhase()

Returns the lifecycle phase being executed. This will be null if the lifecycle is not in transition

Returns:

the lifecycle phase being executed

applyPhase

void applyPhase(Object object,
                String startPhase,
                String toPhase)
         throws org.mule.runtime.api.lifecycle.LifecycleException

Applies lifecycle phase to an object independent of the current lifecycle phase. All phases between the startPhase (not inclusive) and the endPhase will be executed.

Parameters:

object - the object to apply lifecycle to

startPhase - the lifecycle phase the object is currently in. Must not be null.

toPhase - the lifecycle phase to transition the object to. Must not be null.

Throws:

org.mule.runtime.api.lifecycle.LifecycleException - if there is an exception while invoking lifecycle on the object

applyCompletedPhases

void applyCompletedPhases(Object object)
                   throws org.mule.runtime.api.lifecycle.LifecycleException

Successively applies all completed lifecycle phase to an object.

Parameters:

object - the object to which the lifecycle should be applied

Throws:

org.mule.runtime.api.lifecycle.LifecycleException - if there is an error while applying lifecycle to the object

reset

void reset()

Reset the lifecycle manager state back to 'not in lifecycle' phase

isPhaseComplete

boolean isPhaseComplete(String phaseName)

Checks that a phase has completed

Parameters:

phaseName - the name of the pahse to check for

Returns:

true if that phase has completed, false if the phase has not completed, or currently processing or does not exist

checkPhase

void checkPhase(String name)
         throws IllegalStateException

Will check that the phase passed in is a valid next phase for this lifecycle manager. If the phase is not a valid next transition an exception will be thrown

Parameters:

name - The name of the lifecycle to validate as a valid next transition

Throws:

IllegalStateException - if the lifecycle name is not recognised or the phase is not valid for the current lifecycle state

getState

LifecycleState getState()

Provides access to a state machine for this lifecycle manager. components in the registry can use this to assert lifecycle rather than managing thier own lifecycle state

Returns:

A state machine for this lifecycle manager

Since:

3.0

isDirectTransition

boolean isDirectTransition(String phase)