KickJava   Java API By Example, From Geeks To Geeks.

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


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.turbine.modules.Action;
60 import org.apache.fulcrum.security.TurbineSecurity;
61 import org.apache.fulcrum.security.entity.User;
62 import org.apache.fulcrum.security.util.DataBackendException;
63 import org.apache.fulcrum.security.util.TurbineSecurityException;
64 import org.apache.commons.logging.LogFactory;
65 import org.apache.commons.logging.Log;
66
67 /**
68  * This is where we authenticate the user logging into the system
69  * against a user in the database. If the user exists in the database
70  * that users last login time will be updated.
71  *
72  * @author <a HREF="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
73  * @version $Id: LoginUser.java,v 1.4 2002/04/09 17:29:34 jtaylor Exp $
74  */
75 public class LoginUser
76     extends Action
77 {
78     private static final Log log = LogFactory.getLog( LoginUser.class );
79
80     /**
81      * Updates the user's LastLogin timestamp, sets their state to
82      * "logged in" and calls RunData.setUser() . If the user cannot
83      * be authenticated (database error?) the user is assigned
84      * anonymous status and, if tr.props contains a TEMPLATE_LOGIN,
85      * the screenTemplate is set to this, otherwise the screen is set
86      * to SCREEN_LOGIN
87      *
88      * <p><em>Note: Turbine clears the session before calling this
89      * method</em></p>
90      *
91      * @param data Turbine information.
92      * @exception Exception a generic exception.
93      */
94     public void doPerform( RunData data )
95         throws Exception JavaDoc
96     {
97         // This prevents a db hit on second Action call during page
98 // generation. Turbine removes everything from the Session
99 // before calling this method, so in this case we should
100 // continue on with the Login procedure.
101 if ( data.getUserFromSession() != null )
102         {
103             return;
104         }
105
106         String JavaDoc username = data.getParameters().getString( "username", "" );
107         String JavaDoc password = data.getParameters().getString( "password", "" );
108
109         User user = null;
110         try
111         {
112             // Authenticate the user and get the object.
113 user = TurbineSecurity.getAuthenticatedUser( username, password );
114
115             // Store the user object.
116 data.setUser(user);
117
118             // Mark the user as being logged in.
119 user.setHasLoggedIn(Boolean.TRUE);
120
121             // Set the last_login date in the database.
122 user.updateLastLogin();
123
124             // This only happens if the user is valid; otherwise, we
125 // will get a valueBound in the User object when we don't
126 // want to because the username is not set yet. Save the
127 // User object into the session.
128 data.save();
129
130             // If the setPage("template.vm") method has not
131 // been used in the template to authenticate the
132 // user (usually Login.vm), then the user will
133 // be forwarded to the template that is specified
134 // by the "template.home" property as listed in
135 // TR.props for the webapp.
136 }
137         catch ( TurbineSecurityException e )
138         {
139             if(e instanceof DataBackendException)
140             {
141                 log.error(e);
142             }
143
144             data.setMessage(Turbine.getConfiguration().getString(
145                 Turbine.LOGIN_ERROR));
146
147             // Retrieve an anonymous user.
148 data.setUser (TurbineSecurity.getAnonymousUser());
149
150             data.setTarget(Turbine.getConfiguration().getString(
151                 Turbine.TEMPLATE_LOGIN));
152         }
153     }
154 }
155
Popular Tags