io.micronaut.security.oauth2.responses

Class AccessTokenResponse

java.lang.Object

io.micronaut.security.oauth2.responses.AccessTokenResponse

Direct Known Subclasses:

IdTokenAccessTokenResponse

@Introspected
public class AccessTokenResponse
extends java.lang.Object

Represent the answer of an authorization server in response to a valid and authorized access token request.

Since:

1.0.0

Author:

Sergio del Amo

See Also:

Constructor Summary

Constructors

Constructor and Description
AccessTokenResponse() Instantiates Access Token Response.

Method Summary

Modifier and Type	Method and Description
protected static boolean	containsRequiredParameters(java.util.Map<java.lang.String,java.lang.Object> m)
java.lang.String	getAccessToken()
java.lang.Integer	getExpiresIn()
java.lang.String	getRefreshToken()
java.lang.String	getScope()
java.lang.String	getTokenType()
static AccessTokenResponse	of(java.util.Map<java.lang.String,java.lang.Object> m)
void	populateWithMap(java.util.Map<java.lang.String,java.lang.Object> m)
void	setAccessToken(java.lang.String accessToken)
void	setExpiresIn(java.lang.Integer expiresIn)
void	setRefreshToken(java.lang.String refreshToken)
void	setScope(java.lang.String scope)
void	setTokenType(java.lang.String tokenType)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenResponse

public AccessTokenResponse()

Instantiates Access Token Response.

Method Detail

getAccessToken

@Nonnull
public java.lang.String getAccessToken()

Returns:

The access token issued by the authorization server.

setAccessToken

public void setAccessToken(@Nonnull
                           java.lang.String accessToken)

Parameters:

accessToken - The access token issued by the authorization server.

getTokenType

@Nonnull
public java.lang.String getTokenType()

Returns:

The type of the token issued.

setTokenType

public void setTokenType(@Nonnull
                         java.lang.String tokenType)

Parameters:

tokenType - The type of the token issued.

getExpiresIn

@Nullable
public java.lang.Integer getExpiresIn()

Returns:

The lifetime in seconds of the access token.

setExpiresIn

public void setExpiresIn(@Nullable
                         java.lang.Integer expiresIn)

Parameters:

expiresIn - The lifetime in seconds of the access token.

getScope

@Nullable
public java.lang.String getScope()

Returns:

Scope of the access token.

setScope

public void setScope(@Nullable
                     java.lang.String scope)

Parameters:

scope - Scope of the access token.

getRefreshToken

@Nullable
public java.lang.String getRefreshToken()

Returns:

The refresh token, which can be used to obtain new access tokens using the same authorization grant.

setRefreshToken

public void setRefreshToken(@Nullable
                            java.lang.String refreshToken)

Parameters:

refreshToken - The refresh token, which can be used to obtain new access tokens using the same authorization grant.

of

@Nullable
public static AccessTokenResponse of(@Nonnull
                                               java.util.Map<java.lang.String,java.lang.Object> m)

Parameters:

m - A Map e.g a JSON response.

Returns:

null if the required properties are not found in the map, an AccessTokenResponse otherwise.

populateWithMap

public void populateWithMap(@Nonnull
                            java.util.Map<java.lang.String,java.lang.Object> m)

Parameters:

m - A Map e.g a JSON response.

containsRequiredParameters

protected static boolean containsRequiredParameters(@Nonnull
                                                    java.util.Map<java.lang.String,java.lang.Object> m)

Parameters:

m - A Map e.g a JSON response.

Returns:

true if the map contains every required parameter.