Top Description Fields Constructors Methods
org.springframework.http

public Class HttpEntity<T>

extends Object
Class Inheritance
Known Direct Subclasses
org.springframework.http.RequestEntity, org.springframework.http.ResponseEntity, org.springframework.http.client.MultipartBodyBuilder.PublisherEntity
Type Parameters
<T>
the body type
Imports
org.springframework.lang.Nullable, org.springframework.util.MultiValueMap, .ObjectUtils
Represents an HTTP request or response entity, consisting of headers and body.

Often used in combination with the org.springframework.web.client.RestTemplate, like so: 

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.TEXT_PLAIN);
HttpEntity<String> entity = new HttpEntity<>("Hello World", headers);
URI location = template.postForLocation("https://example.com", entity);
or 
HttpEntity<String> entity = template.getForEntity("https://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: 
@GetMapping("/handle")
public HttpEntity<String> handle() {
  HttpHeaders responseHeaders = new HttpHeaders();
  responseHeaders.set("MyResponseHeader", "MyValue");
  return new HttpEntity<>("Hello World", responseHeaders);
}
Authors
Arjen Poutsma, Juergen Hoeller
Since
3.0.2
See Also
org.springframework.web.client.RestTemplate, getBody(), getHeaders()

Field Summary

Modifier and TypeField and Description
private final T
body

public static final HttpEntity<?>
EMPTY

The empty HttpEntity, with no body or headers.

private final HttpHeaders
headers

Constructor Summary

AccessConstructor and Description
protected
HttpEntity()

Create a new, empty HttpEntity.

public
HttpEntity(T
the entity body
body)

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

public
HttpEntity(MultiValueMap<String, String>
the entity headers
headers)

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

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

Create a new HttpEntity with the given body and headers.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

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.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

bodyback to summary
private final T body
Annotations
@Nullable
EMPTYback to summary
public static final HttpEntity<?> EMPTY

The empty HttpEntity, with no body or headers.

headersback to summary
private final HttpHeaders headers

Constructor Detail

HttpEntityback to summary
protected HttpEntity()

Create a new, empty HttpEntity.

HttpEntityback to summary
public HttpEntity(T body)

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

Parameters
body:T

the entity body

HttpEntityback to summary
public HttpEntity(MultiValueMap<String, String> headers)

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

Parameters
headers:MultiValueMap<String, String>

the entity headers

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

Create a new HttpEntity with the given body and headers.

Parameters
body:T

the entity body

headers:MultiValueMap<String, String>

the entity headers

Method Detail

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getBodyback to summary
public T getBody()

Returns the body of this entity.

Annotations
@Nullable
getHeadersback to summary
public HttpHeaders getHeaders()

Returns the headers of this entity.

hasBodyback to summary
public boolean hasBody()

Indicates whether this entity has a body.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override