org.openingo.spring.boot.extension.http.response

Class HttpResponseBodyAdvice

java.lang.Object

org.openingo.spring.boot.extension.http.response.HttpResponseBodyAdvice

All Implemented Interfaces:

org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

public class HttpResponseBodyAdvice
extends Object
implements org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

HttpResponseBodyAdvice

Author:

Qicz

Constructor Summary

Constructors

Constructor and Description
HttpResponseBodyAdvice()

Method Summary

Modifier and Type	Method and Description
Object	beforeBodyWrite(Object body, org.springframework.core.MethodParameter returnType, org.springframework.http.MediaType selectedContentType, Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> selectedConverterType, org.springframework.http.server.ServerHttpRequest request, org.springframework.http.server.ServerHttpResponse response) Invoked after an HttpMessageConverter is selected and just before its write method is invoked.
boolean	supports(org.springframework.core.MethodParameter returnType, Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> converterType) Whether this component supports the given controller method return type and the selected HttpMessageConverter type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpResponseBodyAdvice

public HttpResponseBodyAdvice()

Method Detail

supports

public boolean supports(org.springframework.core.MethodParameter returnType,
                        Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> converterType)

Whether this component supports the given controller method return type and the selected HttpMessageConverter type.

Specified by:

supports in interface org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

Parameters:

returnType - the return type

converterType - the selected converter type

Returns:

true if beforeBodyWrite(java.lang.Object, 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; false otherwise

beforeBodyWrite

public Object beforeBodyWrite(@Nullable
                              Object body,
                              org.springframework.core.MethodParameter returnType,
                              org.springframework.http.MediaType selectedContentType,
                              Class<? extends org.springframework.http.converter.HttpMessageConverter<?>> selectedConverterType,
                              org.springframework.http.server.ServerHttpRequest request,
                              org.springframework.http.server.ServerHttpResponse response)

Invoked after an HttpMessageConverter is selected and just before its write method is invoked.

Specified by:

beforeBodyWrite in interface org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice<Object>

Parameters:

body - the body to be written

returnType - the return type of the controller method

selectedContentType - the content type selected through content negotiation

selectedConverterType - the converter type selected to write to the response

request - the current request

response - the current response

Returns:

the body that was passed in or a modified (possibly new) instance