Package com.broadleafcommerce.auth.client.service

Class DefaultOAuth2AuthorizedClientRepository

java.lang.Object

com.broadleafcommerce.auth.client.service.DefaultOAuth2AuthorizedClientRepository

All Implemented Interfaces:

org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository

public class DefaultOAuth2AuthorizedClientRepository
extends Object
implements org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository

This service stores an OAuth2AuthorizedClient as a Base64 encoded value in a cookie.

Author:

Cade Rea (cade-rea)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper	This class holds the necessary fields for saving and loading OAuth2AuthorizedClient.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COOKIE_NAME
static final long	EXPIRES_IN_SECONDS

Constructor Summary

Constructors

Constructor	Description
DefaultOAuth2AuthorizedClientRepository(StatelessUtil statelessUtil, ContextHelperService contextHelperService, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository)

Method Summary

Modifier and Type	Method	Description
protected org.springframework.security.oauth2.client.OAuth2AuthorizedClient	createAuthorizedClient(String clientRegistrationId, org.springframework.security.core.Authentication principal, DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper authorizedClientWrapper)	Create an OAuth2AuthorizedClient from an DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper
protected org.springframework.security.oauth2.client.registration.ClientRegistrationRepository	getClientRegistrationRepository()
protected ContextHelperService	getContextHelperService()
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected OAuth2AuthorizedClientRepositoryProperties	getProperties()
protected String	getSavedAuthClientCookieName()
protected StatelessUtil	getStatelessUtil()
<T extends org.springframework.security.oauth2.client.OAuth2AuthorizedClient> T	loadAuthorizedClient(String clientRegistrationId, org.springframework.security.core.Authentication principal, jakarta.servlet.http.HttpServletRequest request)
protected DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper	readAuthClientWrapperFromCookie(jakarta.servlet.http.HttpServletRequest request)	Read a DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper from the authorized client cookie.
void	removeAuthorizedClient(String clientRegistrationId, org.springframework.security.core.Authentication principal, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	saveAuthorizedClient(org.springframework.security.oauth2.client.OAuth2AuthorizedClient authorizedClient, org.springframework.security.core.Authentication principal, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
protected String	serializeAuthorizedClient(Object authorizedClient)	Serialize the given OAuth2AuthorizedClient into a Base-64 encoded String.
protected void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
void	setProperties(OAuth2AuthorizedClientRepositoryProperties properties)
protected DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper	wrapAuthorizedClient(org.springframework.security.oauth2.client.OAuth2AuthorizedClient authorizedClient)	Create a new DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper from the given OAuth2AuthorizedClient.

Methods inherited from class java.lang.Object

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

Field Details

COOKIE_NAME

public static final String COOKIE_NAME

See Also:

• Constant Field Values

EXPIRES_IN_SECONDS

public static final long EXPIRES_IN_SECONDS

See Also:

• Constant Field Values

Constructor Details

DefaultOAuth2AuthorizedClientRepository

public DefaultOAuth2AuthorizedClientRepository(StatelessUtil statelessUtil,
 ContextHelperService contextHelperService,
 org.springframework.security.oauth2.client.registration.ClientRegistrationRepository clientRegistrationRepository)

Method Details

loadAuthorizedClient

@Nullable
public <T extends org.springframework.security.oauth2.client.OAuth2AuthorizedClient>
T loadAuthorizedClient(String clientRegistrationId,
 org.springframework.security.core.Authentication principal,
 jakarta.servlet.http.HttpServletRequest request)

Specified by:

loadAuthorizedClient in interface org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository

saveAuthorizedClient

public void saveAuthorizedClient(org.springframework.security.oauth2.client.OAuth2AuthorizedClient authorizedClient,
 org.springframework.security.core.Authentication principal,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Specified by:

saveAuthorizedClient in interface org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository

removeAuthorizedClient

public void removeAuthorizedClient(String clientRegistrationId,
 org.springframework.security.core.Authentication principal,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

Specified by:

removeAuthorizedClient in interface org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository

readAuthClientWrapperFromCookie

@Nullable
protected DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper readAuthClientWrapperFromCookie(jakarta.servlet.http.HttpServletRequest request)

Read a DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper from the authorized client cookie.

Parameters:

request -

Returns:

createAuthorizedClient

protected org.springframework.security.oauth2.client.OAuth2AuthorizedClient createAuthorizedClient(String clientRegistrationId,
 org.springframework.security.core.Authentication principal,
 DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper authorizedClientWrapper)

Create an OAuth2AuthorizedClient from an DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper

Parameters:

clientRegistrationId -

principal -

authorizedClientWrapper -

Returns:

wrapAuthorizedClient

protected DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper wrapAuthorizedClient(org.springframework.security.oauth2.client.OAuth2AuthorizedClient authorizedClient)

Create a new DefaultOAuth2AuthorizedClientRepository.TenantAwareOAuth2AuthorizedClientWrapper from the given OAuth2AuthorizedClient.

Parameters:

authorizedClient -

Returns:

serializeAuthorizedClient

protected String serializeAuthorizedClient(Object authorizedClient)

Serialize the given OAuth2AuthorizedClient into a Base-64 encoded String.

Parameters:

authorizedClient -

Returns:

getSavedAuthClientCookieName

protected String getSavedAuthClientCookieName()

getStatelessUtil

protected StatelessUtil getStatelessUtil()

getContextHelperService

protected ContextHelperService getContextHelperService()

getClientRegistrationRepository

protected org.springframework.security.oauth2.client.registration.ClientRegistrationRepository getClientRegistrationRepository()

getObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setObjectMapper

protected void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

getProperties

protected OAuth2AuthorizedClientRepositoryProperties getProperties()

setProperties

@Autowired
public void setProperties(OAuth2AuthorizedClientRepositoryProperties properties)