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, Authentication, CredentialsContainer
public class OAuth2PushedAuthorizationRequestAuthenticationToken extends AbstractAuthenticationToken
An Authentication implementation for the OAuth 2.0 Pushed Authorization Request used in the Authorization Code Grant.
Since:
7.0
See Also:

  • Constructor Details

    • OAuth2PushedAuthorizationRequestAuthenticationToken

      public OAuth2PushedAuthorizationRequestAuthenticationToken(String authorizationUri, String clientId, 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, 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()
      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

    • 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