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

Class ExternalContentProvider

java.lang.Object

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

com.broadleafcommerce.catalogbrowse.service.provider.external.content.ExternalContentProvider

All Implemented Interfaces:

BrowseEntityProvider, ContentProvider

public class ExternalContentProvider
extends AbstractExternalProvider
implements ContentProvider

Connects to an external content service.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addCustomerRef(@NonNull ContentContext contentContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Adds CustomerRef to the ContentContext based on the authentication and context info.
protected void	attachHydratedRecommendations(ContentItemFieldData fieldData, Map<String,Collection<String>> recommendedProductIds, Map<String,Object> productMap)
BrowseEntityDetails	fetchBrowseEntityDetails(@NonNull BrowseDetailsRequest request)	Retrieves a browse entity such as a Product that matches the given request.
BulkContentResolverResponse	fetchBulkContentForRequest(@NonNull BulkContentResolverRequest request)	Retrieves a BulkContentResolverResponse for the BulkContentResolverResponse.
ContentResolverResponse	fetchContentForRequest(@NonNull ContentResolverRequest request)	Retrieves a ContentResolverResponse for the ContentResolverResponse.
protected CatalogProvider	getBrowseCatalogProvider()
protected String	getBulkContentItemsUri()
protected org.springframework.web.reactive.function.client.WebClient	getCatalogBrowseWebClient()
protected String	getContentItemsUri()
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper()
protected OfferProvider	getOfferProvider()
protected ExternalContentProviderProperties	getProperties()
protected RecommendationProvider	getRecommendationProvider()
protected List<ContentItem>	getResultsWithNestedItems(List<ContentItem> contentItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String	getServiceClient()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected String	getUrl()
protected void	hydrateCategories(ContentResolverResponse items, @NonNull ContentResolverRequest resolverRequest)
protected void	hydrateExternalEntities(ContentResolverResponse items, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, ContentResolverRequest request)
protected void	hydrateOffers(ContentResolverResponse items, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,Map<String,Collection<String>>>	hydrateProductRecommendationIdsIfApplicable(ContentResolverResponse contentResolverResponse, ContentResolverRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	hydrateProducts(ContentResolverResponse items, ContentResolverRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected boolean	isHydrateExternalEntities()
protected void	recursivelyFindEntityIds(ContentItem item, String entityReferenceType, Set<String> ids)
protected void	recursivelyFindEntityIdsExcluding(ContentItem item, String entityReferenceType, Map<String,Map<String,Collection<String>>> allExcludedIds, Set<String> ids)
protected void	recursivelyHydrateEntities(ContentItem item, String entityReferenceType, Map<String,Object> entityMap)
protected void	recursivelyHydrateEntitiesIncludingRecommendations(ContentItem item, String entityReferenceType, Map<String,Map<String,Collection<String>>> allRecommendationIds, Map<String,Object> entityMap)
protected void	removeAuthorFromContentItems(ContentResolverResponse items)	Remove author information from content items before passing them.
void	setBrowseCatalogProvider(CatalogProvider browseCatalogProvider)
void	setOfferProvider(OfferProvider offerProvider)
void	setProperties(ExternalContentProviderProperties properties)
void	setRecommendationProvider(RecommendationProvider recommendationProvider)

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

getAuthenticationUtils, getExternalProviderProperties, getHeaders, getHeaders, isCallerWhitelistedService, setAuthenticationUtils, setExternalProviderProperties

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalContentProvider

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

Method Details

fetchContentForRequest

public ContentResolverResponse fetchContentForRequest(@NonNull
 @NonNull ContentResolverRequest request)

Description copied from interface: ContentProvider

Retrieves a ContentResolverResponse for the ContentResolverResponse.

Specified by:

fetchContentForRequest in interface ContentProvider

Parameters:

request - All relevant information to retrieve ContentItems.

Returns:

A ContentResolverResponse for the ContentResolverResponse.

fetchBulkContentForRequest

public BulkContentResolverResponse fetchBulkContentForRequest(@NonNull
 @NonNull BulkContentResolverRequest request)

Description copied from interface: ContentProvider

Retrieves a BulkContentResolverResponse for the BulkContentResolverResponse.

Specified by:

fetchBulkContentForRequest in interface ContentProvider

Parameters:

request - All relevant information to retrieve ContentItems in bulk.

Returns:

A BulkContentResolverResponse for the BulkContentResolverResponse.

hydrateCategories

protected void hydrateCategories(ContentResolverResponse items,
 @NonNull
 @NonNull ContentResolverRequest resolverRequest)

hydrateProducts

protected void hydrateProducts(ContentResolverResponse items,
 @NonNull
 ContentResolverRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

hydrateOffers

protected void hydrateOffers(ContentResolverResponse items,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

hydrateProductRecommendationIdsIfApplicable

protected Map<String,Map<String,Collection<String>>> hydrateProductRecommendationIdsIfApplicable(ContentResolverResponse contentResolverResponse,
 @NonNull
 ContentResolverRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

attachHydratedRecommendations

protected void attachHydratedRecommendations(ContentItemFieldData fieldData,
 Map<String,Collection<String>> recommendedProductIds,
 Map<String,Object> productMap)

getResultsWithNestedItems

protected List<ContentItem> getResultsWithNestedItems(List<ContentItem> contentItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

recursivelyFindEntityIdsExcluding

protected void recursivelyFindEntityIdsExcluding(ContentItem item,
 String entityReferenceType,
 Map<String,Map<String,Collection<String>>> allExcludedIds,
 Set<String> ids)

recursivelyHydrateEntitiesIncludingRecommendations

protected void recursivelyHydrateEntitiesIncludingRecommendations(ContentItem item,
 String entityReferenceType,
 Map<String,Map<String,Collection<String>>> allRecommendationIds,
 Map<String,Object> entityMap)

recursivelyFindEntityIds

protected void recursivelyFindEntityIds(ContentItem item,
 String entityReferenceType,
 Set<String> ids)

recursivelyHydrateEntities

protected void recursivelyHydrateEntities(ContentItem item,
 String entityReferenceType,
 Map<String,Object> entityMap)

fetchBrowseEntityDetails

public BrowseEntityDetails fetchBrowseEntityDetails(@NonNull
 @NonNull BrowseDetailsRequest request)

Description copied from interface: BrowseEntityProvider

Retrieves a browse entity such as a Product that matches the given request.

Specified by:

fetchBrowseEntityDetails in interface BrowseEntityProvider

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

addCustomerRef

protected void addCustomerRef(@NonNull
 @NonNull ContentContext contentContext,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Adds CustomerRef to the ContentContext based on the authentication and context info.

Parameters:

contentContext - The ContentContext for the request.

contextInfo - Additional tenant and sandbox info that may also include customer segment ids.

hydrateExternalEntities

protected void hydrateExternalEntities(ContentResolverResponse items,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 ContentResolverRequest request)

removeAuthorFromContentItems

protected void removeAuthorFromContentItems(ContentResolverResponse items)

Remove author information from content items before passing them. This is done to address privacy concerns that may arise when author information is on the payload.

getUrl

protected String getUrl()

getContentItemsUri

protected String getContentItemsUri()

getBulkContentItemsUri

protected String getBulkContentItemsUri()

getServiceClient

protected String getServiceClient()

isHydrateExternalEntities

protected boolean isHydrateExternalEntities()

getCatalogBrowseWebClient

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

getTypeFactory

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

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()

Overrides:

getMapper in class AbstractExternalProvider

getBrowseCatalogProvider

protected CatalogProvider getBrowseCatalogProvider()

setBrowseCatalogProvider

@Autowired
@Lazy
public void setBrowseCatalogProvider(CatalogProvider browseCatalogProvider)

getOfferProvider

protected OfferProvider getOfferProvider()

setOfferProvider

@Autowired
@Lazy
public void setOfferProvider(OfferProvider offerProvider)

getRecommendationProvider

protected RecommendationProvider getRecommendationProvider()

setRecommendationProvider

@Autowired
@Lazy
public void setRecommendationProvider(RecommendationProvider recommendationProvider)

getProperties

protected ExternalContentProviderProperties getProperties()

setProperties

@Autowired
public void setProperties(ExternalContentProviderProperties properties)