Package org.springframework.data.rest.webmvc.config

Class RepositoryRestMvcConfiguration

java.lang.Object

org.springframework.data.web.config.SpringDataWebConfiguration

org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration

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

All Implemented Interfaces:

Aware, BeanClassLoaderAware, EmbeddedValueResolverAware, WebMvcConfigurer

@Configuration(proxyBeanMethods=false)
@EnableHypermediaSupport(type={HAL,HAL_FORMS})
@Import({org.springframework.data.rest.webmvc.config.RestControllerImportSelector.class,org.springframework.data.web.config.SpringDataJacksonConfiguration.class,org.springframework.data.web.config.EnableSpringDataWebSupport.QuerydslActivator.class})
public class RepositoryRestMvcConfiguration
extends HateoasAwareSpringDataWebConfiguration
implements BeanClassLoaderAware, EmbeddedValueResolverAware

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, Christoph Strobl, Will Fleury

Constructor Summary

Constructors

Constructor

Description

RepositoryRestMvcConfiguration(ApplicationContext context, ObjectFactory<ConversionService> conversionService, ObjectProvider<LinkRelationProvider> relProvider, ObjectProvider<CurieProvider> curieProvider, ObjectProvider<HalConfiguration> halConfiguration, ObjectProvider<com.fasterxml.jackson.databind.ObjectMapper> objectMapper, ObjectProvider<RepresentationModelProcessorInvoker> invoker, ObjectProvider<MessageResolver> resolver, ObjectProvider<GeoModule> geoModule, ObjectProvider<PathPatternParser> parser)

Method Summary

