io.micronaut.security.oauth2.responses

Interface ErrorResponse

All Known Implementing Classes:

ErrorResponseHttpParamsAdapter, ErrorResponseMapAdapter

public interface ErrorResponse

OAuth 2.0 Error Response.

Since:

1.0.0

Author:

Sergio del Amo

See Also:

Authentication 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
java.lang.String	getError()
java.lang.String	getErrorDescription()
java.lang.String	getErrorUri()
java.lang.String	getState() Although the state is required if the Authorization Request included the state parameter.

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
java.lang.String 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.

getState

@Nullable
java.lang.String getState()

Although the state is required if the Authorization Request included the state parameter. it is set to nullable because it is possible to send authorization requests without including a state.

Returns:

OAuth 2.0 state value.

getErrorUri

@Nullable
java.lang.String getErrorUri()

Returns:

URI identifying a human-readable web page with information about the errorCode