org.broadleafcommerce.core.web.controller.catalog

Class BroadleafCategoryController

java.lang.Object

org.broadleafcommerce.common.web.controller.BroadleafAbstractController

org.broadleafcommerce.core.web.controller.catalog.BroadleafCategoryController

All Implemented Interfaces:

TemplateTypeAware, org.springframework.web.servlet.mvc.Controller

public class BroadleafCategoryController
extends BroadleafAbstractController
implements org.springframework.web.servlet.mvc.Controller, TemplateTypeAware

This class works in combination with the CategoryHandlerMapping which finds a category based upon the passed in URL.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACTIVE_FACETS_ATTRIBUTE_NAME
protected static String	ALL_PRODUCTS_ATTRIBUTE_NAME
protected static String	ALL_SKUS_ATTRIBUTE_NAME
protected static String	CATEGORY_ATTRIBUTE_NAME
protected DeepLinkService<Category>	deepLinkService
protected static String	defaultCategoryView
protected static String	FACETS_ATTRIBUTE_NAME
protected SearchFacetDTOService	facetService
protected static String	PRODUCT_SEARCH_RESULT_ATTRIBUTE_NAME
protected static String	PRODUCTS_ATTRIBUTE_NAME
protected SearchService	searchService
protected static String	SKUS_ATTRIBUTE_NAME
protected TemplateOverrideExtensionManager	templateOverrideManager

Constructor Summary

Constructors

Constructor and Description
BroadleafCategoryController()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultCategoryView()
String	getExpectedTemplateName(javax.servlet.http.HttpServletRequest request) If a custom handler is written and it knows the eventual template name, then it should return the template name when this method is called.
protected SearchService	getSearchService()
TemplateType	getTemplateType(javax.servlet.http.HttpServletRequest request) If a custom handler is written and it knows the eventual template name, then it should return the TemplateType when this method is called.
org.springframework.web.servlet.ModelAndView	handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class org.broadleafcommerce.common.web.controller.BroadleafAbstractController

addDeepLink, getContextPath, isAjaxRequest, jsonResponse

Methods inherited from class java.lang.Object

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

Field Detail

defaultCategoryView

protected static String defaultCategoryView

CATEGORY_ATTRIBUTE_NAME

protected static String CATEGORY_ATTRIBUTE_NAME

PRODUCTS_ATTRIBUTE_NAME

protected static String PRODUCTS_ATTRIBUTE_NAME

SKUS_ATTRIBUTE_NAME

protected static String SKUS_ATTRIBUTE_NAME

FACETS_ATTRIBUTE_NAME

protected static String FACETS_ATTRIBUTE_NAME

PRODUCT_SEARCH_RESULT_ATTRIBUTE_NAME

protected static String PRODUCT_SEARCH_RESULT_ATTRIBUTE_NAME

ACTIVE_FACETS_ATTRIBUTE_NAME

protected static String ACTIVE_FACETS_ATTRIBUTE_NAME

ALL_PRODUCTS_ATTRIBUTE_NAME

protected static String ALL_PRODUCTS_ATTRIBUTE_NAME

ALL_SKUS_ATTRIBUTE_NAME

protected static String ALL_SKUS_ATTRIBUTE_NAME

searchService

protected SearchService searchService

facetService

protected SearchFacetDTOService facetService

deepLinkService

@Autowired(required=false)
@Qualifier(value="blCategoryDeepLinkService")
protected DeepLinkService<Category> deepLinkService

templateOverrideManager

protected TemplateOverrideExtensionManager templateOverrideManager

Constructor Detail

BroadleafCategoryController

public BroadleafCategoryController()

Method Detail

handleRequest

public org.springframework.web.servlet.ModelAndView handleRequest(javax.servlet.http.HttpServletRequest request,
                                                         javax.servlet.http.HttpServletResponse response)
                                                           throws Exception

Specified by:

handleRequest in interface org.springframework.web.servlet.mvc.Controller

Throws:

Exception

getDefaultCategoryView

public String getDefaultCategoryView()

getSearchService

protected SearchService getSearchService()

getExpectedTemplateName

public String getExpectedTemplateName(javax.servlet.http.HttpServletRequest request)

Description copied from interface: TemplateTypeAware

If a custom handler is written and it knows the eventual template name, then it should return the template name when this method is called. This method will always be called after #getBroadleafHandlerInternal(HttpServletRequest) and only if the Handler was able to handle the request (e.g. it returns a non-null value from #getBroadleafHandlerInternal(HttpServletRequest). Listed as expected because the HandlerMapping is making a call before the controller logic has been processed. The controller may send the user somewhere else (e.g. an error page, etc.) in which case, the expected template won't be the actual destination.

Specified by:

getExpectedTemplateName in interface TemplateTypeAware

Returns:

getTemplateType

public TemplateType getTemplateType(javax.servlet.http.HttpServletRequest request)

Description copied from interface: TemplateTypeAware

If a custom handler is written and it knows the eventual template name, then it should return the TemplateType when this method is called. This method will always be called after #getBroadleafHandlerInternal(HttpServletRequest) and only if the Handler was able to handle the request (e.g. it returns a non-null value from #getBroadleafHandlerInternal(HttpServletRequest).

Specified by:

getTemplateType in interface TemplateTypeAware

Returns: