Package org.springframework.http

Class ResponseEntity<T>

  • Type Parameters:
    T - the body type
    public class ResponseEntity<T>
extends HttpEntity<T>
    Extension of HttpEntity that adds a HttpStatus status code. Used in RestTemplate as well @Controller methods.

    In RestTemplate, this class is returned by getForEntity() and exchange(): 

     ResponseEntity<String> entity = template.getForEntity("https://example.com", String.class);
 String body = entity.getBody();
 MediaType contentType = entity.getHeaders().getContentType();
 HttpStatus statusCode = entity.getStatusCode();

    Can also be used in Spring MVC, as the return value from a @Controller method: 

     @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   HttpHeaders responseHeaders = new HttpHeaders();
   responseHeaders.setLocation(location);
   responseHeaders.set("MyResponseHeader", "MyValue");
   return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED);
 }
    Or, by using a builder accessible via static methods: 
     @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   return ResponseEntity.created(location).header("MyResponseHeader", "MyValue").body("Hello World");
 }
    Since:
    3.0.2
    Author:
    Arjen Poutsma, Brian Clozel
    See Also:
    getStatusCode()