Package org.springframework.security.oauth2.client

Class InMemoryOAuth2AuthorizedClientService

java.lang.Object

org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService

All Implemented Interfaces:

OAuth2AuthorizedClientService

public final class InMemoryOAuth2AuthorizedClientService
extends Object
implements OAuth2AuthorizedClientService

An OAuth2AuthorizedClientService that stores Authorized Client(s) in-memory.

Since:

5.0

See Also:

• OAuth2AuthorizedClientService
• OAuth2AuthorizedClient
• OAuth2AuthorizedClientId
• ClientRegistration
• Authentication

Constructor Summary

Constructors

Constructor	Description
InMemoryOAuth2AuthorizedClientService(ClientRegistrationRepository clientRegistrationRepository)	Constructs an InMemoryOAuth2AuthorizedClientService using the provided parameters.
InMemoryOAuth2AuthorizedClientService(ClientRegistrationRepository clientRegistrationRepository, Map<OAuth2AuthorizedClientId,OAuth2AuthorizedClient> authorizedClients)	Constructs an InMemoryOAuth2AuthorizedClientService using the provided parameters.

Method Summary

Modifier and Type	Method	Description
<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.
void	removeAuthorizedClient(String clientRegistrationId, String principalName)	Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.
void	saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient, Authentication principal)	Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).

Methods inherited from class java.lang.Object

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

Constructor Details

InMemoryOAuth2AuthorizedClientService

public InMemoryOAuth2AuthorizedClientService(ClientRegistrationRepository clientRegistrationRepository)

Constructs an InMemoryOAuth2AuthorizedClientService using the provided parameters.

Parameters:

clientRegistrationRepository - the repository of client registrations

InMemoryOAuth2AuthorizedClientService

public InMemoryOAuth2AuthorizedClientService(ClientRegistrationRepository clientRegistrationRepository,
 Map<OAuth2AuthorizedClientId,OAuth2AuthorizedClient> authorizedClients)

Constructs an InMemoryOAuth2AuthorizedClientService using the provided parameters.

Parameters:

clientRegistrationRepository - the repository of client registrations

authorizedClients - the initial Map of authorized client(s) keyed by OAuth2AuthorizedClientId

Since:

5.2

Method Details

loadAuthorizedClient

public <T extends OAuth2AuthorizedClient> T loadAuthorizedClient(String clientRegistrationId,
 String principalName)

Description copied from interface: OAuth2AuthorizedClientService

Returns the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name or null if not available.

Specified by:

loadAuthorizedClient in interface OAuth2AuthorizedClientService

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

public void saveAuthorizedClient(OAuth2AuthorizedClient authorizedClient,
 Authentication principal)

Description copied from interface: OAuth2AuthorizedClientService

Saves the OAuth2AuthorizedClient associating it to the provided End-User Authentication (Resource Owner).

Specified by:

saveAuthorizedClient in interface OAuth2AuthorizedClientService

Parameters:

authorizedClient - the authorized client

principal - the End-User Authentication (Resource Owner)

removeAuthorizedClient

public void removeAuthorizedClient(String clientRegistrationId,
 String principalName)

Description copied from interface: OAuth2AuthorizedClientService

Removes the OAuth2AuthorizedClient associated to the provided client registration identifier and End-User's Principal name.

Specified by:

removeAuthorizedClient in interface OAuth2AuthorizedClientService

Parameters:

clientRegistrationId - the identifier for the client's registration

principalName - the name of the End-User Principal (Resource Owner)