KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > PortletException


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 /**
58  ** The <CODE>PortletException</CODE> class defines a general exception that a
59  ** portlet can throw when it encounters difficulty.
60  **
61  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
62  **/
63
64 public class PortletException extends Exception JavaDoc
65 {
66     private Throwable JavaDoc cause;
67
68     /**
69      ** Constructs a new portlet exception.
70      **/
71
72     public PortletException ()
73     {
74         super ();
75     }
76
77     /**
78      ** Constructs a new portlet exception with the given text. The
79      ** portlet container may use the text write it to a log.
80      **
81      ** @param text
82      ** the exception text
83      **/
84
85     public PortletException (String JavaDoc text)
86     {
87         super (text);
88     }
89
90     /**
91      ** Constructs a new portlet exception when the portlet needs to throw an
92      ** exception and include a message about the "root case" that interfered
93      ** with its normal operation, including a description message.
94      **
95      ** @param aText
96      ** the exception text
97      ** @param aCause
98      ** the root cause
99      **/
100
101     public PortletException (String JavaDoc text, Throwable JavaDoc cause)
102     {
103         super (text); //, cause);
104
105         this.cause = cause;
106     }
107
108     /**
109      ** Constructs a new portlet exception when the portlet needs to throw an
110      ** exception. The exception's message is based on the localized message
111      ** of the underlying exception.
112      **
113      ** @param aCause
114      ** the root cause
115      **/
116
117     public PortletException (Throwable JavaDoc cause)
118     {
119         super (cause.getLocalizedMessage ());
120
121         this.cause = cause;
122     }
123
124     /**
125      ** Returns the exception that cause this portlet exception.
126      **
127      ** @return the <CODE>Throwable</CODE> that caused this portlet exception.
128      **/
129
130     public Throwable JavaDoc getRootCause ()
131     {
132         return (cause);
133     }
134 }
135
Popular Tags