com.aspc.cms.rest.plugin.oidc

Class OidcTokenExchangeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.aspc.cms.rest.plugin.oidc.OidcTokenExchangeException

All Implemented Interfaces:

java.io.Serializable

public class OidcTokenExchangeException
extends java.lang.Exception

Exception thrown when a token exchange with Cognito's /oauth2/token endpoint fails.

Captures the Cognito error code (e.g. invalid_grant) and the human-readable error description returned in the response body.

Author:

Claude

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OidcTokenExchangeException(java.lang.String errorCode, java.lang.String errorDescription) Constructs a new OidcTokenExchangeException.
OidcTokenExchangeException(java.lang.String message, java.lang.Throwable cause) Constructs a new OidcTokenExchangeException with a cause.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Returns the OAuth2 error code from Cognito.
java.lang.String	getErrorDescription() Returns the human-readable error description from Cognito.

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

OidcTokenExchangeException

public OidcTokenExchangeException(@Nonnull
                                  java.lang.String errorCode,
                                  @Nullable
                                  java.lang.String errorDescription)

Constructs a new OidcTokenExchangeException.

Parameters:

errorCode - the OAuth2 error code from Cognito (e.g. invalid_grant)

errorDescription - the human-readable error description, or null

OidcTokenExchangeException

public OidcTokenExchangeException(@Nonnull
                                  java.lang.String message,
                                  @Nonnull
                                  java.lang.Throwable cause)

Constructs a new OidcTokenExchangeException with a cause.

Parameters:

message - the error message

cause - the underlying cause

Method Detail

getErrorCode

@CheckReturnValue
 @Nonnull
public java.lang.String getErrorCode()

Returns the OAuth2 error code from Cognito.

Returns:

the error code

getErrorDescription

@CheckReturnValue
 @Nullable
public java.lang.String getErrorDescription()

Returns the human-readable error description from Cognito.

Returns:

the error description, or null