Package com.broadleafcommerce.auth.client.registration

Class DefaultBroadleafClientRegistrationRepository

java.lang.Object

com.broadleafcommerce.auth.client.registration.DefaultBroadleafClientRegistrationRepository

All Implemented Interfaces:

BroadleafClientRegistrationRepository, org.springframework.security.oauth2.client.registration.ClientRegistrationRepository

public class DefaultBroadleafClientRegistrationRepository
extends Object
implements BroadleafClientRegistrationRepository

Provides ClientRegistration objects to the OAuth2 Client beans. This class relies on the ContextHelperService to get the current tenant id from request attributes. This enables us to allow tenant tracking while preserving the ClientRegistrationRepository interface from the OAuth2 Client library. This class has the ability to incorporate OAuthClientRegistrationWrapper data built from application properties. The OAuthClientRegistrationPersistenceService will always be checked first. If a registration is not found there then this will check the ClientRegistrationPropertiesService. If a registration is found with the ClientRegistrationPropertiesService, it will be saved with OAuthClientRegistrationPersistenceService. Despite the name, this is not a repository in the usual sense. Its name is based on the Spring interface ClientRegistrationRepository that this class implements. Actual persistence operations are handled by OAuthClientRegistrationPersistenceService.

Author:

Cade Rea (cade-rea)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_OAUTH2_IDENTITY_PROVIDERS

Constructor Summary

Constructors

Constructor	Description
DefaultBroadleafClientRegistrationRepository(OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> clientRegistrationService, ContextHelperService contextHelperService, ClientRegistrationPropertiesService<OAuthClientRegistrationWrapper> clientRegistrationPropertiesService)

Method Summary

Modifier and Type	Method	Description
protected org.springframework.security.oauth2.client.registration.ClientRegistration	buildClientRegistration(OAuthClientRegistrationWrapper wrapper)	Converts an OAuthClientRegistrationWrapper to a ClientRegistration.
protected org.springframework.security.oauth2.client.registration.ClientRegistration	consolidateRepresentation(OAuthClientRegistrationWrapper dbEntry, OAuthClientRegistrationWrapper propsEntry, String tenantId)
Map<String,OAuthClientRegistrationWrapper>	findAllClientRegistrations()	Return a Map of all available 3rd party OAuth providers.
org.springframework.security.oauth2.client.registration.ClientRegistration	findByRegistrationId(String registrationId)	Looks up a ClientRegistration by its registration id.
org.springframework.security.oauth2.client.registration.ClientRegistration	findByRegistrationIdAndTenantId(String registrationId, String tenantId)	Looks up a ClientRegistration by its registration id and the given tenant ID.
protected ClientIdentityProviderProperties	getClientProperties()
protected ClientIdentityProviderProperties.ClientProperties	getClientProps(@NonNull AuthorizedClient client)
protected ClientRegistrationPropertiesService<OAuthClientRegistrationWrapper>	getClientRegistrationPropertiesService()
protected OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper>	getClientRegistrationService()
protected ContextHelperService	getContextHelperService()
List<OAuth2IdentityProvider>	getOauth2IdentityProviders(@NonNull AuthorizedClient client)	Looks at the ClientRegistrations to determine which providers are configured and then cross-checks that with the ClientIdentityProviderProperties.ClientProperties for the appropriate type of AuthorizedClient that is making a request, either admin or commerce, to filter the registered identity providers that are appropriate to show the user.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected OAuthClientRegistrationWrapper	loadFromProperties(String registrationId, String tenantId)
void	setClientProperties(ClientIdentityProviderProperties clientProperties)
void	setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Methods inherited from class java.lang.Object

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

Field Details

CACHE_OAUTH2_IDENTITY_PROVIDERS

public static final String CACHE_OAUTH2_IDENTITY_PROVIDERS

See Also:

• Constant Field Values

Constructor Details

DefaultBroadleafClientRegistrationRepository

public DefaultBroadleafClientRegistrationRepository(OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> clientRegistrationService,
 ContextHelperService contextHelperService,
 ClientRegistrationPropertiesService<OAuthClientRegistrationWrapper> clientRegistrationPropertiesService)

Method Details

findByRegistrationId

