org.mule.runtime.core.lifecycle

Class PhaseErrorLifecycleInterceptor

java.lang.Object

org.mule.runtime.core.lifecycle.PhaseErrorLifecycleInterceptor

All Implemented Interfaces:

LifecycleInterceptor

public class PhaseErrorLifecycleInterceptor
extends Object
implements LifecycleInterceptor

A LifecycleInterceptor which tracks the completion of the a phase so that if it fails to complete, the another phase is only applied on the target objects on which it could be successfully applied.

Since:

3.8

Constructor Summary

Constructors

Constructor and Description
PhaseErrorLifecycleInterceptor(String trackingPhase, String phaseToPreventOnTrackingPhaseError, Class lifecycleClass) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	afterPhaseExecution(LifecyclePhase phase, Object object, Optional<Exception> exceptionThrownOptional) If the phase name is trackingPhase then it tracks the given object as successful on the trackingPhase.
boolean	beforePhaseExecution(LifecyclePhase phase, Object object) Determines if the phase should be skipped if the phase name is phaseToPreventOnTrackingPhaseError and the object supports the phase phaseToPreventOnTrackingPhaseError and the phase trackingPhase phase was not successfully completed
void	onPhaseCompleted(LifecyclePhase phase) If the phase name is trackingPhase then it marks the trackingPhase phase as completed and clears all other tracking state so that memory can be reclaimed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhaseErrorLifecycleInterceptor

public PhaseErrorLifecycleInterceptor(String trackingPhase,
                                      String phaseToPreventOnTrackingPhaseError,
                                      Class lifecycleClass)

Creates a new instance.

Parameters:

trackingPhase - the phase to track for execution failures.

phaseToPreventOnTrackingPhaseError - the phase to prevent if the trackingPhase finished with errors.

lifecycleClass - the trackingPhase interface.

Method Detail

beforePhaseExecution

public boolean beforePhaseExecution(LifecyclePhase phase,
                                    Object object)

Determines if the phase should be skipped if the phase name is phaseToPreventOnTrackingPhaseError and the object supports the phase phaseToPreventOnTrackingPhaseError and the phase trackingPhase phase was not successfully completed

If all three of the above conditions are met, then this method returns false. Otherwise, it returns true

Specified by:

beforePhaseExecution in interface LifecycleInterceptor

Parameters:

phase - the phase being applied

object - the target object

Returns:

whether the phase should be applied on the object

afterPhaseExecution

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

If the phase name is trackingPhase then it tracks the given object as successful on the trackingPhase.

Specified by:

afterPhaseExecution in interface LifecycleInterceptor

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

public void onPhaseCompleted(LifecyclePhase phase)

If the phase name is trackingPhase then it marks the trackingPhase phase as completed and clears all other tracking state so that memory can be reclaimed.

Specified by:

onPhaseCompleted in interface LifecycleInterceptor

Parameters:

phase - the phase that was applied