Package com.broadleafcommerce.rest.api

Class BroadleafRestApiMvcConfiguration

java.lang.Object
com.broadleafcommerce.rest.api.BroadleafRestApiMvcConfiguration
All Implemented Interfaces:
org.springframework.web.servlet.config.annotation.WebMvcConfigurer
public class BroadleafRestApiMvcConfiguration extends Object implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Default Broadleaf-recommended configuration for REST APIs

The child class must also be added as the contextConfigLocation for a new DispatcherServlet servlet with contextClass AnnotationConfigWebApplicationContext in web.xml.

Author:
Phillip Verheyden (phillipuniverse)

  • Constructor Summary

    Constructors
    Constructor
    Description
    BroadleafRestApiMvcConfiguration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.broadleafcommerce.common.web.filter.EntityManagerFindValidationFilter
    blEntityManagerFindValidationFilter()
     
    protected org.broadleafcommerce.common.web.controller.FrameworkControllerHandlerMapping
    blFrameworkControllerHandlerMapping()
     
    protected WrapperOverrideTypeModifier
    blWrapperOverrideTypeModifier()
     
    void
    configureContentNegotiation(org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer configurer)
    Setup a simple strategy: use all the defaults and return JSON by default when not sure.
    void
    configureMessageConverters(List<org.springframework.http.converter.HttpMessageConverter<?>> converters)
     
    protected org.springframework.http.converter.HttpMessageConverter<?>
    getJsonConverter()
     
    protected com.fasterxml.jackson.databind.ObjectMapper
    getObjectMapper(boolean useXml)
     
    protected org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
    getObjectMapperBuilder()
     
    protected org.springframework.http.converter.HttpMessageConverter<?>
    getXmlConverter()
    Subclasses might override this method to use JAXB natively for XML serialization by return new Jaxb2RootElementHttpMessageConverter()

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

    addArgumentResolvers, addCorsMappings, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureDefaultServletHandling, configureHandlerExceptionResolvers, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

  • Constructor Details

    • BroadleafRestApiMvcConfiguration

      public BroadleafRestApiMvcConfiguration()

  • Method Details

    • configureMessageConverters

      public void configureMessageConverters(List<org.springframework.http.converter.HttpMessageConverter<?>> converters)
      Specified by:
      configureMessageConverters in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

    • configureContentNegotiation

      public void configureContentNegotiation(org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer configurer)
      Setup a simple strategy: use all the defaults and return JSON by default when not sure.
      Specified by:
      configureContentNegotiation in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

    • getJsonConverter

      protected org.springframework.http.converter.HttpMessageConverter<?> getJsonConverter()

    • getXmlConverter

      protected org.springframework.http.converter.HttpMessageConverter<?> getXmlConverter()
      Subclasses might override this method to use JAXB natively for XML serialization by return new Jaxb2RootElementHttpMessageConverter()

    • getObjectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper(boolean useXml)

    • getObjectMapperBuilder

      protected org.springframework.http.converter.json.Jackson2ObjectMapperBuilder getObjectMapperBuilder()

    • blWrapperOverrideTypeModifier

      @Bean protected WrapperOverrideTypeModifier blWrapperOverrideTypeModifier()

    • blEntityManagerFindValidationFilter

      @Bean protected org.broadleafcommerce.common.web.filter.EntityManagerFindValidationFilter blEntityManagerFindValidationFilter()

    • blFrameworkControllerHandlerMapping

      @Bean protected org.broadleafcommerce.common.web.controller.FrameworkControllerHandlerMapping blFrameworkControllerHandlerMapping()