Package 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:

Serializable

Direct Known Subclasses:

AuthenticationException, PreventedException

public class RootCasException
extends 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

Method Summary

Modifier and Type	Method	Description
List<Object>	getArgs()
String	getCode()	If there is a chained exception it recursively calls getCode() on the cause of the chained exception rather than the returning the code itself.
static RootCasException	withCode(String code)	With code.

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

withCode

public static RootCasException withCode(String code)

With code.

Parameters:

code - the code

Returns:

the root cas exception

getCode

public String getCode()

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

Returns:

Returns the code.

getArgs

public List<Object> getArgs()