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;
018
019
020/**
021 * Exception to indicate the the job has been interrupted. The exception state
022 * indicated is not normally recoverable by batch application clients, but
023 * internally it is useful to force a check. The exception will often be wrapped
024 * in a runtime exception (usually {@link UnexpectedJobExecutionException} before
025 * reaching the client.
026 * 
027 * @author Lucas Ward
028 * @author Dave Syer
029 * 
030 */
031@SuppressWarnings("serial")
032public class JobInterruptedException extends JobExecutionException {
033        
034        private BatchStatus status = BatchStatus.STOPPED;
035
036        public JobInterruptedException(String msg) {
037                super(msg);
038        }
039
040        public JobInterruptedException(String msg, BatchStatus status) {
041                super(msg);
042                this.status = status;
043        }
044        
045        /**
046         * The desired status of the surrounding execution after the interruption.
047         * 
048         * @return the status of the interruption (default STOPPED)
049         */
050        public BatchStatus getStatus() {
051                return status;
052        }
053}