org.mule.runtime.core.api.lifecycle

Interface LifecycleInterceptor

All Known Implementing Classes:

NullLifecycleInterceptor, PhaseErrorLifecycleInterceptor

public interface LifecycleInterceptor

Allows intercepting the application of lifecycle phases over each target object.

Since:

3.8

Method Summary

Modifier and Type	Method and Description
void	afterPhaseExecution(LifecyclePhase phase, Object object, Optional<Exception> exceptionThrownOptional) Invoked after the given phase was applied over the object.
boolean	beforePhaseExecution(LifecyclePhase phase, Object object) Invoked before the given phase is applied over the object.
void	onPhaseCompleted(LifecyclePhase phase) Invoked when the given phase finished processing all the eligible target objects, including those for which beforePhaseExecution(LifecyclePhase, Object) return false

Method Detail

beforePhaseExecution

boolean beforePhaseExecution(LifecyclePhase phase,
                             Object object)

Invoked before the given phase is applied over the object.

This method's return value also indicates if the lifecycle should in fact be applied over the object or if it should be skipped. Note that this interceptor is not responsible from actually preventing the phase from being applied. It's the invoker's responsibility to skip the object if the interceptor indicates so.

Parameters:

phase - the phase being applied

object - the target object

Returns:

whether the phase should be applied or cancelled for the given object

afterPhaseExecution

void afterPhaseExecution(LifecyclePhase phase,
                         Object object,
                         Optional<Exception> exceptionThrownOptional)

Invoked after the given phase was applied over the object.

Parameters:

phase - the phase that was applied

object - the target object

exceptionThrownOptional - an optional with an exception. If present then there was an error execution the phase, otherwise the phase execution was successful

onPhaseCompleted

void onPhaseCompleted(LifecyclePhase phase)

Invoked when the given phase finished processing all the eligible target objects, including those for which beforePhaseExecution(LifecyclePhase, Object) return false

Parameters:

phase - the phase that was applied