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: package javax.ejb;
037:
038: /**
039: * The EJBException exception is thrown by an enterprise Bean instance to
040: * its container to report that the invoked business method or callback method
041: * could not be completed because of an unexpected error (e.g. the instance
042: * failed to open a database connection).
043: */
044: public class EJBException extends java.lang.RuntimeException {
045: /**
046: * @serial
047: */
048: private Exception causeException = null;
049:
050: /**
051: * Constructs an EJBException with no detail message.
052: */
053: public EJBException() {
054: }
055:
056: /**
057: * Constructs an EJBException with the specified
058: * detailed message.
059: */
060: public EJBException(String message) {
061: super (message);
062: }
063:
064: /**
065: * Constructs an EJBException that embeds the originally thrown exception.
066: */
067: public EJBException(Exception ex) {
068: super ();
069: causeException = ex;
070: }
071:
072: /**
073: * Constructs an EJBException that embeds the originally thrown exception
074: * with the specified detail message.
075: */
076: public EJBException(String message, Exception ex) {
077: super (message);
078: causeException = ex;
079: }
080:
081: /**
082: * Obtain the exception that caused the EJBException being thrown.
083: */
084: public Exception getCausedByException() {
085: return causeException;
086: }
087:
088: /**
089: * Returns the detail message, including the message from the nested
090: * exception if there is one.
091: */
092: public String getMessage() {
093: String msg = super .getMessage();
094: if (causeException == null)
095: return msg;
096: else if (msg == null) {
097: return "nested exception is: " + causeException.toString();
098: } else {
099: return msg + "; nested exception is: "
100: + causeException.toString();
101: }
102: }
103:
104: /**
105: * Prints the composite message and the embedded stack trace to
106: * the specified stream <code>ps</code>.
107: * @param ps the print stream
108: */
109: public void printStackTrace(java.io.PrintStream ps) {
110: if (causeException == null) {
111: super .printStackTrace(ps);
112: } else {
113: synchronized (ps) {
114: ps.println(this );
115: // Print the cause exception first, so that the output
116: // appears in stack order (i.e. innermost exception first)
117: causeException.printStackTrace(ps);
118: super .printStackTrace(ps);
119: }
120: }
121: }
122:
123: /**
124: * Prints the composite message to <code>System.err</code>.
125: */
126: public void printStackTrace() {
127: printStackTrace(System.err);
128: }
129:
130: /**
131: * Prints the composite message and the embedded stack trace to
132: * the specified print writer <code>pw</code>.
133: * @param pw the print writer
134: */
135: public void printStackTrace(java.io.PrintWriter pw) {
136: if (causeException == null) {
137: super .printStackTrace(pw);
138: } else {
139: synchronized (pw) {
140: pw.println(this );
141: // Print the cause exception first, so that the output
142: // appears in stack order (i.e. innermost exception first)
143: causeException.printStackTrace(pw);
144: super.printStackTrace(pw);
145: }
146: }
147: }
148: }
|