Package com.broadleafcommerce.auth.client.registration

Class DefaultClientRegistrationPropertiesService<P extends OAuthClientRegistrationWrapper>

java.lang.Object

com.broadleafcommerce.auth.client.registration.DefaultClientRegistrationPropertiesService<P>

All Implemented Interfaces:

ClientRegistrationPropertiesService<P>

public class DefaultClientRegistrationPropertiesService<P extends OAuthClientRegistrationWrapper>
extends Object
implements ClientRegistrationPropertiesService<P>

This service provides OAuthClientRegistrationWrapper objects built from OAuth2ClientProperties defined through application properties. All methods of this class will gracefully return null if the OAuth2ClientProperties properties are not set.

Constructor Summary

Constructors

Constructor	Description
DefaultClientRegistrationPropertiesService(org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2ClientProperties oAuth2ClientProperties)

Method Summary

Modifier and Type	Method	Description
protected org.modelmapper.Converter<org.springframework.security.oauth2.client.registration.ClientRegistration,P>	buildClientRegistrationToWrapperPostConverter()	Since ClientRegistration is a final class, ModelMapper complains about adding mappings via TypeMap.
protected org.modelmapper.ModelMapper	buildClientRegistrationWrapperMapper()
P	get(String registrationId)	Get an OAuthClientRegistrationWrapper that is defined in application properties.
Collection<P>	getAll()	Get all OAuthClientRegistrationWrapper objects that are defined in application properties.
protected Map<String,org.springframework.security.oauth2.client.registration.ClientRegistration>	getClientRegistrations()	Map of ClientRegistrations defined via application properties The key is set from ClientRegistration.getRegistrationId()
protected org.modelmapper.ModelMapper	getClientRegistrationWrapperMapper()	The ModelMapper used to go between ClientRegistration and getWrapperType().
protected Class<P>	getWrapperType()	Extension point for those who extend OAuthClientRegistrationWrapper.
P	wrapClientRegistration(@NonNull org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration)	Converts a ClientRegistration to a OAuthClientRegistrationWrapper.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultClientRegistrationPropertiesService

public DefaultClientRegistrationPropertiesService(@Nullable
 org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2ClientProperties oAuth2ClientProperties)

Method Details

buildClientRegistrationWrapperMapper

protected org.modelmapper.ModelMapper buildClientRegistrationWrapperMapper()

buildClientRegistrationToWrapperPostConverter

protected org.modelmapper.Converter<org.springframework.security.oauth2.client.registration.ClientRegistration,P> buildClientRegistrationToWrapperPostConverter()

Since ClientRegistration is a final class, ModelMapper complains about adding mappings via TypeMap. Thus, we need to explicitly apply any custom mapping logic against real instances.

Returns:

a TypeMap.setPostConverter(Converter) that can be used when mapping from ClientRegistration to getWrapperType()

get

public P get(String registrationId)

Description copied from interface: ClientRegistrationPropertiesService

Get an OAuthClientRegistrationWrapper that is defined in application properties.

Specified by:

get in interface ClientRegistrationPropertiesService<P extends OAuthClientRegistrationWrapper>

Returns:

getAll

public Collection<P> getAll()

Description copied from interface: ClientRegistrationPropertiesService

Get all OAuthClientRegistrationWrapper objects that are defined in application properties.

Specified by:

getAll in interface ClientRegistrationPropertiesService<P extends OAuthClientRegistrationWrapper>

Returns:

wrapClientRegistration

public P wrapClientRegistration(@NonNull
 @NonNull org.springframework.security.oauth2.client.registration.ClientRegistration clientRegistration)

Description copied from interface: ClientRegistrationPropertiesService

Converts a ClientRegistration to a OAuthClientRegistrationWrapper.

Specified by:

wrapClientRegistration in interface ClientRegistrationPropertiesService<P extends OAuthClientRegistrationWrapper>

Returns:

OAuthClientRegistrationWrapper

getWrapperType

protected Class<P> getWrapperType()

Extension point for those who extend OAuthClientRegistrationWrapper.

Returns:

The type of OAuthClientRegistrationWrapper to use as a wrapper for ClientRegistration.

getClientRegistrations

protected Map<String,org.springframework.security.oauth2.client.registration.ClientRegistration> getClientRegistrations()

Map of ClientRegistrations defined via application properties The key is set from ClientRegistration.getRegistrationId()

getClientRegistrationWrapperMapper

protected org.modelmapper.ModelMapper getClientRegistrationWrapperMapper()

The ModelMapper used to go between ClientRegistration and getWrapperType().

See Also:

• wrapClientRegistration(ClientRegistration)