Package com.broadleafcommerce.search.index.catalog.service

Class DefaultCatalogService

java.lang.Object

com.broadleafcommerce.search.index.catalog.service.DefaultCatalogService

All Implemented Interfaces:

CatalogService

public class DefaultCatalogService
extends Object
implements CatalogService

Default implementation to read products from the Catalog Service.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CLIENT_REGISTRATION_ID
static final String	CONFIGURABLE_PARAM
static final String	CONTEXT_ID
static final String	ID_IN_QUERY_PARAM
static final String	ID_START_QUERY_PARAM
static final String	INCLUDE_ALL_PRODUCT_ASSETS_PARAM
static final String	RSQL_FILTER_PARAM
static final String	SIZE_QUERY_PARAM
static final String	SORT_QUERY_PARAM

Constructor Summary

Constructors

Constructor	Description
DefaultCatalogService(org.springframework.web.reactive.function.client.WebClient webClient, String catalogEndpoint, String readProductIdsPath, String readProductsPath)

Method Summary

Modifier and Type	Method	Description
protected void	addBatchProductIdFilter(org.springframework.web.util.UriBuilder uriBuilder, List<String> ids)
protected void	addProductConsolidationConfigurationParams(org.springframework.web.util.UriBuilder uriBuilder)	Adds the request parameters to configure the product consolidation request.
protected String	buildReadBatchOfProductIdsUri(String startId, int batchSize)
protected String	buildReadBatchOfProductsUri(List<String> ids)	Builds a catalog fetch URI with a filter containing a range of IDs of products to retrieve from catalog.
protected String	getCatalogEndpoint()
protected com.broadleafcommerce.common.extension.intercommunication.ExternalClient	getExternalClient()
protected String	getReadProductIdsPath()
protected String	getReadProductsPath()
String	getServiceClient()	The service client to use when calling catalog.
protected org.springframework.web.reactive.function.client.WebClient	getWebClient()
List<String>	readBatchOfProductIds(String startId, int batchSize)	Reads a batch of IDs to be placed in a queue for processing.
List<com.broadleafcommerce.search.catalog.core.domain.Product>	readBatchOfProducts(String id)	Reads a batch of Products by an id.
List<com.broadleafcommerce.search.catalog.core.domain.Product>	readBatchOfProducts(List<String> ids)	Reads a batch of Products by their IDs.
void	setExternalClient(com.broadleafcommerce.common.extension.intercommunication.ExternalClient externalClient)
void	setServiceClient(String serviceClient)	The service client to use when calling catalog.

Methods inherited from class java.lang.Object

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

Field Details

CLIENT_REGISTRATION_ID

protected static final String CLIENT_REGISTRATION_ID

See Also:

• Constant Field Values

RSQL_FILTER_PARAM

public static final String RSQL_FILTER_PARAM

See Also:

• Constant Field Values

ID_START_QUERY_PARAM

public static final String ID_START_QUERY_PARAM

See Also:

• Constant Field Values

SIZE_QUERY_PARAM

public static final String SIZE_QUERY_PARAM

See Also:

• Constant Field Values

SORT_QUERY_PARAM

public static final String SORT_QUERY_PARAM

See Also:

• Constant Field Values

ID_IN_QUERY_PARAM

public static final String ID_IN_QUERY_PARAM

See Also:

• Constant Field Values

CONTEXT_ID

public static final String CONTEXT_ID

See Also:

• Constant Field Values

CONFIGURABLE_PARAM

public static final String CONFIGURABLE_PARAM

See Also:

• Constant Field Values

INCLUDE_ALL_PRODUCT_ASSETS_PARAM

public static final String INCLUDE_ALL_PRODUCT_ASSETS_PARAM

See Also:

• Constant Field Values

Constructor Details

DefaultCatalogService

public DefaultCatalogService(org.springframework.web.reactive.function.client.WebClient webClient,
 String catalogEndpoint,
 String readProductIdsPath,
 String readProductsPath)

Method Details

readBatchOfProductIds

public List<String> readBatchOfProductIds(@Nullable
 String startId,
 int batchSize)
                                   throws com.broadleafcommerce.search.api.SearchIndexException

Description copied from interface: CatalogService

Reads a batch of IDs to be placed in a queue for processing.

Specified by:

readBatchOfProductIds in interface CatalogService

Parameters:

startId - The starting ID

batchSize - The size of the batch to read

Returns:

A list of product IDs.

Throws:

com.broadleafcommerce.search.api.SearchIndexException

readBatchOfProducts

public List<com.broadleafcommerce.search.catalog.core.domain.Product> readBatchOfProducts(List<String> ids)
                                                                                   throws com.broadleafcommerce.search.api.SearchIndexException

Description copied from interface: CatalogService

Reads a batch of Products by their IDs.

Specified by:

readBatchOfProducts in interface CatalogService

Parameters:

ids - A list of product IDs.

Returns:

A list of products or an empty list.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if the service call fails for any reason.

readBatchOfProducts

public List<com.broadleafcommerce.search.catalog.core.domain.Product> readBatchOfProducts(String id)
                                                                                   throws com.broadleafcommerce.search.api.SearchIndexException

Description copied from interface: CatalogService

Reads a batch of Products by an id.

Specified by:

readBatchOfProducts in interface CatalogService

Parameters:

id - A product ID.

Returns:

A list of products or an empty list.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if the service call fails for any reason.

buildReadBatchOfProductIdsUri

protected String buildReadBatchOfProductIdsUri(@Nullable
 String startId,
 int batchSize)

buildReadBatchOfProductsUri

protected String buildReadBatchOfProductsUri(List<String> ids)

Builds a catalog fetch URI with a filter containing a range of IDs of products to retrieve from catalog.

e.g. id=ge=1;id=le=10

The List of ids passed into this method should be in ascending order.

Parameters:

ids - The list of ids

Returns:

A URI for retrieving a list of products from catalog.

addProductConsolidationConfigurationParams

protected void addProductConsolidationConfigurationParams(org.springframework.web.util.UriBuilder uriBuilder)

Adds the request parameters to configure the product consolidation request.

Parameters:

uriBuilder - the UriBuilder to add the request parameters for

addBatchProductIdFilter

protected void addBatchProductIdFilter(org.springframework.web.util.UriBuilder uriBuilder,
 List<String> ids)

getWebClient

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

getCatalogEndpoint

protected String getCatalogEndpoint()

getReadProductIdsPath

protected String getReadProductIdsPath()

getReadProductsPath

protected String getReadProductsPath()

getExternalClient

protected com.broadleafcommerce.common.extension.intercommunication.ExternalClient getExternalClient()

setExternalClient

@Autowired
@Qualifier("catalogExternalClient")
public void setExternalClient(com.broadleafcommerce.common.extension.intercommunication.ExternalClient externalClient)

getServiceClient

public String getServiceClient()

The service client to use when calling catalog. Default is "indexerclient".

setServiceClient

public void setServiceClient(String serviceClient)

The service client to use when calling catalog. Default is "indexerclient".