org.broadleafcommerce.core.web.api

Class BroadleafRestApiMvcConfiguration

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

org.broadleafcommerce.core.web.api.BroadleafRestApiMvcConfiguration

All Implemented Interfaces:

org.springframework.web.servlet.config.annotation.WebMvcConfigurer

public class BroadleafRestApiMvcConfiguration
extends org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

Default Broadleaf-recommended configuration for REST APIs. Recommended use is to extend this class and annotate your extension with @Configuration and @EnableWebMvc

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)

Field Summary

Fields

Modifier and Type	Field and Description
protected WrapperOverrideTypeModifier	typeModifier

Constructor Summary

Constructors

Constructor and Description
BroadleafRestApiMvcConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
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 org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

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

Methods inherited from class java.lang.Object

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

Field Detail

typeModifier

protected WrapperOverrideTypeModifier typeModifier

Constructor Detail

BroadleafRestApiMvcConfiguration

public BroadleafRestApiMvcConfiguration()

Method Detail

configureMessageConverters

public void configureMessageConverters(List<org.springframework.http.converter.HttpMessageConverter<?>> converters)

Specified by:

configureMessageConverters in interface org.springframework.web.servlet.config.annotation.WebMvcConfigurer

Overrides:

configureMessageConverters in class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

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

Overrides:

configureContentNegotiation in class org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter

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()

See Also:

#getObjectMapper(boolean)}

getObjectMapper

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

getObjectMapperBuilder

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