com.broadleafcommerce.rest.api.endpoint.catalog

Class CatalogEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.catalog.CatalogEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

@FrameworkRestController
 @FrameworkMapping(value="/catalog/",
                  produces={"application/json","application/xml"})
public class CatalogEndpoint
extends BaseEndpoint

This class exposes catalog services as RESTful APIs. It is dependent on a JAX-RS implementation such as Jersey. This class must be extended, with appropriate JAX-RS annotations, such as:

javax.ws.rs.@Scope

javax.ws.rs.@Path

javax.ws.rs.@Produces

javax.ws.rs.@Consumes

javax.ws.rs.@Context

etc...

... in the subclass. The subclass must also be a Spring Bean. The subclass can then override the methods, and specify custom inputs and outputs. It will also specify javax.ws.rs.@Path annotations, javax.ws.rs.@Context, javax.ws.rs.@PathParam, javax.ws.rs.@QueryParam, javax.ws.rs.@GET, javax.ws.rs.@POST, etc... Essentially, the subclass will override and extend the methods of this class, add new methods, and control the JAX-RS behavior using annotations according to the JAX-RS specification.

Author:

Jay Aisenbrey (cja769)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected org.broadleafcommerce.common.security.service.ExploitProtectionService	exploitProtectionService
protected org.broadleafcommerce.core.web.service.SearchFacetDTOService	facetService
protected org.broadleafcommerce.core.inventory.service.InventoryService	inventoryService
protected PromotionMessageDTOWrapperService	promotionMessageDTOWrapperService
protected org.broadleafcommerce.core.search.service.SearchService	searchService
protected org.broadleafcommerce.common.file.service.StaticAssetPathService	staticAssetPathService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor and Description
CatalogEndpoint()

Method Summary

Modifier and Type	Method and Description
CategoriesWrapper	findActiveSubCategories(javax.servlet.http.HttpServletRequest request, Long id, int limit, int offset)
CategoriesWrapper	findAllCategories(javax.servlet.http.HttpServletRequest request, String name, int limit, int offset)
List<CategoryAttributeWrapper>	findCategoryAttributesForCategory(javax.servlet.http.HttpServletRequest request, Long categoryId)
CategoryWrapper	findCategoryById(javax.servlet.http.HttpServletRequest request, Long id, int productLimit, int productOffset, int subcategoryLimit, int subcategoryOffset)
CategoryWrapper	findCategoryByIdOrName(javax.servlet.http.HttpServletRequest request, String searchParameter, int productLimit, int productOffset, int subcategoryLimit, int subcategoryOffset) Allows you to search for a category by ID or by name.
List<RelatedProductWrapper>	findCrossSaleProductsByProduct(javax.servlet.http.HttpServletRequest request, Long id, int limit, int offset)
SkuWrapper	findDefaultSkuByProductId(javax.servlet.http.HttpServletRequest request, Long id)
List<InventoryWrapper>	findInventoryForSkus(javax.servlet.http.HttpServletRequest request, List<Long> ids)
List<MediaWrapper>	findMediaForCategory(javax.servlet.http.HttpServletRequest request, Long id)
List<MediaWrapper>	findMediaForProduct(javax.servlet.http.HttpServletRequest request, Long id)
List<MediaWrapper>	findMediaForSku(javax.servlet.http.HttpServletRequest request, Long id)
CategoriesWrapper	findParentCategoriesForProduct(javax.servlet.http.HttpServletRequest request, Long id)
List<ProductAttributeWrapper>	findProductAttributesForProduct(javax.servlet.http.HttpServletRequest request, Long id)
ProductWrapper	findProductById(javax.servlet.http.HttpServletRequest request, Long id) Search for Product by product id
ProductWrapper	findProductById(javax.servlet.http.HttpServletRequest request, Long id, Boolean includePromotionMessages, Boolean includePriceData) Search for Product by product id
SearchResultsWrapper	findSearchResultsByCategoryAndQuery(javax.servlet.http.HttpServletRequest request, Long categoryId, String q, Integer pageSize, Integer page, Boolean includePromotionMessages, Boolean includePriceData) This uses Broadleaf's search service to search for products or skus within a category.
SearchResultsWrapper	findSearchResultsByQuery(javax.servlet.http.HttpServletRequest request, String q, Integer pageSize, Integer page, Boolean includePromotionMessages, Boolean includePriceData) Queries for products or skus.
List<SkuAttributeWrapper>	findSkuAttributesForSku(javax.servlet.http.HttpServletRequest request, Long id)
SkuWrapper	findSkuById(javax.servlet.http.HttpServletRequest request, Long id)
List<SkuWrapper>	findSkusByProductById(javax.servlet.http.HttpServletRequest request, Long id) Search for Sku instances for a given product
CategoriesWrapper	findSubCategories(javax.servlet.http.HttpServletRequest request, Long id, int limit, int offset, boolean active)
List<RelatedProductWrapper>	findUpSaleProductsByProduct(javax.servlet.http.HttpServletRequest request, Long id, int limit, int offset)
protected org.broadleafcommerce.core.search.service.SearchService	getSearchService()

Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

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

Field Detail

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

searchService

protected org.broadleafcommerce.core.search.service.SearchService searchService

facetService

protected org.broadleafcommerce.core.web.service.SearchFacetDTOService facetService

exploitProtectionService

protected org.broadleafcommerce.common.security.service.ExploitProtectionService exploitProtectionService

staticAssetPathService

protected org.broadleafcommerce.common.file.service.StaticAssetPathService staticAssetPathService

inventoryService

protected org.broadleafcommerce.core.inventory.service.InventoryService inventoryService

promotionMessageDTOWrapperService

protected PromotionMessageDTOWrapperService promotionMessageDTOWrapperService

Constructor Detail

CatalogEndpoint

public CatalogEndpoint()

Method Detail

findProductById

public ProductWrapper findProductById(javax.servlet.http.HttpServletRequest request,
                                      Long id)

Search for Product by product id

Parameters:

id - the product id

Returns:

the product instance with the given product id

findProductById

@FrameworkMapping(value="product/{id}",
                  method=GET)
public ProductWrapper findProductById(javax.servlet.http.HttpServletRequest request,
                                                                                                            @PathVariable(value="id")
                                                                                                            Long id,
                                                                                                            @RequestParam(value="includePromotionMessages",required=false)
                                                                                                            Boolean includePromotionMessages,
                                                                                                            @RequestParam(value="includePriceData",required=false)
                                                                                                            Boolean includePriceData)

Search for Product by product id

Parameters:

id - the product id

includePromotionMessages - whether or not PromotionMessages should be included

includePriceData -

Returns:

the product instance with the given product id

findSearchResultsByCategoryAndQuery

@FrameworkMapping(value="search/category/{categoryId}",
                  method=GET)
public SearchResultsWrapper findSearchResultsByCategoryAndQuery(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                      @PathVariable(value="categoryId")
                                                                                                                                                      Long categoryId,
                                                                                                                                                      @RequestParam(value="q",required=false)
                                                                                                                                                      String q,
                                                                                                                                                      @RequestParam(value="pageSize",required=false,defaultValue="15")
                                                                                                                                                      Integer pageSize,
                                                                                                                                                      @RequestParam(value="page",required=false,defaultValue="1")
                                                                                                                                                      Integer page,
                                                                                                                                                      @RequestParam(value="includePromotionMessages",required=false)
                                                                                                                                                      Boolean includePromotionMessages,
                                                                                                                                                      @RequestParam(value="includePriceData",required=false)
                                                                                                                                                      Boolean includePriceData)

This uses Broadleaf's search service to search for products or skus within a category.

Parameters:

request -

q -

categoryId -

pageSize -

page -

Returns:

findSearchResultsByQuery

@FrameworkMapping(value="search",
                  method=GET)
