Interface ResponseBodyAdvice<T>
- Type Parameters:
T- the body type
- All Known Implementing Classes:
AbstractMappingJacksonResponseBodyAdvice,JsonViewResponseBodyAdvice
public interface ResponseBodyAdvice<T>
Allows customizing the response after the execution of an@ResponseBodyor aResponseEntitycontroller method but before the body is written with anHttpMessageConverter.Implementations may be registered directly with
RequestMappingHandlerAdapterandExceptionHandlerExceptionResolveror more likely annotated with@ControllerAdvicein which case they will be auto-detected by both.- Since:
- 4.1
- Author:
- Rossen Stoyanchev
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TbeforeBodyWrite(T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response)Invoked after anHttpMessageConverteris selected and just before its write method is invoked.booleansupports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType)Whether this component supports the given controller method return type and the selectedHttpMessageConvertertype.
Method Detail
supports
boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType)
Whether this component supports the given controller method return type and the selectedHttpMessageConvertertype.- Parameters:
returnType- the return typeconverterType- the selected converter type- Returns:
trueifbeforeBodyWrite(T, org.springframework.core.MethodParameter, org.springframework.http.MediaType, java.lang.Class<? extends org.springframework.http.converter.HttpMessageConverter<?>>, org.springframework.http.server.ServerHttpRequest, org.springframework.http.server.ServerHttpResponse)should be invoked;falseotherwise
beforeBodyWrite
@Nullable T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response)
Invoked after anHttpMessageConverteris selected and just before its write method is invoked.- Parameters:
body- the body to be writtenreturnType- the return type of the controller methodselectedContentType- the content type selected through content negotiationselectedConverterType- the converter type selected to write to the responserequest- the current requestresponse- the current response- Returns:
- the body that was passed in or a modified (possibly new) instance