Package org.apereo.cas.authentication

Class PrincipalException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apereo.cas.authentication.RootCasException

org.apereo.cas.authentication.AuthenticationException

org.apereo.cas.authentication.PrincipalException

All Implemented Interfaces:

Serializable

public class PrincipalException
extends AuthenticationException

Describes a principal resolution error, which is a subcategory of authentication error. Principal resolution necessarily happens after successful authentication for a given credential.

Since:

4.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PrincipalException(String message, Map<String,Throwable> handlerErrors, Map<String,AuthenticationHandlerExecutionResult> handlerSuccesses)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class org.apereo.cas.authentication.AuthenticationException

getHandlerErrors, getHandlerSuccesses

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

getArgs, withCode

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

Constructor Details

PrincipalException

public PrincipalException(String message,
 Map<String,Throwable> handlerErrors,
 Map<String,AuthenticationHandlerExecutionResult> handlerSuccesses)

Creates a new instance.

Parameters:

message - Error message.

handlerErrors - Map of handler names to errors.

handlerSuccesses - Map of handler names to authentication successes.

Method Details

getCode

public String getCode()

Description copied from class: RootCasException

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

Overrides:

getCode in class RootCasException

Returns:

Returns the code.