org.springframework.data.rest.webmvc.config

Class RepositoryRestMvcConfiguration

java.lang.Object

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

org.springframework.data.web.config.SpringDataWebConfiguration

org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration

org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration

All Implemented Interfaces:

WebMvcConfigurer

@Configuration
@EnableHypermediaSupport(type=HAL)
@ComponentScan(basePackageClasses=RepositoryRestController.class,
               includeFilters=,
               useDefaultFilters=false)
@ImportResource(value="classpath*:META-INF/spring-data-rest/**/*.xml")
@Import(value=org.springframework.data.web.config.SpringDataJacksonConfiguration.class)
public class RepositoryRestMvcConfiguration
extends HateoasAwareSpringDataWebConfiguration

Main application configuration for Spring Data REST. To customize how the exporter works, subclass this and override any of the configure* methods.

Any XML files located in the classpath under the META-INF/spring-data-rest/ path will be automatically found and loaded into this ApplicationContext.

Author:

Jon Brisbin, Oliver Gierke

Constructor Summary

Constructors

Constructor and Description
RepositoryRestMvcConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
AnnotatedHandlerBeanPostProcessor	annotatedHandlerBeanPostProcessor() BeanPostProcessor to turn beans annotated as org.springframework.data.rest.repository.annotation.RepositoryEventHandlers.
org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>>	backendIdConverterRegistry()
BackendIdHandlerMethodArgumentResolver	backendIdHandlerMethodArgumentResolver()
BaseUri	baseUri()
RepositoryRestConfiguration	config() Main configuration for the REST exporter.
protected void	configureConversionService(ConfigurableConversionService conversionService) Override this method to add your own converters.
protected void	configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver) Configure the ExceptionHandlerExceptionResolver.
protected void	configureHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters) Configure the available HttpMessageConverters by adding your own.
protected void	configureJacksonObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Configure the Jackson ObjectMapper directly.
protected void	configureRepositoryRestConfiguration(RepositoryRestConfiguration config) Override this method to add additional configuration.
protected void	configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener) Override this method to add validators manually.
DefaultFormattingConversionService	defaultConversionService()
List<HttpMessageConverter<?>>	defaultMessageConverters()
DomainClassConverter<?>	domainClassConverter()
DomainObjectMerger	domainObjectMerger() For merging incoming objects materialized from JSON with existing domain objects loaded from the repository.
org.springframework.hateoas.EntityLinks	entityLinks() A special EntityLinks implementation that takes repository and current configuration into account when generating links.
ExceptionHandlerExceptionResolver	exceptionHandlerExceptionResolver() Bean for looking up methods annotated with ExceptionHandler.
MappingJackson2HttpMessageConverter	halJacksonHttpMessageConverter()
com.fasterxml.jackson.databind.ObjectMapper	halObjectMapper()
MappingJackson2HttpMessageConverter	jacksonHttpMessageConverter() The HttpMessageConverter used by Spring MVC to read and write JSON data.
JpaHelper	jpaHelper()
PersistentEntityToJsonSchemaConverter	jsonSchemaConverter() Turns a domain class into a JsonSchema.
com.fasterxml.jackson.databind.ObjectMapper	objectMapper() The Jackson ObjectMapper used internally.
HateoasPageableHandlerMethodArgumentResolver	pageableResolver()
PersistentEntities	persistentEntities()
PersistentEntityResourceHandlerMethodArgumentResolver	persistentEntityArgumentResolver() Reads incoming JSON into an entity.
com.fasterxml.jackson.databind.Module	persistentEntityJackson2Module() Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.
RootResourceInformationHandlerMethodArgumentResolver	repoRequestArgumentResolver() A convenience resolver that pulls together all the information needed to service a request.
Repositories	repositories()
RequestMappingHandlerAdapter	repositoryExporterHandlerAdapter() Special HandlerAdapter that only recognizes handler methods defined in the provided controller classes.
RequestMappingHandlerMapping	repositoryExporterHandlerMapping() Special HandlerMapping that only recognizes handler methods defined in the provided controller classes.
RepositoryInvokerFactory	repositoryInvokerFactory()
RepositoryRelProvider	repositoryRelProvider(ObjectFactory<ResourceMappings> resourceMappings)
MessageSourceAccessor	resourceDescriptionMessageSourceAccessor() The MessageSourceAccessor to provide messages for ResourceDescriptions being rendered.
ResourceMappings	resourceMappings()
ResourceMetadataHandlerMethodArgumentResolver	resourceMetadataHandlerMethodArgumentResolver()
ServerHttpRequestMethodArgumentResolver	serverHttpRequestMethodArgumentResolver() Turns an HttpServletRequest into a ServerHttpRequest.
HateoasSortHandlerMethodArgumentResolver	sortResolver()
UriListHttpMessageConverter	uriListHttpMessageConverter() The HttpMessageConverter used to create text/uri-list responses.
UriToEntityConverter	uriToEntityConverter()
ValidatingRepositoryEventListener	validatingRepositoryEventListener(ObjectFactory<Repositories> repositories) ApplicationListener implementation for invoking Validator instances assigned to specific domain types.
ValidationExceptionHandler	validationExceptionHandler()

Methods inherited from class org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration

addArgumentResolvers, pagedResourcesAssembler, pagedResourcesAssemblerArgumentResolver

Methods inherited from class org.springframework.data.web.config.SpringDataWebConfiguration

addFormatters

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

addInterceptors, addResourceHandlers, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, getMessageCodesResolver, getValidator

Methods inherited from class java.lang.Object

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

Constructor Detail

RepositoryRestMvcConfiguration

public RepositoryRestMvcConfiguration()

Method Detail

repositories

@Bean
public Repositories repositories()

repositoryRelProvider

@Bean
public RepositoryRelProvider repositoryRelProvider(ObjectFactory<ResourceMappings> resourceMappings)

persistentEntities

@Bean
public PersistentEntities persistentEntities()

defaultConversionService

@Bean
@Qualifier
public DefaultFormattingConversionService defaultConversionService()

domainClassConverter

@Bean
public DomainClassConverter<?> domainClassConverter()

uriToEntityConverter

@Bean
public UriToEntityConverter uriToEntityConverter()

validatingRepositoryEventListener

@Bean
public ValidatingRepositoryEventListener validatingRepositoryEventListener(ObjectFactory<Repositories> repositories)

ApplicationListener implementation for invoking Validator instances assigned to specific domain types.

validationExceptionHandler

@Bean
@Lazy
public ValidationExceptionHandler validationExceptionHandler()

jpaHelper

@Bean
public JpaHelper jpaHelper()

config

@Bean
public RepositoryRestConfiguration config()

Main configuration for the REST exporter.

baseUri

@Bean
public BaseUri baseUri()

annotatedHandlerBeanPostProcessor

@Bean
public AnnotatedHandlerBeanPostProcessor annotatedHandlerBeanPostProcessor()

BeanPostProcessor to turn beans annotated as org.springframework.data.rest.repository.annotation.RepositoryEventHandlers.

Returns:

domainObjectMerger

@Bean
public DomainObjectMerger domainObjectMerger()
                                      throws Exception

For merging incoming objects materialized from JSON with existing domain objects loaded from the repository.

Returns:

Throws:

Exception

serverHttpRequestMethodArgumentResolver

@Bean
public ServerHttpRequestMethodArgumentResolver serverHttpRequestMethodArgumentResolver()

Turns an HttpServletRequest into a ServerHttpRequest.

Returns:

repoRequestArgumentResolver

@Bean
public RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver()

A convenience resolver that pulls together all the information needed to service a request.

Returns:

resourceMetadataHandlerMethodArgumentResolver

@Bean
public ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver()

backendIdHandlerMethodArgumentResolver

@Bean
public BackendIdHandlerMethodArgumentResolver backendIdHandlerMethodArgumentResolver()

entityLinks

@Bean
public org.springframework.hateoas.EntityLinks entityLinks()

A special EntityLinks implementation that takes repository and current configuration into account when generating links.

Returns:

Throws:

