Skip to content

SPR-15066 - Allow request interceptor to add to headers set via entity #1277

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

Closed
wants to merge 1 commit into from
Closed

SPR-15066 - Allow request interceptor to add to headers set via entity #1277

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
14 changes: 10 additions & 4 deletions spring-web/src/main/java/org/springframework/web/client/RestTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@
import java.lang.reflect.Type;
import java.net.URI;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpEntity;
Expand Down Expand Up @@ -844,7 +846,7 @@ public void doWithRequest(ClientHttpRequest httpRequest) throws IOException {
HttpHeaders httpHeaders = httpRequest.getHeaders();
HttpHeaders requestHeaders = this.requestEntity.getHeaders();
if (!requestHeaders.isEmpty()) {
httpHeaders.putAll(requestHeaders);
httpHeaders.putAll(readWriteHttpHeaderMap(requestHeaders));
}
if (httpHeaders.getContentLength() < 0) {
httpHeaders.setContentLength(0L);
Expand All @@ -862,7 +864,7 @@ public void doWithRequest(ClientHttpRequest httpRequest) throws IOException {
GenericHttpMessageConverter<Object> genericMessageConverter = (GenericHttpMessageConverter<Object>) messageConverter;
if (genericMessageConverter.canWrite(requestBodyType, requestBodyClass, requestContentType)) {
if (!requestHeaders.isEmpty()) {
httpRequest.getHeaders().putAll(requestHeaders);
httpRequest.getHeaders().putAll(readWriteHttpHeaderMap(requestHeaders));
}
if (logger.isDebugEnabled()) {
if (requestContentType != null) {
Expand All @@ -881,7 +883,7 @@ public void doWithRequest(ClientHttpRequest httpRequest) throws IOException {
}
else if (messageConverter.canWrite(requestBodyClass, requestContentType)) {
if (!requestHeaders.isEmpty()) {
httpRequest.getHeaders().putAll(requestHeaders);
httpRequest.getHeaders().putAll(readWriteHttpHeaderMap(requestHeaders));
}
if (logger.isDebugEnabled()) {
if (requestContentType != null) {
Expand All @@ -906,8 +908,12 @@ else if (messageConverter.canWrite(requestBodyClass, requestContentType)) {
throw new RestClientException(message);
}
}
}

private Map<String, List<String>> readWriteHttpHeaderMap(HttpHeaders httpHeaders) {
return httpHeaders.entrySet().stream().collect(
Collectors.toMap(Map.Entry::getKey, (entry) -> new LinkedList<>(entry.getValue())));
}
}

/**
* Response extractor for {@link HttpEntity}.
Expand Down
30 changes: 30 additions & 0 deletions spring-web/src/test/java/org/springframework/web/client/RestTemplateTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,14 @@
import org.springframework.http.ResponseEntity;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.converter.GenericHttpMessageConverter;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.util.DefaultUriTemplateHandler;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.collection.IsIterableContainingInOrder.contains;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
Expand Down Expand Up @@ -802,4 +805,31 @@ public void exchangeParameterizedType() throws Exception {

verify(response).close();
}

@Test // SPR-15066
public void requestInterceptorCanAddHeaderValue() throws Exception {
ClientHttpRequestInterceptor interceptor = (request, body, execution) -> {
request.getHeaders().add("MyHeader", "MyInterceptorValue");
return execution.execute(request, body);
};
template.setInterceptors(Collections.singletonList(interceptor));

given(requestFactory.createRequest(new URI("http://example.com"), HttpMethod.POST))
.willReturn(request);
HttpHeaders requestHeaders = new HttpHeaders();
given(request.getHeaders()).willReturn(requestHeaders);
given(request.execute()).willReturn(response);
given(errorHandler.hasError(response)).willReturn(false);
HttpStatus status = HttpStatus.OK;
given(response.getStatusCode()).willReturn(status);
given(response.getStatusText()).willReturn(status.getReasonPhrase());

HttpHeaders entityHeaders = new HttpHeaders();
entityHeaders.add("MyHeader", "MyEntityValue");
HttpEntity<Void> entity = new HttpEntity<>(null, entityHeaders);
template.exchange("http://example.com", HttpMethod.POST, entity, Void.class);
assertThat(requestHeaders.get("MyHeader"), contains("MyEntityValue", "MyInterceptorValue"));

verify(response).close();
}
}