Package org.springframework.security.oauth2.server.authorization.authentication

Class OAuth2DeviceCodeAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationGrantAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2DeviceCodeAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2DeviceCodeAuthenticationToken
extends OAuth2AuthorizationGrantAuthenticationToken

An Authentication implementation for the Device Access Token Request used in the OAuth 2.0 Device Authorization Grant.

Since:

7.0

See Also:

• OAuth2AuthorizationGrantAuthenticationToken
• OAuth2DeviceCodeAuthenticationProvider
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

Authentication.Builder<B extends Authentication.Builder<B>>

Constructor Summary

Constructors

Constructor	Description
OAuth2DeviceCodeAuthenticationToken(String deviceCode, Authentication clientPrincipal, Map<String,Object> additionalParameters)	Constructs an OAuth2DeviceCodeAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getDeviceCode()	Returns the device code.

Methods inherited from class org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationGrantAuthenticationToken

getAdditionalParameters, getCredentials, getGrantType, getPrincipal

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.security.core.Authentication

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

OAuth2DeviceCodeAuthenticationToken

public OAuth2DeviceCodeAuthenticationToken(String deviceCode,
 Authentication clientPrincipal,
 @Nullable
 Map<String,Object> additionalParameters)

Constructs an OAuth2DeviceCodeAuthenticationToken using the provided parameters.

Parameters:

deviceCode - the device code

clientPrincipal - the authenticated client principal

additionalParameters - the additional parameters

Method Details

getDeviceCode

public String getDeviceCode()

Returns the device code.

Returns:

the device code