View Javadoc

    1   /* Copyright 2004, 2005 Acegi Technology Pty Limited
    2    *
    3    * Licensed under the Apache License, Version 2.0 (the "License");
    4    * you may not use this file except in compliance with the License.
    5    * You may obtain a copy of the License at
    6    *
    7    *     http://www.apache.org/licenses/LICENSE-2.0
    8    *
    9    * Unless required by applicable law or agreed to in writing, software
    10   * distributed under the License is distributed on an "AS IS" BASIS,
    11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12   * See the License for the specific language governing permissions and
    13   * limitations under the License.
    14   */
    15
    16  package org.acegisecurity.ui.session;
    17
    18  import org.springframework.context.ApplicationEvent;
    19
    20  import javax.servlet.http.HttpSession;
    21
    22
    23  /***
    24   * Parent class for published HttpSession events
    25   *
    26   * @author Ray Krueger
    27   */
    28  public abstract class HttpSessionApplicationEvent extends ApplicationEvent {
    29      //~ Constructors ===========================================================
    30
    31      /***
    32       * Base constructor for all subclasses must have an HttpSession
    33       *
    34       * @param httpSession The session to carry as the event source.
    35       */
    36      public HttpSessionApplicationEvent(HttpSession httpSession) {
    37          super(httpSession);
    38      }
    39
    40      //~ Methods ================================================================
    41
    42      /***
    43       * Get the HttpSession that is the cause of the event
    44       *
    45       * @return HttpSession instance
    46       */
    47      public HttpSession getSession() {
    48          return (HttpSession) getSource();
    49      }
    50  }