Module io.helidon.common.http

Package io.helidon.common.http

Interface HeadersServerResponse

All Superinterfaces:

Headers, HeadersClientResponse, HeadersWritable<HeadersServerResponse>, Iterable<Http.HeaderValue>

public interface HeadersServerResponse
extends HeadersClientResponse, HeadersWritable<HeadersServerResponse>

Mutable headers of a server response.

Method Summary

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

Methods inherited from interface io.helidon.common.http.Headers

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

Methods inherited from interface io.helidon.common.http.HeadersClientResponse

acceptPatches, expires, lastModified, location

Methods inherited from interface io.helidon.common.http.HeadersWritable

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

create

static HeadersServerResponse create()

Create a new instance of mutable server response headers.

Returns:

new server response headers

create

static HeadersServerResponse 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 HeadersServerResponse addAcceptPatches(HttpMediaType... acceptableMediaTypes)

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

Parameters:

acceptableMediaTypes - media types to add.

Returns:

this instance

addAcceptPatches

default HeadersServerResponse addAcceptPatches(MediaType... acceptableMediaTypes)

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

Parameters:

acceptableMediaTypes - media types to add.

Returns:

this instance

addCookie

HeadersServerResponse addCookie(SetCookie cookie)

Adds Set-Cookie header specified in RFC6265.

Parameters:

cookie - a cookie definition

Returns:

this instance

addCookie

default HeadersServerResponse 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 HeadersServerResponse 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

HeadersServerResponse 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 HeadersServerResponse lastModified(Instant modified)

Sets the value of Http.Header.LAST_MODIFIED header.

The last modified date for the requested object

Parameters:

modified - Last modified date/time.

Returns:

this instance

lastModified

default HeadersServerResponse lastModified(ZonedDateTime modified)

Sets the value of Http.Header.LAST_MODIFIED header.

The last modified date for the requested object

Parameters:

modified - Last modified date/time.

Returns:

this instance

location

default HeadersServerResponse location(URI location)

Sets the value of Http.Header.LOCATION header.

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

Parameters:

location - Location header value.

Returns:

updated headers

expires

default HeadersServerResponse expires(ZonedDateTime dateTime)

Sets the value of Http.Header.EXPIRES header.

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

Parameters:

dateTime - Expires date/time.

Returns:

updated headers

expires

default HeadersServerResponse expires(Instant dateTime)

Sets the value of Http.Header.EXPIRES header.

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

Parameters:

dateTime - Expires date/time.

Returns:

updated headers