Package org.springframework.batch.core
Interface StepExecutionListener
- All Superinterfaces:
StepListener
- All Known Implementing Classes:
ChunkMessageChannelItemWriter
,CompositeStepExecutionListener
,ExecutionContextPromotionListener
,JobParameterExecutionContextCopyListener
,MulticasterBatchListener
,NoWorkFoundStepExecutionListener
,StepExecutionListenerSupport
,StepExecutionSimpleCompletionPolicy
,StepListenerSupport
,SystemCommandTasklet
Listener interface for the lifecycle of a
Step
.- Author:
- Lucas Ward, Dave Syer, Mahmoud Ben Hassine, Parikshit Dutta
-
Method Summary
Modifier and TypeMethodDescriptiondefault ExitStatus
afterStep
(StepExecution stepExecution) Give a listener a chance to modify the exit status from a step.default void
beforeStep
(StepExecution stepExecution) Initialize the state of the listener with theStepExecution
from the current scope.
-
Method Details
-
beforeStep
Initialize the state of the listener with theStepExecution
from the current scope.- Parameters:
stepExecution
- instance ofStepExecution
.
-
afterStep
Give a listener a chance to modify the exit status from a step. The value returned will be combined with the normal exit status usingExitStatus.and(ExitStatus)
. Called after execution of step's processing logic (both successful or failed). Throwing exception in this method has no effect, it will only be logged.- Parameters:
stepExecution
-StepExecution
instance.- Returns:
- an
ExitStatus
to combine with the normal value. Returnnull
to leave the old value unchanged.
-