OPEN - issue BATCH-378: RepeatListener is confusing and too generic to use for 'intercepting' a step

http://jira.springframework.org/browse/BATCH-378

Open StepListsner with StepExecution.

spring-batch-core/src/main/java/org/springframework/batch/core/domain/StepListener.java

@@ -25,15 +25,25 @@ import org.springframework.batch.repeat.ExitStatus;
 public interface StepListener {
 
 	/**
-	 * Initialise the state of the listener with the job parameters from the
-	 * current scope.
-	 * @param jobParameters
+	 * Initialise the state of the listener with the {@link StepExecution} from
+	 * the current scope.
+	 * @param stepExecution
 	 */
-	void open(JobParameters jobParameters);
+	void open(StepExecution stepExecution);
+
+	/**
+	 * The value returned will be combined with the normal exit status using
+	 * {@link ExitStatus#and(ExitStatus)}.
+	 * 
+	 * @param e an exception thrown by the step execution
+	 * @return an exit status to be combined with the normal one, or null
+	 */
+	ExitStatus onError(Throwable e);
 
 	/**
 	 * Give a listener a chance to modify the exit status from a step. The value
-	 * returned will be combined with the normal exit status.
+	 * returned will be combined with the normal exit status using
+	 * {@link ExitStatus#and(ExitStatus)}.
 	 * 
 	 * @return an {@link ExitStatus} to combine with the normal value. Return
 	 * null to leave the old value unchanged.

spring-batch-core/src/main/java/org/springframework/batch/core/interceptor/CompositeStepListener.java

@@ -20,7 +20,7 @@ import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
 
-import org.springframework.batch.core.domain.JobParameters;
+import org.springframework.batch.core.domain.StepExecution;
 import org.springframework.batch.core.domain.StepListener;
 import org.springframework.batch.repeat.ExitStatus;
 
@@ -79,11 +79,23 @@ public class CompositeStepListener implements StepListener {
 	/* (non-Javadoc)
 	 * @see org.springframework.batch.core.domain.StepListener#open(org.springframework.batch.core.domain.JobParameters)
 	 */
-	public void open(JobParameters jobParameters) {
+	public void open(StepExecution stepExecution) {
 		for (Iterator iterator = listeners.iterator(); iterator.hasNext();) {
 			StepListener listener = (StepListener) iterator.next();
-			listener.open(jobParameters);
+			listener.open(stepExecution);
 		}
 	}
 
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.StepListener#onError(java.lang.Throwable)
+	 */
+	public ExitStatus onError(Throwable e) {
+		ExitStatus status = null;
+		for (Iterator iterator = listeners.iterator(); iterator.hasNext();) {
+			StepListener listener = (StepListener) iterator.next();
+			ExitStatus close = listener.onError(e);
+			status = status!=null ? status.and(close): close;
+		}
+		return status;
+	}
 }

spring-batch-core/src/main/java/org/springframework/batch/core/interceptor/StepListenerSupport.java

@@ -15,7 +15,7 @@
  */
 package org.springframework.batch.core.interceptor;
 
-import org.springframework.batch.core.domain.JobParameters;
+import org.springframework.batch.core.domain.StepExecution;
 import org.springframework.batch.core.domain.StepListener;
 import org.springframework.batch.repeat.ExitStatus;
 
@@ -29,13 +29,19 @@ public class StepListenerSupport implements StepListener {
 	 * @see org.springframework.batch.core.domain.StepListener#close()
 	 */
 	public ExitStatus close() {
-		return ExitStatus.CONTINUABLE;
+		return null;
 	}
 
 	/* (non-Javadoc)
 	 * @see org.springframework.batch.core.domain.StepListener#open(org.springframework.batch.item.ExecutionContext)
 	 */
-	public void open(JobParameters jobParameters) {
+	public void open(StepExecution stepExecution) {
 	}
 
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.StepListener#onError(java.lang.Throwable)
+	 */
+	public ExitStatus onError(Throwable e) {
+		return null;
+	}
 }