Package com.broadleafcommerce.catalogbrowse.web.endpoint

Class CatalogBrowseEndpoint

java.lang.Object

com.broadleafcommerce.catalogbrowse.web.endpoint.CatalogBrowseEndpoint

@FrameworkRestController
@FrameworkMapping
public class CatalogBrowseEndpoint
extends Object

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
CatalogBrowseEndpoint(CatalogProvider browseCatalogProvider, CatalogSearchProvider<Product> browseCatalogSearchProvider, OfferProvider browseOfferProvider, MarketingMessageUtils marketingMessageUtils, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected CatalogProvider	getBrowseCatalogProvider()
protected CatalogSearchProvider<Product>	getBrowseCatalogSearchProvider()
protected OfferProvider	getBrowseOfferProvider()
SearchResponse<Product>	getCatalogSearchResults(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)
TypeAheadResponse	getCatalogSuggestions(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)
MarketingMessageResponse	getMarketingMessages(MarketingMessageRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected MarketingMessageUtils	getMarketingMessageUtils()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
BrowseEntityDetails	readBrowseEntityDetails(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)
Category	readCategoryDetails(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)
DataDrivenEnumList	readDataDrivenEnumDetails(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, DataDrivenEnumDetailsRequest detailsRequest)
ProductList	readProductDetails(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, org.springframework.util.MultiValueMap<String,String> parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogBrowseEndpoint

public CatalogBrowseEndpoint(CatalogProvider browseCatalogProvider,
                             CatalogSearchProvider<Product> browseCatalogSearchProvider,
                             OfferProvider browseOfferProvider,
                             MarketingMessageUtils marketingMessageUtils,
                             com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Detail

readProductDetails

@FrameworkGetMapping("/products/details")
public ProductList readProductDetails(javax.servlet.http.HttpServletRequest request,
                                      @ContextOperation
                                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                      @RequestHeader(value="X-Price-Context",required=false)
                                      com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                      @RequestHeader(value="X-Price-Info-Context",required=false)
                                      com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                      @RequestParam
                                      org.springframework.util.MultiValueMap<String,String> parameters)

readCategoryDetails

@FrameworkGetMapping("/categories/details")
public Category readCategoryDetails(javax.servlet.http.HttpServletRequest request,
                                    @ContextOperation
                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                    @RequestHeader(value="X-Price-Context",required=false)
                                    com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                    @RequestHeader(value="X-Price-Info-Context",required=false)
                                    com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                    @RequestParam
                                    org.springframework.util.MultiValueMap<String,String> parameters)

readBrowseEntityDetails

@FrameworkGetMapping("/browse/details")
public BrowseEntityDetails readBrowseEntityDetails(javax.servlet.http.HttpServletRequest request,
                                                   @ContextOperation
                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                   @RequestHeader(value="X-Price-Context",required=false)
                                                   com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                                   @RequestHeader(value="X-Price-Info-Context",required=false)
                                                   com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                                   @RequestParam
                                                   org.springframework.util.MultiValueMap<String,String> parameters)

readDataDrivenEnumDetails

@FrameworkGetMapping("/data-driven-enums/details")
public DataDrivenEnumList readDataDrivenEnumDetails(javax.servlet.http.HttpServletRequest request,
                                                    @ContextOperation
                                                    com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                    DataDrivenEnumDetailsRequest detailsRequest)

getCatalogSearchResults

@FrameworkGetMapping("/search/catalog")
public SearchResponse<Product> getCatalogSearchResults(javax.servlet.http.HttpServletRequest request,
                                                       @ContextOperation
                                                       com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                                       @RequestHeader(value="X-Price-Context",required=false)
                                                       com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                                       @RequestHeader(value="X-Price-Info-Context",required=false)
                                                       com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                                       @RequestParam
                                                       org.springframework.util.MultiValueMap<String,String> parameters)

getCatalogSuggestions

@FrameworkGetMapping("/search/catalog/suggest")
public TypeAheadResponse getCatalogSuggestions(javax.servlet.http.HttpServletRequest request,
                                               @ContextOperation
                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
                                               @RequestHeader(value="X-Price-Context",required=false)
                                               com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext,
                                               @RequestHeader(value="X-Price-Info-Context",required=false)
                                               com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext,
                                               @RequestParam
                                               org.springframework.util.MultiValueMap<String,String> parameters)

getMarketingMessages

@FrameworkPostMapping("/marketing-messages")
public MarketingMessageResponse getMarketingMessages(@RequestBody
                                                     MarketingMessageRequest request,
                                                     @ContextOperation
                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBrowseCatalogProvider

protected CatalogProvider getBrowseCatalogProvider()

getBrowseCatalogSearchProvider

protected CatalogSearchProvider<Product> getBrowseCatalogSearchProvider()

getBrowseOfferProvider

protected OfferProvider getBrowseOfferProvider()

getMarketingMessageUtils

protected MarketingMessageUtils getMarketingMessageUtils()

getTypeFactory

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