Package com.broadleafcommerce.catalogbrowse.service.provider.external.catalog

Class ExternalCatalogProvider

java.lang.Object

com.broadleafcommerce.catalogbrowse.service.provider.external.AbstractExternalProvider

com.broadleafcommerce.catalogbrowse.service.provider.external.catalog.ExternalCatalogProvider

All Implemented Interfaces:

CatalogProvider

@ConfigurationProperties("broadleaf.catalogbrowse.catalogprovider")
public class ExternalCatalogProvider
extends AbstractExternalProvider
implements CatalogProvider

Connects to an external catalog service.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected org.springframework.util.MultiValueMap<String,String>	dataDrivenEnumDetailsRequestToParams(@NonNull DataDrivenEnumDetailsRequest detailsRequest)	Converts a DataDrivenEnumDetailsRequest to request params.
BrowseEntityDetails	fetchBrowseEntityDetails(@NonNull BrowseDetailsRequest request)	Retrieves a product list or category that matches the given request.
Category	fetchCategoryWithDetails(@NonNull CategoryDetailsRequest request)	Retrieves the category with details for the request.
DataDrivenEnumList	fetchDataDrivenEnumsWithDetails(@NonNull DataDrivenEnumDetailsRequest request)	Retrieves the data driven enum list with details for the request.
ProductList	fetchProductsWithDetails(@NonNull ProductDetailsRequest request)	Retrieves the product list with details for the request.
String	getBrowseEntitiesUri()	The URI path for retrieving browse entities when the type is not known by the caller.
protected PricingProvider	getBrowsePricingProvider()
protected org.springframework.web.reactive.function.client.WebClient	getCatalogBrowseWebClient()
String	getCategoriesUri()	The URI path for retrieving categories.
String	getDataDrivenEnumsUri()	The URI path for retrieving data driven enums.
String	getProductAssetsUri()	The URI path for retrieving product assets.
String	getProductsUri()	The URI path for retrieving products.
String	getProductTagsUri()	The URI path for retrieving product tags.
String	getServiceClient()	The service client to use when interacting with catalog.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
String	getUrl()	The base url for an external catalog service: https://localhost:8447/catalog.
<T extends Product> void	hydrateProductAssets(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the Assets for the provided products and populates them onto Product.setAssets(java.util.List<com.broadleafcommerce.catalogbrowse.domain.Asset>).
protected <T extends Product> List<T>	hydrateProductsPricing(@NonNull List<T> toHydrate, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hydrates pricing onto the retrieved products.
<T extends Product> void	hydrateProductTags(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the ProductTags for the provided products and populates them onto Product.getAdvancedTags().
void	setBrowseEntitiesUri(String browseEntitiesUri)	The URI path for retrieving browse entities when the type is not known by the caller.
void	setCategoriesUri(String categoriesUri)	The URI path for retrieving categories.
void	setDataDrivenEnumsUri(String dataDrivenEnumsUri)	The URI path for retrieving data driven enums.
void	setProductAssetsUri(String productAssetsUri)	The URI path for retrieving product assets.
void	setProductsUri(String productsUri)	The URI path for retrieving products.
void	setProductTagsUri(String productTagsUri)	The URI path for retrieving product tags.
void	setServiceClient(String serviceClient)	The service client to use when interacting with catalog.
void	setUrl(String url)	The base url for an external catalog service: https://localhost:8447/catalog.

Methods inherited from class com.broadleafcommerce.catalogbrowse.service.provider.external.AbstractExternalProvider

getHeaders, getMapper

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalCatalogProvider

public ExternalCatalogProvider(@Qualifier("catalogBrowseWebClient")
                               org.springframework.web.reactive.function.client.WebClient catalogBrowseWebClient,
                               com.fasterxml.jackson.databind.ObjectMapper mapper,
                               PricingProvider browsePricingProvider,
                               com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

fetchProductsWithDetails

public ProductList fetchProductsWithDetails(@NonNull
                                            @NonNull ProductDetailsRequest request)

Description copied from interface: CatalogProvider

Retrieves the product list with details for the request.

Specified by:

fetchProductsWithDetails in interface CatalogProvider

Parameters:

request - All of the relevant information to be used to retrieve a product's details

Returns:

The product list for the parameters provided.

fetchCategoryWithDetails

public Category fetchCategoryWithDetails(@NonNull
                                         @NonNull CategoryDetailsRequest request)

Description copied from interface: CatalogProvider

Retrieves the category with details for the request.

Specified by:

fetchCategoryWithDetails in interface CatalogProvider

Parameters:

request - All of the relevant information to be used to retrieve a category's details

Returns:

The category for the parameters provided.

fetchDataDrivenEnumsWithDetails

public DataDrivenEnumList fetchDataDrivenEnumsWithDetails(@NonNull
                                                          @NonNull DataDrivenEnumDetailsRequest request)

Description copied from interface: CatalogProvider

Retrieves the data driven enum list with details for the request.

Specified by:

fetchDataDrivenEnumsWithDetails in interface CatalogProvider

Parameters:

request - All of the relevant information to be used to retrieve a list of data driven enum with their details

Returns:

The data driven enum list for the parameters provided.

dataDrivenEnumDetailsRequestToParams

protected org.springframework.util.MultiValueMap<String,String> dataDrivenEnumDetailsRequestToParams(@NonNull
                                                                                                           @NonNull DataDrivenEnumDetailsRequest detailsRequest)

Converts a DataDrivenEnumDetailsRequest to request params.

Parameters:

detailsRequest - the DataDrivenEnumDetailsRequest to convert

Returns:

a map of query parameters

hydrateProductAssets

public <T extends Product> void hydrateProductAssets(@NonNull
                                                     @NonNull Collection<T> products,
                                                     @Nullable
                                                     org.springframework.util.MultiValueMap<String,String> parameters,
                                                     @Nullable
                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CatalogProvider

Retrieves the Assets for the provided products and populates them onto Product.setAssets(java.util.List<com.broadleafcommerce.catalogbrowse.domain.Asset>).

Note that this is only necessary if assets are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of CatalogProvider.fetchProductsWithDetails(com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest) and CatalogProvider.fetchCategoryWithDetails(com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest).

Specified by:

hydrateProductAssets in interface CatalogProvider

Parameters:

products - Products to hydrate.

parameters - Request parameters to include when fetching assets

contextInfo - Additional sandbox and multitenant info.

hydrateProductTags

public <T extends Product> void hydrateProductTags(@NonNull
                                                   @NonNull Collection<T> products,
                                                   @Nullable
                                                   org.springframework.util.MultiValueMap<String,String> parameters,
                                                   @Nullable
                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CatalogProvider

Retrieves the ProductTags for the provided products and populates them onto Product.getAdvancedTags().

Specified by:

hydrateProductTags in interface CatalogProvider

Parameters:

products - Products to hydrate.

parameters - Request parameters to include when fetching assets

contextInfo - Additional sandbox and multitenant info.

fetchBrowseEntityDetails

public BrowseEntityDetails fetchBrowseEntityDetails(@NonNull
                                                    @NonNull BrowseDetailsRequest request)

Description copied from interface: CatalogProvider

Retrieves a product list or category that matches the given request.

Specified by:

fetchBrowseEntityDetails in interface CatalogProvider

Parameters:

request - All of the relevant information to be used to retrieve a browse entity's details such as a list of URIs.

Returns:

The details of the browse entities matching the request

hydrateProductsPricing

protected <T extends Product> List<T> hydrateProductsPricing(@NonNull
                                                             @NonNull List<T> toHydrate,
                                                             @Nullable
                                                             com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                                             @Nullable
                                                             com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                                             @Nullable
                                                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Hydrates pricing onto the retrieved products.

Type Parameters:

T - The type of the Products

Parameters:

toHydrate - Products to hydrate

priceContext - PriceContext from the originating request

priceInfoContext - PriceInfoContext from the originating request

contextInfo - Multitenant and sandbox info

Returns:

A pricing-hydrated list of the provided products.

getCatalogBrowseWebClient

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

getBrowsePricingProvider

protected PricingProvider getBrowsePricingProvider()

getTypeFactory

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

getUrl

public String getUrl()

The base url for an external catalog service: https://localhost:8447/catalog.

setUrl

public void setUrl(String url)

The base url for an external catalog service: https://localhost:8447/catalog.

getProductsUri

public String getProductsUri()

The URI path for retrieving products. This is appended to url.

setProductsUri

public void setProductsUri(String productsUri)

The URI path for retrieving products. This is appended to url.

getProductAssetsUri

public String getProductAssetsUri()

The URI path for retrieving product assets. This is appended to productsUri. Note that this is only necessary if assets are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of fetchProductsWithDetails(com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest) and fetchCategoryWithDetails(com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest).

setProductAssetsUri

public void setProductAssetsUri(String productAssetsUri)

The URI path for retrieving product assets. This is appended to productsUri. Note that this is only necessary if assets are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of fetchProductsWithDetails(com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest) and fetchCategoryWithDetails(com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest).

getCategoriesUri

public String getCategoriesUri()

The URI path for retrieving categories.

setCategoriesUri

public void setCategoriesUri(String categoriesUri)

The URI path for retrieving categories.

getBrowseEntitiesUri

public String getBrowseEntitiesUri()

The URI path for retrieving browse entities when the type is not known by the caller. This could be the case when the caller has a browser URL but does not know if it belongs to a Catalog or a Product.

setBrowseEntitiesUri

public void setBrowseEntitiesUri(String browseEntitiesUri)

The URI path for retrieving browse entities when the type is not known by the caller. This could be the case when the caller has a browser URL but does not know if it belongs to a Catalog or a Product.

getDataDrivenEnumsUri

public String getDataDrivenEnumsUri()

The URI path for retrieving data driven enums.

setDataDrivenEnumsUri

public void setDataDrivenEnumsUri(String dataDrivenEnumsUri)

The URI path for retrieving data driven enums.

getProductTagsUri

public String getProductTagsUri()

The URI path for retrieving product tags. This is appended to productsUri. Note that this is only necessary if tags are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of fetchProductsWithDetails(com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest) and fetchCategoryWithDetails(com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest).

setProductTagsUri

public void setProductTagsUri(String productTagsUri)

The URI path for retrieving product tags. This is appended to productsUri. Note that this is only necessary if tags are requested separately from product details such as for hydrating search results. Otherwise, they are already hydrated on the results of fetchProductsWithDetails(com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest) and fetchCategoryWithDetails(com.broadleafcommerce.catalogbrowse.domain.CategoryDetailsRequest).

getServiceClient

public String getServiceClient()

The service client to use when interacting with catalog. Default is "catalogbrowseclient"

setServiceClient

public void setServiceClient(String serviceClient)

The service client to use when interacting with catalog. Default is "catalogbrowseclient"