Package com.broadleafcommerce.cartoperation.service.provider.external

Class AbstractExternalProvider

java.lang.Object

com.broadleafcommerce.cartoperation.service.provider.external.AbstractExternalProvider

Direct Known Subclasses:

ExternalCampaignProvider, ExternalCartProvider, ExternalCatalogProvider, ExternalGuestTokenProvider, ExternalInventoryProvider, ExternalItemListAccessRuleProvider, ExternalItemListItemProvider, ExternalItemListProvider, ExternalOfferProvider, ExternalPaymentProvider, ExternalPaymentTransactionExecutionProvider, ExternalPricingProvider, ExternalResourceLockProvider, ExternalShippingProvider

public abstract class AbstractExternalProvider
extends Object

Constructor Summary

Constructors

Constructor	Description
AbstractExternalProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected <T> T	executeRequest(Supplier<T> request)	Executes a request with default Web Client error handling.
protected org.springframework.http.HttpHeaders	getHeaders(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the headers to be passed along with the request to the provider.
protected com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected org.springframework.web.reactive.function.client.WebClient	getWebClient()
protected org.springframework.util.MultiValueMap<String,String>	pageableToParams(org.springframework.data.domain.Pageable pageable)	Converts a pageable into its corresponding query parameters.
protected Map<String,Object>	uriVars(Object... keysAndValues)	Convenience method to generate a map of variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExternalProvider

public AbstractExternalProvider(org.springframework.web.reactive.function.client.WebClient webClient,
                                com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

getHeaders

protected org.springframework.http.HttpHeaders getHeaders(@Nullable
                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds the headers to be passed along with the request to the provider.

Parameters:

contextInfo - ContextInfo from the original request containing tenant and sandbox info

Returns:

The headers to be passed along with the request to the provider.

executeRequest

protected <T> T executeRequest(Supplier<T> request)

Executes a request with default Web Client error handling.

Type Parameters:

T - the return type of the request operation

Parameters:

request - the request to execute

Returns:

the value generated by the supplier

uriVars

protected Map<String,Object> uriVars(Object... keysAndValues)

Convenience method to generate a map of variables.

Parameters:

keysAndValues - the keys and values (in pairs, alternating) to transform into a map

Returns:

the keys and values as a map

pageableToParams

protected org.springframework.util.MultiValueMap<String,String> pageableToParams(@Nullable
                                                                                       org.springframework.data.domain.Pageable pageable)

Converts a pageable into its corresponding query parameters.

Parameters:

pageable - the pageable to convert

Returns:

a map of query parameters

getWebClient

protected org.springframework.web.reactive.function.client.WebClient getWebClient()

getObjectMapper

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

getTypeFactory

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