KickJava   Java API By Example, From Geeks To Geeks.

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


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.turbine.Turbine;
60 import org.apache.turbine.TurbineConstants;
61 import org.apache.turbine.RunData;
62 import org.apache.turbine.TurbineException;
63 import org.apache.turbine.ValveContext;
64 import org.apache.turbine.modules.Module;
65
66 /**
67  * Implements the action portion of the "Turbine classic" processing
68  * 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:mikeh@apache.org">Mike Haberman</a>
73  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
74  * @version $Id: DefaultActionValve.java,v 1.11 2003/11/23 00:42:22 mpoeschl Exp $
75  */
76 public class DefaultActionValve
77     extends AbstractValve
78     implements TurbineConstants
79 {
80     /**
81      * Here we can setup objects that are thread safe and can be
82      * reused. We setup the session validator and the access
83      * controller.
84      */
85     public DefaultActionValve()
86         throws Exception JavaDoc
87     {
88     }
89
90     /**
91      * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
92      */
93     public void invoke(RunData data, ValveContext context)
94         throws IOException JavaDoc, TurbineException
95     {
96         try
97         {
98             preExecuteAction(data);
99             executeAction(data);
100             postExecuteAction(data);
101         }
102         catch (Exception JavaDoc e)
103         {
104             throw new TurbineException(e);
105         }
106
107         // Pass control to the next Valve in the Pipeline
108 context.invokeNext(data);
109     }
110
111     /**
112      * Adds a reference the request's context to the run-time data's
113      * temporary--per-request--storage so that all subsequent stages
114      * of the request have access to the template context. Called
115      * before the action is executed.
116      *
117      * @param data The run-time data.
118      */
119     protected void preExecuteAction(RunData data)
120         throws Exception JavaDoc
121     {
122         // Puts a copy of the Context into the data.setTemp()
123 Module.getTemplateContext(data);
124     }
125
126     /**
127      * Executes the action parsed from the query string.
128      *
129      * @param data The run-time data.
130      */
131     protected void executeAction(RunData data)
132         throws Exception JavaDoc
133     {
134         // If an action has been defined, execute it here. Actions
135 // can re-define the template definition.
136 if (data.hasAction())
137         {
138             Turbine.getResolver()
139                 .getModule( ACTIONS, data.getAction() ).execute( data );
140         }
141     }
142
143     /**
144      * No op. Called after the action is executed.
145      *
146      * @param data The run-time data.
147      */
148     protected void postExecuteAction(RunData data)
149         throws Exception JavaDoc
150     {
151     }
152 }
153
Popular Tags