Is there a way to pass header information in Spring RestTemplate DELETE call

Question

In Spring RestTemplate we are having the following methods for delete.

@Override
    public void delete(String url, Object... urlVariables) throws RestClientException {
        execute(url, HttpMethod.DELETE, null, null, urlVariables);
    }

    @Override
    public void delete(String url, Map<String, ?> urlVariables) throws RestClientException {
        execute(url, HttpMethod.DELETE, null, null, urlVariables);
    }

    @Override
    public void delete(URI url) throws RestClientException {
        execute(url, HttpMethod.DELETE, null, null);
    }

None of these methods are having any place to pass header information. Is there any other method which can be used for DELETE request with header information?

score 38 · Accepted Answer · answered May 08 '15 at 12:01

38

You can use the exchange method (which takes any HTTP request type), rather than using the delete method:

MultiValueMap<String, String> headers = new LinkedMultiValueMap<>();
headers.add("X-XSRF-HEADER", "BlahBlah");
headers.add("Authorization", "Basic " + blahblah);
etc...

HttpEntity<?> request = new HttpEntity<Object>(headers);
restTemplate.exchange(url, HttpMethod.DELETE, request, String.class);

answered May 08 '15 at 12:01

David Lavender

8,021
3
35
55

Are you sure this will work. As far as I know, HttpMethod.DELETE is not allowed to have a body. – Zeeshan May 08 '15 at 12:12
1

It works fine for us. It doesn't have a body: just headers, which are allowed in any HTTP message. – David Lavender May 08 '15 at 12:18

score 7 · Answer 2 · answered May 08 '15 at 15:17

You can implement ClientHttpRequestInterceptor and set it for your restTemplate. In your interceptor:

 @Override
public ClientHttpResponse intercept(
        HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
        throws IOException {
        @Override
        public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
            if (request.getMethod() == HttpMethod.DELETE){
                request.getHeaders().add(headerName, headerValue); 
             }

             return execution.execute(request, body);
        }
}

In your config:

restTemplate.setInterceptors(...)

This is a better solution when you need to add the header to lots of calls or every call. It's much less code. — Christopher Schneider, Nov 07 '18 at 17:43

Is there a way to pass header information in Spring RestTemplate DELETE call

2 Answers2