View Javadoc

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