PrincipalException (cas-server-core-api-authentication 6.1.2 API)

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:

java.io.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(java.lang.String message, java.util.Map<java.lang.String,java.lang.Throwable> handlerErrors, java.util.Map<java.lang.String,AuthenticationHandlerExecutionResult> handlerSuccesses)`	Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

java.lang.String getCode()
- 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
  - PrincipalException
```
public PrincipalException(java.lang.String message,
                          java.util.Map<java.lang.String,java.lang.Throwable> handlerErrors,
                          java.util.Map<java.lang.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 Detail
  - getCode
```
public java.lang.String getCode()
```
    Overrides:
    
    getCode in class RootCasException
    
    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.