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

Author:

Arjen Poutsma, Brian Clozel, sebastien Deleuze

Method summary

Modifier and Type	Method	Description
B	allow(HttpMethod... allowedMethods)	set the set of allowed HTTP methods, as specified by the Allow header.
<T>&nbsp;ResponseEntity<T>	build()	Build the response entity with no body.
B	cacheControl(CacheControl&nbsp;cacheControl)	set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.
B	eTag(@Nullable string&nbsp;etag)	set the entity tag of the body, as specified by the ETag header.
B	header(string&nbsp;headerName, string...&nbsp;headerValues)	Add the given, single header value under the given name.
B	headers(Consumer<HttpHeaders>&nbsp;headersConsumer)	Manipulate this entity's headers with the given consumer.
B	headers(@Nullable HttpHeaders&nbsp;headers)	Copy the given headers into the entity's headers map.
B	lastModified(long&nbsp;lastModified)	set the time the resource was last changed, as specified by the Last-Modified header.
B	lastModified(Instant&nbsp;lastModified)	set the time the resource was last changed, as specified by the Last-Modified header.
B	lastModified(ZonedDateTime&nbsp;lastModified)	set the time the resource was last changed, as specified by the Last-Modified header.
B	location(URI&nbsp;location)	set the location of a resource, as specified by the Location header.
B	varyBy(string...&nbsp;requestHeaders)	Configure one or more request header names (for example, "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.

Method Details

header

B header(string headerName,
 string... headerValues)

Add the given, single header value under the given name.

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

see Also:

• HttpHeaders.add(string, string)

headers

B headers(@Nullable 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)

headers

B&nbsp;headers(Consumer<HttpHeaders>&nbsp;headersConsumer)

Manipulate this entity's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

since:

5.2

allow

B allow(HttpMethod... allowedMethods)

set the set of allowed HTTP methods, as specified by the Allow header.

Parameters:

allowedMethods - the allowed methods

Returns:

this builder

see Also:

• HttpHeaders.setAllow(set)

eTag

B eTag(@Nullable string etag)

set the entity tag of the body, as specified by the ETag header.

Parameters:

etag - the new entity tag

Returns:

this builder

see Also:

• HttpHeaders.setETag(string)

lastModified

B lastModified(ZonedDateTime lastModified)

set the time the resource was last changed, as specified by the Last-Modified header.

Parameters:

lastModified - the last modified date

Returns:

this builder

since:

5.1.4

see Also:

• HttpHeaders.setLastModified(ZonedDateTime)

lastModified

B lastModified(Instant lastModified)

set the time the resource was last changed, as specified by the Last-Modified header.

Parameters:

lastModified - the last modified date

Returns:

this builder

since:

5.1.4

see Also:

• HttpHeaders.setLastModified(Instant)

lastModified

B lastModified(long lastModified)

set the time the resource was last changed, as specified by the Last-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 the Location 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.1 Cache-Control header.

A CacheControl instance can be built like CacheControl.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 (for example, "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>&nbsp;ResponseEntity<T>&nbsp;build()

Build the response entity with no body.

Returns:

the response entity

see Also:

• ResponseEntity.BodyBuilder.body(Object)