Interface RepositoryRestConfigurer

public interface RepositoryRestConfigurer

Component to configure and customize the setup of Spring Data REST.

Since:

2.4

Author:

Oliver Gierke, Mark Paluch

Method Summary

Modifier and Type	Method	Description
default void	configureConversionService(ConfigurableConversionService conversionService)	Override this method to add your own converters.
default void	configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver)	Configure the ExceptionHandlerExceptionResolver.
default void	configureHttpMessageConverters(List<HttpMessageConverter<?>> messageConverters)	Configure the available HttpMessageConverters by adding your own.
default void	configureJacksonObjectMapper(tools.jackson.databind.cfg.MapperBuilder<? extends tools.jackson.databind.ObjectMapper, ? extends tools.jackson.databind.cfg.MapperBuilder<?,?>> mapperBuilder)	Configure the Jackson MapperBuilder directly.
default void	configureRepositoryRestConfiguration(RepositoryRestConfiguration config, CorsRegistry cors)	Override this method to add additional configuration.
default void	configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener)	Override this method to add validators manually.
default AuditableBeanWrapperFactory	customizeAuditableBeanWrapperFactory(AuditableBeanWrapperFactory factory)	Customize the AuditableBeanWrapperFactory to be used.
default LinkCollector	customizeLinkCollector(LinkCollector collector)	Customize the LinkCollector to be used.
static RepositoryRestConfigurer	withConfig(BiConsumer<RepositoryRestConfiguration, CorsRegistry> consumer)	Convenience method to easily create simple RepositoryRestConfigurer instances that solely want to tweak the RepositoryRestConfiguration.
static RepositoryRestConfigurer	withConfig(Consumer<RepositoryRestConfiguration> consumer)	Convenience method to easily create simple RepositoryRestConfigurer instances that solely want to tweak the RepositoryRestConfiguration.

Method Details

withConfig

static RepositoryRestConfigurer withConfig(Consumer<RepositoryRestConfiguration> consumer)

Convenience method to easily create simple RepositoryRestConfigurer instances that solely want to tweak the RepositoryRestConfiguration.

Parameters:

consumer - must not be null.

Returns:

Since:

3.1

withConfig

static RepositoryRestConfigurer withConfig(BiConsumer<RepositoryRestConfiguration, CorsRegistry> consumer)

Convenience method to easily create simple RepositoryRestConfigurer instances that solely want to tweak the RepositoryRestConfiguration.

Parameters:

consumer - must not be null.

Returns:

Since:

3.4

configureRepositoryRestConfiguration

default void configureRepositoryRestConfiguration(RepositoryRestConfiguration config,
 CorsRegistry cors)

Override this method to add additional configuration.

Parameters:

config - Main configuration bean.

cors - CORS configuration.

Since:

3.4

configureConversionService

default void configureConversionService(ConfigurableConversionService conversionService)

Override this method to add your own converters.

Parameters:

conversionService - Default ConversionService bean.

configureValidatingRepositoryEventListener

default void configureValidatingRepositoryEventListener(ValidatingRepositoryEventListener validatingListener)

Override this method to add validators manually.

Parameters:

validatingListener - the ApplicationListener responsible for invoking Validator instances.

configureExceptionHandlerExceptionResolver

default void configureExceptionHandlerExceptionResolver(ExceptionHandlerExceptionResolver exceptionResolver)

Configure the ExceptionHandlerExceptionResolver.

Parameters:

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

configureHttpMessageConverters

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

Configure the available HttpMessageConverters by adding your own.

Parameters:

messageConverters - the converters to be used by the system.

configureJacksonObjectMapper

default void configureJacksonObjectMapper(tools.jackson.databind.cfg.MapperBuilder<? extends tools.jackson.databind.ObjectMapper, ? extends tools.jackson.databind.cfg.MapperBuilder<?,?>> mapperBuilder)

Configure the Jackson MapperBuilder directly.

Parameters:

mapperBuilder - the mapper builder to configure.

customizeAuditableBeanWrapperFactory

default AuditableBeanWrapperFactory customizeAuditableBeanWrapperFactory(AuditableBeanWrapperFactory factory)

Customize the AuditableBeanWrapperFactory to be used.

Parameters:

factory - will never be null.

Returns:

must not be null.

Since:

3.5

customizeLinkCollector

default LinkCollector customizeLinkCollector(LinkCollector collector)

Customize the LinkCollector to be used.

Parameters:

collector - will never be null.

Returns:

must not be null.

Since:

3.5