public class

HttpEntity

extends Object
java.lang.Object
   ↳ org.springframework.http.HttpEntity<T>
Known Direct Subclasses

Class Overview

Represents an HTTP request or response entity, consisting of headers and body.

Typically used in combination with the 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);
 }

See Also

Summary

Fields
public static final HttpEntity EMPTY The empty HttpEntity, with no body or headers.
Public Constructors
HttpEntity(T body)
Create a new HttpEntity with the given body and no headers.
HttpEntity(MultiValueMap<String, String> headers)
Create a new HttpEntity with the given headers and no body.
HttpEntity(T body, MultiValueMap<String, String> headers)
Create a new HttpEntity with the given body and headers.
Protected Constructors
HttpEntity()
Create a new, empty HttpEntity.
Public Methods
T getBody()
Returns the body of this entity.
HttpHeaders getHeaders()
Returns the headers of this entity.
boolean hasBody()
Indicates whether this entity has a body.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static final HttpEntity EMPTY

The empty HttpEntity, with no body or headers.

Public Constructors

public HttpEntity (T body)

Create a new HttpEntity with the given body and no headers.

Parameters
body the entity body

public HttpEntity (MultiValueMap<String, String> headers)

Create a new HttpEntity with the given headers and no body.

Parameters
headers the entity headers

public HttpEntity (T body, MultiValueMap<String, String> headers)

Create a new HttpEntity with the given body and headers.

Parameters
body the entity body
headers the entity headers

Protected Constructors

protected HttpEntity ()

Create a new, empty HttpEntity.

Public Methods

public T getBody ()

Returns the body of this entity.

public HttpHeaders getHeaders ()

Returns the headers of this entity.

public boolean hasBody ()

Indicates whether this entity has a body.