public interface MutableHttpHeaders extends io.micronaut.core.type.MutableHeaders, HttpHeaders
HttpHeaders
add methods for mutation of headers.Modifier and Type | Field and Description |
---|---|
static java.time.ZoneId |
GMT
The default GMT zone for date values.
|
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_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, 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, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, VIEWPORT_WIDTH, WARNING, WEBSOCKET_LOCATION, WEBSOCKET_ORIGIN, WEBSOCKET_PROTOCOL, WIDTH, WWW_AUTHENTICATE, X_AUTH_TOKEN
Modifier and Type | Method and Description |
---|---|
MutableHttpHeaders |
add(java.lang.CharSequence header,
java.lang.CharSequence value)
Add a header for the given name and value.
|
default MutableHttpHeaders |
add(java.lang.CharSequence header,
java.lang.Integer value)
Add a header for the given name and value.
|
default MutableHttpHeaders |
add(java.lang.CharSequence header,
java.time.ZonedDateTime value)
Add a header for the given name and value.
|
default MutableHttpHeaders |
allow(java.util.Collection<HttpMethod> methods)
Set the allowed HTTP methods.
|
default MutableHttpHeaders |
allow(HttpMethod... methods)
Set the allowed HTTP methods.
|
default MutableHttpHeaders |
allowGeneric(java.util.Collection<? extends java.lang.CharSequence> methods)
Set the allowed HTTP methods.
|
default MutableHttpHeaders |
auth(java.lang.String userInfo)
Used to configure BASIC authentication.
|
default MutableHttpHeaders |
auth(java.lang.String username,
java.lang.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 |
date(java.time.LocalDateTime date)
Adds the date header for the given
LocalDateTime . |
default MutableHttpHeaders |
date(long timeInMillis)
Adds the DATE header for the given
Long . |
default MutableHttpHeaders |
expires(java.time.LocalDateTime date)
Adds the EXPIRES header for the given
LocalDateTime . |
default MutableHttpHeaders |
expires(long timeInMillis)
Adds the EXPIRES header for the given
Long . |
default MutableHttpHeaders |
ifModifiedSince(java.time.LocalDateTime date)
Adds the IF_MODIFIED_SINCE header for the given
ZonedDateTime . |
default MutableHttpHeaders |
ifModifiedSince(long timeInMillis)
Adds the IF_MODIFIED_SINCE header for the given
Long . |
default MutableHttpHeaders |
lastModified(java.time.LocalDateTime date)
Adds the LAST_MODIFIED header for the given
LocalDateTime . |
default MutableHttpHeaders |
lastModified(long timeInMillis)
Adds the LAST_MODIFIED header for the given
Long . |
default MutableHttpHeaders |
location(java.net.URI uri)
Sets the location header to the given URI.
|
MutableHttpHeaders |
remove(java.lang.CharSequence header) |
default io.micronaut.core.type.MutableHeaders |
set(java.lang.CharSequence header,
java.lang.CharSequence value) |
accept, contentLength, contentType, findDate, findFirst, findInt, getAuthorization, getContentType, getDate, getInt, getOrigin, isKeepAlive
empty, forEach, forEachValue, get, getAll, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator, of
MutableHttpHeaders add(java.lang.CharSequence header, java.lang.CharSequence value)
add
in interface io.micronaut.core.type.MutableHeaders
header
- The header namevalue
- The valueMutableHttpHeaders remove(java.lang.CharSequence header)
remove
in interface io.micronaut.core.type.MutableHeaders
default io.micronaut.core.type.MutableHeaders set(java.lang.CharSequence header, java.lang.CharSequence value)
set
in interface io.micronaut.core.type.MutableHeaders
default MutableHttpHeaders allow(HttpMethod... methods)
methods
- The methods to specify in the Allowed HTTP headerdefault MutableHttpHeaders date(java.time.LocalDateTime date)
LocalDateTime
.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
MutableHttpHeaders
to set date time with time-zone.
default MutableHttpHeaders expires(java.time.LocalDateTime date)
LocalDateTime
.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
MutableHttpHeaders
to set date time with time-zone.
default MutableHttpHeaders lastModified(java.time.LocalDateTime date)
LocalDateTime
.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
MutableHttpHeaders
to set date time with time-zone.
default MutableHttpHeaders ifModifiedSince(java.time.LocalDateTime date)
ZonedDateTime
.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
MutableHttpHeaders
to set date time with time-zone.
default MutableHttpHeaders date(long timeInMillis)
Long
.timeInMillis
- The time in milli seconds since Epoch.MutableHttpHeaders
default MutableHttpHeaders expires(long timeInMillis)
Long
.timeInMillis
- The time in milli seconds since Epoch.MutableHttpHeaders
default MutableHttpHeaders lastModified(long timeInMillis)
Long
.timeInMillis
- The time in milli seconds since Epoch.MutableHttpHeaders
default MutableHttpHeaders ifModifiedSince(long timeInMillis)
Long
.timeInMillis
- The time in milli seconds since Epoch.MutableHttpHeaders
default MutableHttpHeaders auth(java.lang.String username, java.lang.String password)
username
- The usernamepassword
- The passworddefault MutableHttpHeaders auth(java.lang.String userInfo)
userInfo
- The user info which is in the form "username:password"default MutableHttpHeaders allow(java.util.Collection<HttpMethod> methods)
methods
- The methods to specify in the Allowed HTTP headerdefault MutableHttpHeaders allowGeneric(java.util.Collection<? extends java.lang.CharSequence> methods)
methods
- The methods to specify in the Allowed HTTP headerdefault MutableHttpHeaders location(java.net.URI uri)
uri
- The URIdefault MutableHttpHeaders contentType(MediaType mediaType)
HttpHeaders.CONTENT_TYPE
header to the given media type.mediaType
- The media typedefault MutableHttpHeaders add(java.lang.CharSequence header, java.time.ZonedDateTime value)
header
- The header namevalue
- The valuedefault MutableHttpHeaders add(java.lang.CharSequence header, java.lang.Integer value)
header
- The header namevalue
- The value