org.jasig.cas.authentication

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jasig.cas.authentication.AuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PrincipalException

public class AuthenticationException
extends Exception

Authentication raised by AuthenticationManager to signal authentication failure. Authentication failure typically occurs when one or more AuthenticationHandler components fail to authenticate credentials. This exception contains information about handler successes and failures that may be used by higher-level components to determine subsequent behavior.

Since:

4.0

Author:

Marvin S. Addison

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationException() Creates a new instance for the case when no handlers were attempted, i.e. no successes or failures.
AuthenticationException(Map<String,Class<? extends Exception>> handlerErrors) Creates a new instance for the case when no handlers succeeded.
AuthenticationException(Map<String,Class<? extends Exception>> handlerErrors, Map<String,HandlerResult> handlerSuccesses) Creates a new instance for the case when there are both handler successes and failures.
AuthenticationException(String message, Map<String,Class<? extends Exception>> handlerErrors, Map<String,HandlerResult> handlerSuccesses) Creates a new instance for the case when there are both handler successes and failures and a custom error message is required.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Class<? extends Exception>>	getHandlerErrors() Gets an unmodifable map of handler names to errors.
Map<String,HandlerResult>	getHandlerSuccesses() Gets an unmodifable map of handler names to authentication successes.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationException

public AuthenticationException()

Creates a new instance for the case when no handlers were attempted, i.e. no successes or failures.

AuthenticationException

public AuthenticationException(Map<String,Class<? extends Exception>> handlerErrors)

Creates a new instance for the case when no handlers succeeded.

Parameters:

handlerErrors - Map of handler names to errors.

AuthenticationException

public AuthenticationException(Map<String,Class<? extends Exception>> handlerErrors,
                       Map<String,HandlerResult> handlerSuccesses)

Creates a new instance for the case when there are both handler successes and failures.

Parameters:

handlerErrors - Map of handler names to errors.

handlerSuccesses - Map of handler names to authentication successes.

AuthenticationException

public AuthenticationException(String message,
                       Map<String,Class<? extends Exception>> handlerErrors,
                       Map<String,HandlerResult> handlerSuccesses)

Creates a new instance for the case when there are both handler successes and failures and a custom error message is required.

Parameters:

handlerErrors - Map of handler names to errors.

handlerSuccesses - Map of handler names to authentication successes.

Method Detail

getHandlerErrors

public Map<String,Class<? extends Exception>> getHandlerErrors()

Gets an unmodifable map of handler names to errors.

Returns:

Immutable map of handler names to errors.

getHandlerSuccesses

public Map<String,HandlerResult> getHandlerSuccesses()

Gets an unmodifable map of handler names to authentication successes.

Returns:

Immutable map of handler names to authentication successes.