Package io.micronaut.http

Interface MutableHttpHeaders

All Superinterfaces:

ConversionServiceAware, ConversionServiceProvider, ConvertibleMultiValues<String>, ConvertibleValues<List<String>>, Headers, HttpHeaders, Iterable<Map.Entry<String,List<String>>>, MutableHeaders, ValueResolver<CharSequence>

All Known Implementing Classes:

CaseInsensitiveMutableHttpHeaders, NettyHttpHeaders, SimpleHttpHeaders

public interface MutableHttpHeaders
extends MutableHeaders, HttpHeaders, ConversionServiceAware

Extends HttpHeaders add methods for mutation of headers.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final ZoneId	GMT	The default GMT zone for date values.

Fields inherited from interface io.micronaut.core.convert.value.ConvertibleValues

EMPTY

Fields inherited from interface io.micronaut.http.HttpHeaders

ACCEPT, ACCEPT_CH, ACCEPT_CH_LIFETIME, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_PATCH, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_ALLOW_PRIVATE_NETWORK, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK, AGE, ALLOW, AUTHORIZATION, AUTHORIZATION_INFO, CACHE_CONTROL, CONNECTION, CONTENT_BASE, CONTENT_DISPOSITION, CONTENT_DPR, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, CROSS_ORIGIN_RESOURCE_POLICY, DATE, DEVICE_MEMORY, DOWNLINK, DPR, ECT, ETAG, EXPECT, EXPIRES, FEATURE_POLICY, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, REFERRER_POLICY, RETRY_AFTER, RTT, SAVE_DATA, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_KEY1, SEC_WEBSOCKET_KEY2, SEC_WEBSOCKET_LOCATION, SEC_WEBSOCKET_ORIGIN, SEC_WEBSOCKET_PROTOCOL, SEC_WEBSOCKET_VERSION, SERVER, SET_COOKIE, SET_COOKIE2, SOURCE_MAP, STANDARD_HEADERS, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, VIEWPORT_WIDTH, WARNING, WEBSOCKET_LOCATION, WEBSOCKET_ORIGIN, WEBSOCKET_PROTOCOL, WIDTH, WWW_AUTHENTICATE, X_AUTH_TOKEN

Method Summary

Modifier and Type	Method	Description
MutableHttpHeaders	add(CharSequence header, CharSequence value)	Add a header for the given name and value.
default MutableHttpHeaders	add(CharSequence header, Integer value)	Add a header for the given name and value.
default MutableHttpHeaders	add(CharSequence header, ZonedDateTime value)	Add a header for the given name and value.
default MutableHttpHeaders	allow(HttpMethod... methods)	Set the allowed HTTP methods.
default MutableHttpHeaders	allow(Collection<HttpMethod> methods)	Set the allowed HTTP methods.
default MutableHttpHeaders	allowGeneric(Collection<? extends CharSequence> methods)	Set the allowed HTTP methods.
default MutableHttpHeaders	auth(String userInfo)	Used to configure BASIC authentication.
default MutableHttpHeaders	auth(String username, String password)	Used to configure BASIC authentication.
default MutableHttpHeaders	contentType(MediaType mediaType)	Sets the HttpHeaders.CONTENT_TYPE header to the given media type.
default MutableHttpHeaders	contentTypeIfMissing(MediaType mediaType)	Sets the HttpHeaders.CONTENT_TYPE header to the given media type, if the header is missing.
default MutableHttpHeaders	date(long timeInMillis)	Adds the DATE header for the given Long.
default MutableHttpHeaders	date(LocalDateTime date)	Adds the date header for the given LocalDateTime.
default MutableHttpHeaders	expires(long timeInMillis)	Adds the EXPIRES header for the given Long.
default MutableHttpHeaders	expires(LocalDateTime date)	Adds the EXPIRES header for the given LocalDateTime.
default MutableHttpHeaders	ifModifiedSince(long timeInMillis)	Adds the IF_MODIFIED_SINCE header for the given Long.
default MutableHttpHeaders	ifModifiedSince(LocalDateTime date)	Adds the IF_MODIFIED_SINCE header for the given ZonedDateTime.
default MutableHttpHeaders	lastModified(long timeInMillis)	Adds the LAST_MODIFIED header for the given Long.
default MutableHttpHeaders	lastModified(LocalDateTime date)	Adds the LAST_MODIFIED header for the given LocalDateTime.
default MutableHttpHeaders	location(URI uri)	Sets the location header to the given URI.
MutableHttpHeaders	remove(CharSequence header)	Removes a header.
default MutableHeaders	set(CharSequence header, CharSequence value)	Sets an HTTP header overriding any existing value.

Methods inherited from interface io.micronaut.core.convert.ConversionServiceAware

setConversionService

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleMultiValues

forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator

Methods inherited from interface io.micronaut.core.convert.value.ConvertibleValues

asMap, asMap, asProperties, contains, getConversionService, getValue, getValueType, names, subMap, subMap, subMap, values

Methods inherited from interface io.micronaut.http.HttpHeaders

accept, acceptCharset, acceptLanguage, contains, contentLength, contentType, findAcceptCharset, findAcceptLanguage, findDate, findFirst, findInt, getAuthorization, getContentType, getDate, getInt, getOrigin, isKeepAlive

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface io.micronaut.core.type.MutableHeaders

