/*
 * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.security.authentication.event;

import org.springframework.security.core.Authentication;
import org.springframework.security.core.AuthenticationException;

import org.springframework.util.Assert;

/**
 * Abstract application event which indicates authentication failure for some reason.
 *
 * @author Ben Alex
 */
public abstract class AbstractAuthenticationFailureEvent extends
		AbstractAuthenticationEvent {
	// ~ Instance fields
	// ================================================================================================

	private final AuthenticationException exception;

	// ~ Constructors
	// ===================================================================================================

	public AbstractAuthenticationFailureEvent(Authentication authentication,
			AuthenticationException exception) {
		super(authentication);
		Assert.notNull(exception, "AuthenticationException is required");
		this.exception = exception;
	}

	// ~ Methods
	// ========================================================================================================

	public AuthenticationException getException() {
		return exception;
	}
}
