Module io.helidon.http

Package io.helidon.http

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).
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.
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 io.helidon.http.ClientResponseHeaders

acceptPatches, expires, lastModified, location

Methods inherited from interface io.helidon.http.Headers

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface io.helidon.http.WritableHeaders

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

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

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.

Parameters:

name - name of 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