Interface OAuth2AccessTokenResponseClient<T extends AbstractOAuth2AuthorizationGrantRequest>

All Known Implementing Classes:
AbstractRestClientOAuth2AccessTokenResponseClient, DefaultAuthorizationCodeTokenResponseClient, DefaultClientCredentialsTokenResponseClient, DefaultJwtBearerTokenResponseClient, DefaultPasswordTokenResponseClient, DefaultRefreshTokenTokenResponseClient, DefaultTokenExchangeTokenResponseClient, RestClientAuthorizationCodeTokenResponseClient, RestClientClientCredentialsTokenResponseClient, RestClientJwtBearerTokenResponseClient, RestClientRefreshTokenTokenResponseClient, RestClientTokenExchangeTokenResponseClient
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public interface OAuth2AccessTokenResponseClient<T extends AbstractOAuth2AuthorizationGrantRequest>
A strategy for "exchanging" an authorization grant credential (e.g. an Authorization Code) for an access token credential at the Authorization Server's Token Endpoint.
Since:
5.0
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    getTokenResponse(T authorizationGrantRequest)
    Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.
  • Method Details

    • getTokenResponse

      OAuth2AccessTokenResponse getTokenResponse(T authorizationGrantRequest)
      Exchanges the authorization grant credential, provided in the authorization grant request, for an access token credential at the Authorization Server's Token Endpoint.
      Parameters:
      authorizationGrantRequest - the authorization grant request that contains the authorization grant credential
      Returns:
      an OAuth2AccessTokenResponse that contains the access token credential
      Throws:
      OAuth2AuthorizationException - if an error occurs while attempting to exchange for the access token credential