io.micronaut.security.oauth2.responses

Class Oauth2AuthenticationResponse

java.lang.Object

io.micronaut.security.oauth2.responses.AbstractAuthenticationResponse

io.micronaut.security.oauth2.responses.Oauth2AuthenticationResponse

All Implemented Interfaces:

AuthenticationResponse

public class Oauth2AuthenticationResponse
extends AbstractAuthenticationResponse

OAuth 2.0 authorization response.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

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

KEY_CODE, KEY_STATE

Constructor Summary

Constructors

Constructor and Description
Oauth2AuthenticationResponse(StateSerDes stateSerDes) Construct authorization response object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode()
java.lang.String	getStateValue() If the initial request contained a state parameter, the response must also include the exact value from the request.
void	setCode(java.lang.String code) Set an authorization code.
void	setState(java.lang.String state) After the state has been retrieved, further calls to this method will not be reflected in the execution of AbstractAuthenticationResponse.getState().

Methods inherited from class io.micronaut.security.oauth2.responses.AbstractAuthenticationResponse

getState

Methods inherited from class java.lang.Object

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

Constructor Detail

Oauth2AuthenticationResponse

public Oauth2AuthenticationResponse(StateSerDes stateSerDes)

Construct authorization response object.

Parameters:

stateSerDes - The state serdes

Method Detail

getStateValue

@Nullable
public java.lang.String getStateValue()

If the initial request contained a state parameter, the response must also include the exact value from the request. The client will be using this to associate this response with the initial request.

Specified by:

getStateValue in class AbstractAuthenticationResponse

Returns:

state parameter.

setState

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

After the state has been retrieved, further calls to this method will not be reflected in the execution of AbstractAuthenticationResponse.getState().

Parameters:

state - Set state.

getCode

@Nonnull
public java.lang.String getCode()

Returns:

An authorization code which the client will later exchange for an access token.

setCode

public void setCode(@Nonnull
                    java.lang.String code)

Set an authorization code.

Parameters:

code - authorization code.