io.micronaut.security.errors

Interface ErrorResponse

All Known Subinterfaces:

AuthorizationErrorResponse

All Known Implementing Classes:

DefaultAuthorizationErrorResponse, OauthErrorResponseException

public interface ErrorResponse

OAuth 2.0 Error Response.

Since:

1.2.0

Author:

Sergio del Amo

See Also:

Obtaining Authorization - Error Response

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_KEY_ERROR
static java.lang.String	JSON_KEY_ERROR_DESCRIPTION
static java.lang.String	JSON_KEY_ERROR_URI
static java.lang.String	JSON_KEY_STATE

Method Summary

Modifier and Type	Method and Description
ErrorCode	getError()
java.lang.String	getErrorDescription()
java.lang.String	getErrorUri()

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