Package org.springframework.data.web.config

Annotation Interface EnableSpringDataWebSupport

@Retention(RUNTIME)
@Target({TYPE,ANNOTATION_TYPE})
@Inherited
@Import({SpringDataWebConfigurationImportSelector.class,QuerydslActivator.class,SpringDataWebSettingsRegistar.class})
public @interface EnableSpringDataWebSupport

Annotation to automatically register the following beans for usage with Spring MVC. Note that using this annotation will require Spring 3.2.

• DomainClassConverter - to allow usage of domain types managed by Spring Data repositories as controller method arguments bound with PathVariable or RequestParam.
• PageableHandlerMethodArgumentResolver - to allow injection of Pageable instances into controller methods automatically created from request parameters.
• SortHandlerMethodArgumentResolver - to allow injection of Sort instances into controller methods automatically created from request parameters.

If Spring HATEOAS is present on the classpath we will register the following beans:

• HateoasPageableHandlerMethodArgumentResolver - instead of PageableHandlerMethodArgumentResolver
• HateoasSortHandlerMethodArgumentResolver - instead of SortHandlerMethodArgumentResolver
• PagedResourcesAssembler - for injection into web components
• SortHandlerMethodArgumentResolver - for injection of PagedResourcesAssembler into controller methods

Since:

1.6

Author:

Oliver Gierke, Yanming Zhou

See Also:

• SpringDataWebConfiguration
• HateoasAwareSpringDataWebConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EnableSpringDataWebSupport.PageSerializationMode
static class	EnableSpringDataWebSupport.QuerydslActivator	Import selector to register QuerydslWebConfiguration as configuration class if Querydsl is on the classpath.
static class	EnableSpringDataWebSupport.SpringDataWebConfigurationImportSelector	Import selector to import the appropriate configuration class depending on whether Spring HATEOAS is present on the classpath.
static class	EnableSpringDataWebSupport.SpringDataWebSettingsRegistar	Registers a bean definition for SpringDataWebSettings carrying the configuration values of EnableSpringDataWebSupport.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
EnableSpringDataWebSupport.PageSerializationMode	pageSerializationMode	Configures how to render PageImpl instances.

Element Details

pageSerializationMode

EnableSpringDataWebSupport.PageSerializationMode pageSerializationMode

Configures how to render PageImpl instances. Defaults to EnableSpringDataWebSupport.PageSerializationMode.DIRECT for backward compatibility reasons. Prefer explicitly setting this to EnableSpringDataWebSupport.PageSerializationMode.VIA_DTO, or manually convert PageImpl instances before handing them out of a controller method, either by manually calling new PagedModel<>(page) or using Spring HATEOAS PagedModel abstraction.

Returns:

will never be null.

Since:

3.3

Default:

DIRECT