Class AbstractMappingJacksonResponseBodyAdvice
java.lang.Object
org.springframework.web.servlet.mvc.method.annotation.AbstractMappingJacksonResponseBodyAdvice
- All Implemented Interfaces:
ResponseBodyAdvice<Object>
- Direct Known subclasses:
JsonViewResponseBodyAdvice
public abstract class AbstractMappingJacksonResponseBodyAdvice
extends Object
implements ResponseBodyAdvice<Object>
A convenient base class for
ResponseBodyAdvice implementations
that customize the response before JsON serialization with
AbstractJacksonHttpMessageConverter's and
AbstractJackson2HttpMessageConverter's concrete subclasses.- since:
- 4.1
- Author:
- Rossen stoyanchev, sebastien Deleuze
-
Constructor summary
Constructors -
Method summary
Modifier and TypeMethodDescriptionbeforeBodyWrite(@Nullable Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, serverHttpRequest request, serverHttpResponse response) Invoked after anHttpMessageConverteris selected and just before its write method is invoked.protected abstract voidbeforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, serverHttpRequest request, serverHttpResponse response) Invoked only if the converter type isMappingJackson2HttpMessageConverter.protected MappingJacksonValuegetOrCreateContainer(Object body) Wrap the body in aMappingJacksonValuevalue container (for providing additional serialization instructions) or simply cast it if already wrapped.booleansupports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) Whether this component supports the given controller method return type and the selectedHttpMessageConvertertype.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, tostring, wait, wait, waitMethods inherited from interface ResponseBodyAdvice
determineWriteHints
-
Constructor Details
-
AbstractMappingJacksonResponseBodyAdvice
public AbstractMappingJacksonResponseBodyAdvice()
-
-
Method Details
-
supports
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) Description copied from interface: ResponseBodyAdviceWhether this component supports the given controller method return type and the selectedHttpMessageConvertertype.- specified by:
supports in interface ResponseBodyAdvice<Object>- Parameters:
returnType- the return typeconverterType- the selected converter type- Returns:
trueifResponseBodyAdvice.beforeBodyWrite(T, MethodParameter, MediaType, Class, serverHttpRequest, serverHttpResponse)should be invoked;falseotherwise
-
beforeBodyWrite
public final @Nullable Object beforeBodyWrite(@Nullable Object body, MethodParameter returnType, MediaType contentType, Class<? extends HttpMessageConverter<?>> converterType, serverHttpRequest request, serverHttpResponse response) Description copied from interface: ResponseBodyAdviceInvoked after anHttpMessageConverteris selected and just before its write method is invoked.- specified by:
beforeBodyWrite in interface ResponseBodyAdvice<Object>- Parameters:
body- the body to be writtenreturnType- the return type of the controller methodcontentType- the content type selected through content negotiationconverterType- 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
-
getOrCreateContainer
Wrap the body in aMappingJacksonValuevalue container (for providing additional serialization instructions) or simply cast it if already wrapped. -
beforeBodyWriteInternal
protected abstract void beforeBodyWriteInternal(MappingJacksonValue bodyContainer, MediaType contentType, MethodParameter returnType, serverHttpRequest request, serverHttpResponse response) Invoked only if the converter type isMappingJackson2HttpMessageConverter.
-