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 * A common base class for all <code>Work</code> processing related exceptions.
41 *
42 * @version 1.0
43 * @author Ram Jeyaraman
44 */
45 public class WorkException extends javax.resource.ResourceException {
46
47
48 /**
49 * Indicates an internal error condition.
50 */
51 public static final String INTERNAL = "-1";
52
53 /**
54 * Undefined error code.
55 */
56 public static final String UNDEFINED = "0";
57
58 /**
59 * Indicates start timeout expiration.
60 */
61 public static final String START_TIMED_OUT = "1";
62
63 /**
64 * Indicates that concurrent work within a transaction is
65 * disallowed. That is, there is already another <code>Work</code>
66 * instance associated with the specified transaction context.
67 */
68 public static final String TX_CONCURRENT_WORK_DISALLOWED = "2";
69
70 /**
71 * Indicates a failure in recreating the specified transaction context.
72 */
73 public static final String TX_RECREATE_FAILED = "3";
74
75 /**
76 * Constructs a new instance with null as its detail message.
77 */
78 public WorkException() { super(); }
79
80 /**
81 * Constructs a new instance with the specified detail message.
82 *
83 * @param message the detail message.
84 */
85 public WorkException(String message) {
86 super(message);
87 }
88
89 /**
90 * Constructs a new throwable with the specified cause.
91 *
92 * @param cause a chained exception of type
93 * <code>Throwable</code>.
94 */
95 public WorkException(Throwable cause) {
96 super(cause);
97 }
98
99 /**
100 * Constructs a new throwable with the specified detail message and cause.
101 *
102 * @param message the detail message.
103 *
104 * @param cause a chained exception of type
105 * <code>Throwable</code>.
106 */
107 public WorkException(String message, Throwable cause) {
108 super(message, cause);
109 }
110
111 /**
112 * Constructs a new throwable with the specified detail message and
113 * an error code.
114 *
115 * @param message a description of the exception.
116 * @param errorCode a string specifying the vendor specific error code.
117 */
118 public WorkException(String message, String errorCode) {
119 super(message, errorCode);
120 }
121 }