Enum Class OAuthException.Reason
- All Implemented Interfaces:
Serializable, Comparable<OAuthException.Reason>, Constable
- Enclosing class:
OAuthException
Reasons for OAuth failures. New reasons may be added in a later release.
- Since:
- 1.0.0
- Author:
- Mark Allen
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionA cache attempt ceiling temporarily held back the request.The callback reported an authorization error.The browser binding does not match the saved pending authorization.A callback has duplicate, conflicting or malformed parameters.The trusted callback route differs from the registered redirect URI.The in-memory store has reached a configured live capacity.The asserted endpoint or its authentication metadata does not match the configured trust.The assertion private and public keys do not form a pair.The configured assertion key could not be selected.The configured assertion could not be signed or has invalid timing.The pending record belongs to another client.A metadata or token JSON document is malformed.The token or revocation endpoint reported an OAuth error.An endpoint returned an unexpected status or media type.The default HTTP client could not be constructed.A thread was interrupted during a network request.The pending record belongs to another issuer.A required callback issuer is missing.The application issuer policy is unavailable.The endpoint pair changed while an authorization was pending.The metadata issuer or an endpoint is unsafe or mismatched.A network request failed or timed out.The authenticated pending record has expired.The sealed pending record is invalid or cannot be opened.No pending record was found in the store.The pending-authorization store failed or exceeded the remaining operation budget.An authorization server does not advertise required PKCE S256 support.The endpoint redirected a request carrying credentials; the redirect was not followed.The callback delivery mode differs from the pending request.The callback state is absent or differs from the pending state.A token cannot be returned because its lifetime has already ended.The endpoint response exceeded its configured body limit.A successful endpoint response lacked one permitted JSON media type. -
Method Summary
Modifier and TypeMethodDescriptionstatic OAuthException.ReasonReturns the enum constant of this class with the specified name.static OAuthException.Reason[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
AUTHORIZATION_ERROR
The callback reported an authorization error. -
ENDPOINT_ERROR
The token or revocation endpoint reported an OAuth error. -
STATE_MISMATCH
The callback state is absent or differs from the pending state. -
BROWSER_BINDING_MISMATCH
The browser binding does not match the saved pending authorization. -
PENDING_AUTHORIZATION_INVALID
The sealed pending record is invalid or cannot be opened. -
PENDING_AUTHORIZATION_EXPIRED
The authenticated pending record has expired. -
PENDING_AUTHORIZATION_NOT_FOUND
No pending record was found in the store. -
CLIENT_MISMATCH
The pending record belongs to another client. -
ISSUER_MISMATCH
The pending record belongs to another issuer. -
ISSUER_MISSING
A required callback issuer is missing. -
CALLBACK_URI_MISMATCH
The trusted callback route differs from the registered redirect URI. -
RESPONSE_MODE_MISMATCH
The callback delivery mode differs from the pending request. -
METADATA_INVALID
The metadata issuer or an endpoint is unsafe or mismatched. -
METADATA_ENDPOINT_DRIFT
The endpoint pair changed while an authorization was pending. -
PKCE_UNSUPPORTED
An authorization server does not advertise required PKCE S256 support. -
TOKEN_EXPIRED
A token cannot be returned because its lifetime has already ended. -
CAPACITY_EXCEEDED
The in-memory store has reached a configured live capacity. -
PENDING_AUTHORIZATION_STORE_UNAVAILABLE
The pending-authorization store failed or exceeded the remaining operation budget. -
CALLBACK_MALFORMED
A callback has duplicate, conflicting or malformed parameters. -
DOCUMENT_MALFORMED
A metadata or token JSON document is malformed. -
ENDPOINT_RESPONSE_MALFORMED
An endpoint returned an unexpected status or media type. -
REDIRECT_NOT_FOLLOWED
The endpoint redirected a request carrying credentials; the redirect was not followed. -
TOO_LARGE
The endpoint response exceeded its configured body limit. -
UNEXPECTED_CONTENT_TYPE
A successful endpoint response lacked one permitted JSON media type. -
NETWORK_FAILURE
A network request failed or timed out. -
INTERRUPTED
A thread was interrupted during a network request. -
ATTEMPT_LIMIT
A cache attempt ceiling temporarily held back the request. -
HTTP_CLIENT_UNAVAILABLE
The default HTTP client could not be constructed. -
CLIENT_ASSERTION_KEY_UNAVAILABLE
The configured assertion key could not be selected. -
CLIENT_ASSERTION_SIGNING_FAILED
The configured assertion could not be signed or has invalid timing. -
CLIENT_ASSERTION_KEY_PAIR_MISMATCH
The assertion private and public keys do not form a pair. -
CLIENT_ASSERTION_ENDPOINT_MISMATCH
The asserted endpoint or its authentication metadata does not match the configured trust. -
ISSUER_POLICY_UNAVAILABLE
The application issuer policy is unavailable.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-