Modifier and Type	Method	Description
void	addResourceHandlers(ResourceHandlerRegistry registry)
RootResourceInformationToAlpsDescriptorConverter	alpsConverter(Repositories repositories, PersistentEntities persistentEntities, RepositoryEntityLinks entityLinks, EnumTranslator enumTranslator, Associations associationLinks, RepositoryRestConfiguration repositoryRestConfiguration)
AlpsJsonHttpMessageConverter	alpsJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter alpsConverter)
static AnnotatedEventHandlerInvoker	annotatedEventHandlerInvoker()
Associations	associationLinks(RepositoryResourceMappings resourceMappings, RepositoryRestConfiguration repositoryRestConfiguration)
AuditableBeanWrapperFactory	auditableBeanWrapperFactory(PersistentEntities persistentEntities)
org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>>	backendIdConverterRegistry(List<BackendIdConverter> backendIdConverter)
BackendIdHandlerMethodArgumentResolver	backendIdHandlerMethodArgumentResolver(org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> backendIdConverterRegistry, ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver, BaseUri baseUri)
BaseUri	baseUri(RepositoryRestConfiguration repositoryRestConfiguration)
protected com.fasterxml.jackson.databind.ObjectMapper	basicObjectMapper()
DefaultFormattingConversionService	defaultConversionService(PersistentEntities persistentEntities, RepositoryInvokerFactory repositoryInvokerFactory)
List<HttpMessageConverter<?>>	defaultMessageConverters(TypeConstrainedMappingJackson2HttpMessageConverter jacksonHttpMessageConverter, TypeConstrainedMappingJackson2HttpMessageConverter halJacksonHttpMessageConverter, TypeConstrainedMappingJackson2HttpMessageConverter halFormsJacksonHttpMessageConverter, AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter, UriListHttpMessageConverter uriListHttpMessageConverter, RepositoryRestConfiguration repositoryRestConfiguration)
protected List<HandlerMethodArgumentResolver>	defaultMethodArgumentResolvers(SelfLinkProvider selfLinkProvider, PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver, PersistentEntityResourceAssemblerArgumentResolver persistentEntityResourceAssemblerArgumentResolver, RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver)
RepositoryEntityLinks	entityLinks(ObjectFactory<HateoasPageableHandlerMethodArgumentResolver> pageableResolver, Repositories repositories, RepositoryResourceMappings resourceMappings, org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> backendIdConverterRegistry, RepositoryRestConfiguration repositoryRestConfiguration, ObjectFactory<HateoasSortHandlerMethodArgumentResolver> sortResolver)	A special EntityLinks implementation that takes repository and current configuration into account when generating links.
EnumTranslator	enumTranslator(MessageResolver resolver)
ETagArgumentResolver	eTagArgumentResolver()
ExcerptProjector	excerptProjector(RepositoryResourceMappings resourceMappings)
void	extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)
protected List<EntityLookup<?>>	getEntityLookups()
TypeConstrainedMappingJackson2HttpMessageConverter	halJacksonHttpMessageConverter(LinkCollector linkCollector, RepositoryRestConfiguration repositoryRestConfiguration)
com.fasterxml.jackson.databind.ObjectMapper	halObjectMapper(LinkCollector linkCollector)
HttpHeadersPreparer	httpHeadersPreparer(AuditableBeanWrapperFactory auditableBeanWrapperFactory)
TypeConstrainedMappingJackson2HttpMessageConverter	jacksonHttpMessageConverter(RepositoryRestConfiguration repositoryRestConfiguration)	The HttpMessageConverter used by Spring MVC to read and write JSON data.
JpaHelper	jpaHelper()
PersistentEntityToJsonSchemaConverter	jsonSchemaConverter(PersistentEntities persistentEntities, Associations associationLinks, RepositoryInvokerFactory repositoryInvokerFactory, RepositoryRestConfiguration repositoryRestConfiguration)	Turns a domain class into a JsonSchema.
protected LinkCollector	linkCollector(PersistentEntities persistentEntities, SelfLinkProvider selfLinkProvider, Associations associationLinks)
MetadataConfiguration	metadataConfiguration()
com.fasterxml.jackson.databind.ObjectMapper	objectMapper()	The Jackson ObjectMapper used internally.
HateoasPageableHandlerMethodArgumentResolver	pageableResolver()
PersistentEntities	persistentEntities()
PersistentEntityResourceHandlerMethodArgumentResolver	persistentEntityArgumentResolver(List<HttpMessageConverter<?>> defaultMessageConverters, RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver, Associations associationLinks, BackendIdHandlerMethodArgumentResolver backendIdHandlerMethodArgumentResolver, PersistentEntities entities)	Reads incoming JSON into an entity.
protected com.fasterxml.jackson.databind.Module	persistentEntityJackson2Module(LinkCollector linkCollector)	Jackson module responsible for intelligently serializing and deserializing JSON that corresponds to an entity.
ProfileResourceProcessor	profileResourceProcessor(RepositoryRestConfiguration repositoryRestConfiguration)
static ProjectionDefinitionRegistar	projectionDefinitionRegistrar(ObjectFactory<RepositoryRestConfiguration> config)
RootResourceInformationHandlerMethodArgumentResolver	repoRequestArgumentResolver(Repositories repositories, ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver, RepositoryInvokerFactory repositoryInvokerFactory)	A convenience resolver that pulls together all the information needed to service a request.
Repositories	repositories()
RequestMappingHandlerAdapter	repositoryExporterHandlerAdapter(ObjectProvider<Validator> validator, List<HttpMessageConverter<?>> defaultMessageConverters, AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter, SelfLinkProvider selfLinkProvider, PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver, PersistentEntityResourceAssemblerArgumentResolver persistentEntityResourceAssemblerArgumentResolver, RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver, RepositoryRestConfiguration repositoryRestConfiguration)	Special HandlerAdapter that only recognizes handler methods defined in the provided controller classes.
RepositoryInvokerFactory	repositoryInvokerFactory()
RepositoryRelProvider	repositoryRelProvider(ObjectFactory<ResourceMappings> resourceMappings)
<T extends RepositoryRestConfiguration & CorsConfigurationAware> T	repositoryRestConfiguration()	Main configuration for the REST exporter.
RepositoryRestExceptionHandler	repositoryRestExceptionHandler()
RepositoryResourceMappings	resourceMappings(Repositories repositories, PersistentEntities persistentEntities, RepositoryRestConfiguration repositoryRestConfiguration)
ResourceMetadataHandlerMethodArgumentResolver	resourceMetadataHandlerMethodArgumentResolver(Repositories repositories, RepositoryResourceMappings resourceMappings, BaseUri baseUri)
org.springframework.data.rest.webmvc.config.DelegatingHandlerMapping	restHandlerMapping(Repositories repositories, RepositoryResourceMappings resourceMappings, Optional<JpaHelper> jpaHelper, RepositoryRestConfiguration repositoryRestConfiguration, CorsConfigurationAware corsRestConfiguration)	The HandlerMapping to delegate requests to Spring Data REST controllers.
SelfLinkProvider	selfLinkProvider(PersistentEntities persistentEntities, RepositoryEntityLinks entityLinks, ObjectProvider<ConversionService> conversionService)
void	setBeanClassLoader(ClassLoader classLoader)
void	setEmbeddedValueResolver(StringValueResolver resolver)
HateoasSortHandlerMethodArgumentResolver	sortResolver()
UriListHttpMessageConverter	uriListHttpMessageConverter()	The HttpMessageConverter used to create text/uri-list responses.
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, slicedResourcesAssembler, slicedResourcesAssemblerArgumentResolver

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

