KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > modules > actions > TemplateSessionValidator


1 package org.apache.turbine.modules.actions;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2001 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.Turbine;
58 import org.apache.turbine.RunData;
59 import org.apache.fulcrum.security.TurbineSecurity;
60
61 /**
62  * SessionValidator for use with the Template Service, the
63  * TemplateSessionValidator is virtually identical to the
64  * TemplateSecureSessionValidator except that it does not tranfer to the
65  * login page when it detects a null user (or a user not logged in).
66  *
67  * <p>The Template Service requires a different Session Validator
68  * because of the way it handles screens.
69  *
70  * @see TemplateSecureSessionValidator
71  * @author <a HREF="mailto:jmcnally@collab.net">John D. McNally</a>
72  * @author <a HREF="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
73  * @version $Id: TemplateSessionValidator.java,v 1.5 2002/03/20 01:55:28 brekke Exp $
74  */
75 public class TemplateSessionValidator
76     extends SessionValidator
77 {
78      /**
79       * the COUNTER can be placed as a hidden field in
80       * forms. This can be used to prevent a user from using the
81       * browsers back button and submitting stale data.
82       */
83      protected String JavaDoc COUNTER = "_session_access_counter";
84
85     /**
86      * Execute the action.
87      *
88      * @param data Turbine information.
89      * @exception Exception a generic exception.
90      */
91     public void doPerform(RunData data)
92         throws Exception JavaDoc
93     {
94         // pull user from session, update access times, counters
95 data.populate();
96
97         // The user may have not logged in, so create a "guest" user.
98 if ( data.getUser() == null )
99         {
100             // place user in the session
101 data.setUser(TurbineSecurity.getAnonymousUser());
102             data.save();
103         }
104
105         // make sure we have some way to return a response
106 if (!data.hasTarget())
107         {
108             setTarget(data);
109         }
110         else if (data.getParameters().containsKey(COUNTER) )
111         {
112             processCounter(data);
113         }
114     }
115
116     protected void setTarget(RunData data)
117     {
118         String JavaDoc target = data.getParameters().getString("template");
119
120         if (target != null)
121         {
122             data.setTarget(target);
123         }
124         else
125         {
126             data.setTarget(Turbine.getConfiguration().getString(
127                 Turbine.TEMPLATE_HOMEPAGE));
128         }
129     }
130
131     protected void processCounter(RunData data)
132     {
133         // See comments in screens.error.InvalidState.
134 if (data.getParameters().getInt(COUNTER) <
135             (((Integer JavaDoc)data.getUser().getTemp(COUNTER)).intValue() - 1) )
136         {
137             if (data.hasTarget())
138             {
139                 data.getUser().setTemp( "prev_template", data.getTarget());
140
141                 data.setTarget(Turbine.getConfiguration().getString(
142                     Turbine.TEMPLATE_INVALID_STATE));
143             }
144             data.getUser().setTemp( "prev_parameters", data.getParameters() );
145             data.setAction( "" );
146         }
147     }
148 }
149
Popular Tags