Package com.broadleafcommerce.catalog.service.product.commerce

Class DefaultProductDetailsService

java.lang.Object

com.broadleafcommerce.catalog.service.product.commerce.DefaultProductDetailsService

All Implemented Interfaces:

ProductDetailsService

public class DefaultProductDetailsService
extends Object
implements ProductDetailsService

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor

Description

DefaultProductDetailsService(List<ProductDetailsContributor> detailsContributors, List<ProductDetailsContextContributor> contextContributors, List<ProductDetailsContextConsolidator> contextConsolidators, ProductService<Product> productService, ProductAssetService<ProductAsset> productAssetService, ProductTagService<ProductTag> productTagService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected <T extends ProductDetailsContext> Collection<T>	buildContexts(@NonNull Collection<T> detailsContexts, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds ProductDetailsContexts in response to ProductDetailsRequests.
protected <T extends ProductDetailsContext> ProductDetailsList	buildDetails(@NonNull Collection<T> detailsContexts, @NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds out the ProductDetails in response to a ProductDetailsRequest.
Map<String,List<ProductAsset>>	getAssetsForProducts(@NonNull Collection<String> productIds, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the ProductAssets that match the productIds provided.
protected List<ProductDetailsContextConsolidator>	getContextConsolidators()
protected List<ProductDetailsContextContributor>	getContextContributors()
protected List<ProductDetailsContributor>	getDetailsContributors()
ProductDetailsList	getDetailsForProducts(@NonNull Collection<? extends Product> products, @NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the ProductDetailsList for the provided products.
protected ProductAssetService<ProductAsset>	getProductAssetService()
Optional<ProductDetailsList>	getProductDetailsForRequest(@NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a ProductDetails for the ProductDetailsRequest.
protected ProductService<Product>	getProductService()
protected List<Product>	getProductsForUris(Set<String> productUris, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected ProductTagService<ProductTag>	getProductTagService()
protected ProductDetailsProperties	getProperties()
Map<String,List<ProductTagDetail>>	getTagDetailsForProducts(Collection<String> productIds, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the ProductTags for the given productIds.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected String	getVariantHydrationBehavior(@NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the ProductDetailsRequest.getVariantHydrationBehavior() or defaults to ProductDetailsProperties.getVariantHydrationBehavior() if blank.
protected VariantService<Variant>	getVariantService()
protected BinaryOperator<Product>	mergeProductsWithSameUris()
protected List<Product>	mergeProductsWithSameUris(List<Product> products)	If a SELECTOR product and another product share the same URL, the SELECTOR product replaces the other one.
protected Set<Product>	resolveProducts(@NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Resolves the base product for the given requests.
protected Set<Variant>	resolveVariants(@NonNull ProductDetailsRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	setProperties(ProductDetailsProperties properties)
void	setVariantService(VariantService<Variant> variantService)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultProductDetailsService

public DefaultProductDetailsService(List<ProductDetailsContributor> detailsContributors,
 List<ProductDetailsContextContributor> contextContributors,
 List<ProductDetailsContextConsolidator> contextConsolidators,
 ProductService<Product> productService,
 ProductAssetService<ProductAsset> productAssetService,
 ProductTagService<ProductTag> productTagService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

getProductDetailsForRequest

public Optional<ProductDetailsList> getProductDetailsForRequest(@NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ProductDetailsService

Gets a ProductDetails for the ProductDetailsRequest.

Specified by:

getProductDetailsForRequest in interface ProductDetailsService

Parameters:

request - the ProductDetailsRequest with additional request context for identifying the products for which to retrieve details and defining the how much detail to go into.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

ProductDetailsList for the ProductDetailsRequests.

getAssetsForProducts

public Map<String,List<ProductAsset>> getAssetsForProducts(@NonNull
 @NonNull Collection<String> productIds,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ProductDetailsService

Gets the ProductAssets that match the productIds provided. The results are mapped by the product ID.

Specified by:

getAssetsForProducts in interface ProductDetailsService

Parameters:

productIds - IDs of the Products whose assets to fetch.

filters - additional filters to apply in the query.

contextInfo - context information surrounding sandboxing/multitenant state.

Returns:

the ProductAssets that match the productIds provided.

getDetailsForProducts

public ProductDetailsList getDetailsForProducts(@NonNull
 @NonNull Collection<? extends Product> products,
 @NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ProductDetailsService

Gets the ProductDetailsList for the provided products.

The product IDs and URIs not found should be populated onto the original ProductDetailsRequest rather than be passed in separately to clean up the method signature and allow even more information to be passed in besides in the future or by extensions.

Specified by:

getDetailsForProducts in interface ProductDetailsService

Parameters:

products - Products for which to get a ProductDetailsList.

request - The original request.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

ProductDetailsList for the products.

getTagDetailsForProducts

public Map<String,List<ProductTagDetail>> getTagDetailsForProducts(Collection<String> productIds,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ProductDetailsService

Gets the ProductTags for the given productIds. The results are mapped by the owning product ID.

Specified by:

getTagDetailsForProducts in interface ProductDetailsService

Parameters:

productIds - IDs of the Products whose assets to fetch.

filters - additional filters to apply in the query.

contextInfo - context information surrounding sandboxing/multitenant state.

Returns:

The ProductTags for the given productIds.

getVariantHydrationBehavior

protected String getVariantHydrationBehavior(@NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets the ProductDetailsRequest.getVariantHydrationBehavior() or defaults to ProductDetailsProperties.getVariantHydrationBehavior() if blank.

Parameters:

request - The incoming request

contextInfo - Additional tenant and sandbox info

Returns:

the variant hydration behavior

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

resolveVariants

protected Set<Variant> resolveVariants(@NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

resolveProducts

protected Set<Product> resolveProducts(@NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Resolves the base product for the given requests.

Parameters:

request - The ProductDetailsRequests to use to resolve the base products

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

the resolved base products

getProductsForUris

protected List<Product> getProductsForUris(Set<String> productUris,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

mergeProductsWithSameUris

protected List<Product> mergeProductsWithSameUris(List<Product> products)

If a SELECTOR product and another product share the same URL, the SELECTOR product replaces the other one. If more than one SELECTOR product has the same URI it returns the first one.

Parameters:

products - the list of products to merge

Returns:

the merged list of products

mergeProductsWithSameUris

protected BinaryOperator<Product> mergeProductsWithSameUris()

buildContexts

protected <T extends ProductDetailsContext>
Collection<T> buildContexts(@NonNull
 @NonNull Collection<T> detailsContexts,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds ProductDetailsContexts in response to ProductDetailsRequests. This facilitates gathering all of the related catalog entities to the requested products all at once to allow fewer DB calls throughout the process of building ProductDetails. It first gathers all of the context info using all of the ProductDetailsContextContributors. Then, it consolidates the context info onto the related entities such as adding ProductAssets to the related Products using the ProductDetailsContextConsolidators.

Parameters:

detailsContexts - the ProductDetailsContext with the request context and resolved products populated

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

a ProductDetailsContext in response to a ProductDetailsRequest.

buildDetails

protected <T extends ProductDetailsContext>
ProductDetailsList buildDetails(@NonNull
 @NonNull Collection<T> detailsContexts,
 @NonNull
 @NonNull ProductDetailsRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds out the ProductDetails in response to a ProductDetailsRequest. It relies on all of the ProductDetailsContributors.

Parameters:

detailsContexts - The ProductDetailsContexts created in response to the ProductDetailsRequests. This contains context information and all the catalog entities related to the requested product pre-fetched and consolidated.

request - The original request. The IDs and URIs for entities not found should be hydrated onto this.

contextInfo - context information surrounding sandboxing/multitenant state

Returns:

the ProductDetails in response to a ProductDetailsRequest.

getDetailsContributors

protected List<ProductDetailsContributor> getDetailsContributors()

getContextContributors

protected List<ProductDetailsContextContributor> getContextContributors()

getContextConsolidators

protected List<ProductDetailsContextConsolidator> getContextConsolidators()

getProductService

protected ProductService<Product> getProductService()

getProductAssetService

protected ProductAssetService<ProductAsset> getProductAssetService()

getProductTagService

protected ProductTagService<ProductTag> getProductTagService()

getTypeFactory

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

getVariantService

protected VariantService<Variant> getVariantService()

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

setVariantService

@Autowired
public void setVariantService(VariantService<Variant> variantService)

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

getProperties

protected ProductDetailsProperties getProperties()

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

setProperties

@Autowired
public void setProperties(ProductDetailsProperties properties)

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA