io.micronaut.security.oauth2.responses

Class ErrorResponseHttpParamsAdapter

java.lang.Object

io.micronaut.security.oauth2.responses.ErrorResponseHttpParamsAdapter

All Implemented Interfaces:

ErrorResponse

public class ErrorResponseHttpParamsAdapter
extends java.lang.Object
implements ErrorResponse

Adapts from HttpParameters to ErrorResponse.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields inherited from interface io.micronaut.security.oauth2.responses.ErrorResponse

JSON_KEY_ERROR, JSON_KEY_ERROR_DESCRIPTION, JSON_KEY_ERROR_URI, JSON_KEY_STATE

Constructor Summary

Constructors

Constructor and Description
ErrorResponseHttpParamsAdapter(io.micronaut.http.HttpParameters httpParameters) Constructs an adapter from HttpParameters to ErrorResponse.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorResponseHttpParamsAdapter

public ErrorResponseHttpParamsAdapter(io.micronaut.http.HttpParameters httpParameters)

Constructs an adapter from HttpParameters to ErrorResponse.

Parameters:

httpParameters - Http Parameters

Method Detail

getError

@Nonnull
public java.lang.String getError()

Specified by:

getError in interface ErrorResponse

Returns:

The error code

getErrorDescription

@Nullable
public java.lang.String getErrorDescription()

Specified by:

getErrorDescription in interface ErrorResponse

Returns:

Human-readable ASCII [USASCII] text providing additional information, used to assist the client developer in understanding the errorCode that occurred.

getState

@Nullable
public java.lang.String getState()

Description copied from interface: ErrorResponse

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.

Specified by:

getState in interface ErrorResponse

Returns:

OAuth 2.0 state value.

getErrorUri

@Nullable
public java.lang.String getErrorUri()

Specified by:

getErrorUri in interface ErrorResponse

Returns:

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