KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-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.Messages;
59 import org.jboss.logging.Logger;
60
61 /**
62  * Encapsulates exceptions for "should never occur" situations. Extends
63  * RuntimeException so it need not explicitly be caught. Logs the exception
64  * as a fatal error, and if debug is enabled, includes the full stack trace.
65  *
66  * @author Sam Ruby (rubys@us.ibm.com)
67  * @author Glyn Normington (glyn_normington@uk.ibm.com)
68  */
69 public class InternalException extends RuntimeException JavaDoc
70 {
71
72    private static Logger log = Logger.getLogger(InternalException.class.getName());
73
74    /**
75     * Attribute which controls whether or not logging of such events should
76     * occur. Default is true and is recommended. Sometimes this may be
77     * turned off in unit tests when internal errors are intentionally
78     * provoked.
79     */
80    private static boolean shouldLog = true;
81
82    /**
83     * Setter for logging.
84     */
85    public static void setLogging(boolean logging)
86    {
87       shouldLog = logging;
88    }
89
90    /**
91     * Getter for logging property.
92     */
93    public static boolean getLogging()
94    {
95       return shouldLog;
96    }
97
98    /**
99     * Construct an Internal Exception from a String. The string is wrapped
100     * in an exception, enabling a stack traceback to be obtained.
101     *
102     * @param message String form of the error
103     */
104    public InternalException(String JavaDoc message)
105    {
106       this(new Exception JavaDoc(message));
107    }
108
109    /**
110     * Construct an Internal Exception from an Exception.
111     *
112     * @param exception original exception which was unexpected
113     */
114    public InternalException(Exception JavaDoc e)
115    {
116       super(e.toString());
117
118       if (shouldLog)
119       {
120          // if the exception is merely bubbling up the stack, only log the
121 // event if debug is turned on.
122 if (e instanceof InternalException)
123          {
124             log.debug("InternalException: ", e);
125          }
126          else
127          {
128             log.fatal(Messages.getMessage("exception00"), e);
129          }
130       }
131    }
132 }
133
Popular Tags