org.apereo.cas.authentication

Class RootCasException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apereo.cas.authentication.RootCasException

All Implemented Interfaces:

java.io.Serializable

public abstract class RootCasException
extends java.lang.RuntimeException

Generic CAS exception that sits at the top of the exception hierarchy. Provides unified logic around retrieval and configuration of exception codes that may be mapped inside an external resource bundle for internationalization of error messages.

Since:

4.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RootCasException(java.lang.String code) Constructor that takes a code description of the error along with the exception msg generally for logging purposes.
RootCasException(java.lang.String code, java.lang.String msg) Constructs a new exception with the code identifying the exception and the error message.
RootCasException(java.lang.String code, java.lang.Throwable throwable) Constructs a new exception with the code identifying the exception and the original throwable.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
java.lang.String	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

RootCasException

public RootCasException(java.lang.String code)

Constructor that takes a code description of the error along with the exception msg generally for logging purposes. These codes normally have a corresponding entries in the messages file for the internationalization of error messages.

Parameters:

code - the code to describe what type of exception this is.

RootCasException

public RootCasException(java.lang.String code,
                        java.lang.String msg)

Constructs a new exception with the code identifying the exception and the error message.

Parameters:

code - the code to describe what type of exception this is.

msg - The error message associated with this exception for additional logging purposes.

RootCasException

public RootCasException(java.lang.String code,
                        java.lang.Throwable throwable)

Constructs a new exception with the code identifying the exception and the original throwable.

Parameters:

code - the code to describe what type of exception this is.

throwable - the original exception we are chaining.

Method Detail

getCode

public java.lang.String getCode()

Returns:

Returns the code. If there is a chained exception it recursively calls getCode() on the cause of the chained exception rather than the returning the code itself.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable