Skip to content

GH-2806: Add generics support to HTTP Inbound #2807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2019
Merged

GH-2806: Add generics support to HTTP Inbound #2807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions ...p/src/main/java/org/springframework/integration/http/inbound/BaseHttpInboundEndpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017-2018 the original author or authors.
* Copyright 2017-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -66,23 +66,23 @@ public class BaseHttpInboundEndpoint extends MessagingGatewaySupport implements

protected final AtomicInteger activeCount = new AtomicInteger();

private volatile ResolvableType requestPayloadType = null;
private ResolvableType requestPayloadType = null;

private volatile HeaderMapper<HttpHeaders> headerMapper = DefaultHttpHeaderMapper.inboundMapper();
private HeaderMapper<HttpHeaders> headerMapper = DefaultHttpHeaderMapper.inboundMapper();

private volatile boolean extractReplyPayload = true;
private boolean extractReplyPayload = true;

private volatile Expression statusCodeExpression;
private Expression statusCodeExpression;

private volatile EvaluationContext evaluationContext;
private EvaluationContext evaluationContext;

private volatile RequestMapping requestMapping = new RequestMapping();
private RequestMapping requestMapping = new RequestMapping();

private volatile Expression payloadExpression;
private Expression payloadExpression;

private volatile Map<String, Expression> headerExpressions;
private Map<String, Expression> headerExpressions;

private volatile CrossOrigin crossOrigin;
private CrossOrigin crossOrigin;

