org.jasig.cas.authentication.handler

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jasig.cas.authentication.RootCasException

org.jasig.cas.authentication.handler.AuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadCredentialsAuthenticationException, BlockedCredentialsAuthenticationException, UncategorizedAuthenticationException, UnsupportedCredentialsException

public abstract class AuthenticationException
extends RootCasException

The most generic type of authentication exception that one can catch if not sure what specific implementation will be thrown. Top of the tree of all other AuthenticationExceptions.

Since:

3.0

Author:

Scott Battaglia

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationException(String code)
AuthenticationException(String code, String msg)
AuthenticationException(String code, String msg, String type)
AuthenticationException(String code, Throwable throwable)

Method Summary

Methods

Modifier and Type	Method and Description
String	getType() Method to return the error type of this exception.

Methods inherited from class org.jasig.cas.authentication.RootCasException

getCode, toString

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationException

public AuthenticationException(String code)

AuthenticationException

public AuthenticationException(String code,
                       String msg)

AuthenticationException

public AuthenticationException(String code,
                       String msg,
                       String type)

Parameters:

type - The type of the error message that caused the exception to be thrown. By default, all errors are considered of error.

code - the exception code

msg - the error message

AuthenticationException

public AuthenticationException(String code,
                       Throwable throwable)

Parameters:

code - the exception code

throwable - the exception that originally caused the authentication failure

Method Detail

getType

public final String getType()

Method to return the error type of this exception.

Returns:

the String identifier for the cause of this error.