org.broadleafcommerce.core.web.catalog

Class CategoryHandlerMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.handler.AbstractHandlerMapping

org.broadleafcommerce.common.web.BLCAbstractHandlerMapping

org.broadleafcommerce.core.web.catalog.CategoryHandlerMapping

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.HandlerMapping

public class CategoryHandlerMapping
extends org.broadleafcommerce.common.web.BLCAbstractHandlerMapping

This handler mapping works with the Category entity to determine if a category has been configured for the passed in URL. If the URL matches a valid Category then this mapping returns the handler configured via the controllerName property or blCategoryController by default.

Since:

2.0

Author:

bpolster

See Also:

Category, CataService

Field Summary

Fields

Modifier and Type	Field and Description
String	charEncoding
static String	CURRENT_CATEGORY_ATTRIBUTE_NAME
protected String	defaultTemplateName

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.web.servlet.HandlerMapping

BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CategoryHandlerMapping()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowCategoryResolutionUsingIdParam()
protected Category	findCategoryUsingIdParam(org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected Category	findCategoryUsingUrl(org.broadleafcommerce.common.web.BroadleafRequestContext context)
String	getDefaultTemplateName()
protected Object	getHandlerInternal(javax.servlet.http.HttpServletRequest request)
void	setDefaultTemplateName(String defaultTemplateName)

Methods inherited from class org.broadleafcommerce.common.web.BLCAbstractHandlerMapping

getControllerName, getDefaultHandler, setControllerName

Methods inherited from class org.springframework.web.servlet.handler.AbstractHandlerMapping

adaptInterceptor, detectMappedInterceptors, extendInterceptors, getAdaptedInterceptors, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getUrlPathHelper, initApplicationContext, initInterceptors, setAlwaysUseFullPath, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Field Detail

defaultTemplateName

protected String defaultTemplateName

CURRENT_CATEGORY_ATTRIBUTE_NAME

public static final String CURRENT_CATEGORY_ATTRIBUTE_NAME

See Also:

Constant Field Values

charEncoding

@Value(value="${request.uri.encoding}")
public String charEncoding

Constructor Detail

CategoryHandlerMapping

public CategoryHandlerMapping()

Method Detail

getHandlerInternal

protected Object getHandlerInternal(javax.servlet.http.HttpServletRequest request)
                             throws Exception

Specified by:

getHandlerInternal in class org.springframework.web.servlet.handler.AbstractHandlerMapping

Throws:

Exception

getDefaultTemplateName

public String getDefaultTemplateName()

setDefaultTemplateName

public void setDefaultTemplateName(String defaultTemplateName)

findCategoryUsingIdParam

protected Category findCategoryUsingIdParam(org.broadleafcommerce.common.web.BroadleafRequestContext context)
                                     throws org.springframework.web.bind.ServletRequestBindingException

Throws:

org.springframework.web.bind.ServletRequestBindingException

findCategoryUsingUrl

protected Category findCategoryUsingUrl(org.broadleafcommerce.common.web.BroadleafRequestContext context)
                                 throws org.springframework.web.bind.ServletRequestBindingException,
                                        UnsupportedEncodingException

Throws:

org.springframework.web.bind.ServletRequestBindingException

UnsupportedEncodingException

allowCategoryResolutionUsingIdParam

public boolean allowCategoryResolutionUsingIdParam()