public SearchResultsWrapper findSearchResultsByQuery(javax.servlet.http.HttpServletRequest request,
                                                                                                                     @RequestParam(value="q")
                                                                                                                     String q,
                                                                                                                     @RequestParam(value="pageSize",defaultValue="15")
                                                                                                                     Integer pageSize,
                                                                                                                     @RequestParam(value="page",defaultValue="1")
                                                                                                                     Integer page,
                                                                                                                     @RequestParam(value="includePromotionMessages",required=false)
                                                                                                                     Boolean includePromotionMessages,
                                                                                                                     @RequestParam(value="includePriceData",required=false)
                                                                                                                     Boolean includePriceData)

Queries for products or skus. The parameter q, which represents the query, is required. It can be any string, but is typically a name or keyword, similar to a search engine search.

Parameters:

request -

q -

pageSize -

page -

Returns:

findSkusByProductById

@FrameworkMapping(value="product/{productId}/skus",
                  method=GET)
public List<SkuWrapper> findSkusByProductById(javax.servlet.http.HttpServletRequest request,
                                                                                                                                @PathVariable(value="productId")
                                                                                                                                Long id)

Search for Sku instances for a given product

Parameters:

id -

Returns:

the list of sku instances for the product

findDefaultSkuByProductId

@FrameworkMapping(value="product/{productId}/defaultSku",
                  method=GET)
public SkuWrapper findDefaultSkuByProductId(javax.servlet.http.HttpServletRequest request,
                                                                                                                                    @PathVariable(value="productId")
                                                                                                                                    Long id)

findAllCategories

@FrameworkMapping(value="categories",
                  method=GET)
public CategoriesWrapper findAllCategories(javax.servlet.http.HttpServletRequest request,
                                                                                                               @RequestParam(value="name",required=false)
                                                                                                               String name,
                                                                                                               @RequestParam(value="limit",defaultValue="20")
                                                                                                               int limit,
                                                                                                               @RequestParam(value="offset",defaultValue="0")
                                                                                                               int offset)

findSubCategories

@FrameworkMapping(value="category/{categoryId}/categories",
                  method=GET)
public CategoriesWrapper findSubCategories(javax.servlet.http.HttpServletRequest request,
                                                                                                                                     @PathVariable(value="categoryId")
                                                                                                                                     Long id,
                                                                                                                                     @RequestParam(value="limit",defaultValue="20")
                                                                                                                                     int limit,
                                                                                                                                     @RequestParam(value="offset",defaultValue="0")
                                                                                                                                     int offset,
                                                                                                                                     @RequestParam(value="active",defaultValue="true")
                                                                                                                                     boolean active)

findActiveSubCategories

@FrameworkMapping(value="category/{categoryId}/activeSubcategories",
                  method=GET)
public CategoriesWrapper findActiveSubCategories(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                    @PathVariable(value="categoryId")
                                                                                                                                                    Long id,
                                                                                                                                                    @RequestParam(value="limit",defaultValue="20")
                                                                                                                                                    int limit,
                                                                                                                                                    @RequestParam(value="offset",defaultValue="0")
                                                                                                                                                    int offset)

findCategoryById

@FrameworkMapping(value="category/{categoryId}",
                  method=GET)
public CategoryWrapper findCategoryById(javax.servlet.http.HttpServletRequest request,
                                                                                                                       @PathVariable(value="categoryId")
                                                                                                                       Long id,
                                                                                                                       @RequestParam(value="productLimit",defaultValue="20")
                                                                                                                       int productLimit,
                                                                                                                       @RequestParam(value="productOffset",defaultValue="1")
                                                                                                                       int productOffset,
                                                                                                                       @RequestParam(value="subcategoryLimit",defaultValue="20")
                                                                                                                       int subcategoryLimit,
                                                                                                                       @RequestParam(value="subcategoryOffset",defaultValue="1")
                                                                                                                       int subcategoryOffset)

findCategoryByIdOrName

@FrameworkMapping(value="category",
                  method=GET)
