001/*
002 * Copyright 2006-2007 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.batch.core.step;
018
019import org.springframework.batch.core.JobInterruptedException;
020import org.springframework.batch.core.Step;
021import org.springframework.batch.core.StepExecution;
022
023/**
024 * Strategy interface for an interruption policy. This policy allows
025 * {@link Step} implementations to check if a job has been interrupted.
026 * 
027 * @author Lucas Ward
028 * 
029 */
030public interface StepInterruptionPolicy {
031
032        /**
033         * Has the job been interrupted? If so then throw a
034         * {@link JobInterruptedException}.
035         * @param stepExecution the current context of the running step.
036         * 
037         * @throws JobInterruptedException when the job has been interrupted.
038         */
039        void checkInterrupted(StepExecution stepExecution) throws JobInterruptedException;
040}