View Javadoc

1   /*
2    * Copyright 2006 University Corporation for Advanced Internet Development, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package edu.internet2.middleware.shibboleth.common.session;
18  
19  import org.springframework.context.ApplicationEvent;
20  
21  /**
22   * An event representing the destruction of a Shibboleth session that occured because a user logged out of the system or
23   * because the application timed out.
24   */
25  public class LogoutEvent extends ApplicationEvent {
26  
27      /** Serial version UID. */
28      private static final long serialVersionUID = -1234450648177702760L;
29  
30      /**
31       * Constructor.
32       * 
33       * @param session session of the user being logged out
34       */
35      public LogoutEvent(Session session) {
36          super(session);
37      }
38  
39      /**
40       * Gets the session for the user logging out.
41       * 
42       * @return session for the user logging out
43       */
44      public Session getUserSession() {
45          return (Session) getSource();
46      }
47  }