Package org.springframework.security.oauth2.client.endpoint

Class DefaultPasswordTokenResponseClient

java.lang.Object
org.springframework.security.oauth2.client.endpoint.DefaultPasswordTokenResponseClient
All Implemented Interfaces:
OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest>
@Deprecated(since="5.8", forRemoval=true) public final class DefaultPasswordTokenResponseClient extends Object implements OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest>
Deprecated, for removal: This API element is subject to removal in a future version.
The OAuth 2.0 Security Best Current Practice disallows the use of the Resource Owner Password Credentials grant. See reference OAuth 2.0 Security Best Current Practice.
The default implementation of an OAuth2AccessTokenResponseClient for the password grant. This implementation uses a RestOperations when requesting an access token credential at the Authorization Server's Token Endpoint.
Since:
5.2
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultPasswordTokenResponseClient()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    OAuth2AccessTokenResponse
    getTokenResponse(OAuth2PasswordGrantRequest passwordGrantRequest)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.
    void
    setRequestEntityConverter(org.springframework.core.convert.converter.Converter<OAuth2PasswordGrantRequest,org.springframework.http.RequestEntity<?>> requestEntityConverter)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the Converter used for converting the OAuth2PasswordGrantRequest to a RequestEntity representation of the OAuth 2.0 Access Token Request.
    void
    setRestOperations(org.springframework.web.client.RestOperations restOperations)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the RestOperations used when requesting the OAuth 2.0 Access Token Response.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • DefaultPasswordTokenResponseClient

      public DefaultPasswordTokenResponseClient()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getTokenResponse

      public OAuth2AccessTokenResponse getTokenResponse(OAuth2PasswordGrantRequest passwordGrantRequest)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OAuth2AccessTokenResponseClient
      Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.
      Specified by:
      getTokenResponse in interface OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest>
      Parameters:
      passwordGrantRequest - the authorization grant request that contains the authorization grant credential
      Returns:
      an OAuth2AccessTokenResponse that contains the access token credential

    • setRequestEntityConverter

      public void setRequestEntityConverter(org.springframework.core.convert.converter.Converter<OAuth2PasswordGrantRequest,org.springframework.http.RequestEntity<?>> requestEntityConverter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the Converter used for converting the OAuth2PasswordGrantRequest to a RequestEntity representation of the OAuth 2.0 Access Token Request.
      Parameters:
      requestEntityConverter - the Converter used for converting to a RequestEntity representation of the Access Token Request

    • setRestOperations

      public void setRestOperations(org.springframework.web.client.RestOperations restOperations)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the RestOperations used when requesting the OAuth 2.0 Access Token Response.

      NOTE: At a minimum, the supplied restOperations must be configured with the following:

      1. HttpMessageConverter's - FormHttpMessageConverter and OAuth2AccessTokenResponseHttpMessageConverter
      2. ResponseErrorHandler - OAuth2ErrorResponseErrorHandler
      Parameters:
      restOperations - the RestOperations used when requesting the Access Token Response