RepositoryRestMvcConfiguration (Spring Data REST

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:: InitializingBean, 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,org.springframework.data.web.config.EnableSpringDataWebSupport.QuerydslActivator.class})
public class RepositoryRestMvcConfiguration
extends HateoasAwareSpringDataWebConfiguration
implements InitializingBean

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:: Oliver Gierke, Jon Brisbin, Greg Turnquist, Mark Paluch

Constructor Summary

Constructors
Constructor and Description

RepositoryRestMvcConfiguration()

Constructors
Constructor and Description
`RepositoryRestMvcConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addResourceHandlers(ResourceHandlerRegistry registry)`
`void`	`afterPropertiesSet()`
`RootResourceInformationToAlpsDescriptorConverter`	`alpsConverter()`
`AlpsJsonHttpMessageConverter`	`alpsJsonHttpMessageConverter()`
`static AnnotatedEventHandlerInvoker`	`annotatedEventHandlerInvoker()` `BeanPostProcessor` to turn beans annotated as `org.springframework.data.rest.repository.annotation.RepositoryEventHandler`s.
`Associations`	`associationLinks()`
`AuditableBeanWrapperFactory`	`auditableBeanWrapperFactory()`
`org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>>`	`backendIdConverterRegistry()`
`BackendIdHandlerMethodArgumentResolver`	`backendIdHandlerMethodArgumentResolver()`
`BaseUri`	`baseUri()`
`protected com.fasterxml.jackson.databind.ObjectMapper`	`basicObjectMapper()`
`RepositoryRestConfiguration`	`config()` Main configuration for the REST exporter.
`protected void`	`configureConversionService(ConfigurableConversionService conversionService)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureConversionService(ConfigurableConversionService)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`protected void`	`configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`protected void`	`configureHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureHttpMessageConverters(List)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`protected void`	`configureJacksonObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureJacksonObjectMapper(ObjectMapper)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`protected void`	`configureRepositoryRestConfiguration(RepositoryRestConfiguration config)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureRepositoryRestConfiguration(RepositoryRestConfiguration)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`protected void`	`configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener)` Deprecated. since 2.4, implement `RepositoryRestConfigurer.configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener)` either directly or extend `RepositoryRestConfigurerAdapter` and override the method.
`DefaultFormattingConversionService`	`defaultConversionService()`
`List<HttpMessageConverter<?>>`	`defaultMessageConverters()`
`protected List<HandlerMethodArgumentResolver>`	`defaultMethodArgumentResolvers()`
`DomainObjectMerger`	`domainObjectMerger()` For merging incoming objects materialized from JSON with existing domain objects loaded from the repository.
`RepositoryEntityLinks`	`entityLinks()` A special `EntityLinks` implementation that takes repository and current configuration into account when generating links.
`EnumTranslator`	`enumTranslator()`
`ETagArgumentResolver`	`eTagArgumentResolver()`
`ExceptionHandlerExceptionResolver`	`exceptionHandlerExceptionResolver()` Bean for looking up methods annotated with `ExceptionHandler`.
`ExcerptProjector`	`excerptProjector()`
`protected List<EntityLookup<?>>`	`getEntityLookups()`
`org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter`	`halJacksonHttpMessageConverter()`
`com.fasterxml.jackson.databind.ObjectMapper`	`halObjectMapper()`
`org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter`	`jacksonHttpMessageConverter()` The `HttpMessageConverter` used by Spring MVC to read and write JSON data.
`JpaHelper`	`jpaHelper()`
`PersistentEntityToJsonSchemaConverter`	`jsonSchemaConverter()` Turns a domain class into a `JsonSchema`.
`protected LinkCollector`	`linkCollector()`
`MetadataConfiguration`	`metadataConfiguration()`
`com.fasterxml.jackson.databind.ObjectMapper`	`objectMapper()` The Jackson `ObjectMapper` used internally.
`HateoasPageableHandlerMethodArgumentResolver`	`pageableResolver()`
`PersistentEntities`	`persistentEntities()`
`PersistentEntityResourceHandlerMethodArgumentResolver`	`persistentEntityArgumentResolver()` Reads incoming JSON into an entity.
`protected com.fasterxml.jackson.databind.Module`	`persistentEntityJackson2Module()` Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.
`ProfileResourceProcessor`	`profileResourceProcessor(RepositoryRestConfiguration config)`
`static ProjectionDefinitionRegistar`	`projectionDefinitionRegistrar(ObjectFactory<RepositoryRestConfiguration> config)`
`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.
`RepositoryInvokerFactory`	`repositoryInvokerFactory(ConversionService defaultConversionService)`
`RepositoryRelProvider`	`repositoryRelProvider(ObjectFactory<ResourceMappings> resourceMappings)`
`RepositoryRestExceptionHandler`	`repositoryRestExceptionHandler()`
`MessageSourceAccessor`	`resourceDescriptionMessageSourceAccessor()` The `MessageSourceAccessor` to provide messages for `ResourceDescription`s being rendered.
`RepositoryResourceMappings`	`resourceMappings()`
`ResourceMetadataHandlerMethodArgumentResolver`	`resourceMetadataHandlerMethodArgumentResolver()`
`ResourceProcessorInvoker`	`resourceProcessorInvoker()`
`DelegatingHandlerMapping`	`restHandlerMapping()` The `HandlerMapping` to delegate requests to Spring Data REST controllers.
`SelfLinkProvider`	`selfLinkProvider()`
`ServerHttpRequestMethodArgumentResolver`	`serverHttpRequestMethodArgumentResolver()` Turns an `HttpServletRequest` into a `ServerHttpRequest`.
`HateoasSortHandlerMethodArgumentResolver`	`sortResolver()`
`UriListHttpMessageConverter`	`uriListHttpMessageConverter()` The `HttpMessageConverter` used to create text/uri-list responses.
`protected UriToEntityConverter`	`uriToEntityConverter(ConversionService conversionService)`
`ValidatingRepositoryEventListener`	`validatingRepositoryEventListener(ObjectFactory<PersistentEntities> entities)` `ApplicationListener` implementation for invoking `Validator` instances assigned to specific domain types.

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
addCorsMappings, addInterceptors, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendMessageConverters, 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
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception
  - repositories
```
@Bean
public Repositories repositories()
```
  - repositoryRelProvider
```
@Bean
public RepositoryRelProvider repositoryRelProvider(ObjectFactory<ResourceMappings> resourceMappings)
```
  - persistentEntities
```
@Bean
public PersistentEntities persistentEntities()
```
  - defaultConversionService
```
@Bean
 @Qualifier
public DefaultFormattingConversionService defaultConversionService()
```
  - validatingRepositoryEventListener
```
@Bean
public ValidatingRepositoryEventListener validatingRepositoryEventListener(ObjectFactory<PersistentEntities> entities)
```
    ApplicationListener implementation for invoking Validator instances assigned to specific domain types.
  - jpaHelper
```
@Bean
public JpaHelper jpaHelper()
```
  - config
```
@Bean
public RepositoryRestConfiguration config()
```
    Main configuration for the REST exporter.
  - projectionDefinitionRegistrar
```
@Bean
public static ProjectionDefinitionRegistar projectionDefinitionRegistrar(ObjectFactory<RepositoryRestConfiguration> config)
```
  - metadataConfiguration
```
@Bean
public MetadataConfiguration metadataConfiguration()
```
  - baseUri
```
@Bean
public BaseUri baseUri()
```
  - annotatedEventHandlerInvoker
```
@Bean
public static AnnotatedEventHandlerInvoker annotatedEventHandlerInvoker()
```
    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()
```
  - eTagArgumentResolver
```
@Bean
public ETagArgumentResolver eTagArgumentResolver()
```
  - entityLinks
```
@Bean
public RepositoryEntityLinks 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 org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter jacksonHttpMessageConverter()
```
    The HttpMessageConverter used by Spring MVC to read and write JSON data.
    
    Returns:
  - halJacksonHttpMessageConverter
```
@Bean
public org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter 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:
  - resourceProcessorInvoker
```
@Bean
public ResourceProcessorInvoker resourceProcessorInvoker()
```
  - 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:
  - restHandlerMapping
```
@Bean
public DelegatingHandlerMapping restHandlerMapping()
```
    The HandlerMapping to delegate requests to Spring Data REST controllers. Sets up a DelegatingHandlerMapping to make sure manually implemented BasePathAwareController instances that register custom handlers for certain media types don't cause the RepositoryRestHandlerMapping to be omitted.
    
    Returns:
    
    See Also:
    
    DATAREST-490
  - resourceMappings
```
@Bean
public RepositoryResourceMappings resourceMappings()
```
  - persistentEntityJackson2Module
```
protected com.fasterxml.jackson.databind.Module persistentEntityJackson2Module()
```
    Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.
    
    Returns:
  - linkCollector
```
@Bean
protected LinkCollector linkCollector()
```
  - uriToEntityConverter
```
protected UriToEntityConverter uriToEntityConverter(ConversionService conversionService)
```
  - excerptProjector
```
@Bean
public ExcerptProjector excerptProjector()
```
  - exceptionHandlerExceptionResolver
```
@Bean
public ExceptionHandlerExceptionResolver exceptionHandlerExceptionResolver()
```
    Bean for looking up methods annotated with ExceptionHandler.
    
    Returns:
  - repositoryRestExceptionHandler
```
@Bean
public RepositoryRestExceptionHandler repositoryRestExceptionHandler()
```
  - repositoryInvokerFactory
```
@Bean
public RepositoryInvokerFactory repositoryInvokerFactory(@Qualifier
                                                               ConversionService defaultConversionService)
```
  - defaultMessageConverters
```
@Bean
public List<HttpMessageConverter<?>> defaultMessageConverters()
```
  - alpsJsonHttpMessageConverter
```
@Bean
public AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter()
```
  - 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()
```
  - auditableBeanWrapperFactory
```
@Bean
public AuditableBeanWrapperFactory auditableBeanWrapperFactory()
```
  - selfLinkProvider
```
@Bean
public SelfLinkProvider selfLinkProvider()
```
  - associationLinks
```
@Bean
public Associations associationLinks()
```
  - getEntityLookups
```
protected List<EntityLookup<?>> getEntityLookups()
```
  - defaultMethodArgumentResolvers
```
protected List<HandlerMethodArgumentResolver> defaultMethodArgumentResolvers()
```
  - basicObjectMapper
```
protected com.fasterxml.jackson.databind.ObjectMapper basicObjectMapper()
```
  - enumTranslator
```
@Bean
public EnumTranslator enumTranslator()
```
  - alpsConverter
```
@Bean
public RootResourceInformationToAlpsDescriptorConverter alpsConverter()
```
  - profileResourceProcessor
```
@Bean
public ProfileResourceProcessor profileResourceProcessor(RepositoryRestConfiguration config)
```
  - addResourceHandlers
```
public void addResourceHandlers(ResourceHandlerRegistry registry)
```
    Specified by:
    
    addResourceHandlers in interface WebMvcConfigurer
    
    Overrides:
    
    addResourceHandlers in class WebMvcConfigurerAdapter
  - configureRepositoryRestConfiguration
```
@Deprecated
protected void configureRepositoryRestConfiguration(RepositoryRestConfiguration config)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureRepositoryRestConfiguration(RepositoryRestConfiguration) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Override this method to add additional configuration.
    
    Parameters:
    
    config - Main configuration bean.
  - configureConversionService
```
@Deprecated
protected void configureConversionService(ConfigurableConversionService conversionService)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureConversionService(ConfigurableConversionService) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Override this method to add your own converters.
    
    Parameters:
    
    conversionService - Default ConversionService bean.
  - configureValidatingRepositoryEventListener
```
@Deprecated
protected void configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Override this method to add validators manually.
    
    Parameters:
    
    validatingListener - The ApplicationListener responsible for invoking Validator instances.
  - configureExceptionHandlerExceptionResolver
```
@Deprecated
protected void configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Configure the ExceptionHandlerExceptionResolver.
    
    Parameters:
    
    exceptionResolver - The default exception resolver on which you can add custom argument resolvers.
  - configureHttpMessageConverters
```
@Deprecated
protected void configureHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureHttpMessageConverters(List) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Configure the available HttpMessageConverters by adding your own.
    
    Parameters:
    
    messageConverters - The converters to be used by the system.
  - configureJacksonObjectMapper
```
@Deprecated
protected void configureJacksonObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
```
    Deprecated. since 2.4, implement RepositoryRestConfigurer.configureJacksonObjectMapper(ObjectMapper) either directly or extend RepositoryRestConfigurerAdapter and override the method.
    
    Configure the Jackson ObjectMapper directly.
    
    Parameters:
    
    objectMapper - The ObjectMapper to be used by the system.

Class RepositoryRestMvcConfiguration

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

RepositoryRestMvcConfiguration

Method Detail

afterPropertiesSet

repositories

repositoryRelProvider

persistentEntities

defaultConversionService

validatingRepositoryEventListener

jpaHelper

config

projectionDefinitionRegistrar

metadataConfiguration

baseUri

annotatedEventHandlerInvoker

domainObjectMerger

serverHttpRequestMethodArgumentResolver

repoRequestArgumentResolver

resourceMetadataHandlerMethodArgumentResolver

backendIdHandlerMethodArgumentResolver

eTagArgumentResolver

entityLinks

persistentEntityArgumentResolver

jsonSchemaConverter

resourceDescriptionMessageSourceAccessor

objectMapper

jacksonHttpMessageConverter

halJacksonHttpMessageConverter

halObjectMapper

uriListHttpMessageConverter

resourceProcessorInvoker

repositoryExporterHandlerAdapter

restHandlerMapping

resourceMappings

persistentEntityJackson2Module

linkCollector

uriToEntityConverter

excerptProjector

exceptionHandlerExceptionResolver

repositoryRestExceptionHandler

repositoryInvokerFactory

defaultMessageConverters

alpsJsonHttpMessageConverter

pageableResolver

sortResolver

backendIdConverterRegistry

auditableBeanWrapperFactory

selfLinkProvider

associationLinks

getEntityLookups

defaultMethodArgumentResolvers

basicObjectMapper

enumTranslator

alpsConverter

profileResourceProcessor

addResourceHandlers

configureRepositoryRestConfiguration

configureConversionService

configureValidatingRepositoryEventListener

configureExceptionHandlerExceptionResolver

configureHttpMessageConverters

configureJacksonObjectMapper