View Javadoc

1   /*
2    * Copyright 2006-2009 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.batch.core.job;
18  
19  import org.springframework.batch.core.Job;
20  import org.springframework.batch.core.JobExecution;
21  import org.springframework.batch.core.JobInterruptedException;
22  import org.springframework.batch.core.StartLimitExceededException;
23  import org.springframework.batch.core.Step;
24  import org.springframework.batch.core.StepExecution;
25  import org.springframework.batch.core.repository.JobRestartException;
26  
27  /**
28   * Strategy interface for handling a {@link Step} on behalf of a {@link Job}.
29   * 
30   * @author Dave Syer
31   * 
32   */
33  public interface StepHandler {
34  
35  	/**
36  	 * Handle a step and return the execution for it. Does not save the
37  	 * {@link JobExecution}, but should manage the persistence of the
38  	 * {@link StepExecution} if required (e.g. at least it needs to be added to
39  	 * a repository before the step can eb executed).
40  	 * 
41  	 * @param step a {@link Step}
42  	 * @param jobExecution a {@link JobExecution}
43  	 * @return an execution of the step
44  	 * 
45  	 * @throws JobInterruptedException if there is an interruption
46  	 * @throws JobRestartException if there is a problem restarting a failed
47  	 * step
48  	 * @throws StartLimitExceededException if the step exceeds its start limit
49  	 * 
50  	 * @see Job#execute(JobExecution)
51  	 * @see Step#execute(StepExecution)
52  	 */
53  	StepExecution handleStep(Step step, JobExecution jobExecution) throws JobInterruptedException, JobRestartException,
54  			StartLimitExceededException;
55  
56  }