addFormatters, customizeOffsetResolver, customizePageableResolver, customizeSortResolver, extendMessageConverters, offsetResolver

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

addCorsMappings, addInterceptors, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, getMessageCodesResolver, getValidator

Constructor Details

RepositoryRestMvcConfiguration

public RepositoryRestMvcConfiguration(ApplicationContext context,
 @Qualifier("mvcConversionService")
 ObjectFactory<ConversionService> conversionService,
 ObjectProvider<LinkRelationProvider> relProvider,
 ObjectProvider<CurieProvider> curieProvider,
 ObjectProvider<HalConfiguration> halConfiguration,
 ObjectProvider<com.fasterxml.jackson.databind.ObjectMapper> objectMapper,
 ObjectProvider<RepresentationModelProcessorInvoker> invoker,
 ObjectProvider<MessageResolver> resolver,
 ObjectProvider<GeoModule> geoModule,
 ObjectProvider<PathPatternParser> parser)

Method Details

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Overrides:

setBeanClassLoader in class SpringDataWebConfiguration

setEmbeddedValueResolver

public void setEmbeddedValueResolver(StringValueResolver resolver)

Specified by:

setEmbeddedValueResolver in interface EmbeddedValueResolverAware

repositories

@Bean
public Repositories repositories()

repositoryRelProvider

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

persistentEntities

@Bean
public PersistentEntities persistentEntities()

defaultConversionService

@Bean
@Qualifier
public DefaultFormattingConversionService defaultConversionService(PersistentEntities persistentEntities,
 RepositoryInvokerFactory repositoryInvokerFactory)

validatingRepositoryEventListener

@Bean
public ValidatingRepositoryEventListener validatingRepositoryEventListener(ObjectFactory<PersistentEntities> entities)

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

jpaHelper

@Bean
public JpaHelper jpaHelper()

repositoryRestConfiguration

@Bean
public <T extends RepositoryRestConfiguration & CorsConfigurationAware>
T repositoryRestConfiguration()

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

annotatedEventHandlerInvoker

@Bean
public static AnnotatedEventHandlerInvoker annotatedEventHandlerInvoker()

repoRequestArgumentResolver

@Bean
public RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver(Repositories repositories,
 ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver,
 @Qualifier("repositoryInvokerFactory")
 RepositoryInvokerFactory repositoryInvokerFactory)

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

Returns:

resourceMetadataHandlerMethodArgumentResolver

