KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > pipeline > CleanUpValve


1 package org.apache.turbine.pipeline;
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 java.io.IOException JavaDoc;
58
59 import org.apache.fulcrum.security.util.AccessControlList;
60 import org.apache.turbine.RunData;
61 import org.apache.turbine.TemplateContext;
62 import org.apache.turbine.TurbineException;
63 import org.apache.turbine.ValveContext;
64 import org.apache.turbine.modules.Module;
65
66 /**
67  * Implements the RunData target portion of the "Turbine classic"
68  * processing pipeline (from the Turbine 2.x series).
69  *
70  * @author <a HREF="mailto:jvanzyl@apache.org">Jason van Zyl</a>
71  * @author <a HREF="mailto:jon@latchkey.com">Jon S. Stevens</a>
72  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
73  * @author <a HREF="mailto:mikeh@apache.org">Mike Haberman</a>
74  * @author <a HREF="mailto:james@jamestaylor.org">James Taylor</a>
75  * @author <a HREF="mailto:mpoeschl@marmot.at">Martin Poeschl</a>
76  * @version $Id: CleanUpValve.java,v 1.2 2003/11/23 00:42:22 mpoeschl Exp $
77  */
78 public class CleanUpValve
79     extends AbstractValve
80 {
81     /**
82      * Creates a new instance.
83      */
84     public CleanUpValve()
85     {
86     }
87
88     /**
89      * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
90      */
91     public void invoke(RunData data, ValveContext context)
92         throws IOException JavaDoc, TurbineException
93     {
94         try
95         {
96             cleanUp(data);
97         }
98         catch (Exception JavaDoc e)
99         {
100             throw new TurbineException(e);
101         }
102
103         // Pass control to the next Valve in the Pipeline
104 context.invokeNext(data);
105     }
106
107     /**
108      * Perform clean up after processing the request.
109      *
110      * @param data The run-time data.
111      */
112     protected void cleanUp(RunData data)
113         throws Exception JavaDoc
114     {
115         TemplateContext context = Module.getTemplateContext(data);
116         Module.requestFinished(context);
117
118         // If a module has set data.acl = null, remove acl from
119 // the session.
120 if (data.getACL() == null)
121         {
122             try
123             {
124                 data.getSession().removeAttribute
125                     (AccessControlList.SESSION_KEY);
126             }
127             catch (IllegalStateException JavaDoc invalidatedSession)
128             {
129                 // Web was used to shut us down. Trying to clean up
130 // our stuff, but it's already been done for us.
131 }
132         }
133     }
134 }
135
Popular Tags