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

Class OAuth2DeviceAuthorizationResponse.Builder

java.lang.Object

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

Enclosing class:

OAuth2DeviceAuthorizationResponse

public static final class OAuth2DeviceAuthorizationResponse.Builder
extends Object

A builder for OAuth2DeviceAuthorizationResponse.

Method Summary

Modifier and Type	Method	Description
OAuth2DeviceAuthorizationResponse.Builder	additionalParameters(Map<String,Object> additionalParameters)	Sets the additional parameters returned in the response.
OAuth2DeviceAuthorizationResponse	build()	Builds a new OAuth2DeviceAuthorizationResponse.
OAuth2DeviceAuthorizationResponse.Builder	expiresIn(long expiresIn)	Sets the lifetime (in seconds) of the device code and user code.
OAuth2DeviceAuthorizationResponse.Builder	interval(long interval)	Sets the minimum amount of time (in seconds) that the client should wait between polling requests to the token endpoint.
OAuth2DeviceAuthorizationResponse.Builder	verificationUri(String verificationUri)	Sets the end-user verification URI.
OAuth2DeviceAuthorizationResponse.Builder	verificationUriComplete(String verificationUriComplete)	Sets the end-user verification URI that includes the user code.

Methods inherited from class java.lang.Object

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

Method Details

verificationUri

public OAuth2DeviceAuthorizationResponse.Builder verificationUri(String verificationUri)

Sets the end-user verification URI.

Parameters:

verificationUri - the end-user verification URI

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

verificationUriComplete

public OAuth2DeviceAuthorizationResponse.Builder verificationUriComplete(String verificationUriComplete)

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

Parameters:

verificationUriComplete - the end-user verification URI that includes the user code

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

expiresIn

public OAuth2DeviceAuthorizationResponse.Builder expiresIn(long expiresIn)

Sets the lifetime (in seconds) of the device code and user code.

Parameters:

expiresIn - the lifetime (in seconds) of the device code and user code

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

interval

public OAuth2DeviceAuthorizationResponse.Builder interval(long interval)

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

Parameters:

interval - the minimum amount of time between polling requests

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

additionalParameters

public OAuth2DeviceAuthorizationResponse.Builder additionalParameters(Map<String,Object> additionalParameters)

Sets the additional parameters returned in the response.

Parameters:

additionalParameters - the additional parameters returned in the response

Returns:

the OAuth2DeviceAuthorizationResponse.Builder

build

public OAuth2DeviceAuthorizationResponse build()

Builds a new OAuth2DeviceAuthorizationResponse.

Returns:

a OAuth2DeviceAuthorizationResponse