@Bean
public ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver(Repositories repositories,
 RepositoryResourceMappings resourceMappings,
 BaseUri baseUri)

backendIdHandlerMethodArgumentResolver

@Bean
public BackendIdHandlerMethodArgumentResolver backendIdHandlerMethodArgumentResolver(org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> backendIdConverterRegistry,
 ResourceMetadataHandlerMethodArgumentResolver resourceMetadataHandlerMethodArgumentResolver,
 BaseUri baseUri)

eTagArgumentResolver

@Bean
public ETagArgumentResolver eTagArgumentResolver()

entityLinks

@Bean
public RepositoryEntityLinks entityLinks(ObjectFactory<HateoasPageableHandlerMethodArgumentResolver> pageableResolver,
 Repositories repositories,
 RepositoryResourceMappings resourceMappings,
 org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>> backendIdConverterRegistry,
 RepositoryRestConfiguration repositoryRestConfiguration,
 ObjectFactory<HateoasSortHandlerMethodArgumentResolver> sortResolver)

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

Returns:

persistentEntityArgumentResolver

@Bean
public PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver(@Qualifier("defaultMessageConverters")
 List<HttpMessageConverter<?>> defaultMessageConverters,
 RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver,
 Associations associationLinks,
 BackendIdHandlerMethodArgumentResolver backendIdHandlerMethodArgumentResolver,
 PersistentEntities entities)

Reads incoming JSON into an entity.

Returns:

jsonSchemaConverter

@Bean
public PersistentEntityToJsonSchemaConverter jsonSchemaConverter(PersistentEntities persistentEntities,
 Associations associationLinks,
 @Qualifier("repositoryInvokerFactory")
 RepositoryInvokerFactory repositoryInvokerFactory,
 RepositoryRestConfiguration repositoryRestConfiguration)

Turns a domain class into a JsonSchema.

Returns:

objectMapper

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

The Jackson ObjectMapper used internally.

Returns:

jacksonHttpMessageConverter

@Bean
public TypeConstrainedMappingJackson2HttpMessageConverter jacksonHttpMessageConverter(RepositoryRestConfiguration repositoryRestConfiguration)

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

Returns:

halJacksonHttpMessageConverter

@Bean
public TypeConstrainedMappingJackson2HttpMessageConverter halJacksonHttpMessageConverter(LinkCollector linkCollector,
 RepositoryRestConfiguration repositoryRestConfiguration)

halObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper halObjectMapper(LinkCollector linkCollector)

uriListHttpMessageConverter

@Bean
public UriListHttpMessageConverter uriListHttpMessageConverter()

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

Returns:

repositoryExporterHandlerAdapter

@Bean
public RequestMappingHandlerAdapter repositoryExporterHandlerAdapter(@Qualifier("mvcValidator")
 ObjectProvider<Validator> validator,
 @Qualifier("defaultMessageConverters")
 List<HttpMessageConverter<?>> defaultMessageConverters,
 AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter,
 SelfLinkProvider selfLinkProvider,
 PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver,
 PersistentEntityResourceAssemblerArgumentResolver persistentEntityResourceAssemblerArgumentResolver,
 RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver,
 RepositoryRestConfiguration repositoryRestConfiguration)

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

Returns:

restHandlerMapping

@Bean
public org.springframework.data.rest.webmvc.config.DelegatingHandlerMapping restHandlerMapping(Repositories repositories,
 RepositoryResourceMappings resourceMappings,
 Optional<JpaHelper> jpaHelper,
 RepositoryRestConfiguration repositoryRestConfiguration,
 CorsConfigurationAware corsRestConfiguration)

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. See DATAREST-490.

Returns:

resourceMappings

@Bean
public RepositoryResourceMappings resourceMappings(Repositories repositories,
 PersistentEntities persistentEntities,
 RepositoryRestConfiguration repositoryRestConfiguration)

persistentEntityJackson2Module

