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

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

Change contract of StepListener - JobParameters are more useful at that stage than ExecutionContext.

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

@@ -37,7 +37,7 @@ import org.springframework.util.Assert;
 public class StepExecution extends Entity {
 
 	private JobExecution jobExecution;
-	
+
 	private Step step;
 
 	private BatchStatus status = BatchStatus.STARTING;
@@ -47,9 +47,9 @@ public class StepExecution extends Entity {
 	private int commitCount = 0;
 
 	private int rollbackCount = 0;
-	
+
 	private int skipCount = 0;
-	
+
 	private int retryCount = 0;
 
 	private Date startTime = new Date(System.currentTimeMillis());
@@ -258,7 +258,7 @@ public class StepExecution extends Entity {
 	 * @see org.springframework.batch.container.common.domain.Entity#equals(java.lang.Object)
 	 */
 	public boolean equals(Object obj) {
-		//TODO make sure the equality makes sense
+		// TODO make sure the equality makes sense
 		Object jobExecutionId = getJobExecutionId();
 		if (step == null && jobExecutionId == null || !(obj instanceof StepExecution) || getId() == null) {
 			return super.equals(obj);
@@ -268,7 +268,7 @@ public class StepExecution extends Entity {
 			return jobExecutionId.equals(other.getJobExecutionId());
 		}
 		return step.getName().equals(other.getStepName())
-		        && (jobExecutionId == null || jobExecutionId.equals(other.getJobExecutionId()));
+				&& (jobExecutionId == null || jobExecutionId.equals(other.getJobExecutionId()));
 	}
 
 	/*
@@ -279,12 +279,12 @@ public class StepExecution extends Entity {
 	public int hashCode() {
 		Object jobExecutionId = getJobExecutionId();
 		return super.hashCode() + 31 * (step.getName() != null ? step.getName().hashCode() : 0) + 91
-		        * (jobExecutionId != null ? jobExecutionId.hashCode() : 0);
+				* (jobExecutionId != null ? jobExecutionId.hashCode() : 0);
 	}
 
 	public String toString() {
-		return super.toString() + ", name=" + step.getName() + ", taskCount=" + taskCount + ", commitCount=" + commitCount
-		        + ", rollbackCount=" + rollbackCount;
+		return super.toString() + ", name=" + step.getName() + ", taskCount=" + taskCount + ", commitCount="
+				+ commitCount + ", rollbackCount=" + rollbackCount;
 	}
 
 	/**
@@ -305,7 +305,7 @@ public class StepExecution extends Entity {
 	 * Accessor for the execution context information of the enclosing job.
 	 * 
 	 * @return the {@link JobExecution} that was used to start this step
-	 *         execution.
+	 * execution.
 	 */
 	public JobExecution getJobExecution() {
 		return jobExecution;
@@ -357,25 +357,38 @@ public class StepExecution extends Entity {
 	public void setTerminateOnly() {
 		this.terminateOnly = true;
 	}
-	
+
 	public void setSkipCount(int skipCount) {
 		this.skipCount = skipCount;
 	}
-	
+
 	public int getSkipCount() {
 		return skipCount;
 	}
-	
-	public void incrementSkipCount(){
+
+	public void incrementSkipCount() {
 		skipCount++;
 	}
-	
+
 	public void setRetryCount(int retryCount) {
 		this.retryCount = retryCount;
 	}
-	
+
 	public int getRetryCount() {
 		return retryCount;
 	}
 
+	/**
+	 * Convenience method to get the current job parameters.
+	 * 
+	 * @return the {@link JobParameters} from the enclosing job, or empty if
+	 * that is null
+	 */
+	public JobParameters getJobParameters() {
+		if (jobExecution == null || jobExecution.getJobInstance() == null) {
+			return new JobParameters();
+		}
+		return jobExecution.getJobInstance().getJobParameters();
+	}
+
 }

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

@@ -15,17 +15,28 @@
  */
 package org.springframework.batch.core.domain;
 
-import org.springframework.batch.item.ExecutionContext;
 import org.springframework.batch.repeat.ExitStatus;
 
 /**
  * @author Lucas Ward
  * @author Dave Syer
- *
+ * 
  */
 public interface StepListener {
 
-	void open(ExecutionContext executionContext);
-	
+	/**
+	 * Initialise the state of the listener with the job parameters from the
+	 * current scope.
+	 * @param jobParameters
+	 */
+	void open(JobParameters jobParameters);
+
+	/**
+	 * Give a listener a chance to modify the exit status from a step. The value
+	 * returned will be combined with the normal exit status.
+	 * 
+	 * @return an {@link ExitStatus} to combine with the normal value. Return
+	 * null to leave the old value unchanged.
+	 */
 	ExitStatus close();
 }

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

@@ -20,8 +20,8 @@ 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.StepListener;
-import org.springframework.batch.item.ExecutionContext;
 import org.springframework.batch.repeat.ExitStatus;
 
 /**
@@ -63,27 +63,26 @@ public class CompositeStepListener implements StepListener {
 		}
 	}
 
-	/*
-	 * (non-Javadoc)
+	/* (non-Javadoc)
 	 * @see org.springframework.batch.core.domain.StepListener#close()
 	 */
 	public ExitStatus close() {
-		ExitStatus status = ExitStatus.CONTINUABLE;
+		ExitStatus status = null;
 		for (Iterator iterator = listeners.iterator(); iterator.hasNext();) {
 			StepListener listener = (StepListener) iterator.next();
-			status = status.and(listener.close());
+			ExitStatus close = listener.close();
+			status = status!=null ? status.and(close): close;
 		}
 		return status;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.batch.core.domain.StepListener#open(org.springframework.batch.item.ExecutionContext)
+	/* (non-Javadoc)
+	 * @see org.springframework.batch.core.domain.StepListener#open(org.springframework.batch.core.domain.JobParameters)
 	 */
-	public void open(ExecutionContext executionContext) {
+	public void open(JobParameters jobParameters) {
 		for (Iterator iterator = listeners.iterator(); iterator.hasNext();) {
 			StepListener listener = (StepListener) iterator.next();
-			listener.open(executionContext);
+			listener.open(jobParameters);
 		}
 	}
 

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

@@ -15,8 +15,8 @@
  */
 package org.springframework.batch.core.interceptor;
 
+import org.springframework.batch.core.domain.JobParameters;
 import org.springframework.batch.core.domain.StepListener;
-import org.springframework.batch.item.ExecutionContext;
 import org.springframework.batch.repeat.ExitStatus;
 
 /**
@@ -35,7 +35,7 @@ public class StepListenerSupport implements StepListener {
 	/* (non-Javadoc)
 	 * @see org.springframework.batch.core.domain.StepListener#open(org.springframework.batch.item.ExecutionContext)
 	 */
-	public void open(ExecutionContext executionContext) {
+	public void open(JobParameters jobParameters) {
 	}
 
 }