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

Class ExternalCatalogSearchProvider<T extends Product>

java.lang.Object

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

com.broadleafcommerce.catalogbrowse.service.provider.external.search.ExternalCatalogSearchProvider<T>

All Implemented Interfaces:

CatalogSearchProvider<T>

@ConfigurationProperties("broadleaf.catalogbrowse.catalogsearchprovider")
public class ExternalCatalogSearchProvider<T extends Product>
extends AbstractExternalProvider
implements CatalogSearchProvider<T>

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected List<Map<String,Object>>	convertSuggestionsToMap(@NonNull List<T> suggestions)
protected List<T>	convertSuggestionsToProducts(@NonNull List<Map<String,Object>> suggestions)
protected PricingProvider	getBrowsePricingProvider()
protected CatalogProvider	getCatalogProvider()
protected org.springframework.web.reactive.function.client.WebClient	getCatalogSearchWebClient()
protected List<Map<String,Object>>	getHydratedProductSuggestionsPricing(@NonNull List<Map<String,Object>> suggestions, 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 on product type-ahead suggetsions.
SearchResponse<T>	getSearchResults(@NonNull CatalogSearchRequest request)	Performs a search for the provided request.
String	getSearchUri()	The context path to the catalog search endpoint
String	getServiceClient()	The service client to use when calling search.
TypeAheadResponse	getSuggestions(@NonNull CatalogTypeAheadRequest request)	Gets suggestions for a search typeahead component based on the request.
String	getSuggestUri()	The context path to the catalog search suggestions endpoint
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
String	getUrl()	The base url for an external search service: https://localhost:8447/search.
protected void	hydrateProductAssets(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Makes an additional call to the CatalogProvider to hydrate Assets for the search results.
protected void	hydrateProductPricing(@NonNull Collection<T> products, 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 results of a search request.
protected void	hydrateProductTags(@NonNull Collection<T> products, org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Makes an additional call to the CatalogProvider to hydrate ProductTags for the search results.
boolean	isHydrateAssets()	Determines whether an additional call to Catalog Services should be made to hydrate the search results with additional product assets.
void	setHydrateAssets(boolean hydrateAssets)	Determines whether an additional call to Catalog Services should be made to hydrate the search results with additional product assets.
protected void	setProductPriceInfos(@NonNull Collection<T> products, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Ensures that all Products with simple prices have those replaced with a PriceInfo.
void	setSearchUri(String searchUri)	The context path to the catalog search endpoint
void	setServiceClient(String serviceClient)	The service client to use when calling search.
void	setSuggestUri(String suggestUri)	The context path to the catalog search suggestions endpoint
void	setUrl(String url)	The base url for an external search service: https://localhost:8447/search.

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

ExternalCatalogSearchProvider

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

Method Detail

getSearchResults

public SearchResponse<T> getSearchResults(@NonNull
                                          @NonNull CatalogSearchRequest request)

Description copied from interface: CatalogSearchProvider

Performs a search for the provided request.

Specified by:

getSearchResults in interface CatalogSearchProvider<T extends Product>

Parameters:

request - All of the relevant information to be used to retrieve search results.

Returns:

The SearchResponse with results for the request.

getSuggestions

public TypeAheadResponse getSuggestions(@NonNull
                                        @NonNull CatalogTypeAheadRequest request)

Description copied from interface: CatalogSearchProvider

Gets suggestions for a search typeahead component based on the request.

Specified by:

getSuggestions in interface CatalogSearchProvider<T extends Product>

Parameters:

request - All of the relevant information to be used to retrieve type-ahead suggestions.

Returns:

The TypeAheadResponse with the results for the request.

getHydratedProductSuggestionsPricing

protected List<Map<String,Object>> getHydratedProductSuggestionsPricing(@NonNull
                                                                              @NonNull List<Map<String,Object>> suggestions,
                                                                              @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 on product type-ahead suggetsions.

Parameters:

suggestions - Suggestions to be hydrated

priceContext - PriceContext from the original request containing general pricing info

priceInfoContext - PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.

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

Returns:

Hydrated product suggestions

hydrateProductPricing

protected void hydrateProductPricing(@NonNull
                                     @NonNull Collection<T> products,
                                     @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 results of a search request.

Parameters:

products - The products from the SearchResponse to be hydrated

priceContext - PriceContext from the original request containing general pricing info

priceInfoContext - PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.

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

setProductPriceInfos

protected void setProductPriceInfos(@NonNull
                                    @NonNull Collection<T> products,
                                    @Nullable
                                    com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Ensures that all Products with simple prices have those replaced with a PriceInfo.

Parameters:

products - Search results whose contents to ensure to have a PriceInfos instead of simple prices.

hydrateProductAssets

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

Makes an additional call to the CatalogProvider to hydrate Assets for the search results.

This hydration is gated by isHydrateAssets().

Parameters:

products - The search results.

parameters - Additional parameters to include the request like filters

contextInfo - Additional sandbox and multitenant state.

hydrateProductTags

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

Makes an additional call to the CatalogProvider to hydrate ProductTags for the search results.

Parameters:

products - The search results.

parameters - Additional parameters to include the request like filters

contextInfo - Additional sandbox and multitenant state.

convertSuggestionsToProducts

protected List<T> convertSuggestionsToProducts(@NonNull
                                               @NonNull List<Map<String,Object>> suggestions)

convertSuggestionsToMap

protected List<Map<String,Object>> convertSuggestionsToMap(@NonNull
                                                                 @NonNull List<T> suggestions)

getCatalogSearchWebClient

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

getTypeFactory

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

getBrowsePricingProvider

protected PricingProvider getBrowsePricingProvider()

getCatalogProvider

protected CatalogProvider getCatalogProvider()

getUrl

public String getUrl()

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

setUrl

public void setUrl(String url)

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

getSearchUri

public String getSearchUri()

The context path to the catalog search endpoint

setSearchUri

public void setSearchUri(String searchUri)

The context path to the catalog search endpoint

getSuggestUri

public String getSuggestUri()

The context path to the catalog search suggestions endpoint

setSuggestUri

public void setSuggestUri(String suggestUri)

The context path to the catalog search suggestions endpoint

isHydrateAssets

public boolean isHydrateAssets()

Determines whether an additional call to Catalog Services should be made to hydrate the search results with additional product assets.

setHydrateAssets

public void setHydrateAssets(boolean hydrateAssets)

Determines whether an additional call to Catalog Services should be made to hydrate the search results with additional product assets.

getServiceClient

public String getServiceClient()

The service client to use when calling search. Default is "catalogbrowseclient"

setServiceClient

public void setServiceClient(String serviceClient)

The service client to use when calling search. Default is "catalogbrowseclient"