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, 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, BeanClassLoaderAware

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(ApplicationContext context, ObjectFactory<ConversionService> conversionService)

Method Summary

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.RepositoryEventHandlers.
Associations	associationLinks()
AuditableBeanWrapperFactory	auditableBeanWrapperFactory()
org.springframework.plugin.core.PluginRegistry<BackendIdConverter,Class<?>>	backendIdConverterRegistry()
BackendIdHandlerMethodArgumentResolver	backendIdHandlerMethodArgumentResolver()
BaseUri	baseUri()
protected com.fasterxml.jackson.databind.ObjectMapper	basicObjectMapper()
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()
ExcerptProjector	excerptProjector()
void	extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)
protected List<EntityLookup<?>>	getEntityLookups()
org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter	halJacksonHttpMessageConverter()
com.fasterxml.jackson.databind.ObjectMapper	halObjectMapper()
HttpHeadersPreparer	httpHeadersPreparer()
HttpRequestHandlerAdapter	httpRequestHandlerAdapter() HttpRequestHandlerAdapter to handle CORS preflight requests.
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)
RepositoryRestConfiguration	repositoryRestConfiguration() Main configuration for the REST exporter.
RepositoryRestExceptionHandler	repositoryRestExceptionHandler()
MessageSourceAccessor	resourceDescriptionMessageSourceAccessor() The MessageSourceAccessor to provide messages for ResourceDescriptions being rendered.
RepositoryResourceMappings	resourceMappings()
ResourceMetadataHandlerMethodArgumentResolver	resourceMetadataHandlerMethodArgumentResolver()
org.springframework.hateoas.mvc.ResourceProcessorInvoker	resourceProcessorInvoker()
DelegatingHandlerMapping	restHandlerMapping() The HandlerMapping to delegate requests to Spring Data REST controllers.
SelfLinkProvider	selfLinkProvider()
ServerHttpRequestMethodArgumentResolver	serverHttpRequestMethodArgumentResolver() Turns an HttpServletRequest into a ServerHttpRequest.
void	setBeanClassLoader(ClassLoader classLoader)
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, customizePageableResolver, customizeSortResolver, extendMessageConverters

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 Detail

RepositoryRestMvcConfiguration

public RepositoryRestMvcConfiguration(ApplicationContext context,
                                      @Qualifier(value="mvcConversionService")
                                      ObjectFactory<ConversionService> conversionService)

Method Detail

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Overrides:

setBeanClassLoader in class SpringDataWebConfiguration

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

repositoryRestConfiguration

@Bean
public RepositoryRestConfiguration 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()

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 org.springframework.hateoas.mvc.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:

httpRequestHandlerAdapter

@Bean
public HttpRequestHandlerAdapter httpRequestHandlerAdapter()

HttpRequestHandlerAdapter to handle CORS preflight requests.

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

Returns:

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

extendHandlerExceptionResolvers

public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)

Specified by:

extendHandlerExceptionResolvers in interface WebMvcConfigurer

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

httpHeadersPreparer

@Bean
public HttpHeadersPreparer httpHeadersPreparer()

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