接口 ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>
- 类型参数:
B
- the builder subclass
- 所有已知子接口:
ResponseEntity.BodyBuilder
- 封闭类:
- ResponseEntity<T>
public static interface ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>
Defines a builder that adds headers to the response entity.- 从以下版本开始:
- 4.1
方法概要
所有方法 实例方法 抽象方法 修饰符和类型 方法 说明 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.
方法详细资料
header
B header(String headerName, String... headerValues)
Add the given, single header value under the given name.- 参数:
headerName
- the header nameheaderValues
- the header value(s)- 返回:
- this builder
- 另请参阅:
HttpHeaders.add(String, String)
headers
B headers(HttpHeaders headers)
Copy the given headers into the entity's headers map.- 参数:
headers
- the existing HttpHeaders to copy from- 返回:
- this builder
- 从以下版本开始:
- 4.1.2
- 另请参阅:
HttpHeaders.add(String, String)
allow
B allow(HttpMethod... allowedMethods)
Set the set of allowedHTTP methods
, as specified by theAllow
header.- 参数:
allowedMethods
- the allowed methods- 返回:
- this builder
- 另请参阅:
HttpHeaders.setAllow(Set)
eTag
B eTag(String etag)
Set the entity tag of the body, as specified by theETag
header.- 参数:
etag
- the new entity tag- 返回:
- this builder
- 另请参阅:
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.
- 参数:
lastModified
- the last modified date- 返回:
- this builder
- 另请参阅:
HttpHeaders.setLastModified(long)
location
B location(URI location)
Set the location of a resource, as specified by theLocation
header.- 参数:
location
- the location- 返回:
- this builder
- 另请参阅:
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()
.- 参数:
cacheControl
- a builder for cache-related HTTP response headers- 返回:
- this builder
- 从以下版本开始:
- 4.2
- 另请参阅:
- 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.- 参数:
requestHeaders
- request header names- 从以下版本开始:
- 4.3
build
<T> ResponseEntity<T> build()
Build the response entity with no body.- 返回:
- the response entity
- 另请参阅:
ResponseEntity.BodyBuilder.body(Object)