Package com.broadleafcommerce.search.index.customer.service

Class DefaultCustomerService

java.lang.Object

com.broadleafcommerce.search.index.customer.service.DefaultCustomerService

All Implemented Interfaces:

CustomerService

public class DefaultCustomerService
extends Object
implements CustomerService

Default implementation to read customers from the Customer Service.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CLIENT_REGISTRATION_ID

Constructor Summary

Constructors

Constructor	Description
DefaultCustomerService(org.springframework.web.reactive.function.client.WebClient webClient, String customerEndpoint, String readCustomerIdsPath, String readCustomersPath)

Method Summary

Modifier and Type	Method	Description
protected void	addBatchCustomerIdFilter(org.springframework.web.util.UriBuilder uriBuilder, List<String> ids)
protected cz.jirutka.rsql.parser.ast.Node	buildBatchCustomerIdsFilters(String startId, Map<String,Object> additionalProperties)
protected String	buildReadBatchOfCustomerIdsUri(String startId, int batchSize)	Deprecated. in favor of buildReadBatchOfCustomerIdsUri(String, int, Map<String, Object>) for the potential to utilize a time range when reading customers.
protected String	buildReadBatchOfCustomerIdsUri(String startId, int batchSize, Map<String,Object> additionalProperties)	Build the product id URI based on the provided parameters.
protected String	buildReadBatchOfCustomersUri(List<String> ids)
protected String	getCustomerEndpoint()
protected String	getReadCustomerIdsPath()
protected String	getReadCustomersPath()
String	getServiceClient()	The service client to use when calling inventory services.
protected org.springframework.web.reactive.function.client.WebClient	getWebClient()
List<String>	readBatchOfCustomerIds(String startId, int batchSize)
List<String>	readBatchOfCustomerIds(String startId, int batchSize, Map<String,Object> additionalProperties)	Reads a batch of IDs to be placed in a queue for processing.
List<com.broadleafcommerce.search.customer.core.domain.Customer>	readBatchOfCustomers(List<String> ids)	Reads a batch of Customers by their IDs.
Optional<com.broadleafcommerce.search.customer.core.domain.Customer>	readCustomer(@NonNull String id)	Reads a batch of Customers by their IDs.
void	setServiceClient(String serviceClient)	The service client to use when calling inventory services.

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

Constructor Details

DefaultCustomerService

public DefaultCustomerService(org.springframework.web.reactive.function.client.WebClient webClient,
 String customerEndpoint,
 String readCustomerIdsPath,
 String readCustomersPath)

Method Details

readBatchOfCustomerIds

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

Specified by:

readBatchOfCustomerIds in interface CustomerService

Throws:

com.broadleafcommerce.search.api.SearchIndexException

readBatchOfCustomerIds

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

Description copied from interface: CustomerService

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

Specified by:

readBatchOfCustomerIds in interface CustomerService

Parameters:

startId - The starting ID

batchSize - The size of the batch

additionalProperties - additional information that can be used to filter the items to be indexed

Returns:

A list of customer IDs.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the customer ids fails.

buildReadBatchOfCustomerIdsUri

@Deprecated(since="2.1.5-GA")
protected String buildReadBatchOfCustomerIdsUri(@Nullable
 String startId,
 int batchSize)

Deprecated.

in favor of buildReadBatchOfCustomerIdsUri(String, int, Map<String, Object>) for the potential to utilize a time range when reading customers.

buildReadBatchOfCustomerIdsUri

protected String buildReadBatchOfCustomerIdsUri(@Nullable
 String startId,
 int batchSize,
 @Nullable
 Map<String,Object> additionalProperties)

Build the product id URI based on the provided parameters.

Parameters:

startId - The starting ID

batchSize - The size of the batch

additionalProperties - additional information that can be used to filter the items to be indexed

Returns:

the built uri

readBatchOfCustomers

public List<com.broadleafcommerce.search.customer.core.domain.Customer> readBatchOfCustomers(List<String> ids)
                                                                                      throws com.broadleafcommerce.search.api.SearchIndexException

Description copied from interface: CustomerService

Reads a batch of Customers by their IDs.

Specified by:

readBatchOfCustomers in interface CustomerService

Parameters:

ids - A list of customer IDs.

Returns:

A list of customers or an empty list.

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the customer fails.

readCustomer

public Optional<com.broadleafcommerce.search.customer.core.domain.Customer> readCustomer(@NonNull @NonNull
 @NonNull String id)
                                                                                  throws com.broadleafcommerce.search.api.SearchIndexException

Description copied from interface: CustomerService

Reads a batch of Customers by their IDs.

Specified by:

readCustomer in interface CustomerService

Parameters:

id - A customer id

Returns:

A customer optional or Optional.empty()

Throws:

com.broadleafcommerce.search.api.SearchIndexException - if reading the customer fails.

buildReadBatchOfCustomersUri

protected String buildReadBatchOfCustomersUri(List<String> ids)

addBatchCustomerIdFilter

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

buildBatchCustomerIdsFilters

protected cz.jirutka.rsql.parser.ast.Node buildBatchCustomerIdsFilters(@Nullable
 String startId,
 @Nullable
 Map<String,Object> additionalProperties)

getWebClient

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

getCustomerEndpoint

protected String getCustomerEndpoint()

getReadCustomerIdsPath

protected String getReadCustomerIdsPath()

getReadCustomersPath

protected String getReadCustomersPath()

getServiceClient

public String getServiceClient()

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

setServiceClient

public void setServiceClient(String serviceClient)

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