Interface ServerResponseHeaders

All Superinterfaces:

ClientResponseHeaders, Headers, Iterable<Header>, WritableHeaders<ServerResponseHeaders>

public interface ServerResponseHeaders
extends ClientResponseHeaders, WritableHeaders<ServerResponseHeaders>

Mutable headers of a server response.

Method Summary

Modifier and Type	Method	Description
default ServerResponseHeaders	addAcceptPatches(MediaType... acceptableMediaTypes)	Adds one or more acceptedTypes path document formats (header HeaderNames.ACCEPT_PATCH).
default ServerResponseHeaders	addAcceptQueries(MediaType... acceptableMediaTypes)	Adds one or more media types supported by this resource for Method.QUERY request content (header HeaderNames.ACCEPT_QUERY).
ServerResponseHeaders	addCookie(SetCookie cookie)	Adds Set-Cookie header specified in RFC6265.
default ServerResponseHeaders	addCookie(String name, String value)	Adds Set-Cookie header based on RFC2616.
default ServerResponseHeaders	addCookie(String name, String value, Duration maxAge)	Adds Set-Cookie header based on RFC6265 with Max-Age parameter.
default ServerResponseHeaders	clearCookie(SetCookie setCookie)	Clears a cookie by adding a Set-Cookie header with an expiration date in the past.
ServerResponseHeaders	clearCookie(String name)	Clears a cookie by adding a Set-Cookie header with an expiration date in the past.
static ServerResponseHeaders	create()	Create a new instance of mutable server response headers.
static ServerResponseHeaders	create(Headers existing)	Create a new instance of mutable server response headers.
default ServerResponseHeaders	expires(Instant dateTime)	Sets the value of HeaderNames.EXPIRES header.
default ServerResponseHeaders	expires(ZonedDateTime dateTime)	Sets the value of HeaderNames.EXPIRES header.
default ServerResponseHeaders	lastModified(Instant modified)	Sets the value of HeaderNames.LAST_MODIFIED header.
default ServerResponseHeaders	lastModified(ZonedDateTime modified)	Sets the value of HeaderNames.LAST_MODIFIED header.
default ServerResponseHeaders	location(URI location)	Sets the value of HeaderNames.LOCATION header.

Methods inherited from interface ClientResponseHeaders

acceptPatches, acceptQueries, expires, lastModified, location

Modifier and Type	Method	Description
default List<HttpMediaType>	acceptPatches()	Accepted patches.
default List<HttpMediaType>	acceptQueries()	Media types supported by the resource for Method.QUERY request content.
default Optional<ZonedDateTime>	expires()	Optionally gets the value of HeaderNames.EXPIRES header.
default Optional<ZonedDateTime>	lastModified()	Optionally gets the value of HeaderNames.LAST_MODIFIED header.
default Optional<URI>	location()	Optionally gets the value of HeaderNames.LOCATION header.

Methods inherited from interface Headers

acceptedTypes, all, contains, contains, containsToken, contentLength, contentType, find, first, get, isAccepted, size, stream, toMap, value, values

Modifier and Type	Method	Description
List<HttpMediaType>	acceptedTypes()	Returns a list of acceptedTypes (HeaderNames.ACCEPT header) content discoveryTypes in quality factor order.
List<String>	all(HeaderName name, Supplier<List<String>> defaultSupplier)	Get all values of a header.
boolean	contains(Header value)	Whether these headers contain a header with the provided name and value.
boolean	contains(HeaderName name)	Whether these headers contain a header with the provided name.
default boolean	containsToken(Header value)	Whether these headers contain all tokenized values from the provided header.
default OptionalLong	contentLength()	Content length if defined.
default Optional<HttpMediaType>	contentType()	Content type (if defined).
default Optional<Header>	find(HeaderName headerName)	Find the first header.
default Optional<String>	first(HeaderName headerName)	Returns a first header value.
Header	get(HeaderName name)	Get a header value.
default boolean	isAccepted(MediaType... mediaTypes)	Whether this media type is accepted by these headers.
int	size()	Number of headers in these headers.
default Stream<Header>	stream()	A sequential stream with these headers as the source.
default Map<String, List<String>>	toMap()	Deprecated. use other methods to handle headers, preferably using pull approach
default Optional<String>	value(HeaderName headerName)	Returns a header value as a single String potentially concatenated using comma character from Headers.all(HeaderName, java.util.function.Supplier) header fields.
default List<String>	values(HeaderName headerName)	Returns an unmodifiable List of all comma separated header value parts - Such segmentation is NOT valid for all header semantics, however it is very common.

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface WritableHeaders

add, add, add, add, clear, contentLength, contentType, from, remove, remove, set, set, set, set, set, setIfAbsent

Modifier and Type	Method	Description
ServerResponseHeaders	add(Header header)	Add a header or add a header value if the header is already present.
default ServerResponseHeaders	add(HeaderName header, int value)	Add a header or add a header value if the header is already present.
default ServerResponseHeaders	add(HeaderName header, long value)	Add a header or add a header value if the header is already present.
default ServerResponseHeaders	add(HeaderName header, String... value)	Add a header or add a header value if the header is already present.
ServerResponseHeaders	clear()	Clear all current headers.
default ServerResponseHeaders	contentLength(long length)	Content length of the entity in bytes.
default ServerResponseHeaders	contentType(MediaType contentType)	Sets the MIME type of the response body.
ServerResponseHeaders	from(Headers headers)	For each header from the provided headers, set its value on these headers.
ServerResponseHeaders	remove(HeaderName name)	Remove a header.
ServerResponseHeaders	remove(HeaderName name, Consumer<Header> removedConsumer)	Remove a header.
ServerResponseHeaders	set(Header header)	Set a header and replace it if it already existed.
default ServerResponseHeaders	set(HeaderName name, int value)	Set a header and replace it if it already existed.
default ServerResponseHeaders	set(HeaderName name, long value)	Set a header and replace it if it already existed.
default ServerResponseHeaders	set(HeaderName name, String... values)	Set a header and replace it if it already existed.
default ServerResponseHeaders	set(HeaderName name, Collection<String> values)	Set a header and replace it if it already existed.
ServerResponseHeaders	setIfAbsent(Header header)	Set a value of a header unless it is already present.

Method Details

create

static ServerResponseHeaders create()

Create a new instance of mutable server response headers.

Returns:

new server response headers

create

static ServerResponseHeaders create(Headers existing)

Create a new instance of mutable server response headers.

Parameters:

existing - headers to add to these response headers

Returns:

new server response headers

addAcceptPatches

default ServerResponseHeaders addAcceptPatches(MediaType... acceptableMediaTypes)

Adds one or more acceptedTypes path document formats (header HeaderNames.ACCEPT_PATCH).

Parameters:

acceptableMediaTypes - media types to add.

Returns:

this instance

addAcceptQueries

default ServerResponseHeaders addAcceptQueries(MediaType... acceptableMediaTypes)

Adds one or more media types supported by this resource for Method.QUERY request content (header HeaderNames.ACCEPT_QUERY). HttpMediaType may be used to add media type parameters.

Parameters:

acceptableMediaTypes - media types to add

Returns:

this instance

addCookie

ServerResponseHeaders addCookie(SetCookie cookie)

Adds Set-Cookie header specified in RFC6265.

Parameters:

cookie - a cookie definition

Returns:

this instance

addCookie

default ServerResponseHeaders addCookie(String name,
 String value,
 Duration maxAge)

Adds Set-Cookie header based on RFC6265 with Max-Age parameter.

Parameters:

name - name of the cookie

value - value of the cookie

maxAge - Max-Age cookie parameter

Returns:

this instance

addCookie

default ServerResponseHeaders addCookie(String name,
 String value)

Adds Set-Cookie header based on RFC2616.

Parameters:

name - name of the cookie

value - value of the cookie

Returns:

this instance

clearCookie

ServerResponseHeaders clearCookie(String name)

Clears a cookie by adding a Set-Cookie header with an expiration date in the past. It is recommended to use clearCookie(SetCookie) instead for better handling of Path and Domain.

Parameters:

name - name of the cookie.

Returns:

this instance

clearCookie

default ServerResponseHeaders clearCookie(SetCookie setCookie)

Clears a cookie by adding a Set-Cookie header with an expiration date in the past.

Parameters:

setCookie - the cookie.

Returns:

this instance

lastModified

default ServerResponseHeaders lastModified(Instant modified)

Sets the value of HeaderNames.LAST_MODIFIED header.

The last modified date for the requested object

Parameters:

modified - Last modified date/time.

Returns:

this instance

lastModified

default ServerResponseHeaders lastModified(ZonedDateTime modified)

Sets the value of HeaderNames.LAST_MODIFIED header.

The last modified date for the requested object

Parameters:

modified - Last modified date/time.

Returns:

this instance

location

default ServerResponseHeaders location(URI location)

Sets the value of HeaderNames.LOCATION header.

Used in redirection, or when a new resource has been created.

Parameters:

location - Location header value.

Returns:

updated headers

expires

default ServerResponseHeaders expires(ZonedDateTime dateTime)

Sets the value of HeaderNames.EXPIRES header.

The date/time after which the response is considered stale.

Parameters:

dateTime - Expires date/time.

Returns:

updated headers

expires

default ServerResponseHeaders expires(Instant dateTime)

Sets the value of HeaderNames.EXPIRES header.

The date/time after which the response is considered stale.

Parameters:

dateTime - Expires date/time.

Returns:

updated headers