Package com.broadleafcommerce.auth.server.service

Class DefaultAuthorizedClientService<P extends AuthorizedClient,D extends com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable & com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware>

java.lang.Object

com.broadleafcommerce.auth.server.service.DefaultAuthorizedClientService<P,D>

All Implemented Interfaces:

AuthorizedClientService<P>

public class DefaultAuthorizedClientService<P extends AuthorizedClient,D extends com.broadleafcommerce.data.tracking.core.mapping.ModelMapperMappable & com.broadleafcommerce.data.tracking.core.mapping.BusinessTypeAware>
extends Object
implements AuthorizedClientService<P>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DefaultAuthorizedClientService.BaseUriInitializer	This leverages the lazy-initializer pattern to ensure the base-uri resolution logic for relative URLs (which may be expensive) is only engaged if needed, and won't perform computation more than once.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_BY_AUTHORIZED_CLIENT

Constructor Summary

Constructors

Constructor	Description
DefaultAuthorizedClientService(AuthorizationServerService<AuthorizationServer> serverService, AuthorizedClientRepository<D> repository, SimplePayloadMapper mapper, com.broadleafcommerce.data.tracking.core.mapping.validation.EntityValidatorManager validator, org.springframework.security.crypto.password.PasswordEncoder passwordEncoder, TenantUrlResolver tenantUrlResolver)

Method Summary

Modifier and Type	Method	Description
P	create(P authorizedClient)	Create a new authorized client.
void	delete(P authorizedClient)	Delete an authorized client.
void	deleteById(String id)	Delete an authorized client by ID.
boolean	existsById(String id)	Check if an authorized client exists by its ID.
Optional<P>	findAdminClient(String tenantId)	Finds the authorized client for the admin within the given context.
org.springframework.data.domain.Page<P>	findAll(org.springframework.data.domain.Pageable pageable)	Find all authorized clients.
org.springframework.data.domain.Page<P>	findAllByServerId(String serverId, org.springframework.data.domain.Pageable pageable)	Finds all authorized clients within an authorization server.
Optional<P>	findApplicationClient(String applicationId)	Finds the authorized client for the application within the given context.
Optional<P>	findApplicationClient(String applicationId, String tenantId)	Finds the authorized client for the application within the given context.
Optional<P>	findByClientId(String authorizedClientId)	Find an authorized client by its client ID.
Optional<P>	findById(String id)	Find an authorized client by its ID.
protected Optional<D>	findRepositoryDomainById(String id)
protected Optional<P>	fromRepositoryDomain(Optional<D> optionalDomain)
protected org.springframework.data.domain.Page<P>	fromRepositoryDomain(org.springframework.data.domain.Page<D> page)
protected String	generateAuthorizedClientId(P authorizedClient)	Generates a Base64, 16-bit string appended with the server name as the client ID for a newly created authorized client.
protected SimplePayloadMapper	getMapper()
protected org.springframework.security.crypto.password.PasswordEncoder	getPasswordEncoder()
protected AuthorizedClientRepository<D>	getRepository()
protected AuthorizationServerService<AuthorizationServer>	getServerService()
protected TenantUrlResolver	getTenantUrlResolver()
protected com.broadleafcommerce.data.tracking.core.mapping.validation.EntityValidatorManager	getValidator()
P	replace(String id, P authorizedClient)	Replace an authorized client.
Optional<String>	resolveAbsolutePathForUri(String uri, AuthorizedClient client)	Resolves the absolute path for the string uri provided
Optional<String>	resolveAbsolutePathsForRelativeDefaultRedirectUri(AuthorizedClient client)	Resolves the absolute path for the default redirect uri on the provided AuthorizedClient
Set<String>	resolveAbsolutePathsForRelativeRedirectUris(AuthorizedClient client)	Resolves the absolute path for the redirect uris on the provided AuthorizedClient
Set<String>	resolveAbsolutePathsForUris(Set<String> uris, AuthorizedClient client)	Resolves the absolute path for the string uris provided
protected Optional<org.springframework.web.util.UriComponentsBuilder>	resolveBaseUri(AuthorizedClient client)	Determines the base URI of the application or admin the client is used for.
P	save(P authorizedClient)	Save an authorized client.
protected void	validate(P authorizedClient)
protected void	validateUniqueAdminClientPerTenant(P authorizedClient, org.springframework.validation.Errors errors)