protected com.fasterxml.jackson.databind.Module persistentEntityJackson2Module(LinkCollector linkCollector)

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

Returns:

linkCollector

@Bean
protected LinkCollector linkCollector(PersistentEntities persistentEntities,
 SelfLinkProvider selfLinkProvider,
 Associations associationLinks)

excerptProjector

@Bean
public ExcerptProjector excerptProjector(RepositoryResourceMappings resourceMappings)

extendHandlerExceptionResolvers

public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)

Specified by:

extendHandlerExceptionResolvers in interface WebMvcConfigurer

repositoryRestExceptionHandler

@Bean
public RepositoryRestExceptionHandler repositoryRestExceptionHandler()

repositoryInvokerFactory

@Bean
@Qualifier
public RepositoryInvokerFactory repositoryInvokerFactory()

defaultMessageConverters

@Bean
public List<HttpMessageConverter<?>> defaultMessageConverters(@Qualifier("jacksonHttpMessageConverter")
 TypeConstrainedMappingJackson2HttpMessageConverter jacksonHttpMessageConverter,
 @Qualifier("halJacksonHttpMessageConverter")
 TypeConstrainedMappingJackson2HttpMessageConverter halJacksonHttpMessageConverter,
 @Qualifier("halFormsJacksonHttpMessageConverter")
 TypeConstrainedMappingJackson2HttpMessageConverter halFormsJacksonHttpMessageConverter,
 AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter,
 UriListHttpMessageConverter uriListHttpMessageConverter,
 RepositoryRestConfiguration repositoryRestConfiguration)

alpsJsonHttpMessageConverter

@Bean
public AlpsJsonHttpMessageConverter alpsJsonHttpMessageConverter(RootResourceInformationToAlpsDescriptorConverter alpsConverter)

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(List<BackendIdConverter> backendIdConverter)

auditableBeanWrapperFactory

@Bean
public AuditableBeanWrapperFactory auditableBeanWrapperFactory(PersistentEntities persistentEntities)

httpHeadersPreparer

@Bean
public HttpHeadersPreparer httpHeadersPreparer(AuditableBeanWrapperFactory auditableBeanWrapperFactory)

selfLinkProvider

@Bean
public SelfLinkProvider selfLinkProvider(PersistentEntities persistentEntities,
 RepositoryEntityLinks entityLinks,
 @Qualifier("mvcConversionService")
 ObjectProvider<ConversionService> conversionService)

associationLinks

@Bean
public Associations associationLinks(RepositoryResourceMappings resourceMappings,
 RepositoryRestConfiguration repositoryRestConfiguration)

getEntityLookups

protected List<EntityLookup<?>> getEntityLookups()

defaultMethodArgumentResolvers

protected List<HandlerMethodArgumentResolver> defaultMethodArgumentResolvers(SelfLinkProvider selfLinkProvider,
 PersistentEntityResourceHandlerMethodArgumentResolver persistentEntityArgumentResolver,
 PersistentEntityResourceAssemblerArgumentResolver persistentEntityResourceAssemblerArgumentResolver,
 RootResourceInformationHandlerMethodArgumentResolver repoRequestArgumentResolver)

basicObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper basicObjectMapper()

enumTranslator

@Bean
public EnumTranslator enumTranslator(MessageResolver resolver)

alpsConverter

@Bean
public RootResourceInformationToAlpsDescriptorConverter alpsConverter(Repositories repositories,
 PersistentEntities persistentEntities,
 RepositoryEntityLinks entityLinks,
 EnumTranslator enumTranslator,
 Associations associationLinks,
 RepositoryRestConfiguration repositoryRestConfiguration)

profileResourceProcessor

@Bean
public ProfileResourceProcessor profileResourceProcessor(RepositoryRestConfiguration repositoryRestConfiguration)

addResourceHandlers

public void addResourceHandlers(ResourceHandlerRegistry registry)

Specified by:

addResourceHandlers in interface WebMvcConfigurer