Enum Class OAuthEndpointError
- All Implemented Interfaces:
Serializable, Comparable<OAuthEndpointError>, Constable
Fixed OAuth and OpenID Connect protocol errors for endpoint and checked authorization rejections.
Unknown extension codes share one fallback and never become diagnostic text. A later release may add constants;
consuming switches should include a default branch.
- 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 ConstantDescriptionThe endpoint reported access_denied.The endpoint reported account_selection_required.The endpoint reported consent_required.The endpoint reported insufficient_scope.The endpoint reported interaction_required.The endpoint reported invalid_client.The endpoint reported invalid_grant.The endpoint reported invalid_request.The endpoint reported invalid_request_object.The endpoint reported invalid_request_uri.The endpoint reported invalid_scope.The endpoint reported invalid_token.The endpoint reported login_required.The endpoint reported registration_not_supported.The endpoint reported request_not_supported.The endpoint reported request_uri_not_supported.The endpoint reported server_error.The endpoint reported temporarily_unavailable.The endpoint reported unauthorized_client.The endpoint supplied an absent or unrecognized error code; no supplied text is retained.The endpoint reported unsupported_grant_type.The endpoint reported unsupported_response_type.The endpoint reported unsupported_token_type. -
Method Summary
Modifier and TypeMethodDescriptionstatic @NonNull OAuthEndpointErrorfromWireValue(@NonNull String wireValue) Interprets an exact wire error code without retaining supplied text.static OAuthEndpointErrorReturns the enum constant of this class with the specified name.static OAuthEndpointError[]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
-
INVALID_REQUEST
The endpoint reported invalid_request. -
UNAUTHORIZED_CLIENT
The endpoint reported unauthorized_client. -
ACCESS_DENIED
The endpoint reported access_denied. -
UNSUPPORTED_RESPONSE_TYPE
The endpoint reported unsupported_response_type. -
INVALID_SCOPE
The endpoint reported invalid_scope. -
SERVER_ERROR
The endpoint reported server_error. -
TEMPORARILY_UNAVAILABLE
The endpoint reported temporarily_unavailable. -
INVALID_CLIENT
The endpoint reported invalid_client. -
INVALID_GRANT
The endpoint reported invalid_grant. -
UNSUPPORTED_GRANT_TYPE
The endpoint reported unsupported_grant_type. -
UNSUPPORTED_TOKEN_TYPE
The endpoint reported unsupported_token_type. -
INVALID_TOKEN
The endpoint reported invalid_token. -
INSUFFICIENT_SCOPE
The endpoint reported insufficient_scope. -
LOGIN_REQUIRED
The endpoint reported login_required. -
INTERACTION_REQUIRED
The endpoint reported interaction_required. -
ACCOUNT_SELECTION_REQUIRED
The endpoint reported account_selection_required. -
CONSENT_REQUIRED
The endpoint reported consent_required. -
INVALID_REQUEST_URI
The endpoint reported invalid_request_uri. -
INVALID_REQUEST_OBJECT
The endpoint reported invalid_request_object. -
REQUEST_NOT_SUPPORTED
The endpoint reported request_not_supported. -
REQUEST_URI_NOT_SUPPORTED
The endpoint reported request_uri_not_supported. -
REGISTRATION_NOT_SUPPORTED
The endpoint reported registration_not_supported. -
UNRECOGNIZED
The endpoint supplied an absent or unrecognized error code; no supplied text is retained.
-
-
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
-
fromWireValue
Interprets an exact wire error code without retaining supplied text.- Parameters:
wireValue- supplied protocol error code- Returns:
- fixed error or the unrecognized fallback
- Throws:
NullPointerException- if the code is null- Since:
- 1.0.0
-