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;
18
19
20 /**
21 * Exception to indicate the the job has been interrupted. The exception state
22 * indicated is not normally recoverable by batch application clients, but
23 * internally it is useful to force a check. The exception will often be wrapped
24 * in a runtime exception (usually {@link UnexpectedJobExecutionException} before
25 * reaching the client.
26 *
27 * @author Lucas Ward
28 * @author Dave Syer
29 *
30 */
31 public class JobInterruptedException extends JobExecutionException {
32
33 private BatchStatus status = BatchStatus.STOPPED;
34
35 public JobInterruptedException(String msg) {
36 super(msg);
37 }
38
39 public JobInterruptedException(String msg, BatchStatus status) {
40 super(msg);
41 this.status = status;
42 }
43
44 /**
45 * The desired status of the surrounding execution after the interruption.
46 *
47 * @return the status of the interruption (default STOPPED)
48 */
49 public BatchStatus getStatus() {
50 return status;
51 }
52 }