View Javadoc
1   /*
2    * $Id$
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  
23  package org.apache.struts.webapp.example2;
24  
25  
26  import java.lang.reflect.InvocationTargetException;
27  
28  import jakarta.servlet.ServletException;
29  import jakarta.servlet.http.HttpServletRequest;
30  import jakarta.servlet.http.HttpServletResponse;
31  import jakarta.servlet.http.HttpSession;
32  
33  import org.apache.commons.beanutils.PropertyUtils;
34  import org.apache.struts.action.Action;
35  import org.apache.struts.action.ActionForm;
36  import org.apache.struts.action.ActionForward;
37  import org.apache.struts.action.ActionMapping;
38  import org.apache.struts.apps.mailreader.dao.User;
39  import org.slf4j.Logger;
40  import org.slf4j.LoggerFactory;
41  
42  
43  /**
44   * Implementation of <strong>Action</strong> that populates an instance of
45   * <code>RegistrationForm</code> from the profile of the currently logged on
46   * User (if any).
47   *
48   * @author Craig R. McClanahan
49   * @version $Rev$ $Date$
50   */
51  
52  public final class EditRegistrationAction extends Action {
53      private static final long serialVersionUID = -4649550184967126100L;
54  
55  
56      // ----------------------------------------------------- Instance Variables
57  
58  
59      /**
60       * The {@code Log} instance for this class.
61       */
62      private final static Logger LOG =
63          LoggerFactory.getLogger(EditRegistrationAction.class);
64  
65  
66      // --------------------------------------------------------- Public Methods
67  
68  
69      /**
70       * Process the specified HTTP request, and create the corresponding HTTP
71       * response (or forward to another web component that will create it).
72       * Return an <code>ActionForward</code> instance describing where and how
73       * control should be forwarded, or <code>null</code> if the response has
74       * already been completed.
75       *
76       * @param mapping The ActionMapping used to select this instance
77       * @param form The optional ActionForm bean for this request (if any)
78       * @param request The HTTP request we are processing
79       * @param response The HTTP response we are creating
80       *
81       * @exception Exception if the application business logic throws
82       *  an exception
83       */
84      public ActionForward execute(ActionMapping mapping,
85                   ActionForm form,
86                   HttpServletRequest request,
87                   HttpServletResponse response)
88      throws Exception {
89  
90      // Extract attributes we will need
91      HttpSession session = request.getSession();
92      String action = request.getParameter("action");
93      if (action == null) {
94          action = "Create";
95      }
96      LOG.debug("EditRegistrationAction:  Processing {} action",
97          action);
98  
99      // Is there a currently logged on user?
100     User user = null;
101     if (!"Create".equals(action)) {
102         user = (User) session.getAttribute(Constants.USER_KEY);
103         if (user == null) {
104             LOG.debug(" User is not logged on in session {}",
105                 session.getId());
106             return (mapping.findForward("logon"));
107         }
108     }
109 
110     // Populate the user registration form
111     if (form == null) {
112         LOG.trace(" Creating new RegistrationForm bean under key {}",
113             mapping.getAttribute());
114         form = new RegistrationForm();
115         if ("request".equals(mapping.getScope()))
116             request.setAttribute(mapping.getAttribute(), form);
117         else
118             session.setAttribute(mapping.getAttribute(), form);
119     }
120     RegistrationForm regform = (RegistrationForm) form;
121     if (user != null) {
122         LOG.trace(" Populating form from {}", user);
123         try {
124             PropertyUtils.copyProperties(regform, user);
125             regform.setAction(action);
126             regform.setPassword(null);
127             regform.setPassword2(null);
128         } catch (InvocationTargetException e) {
129             Throwable t = e.getTargetException();
130             if (t == null)
131                 t = e;
132             LOG.error("RegistrationForm.populate", t);
133             throw new ServletException("RegistrationForm.populate", t);
134         } catch (Throwable t) {
135             LOG.error("RegistrationForm.populate", t);
136             throw new ServletException("RegistrationForm.populate", t);
137         }
138     }
139 
140     // Set a transactional control token to prevent double posting
141     LOG.trace(" Setting transactional control token");
142     saveToken(request);
143 
144     // Forward control to the edit user registration page
145     LOG.trace(" Forwarding to 'success' page");
146     if ("Create".equals(action)) {
147         return (mapping.findForward("register"));
148     } else {
149         return (mapping.findForward("success"));
150     }
151 
152     }
153 }