Package org.broadleafcommerce.common.exception

Class BroadleafSimpleMappingExceptionResolver

java.lang.Object
org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver
org.springframework.web.servlet.handler.SimpleMappingExceptionResolver
org.broadleafcommerce.common.exception.BroadleafSimpleMappingExceptionResolver
All Implemented Interfaces:
org.springframework.core.Ordered, org.springframework.web.servlet.HandlerExceptionResolver
@Component("blSimpleMappingExceptionResolver") public class BroadleafSimpleMappingExceptionResolver extends org.springframework.web.servlet.handler.SimpleMappingExceptionResolver
This exception resolver can be used to handle exceptions in a user friendly way by displaying an error template. It also serves a security purpose of not showing stack traces to users. This is disabled by default and should only be enabled when there is not already a way to handle exceptions in the current project.

This can be enabled by setting exception.handler.enabled=true in your properties file. You will need to create a template file at path "utility/error" or override the method getDefaultErrorView() to return a different path to an error file.

Author:
Chad Harchar (charchar)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    DEFAULT_ERROR_VIEW
     
    protected boolean
    exceptionHandlerEnabled
     

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

    DEFAULT_EXCEPTION_ATTRIBUTE

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

    logger

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    BroadleafSimpleMappingExceptionResolver()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.springframework.web.servlet.ModelAndView
    doResolveException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)
     
    String
    getDefaultErrorView()
     
    org.springframework.web.servlet.ModelAndView
    resolveException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)
     

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

    addStatusCode, applyStatusCodeIfPossible, determineStatusCode, determineViewName, findMatchingViewName, getDepth, getModelAndView, getModelAndView, getStatusCodesAsMap, setDefaultErrorView, setDefaultStatusCode, setExceptionAttribute, setExceptionMappings, setExcludedExceptions, setStatusCodes

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

    addMappedHandlerClass, buildLogMessage, getMappedHandlerClasses, getOrder, hasHandlerMappings, logException, prepareResponse, preventCaching, setMappedHandlerClasses, setMappedHandlerPredicate, setMappedHandlers, setOrder, setPreventResponseCaching, setWarnLogCategory, shouldApplyTo

    Methods inherited from class java.lang.Object

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

  • Field Details

    • exceptionHandlerEnabled

      @Value("${exception.handler.enabled:false}") protected boolean exceptionHandlerEnabled

    • DEFAULT_ERROR_VIEW

      protected String DEFAULT_ERROR_VIEW

  • Constructor Details

    • BroadleafSimpleMappingExceptionResolver

      public BroadleafSimpleMappingExceptionResolver()

  • Method Details

    • doResolveException

      protected org.springframework.web.servlet.ModelAndView doResolveException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)
      Overrides:
      doResolveException in class org.springframework.web.servlet.handler.SimpleMappingExceptionResolver

    • resolveException

      public org.springframework.web.servlet.ModelAndView resolveException(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)
      Specified by:
      resolveException in interface org.springframework.web.servlet.HandlerExceptionResolver
      Overrides:
      resolveException in class org.springframework.web.servlet.handler.AbstractHandlerExceptionResolver

    • getDefaultErrorView

      public String getDefaultErrorView()