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

Class OAuth2PushedAuthorizationRequestAuthenticationToken

java.lang.Object
org.springframework.security.authentication.AbstractAuthenticationToken
org.springframework.security.oauth2.server.authorization.authentication.OAuth2PushedAuthorizationRequestAuthenticationToken
All Implemented Interfaces:
Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer
public class OAuth2PushedAuthorizationRequestAuthenticationToken extends org.springframework.security.authentication.AbstractAuthenticationToken
An Authentication implementation for the OAuth 2.0 Pushed Authorization Request used in the Authorization Code 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
    OAuth2PushedAuthorizationRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, String redirectUri, String state, Set<String> scopes, Map<String,Object> additionalParameters)
    Constructs an OAuth2PushedAuthorizationRequestAuthenticationToken using the provided parameters.
    OAuth2PushedAuthorizationRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, String requestUri, Instant requestUriExpiresAt, String redirectUri, String state, Set<String> scopes)
    Constructs an OAuth2PushedAuthorizationRequestAuthenticationToken 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.
    String
    getClientId()
    Returns the client identifier.
    Object
    getCredentials()
     
    Object
    getPrincipal()
     
    String
    getRedirectUri()
    Returns the redirect uri.
    String
    getRequestUri()
    Returns the request_uri corresponding to the authorization request posted.
    Instant
    getRequestUriExpiresAt()
    Returns the expiration time on or after which the request_uri MUST NOT be accepted.
    Set<String>
    getScopes()
    Returns the requested (or authorized) scope(s).
    String
    getState()
    Returns the state.

    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

    • OAuth2PushedAuthorizationRequestAuthenticationToken

      public OAuth2PushedAuthorizationRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, @Nullable String redirectUri, @Nullable String state, @Nullable Set<String> scopes, @Nullable Map<String,Object> additionalParameters)
      Constructs an OAuth2PushedAuthorizationRequestAuthenticationToken using the provided parameters.
      Parameters:
      authorizationUri - the authorization URI
      clientId - the client identifier
      principal - the authenticated client principal
      redirectUri - the redirect uri
      state - the state
      scopes - the requested scope(s)
      additionalParameters - the additional parameters

    • OAuth2PushedAuthorizationRequestAuthenticationToken

      public OAuth2PushedAuthorizationRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, String requestUri, Instant requestUriExpiresAt, @Nullable String redirectUri, @Nullable String state, @Nullable Set<String> scopes)
      Constructs an OAuth2PushedAuthorizationRequestAuthenticationToken using the provided parameters.
      Parameters:
      authorizationUri - the authorization URI
      clientId - the client identifier
      principal - the authenticated client principal
      requestUri - the request_uri corresponding to the authorization request posted
      requestUriExpiresAt - the expiration time on or after which the request_uri MUST NOT be accepted
      redirectUri - the redirect uri
      state - the state
      scopes - the authorized scope(s)

  • Method Details

    • getRequestUri

      @Nullable public String getRequestUri()
      Returns the request_uri corresponding to the authorization request posted.
      Returns:
      the request_uri corresponding to the authorization request posted

    • getRequestUriExpiresAt

      @Nullable public Instant getRequestUriExpiresAt()
      Returns the expiration time on or after which the request_uri MUST NOT be accepted.
      Returns:
      the expiration time on or after which the request_uri MUST NOT be accepted

    • getPrincipal

      public Object getPrincipal()

    • getCredentials

      public Object getCredentials()

    • getAuthorizationUri

      public String getAuthorizationUri()
      Returns the authorization URI.
      Returns:
      the authorization URI

    • getClientId

      public String getClientId()
      Returns the client identifier.
      Returns:
      the client identifier

    • getRedirectUri

      @Nullable public String getRedirectUri()
      Returns the redirect uri.
      Returns:
      the redirect uri

    • getState

      @Nullable public String getState()
      Returns the state.
      Returns:
      the state

    • getScopes

      public Set<String> getScopes()
      Returns the requested (or authorized) scope(s).
      Returns:
      the requested (or authorized) scope(s), or an empty Set if not available

    • getAdditionalParameters

      public Map<String,Object> getAdditionalParameters()
      Returns the additional parameters.
      Returns:
      the additional parameters, or an empty Map if not available