Top Description Interfaces Classes
module spring.webmvc

Package org.springframework.web.servlet.mvc.method.annotation

Annotations
@NonNullApi
@NonNullFields
Imports
org.springframework.lang.NonNullApi, .NonNullFields

MVC infrastructure for annotation-based handler method processing, building on the org.springframework.web.method.annotation package. Entry points are org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping and org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.

Interface Summary

Modifier and TypeInterface and Description
public interface
RequestBodyAdvice

Allows customizing the request before its body is read and converted into an Object and also allows for processing of the resulting Object before it is passed into a controller method as an @RequestBody or an HttpEntity method argument.

public interface
ResponseBodyAdvice<
the body type
T
>

Allows customizing the response after the execution of an @ResponseBody or a ResponseEntity controller method but before the body is written with an HttpMessageConverter.

public interface
StreamingResponseBody

A controller method return value type for asynchronous request processing where the application can write directly to the response OutputStream without holding up the Servlet container thread.

Class Summary

Modifier and TypeClass and Description
public abstract class
AbstractMappingJacksonResponseBodyAdvice

A convenient base class for ResponseBodyAdvice implementations that customize the response before JSON serialization with AbstractJackson2HttpMessageConverter's concrete subclasses.

public abstract class
AbstractMessageConverterMethodArgumentResolver

A base class for resolving method argument values by reading from the body of a request with HttpMessageConverters.

public abstract class
AbstractMessageConverterMethodProcessor

Extends AbstractMessageConverterMethodArgumentResolver with the ability to handle method return values by writing to the response with HttpMessageConverters.

public class
AsyncTaskMethodReturnValueHandler

Handles return values of type WebAsyncTask.

public class
CallableMethodReturnValueHandler

Handles return values of type Callable.

public class
public class
public class
ExceptionHandlerExceptionResolver

An AbstractHandlerMethodExceptionResolver that resolves exceptions through @ExceptionHandler methods.

public class
ExtendedServletRequestDataBinder

Subclass of ServletRequestDataBinder that adds URI template variables to the values used for data binding.

public class
HttpEntityMethodProcessor

Resolves HttpEntity and RequestEntity method argument values, as well as return values of type HttpEntity, ResponseEntity, ErrorResponse and ProblemDetail.

public class
public class
JsonViewRequestBodyAdvice

A RequestBodyAdvice implementation that adds support for Jackson's @JsonView annotation declared on a Spring MVC @HttpEntity or @RequestBody method parameter.

public class
JsonViewResponseBodyAdvice

A ResponseBodyAdvice implementation that adds support for Jackson's @JsonView annotation declared on a Spring MVC @RequestMapping or @ExceptionHandler method.

public class
MatrixVariableMapMethodArgumentResolver

Resolves arguments of type Map annotated with @MatrixVariable where the annotation does not specify a name.

public class
MatrixVariableMethodArgumentResolver

Resolves arguments annotated with @MatrixVariable.

public class
ModelAndViewMethodReturnValueHandler

Handles return values of type ModelAndView copying view and model information to the ModelAndViewContainer.

public class
ModelAndViewResolverMethodReturnValueHandler

This return value handler is intended to be ordered after all others as it attempts to handle _any_ return value type (i.e. returns true for all return types).

public class
MvcUriComponentsBuilder

Creates instances of org.springframework.web.util.UriComponentsBuilder by pointing to @RequestMapping methods on Spring MVC controllers.

public class
PathVariableMapMethodArgumentResolver

Resolves Map method arguments annotated with @PathVariable where the annotation does not specify a path variable name.

public class
PathVariableMethodArgumentResolver

Resolves method arguments annotated with an @PathVariable.

public class
PrincipalMethodArgumentResolver

Resolves an argument of type Principal, similar to ServletRequestMethodArgumentResolver but irrespective of whether the argument is annotated or not.

pack-priv class
ReactiveTypeHandler

Private helper class to assist with handling "reactive" return values types that can be adapted to a Reactive Streams Publisher through the ReactiveAdapterRegistry.

public class
public class
RequestAttributeMethodArgumentResolver

Resolves method arguments annotated with an @RequestAttribute.

public abstract class
RequestBodyAdviceAdapter

A convenient starting point for implementing RequestBodyAdvice with default method implementations.

public class
public class
RequestMappingHandlerMapping

Creates RequestMappingInfo instances from type-level and method-level @RequestMapping and @HttpExchange annotations in @Controller classes.

public class
RequestPartMethodArgumentResolver

Resolves the following method arguments:

pack-priv class
RequestResponseBodyAdviceChain

Invokes RequestBodyAdvice and ResponseBodyAdvice where each instance may be (and is most likely) wrapped with ControllerAdviceBean.

public class
RequestResponseBodyMethodProcessor

Resolves method arguments annotated with @RequestBody and handles return values from methods annotated with @ResponseBody by reading and writing to the body of the request or response with an HttpMessageConverter.

public class
ResponseBodyEmitter

A controller method return value type for asynchronous request processing where one or more objects are written to the response.

public class
ResponseBodyEmitterReturnValueHandler

Handler for return values of type ResponseBodyEmitter and subclasses such as SseEmitter including the same types wrapped with ResponseEntity.

public abstract class
ResponseEntityExceptionHandler

A class with an @ExceptionHandler method that handles all Spring MVC raised exceptions by returning a ResponseEntity with RFC 7807 formatted error details in the body.

public class
public class
ServletInvocableHandlerMethod

Extends InvocableHandlerMethod with the ability to handle return values through a registered HandlerMethodReturnValueHandler and also supports setting the response status based on a method-level @ResponseStatus annotation.

public class
ServletModelAttributeMethodProcessor

A Servlet-specific ModelAttributeMethodProcessor that applies data binding through a WebDataBinder of type ServletRequestDataBinder.

public class
ServletRequestDataBinderFactory

Creates a ServletRequestDataBinder.

public class
ServletRequestMethodArgumentResolver

Resolves servlet backed request-related method arguments.

public class
ServletResponseMethodArgumentResolver

Resolves servlet backed response-related method arguments.

public class
public class
SessionAttributeMethodArgumentResolver

Resolves method arguments annotated with an @SessionAttribute.

public class
SseEmitter

A specialization of ResponseBodyEmitter for sending Server-Sent Events.

public class
StreamingResponseBodyReturnValueHandler

Supports return values of type org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody and also ResponseEntity<StreamingResponseBody>.

public class
public class
ViewMethodReturnValueHandler

Handles return values that are of type View.

public class
ViewNameMethodReturnValueHandler

Handles return values of types void and String interpreting them as view name reference.