Exception

persistentEntityArgumentResolver

@Bean
public PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver()

Reads incoming JSON into an entity.

Returns:

jsonSchemaConverter

@Bean
public PersistentEntityToJsonSchemaConverter jsonSchemaConverter()

Turns a domain class into a JsonSchema.

Returns:

resourceDescriptionMessageSourceAccessor

@Bean
public MessageSourceAccessor resourceDescriptionMessageSourceAccessor()

The MessageSourceAccessor to provide messages for ResourceDescriptions being rendered.

Returns:

objectMapper

@Bean
public com.fasterxml.jackson.databind.ObjectMapper objectMapper()

The Jackson ObjectMapper used internally.

Returns:

jacksonHttpMessageConverter

@Bean
public MappingJackson2HttpMessageConverter jacksonHttpMessageConverter()

The HttpMessageConverter used by Spring MVC to read and write JSON data.

Returns:

halJacksonHttpMessageConverter

@Bean
public MappingJackson2HttpMessageConverter halJacksonHttpMessageConverter()

halObjectMapper

@Bean
public com.fasterxml.jackson.databind.ObjectMapper halObjectMapper()

uriListHttpMessageConverter

@Bean
public UriListHttpMessageConverter uriListHttpMessageConverter()

The HttpMessageConverter used to create text/uri-list responses.

Returns:

repositoryExporterHandlerAdapter

@Bean
public RequestMappingHandlerAdapter repositoryExporterHandlerAdapter()

Special HandlerAdapter that only recognizes handler methods defined in the provided controller classes.

Parameters:

resourceProcessors - ResourceProcessors available in the ApplicationContext.

Returns:

repositoryExporterHandlerMapping

@Bean
public RequestMappingHandlerMapping repositoryExporterHandlerMapping()

Special HandlerMapping that only recognizes handler methods defined in the provided controller classes.

Returns:

resourceMappings

@Bean
public ResourceMappings resourceMappings()

persistentEntityJackson2Module

@Bean
public com.fasterxml.jackson.databind.Module persistentEntityJackson2Module()

Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.

Returns:

exceptionHandlerExceptionResolver

@Bean
public ExceptionHandlerExceptionResolver exceptionHandlerExceptionResolver()

Bean for looking up methods annotated with ExceptionHandler.

Returns:

repositoryInvokerFactory

@Bean
public RepositoryInvokerFactory repositoryInvokerFactory()

defaultMessageConverters

@Bean
public List<HttpMessageConverter<?>> defaultMessageConverters()

pageableResolver

@Bean
public HateoasPageableHandlerMethodArgumentResolver pageableResolver()

Overrides:

pageableResolver in class HateoasAwareSpringDataWebConfiguration

sortResolver

@Bean
public HateoasSortHandlerMethodArgumentResolver sortResolver()

Overrides:

sortResolver in class HateoasAwareSpringDataWebConfiguration

backendIdConverterRegistry

@Bean
public org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> backendIdConverterRegistry()

configureRepositoryRestConfiguration

protected void configureRepositoryRestConfiguration(RepositoryRestConfiguration config)

Override this method to add additional configuration.

Parameters:

config - Main configuration bean.

configureConversionService

protected void configureConversionService(ConfigurableConversionService conversionService)

Override this method to add your own converters.

Parameters:

conversionService - Default ConversionService bean.

configureValidatingRepositoryEventListener

protected void configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener)

Override this method to add validators manually.

Parameters:

validatingListener - The ApplicationListener responsible for invoking Validator instances.

configureExceptionHandlerExceptionResolver

protected void configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver)

Configure the ExceptionHandlerExceptionResolver.

Parameters:

exceptionResolver - The default exception resolver on which you can add custom argument resolvers.

configureHttpMessageConverters

protected void configureHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters)

Configure the available HttpMessageConverters by adding your own.

Parameters:

messageConverters - The converters to be used by the system.

configureJacksonObjectMapper

protected void configureJacksonObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Configure the Jackson ObjectMapper directly.

Parameters:

objectMapper - The ObjectMapper to be used by the system.