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.util.Assert;
21  
22  
23  /***
24   * Indicates an interactive authentication was successful.
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: InteractiveAuthenticationSuccessEvent.java,v 1.2 2005/11/17 00:55:48 benalex Exp $
33   */
34  public class InteractiveAuthenticationSuccessEvent
35      extends AbstractAuthenticationEvent {
36      //~ Instance fields ========================================================
37  
38      private Class generatedBy;
39  
40      //~ Constructors ===========================================================
41  
42      public InteractiveAuthenticationSuccessEvent(
43          Authentication authentication, Class generatedBy) {
44          super(authentication);
45          Assert.notNull(generatedBy);
46          this.generatedBy = generatedBy;
47      }
48  
49      //~ Methods ================================================================
50  
51      /***
52       * Getter for the <code>Class</code> that generated this event. This can be
53       * useful for generating additional logging information.
54       *
55       * @return
56       */
57      public Class getGeneratedBy() {
58          return generatedBy;
59      }
60  }