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

Class OAuth2DeviceAuthorizationRequestAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2DeviceAuthorizationRequestAuthenticationToken
extends AbstractAuthenticationToken

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

Since:

7.0

See Also:

• AbstractAuthenticationToken
• OAuth2ClientAuthenticationToken
• OAuth2DeviceAuthorizationRequestAuthenticationProvider
• 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
OAuth2DeviceAuthorizationRequestAuthenticationToken(Authentication clientPrincipal, String authorizationUri, Set<String> scopes, Map<String,Object> additionalParameters)	Constructs an OAuth2DeviceAuthorizationRequestAuthenticationToken using the provided parameters.
OAuth2DeviceAuthorizationRequestAuthenticationToken(Authentication clientPrincipal, Set<String> scopes, OAuth2DeviceCode deviceCode, OAuth2UserCode userCode)	Constructs an OAuth2DeviceAuthorizationRequestAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalParameters()	Returns the additional parameters.
String	getAuthorizationUri()	Returns the authorization URI.
Object	getCredentials()	The credentials that prove the principal is correct.
OAuth2DeviceCode	getDeviceCode()	Returns the device code.
Object	getPrincipal()	The identity of the principal being authenticated.
Set<String>	getScopes()	Returns the requested scope(s).
OAuth2UserCode	getUserCode()	Returns the user code.

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

OAuth2DeviceAuthorizationRequestAuthenticationToken

public OAuth2DeviceAuthorizationRequestAuthenticationToken(Authentication clientPrincipal,
 String authorizationUri,
 @Nullable
 Set<String> scopes,
 @Nullable
 Map<String,Object> additionalParameters)

Constructs an OAuth2DeviceAuthorizationRequestAuthenticationToken using the provided parameters.

Parameters:

clientPrincipal - the authenticated client principal

authorizationUri - the authorization URI

scopes - the requested scope(s)

additionalParameters - the additional parameters

OAuth2DeviceAuthorizationRequestAuthenticationToken

public OAuth2DeviceAuthorizationRequestAuthenticationToken(Authentication clientPrincipal,
 @Nullable
 Set<String> scopes,
 OAuth2DeviceCode deviceCode,
 OAuth2UserCode userCode)

Constructs an OAuth2DeviceAuthorizationRequestAuthenticationToken using the provided parameters.

Parameters:

clientPrincipal - the authenticated client principal

scopes - the requested scope(s)

deviceCode - the OAuth2DeviceCode

userCode - the OAuth2UserCode

Method Details

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

Returns:

the Principal being authenticated or the authenticated principal after authentication.

getCredentials

public Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

getAuthorizationUri

public String getAuthorizationUri()

Returns the authorization URI.

Returns:

the authorization URI

getScopes

public Set<String> getScopes()

Returns the requested scope(s).

Returns:

the requested scope(s)

getDeviceCode

public OAuth2DeviceCode getDeviceCode()

Returns the device code.

Returns:

the device code

getUserCode

public OAuth2UserCode getUserCode()

Returns the user code.

Returns:

the user code

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameters.

Returns:

the additional parameters