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.event.authentication;
17  
18  import org.acegisecurity.Authentication;
19  
20  import org.springframework.context.ApplicationEvent;
21  
22  
23  /***
24   * Represents an application authentication event.
25   * 
26   * <P>
27   * The <code>ApplicationEvent</code>'s <code>source</code> will be the
28   * <code>Authentication</code> object.
29   * </p>
30   *
31   * @author Ben Alex
32   * @version $Id: AbstractAuthenticationEvent.java,v 1.2 2005/11/17 00:55:48 benalex Exp $
33   */
34  public abstract class AbstractAuthenticationEvent extends ApplicationEvent {
35      //~ Constructors ===========================================================
36  
37      public AbstractAuthenticationEvent(Authentication authentication) {
38          super(authentication);
39      }
40  
41      //~ Methods ================================================================
42  
43      /***
44       * Getters for the <code>Authentication</code> request that caused the
45       * event. Also available from <code>super.getSource()</code>.
46       *
47       * @return the authentication request
48       */
49      public Authentication getAuthentication() {
50          return (Authentication) super.getSource();
51      }
52  }