Package io.micronaut.security.errors
Interface ErrorResponse
-
- All Known Implementing Classes:
OauthErrorResponseException
public interface ErrorResponseOAuth 2.0 Error Response.- Since:
- 1.2.0
- See Also:
- Obtaining Authorization - Error Response
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJSON_KEY_ERRORstatic java.lang.StringJSON_KEY_ERROR_DESCRIPTIONstatic java.lang.StringJSON_KEY_ERROR_URIstatic java.lang.StringJSON_KEY_STATE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ErrorCodegetError()java.lang.StringgetErrorDescription()java.lang.StringgetErrorUri()
-
-
-
Field Detail
-
JSON_KEY_ERROR
static final java.lang.String JSON_KEY_ERROR
- See Also:
- Constant Field Values
-
JSON_KEY_STATE
static final java.lang.String JSON_KEY_STATE
- See Also:
- Constant Field Values
-
JSON_KEY_ERROR_DESCRIPTION
static final java.lang.String JSON_KEY_ERROR_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_KEY_ERROR_URI
static final java.lang.String JSON_KEY_ERROR_URI
- See Also:
- Constant Field Values
-
-
Method Detail
-
getError
@NonNull ErrorCode getError()
- Returns:
- The error code
-
getErrorDescription
@Nullable java.lang.String getErrorDescription()
- Returns:
- Human-readable ASCII [USASCII] text providing additional information, used to assist the client developer in understanding the errorCode that occurred.
-
getErrorUri
@Nullable java.lang.String getErrorUri()
- Returns:
- URI identifying a human-readable web page with information about the errorCode
-
-