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, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer
public class OAuth2DeviceAuthorizationRequestAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken
An Authentication implementation for the Device Authorization Request used in the OAuth 2.0 Device Authorization Grant.
Since:
7.0
See Also:

  • Nested Class Summary

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

    org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

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

    org.springframework.security.core.Authentication.Builder<B extends org.springframework.security.core.Authentication.Builder<B>>

  • Constructor Summary

    Constructors
    Constructor
    Description
    OAuth2DeviceAuthorizationRequestAuthenticationToken(org.springframework.security.core.Authentication clientPrincipal, String authorizationUri, Set<String> scopes, Map<String,Object> additionalParameters)
    Constructs an OAuth2DeviceAuthorizationRequestAuthenticationToken using the provided parameters.
    OAuth2DeviceAuthorizationRequestAuthenticationToken(org.springframework.security.core.Authentication clientPrincipal, Set<String> scopes, org.springframework.security.oauth2.core.OAuth2DeviceCode deviceCode, org.springframework.security.oauth2.core.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()
     
    org.springframework.security.oauth2.core.OAuth2DeviceCode
    getDeviceCode()
    Returns the device code.
    Object
    getPrincipal()
     
    Set<String>
    getScopes()
    Returns the requested scope(s).
    org.springframework.security.oauth2.core.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(org.springframework.security.core.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(org.springframework.security.core.Authentication clientPrincipal, @Nullable Set<String> scopes, org.springframework.security.oauth2.core.OAuth2DeviceCode deviceCode, org.springframework.security.oauth2.core.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()

    • getCredentials

      public Object getCredentials()

    • 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 org.springframework.security.oauth2.core.OAuth2DeviceCode getDeviceCode()
      Returns the device code.
      Returns:
      the device code

    • getUserCode

      public org.springframework.security.oauth2.core.OAuth2UserCode getUserCode()
      Returns the user code.
      Returns:
      the user code

    • getAdditionalParameters

      public Map<String,Object> getAdditionalParameters()
      Returns the additional parameters.
      Returns:
      the additional parameters