View Javadoc

1   /*
2    * $Id: LogoffAction.java 471754 2006-11-06 14:55:09Z husted $
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  package org.apache.struts.apps.mailreader.actions;
23  
24  import org.apache.struts.action.ActionForm;
25  import org.apache.struts.action.ActionForward;
26  import org.apache.struts.action.ActionMapping;
27  import org.apache.struts.apps.mailreader.Constants;
28  import org.apache.struts.apps.mailreader.dao.User;
29  
30  import javax.servlet.http.HttpServletRequest;
31  import javax.servlet.http.HttpServletResponse;
32  import javax.servlet.http.HttpSession;
33  
34  /**
35   * <p>
36   * Log user out of the current session.
37   * </p>
38   *
39   * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
40   */
41  public final class LogoffAction extends BaseAction {
42  
43      // See superclass for Javadoc
44      public ActionForward execute(
45              ActionMapping mapping,
46              ActionForm form,
47              HttpServletRequest request,
48              HttpServletResponse response)
49              throws Exception {
50  
51          // Log event
52          HttpSession session = request.getSession();
53          User user = doGetUser(session);
54          if (user != null) {
55              if (log.isDebugEnabled()) {
56                  log.debug(
57                          "LogoffAction: User '"
58                                  + user.getUsername()
59                                  + "' logged off in session "
60                                  + session.getId());
61              }
62          } else {
63              if (log.isDebugEnabled()) {
64                  log.debug(
65                          "LogoffActon: User logged off in session " +
66                                  session.getId());
67              }
68          }
69  
70          // Process user logoff by removing session attributes
71          session.removeAttribute(Constants.SUBSCRIPTION_KEY);
72          session.removeAttribute(Constants.USER_KEY);
73          session.invalidate();
74  
75          // Done
76          return doFindSuccess(mapping);
77  
78      }
79  
80  }