authenticationevent.java

来自「CAS在Tomcat中实现单点登录项目,单点登录（Single Sign On 」· Java 代码 · 共 78 行

/*
 * Copyright 2007 The JA-SIG Collaborative. All rights reserved. See license
 * distributed with this file and available online at
 * http://www.ja-sig.org/products/cas/overview/license/
 */
package org.jasig.cas.event;

import org.jasig.cas.authentication.principal.Credentials;

/**
 * Event for letting listeners know about authentication requests and whether
 * they were successful or not. Provides handlers with access to the original
 * Credentials object as well as the return value from the handler.
 * 
 * @author Scott Battaglia
 * @version $Revision: 42053 $ $Date: 2007-06-10 09:17:55 -0400 (Sun, 10 Jun 2007) $
 * @since 3.0
 */
public class AuthenticationEvent extends AbstractEvent {

    /** Unique Serializable Id. */
    private static final long serialVersionUID = 3257844398434889778L;

    /**
     * Boolean of whether this event represents a successful authentication or
     * not.
     */
    private boolean successfulAuthentication;

    /** The AuthenticationHandler class used to generate this event. */
    private Class<?> authenticationHandlerClass;

    /**
     * Constructs the AuthenticationEvent using the credentials as the source
     * object.
     * 
     * @param credentials the Credentials from the AuthenticationRequest.
     * @param successfulAuthentication boolean of whether the authentication was
     * successful or not.
     */
    public AuthenticationEvent(final Credentials credentials,
        final boolean successfulAuthentication,
        final Class<?> authenticationHandlerClass) {
        super(credentials);

        this.successfulAuthentication = successfulAuthentication;
        this.authenticationHandlerClass = authenticationHandlerClass;
    }

    /**
     * Method to return the Credentials for the Authentication.
     * 
     * @return the Credentials.
     */
    public final Credentials getCredentials() {
        return (Credentials) getSource();
    }

    /**
     * Method to determine if the authentication this event represents was
     * successful or not.
     * 
     * @return true if successful, false otherwise.
     */
    public final boolean isSuccessfulAuthentication() {
        return this.successfulAuthentication;
    }

    /**
     * Method to return the AuthenticatonHandler class that generated the event.
     * 
     * @return the Class of the AuthenticationHandler.
     */
    public final Class<?> getAuthenticationHandlerClass() {
        return this.authenticationHandlerClass;
    }
}