Package org.springframework.security.oauth2.client

Interface OAuth2AuthorizedClientService

All Known Implementing Classes:
InMemoryOAuth2AuthorizedClientService, JdbcOAuth2AuthorizedClientService
public interface OAuth2AuthorizedClientService
Implementations of this interface are responsible for the management of Authorized Client(s), which provide the purpose of associating an Access Token credential to a Client and Resource Owner, who is the Principal that originally granted the authorization.
Since:
5.0
See Also:

  • Method Details

    • loadAuthorizedClient

      <T extends OAuth2AuthorizedClient> T loadAuthorizedClient(String clientRegistrationId, String principalName)
      Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name or null if not available.
      Type Parameters:
      T - a type of OAuth2AuthorizedClient
      Parameters:
      clientRegistrationId - the identifier for the client's registration
      principalName - the name of the End-User Principal (Resource Owner)
      Returns:
      the OAuth2AuthorizedClient or null if not available

    • saveAuthorizedClient

      void saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal)
      Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).
      Parameters:
      authorizedClient - the authorized client
      principal - the End-User Authentication (Resource Owner)

    • removeAuthorizedClient

      void removeAuthorizedClient(String clientRegistrationId, String principalName)
      Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.
      Parameters:
      clientRegistrationId - the identifier for the client's registration
      principalName - the name of the End-User Principal (Resource Owner)