com.unboundid.directory.sdk.http.types
Class OAuth2AuthenticationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.unboundid.directory.sdk.http.types.AuthenticationException
              com.unboundid.directory.sdk.http.types.OAuth2AuthenticationException

All Implemented Interfaces:

java.io.Serializable

public class OAuth2AuthenticationException
extends AuthenticationException

Exception used to indicate authentication failed with an external identity provider while performing the OAuth 2 flow.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.unboundid.directory.sdk.http.types.AuthenticationException

ATTRIBUTE_CREATE_DENIED, BAD_CREDENTIALS, CREDENTIALS_EXPIRED, INTERNAL_ERROR, INVALID_CLIENT, INVALID_IDENTITY_PROVIDER, INVALID_REQUEST, INVALID_RESOURCE, OAUTH2_ERROR, RESOURCE_CONFLICT, USER_DISABLED, USER_LOCKED

Constructor Summary

OAuth2AuthenticationException(java.lang.String message, java.lang.String preservedState)
Constructs an OAuth2AuthenticationException with the specified message and no root cause.

OAuth2AuthenticationException(java.lang.String message, java.lang.Throwable cause, java.lang.String preservedState)
Constructs an OAuth2AuthenticationException with the specified message and root cause.

Method Summary

java.lang.String	getErrorCode() Retrieve the error code associated with this exception.
java.lang.String	getPreservedState() Retrieves the state preserved during the OAuth 2 flow.

Methods inherited from class com.unboundid.directory.sdk.http.types.AuthenticationException

addAdditionalInformation, getAdditionalInformation

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

OAuth2AuthenticationException

public OAuth2AuthenticationException(java.lang.String message,
                                     java.lang.String preservedState)

Constructs an OAuth2AuthenticationException with the specified message and no root cause.

Parameters:

message - the detail message

preservedState - the state preserved during the OAuth 2 flow or null if not available.

OAuth2AuthenticationException

public OAuth2AuthenticationException(java.lang.String message,
                                     java.lang.Throwable cause,
                                     java.lang.String preservedState)

Constructs an OAuth2AuthenticationException with the specified message and root cause.

Parameters:

message - the detail message

cause - the root cause

preservedState - the state preserved during the OAuth 2 flow or null if not available.

Method Detail

getPreservedState

public java.lang.String getPreservedState()

Retrieves the state preserved during the OAuth 2 flow.

Returns:

the state preserved during the OAuth 2 flow or null if not available.

getErrorCode

public java.lang.String getErrorCode()

Retrieve the error code associated with this exception.

Specified by:

getErrorCode in class AuthenticationException

Returns:

The error code associated with this exception.