KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > ConfigurationException


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2002-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis;
57
58 import org.jboss.axis.utils.JavaUtils;
59 import org.jboss.logging.Logger;
60
61 import java.io.IOException JavaDoc;
62
63 /**
64  * ConfigurationException is thrown when an error occurs trying to
65  * use an EngineConfiguration.
66  *
67  * @author Glyn Normington (glyn@apache.org)
68  */
69 public class ConfigurationException extends IOException JavaDoc
70 {
71
72    /**
73     * any contained exception
74     */
75    private Exception JavaDoc containedException = null;
76
77    private String JavaDoc stackTrace = "";
78
79    /**
80     * Copy the orginal exception by default
81     */
82    protected static boolean copyStackByDefault = true;
83
84    private static Logger log = Logger.getLogger(ConfigurationException.class.getName());
85
86    /**
87     * Construct a ConfigurationException from a String. The string is wrapped
88     * in an exception, enabling a stack traceback to be obtained.
89     *
90     * @param message String form of the error
91     */
92    public ConfigurationException(String JavaDoc message)
93    {
94       super(message);
95       if (copyStackByDefault)
96       {
97          stackTrace = JavaUtils.stackToString(this);
98       }
99       logException(this);
100    }
101
102    /**
103     * Construct a ConfigurationException from an Exception.
104     *
105     * @param exception original exception which was unexpected
106     */
107    public ConfigurationException(Exception JavaDoc exception)
108    {
109       this(exception, copyStackByDefault);
110    }
111
112    /**
113     * stringify, including stack trace.
114     *
115     * @return
116     */
117    public String JavaDoc toString()
118    {
119       String JavaDoc stack;
120       if (stackTrace.length() == 0)
121       {
122          stack = "";
123       }
124       else
125       {
126          stack = "\n" + stackTrace;
127       }
128       return super.toString() + stack;
129    }
130
131    /**
132     * Construct a ConfigurationException from an Exception.
133     *
134     * @param exception original exception which was unexpected
135     * @param copyStack set to true to copy the orginal exception's stack
136     */
137    public ConfigurationException(Exception JavaDoc exception, final boolean copyStack)
138    {
139       super(exception.toString() + (copyStack ? "\n"
140               + JavaUtils.stackToString(exception) : ""));
141       containedException = exception;
142       if (copyStack)
143       {
144          stackTrace = JavaUtils.stackToString(this);
145       }
146       // Log the exception the first time it appears.
147 if (!(exception instanceof ConfigurationException))
148       {
149          logException(exception);
150       }
151    }
152
153    /**
154     * single point for logging exceptions.
155     *
156     * @param exception
157     */
158    private void logException(Exception JavaDoc exception)
159    {
160       log.debug("Exception: ", exception);
161    }
162
163    /**
164     * get any contained exception
165     *
166     * @return base exception or null
167     * @since axis1.1
168     */
169    public Exception JavaDoc getContainedException()
170    {
171       return containedException;
172    }
173 }
174
Popular Tags