KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jpublish > exception > ExceptionWrapper


1 /*--
2
3  Copyright (C) 2001-2003 Aetrion LLC.
4  All rights reserved.
5  
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions
8  are met:
9  
10  1. Redistributions of source code must retain the above copyright
11     notice, this list of conditions, and the following disclaimer.
12  
13  2. Redistributions in binary form must reproduce the above copyright
14     notice, this list of conditions, and the disclaimer that follows
15     these conditions in the documentation and/or other materials
16     provided with the distribution.
17
18  3. The name "JPublish" must not be used to endorse or promote products
19     derived from this software without prior written permission. For
20     written permission, please contact info@aetrion.com.
21  
22  4. Products derived from this software may not be called "JPublish", nor
23     may "JPublish" appear in their name, without prior written permission
24     from Aetrion LLC (info@aetrion.com).
25  
26  In addition, the authors of this software request (but do not require)
27  that you include in the end-user documentation provided with the
28  redistribution and/or in the software itself an acknowledgement equivalent
29  to the following:
30      "This product includes software developed by
31       Aetrion LLC (http://www.aetrion.com/)."
32
33  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43  POSSIBILITY OF SUCH DAMAGE.
44
45  For more information on JPublish, please see <http://www.jpublish.org/>.
46  
47  */
48
49 package org.jpublish.exception;
50
51 import org.jpublish.RequestContext;
52
53 /**
54  * Class which encapsulates Throwable errors which are sent to registered ErrorHandlers. ErrorHandlers can consume an
55  * error message which will indicate that a ServletException should NOT be thrown once all error handlers have
56  * completed.
57  *
58  * @author Anthony Eden
59  */
60
61 public class ExceptionWrapper {
62
63     private Throwable JavaDoc error = null;
64     private boolean consumed = false;
65     private RequestContext context = null;
66
67     /**
68      * Construct a JPublishError with the given Throwable.
69      *
70      * @param error The Throwable
71      */
72
73     public ExceptionWrapper(Throwable JavaDoc error) {
74         this(error, null);
75     }
76
77     /**
78      * Construct an ExceptionWrapper with the given Throwable and context.
79      *
80      * @param error The error
81      * @param context The current RequestContext
82      */
83
84     public ExceptionWrapper(Throwable JavaDoc error, RequestContext context) {
85         this.error = error;
86         this.context = context;
87     }
88
89     /**
90      * Get the encapsulated error.
91      *
92      * @return The error
93      */
94
95     public Throwable JavaDoc getError() {
96         return error;
97     }
98
99     /**
100      * Return true if this error is consumed. If this method returns true then a ServletException should NOT be thrown
101      * upon completion of all error handlers.
102      *
103      * @return True if this error is consumed
104      */
105
106     public boolean isConsumed() {
107         return consumed;
108     }
109
110     /**
111      * Set to true to mark the error as consumed.
112      *
113      * @param consumed True if error is consumed
114      */
115
116     public void setConsumed(boolean consumed) {
117         this.consumed = consumed;
118     }
119
120     /**
121      * Get a snapshot of the context which was taken when the error occured. This method may return null if the context
122      * is not available at the time the error occurred.
123      *
124      * @return The context
125      */
126
127     public RequestContext getContext() {
128         return context;
129     }
130
131 }
132
Popular Tags