001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package javax.transaction.xa;
038:
039: /**
040: * The XAException is thrown by the Resource Manager (RM) to inform the
041: * Transaction Manager of an error encountered by the involved
042: * transaction.
043: */
044: public class XAException extends java.lang.Exception {
045:
046: /**
047: * The error code with which to create the SystemException.
048: *
049: * @serial The error code for the exception.
050: */
051:
052: public int errorCode;
053:
054: /**
055: * Create an XAException.
056: */
057: public XAException() {
058: super ();
059: }
060:
061: /**
062: * Create an XAException with a given string.
063: *
064: * @param s The <code>String</code> object containing the exception
065: * message.
066: */
067: public XAException(String s) {
068: super (s);
069: }
070:
071: /**
072: * Create an XAException with a given error code.
073: *
074: * @param errcode The error code identifying the exception.
075: */
076: public XAException(int errcode) {
077: super ();
078: errorCode = errcode;
079: }
080:
081: /**
082: * The inclusive lower bound of the rollback codes.
083: */
084: public final static int XA_RBBASE = 100;
085:
086: /**
087: * Indicates that the rollback was caused by an unspecified reason.
088: */
089: public final static int XA_RBROLLBACK = XA_RBBASE;
090:
091: /**
092: * Indicates that the rollback was caused by a communication failure.
093: */
094: public final static int XA_RBCOMMFAIL = XA_RBBASE + 1;
095:
096: /**
097: * A deadlock was detected.
098: */
099: public final static int XA_RBDEADLOCK = XA_RBBASE + 2;
100:
101: /**
102: * A condition that violates the integrity of the resource was detected.
103: */
104: public final static int XA_RBINTEGRITY = XA_RBBASE + 3;
105:
106: /**
107: * The resource manager rolled back the transaction branch for a reason
108: * not on this list.
109: */
110: public final static int XA_RBOTHER = XA_RBBASE + 4;
111:
112: /**
113: * A protocol error occurred in the resource manager.
114: */
115: public final static int XA_RBPROTO = XA_RBBASE + 5;
116:
117: /**
118: * A transaction branch took too long.
119: */
120: public final static int XA_RBTIMEOUT = XA_RBBASE + 6;
121:
122: /**
123: * May retry the transaction branch.
124: */
125: public final static int XA_RBTRANSIENT = XA_RBBASE + 7;
126:
127: /**
128: * The inclusive upper bound of the rollback error code.
129: */
130: public final static int XA_RBEND = XA_RBTRANSIENT;
131:
132: /**
133: * Resumption must occur where the suspension occurred.
134: */
135: public final static int XA_NOMIGRATE = 9;
136:
137: /**
138: * The transaction branch may have been heuristically completed.
139: */
140: public final static int XA_HEURHAZ = 8;
141:
142: /**
143: * The transaction branch has been heuristically committed.
144: */
145: public final static int XA_HEURCOM = 7;
146:
147: /**
148: * The transaction branch has been heuristically rolled back.
149: */
150: public final static int XA_HEURRB = 6;
151:
152: /**
153: * The transaction branch has been heuristically committed and
154: * rolled back.
155: */
156: public final static int XA_HEURMIX = 5;
157:
158: /**
159: * Routine returned with no effect and may be reissued.
160: */
161: public final static int XA_RETRY = 4;
162:
163: /**
164: * The transaction branch was read-only and has been committed.
165: */
166: public final static int XA_RDONLY = 3;
167:
168: /**
169: * There is an asynchronous operation already outstanding.
170: */
171: public final static int XAER_ASYNC = -2;
172:
173: /**
174: * A resource manager error has occurred in the transaction branch.
175: */
176: public final static int XAER_RMERR = -3;
177:
178: /**
179: * The XID is not valid.
180: */
181: public final static int XAER_NOTA = -4;
182:
183: /**
184: * Invalid arguments were given.
185: */
186: public final static int XAER_INVAL = -5;
187:
188: /**
189: * Routine was invoked in an improper context.
190: */
191: public final static int XAER_PROTO = -6;
192:
193: /**
194: * Resource manager is unavailable.
195: */
196: public final static int XAER_RMFAIL = -7;
197:
198: /**
199: * The XID already exists.
200: */
201: public final static int XAER_DUPID = -8;
202:
203: /**
204: * The resource manager is doing work outside a global transaction.
205: */
206: public final static int XAER_OUTSIDE = -9;
207:
208: }
|