io.micronaut.security.oauth2.responses

Class Oauth2ErrorResponse

java.lang.Object

io.micronaut.security.oauth2.responses.Oauth2ErrorResponse

public class Oauth2ErrorResponse
extends java.lang.Object

OAuth 2.0 ErrorCode Response.

Since:

1.0.0

Author:

Sergio del Amo

See Also:

RFC 6749 - ErrorCode Response

Constructor Summary

Constructors

Constructor and Description
Oauth2ErrorResponse() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError()
java.lang.String	getErrorDescription()
java.lang.String	getErrorUri()
java.lang.String	getState() Althought the state is required if the Authorization Request included the state parameter.
static Oauth2ErrorResponse	of(ErrorResponse errorResponse) Instantiates a Oauth2ErrorResponse from a ErrorResponse.
void	setError(java.lang.String error)
void	setErrorDescription(java.lang.String errorDescription)
void	setErrorUri(java.lang.String errorUri)
void	setState(java.lang.String state)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Oauth2ErrorResponse

public Oauth2ErrorResponse()

Constructor.

Method Detail

getState

@Nullable
public java.lang.String getState()

Althought 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.

setState

public void setState(@Nullable
                     java.lang.String state)

Parameters:

state - OAuth 2.0 state value.

getError

@Nonnull
public java.lang.String getError()

Returns:

The error code

setError

public void setError(java.lang.String error)

Parameters:

error - The error code.

getErrorDescription

@Nullable
public 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.

setErrorDescription

public void setErrorDescription(@Nullable
                                java.lang.String errorDescription)

Parameters:

errorDescription - Human-readable ASCII [USASCII] text providing additional information about the errorCode.

getErrorUri

@Nullable
public java.lang.String getErrorUri()

Returns:

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

setErrorUri

public void setErrorUri(@Nullable
                        java.lang.String errorUri)

Parameters:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

of

public static Oauth2ErrorResponse of(ErrorResponse errorResponse)

Instantiates a Oauth2ErrorResponse from a ErrorResponse.

Parameters:

errorResponse - Error Response

Returns:

A Oauth2ErrorResponse