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.util.Assert;
21  
22  
23  /**
24   * Indicates an interactive authentication was successful.<P>The <code>ApplicationEvent</code>'s
25   * <code>source</code> will be the <code>Authentication</code> object.</p>
26   *
27   * @author Ben Alex
28   * @version $Id: InteractiveAuthenticationSuccessEvent.java 2217 2007-10-27 00:45:30Z luke_t $
29   */
30  public class InteractiveAuthenticationSuccessEvent extends AbstractAuthenticationEvent {
31      //~ Instance fields ================================================================================================
32  
33      private Class generatedBy;
34  
35      //~ Constructors ===================================================================================================
36  
37      public InteractiveAuthenticationSuccessEvent(Authentication authentication, Class generatedBy) {
38          super(authentication);
39          Assert.notNull(generatedBy);
40          this.generatedBy = generatedBy;
41      }
42  
43      //~ Methods ========================================================================================================
44  
45      /**
46       * Getter for the <code>Class</code> that generated this event. This can be useful for generating
47       * additional logging information.
48       *
49       * @return the class
50       */
51      public Class getGeneratedBy() {
52          return generatedBy;
53      }
54  }