Package com.broadleafcommerce.dataexchange.service.provider.external

Class ExternalCatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

java.lang.Object

com.broadleafcommerce.dataexchange.service.provider.external.AbstractRestApiExternalProvider

com.broadleafcommerce.dataexchange.service.provider.external.ExternalCatalogProvider<T1,T2>

All Implemented Interfaces:

NodeBuilder, CatalogProvider<T1,T2>

public class ExternalCatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>
extends AbstractRestApiExternalProvider
implements CatalogProvider<T1,T2>

Author:

Kelly Tisdell (ktisdell)

Constructor Summary

Constructors

Constructor	Description
ExternalCatalogProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, org.springframework.web.reactive.function.client.WebClient dataExchangeWebClient, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalCatalogProviderProperties properties)

Method Summary

Modifier and Type	Method	Description
protected cz.jirutka.rsql.parser.ast.Node	addExternalIdRsql(cz.jirutka.rsql.parser.ast.Node node, Set<String> externalIds)
protected cz.jirutka.rsql.parser.ast.Node	addProductIdsRsql(cz.jirutka.rsql.parser.ast.Node node, Set<String> productIds)
protected cz.jirutka.rsql.parser.ast.Node	addSkuRsql(cz.jirutka.rsql.parser.ast.Node node, Set<String> skus)
protected cz.jirutka.rsql.parser.ast.Node	buildDataDrivenEnumFilter(DataDrivenEnumRequestFilters filters, BatchContext<?> batchContext)
protected org.springframework.util.MultiValueMap<String,String>	buildFindProductsRequestParams(String rsqlQuery)
protected cz.jirutka.rsql.parser.ast.Node	buildNameInNode(Collection<String> names)
protected Optional<String>	createExistingProductRsqlQuery(List<T1> products, BatchContext<?> batchContext)	When we want to query for existing products, we normally do so by querying by contextId, externalId, or sku.
T1	createProduct(T1 product, BatchContext<?> batchContext)
T2	createVariant(T1 product, T2 variant, BatchContext<?> batchContext)
void	deleteVariant(String productId, String variantId, BatchContext<?> context)
protected ProductList<T1>	emptyProductList()
T1	generateOptions(GenerateProductOption generateProductOption, BatchContext<?> batchContext)
protected org.springframework.util.MultiValueMap<String,String>	getFilterParamsWithPaging(cz.jirutka.rsql.parser.ast.Node node)
protected Map<String,Object>	getProductPathVars(T1 product)
protected Map<String,Object>	getProductTranslationsPathVars(T1 product, Locale locale)
protected Class<T1>	getProductType()
protected ExternalCatalogProviderProperties	getProperties()
protected org.springframework.util.MultiValueMap<String,String>	getReadAllDataDriveEnumParams(DataDrivenEnumRequestFilters filters, BatchContext<?> batchContext)
protected String	getServiceClient()
protected Class<TranslationsPayload>	getTranslationsPayloadType()
protected Class<T2>	getVariantType()
protected void	populateExistingProductIdentifiers(List<T1> products, Set<String> productIds, Set<String> externalIds, Set<String> skus)
DataDrivenEnumResponse	readDataDrivenEnums(DataDrivenEnumRequestFilters filters, BatchContext<?> batchContext)	Fetches a list of DataDrivenEnums based on the provided filters.
List<OptionTemplateGroup>	readOptionTemplateGroups(cz.jirutka.rsql.parser.ast.Node node, BatchContext<?> batchContext)
List<OptionTemplateGroup>	readOptionTemplateGroupsByNameIn(Collection<String> names, BatchContext<?> batchContext)
List<OptionTemplate>	readOptionTemplates(cz.jirutka.rsql.parser.ast.Node node, BatchContext<?> batchContext)
List<OptionTemplate>	readOptionTemplatesByNameIn(Collection<String> names, BatchContext<?> batchContext)
T1	readProductById(String productId, BatchContext<?> batchContext)
ProductList<T1>	readProducts(List<T1> requestedProducts, BatchContext<?> batchContext)	Fetches a list of Products based on externalId, SKU, or URI.
ProductList<T1>	readProducts(org.springframework.util.MultiValueMap<String,String> params, BatchContext<?> batchContext)
T2	readVariant(String productId, String variantId, BatchContext<?> context)
T2	readVariantById(String productId, String variantId, BatchContext<?> batchContext)
List<T2>	readVariants(List<T1> products, BatchContext<?> batchContext)
List<T2>	readVariantsForProduct(T1 product, BatchContext<?> batchContext)
protected T1	saveProduct(T1 product, org.springframework.web.reactive.function.client.WebClient.RequestBodySpec request)
List<Translation>	saveProductTranslations(T1 product, Locale locale, List<Translation> translations, BatchContext<?> batchContext)	Saves translations, specifically for a Product.
List<Translation>	saveVariantTranslations(T1 product, T2 variant, Locale locale, List<Translation> translations, BatchContext<?> batchContext)
T1	updateProduct(T1 product, BatchContext<?> batchContext)
T2	updateVariant(T1 product, T2 variant, BatchContext<?> batchContext)