public BaseHttpInboundEndpoint(boolean expectReply) {
super(expectReply);
Expand Down Expand Up @@ -279,8 +279,13 @@ private void validateSupportedMethods() {
}

protected HttpStatus evaluateHttpStatus(HttpEntity<?> httpEntity) {
Object value = this.statusCodeExpression.getValue(this.evaluationContext, httpEntity);
return buildHttpStatus(value);
if (this.statusCodeExpression != null) {
Object value = this.statusCodeExpression.getValue(this.evaluationContext, httpEntity);
return buildHttpStatus(value);
}
else {
return HttpStatus.INTERNAL_SERVER_ERROR;
}
}

protected HttpStatus resolveHttpStatusFromHeaders(MessageHeaders headers) {
Expand Down Expand Up @@ -328,8 +333,7 @@ public String getComponentType() {
* @return true or false if HTTP request can contain the body
*/
protected boolean isReadable(HttpRequest request) {
HttpMethod method = request.getMethod();
return method == null ? false : !(CollectionUtils.containsInstance(nonReadableBodyHttpMethods, method));
return !(CollectionUtils.containsInstance(nonReadableBodyHttpMethods, request.getMethod()));
}

}
109 changes: 56 additions & 53 deletions ...java/org/springframework/integration/http/inbound/HttpRequestHandlingEndpointSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.integration.http.inbound;

import java.io.IOException;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
Expand All @@ -39,6 +40,7 @@
import org.springframework.http.MediaType;
import org.springframework.http.RequestEntity;
import org.springframework.http.converter.ByteArrayHttpMessageConverter;
import org.springframework.http.converter.GenericHttpMessageConverter;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.ResourceHttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
Expand Down Expand Up @@ -93,7 +95,7 @@
* In a request-reply scenario, the reply Message's payload will be extracted prior
* to generating a response by default.
* To have the entire serialized Message available for the response, switch the
* {@link #extractReplyPayload} value to {@code false}.
* {@code extractReplyPayload} value to {@code false}.
*
* @author Mark Fisher
* @author Oleg Zhurakousky
Expand Down Expand Up @@ -146,27 +148,21 @@ public HttpRequestHandlingEndpointSupport(boolean expectReply) {
stringHttpMessageConverter.setWriteAcceptCharset(false);
this.defaultMessageConverters.add(stringHttpMessageConverter);
this.defaultMessageConverters.add(new ResourceHttpMessageConverter());
SourceHttpMessageConverter<Source> sourceConverter = new SourceHttpMessageConverter<Source>();
SourceHttpMessageConverter<Source> sourceConverter = new SourceHttpMessageConverter<>();
this.defaultMessageConverters.add(sourceConverter);
if (jaxb2Present) {
this.defaultMessageConverters.add(new Jaxb2RootElementHttpMessageConverter());
if (logger.isDebugEnabled()) {
logger.debug("'Jaxb2RootElementHttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
logger.debug("'Jaxb2RootElementHttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
if (JacksonPresent.isJackson2Present()) {
this.defaultMessageConverters.add(new MappingJackson2HttpMessageConverter());
if (logger.isDebugEnabled()) {
logger.debug("'MappingJackson2HttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
logger.debug("'MappingJackson2HttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
if (romeToolsPresent) {
this.defaultMessageConverters.add(new AtomFeedHttpMessageConverter());
this.defaultMessageConverters.add(new RssChannelHttpMessageConverter());
if (logger.isDebugEnabled()) {
logger.debug("'AtomFeedHttpMessageConverter' was added to the 'defaultMessageConverters'.");
logger.debug("'RssChannelHttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
logger.debug("'AtomFeedHttpMessageConverter' was added to the 'defaultMessageConverters'.");
logger.debug("'RssChannelHttpMessageConverter' was added to the 'defaultMessageConverters'.");
}
}

Expand All @@ -176,8 +172,9 @@ public HttpRequestHandlingEndpointSupport(boolean expectReply) {
* @param messageConverters The message converters.
*/
public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
Assert.notNull(messageConverters, "'messageConverters' must not be null");
Assert.noNullElements(messageConverters.toArray(), "'messageConverters' must not contain null entries");
List<HttpMessageConverter<?>> localConverters = new ArrayList<HttpMessageConverter<?>>(messageConverters);
List<HttpMessageConverter<?>> localConverters = new ArrayList<>(messageConverters);
if (this.mergeWithDefaultConverters) {
localConverters.addAll(this.defaultMessageConverters);
this.convertersMerged = true;
Expand Down Expand Up @@ -266,14 +263,13 @@ private Message<?> actualDoHandleRequest(HttpServletRequest servletRequest, Requ

this.activeCount.incrementAndGet();
try {
StandardEvaluationContext evaluationContext = this.createEvaluationContext();
StandardEvaluationContext evaluationContext = createEvaluationContext();
evaluationContext.setRootObject(httpEntity);

evaluationContext.setVariable("requestAttributes", RequestContextHolder.currentRequestAttributes());

MultiValueMap<String, String> requestParams = this.convertParameterMap(servletRequest.getParameterMap());
MultiValueMap<String, String> requestParams = convertParameterMap(servletRequest.getParameterMap());
evaluationContext.setVariable("requestParams", requestParams);

evaluationContext.setVariable("requestHeaders", new ServletServerHttpRequest(servletRequest).getHeaders());

Cookie[] requestCookies = servletRequest.getCookies();
Expand Down Expand Up @@ -335,12 +331,16 @@ private Message<?> actualDoHandleRequest(HttpServletRequest servletRequest, Requ
AbstractIntegrationMessageBuilder<?> messageBuilder = null;

if (payload instanceof Message<?>) {
messageBuilder = this.getMessageBuilderFactory().fromMessage((Message<?>) payload)
.copyHeadersIfAbsent(headers);
messageBuilder =
getMessageBuilderFactory()
.fromMessage((Message<?>) payload)
.copyHeadersIfAbsent(headers);
}
else {
Assert.state(payload != null, "payload cannot be null");
messageBuilder = this.getMessageBuilderFactory().withPayload(payload).copyHeaders(headers);
messageBuilder = getMessageBuilderFactory()
.withPayload(payload)
.copyHeaders(headers);
}

HttpMethod method = httpEntity.getMethod();
Expand All @@ -359,30 +359,24 @@ private Message<?> actualDoHandleRequest(HttpServletRequest servletRequest, Requ
Message<?> reply = null;
if (this.expectReply) {
try {
reply = this.sendAndReceiveMessage(message);
reply = sendAndReceiveMessage(message);
}
catch (MessageTimeoutException e) {
if (getStatusCodeExpression() != null) {
reply = getMessageBuilderFactory().withPayload(e.getMessage())
.setHeader(org.springframework.integration.http.HttpHeaders.STATUS_CODE,
evaluateHttpStatus(httpEntity))
.build();
}
else {
reply = getMessageBuilderFactory().withPayload(e.getMessage())
.setHeader(org.springframework.integration.http.HttpHeaders.STATUS_CODE,
HttpStatus.INTERNAL_SERVER_ERROR)
.build();
}
reply =
getMessageBuilderFactory()
.withPayload(e.getMessage())
.setHeader(org.springframework.integration.http.HttpHeaders.STATUS_CODE,
evaluateHttpStatus(httpEntity))
.build();
}
}
else {
this.send(message);
send(message);
}
return reply;
}
finally {
this.postProcessRequest(servletRequest);
postProcessRequest(servletRequest);
this.activeCount.decrementAndGet();
}
}
Expand All @@ -391,7 +385,8 @@ private Message<?> createServiceUnavailableResponse() {
if (logger.isDebugEnabled()) {
logger.debug("Endpoint is stopped; returning status " + HttpStatus.SERVICE_UNAVAILABLE);
}
return this.getMessageBuilderFactory().withPayload("Endpoint is stopped")
return getMessageBuilderFactory()
.withPayload("Endpoint is stopped")
.setHeader(org.springframework.integration.http.HttpHeaders.STATUS_CODE, HttpStatus.SERVICE_UNAVAILABLE)
.build();
}
Expand All @@ -401,7 +396,7 @@ private Message<?> createServiceUnavailableResponse() {
* sets up the {@link ServletServerHttpResponse}.
* @param response The ServletServerHttpResponse.
* @param replyMessage The reply message.
* @return The message payload (if {@link #extractReplyPayload}) otherwise the message.
* @return The message payload (if {@code extractReplyPayload}) otherwise the message.
*/
protected final Object setupResponseAndConvertReply(ServletServerHttpResponse response, Message<?> replyMessage) {
getHeaderMapper().fromHeaders(replyMessage.getHeaders(), response.getHeaders());
Expand Down Expand Up @@ -461,7 +456,7 @@ private void postProcessRequest(HttpServletRequest request) {
* Converts a servlet request's parameterMap to a {@link MultiValueMap}.
*/
private MultiValueMap<String, String> convertParameterMap(Map<String, String[]> parameterMap) {
MultiValueMap<String, String> convertedMap = new LinkedMultiValueMap<String, String>(parameterMap.size());
MultiValueMap<String, String> convertedMap = new LinkedMultiValueMap<>(parameterMap.size());
for (Map.Entry<String, String[]> entry : parameterMap.entrySet()) {
String[] values = entry.getValue();
for (String value : values) {
Expand All @@ -487,29 +482,37 @@ protected Object extractRequestBody(ServletServerHttpRequest request) throws IOE
contentType = MediaType.APPLICATION_OCTET_STREAM;
}
ResolvableType requestPayloadType = getRequestPayloadType();
Class<?> expectedType;
if (requestPayloadType == null) {
expectedType = "text".equals(contentType.getType()) ? String.class : byte[].class;
}
else {
expectedType = requestPayloadType.resolve();
requestPayloadType =
ResolvableType.forClass(
"text".equals(contentType.getType())
? String.class
: byte[].class);
}

/*
* TODO: resolve() can return null, which is not valid for canRead().
* Perhaps we should coerce to String/byte[] instead of attempting
* to convert. However this might be a breaking change - 5.2?
* Hence NOSONAR below.
*/
Type targetType = requestPayloadType.getType();
Class<?> targetClass = requestPayloadType.toClass();

for (HttpMessageConverter<?> converter : this.messageConverters) {
if (converter.canRead(expectedType, contentType)) {
return converter.read((Class) expectedType, request);
GenericHttpMessageConverter<?> genericConverter =
converter instanceof GenericHttpMessageConverter
? (GenericHttpMessageConverter<?>) converter
: null;
if (genericConverter != null
? genericConverter.canRead(targetType, null, contentType) :
(converter.canRead(targetClass, contentType))) {

if (genericConverter != null) {
return genericConverter.read(targetType, null, request);
}
else {
return converter.read((Class) targetClass, request);
}
}
}
throw new MessagingException(// NOSONAR might be null; see comment above.
throw new MessagingException(
"Could not convert request: no suitable HttpMessageConverter found for expected type ["
+ expectedType != null ? expectedType.getName() : "null"
+ "] and content type [" + contentType + "]");
+ requestPayloadType + "] and content type [" + contentType + "]");
}

}
9 changes: 5 additions & 4 deletions ...ava/org/springframework/integration/http/inbound/HttpRequestHandlingMessagingGateway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@
* (e.g. 200 OK).
* <p>
* The default supported request methods are GET and POST, but the list of values can be configured with the
* {@link RequestMapping#methods} property. The payload generated from a GET request (or HEAD or OPTIONS if supported) will
* be a {@link org.springframework.util.MultiValueMap} containing the parameter values. For a request containing a body
* (e.g. a POST), the type
* of the payload is determined by the {@link #setRequestPayloadTypeClass(Class)} request payload type}.
* {@link RequestMapping#getMethods()} property.
* The payload generated from a GET request (or HEAD or OPTIONS if supported) will
* be a {@link org.springframework.util.MultiValueMap} containing the parameter values.
* For a request containing a body (e.g. a POST), the type of the payload is determined
* by the {@link #setRequestPayloadTypeClass(Class)} request payload type}.
* <p>
* If the HTTP request is a multipart and a "multipartResolver" bean has been defined in the context, then it will be
* converted by the
Expand Down
59 changes: 57 additions & 2 deletions ...rg/springframework/integration/http/inbound/HttpRequestHandlingMessagingGatewayTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@
import org.junit.Test;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.ResolvableType;
import org.springframework.expression.common.LiteralExpression;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
Expand All @@ -60,6 +62,8 @@
import org.springframework.util.SerializationUtils;
import org.springframework.web.multipart.MultipartResolver;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
* @author Mark Fisher
* @author Gary Russell
Expand Down Expand Up @@ -270,9 +274,52 @@ public void serializableRequestBody() throws Exception {
assertThat(message.getPayload().getClass()).isEqualTo(TestBean.class);
TestBean result = (TestBean) message.getPayload();
assertThat(result.name).isEqualTo("T. Bean");
assertThat(result.age).isEqualTo(84);
assertThat(result.age).isEqualTo(42);
}

@Test
public void testJsonRequestBody() throws Exception {
QueueChannel channel = new QueueChannel();
HttpRequestHandlingMessagingGateway gateway = new HttpRequestHandlingMessagingGateway(false);
gateway.setBeanFactory(mock(BeanFactory.class));
ParameterizedTypeReference<List<TestBean>> parameterizedTypeReference =
new ParameterizedTypeReference<List<TestBean>>() {

};
gateway.setRequestPayloadType(ResolvableType.forType(parameterizedTypeReference));
gateway.setRequestChannel(channel);
gateway.afterPropertiesSet();
gateway.start();

MockHttpServletRequest request = new MockHttpServletRequest("POST", "/test");

request.setContentType("application/json");
TestBean testBean = new TestBean();
testBean.setName("T. Bean");
testBean.setAge(42);
request.setContent(new ObjectMapper().writeValueAsBytes(new TestBean[] { testBean }));
MockHttpServletResponse response = new MockHttpServletResponse();
gateway.handleRequest(request, response);
byte[] bytes = response.getContentAsByteArray();
assertThat(bytes).isNotNull();
Message<?> message = channel.receive(0);

assertThat(message).isNotNull()
.extracting(Message::getPayload)
.isInstanceOf(List.class)
.asList()
.hasSize(1)
.element(0)
.isInstanceOf(TestBean.class)
.satisfies((actual) -> {
TestBean bean = (TestBean) actual;
assertThat(bean).extracting(TestBean::getName).isEqualTo("T. Bean");
assertThat(bean).extracting(TestBean::getAge).isEqualTo(42);
});

}


@Test
public void INT2680DuplicateContentTypeHeader() throws Exception {

Expand Down Expand Up @@ -492,7 +539,15 @@ public void setName(String name) {
}

public void setAge(int age) {
this.age = age * 2;
this.age = age;
}

public String getName() {
return name;
}

public int getAge() {
return age;
}

}
Expand Down