org.finra.herd.rest.config

Class RestSpringModuleConfig

java.lang.Object

org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

org.finra.herd.rest.config.RestSpringModuleConfig

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware

@Configuration
 @ComponentScan(value="org.finra.herd.rest",
               excludeFilters=)
 @Import(value=RestAopSpringModuleConfig.class)
public class RestSpringModuleConfig
extends org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

REST Spring module configuration. This configuration doesn't use the @EnableWebMvc annotation and instead extends WebMvcConfigurationSupport so we have the ability to override configuration methods that we need. One example is that we need to configure our own message converter that can perform XSD validation. Note that to override non-bean defined base class methods, we need to add the "@Bean" configuration that calls those methods in this configuration for them to get used. In this case, just define the bean and call it's super method to invoke the default processing.

Constructor Summary

Constructors

Constructor and Description
RestSpringModuleConfig()

Method Summary

Modifier and Type	Method and Description
protected void	configureMessageConverters(List<org.springframework.http.converter.HttpMessageConverter<?>> converters) This is called from requestMappingHandlerAdapter to configure the message converters.
void	configurePathMatch(org.springframework.web.servlet.config.annotation.PathMatchConfigurer configurer) Configure the path match by disabling suffix pattern matching.
org.springframework.web.servlet.HandlerExceptionResolver	handlerExceptionResolver() We need to override the base method so this "@Bean" will get invoked and ultimately call configureMessageConverters.
HerdSchemaValidationEventHandler	herdSchemaValidationEventHandler() Gets a new HerdSchemaValidationEventHandler that handles JAXB validation events which can then be attached to Herd's JAXB marshaller/unmarshaller
org.springframework.oxm.jaxb.Jaxb2Marshaller	jaxb2Marshaller() Gets a new JAXB marshaller that is aware of our XSD and can perform schema validation.
org.springframework.http.converter.xml.MarshallingHttpMessageConverter	marshallingMessageConverter() Gets a new marshalling HTTP message converter that is aware of our custom JAXB marshaller.
org.springframework.util.PathMatcher	mvcPathMatcher()
org.springframework.web.servlet.resource.ResourceUrlProvider	mvcResourceUrlProvider()
org.springframework.web.util.UrlPathHelper	mvcUrlPathHelper()
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter	requestMappingHandlerAdapter() We need to override the base method so this "@Bean" will get invoked and ultimately call configureMessageConverters.
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping	requestMappingHandlerMapping()

Methods inherited from class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

addArgumentResolvers, addCorsMappings, addDefaultHandlerExceptionResolvers, addDefaultHttpMessageConverters, addFormatters, addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, beanNameHandlerMapping, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureViewResolvers, createExceptionHandlerExceptionResolver, createRequestMappingHandlerAdapter, createRequestMappingHandlerMapping, defaultServletHandlerMapping, extendHandlerExceptionResolvers, extendMessageConverters, getApplicationContext, getArgumentResolvers, getConfigurableWebBindingInitializer, getCorsConfigurations, getDefaultMediaTypes, getInterceptors, getMessageCodesResolver, getMessageConverters, getPathMatchConfigurer, getReturnValueHandlers, getServletContext, getValidator, httpRequestHandlerAdapter, mvcContentNegotiationManager, mvcConversionService, mvcHandlerMappingIntrospector, mvcUriComponentsContributor, mvcValidator, mvcViewResolver, resourceHandlerMapping, setApplicationContext, setServletContext, simpleControllerHandlerAdapter, viewControllerHandlerMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

RestSpringModuleConfig

public RestSpringModuleConfig()

Method Detail

handlerExceptionResolver

@Bean
public org.springframework.web.servlet.HandlerExceptionResolver handlerExceptionResolver()

We need to override the base method so this "@Bean" will get invoked and ultimately call configureMessageConverters. Otherwise, it doesn't get called. This implementation doesn't do anything except call the super method.

Overrides:

handlerExceptionResolver in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

Returns:

the RequestMappingHandlerAdapter.

requestMappingHandlerAdapter

@Bean
public org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter requestMappingHandlerAdapter()

We need to override the base method so this "@Bean" will get invoked and ultimately call configureMessageConverters. Otherwise, it doesn't get called. This implementation doesn't do anything except call the super method.

Overrides:

requestMappingHandlerAdapter in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

Returns:

the RequestMappingHandlerAdapter.

configureMessageConverters

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

This is called from requestMappingHandlerAdapter to configure the message converters. We override it to configure our own converter in addition to the default converters.

Overrides:

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

Parameters:

converters - the converter list we configure.

marshallingMessageConverter

@Bean
public org.springframework.http.converter.xml.MarshallingHttpMessageConverter marshallingMessageConverter()

Gets a new marshalling HTTP message converter that is aware of our custom JAXB marshaller.

Returns:

the newly created message converter.

herdSchemaValidationEventHandler

@Bean
public HerdSchemaValidationEventHandler herdSchemaValidationEventHandler()

Gets a new HerdSchemaValidationEventHandler that handles JAXB validation events which can then be attached to Herd's JAXB marshaller/unmarshaller

Returns:

the newly created validation event handler

jaxb2Marshaller

@Bean
public org.springframework.oxm.jaxb.Jaxb2Marshaller jaxb2Marshaller()

Gets a new JAXB marshaller that is aware of our XSD and can perform schema validation. It is also aware of all our auto-generated classes that are in the org.finra.herd.model.api.xml package. Note that REST endpoints that use Java objects which are not in this package will not use this marshaller and will not get schema validated which is good since they don't have an XSD.

Returns:

the newly created JAXB marshaller.

requestMappingHandlerMapping

@Bean
public org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping requestMappingHandlerMapping()

Overrides:

requestMappingHandlerMapping in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

mvcResourceUrlProvider

@Bean
public org.springframework.web.servlet.resource.ResourceUrlProvider mvcResourceUrlProvider()

Overrides:

mvcResourceUrlProvider in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

mvcPathMatcher

@Bean
public org.springframework.util.PathMatcher mvcPathMatcher()

Overrides:

mvcPathMatcher in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

mvcUrlPathHelper

@Bean
public org.springframework.web.util.UrlPathHelper mvcUrlPathHelper()

Overrides:

mvcUrlPathHelper in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

configurePathMatch

public void configurePathMatch(org.springframework.web.servlet.config.annotation.PathMatchConfigurer configurer)

Configure the path match by disabling suffix pattern matching.

Overrides:

configurePathMatch in class org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport

Parameters:

configurer - the path match configurer.