Methods inherited from class com.broadleafcommerce.dataexchange.service.provider.external.AbstractRestApiExternalProvider

addNarrowedPageableParams, deleteRequest, deleteRequest, getFilterParams, getFilterParams, getHeaders, getMapper, getMostDerivedType, getRequest, getRequest, getTypeFactory, getWebClient, narrowedPageParams, patchRequest, patchRequest, postRequest, postRequest, putRequest, putRequest, setCorrelationIds

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.dataexchange.service.NodeBuilder

buildAndNode, buildAndNode, buildEqualsNode, buildInNode, buildInNode, buildOrNode, buildOrNode, emptyNode, escapeSpecialCharacters, filterEmptyNodes, filterEmptyNodes, isEmptyNodeOrNull

Constructor Details

ExternalCatalogProvider

public ExternalCatalogProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
 org.springframework.web.reactive.function.client.WebClient dataExchangeWebClient,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 ExternalCatalogProviderProperties properties)

Method Details

readProducts

public ProductList<T1> readProducts(List<T1> requestedProducts,
 BatchContext<?> batchContext)

Description copied from interface: CatalogProvider

Fetches a list of Products based on externalId, SKU, or URI. This is to find existing products for update.

Specified by:

readProducts in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

Returns:

readProducts

public ProductList<T1> readProducts(@Nullable
 org.springframework.util.MultiValueMap<String,String> params,
 BatchContext<?> batchContext)

Specified by:

readProducts in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readProductById

public T1 readProductById(String productId,
 BatchContext<?> batchContext)

Specified by:

readProductById in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readVariantById

public T2 readVariantById(String productId,
 String variantId,
 BatchContext<?> batchContext)

Specified by:

readVariantById in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

createProduct

public T1 createProduct(T1 product,
 BatchContext<?> batchContext)

Specified by:

createProduct in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

updateProduct

public T1 updateProduct(T1 product,
 BatchContext<?> batchContext)

Specified by:

updateProduct in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

generateOptions

public T1 generateOptions(GenerateProductOption generateProductOption,
 BatchContext<?> batchContext)

Specified by:

generateOptions in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

saveProductTranslations

public List<Translation> saveProductTranslations(T1 product,
 Locale locale,
 List<Translation> translations,
 BatchContext<?> batchContext)

Description copied from interface: CatalogProvider

Saves translations, specifically for a Product.

Specified by:

saveProductTranslations in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

Parameters:

product - the product for which to save translations

locale - the locale for the translations - must be the same for all

translations - the list of translations

batchContext - the batch context including the ContextInfo

Returns:

the list of translations

readVariants

public List<T2> readVariants(List<T1> products,
 BatchContext<?> batchContext)

Specified by:

readVariants in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readVariantsForProduct

public List<T2> readVariantsForProduct(T1 product,
 BatchContext<?> batchContext)

Specified by:

readVariantsForProduct in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

createVariant

public T2 createVariant(T1 product,
 T2 variant,
 BatchContext<?> batchContext)

Specified by:

createVariant in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

updateVariant

public T2 updateVariant(T1 product,
 T2 variant,
 BatchContext<?> batchContext)

Specified by:

updateVariant in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

saveVariantTranslations

public List<Translation> saveVariantTranslations(T1 product,
 T2 variant,
 Locale locale,
 List<Translation> translations,
 BatchContext<?> batchContext)

Specified by:

saveVariantTranslations in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readDataDrivenEnums

public DataDrivenEnumResponse readDataDrivenEnums(DataDrivenEnumRequestFilters filters,
 BatchContext<?> batchContext)

Description copied from interface: CatalogProvider

Fetches a list of DataDrivenEnums based on the provided filters.

Specified by:

readDataDrivenEnums in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

Parameters:

filters - the filters to apply

batchContext - the batch context

Returns:

the list of DataDrivenEnums

readOptionTemplateGroups

public List<OptionTemplateGroup> readOptionTemplateGroups(cz.jirutka.rsql.parser.ast.Node node,
 BatchContext<?> batchContext)

Specified by:

readOptionTemplateGroups in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readOptionTemplates

public List<OptionTemplate> readOptionTemplates(cz.jirutka.rsql.parser.ast.Node node,
 BatchContext<?> batchContext)

Specified by:

readOptionTemplates in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readOptionTemplateGroupsByNameIn

public List<OptionTemplateGroup> readOptionTemplateGroupsByNameIn(Collection<String> names,
 BatchContext<?> batchContext)

Specified by:

readOptionTemplateGroupsByNameIn in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readOptionTemplatesByNameIn

public List<OptionTemplate> readOptionTemplatesByNameIn(Collection<String> names,
 BatchContext<?> batchContext)

Specified by:

readOptionTemplatesByNameIn in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

readVariant

public T2 readVariant(String productId,
 String variantId,
 BatchContext<?> context)

Specified by:

readVariant in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

deleteVariant

public void deleteVariant(String productId,
 String variantId,
 BatchContext<?> context)

Specified by:

deleteVariant in interface CatalogProvider<T1 extends ComprehensiveProduct,T2 extends Variant>

saveProduct

protected T1 saveProduct(T1 product,
 org.springframework.web.reactive.function.client.WebClient.RequestBodySpec request)

getProductTranslationsPathVars

protected Map<String,Object> getProductTranslationsPathVars(T1 product,
 Locale locale)

getProductPathVars

protected Map<String,Object> getProductPathVars(T1 product)

emptyProductList

protected ProductList<T1> emptyProductList()

createExistingProductRsqlQuery

protected Optional<String> createExistingProductRsqlQuery(List<T1> products,
 BatchContext<?> batchContext)

When we want to query for existing products, we normally do so by querying by contextId, externalId, or sku. These are known, unique identifiers. In this case, we're trying to find products that may exist, but that may not be known by or referenced by their contextIds by the client. In this case, we use EntityExchangeObject.getId() and ComprehensiveProduct.getExternalId() and ComprehensiveProduct.getSku() as unique references and query for existing products so that we have original product references, including their IDs.

Parameters:

products - the product list for which we plan to execute create or update operations

batchContext - the batch context including the ContextRequest

Returns:

an Optional value which may contain an RSQL string

addProductIdsRsql

protected cz.jirutka.rsql.parser.ast.Node addProductIdsRsql(cz.jirutka.rsql.parser.ast.Node node,
 Set<String> productIds)

addSkuRsql

protected cz.jirutka.rsql.parser.ast.Node addSkuRsql(cz.jirutka.rsql.parser.ast.Node node,
 Set<String> skus)

addExternalIdRsql

protected cz.jirutka.rsql.parser.ast.Node addExternalIdRsql(cz.jirutka.rsql.parser.ast.Node node,
 Set<String> externalIds)

populateExistingProductIdentifiers

protected void populateExistingProductIdentifiers(List<T1> products,
 Set<String> productIds,
 Set<String> externalIds,
 Set<String> skus)

buildFindProductsRequestParams

protected org.springframework.util.MultiValueMap<String,String> buildFindProductsRequestParams(String rsqlQuery)

getProductType

protected Class<T1> getProductType()

getVariantType

protected Class<T2> getVariantType()

getTranslationsPayloadType

protected Class<TranslationsPayload> getTranslationsPayloadType()

buildDataDrivenEnumFilter

protected cz.jirutka.rsql.parser.ast.Node buildDataDrivenEnumFilter(DataDrivenEnumRequestFilters filters,
 BatchContext<?> batchContext)

getReadAllDataDriveEnumParams

protected org.springframework.util.MultiValueMap<String,String> getReadAllDataDriveEnumParams(DataDrivenEnumRequestFilters filters,
 BatchContext<?> batchContext)

getFilterParamsWithPaging

protected org.springframework.util.MultiValueMap<String,String> getFilterParamsWithPaging(cz.jirutka.rsql.parser.ast.Node node)

buildNameInNode

protected cz.jirutka.rsql.parser.ast.Node buildNameInNode(Collection<String> names)

getServiceClient

protected String getServiceClient()

Specified by:

getServiceClient in class AbstractRestApiExternalProvider

Returns:

Returns the service client name to be used for the request.

getProperties

protected ExternalCatalogProviderProperties getProperties()