@Nullable
public org.springframework.security.oauth2.client.registration.ClientRegistration findByRegistrationId(String registrationId)

Looks up a ClientRegistration by its registration id. This will first check the OAuthClientRegistrationPersistenceService. If not found there, this will check ClientRegistrationPropertiesService.

Specified by:

findByRegistrationId in interface org.springframework.security.oauth2.client.registration.ClientRegistrationRepository

Parameters:

registrationId - The registration id, e.g. "google" or "facebook".

Returns:

The ClientRegistration that corresponds to the given registration id.

findByRegistrationIdAndTenantId

@Nullable
public org.springframework.security.oauth2.client.registration.ClientRegistration findByRegistrationIdAndTenantId(String registrationId,
 String tenantId)

Description copied from interface: BroadleafClientRegistrationRepository

Looks up a ClientRegistration by its registration id and the given tenant ID. This will first check the OAuthClientRegistrationPersistenceService. If not found there, this will check ClientRegistrationPropertiesService.

This method differs from ClientRegistrationRepository.findByRegistrationId(String), as that method implicitly retrieves the tenant ID via ContextHelperService.getTenantId(). In this method, the tenant ID is explicitly provided by the caller.

Specified by:

findByRegistrationIdAndTenantId in interface BroadleafClientRegistrationRepository

Parameters:

registrationId - The registration id, e.g. "google" or "facebook".

tenantId - the tenant ID in which to find the registration

Returns:

The ClientRegistration that corresponds to the given registration id.

consolidateRepresentation

protected org.springframework.security.oauth2.client.registration.ClientRegistration consolidateRepresentation(@Nullable
 OAuthClientRegistrationWrapper dbEntry,
 @Nullable
 OAuthClientRegistrationWrapper propsEntry,
 String tenantId)

findAllClientRegistrations

public Map<String,OAuthClientRegistrationWrapper> findAllClientRegistrations()

Return a Map of all available 3rd party OAuth providers. The map key is the registration id from the OAuthClientRegistrationWrapper.

Specified by:

findAllClientRegistrations in interface BroadleafClientRegistrationRepository

Returns:

A tenant-discriminated Map of OAuthClientRegistrationWrapper

loadFromProperties

protected OAuthClientRegistrationWrapper loadFromProperties(String registrationId,
 String tenantId)

buildClientRegistration

@Nullable
protected org.springframework.security.oauth2.client.registration.ClientRegistration buildClientRegistration(OAuthClientRegistrationWrapper wrapper)

Converts an OAuthClientRegistrationWrapper to a ClientRegistration. Returns null if there are any exceptions in the conversion process.

Parameters:

wrapper -

Returns:

getOauth2IdentityProviders

@Cacheable(value="oauth2IdentityProviders",
           keyGenerator="oauth2IdentityProviders",
           condition="@cacheStateManager.isEnabled(#root.caches, #root.args)")
public List<OAuth2IdentityProvider> getOauth2IdentityProviders(@NonNull
 @NonNull AuthorizedClient client)

Description copied from interface: BroadleafClientRegistrationRepository

Looks at the ClientRegistrations to determine which providers are configured and then cross-checks that with the ClientIdentityProviderProperties.ClientProperties for the appropriate type of AuthorizedClient that is making a request, either admin or commerce, to filter the registered identity providers that are appropriate to show the user.

Specified by:

getOauth2IdentityProviders in interface BroadleafClientRegistrationRepository

Parameters:

client - The requesting AuthorizedClient.

Returns:

A list of OAuth2IdentityProvider to add to the request model.

getClientProps

protected ClientIdentityProviderProperties.ClientProperties getClientProps(@NonNull
 @NonNull AuthorizedClient client)

See Also:

• getOauth2IdentityProviders(AuthorizedClient)

getClientRegistrationService

protected OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> getClientRegistrationService()

getContextHelperService

protected ContextHelperService getContextHelperService()

getClientRegistrationPropertiesService

protected ClientRegistrationPropertiesService<OAuthClientRegistrationWrapper> getClientRegistrationPropertiesService()

getClientProperties

protected ClientIdentityProviderProperties getClientProperties()

setClientProperties

@Autowired
public void setClientProperties(ClientIdentityProviderProperties clientProperties)

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

setTypeFactory

@Autowired
public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)