org.springframework.http.HttpEntity Maven / Gradle / Ivy
/*
* Copyright 2002-2012 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.http;
import org.springframework.util.MultiValueMap;
import org.springframework.util.ObjectUtils;
/**
* Represents an HTTP request or response entity, consisting of headers and body.
*
* Typically used in combination with the {@link org.springframework.web.client.RestTemplate RestTemplate}, like so:
*
* HttpHeaders headers = new HttpHeaders();
* headers.setContentType(MediaType.TEXT_PLAIN);
* HttpEntity<String> entity = new HttpEntity<String>(helloWorld, headers);
* URI location = template.postForLocation("http://example.com", entity);
*
* or
*
* HttpEntity<String> entity = template.getForEntity("http://example.com", String.class);
* String body = entity.getBody();
* MediaType contentType = entity.getHeaders().getContentType();
*
* Can also be used in Spring MVC, as a return value from a @Controller method:
*
* @RequestMapping("/handle")
* public HttpEntity<String> handle() {
* HttpHeaders responseHeaders = new HttpHeaders();
* responseHeaders.set("MyResponseHeader", "MyValue");
* return new HttpEntity<String>("Hello World", responseHeaders);
* }
*
*
* @author Arjen Poutsma
* @since 3.0.2
* @see org.springframework.web.client.RestTemplate
* @see #getBody()
* @see #getHeaders()
*/
public class HttpEntity {
/**
* The empty {@code HttpEntity}, with no body or headers.
*/
public static final HttpEntity EMPTY = new HttpEntity