Package org.springframework.security.oauth2.core.endpoint

Class OAuth2DeviceAuthorizationResponse

java.lang.Object

org.springframework.security.oauth2.core.endpoint.OAuth2DeviceAuthorizationResponse

public final class OAuth2DeviceAuthorizationResponse
extends Object

A representation of an OAuth 2.0 Device Authorization Response.

Since:

6.1

See Also:

• OAuth2DeviceCode
• OAuth2UserCode
• Section 3.2 Device Authorization Response

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OAuth2DeviceAuthorizationResponse.Builder	A builder for OAuth2DeviceAuthorizationResponse.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalParameters()	Returns the additional parameters returned in the response.
OAuth2DeviceCode	getDeviceCode()	Returns the Device Code.
long	getInterval()	Returns the minimum amount of time (in seconds) that the client should wait between polling requests to the token endpoint.
OAuth2UserCode	getUserCode()	Returns the User Code.
String	getVerificationUri()	Returns the end-user verification URI.
String	getVerificationUriComplete()	Returns the end-user verification URI that includes the user code.
static OAuth2DeviceAuthorizationResponse.Builder	with(String deviceCode, String userCode)	Returns a new OAuth2DeviceAuthorizationResponse.Builder, initialized with the provided device code and user code values.
static OAuth2DeviceAuthorizationResponse.Builder	with(OAuth2DeviceCode deviceCode, OAuth2UserCode userCode)	Returns a new OAuth2DeviceAuthorizationResponse.Builder, initialized with the provided device code and user code.

Methods inherited from class java.lang.Object

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

Method Details

getDeviceCode

public OAuth2DeviceCode getDeviceCode()

Returns the Device Code.

Returns:

the OAuth2DeviceCode

getUserCode

public OAuth2UserCode getUserCode()

Returns the User Code.

Returns:

the OAuth2UserCode

getVerificationUri

public String getVerificationUri()

Returns the end-user verification URI.

Returns:

the end-user verification URI

getVerificationUriComplete

public String getVerificationUriComplete()

Returns the end-user verification URI that includes the user code.

Returns:

the end-user verification URI that includes the user code

getInterval

public long getInterval()

Returns the minimum amount of time (in seconds) that the client should wait between polling requests to the token endpoint.

Returns:

the minimum amount of time between polling requests

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameters returned in the response.

Returns:

a Map of the additional parameters returned in the response, may be empty.

with

public static OAuth2DeviceAuthorizationResponse.Builder with(String deviceCode,
 String userCode)

Returns a new OAuth2DeviceAuthorizationResponse.Builder, initialized with the provided device code and user code values.

Parameters:

deviceCode - the value of the device code

userCode - the value of the user code

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

with

public static OAuth2DeviceAuthorizationResponse.Builder with(OAuth2DeviceCode deviceCode,
 OAuth2UserCode userCode)

Returns a new OAuth2DeviceAuthorizationResponse.Builder, initialized with the provided device code and user code.

Parameters:

deviceCode - the OAuth2DeviceCode

userCode - the OAuth2UserCode

Returns:

the OAuth2DeviceAuthorizationResponse.Builder