Package org.springframework.http
Class HttpEntity<T>
- java.lang.Object
- org.springframework.http.HttpEntity<T>
- Type Parameters:
T- the body type
- Direct Known Subclasses:
RequestEntity,ResponseEntity
public class HttpEntity<T> extends Object
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("https://example.com", entity);orHttpEntity<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:@RequestMapping("/handle") public HttpEntity<String> handle() { HttpHeaders responseHeaders = new HttpHeaders(); responseHeaders.set("MyResponseHeader", "MyValue"); return new HttpEntity<String>("Hello World", responseHeaders); }- Since:
- 3.0.2
- Author:
- Arjen Poutsma, Juergen Hoeller
- See Also:
RestTemplate,getBody(),getHeaders()
Field Summary
Fields Modifier and Type Field Description static HttpEntity<?>EMPTYThe emptyHttpEntity, with no body or headers.
Constructor Summary
Constructors Modifier Constructor Description protectedHttpEntity()Create a new, emptyHttpEntity.HttpEntity(MultiValueMap<String,String> headers)Create a newHttpEntitywith the given headers and no body.HttpEntity(T body)Create a newHttpEntitywith the given body and no headers.HttpEntity(T body, MultiValueMap<String,String> headers)Create a newHttpEntitywith the given body and headers.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object other)TgetBody()Returns the body of this entity.HttpHeadersgetHeaders()Returns the headers of this entity.booleanhasBody()Indicates whether this entity has a body.inthashCode()StringtoString()
Field Detail
EMPTY
public static final HttpEntity<?> EMPTY
The emptyHttpEntity, with no body or headers.
Constructor Detail
HttpEntity
protected HttpEntity()
Create a new, emptyHttpEntity.
HttpEntity
public HttpEntity(T body)
Create a newHttpEntitywith the given body and no headers.- Parameters:
body- the entity body
HttpEntity
public HttpEntity(MultiValueMap<String,String> headers)
Create a newHttpEntitywith the given headers and no body.- Parameters:
headers- the entity headers
HttpEntity
public HttpEntity(@Nullable T body, @Nullable MultiValueMap<String,String> headers)
Create a newHttpEntitywith the given body and headers.- Parameters:
body- the entity bodyheaders- the entity headers
Method Detail
getHeaders
public HttpHeaders getHeaders()
Returns the headers of this entity.
hasBody
public boolean hasBody()
Indicates whether this entity has a body.