setIfMissing

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get, get

Field Details

GMT

static final ZoneId GMT

The default GMT zone for date values.

Method Details

add

MutableHttpHeaders add(CharSequence header,
 CharSequence value)

Add a header for the given name and value.

Specified by:

add in interface MutableHeaders

Parameters:

header - The header name

value - The value

Returns:

This headers object

remove

MutableHttpHeaders remove(CharSequence header)

Description copied from interface: MutableHeaders

Removes a header.

Specified by:

remove in interface MutableHeaders

Parameters:

header - The header to remove

Returns:

These headers

set

default MutableHeaders set(CharSequence header,
 CharSequence value)

Description copied from interface: MutableHeaders

Sets an HTTP header overriding any existing value.

Specified by:

set in interface MutableHeaders

Parameters:

header - The header

value - The value

Returns:

This headers

allow

default MutableHttpHeaders allow(HttpMethod... methods)

Set the allowed HTTP methods.

Parameters:

methods - The methods to specify in the Allowed HTTP header

Returns:

This HTTP headers

date

default MutableHttpHeaders date(LocalDateTime date)

Adds the date header for the given LocalDateTime.

Parameters:

date - The local date time (assumed to represent system's default time-zone ZoneId.systemDefault(), will be converted to GMT) as per DateTimeFormatter.RFC_1123_DATE_TIME

Returns:

The MutableHttpHeaders

See Also:

• to set date time with time-zone.

expires

default MutableHttpHeaders expires(LocalDateTime date)

Adds the EXPIRES header for the given LocalDateTime.

Parameters:

date - The local date time (assumed to represent system's default time-zone ZoneId.systemDefault(), will be converted to GMT) as per DateTimeFormatter.RFC_1123_DATE_TIME

Returns:

The MutableHttpHeaders

See Also:

• to set date time with time-zone.

lastModified

default MutableHttpHeaders lastModified(LocalDateTime date)

Adds the LAST_MODIFIED header for the given LocalDateTime.

Parameters:

date - The local date time (assumed to represent system's default time-zone ZoneId.systemDefault(), will be converted to GMT) as per DateTimeFormatter.RFC_1123_DATE_TIME

Returns:

The MutableHttpHeaders

See Also:

• to set date time with time-zone.

ifModifiedSince

default MutableHttpHeaders ifModifiedSince(LocalDateTime date)

Adds the IF_MODIFIED_SINCE header for the given ZonedDateTime.

Parameters:

date - The local date time (assumed to represent system's default time-zone ZoneId.systemDefault(), will be converted to GMT) as per DateTimeFormatter.RFC_1123_DATE_TIME

Returns:

The MutableHttpHeaders

See Also:

• to set date time with time-zone.

date

default MutableHttpHeaders date(long timeInMillis)

Adds the DATE header for the given Long.

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

expires

default MutableHttpHeaders expires(long timeInMillis)

Adds the EXPIRES header for the given Long.

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

lastModified

default MutableHttpHeaders lastModified(long timeInMillis)

Adds the LAST_MODIFIED header for the given Long.

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

ifModifiedSince

default MutableHttpHeaders ifModifiedSince(long timeInMillis)

Adds the IF_MODIFIED_SINCE header for the given Long.

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

auth

default MutableHttpHeaders auth(String username,
 String password)

Used to configure BASIC authentication.

Parameters:

username - The username

password - The password

Returns:

This HTTP headers

auth

default MutableHttpHeaders auth(String userInfo)

Used to configure BASIC authentication.

Parameters:

userInfo - The user info which is in the form "username:password"

Returns:

This HTTP headers

allow

default MutableHttpHeaders allow(Collection<HttpMethod> methods)

Set the allowed HTTP methods.

Parameters:

methods - The methods to specify in the Allowed HTTP header

Returns:

This HTTP headers

allowGeneric

default MutableHttpHeaders allowGeneric(Collection<? extends CharSequence> methods)

Set the allowed HTTP methods.

Parameters:

methods - The methods to specify in the Allowed HTTP header

Returns:

This HTTP headers

location

default MutableHttpHeaders location(URI uri)

Sets the location header to the given URI.

Parameters:

uri - The URI

Returns:

This HTTP headers

contentType

default MutableHttpHeaders contentType(MediaType mediaType)

Sets the HttpHeaders.CONTENT_TYPE header to the given media type.

Parameters:

mediaType - The media type

Returns:

This HTTP headers

contentTypeIfMissing

default MutableHttpHeaders contentTypeIfMissing(MediaType mediaType)

Sets the HttpHeaders.CONTENT_TYPE header to the given media type, if the header is missing.

Parameters:

mediaType - The media type

Returns:

This HTTP headers

add

default MutableHttpHeaders add(CharSequence header,
 ZonedDateTime value)

Add a header for the given name and value.

Parameters:

header - The header name

value - The value

Returns:

This headers object

add

default MutableHttpHeaders add(CharSequence header,
 Integer value)

Add a header for the given name and value.

Parameters:

header - The header name

value - The value

Returns:

This headers object