KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.apache.turbine.Turbine;
59 import org.apache.turbine.RunData;
60 import org.apache.turbine.TurbineException;
61 import org.apache.turbine.ValveContext;
62 import org.apache.commons.logging.Log;
63 import org.apache.commons.logging.LogFactory;
64
65 /**
66  * This valve is responsible for setting the 'target' property of the RunData.
67  * If it is not already set it attempts to get the target from the request
68  * parameter 'template'. If the parameter is not set, we use the homepage
69  * specified by the configuration property Turbine.TEMPLATE_HOMEPAGE.
70  *
71  * FIXME: The request parameter which determines the template should be
72  * configurable.
73  *
74  * @author <a HREF="mailto:james@jamestaylor.org">James Taylor</a>
75  */
76 public class DetermineTargetValve
77     extends AbstractValve
78 {
79     private static final Log log
80         = LogFactory.getLog( DetermineTargetValve.class );
81         
82     /**
83      * @see org.apache.turbine.Valve#invoke(RunData, ValveContext)
84      */
85     public void invoke( RunData data, ValveContext context )
86         throws IOException JavaDoc, TurbineException
87     {
88         if ( ! data.hasTarget() )
89         {
90             String JavaDoc target = data.getParameters().getString( "template" );
91
92             if ( target != null )
93             {
94                 data.setTarget( target );
95                 
96                 log.debug( "Set target from request parameter" );
97             }
98             else
99             {
100                 data.setTarget( Turbine.getConfiguration().getString(
101                     Turbine.TEMPLATE_HOMEPAGE ) );
102                     
103                 log.debug( "Set target using default value" );
104             }
105         }
106         
107         if ( log.isDebugEnabled() )
108         {
109             log.debug( "Target is now: " + data.getTarget() );
110         }
111
112         // Pass control to the next Valve in the Pipeline
113 context.invokeNext( data );
114     }
115 }
116
Popular Tags