1 /***
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Exoffice Technologies. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Exoffice Technologies. Exolab is a registered
23 * trademark of Exoffice Technologies.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 1999-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42 *
43 * $Id: ServiceException.java,v 1.1 2004/11/26 01:51:01 tanderson Exp $
44 */
45 package org.exolab.jms.service;
46
47 import java.io.PrintStream;
48 import java.io.PrintWriter;
49
50
51 /***
52 * This exception is thrown whenever there is a general exception with a
53 * service entitiy
54 *
55 * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:01 $
56 * @author <a href="mailto:jima@comware.com.au">Jim Alateras</a>
57 * @author <a href="mailto:tma@netspace.net.au">Tim Anderson</a>
58 */
59 public class ServiceException extends Exception {
60
61 /***
62 * The exception that caused this exception. May be <code>null</code>
63 */
64 private Throwable _cause;
65
66
67 /***
68 * Construct a new <code>ServiceException</code> with no information.
69 */
70 public ServiceException() {
71 this(null, null);
72 }
73
74 /***
75 * Construct a new <code>ServiceException</code> with a detail message
76 *
77 * @param message a message describing this exception
78 */
79 public ServiceException(String message) {
80 this(message, null);
81 }
82
83 /***
84 * Construct a new <code>ServiceException</code> with the exception that
85 * caused it.
86 *
87 * @param cause the exception that caused this exception
88 */
89 public ServiceException(Throwable cause) {
90 this(null, cause);
91 }
92
93 /***
94 * Construct a new <code>ServiceException</code> with a detail
95 * message and the exception that caused it
96 *
97 * @param message a message describing this exception
98 * @param cause the exception that caused this exception
99 */
100 public ServiceException(String message, Throwable cause) {
101 super(message);
102 _cause = cause;
103 }
104
105 /***
106 * Returns the exception that caused this exception
107 *
108 * @return the exception that caused this exception.
109 * May be <code>null</code>
110 */
111 public Throwable getRootCause() {
112 return _cause;
113 }
114
115 /***
116 * Prints the stack trace of the thrown exception to the standard error
117 * stream
118 */
119 public void printStackTrace() {
120 printStackTrace(System.err);
121 }
122
123 /***
124 * Prints the stack trace of the thrown exception to the specified
125 * print stream.
126 */
127 public void printStackTrace(PrintStream stream) {
128 synchronized (stream) {
129 if (_cause != null) {
130 stream.print(getClass().getName() + ": ");
131 _cause.printStackTrace(stream);
132 } else {
133 super.printStackTrace(stream);
134 }
135 }
136 }
137
138 /***
139 * Prints the stack trace of the thrown throwable exception to the
140 * specified print writer.
141 */
142 public void printStackTrace(PrintWriter writer) {
143 synchronized (writer) {
144 if (_cause != null) {
145 writer.print(getClass().getName() + ": ");
146 _cause.printStackTrace(writer);
147 } else {
148 super.printStackTrace(writer);
149 }
150 }
151 }
152
153 }