org.springframework.batch.core.listener
Class CompositeStepExecutionListener

java.lang.Object
  org.springframework.batch.core.listener.CompositeStepExecutionListener

All Implemented Interfaces:

StepExecutionListener, StepListener

public class CompositeStepExecutionListener
extends Object
implements StepExecutionListener

Author:

Lucas Ward, Dave Syer

Constructor Summary

CompositeStepExecutionListener()

Method Summary

ExitStatus	afterStep(StepExecution stepExecution) Call the registered listeners in reverse order, respecting and prioritising those that implement Ordered.
void	beforeStep(StepExecution stepExecution) Call the registered listeners in order, respecting and prioritising those that implement Ordered.
ExitStatus	onErrorInStep(StepExecution stepExecution, Throwable e) Call the registered listeners in reverse order, respecting and prioritising those that implement Ordered.
void	register(StepExecutionListener stepExecutionListener) Register additional listener.
void	setListeners(StepExecutionListener[] listeners) Public setter for the listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeStepExecutionListener

public CompositeStepExecutionListener()

Method Detail

setListeners

public void setListeners(StepExecutionListener[] listeners)

Public setter for the listeners.

Parameters:

listeners -

register

public void register(StepExecutionListener stepExecutionListener)

Register additional listener.

Parameters:

stepExecutionListener -

afterStep

public ExitStatus afterStep(StepExecution stepExecution)

Call the registered listeners in reverse order, respecting and prioritising those that implement Ordered.

Specified by:

afterStep in interface StepExecutionListener

Returns:

an ExitStatus to combine with the normal value. Return null to leave the old value unchanged.

See Also:

StepExecutionListener.afterStep(StepExecution)

beforeStep

public void beforeStep(StepExecution stepExecution)

Call the registered listeners in order, respecting and prioritising those that implement Ordered.

Specified by:

beforeStep in interface StepExecutionListener

See Also:

StepExecutionListener.beforeStep(StepExecution)

onErrorInStep

public ExitStatus onErrorInStep(StepExecution stepExecution,
                                Throwable e)

Call the registered listeners in reverse order, respecting and prioritising those that implement Ordered.

Specified by:

onErrorInStep in interface StepExecutionListener

e - an exception thrown by the step execution

Returns:

an exit status to be combined with the normal one, or null

See Also:

StepExecutionListener.onErrorInStep(StepExecution, java.lang.Throwable)