View Javadoc

1   /*
2    * Copyright 2006-2007 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.step;
18  
19  import org.springframework.batch.core.JobInterruptedException;
20  import org.springframework.batch.core.Step;
21  import org.springframework.batch.core.StepExecution;
22  
23  /**
24   * Strategy interface for an interruption policy. This policy allows
25   * {@link Step} implementations to check if a job has been interrupted.
26   * 
27   * @author Lucas Ward
28   * 
29   */
30  public interface StepInterruptionPolicy {
31  
32  	/**
33  	 * Has the job been interrupted? If so then throw a
34  	 * {@link JobInterruptedException}.
35  	 * @param stepExecution the current context of the running step.
36  	 * 
37  	 * @throws JobInterruptedException when the job has been interrupted.
38  	 */
39  	void checkInterrupted(StepExecution stepExecution) throws JobInterruptedException;
40  }