public CategoryWrapper findCategoryByIdOrName(javax.servlet.http.HttpServletRequest request,
                                                                                                                @RequestParam(value="searchParameter")
                                                                                                                String searchParameter,
                                                                                                                @RequestParam(value="productLimit",defaultValue="20")
                                                                                                                int productLimit,
                                                                                                                @RequestParam(value="productOffset",defaultValue="1")
                                                                                                                int productOffset,
                                                                                                                @RequestParam(value="subcategoryLimit",defaultValue="20")
                                                                                                                int subcategoryLimit,
                                                                                                                @RequestParam(value="subcategoryOffset",defaultValue="1")
                                                                                                                int subcategoryOffset)

Allows you to search for a category by ID or by name.

Parameters:

request -

searchParameter -

productLimit -

productOffset -

subcategoryLimit -

subcategoryOffset -

Returns:

findCategoryAttributesForCategory

@FrameworkMapping(value="category/{categoryId}/attributes",
                  method=GET)
public List<CategoryAttributeWrapper> findCategoryAttributesForCategory(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                                  @PathVariable(value="categoryId")
                                                                                                                                                                  Long categoryId)

findUpSaleProductsByProduct

@FrameworkMapping(value="product/{productId}/upsale",
                  method=GET)
public List<RelatedProductWrapper> findUpSaleProductsByProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                   @PathVariable(value="productId")
                                                                                                                                                   Long id,
                                                                                                                                                   @RequestParam(value="limit",defaultValue="20")
                                                                                                                                                   int limit,
                                                                                                                                                   @RequestParam(value="offset",defaultValue="0")
                                                                                                                                                   int offset)

findCrossSaleProductsByProduct

@FrameworkMapping(value="product/{productId}/crosssale",
                  method=GET)
public List<RelatedProductWrapper> findCrossSaleProductsByProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                         @PathVariable(value="productId")
                                                                                                                                                         Long id,
                                                                                                                                                         @RequestParam(value="limit",defaultValue="20")
                                                                                                                                                         int limit,
                                                                                                                                                         @RequestParam(value="offset",defaultValue="0")
                                                                                                                                                         int offset)

findProductAttributesForProduct

@FrameworkMapping(value="product/{productId}/attributes",
                  method=GET)
public List<ProductAttributeWrapper> findProductAttributesForProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                             @PathVariable(value="productId")
                                                                                                                                                             Long id)

findSkuAttributesForSku

@FrameworkMapping(value="sku/{skuId}/attributes",
                  method=GET)
public List<SkuAttributeWrapper> findSkuAttributesForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                                                         @PathVariable(value="skuId")
                                                                                                                                         Long id)

findMediaForSku

@FrameworkMapping(value="sku/{skuId}/media",
                  method=GET)
public List<MediaWrapper> findMediaForSku(javax.servlet.http.HttpServletRequest request,
                                                                                                                     @PathVariable(value="skuId")
                                                                                                                     Long id)

findSkuById

@FrameworkMapping(value="sku/{skuId}",
                  method=GET)
public SkuWrapper findSkuById(javax.servlet.http.HttpServletRequest request,
                                                                                                   @PathVariable(value="skuId")
                                                                                                   Long id)

findInventoryForSkus

@FrameworkMapping(value="sku/inventory",
                  method=GET)
public List<InventoryWrapper> findInventoryForSkus(javax.servlet.http.HttpServletRequest request,
                                                                                                                          @RequestParam(value="id")
                                                                                                                          List<Long> ids)

findMediaForProduct

@FrameworkMapping(value="product/{productId}/media",
                  method=GET)
public List<MediaWrapper> findMediaForProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                 @PathVariable(value="productId")
                                                                                                                                 Long id)

findMediaForCategory

@FrameworkMapping(value="category/{id}/media",
                  method=GET)
public List<MediaWrapper> findMediaForCategory(javax.servlet.http.HttpServletRequest request,
                                                                                                                            @PathVariable(value="id")
                                                                                                                            Long id)

findParentCategoriesForProduct

@FrameworkMapping(value="product/{productId}/categories",
                  method=GET)
public CategoriesWrapper findParentCategoriesForProduct(javax.servlet.http.HttpServletRequest request,
                                                                                                                                                @PathVariable(value="productId")
                                                                                                                                                Long id)

getSearchService

protected org.broadleafcommerce.core.search.service.SearchService getSearchService()