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

Class OAuth2DeviceVerificationAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2DeviceVerificationAuthenticationToken
extends AbstractAuthenticationToken

An Authentication implementation for the Device Verification Request (submission of the user code) used in the OAuth 2.0 Device Authorization Grant.

Since:

7.0

See Also:

• AbstractAuthenticationToken
• OAuth2DeviceVerificationAuthenticationProvider
• 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
OAuth2DeviceVerificationAuthenticationToken(Authentication principal, String userCode, String clientId)	Constructs an OAuth2DeviceVerificationAuthenticationToken using the provided parameters.
OAuth2DeviceVerificationAuthenticationToken(Authentication principal, String userCode, Map<String,Object> additionalParameters)	Constructs an OAuth2DeviceVerificationAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalParameters()	Returns the additional parameters.
String	getClientId()	Returns the client identifier.
Object	getCredentials()	The credentials that prove the principal is correct.
Object	getPrincipal()	The identity of the principal being authenticated.
String	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

OAuth2DeviceVerificationAuthenticationToken

public OAuth2DeviceVerificationAuthenticationToken(Authentication principal,
 String userCode,
 @Nullable
 Map<String,Object> additionalParameters)

Constructs an OAuth2DeviceVerificationAuthenticationToken using the provided parameters.

Parameters:

principal - the Principal (Resource Owner)

userCode - the user code associated with the device authorization response

additionalParameters - the additional parameters

OAuth2DeviceVerificationAuthenticationToken

public OAuth2DeviceVerificationAuthenticationToken(Authentication principal,
 String userCode,
 String clientId)

Constructs an OAuth2DeviceVerificationAuthenticationToken using the provided parameters.

Parameters:

principal - the Principal (Resource Owner)

userCode - the user code associated with the device authorization response

clientId - the client identifier

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

getUserCode

public String getUserCode()

Returns the user code.

Returns:

the user code

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameters.

Returns:

the additional parameters, or an empty Map if not available

getClientId

public String getClientId()

Returns the client identifier.

Returns:

the client identifier