Package io.micronaut.http.netty

Class NettyHttpHeaders

java.lang.Object

io.micronaut.http.netty.NettyHttpHeaders

All Implemented Interfaces:

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

@Internal
public class NettyHttpHeaders
extends Object
implements MutableHttpHeaders

Delegates to Netty's HttpHeaders.

Since:

1.0

Author:

Graeme Rocher

Field Summary

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

Fields inherited from interface io.micronaut.http.MutableHttpHeaders

GMT

Constructor Summary

Constructors

Constructor	Description
NettyHttpHeaders()	Default constructor.
NettyHttpHeaders(io.netty.handler.codec.http.HttpHeaders nettyHeaders, ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
List<MediaType>	accept()	A list of accepted MediaType instances.
MutableHttpHeaders	add(CharSequence header, CharSequence value)	Add a header for the given name and value.
MutableHttpHeaders	allowGeneric(Collection<? extends CharSequence> methods)	Set the allowed HTTP methods.
MutableHttpHeaders	auth(String userInfo)	Used to configure BASIC authentication.
final boolean	contains(CharSequence name)	Whether the given key is contained within these values.
final boolean	contains(String name)	Whether the given key is contained within these values.
OptionalLong	contentLength()	The request or response content type.
Optional<MediaType>	contentType()	The request or response content type.
MutableHttpHeaders	contentType(MediaType mediaType)	Sets the HttpHeaders.CONTENT_TYPE header to the given media type.
MutableHttpHeaders	contentTypeIfMissing(MediaType mediaType)	Sets the HttpHeaders.CONTENT_TYPE header to the given media type, if the header is missing.
MutableHttpHeaders	date(long timeInMillis)	Adds the DATE header for the given Long.
MutableHttpHeaders	date(LocalDateTime date)	Adds the date header for the given LocalDateTime.
MutableHttpHeaders	expires(long timeInMillis)	Adds the EXPIRES header for the given Long.
MutableHttpHeaders	expires(LocalDateTime date)	Adds the EXPIRES header for the given LocalDateTime.
Optional<Charset>	findAcceptCharset()	The Accept-Charset header, or empty if unset.
Optional<Locale>	findAcceptLanguage()	The Accept-Language header, or empty if unset.
Optional<String>	findFirst(CharSequence name)	Get the first value of the given header.
String	get(CharSequence name)	Get a value without applying any conversion.
<T> Optional<T>	get(CharSequence name, ArgumentConversionContext<T> conversionContext)	Resolve the given property for the given name.
List<String>	getAll(CharSequence name)	Get all the values for the given name without applying conversion.
ConversionService	getConversionService()	Provides the conversion service.
io.netty.handler.codec.http.HttpHeaders	getNettyHeaders()	Note: Caller must take care to validate headers inserted into this object!
Optional<String>	getOrigin()
MutableHttpHeaders	ifModifiedSince(long timeInMillis)	Adds the IF_MODIFIED_SINCE header for the given Long.
MutableHttpHeaders	ifModifiedSince(LocalDateTime date)	Adds the IF_MODIFIED_SINCE header for the given ZonedDateTime.
MutableHttpHeaders	lastModified(long timeInMillis)	Adds the LAST_MODIFIED header for the given Long.
MutableHttpHeaders	lastModified(LocalDateTime date)	Adds the LAST_MODIFIED header for the given LocalDateTime.
MutableHttpHeaders	location(URI uri)	Sets the location header to the given URI.
Set<String>	names()
MutableHttpHeaders	remove(CharSequence header)	Removes a header.
MutableHeaders	set(CharSequence header, CharSequence value)	Sets an HTTP header overriding any existing value.
void	setConversionService(ConversionService conversionService)	Sets the conversion service.
void	setUnsafe(CharSequence header, CharSequence value)	Like set(CharSequence, CharSequence) but without header validation.
static void	validateHeader(CharSequence name, CharSequence value)
Collection<List<String>>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

forEach, forEachValue, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator

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

asMap, asMap, asProperties, getValue, getValueType, subMap, subMap, subMap

Methods inherited from interface io.micronaut.http.HttpHeaders

acceptCharset, acceptLanguage, findDate, findInt, getAuthorization, getContentType, getDate, getInt, 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.http.MutableHttpHeaders

add, add, allow, allow, auth

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

get, get, get

Constructor Details

NettyHttpHeaders

public NettyHttpHeaders(io.netty.handler.codec.http.HttpHeaders nettyHeaders,
 ConversionService conversionService)

Parameters:

nettyHeaders - The Netty Http headers

conversionService - The conversion service

NettyHttpHeaders

public NettyHttpHeaders()

Default constructor.

Method Details

getNettyHeaders

public io.netty.handler.codec.http.HttpHeaders getNettyHeaders()

Note: Caller must take care to validate headers inserted into this object!

Returns:

The underlying Netty headers.

contains

public final boolean contains(String name)

Description copied from interface: ConvertibleValues

Whether the given key is contained within these values.

Specified by:

contains in interface ConvertibleValues<List<String>>

Parameters:

name - The key name

Returns:

True if it is

contains

public final boolean contains(CharSequence name)

Description copied from interface: HttpHeaders

Whether the given key is contained within these values.

Specified by:

contains in interface HttpHeaders

Parameters:

name - The key name

Returns:

True if it is

get

public <T> Optional<T> get(CharSequence name,
 ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<CharSequence>

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted

getAll

public List<String> getAll(CharSequence name)

Description copied from interface: ConvertibleMultiValues

Get all the values for the given name without applying conversion.

Specified by:

getAll in interface ConvertibleMultiValues<String>

Parameters:

name - The header name

Returns:

All the values

names

public Set<String> names()

Specified by:

names in interface ConvertibleValues<List<String>>

Returns:

The names of the values

values

public Collection<List<String>> values()

Specified by:

values in interface ConvertibleValues<List<String>>

Returns:

The values

get

public String get(CharSequence name)

Description copied from interface: ConvertibleMultiValues

Get a value without applying any conversion.

Specified by:

get in interface ConvertibleMultiValues<String>

Parameters:

name - The name of the value

Returns:

The raw value or null

See Also:

• ConvertibleMultiValues.getFirst(CharSequence)

findFirst

public Optional<String> findFirst(CharSequence name)

Description copied from interface: HttpHeaders

Get the first value of the given header.

Specified by:

findFirst in interface HttpHeaders

Parameters:

name - The header name

Returns:

The first value or null if it is present

add

public MutableHttpHeaders add(CharSequence header,
 CharSequence value)

Description copied from interface: MutableHttpHeaders

Add a header for the given name and value.

Specified by:

add in interface MutableHeaders

Specified by:

add in interface MutableHttpHeaders

Parameters:

header - The header name

value - The value

Returns:

This headers object

set

public 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

Specified by:

set in interface MutableHttpHeaders

Parameters:

header - The header

value - The value

Returns:

This headers

setUnsafe

public void setUnsafe(CharSequence header,
 CharSequence value)

Like set(CharSequence, CharSequence) but without header validation.

Parameters:

header - The header name

value - The header value

validateHeader

public static void validateHeader(CharSequence name,
 CharSequence value)

remove

public MutableHttpHeaders remove(CharSequence header)

Description copied from interface: MutableHeaders

Removes a header.

Specified by:

remove in interface MutableHeaders

Specified by:

remove in interface MutableHttpHeaders

Parameters:

header - The header to remove

Returns:

These headers

date

public MutableHttpHeaders date(LocalDateTime date)

Description copied from interface: MutableHttpHeaders

Adds the date header for the given LocalDateTime.

Specified by:

date in interface MutableHttpHeaders

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

public MutableHttpHeaders expires(LocalDateTime date)

Description copied from interface: MutableHttpHeaders

Adds the EXPIRES header for the given LocalDateTime.

Specified by:

expires in interface MutableHttpHeaders

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

public MutableHttpHeaders lastModified(LocalDateTime date)

Description copied from interface: MutableHttpHeaders

Adds the LAST_MODIFIED header for the given LocalDateTime.

Specified by:

lastModified in interface MutableHttpHeaders

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

public MutableHttpHeaders ifModifiedSince(LocalDateTime date)

Description copied from interface: MutableHttpHeaders

Adds the IF_MODIFIED_SINCE header for the given ZonedDateTime.

Specified by:

ifModifiedSince in interface MutableHttpHeaders

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

public MutableHttpHeaders date(long timeInMillis)

Description copied from interface: MutableHttpHeaders

Adds the DATE header for the given Long.

Specified by:

date in interface MutableHttpHeaders

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

expires

public MutableHttpHeaders expires(long timeInMillis)

Description copied from interface: MutableHttpHeaders

Adds the EXPIRES header for the given Long.

Specified by:

expires in interface MutableHttpHeaders

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

lastModified

public MutableHttpHeaders lastModified(long timeInMillis)

Description copied from interface: MutableHttpHeaders

Adds the LAST_MODIFIED header for the given Long.

Specified by:

lastModified in interface MutableHttpHeaders

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

ifModifiedSince

public MutableHttpHeaders ifModifiedSince(long timeInMillis)

Description copied from interface: MutableHttpHeaders

Adds the IF_MODIFIED_SINCE header for the given Long.

Specified by:

ifModifiedSince in interface MutableHttpHeaders

Parameters:

timeInMillis - The time in milliseconds since Epoch.

Returns:

The MutableHttpHeaders

auth

public MutableHttpHeaders auth(String userInfo)

Description copied from interface: MutableHttpHeaders

Used to configure BASIC authentication.

Specified by:

auth in interface MutableHttpHeaders

Parameters:

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

Returns:

This HTTP headers

allowGeneric

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

Description copied from interface: MutableHttpHeaders

Set the allowed HTTP methods.

Specified by:

allowGeneric in interface MutableHttpHeaders

Parameters:

methods - The methods to specify in the Allowed HTTP header

Returns:

This HTTP headers

location

public MutableHttpHeaders location(URI uri)

Description copied from interface: MutableHttpHeaders

Sets the location header to the given URI.

Specified by:

location in interface MutableHttpHeaders

Parameters:

uri - The URI

Returns:

This HTTP headers

contentType

public MutableHttpHeaders contentType(MediaType mediaType)

Description copied from interface: MutableHttpHeaders

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

Specified by:

contentType in interface MutableHttpHeaders

Parameters:

mediaType - The media type

Returns:

This HTTP headers

contentTypeIfMissing

public MutableHttpHeaders contentTypeIfMissing(MediaType mediaType)

Description copied from interface: MutableHttpHeaders

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

Specified by:

contentTypeIfMissing in interface MutableHttpHeaders

Parameters:

mediaType - The media type

Returns:

This HTTP headers

getConversionService

public ConversionService getConversionService()

Description copied from interface: ConversionServiceProvider

Provides the conversion service.

Specified by:

getConversionService in interface ConversionServiceProvider

Specified by:

getConversionService in interface ConvertibleValues<List<String>>

Returns:

the conversion service

setConversionService

public void setConversionService(ConversionService conversionService)

Description copied from interface: ConversionServiceAware

Sets the conversion service.

Specified by:

setConversionService in interface ConversionServiceAware

Parameters:

conversionService - The conversion service

contentType

public Optional<MediaType> contentType()

Description copied from interface: HttpHeaders

The request or response content type.

Specified by:

contentType in interface HttpHeaders

Returns:

The content type

contentLength

public OptionalLong contentLength()

Description copied from interface: HttpHeaders

The request or response content type.

Specified by:

contentLength in interface HttpHeaders

Returns:

The content type

accept

public List<MediaType> accept()

Description copied from interface: HttpHeaders

A list of accepted MediaType instances.

Specified by:

accept in interface HttpHeaders

Returns:

A list of zero or many MediaType instances

findAcceptCharset

public Optional<Charset> findAcceptCharset()

Description copied from interface: HttpHeaders

The Accept-Charset header, or empty if unset.

Specified by:

findAcceptCharset in interface HttpHeaders

Returns:

The Accept-Charset header

findAcceptLanguage

public Optional<Locale> findAcceptLanguage()

Description copied from interface: HttpHeaders

The Accept-Language header, or empty if unset.

Specified by:

findAcceptLanguage in interface HttpHeaders

Returns:

The Accept-Language header

getOrigin

public Optional<String> getOrigin()

Specified by:

getOrigin in interface HttpHeaders

Returns:

The HttpHeaders.ORIGIN header