001: /*
002: * $Id: LogonAction.java 471754 2006-11-06 14:55:09Z husted $
003: *
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: package org.apache.struts.webapp.example2;
023:
024: import javax.servlet.http.HttpServletRequest;
025: import javax.servlet.http.HttpServletResponse;
026: import javax.servlet.http.HttpSession;
027: import org.apache.commons.beanutils.PropertyUtils;
028: import org.apache.commons.logging.Log;
029: import org.apache.commons.logging.LogFactory;
030: import org.apache.struts.action.Action;
031: import org.apache.struts.action.ActionMessage;
032: import org.apache.struts.action.ActionErrors;
033: import org.apache.struts.action.ActionForm;
034: import org.apache.struts.action.ActionForward;
035: import org.apache.struts.action.ActionMapping;
036: import org.apache.struts.util.ModuleException;
037:
038: /**
039: * Implementation of <strong>Action</strong> that validates a user logon.
040: *
041: * @author Craig R. McClanahan
042: * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
043: */
044:
045: public final class LogonAction extends Action {
046:
047: // ----------------------------------------------------- Instance Variables
048:
049: /**
050: * The <code>Log</code> instance for this application.
051: */
052: private Log log = LogFactory
053: .getLog("org.apache.struts.webapp.Example");
054:
055: // --------------------------------------------------------- Public Methods
056:
057: /**
058: * Process the specified HTTP request, and create the corresponding HTTP
059: * response (or forward to another web component that will create it).
060: * Return an <code>ActionForward</code> instance describing where and how
061: * control should be forwarded, or <code>null</code> if the response has
062: * already been completed.
063: *
064: * @param mapping The ActionMapping used to select this instance
065: * @param form The optional ActionForm bean for this request (if any)
066: * @param request The HTTP request we are processing
067: * @param response The HTTP response we are creating
068: *
069: * @exception Exception if business logic throws an exception
070: */
071: public ActionForward execute(ActionMapping mapping,
072: ActionForm form, HttpServletRequest request,
073: HttpServletResponse response) throws Exception {
074:
075: // Extract attributes we will need
076: User user = null;
077:
078: // Validate the request parameters specified by the user
079: ActionErrors errors = new ActionErrors();
080: String username = (String) PropertyUtils.getSimpleProperty(
081: form, "username");
082: String password = (String) PropertyUtils.getSimpleProperty(
083: form, "password");
084: UserDatabase database = (UserDatabase) servlet
085: .getServletContext().getAttribute(
086: Constants.DATABASE_KEY);
087: if (database == null)
088: errors.add(ActionErrors.GLOBAL_MESSAGE, new ActionMessage(
089: "error.database.missing"));
090: else {
091: user = getUser(database, username);
092: if ((user != null) && !user.getPassword().equals(password))
093: user = null;
094: if (user == null)
095: errors.add(ActionErrors.GLOBAL_MESSAGE,
096: new ActionMessage("error.password.mismatch"));
097: }
098:
099: // Report any errors we have discovered back to the original form
100: if (!errors.isEmpty()) {
101: saveErrors(request, errors);
102: return (mapping.getInputForward());
103: }
104:
105: // Save our logged-in user in the session
106: HttpSession session = request.getSession();
107: session.setAttribute(Constants.USER_KEY, user);
108: if (log.isDebugEnabled()) {
109: log.debug("LogonAction: User '" + user.getUsername()
110: + "' logged on in session " + session.getId());
111: }
112:
113: // Remove the obsolete form bean
114: if (mapping.getAttribute() != null) {
115: if ("request".equals(mapping.getScope()))
116: request.removeAttribute(mapping.getAttribute());
117: else
118: session.removeAttribute(mapping.getAttribute());
119: }
120:
121: // Forward control to the specified success URI
122: return (mapping.findForward("success"));
123:
124: }
125:
126: // ------------------------------------------------------ Protected Methods
127:
128: /**
129: * Look up the user, throwing an exception to simulate business logic
130: * rule exceptions.
131: *
132: * @param database Database in which to look up the user
133: * @param username Username specified on the logon form
134: *
135: * @exception AppException if a business logic rule is violated
136: */
137: public User getUser(UserDatabase database, String username)
138: throws ModuleException {
139:
140: // Force an ArithmeticException which can be handled explicitly
141: if ("arithmetic".equals(username)) {
142: throw new ArithmeticException();
143: }
144:
145: // Force an application-specific exception which can be handled
146: if ("expired".equals(username)) {
147: throw new ExpiredPasswordException(username);
148: }
149:
150: // Look up and return the specified user
151: return (database.findUser(username));
152:
153: }
154:
155: }
|