KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > exception > DefaultExceptionHandler


1 package org.apache.turbine.exception;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation" and
29  * "Apache Turbine" must not be used to endorse or promote products
30  * derived from this software without prior written permission. For
31  * written permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache",
34  * "Apache Turbine", nor may "Apache" appear in their name, without
35  * prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  */
56
57 import org.apache.turbine.ExceptionHandler;
58 import org.apache.turbine.RunData;
59 import org.apache.turbine.Turbine;
60 import org.apache.turbine.ValveContext;
61 import org.apache.turbine.pipeline.DefaultTargetValve;
62 import org.apache.turbine.pipeline.CleanUpValve;
63 import org.apache.commons.lang.exception.ExceptionUtils;
64
65 /**
66  * The default exception handler for {@link Turbine}. Populates the RunData
67  * with information on the throwable, and then renders the template specified
68  * by the 'template.error' configuration property.
69  *
70  * @author <a HREF="mailto:james@jamestaylor.org">James Taylor</a>
71  * @version $Id: DefaultExceptionHandler.java,v 1.7 2003/11/23 00:42:22 mpoeschl Exp $
72  */
73 public class DefaultExceptionHandler implements ExceptionHandler
74 {
75     /**
76      * @see ExceptionHandler#handleException
77      */
78     public void handleException( RunData data, Throwable JavaDoc throwable )
79         throws Exception JavaDoc
80     {
81         data.setTarget( Turbine.getConfiguration()
82             .getString( "template.error", "/Error.vm" ) );
83
84         data.setStackTrace( ExceptionUtils.getStackTrace( throwable ), throwable );
85
86         try
87         {
88             // Simulate a minimal Pipeline here to run the target.
89 new DefaultTargetValve().invoke(data, new NullValveContext());
90         }
91         finally
92         {
93             // generally pull tools will need to be cleaned up.
94 new CleanUpValve().invoke(data, new NullValveContext());
95         }
96     }
97
98     /**
99      * A skeleton {@link org.apache.turbine.ValveContext}
100      * implementation to assist in invoking DefaultTargetValve in
101      * {@link #handleException(RunData, Throwable)}.
102      */
103     protected final class NullValveContext implements ValveContext
104     {
105         /**
106          * No-op implementation of ValveContext interface.
107          */
108         public void invokeNext(RunData ignored)
109         {
110             // Do nothing
111 }
112     }
113 }
114
Popular Tags