Package org.apache.juneau.rest.auth.oauth.flow

Class OAuthFlowException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.rest.auth.oauth.flow.OAuthFlowException

All Implemented Interfaces:

Serializable

public class OAuthFlowException
extends RuntimeException

Runtime exception thrown by any OAuth flow helper when the IdP rejects the request, the HTTP round-trip fails, or the response can't be parsed.

Unchecked because flow acquisition is typically called from startup or service-initialization code where checked exceptions would bloat call sites.

Since:

10.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OAuthFlowException(String msg)	Constructor.
OAuthFlowException(String msg, String errorCode)	Constructor carrying the OAuth error code returned by the IdP (RFC 6749 §5.2).
OAuthFlowException(String msg, Throwable cause)	Constructor.

Method Summary

Modifier and Type	Method	Description
Optional<String>	errorCode()	Returns the OAuth error code the IdP returned, if this exception represents a token-endpoint error response (RFC 6749 §5.2).

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 Details

OAuthFlowException

public OAuthFlowException(String msg)

Constructor.

Parameters:

msg - The detail message. May be null.

OAuthFlowException

public OAuthFlowException(String msg,
 Throwable cause)

Constructor.

Parameters:

msg - The detail message. May be null.

cause - The cause. May be null.

OAuthFlowException

public OAuthFlowException(String msg,
 String errorCode)

Constructor carrying the OAuth error code returned by the IdP (RFC 6749 §5.2).

Parameters:

msg - The detail message. May be null.

errorCode - The OAuth error code (e.g. "invalid_grant"). May be null.

Method Details

errorCode

public Optional<String> errorCode()

Returns the OAuth error code the IdP returned, if this exception represents a token-endpoint error response (RFC 6749 §5.2).

Returns:

The error code (e.g. "invalid_grant"), or Optional.empty() if not an IdP error response.