org.springframework.web.servlet.function

Class DefaultEntityResponseBuilder<T>

java.lang.Object

org.springframework.web.servlet.function.DefaultEntityResponseBuilder<T>

Type Parameters:

T - the entity type

All Implemented Interfaces:

EntityResponse.Builder<T>

final class DefaultEntityResponseBuilder<T>
extends java.lang.Object
implements EntityResponse.Builder<T>

Default EntityResponse.Builder implementation.

Since:

5.2

Author:

Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultEntityResponseBuilder.CompletionStageEntityResponse<T> EntityResponse implementation for asynchronous CompletionStage bodies.
private static class	DefaultEntityResponseBuilder.DefaultEntityResponse<T> Default EntityResponse implementation for synchronous bodies.
private static class	DefaultEntityResponseBuilder.PublisherEntityResponse<T>

Field Summary

Fields

Modifier and Type	Field and Description
private MultiValueMap<java.lang.String,Cookie>	cookies
private T	entity
private java.lang.reflect.Type	entityType
private HttpHeaders	headers
private static boolean	reactiveStreamsPresent
private int	status

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DefaultEntityResponseBuilder(T entity, java.lang.reflect.Type entityType)

Method Summary

Modifier and Type	Method and Description
EntityResponse.Builder<T>	allow(HttpMethod... allowedMethods) Set the set of allowed HTTP methods, as specified by the Allow header.
EntityResponse.Builder<T>	allow(java.util.Set<HttpMethod> allowedMethods) Set the set of allowed HTTP methods, as specified by the Allow header.
EntityResponse<T>	build() Build the response.
EntityResponse.Builder<T>	cacheControl(CacheControl cacheControl) Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.
EntityResponse.Builder<T>	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
EntityResponse.Builder<T>	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
EntityResponse.Builder<T>	cookie(Cookie cookie) Add the given cookie to the response.
EntityResponse.Builder<T>	cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,Cookie>> cookiesConsumer) Manipulate this response's cookies with the given consumer.
EntityResponse.Builder<T>	eTag(java.lang.String etag) Set the entity tag of the body, as specified by the ETag header.
static <T> EntityResponse.Builder<T>	fromObject(T t) Return a new EntityResponse.Builder from the given object.
static <T> EntityResponse.Builder<T>	fromObject(T t, ParameterizedTypeReference<?> bodyType) Return a new EntityResponse.Builder from the given object and type reference.
EntityResponse.Builder<T>	header(java.lang.String headerName, java.lang.String... headerValues) Add the given header value(s) under the given name.
EntityResponse.Builder<T>	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate this response's headers with the given consumer.
EntityResponse.Builder<T>	lastModified(java.time.Instant lastModified) Set the time the resource was last changed, as specified by the Last-Modified header.
EntityResponse.Builder<T>	lastModified(java.time.ZonedDateTime lastModified) Set the time the resource was last changed, as specified by the Last-Modified header.
EntityResponse.Builder<T>	location(java.net.URI location) Set the location of a resource, as specified by the Location header.
EntityResponse.Builder<T>	status(HttpStatus status) Set the HTTP status.
EntityResponse.Builder<T>	status(int status) Set the HTTP status.
EntityResponse.Builder<T>	varyBy(java.lang.String... requestHeaders) Configure one or more request header names (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reactiveStreamsPresent

private static final boolean reactiveStreamsPresent

entity

private final T entity

entityType

private final java.lang.reflect.Type entityType

status

private int status

headers

private final HttpHeaders headers

cookies

private final MultiValueMap<java.lang.String,Cookie> cookies

Constructor Detail

DefaultEntityResponseBuilder

private DefaultEntityResponseBuilder(T entity,
                                     @Nullable
                                     java.lang.reflect.Type entityType)

Method Detail

status

public EntityResponse.Builder<T> status(HttpStatus status)

Description copied from interface: EntityResponse.Builder

Set the HTTP status.

Specified by:

status in interface EntityResponse.Builder<T>

Parameters:

status - the response status

Returns:

this builder

status

public EntityResponse.Builder<T> status(int status)

Description copied from interface: EntityResponse.Builder

Set the HTTP status.

Specified by:

status in interface EntityResponse.Builder<T>

Parameters:

status - the response status

Returns:

this builder

cookie

public EntityResponse.Builder<T> cookie(Cookie cookie)

Description copied from interface: EntityResponse.Builder

Add the given cookie to the response.

Specified by:

cookie in interface EntityResponse.Builder<T>

Parameters:

cookie - the cookie to add

Returns:

this builder

cookies

public EntityResponse.Builder<T> cookies(java.util.function.Consumer<MultiValueMap<java.lang.String,Cookie>> cookiesConsumer)

Description copied from interface: EntityResponse.Builder

Manipulate this response's cookies with the given consumer. The cookies provided to the consumer are "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

Specified by:

cookies in interface EntityResponse.Builder<T>

Parameters:

cookiesConsumer - a function that consumes the cookies

Returns:

this builder

header

public EntityResponse.Builder<T> header(java.lang.String headerName,
                                        java.lang.String... headerValues)

Description copied from interface: EntityResponse.Builder

Add the given header value(s) under the given name.

Specified by:

header in interface EntityResponse.Builder<T>

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

headers

public EntityResponse.Builder<T> headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Description copied from interface: EntityResponse.Builder

Manipulate this response'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.

Specified by:

headers in interface EntityResponse.Builder<T>

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

allow

public EntityResponse.Builder<T> allow(HttpMethod... allowedMethods)

Description copied from interface: EntityResponse.Builder

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

Specified by:

allow in interface EntityResponse.Builder<T>

Parameters:

allowedMethods - the allowed methods

Returns:

this builder

See Also:

HttpHeaders.setAllow(Set)

allow

public EntityResponse.Builder<T> allow(java.util.Set<HttpMethod> allowedMethods)

Description copied from interface: EntityResponse.Builder

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

Specified by:

allow in interface EntityResponse.Builder<T>

Parameters:

allowedMethods - the allowed methods

Returns:

this builder

See Also:

HttpHeaders.setAllow(Set)

contentLength

public EntityResponse.Builder<T> contentLength(long contentLength)

Description copied from interface: EntityResponse.Builder

Set the length of the body in bytes, as specified by the Content-Length header.

Specified by:

contentLength in interface EntityResponse.Builder<T>

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

public EntityResponse.Builder<T> contentType(MediaType contentType)

Description copied from interface: EntityResponse.Builder

Set the media type of the body, as specified by the Content-Type header.

Specified by:

contentType in interface EntityResponse.Builder<T>

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

eTag

public EntityResponse.Builder<T> eTag(java.lang.String etag)

Description copied from interface: EntityResponse.Builder

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

Specified by:

eTag in interface EntityResponse.Builder<T>

Parameters:

etag - the new entity tag

Returns:

this builder

See Also:

HttpHeaders.setETag(String)

lastModified

public EntityResponse.Builder<T> lastModified(java.time.ZonedDateTime lastModified)

Description copied from interface: EntityResponse.Builder

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.

Specified by:

lastModified in interface EntityResponse.Builder<T>

Parameters:

lastModified - the last modified date

Returns:

this builder

See Also:

HttpHeaders.setLastModified(long)

lastModified

public EntityResponse.Builder<T> lastModified(java.time.Instant lastModified)

Description copied from interface: EntityResponse.Builder

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.

Specified by:

lastModified in interface EntityResponse.Builder<T>

Parameters:

lastModified - the last modified date

Returns:

this builder

See Also:

HttpHeaders.setLastModified(long)

location

public EntityResponse.Builder<T> location(java.net.URI location)

Description copied from interface: EntityResponse.Builder

Set the location of a resource, as specified by the Location header.

Specified by:

location in interface EntityResponse.Builder<T>

Parameters:

location - the location

Returns:

this builder

See Also:

HttpHeaders.setLocation(URI)

cacheControl

public EntityResponse.Builder<T> cacheControl(CacheControl cacheControl)

Description copied from interface: EntityResponse.Builder

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().

Specified by:

cacheControl in interface EntityResponse.Builder<T>

Parameters:

cacheControl - a builder for cache-related HTTP response headers

Returns:

this builder

See Also:

RFC-7234 Section 5.2

varyBy

public EntityResponse.Builder<T> varyBy(java.lang.String... requestHeaders)

Description copied from interface: EntityResponse.Builder

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.

Specified by:

varyBy in interface EntityResponse.Builder<T>

Parameters:

requestHeaders - request header names

Returns:

this builder

build

public EntityResponse<T> build()

Description copied from interface: EntityResponse.Builder

Build the response.

Specified by:

build in interface EntityResponse.Builder<T>

Returns:

the built response

fromObject

public static <T> EntityResponse.Builder<T> fromObject(T t)

Return a new EntityResponse.Builder from the given object.

fromObject

public static <T> EntityResponse.Builder<T> fromObject(T t,
                                                       ParameterizedTypeReference<?> bodyType)

Return a new EntityResponse.Builder from the given object and type reference.