Package org.springframework.http
Interface ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>
- Type Parameters:
B
- the builder subclass
- All Known Subinterfaces:
ResponseEntity.BodyBuilder
- Enclosing class:
- ResponseEntity<T>
public static interface ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>
Defines a builder that adds headers to the response entity.- Since:
- 4.1
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description B
allow(HttpMethod... allowedMethods)
Set the set of allowedHTTP methods
, as specified by theAllow
header.<T> ResponseEntity<T>
build()
Build the response entity with no body.B
cacheControl(CacheControl cacheControl)
Set the caching directives for the resource, as specified by the HTTP 1.1Cache-Control
header.B
eTag(String etag)
Set the entity tag of the body, as specified by theETag
header.B
header(String headerName, String... headerValues)
Add the given, single header value under the given name.B
headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.B
lastModified(long lastModified)
Set the time the resource was last changed, as specified by theLast-Modified
header.B
location(URI location)
Set the location of a resource, as specified by theLocation
header.B
varyBy(String... requestHeaders)
Configure one or more request header names (e.g.
Method Detail
header
B header(String headerName, String... headerValues)
Add the given, single header value under the given name.- Parameters:
headerName
- the header nameheaderValues
- the header value(s)- Returns:
- this builder
- See Also:
HttpHeaders.add(String, String)
headers
B headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.- Parameters:
headers
- the existing HttpHeaders to copy from- Returns:
- this builder
- Since:
- 4.1.2
- See Also:
HttpHeaders.add(String, String)
allow
B allow(HttpMethod... allowedMethods)
Set the set of allowedHTTP methods
, as specified by theAllow
header.- Parameters:
allowedMethods
- the allowed methods- Returns:
- this builder
- See Also:
HttpHeaders.setAllow(Set)
eTag
B eTag(String etag)
Set the entity tag of the body, as specified by theETag
header.- Parameters:
etag
- the new entity tag- Returns:
- this builder
- See Also:
HttpHeaders.setETag(String)
lastModified
B lastModified(long lastModified)
Set the time the resource was last changed, as specified by theLast-Modified
header.The date should be specified as the number of milliseconds since January 1, 1970 GMT.
- Parameters:
lastModified
- the last modified date- Returns:
- this builder
- See Also:
HttpHeaders.setLastModified(long)
location
B location(URI location)
Set the location of a resource, as specified by theLocation
header.- Parameters:
location
- the location- Returns:
- this builder
- See Also:
HttpHeaders.setLocation(URI)
cacheControl
B cacheControl(CacheControl cacheControl)
Set the caching directives for the resource, as specified by the HTTP 1.1Cache-Control
header.A
CacheControl
instance can be built likeCacheControl.maxAge(3600).cachePublic().noTransform()
.- Parameters:
cacheControl
- a builder for cache-related HTTP response headers- Returns:
- this builder
- Since:
- 4.2
- See Also:
- RFC-7234 Section 5.2
varyBy
B varyBy(String... requestHeaders)
Configure one or more request header names (e.g. "Accept-Language") to add to the "Vary" response header to inform clients that the response is subject to content negotiation and variances based on the value of the given request headers. The configured request header names are added only if not already present in the response "Vary" header.- Parameters:
requestHeaders
- request header names- Since:
- 4.3
build
<T> ResponseEntity<T> build()
Build the response entity with no body.- Returns:
- the response entity
- See Also:
ResponseEntity.BodyBuilder.body(Object)