Save This Page
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.resource.spi.work;
38
39 /**
40 * This exception is thrown by a <code>WorkManager</code> to indicate
41 * that a submitted <code>Work</code> instance has been rejected. The
42 * rejection could be due to internal factors or start timeout expiration.
43 *
44 * <p>This could be thrown only before the execution of a
45 * <code>Work</code> instance starts (that is, before a
46 * thread has been allocated for <code>Work</code> execution).
47
48 * <p>An associated error code indicates the nature of the error condition.
49 * Possible error codes are <code>WorkException.START_TIMED_OUT</code>,
50 * <code>WorkException.INTERNAL</code> or <code>WorkException.UNDEFINED</code>.
51 *
52 * @version 1.0
53 * @author Ram Jeyaraman
54 */
55 public class WorkRejectedException extends WorkException {
56
57 /**
58 * Constructs a new instance with null as its detail message.
59 */
60 public WorkRejectedException() { super(); }
61
62 /**
63 * Constructs a new instance with the specified detail message.
64 *
65 * @param message the detail message.
66 */
67 public WorkRejectedException(String message) {
68 super(message);
69 }
70
71 /**
72 * Constructs a new throwable with the specified cause.
73 *
74 * @param cause a chained exception of type <code>Throwable</code>.
75 */
76 public WorkRejectedException(Throwable cause) {
77 super(cause);
78 }
79
80 /**
81 * Constructs a new throwable with the specified detail message and cause.
82 *
83 * @param message the detail message.
84 *
85 * @param cause a chained exception of type <code>Throwable</code>.
86 */
87 public WorkRejectedException(String message, Throwable cause) {
88 super(message, cause);
89 }
90
91 /**
92 * Constructs a new throwable with the specified detail message and
93 * an error code.
94 *
95 * @param message a description of the exception.
96 * @param errorCode a string specifying the vendor specific error code.
97 */
98 public WorkRejectedException(String message, String errorCode) {
99 super(message, errorCode);
100 }
101 }