View Javadoc

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