Package org.broadleafcommerce.common.web

Class BLCAbstractHandlerMapping

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
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.HandlerMapping
Direct Known Subclasses:
CategoryHandlerMapping, PageHandlerMapping, ProductHandlerMapping, SkuHandlerMapping
public abstract class BLCAbstractHandlerMapping extends org.springframework.web.servlet.handler.AbstractHandlerMapping
Adds some convenience methods to the Spring AbstractHandlerMapping for BLC specific HandlerMappings.

Always returns null from defaultHandlerMapping

Author:
bpolster

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    controllerName
     
    protected org.springframework.core.env.Environment
    env
     

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

    mappingsLogger

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

    logger

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

    BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, 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
    Description
    BLCAbstractHandlerMapping()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowCategoryResolutionUsingIdParam()
     
    boolean
    allowProductResolutionUsingIdParam()
     
    String
    getControllerName()
    Returns the controllerName if set or "blPageController" by default.
    Object
    getDefaultHandler()
    This handler mapping does not provide a default handler.
    void
    setControllerName(String controllerName)
    Sets the name of the bean to use as the Handler.

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

    adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfiguration, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getHandler, getHandlerExecutionChain, getHandlerInternal, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, hasCorsConfigurationSource, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setPatternParser, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

    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, obtainApplicationContext, requiredContextClass, setApplicationContext

    Methods inherited from class java.lang.Object

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

  • Field Details

    • controllerName

      protected String controllerName

    • env

      @Autowired protected org.springframework.core.env.Environment env

  • Constructor Details

    • BLCAbstractHandlerMapping

      public BLCAbstractHandlerMapping()

  • Method Details

    • getDefaultHandler

      public Object getDefaultHandler()
      This handler mapping does not provide a default handler. This method has been coded to always return null.
      Overrides:
      getDefaultHandler in class org.springframework.web.servlet.handler.AbstractHandlerMapping

    • getControllerName

      public String getControllerName()
      Returns the controllerName if set or "blPageController" by default.
      Returns:

    • setControllerName

      public void setControllerName(String controllerName)
      Sets the name of the bean to use as the Handler. Typically the name of a controller bean.
      Parameters:
      controllerName -

    • allowProductResolutionUsingIdParam

      public boolean allowProductResolutionUsingIdParam()

    • allowCategoryResolutionUsingIdParam

      public boolean allowCategoryResolutionUsingIdParam()