Methods inherited from class java.lang.Object

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

Field Details

CACHE_BY_AUTHORIZED_CLIENT

public static final String CACHE_BY_AUTHORIZED_CLIENT

See Also:

• Constant Field Values

Constructor Details

DefaultAuthorizedClientService

public DefaultAuthorizedClientService(AuthorizationServerService<AuthorizationServer> serverService,
 AuthorizedClientRepository<D> repository,
 SimplePayloadMapper mapper,
 com.broadleafcommerce.data.tracking.core.mapping.validation.EntityValidatorManager validator,
 org.springframework.security.crypto.password.PasswordEncoder passwordEncoder,
 TenantUrlResolver tenantUrlResolver)

Method Details

findAll

public org.springframework.data.domain.Page<P> findAll(org.springframework.data.domain.Pageable pageable)

Description copied from interface: AuthorizedClientService

Find all authorized clients.

Specified by:

findAll in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

pageable - the pageable

Returns:

a page of authorized client

findAllByServerId

public org.springframework.data.domain.Page<P> findAllByServerId(String serverId,
 org.springframework.data.domain.Pageable pageable)

Description copied from interface: AuthorizedClientService

Finds all authorized clients within an authorization server.

Specified by:

findAllByServerId in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

serverId - the server ID

pageable - the pageable

Returns:

a page of authorized client

findAdminClient

public Optional<P> findAdminClient(String tenantId)

Description copied from interface: AuthorizedClientService

Finds the authorized client for the admin within the given context.

Specified by:

findAdminClient in interface AuthorizedClientService<P extends AuthorizedClient>

Returns:

an optional of authorized client

findApplicationClient

public Optional<P> findApplicationClient(String applicationId,
 String tenantId)

Description copied from interface: AuthorizedClientService

Finds the authorized client for the application within the given context.

Specified by:

findApplicationClient in interface AuthorizedClientService<P extends AuthorizedClient>

Returns:

an optional of authorized client

findApplicationClient

public Optional<P> findApplicationClient(String applicationId)

Description copied from interface: AuthorizedClientService

Finds the authorized client for the application within the given context.

Specified by:

findApplicationClient in interface AuthorizedClientService<P extends AuthorizedClient>

Returns:

an optional of authorized client

existsById

public boolean existsById(String id)

Description copied from interface: AuthorizedClientService

Check if an authorized client exists by its ID.

Specified by:

existsById in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

id - the authorized client ID

Returns:

whether or the not the authorized client exists

findById

public Optional<P> findById(String id)

Description copied from interface: AuthorizedClientService

Find an authorized client by its ID.

Specified by:

findById in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

id - the authorized client ID

Returns:

an optional of authorized client

findByClientId

@Cacheable(cacheNames="authCacheByAuthorizedClient",
           key="#a0",
           condition="@cacheStateManager.isEnabled(#root.caches, #root.args)")
public Optional<P> findByClientId(String authorizedClientId)

Description copied from interface: AuthorizedClientService

Find an authorized client by its client ID.

Specified by:

findByClientId in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

authorizedClientId - the client ID of the authorization client

Returns:

an optional of authorized client

create

public P create(P authorizedClient)

Description copied from interface: AuthorizedClientService

Create a new authorized client. AuthorizedClient#getServer() must not be null.

Specified by:

create in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

authorizedClient - the authorized client to create

Returns:

the created authorized client

generateAuthorizedClientId

protected String generateAuthorizedClientId(P authorizedClient)

Generates a Base64, 16-bit string appended with the server name as the client ID for a newly created authorized client.

Parameters:

authorizedClient - the new authorized client

Returns:

the client ID

save

public P save(P authorizedClient)

Description copied from interface: AuthorizedClientService

Save an authorized client.

Specified by:

save in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

authorizedClient - the authorized client to save

Returns:

the saved authorized client

replace

public P replace(String id,
 P authorizedClient)

Description copied from interface: AuthorizedClientService

Replace an authorized client.

Specified by:

replace in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

id - the authorized client ID to replace

authorizedClient - the authorized client replacement

Returns:

the created authorized client

delete

public void delete(P authorizedClient)

Description copied from interface: AuthorizedClientService

Delete an authorized client.

Specified by:

delete in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

authorizedClient - the authorized client to delete

deleteById

public void deleteById(String id)

Description copied from interface: AuthorizedClientService

Delete an authorized client by ID.

Specified by:

deleteById in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

id - the ID of the authorized client to delete

resolveAbsolutePathsForRelativeDefaultRedirectUri

public Optional<String> resolveAbsolutePathsForRelativeDefaultRedirectUri(AuthorizedClient client)

Description copied from interface: AuthorizedClientService

Resolves the absolute path for the default redirect uri on the provided AuthorizedClient

Specified by:

resolveAbsolutePathsForRelativeDefaultRedirectUri in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

client - The AuthorizedClient to resolve the default redirect uri for

Returns:

The absolute path for the default redirect uri on the provided AuthorizedClient if one is resolved else an empty Optional

resolveAbsolutePathsForRelativeRedirectUris

public Set<String> resolveAbsolutePathsForRelativeRedirectUris(AuthorizedClient client)

Description copied from interface: AuthorizedClientService

Resolves the absolute path for the redirect uris on the provided AuthorizedClient

Specified by:

resolveAbsolutePathsForRelativeRedirectUris in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

client - The AuthorizedClient to resolve the redirect uris for

Returns:

The absolute paths for the redirect uris on the provided AuthorizedClient that could be resolved

resolveAbsolutePathForUri

public Optional<String> resolveAbsolutePathForUri(String uri,
 AuthorizedClient client)

Description copied from interface: AuthorizedClientService

Resolves the absolute path for the string uri provided

Specified by:

resolveAbsolutePathForUri in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

uri - The uri to resolve the absolute path for

client - The AuthorizedClient to use for finding the domain, host, etc.

Returns:

The uri resolved to an absolute path if possible else an empty Optional

resolveAbsolutePathsForUris

public Set<String> resolveAbsolutePathsForUris(Set<String> uris,
 AuthorizedClient client)

Description copied from interface: AuthorizedClientService

Resolves the absolute path for the string uris provided

Specified by:

resolveAbsolutePathsForUris in interface AuthorizedClientService<P extends AuthorizedClient>

Parameters:

uris - The uris to resolve absolute paths for

client - The AuthorizedClient to use for finding the domain, host, etc.

Returns:

The uris that could be resolved to absolute paths

resolveBaseUri

protected Optional<org.springframework.web.util.UriComponentsBuilder> resolveBaseUri(AuthorizedClient client)

Determines the base URI of the application or admin the client is used for.

Delegates to TenantUrlResolver.

To preserve best-effort for the remainder of the flow, this method will not throw exceptions. Errors will be gracefully logged, and Optional.empty() will be returned.

Parameters:

client - the client whose admin or application base URI needs to be found

Returns:

a UriComponentsBuilder representing the base URI if successfully found, Optional.empty() otherwise

findRepositoryDomainById

protected Optional<D> findRepositoryDomainById(String id)

fromRepositoryDomain

protected Optional<P> fromRepositoryDomain(Optional<D> optionalDomain)

fromRepositoryDomain

protected org.springframework.data.domain.Page<P> fromRepositoryDomain(org.springframework.data.domain.Page<D> page)

validate

protected void validate(P authorizedClient)

validateUniqueAdminClientPerTenant

protected void validateUniqueAdminClientPerTenant(P authorizedClient,
 org.springframework.validation.Errors errors)

getServerService

protected AuthorizationServerService<AuthorizationServer> getServerService()

getRepository

protected AuthorizedClientRepository<D> getRepository()

getMapper

protected SimplePayloadMapper getMapper()

getValidator

protected com.broadleafcommerce.data.tracking.core.mapping.validation.EntityValidatorManager getValidator()

getPasswordEncoder

protected org.springframework.security.crypto.password.PasswordEncoder getPasswordEncoder()

getTenantUrlResolver

protected TenantUrlResolver getTenantUrlResolver()