io.micronaut.http.netty

Class NettyHttpHeaders

java.lang.Object

io.micronaut.http.netty.NettyHttpHeaders

All Implemented Interfaces:

ConvertibleMultiValues<java.lang.String>, ConvertibleValues<java.util.List<java.lang.String>>, Headers, MutableHeaders, ValueResolver<java.lang.CharSequence>, HttpHeaders, MutableHttpHeaders, java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>

@Internal
public class NettyHttpHeaders
extends java.lang.Object
implements MutableHttpHeaders

Delegates to Netty's HttpHeaders.

Since:

1.0

Author:

Graeme Rocher

Field Summary

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_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

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

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.
boolean	contains(java.lang.String name) Whether the given key is contained within these values.
java.lang.String	get(java.lang.CharSequence name) Get a value without applying any conversion.
<T> java.util.Optional<T>	get(java.lang.CharSequence name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name.
java.util.List<java.lang.String>	getAll(java.lang.CharSequence name) Get all the values for the given name without applying conversion.
io.netty.handler.codec.http.HttpHeaders	getNettyHeaders()
java.util.Set<java.lang.String>	names()
MutableHttpHeaders	remove(java.lang.CharSequence header) Removes a header.
MutableHeaders	set(java.lang.CharSequence header, java.lang.CharSequence value) Sets an HTTP header overriding any existing value.
java.util.Collection<java.util.List<java.lang.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.http.MutableHttpHeaders

add, add, allow, allow, allowGeneric, auth, auth, contentType, date, date, expires, expires, ifModifiedSince, ifModifiedSince, lastModified, lastModified, location

Methods inherited from interface io.micronaut.http.HttpHeaders

accept, contentLength, contentType, findDate, findFirst, findInt, getAuthorization, getContentType, getDate, getInt, getOrigin, isKeepAlive

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

empty, forEach, forEachValue, getFirst, getFirst, getFirst, getFirst, getFirst, isEmpty, iterator, of

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

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

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

get, get, get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

getNettyHeaders

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

Returns:

The underlying Netty headers.

contains

public final boolean contains(java.lang.String name)

Description copied from interface: ConvertibleValues

Whether the given key is contained within these values.

Specified by:

contains in interface ConvertibleValues<java.util.List<java.lang.String>>

Parameters:

name - The key name

Returns:

True if it is

get

public <T> java.util.Optional<T> get(java.lang.CharSequence name,
                                     ArgumentConversionContext<T> conversionContext)

Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<java.lang.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 java.util.List<java.lang.String> getAll(java.lang.CharSequence name)

Description copied from interface: ConvertibleMultiValues

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

Specified by:

getAll in interface ConvertibleMultiValues<java.lang.String>

Parameters:

name - The header name

Returns:

All the values

names

public java.util.Set<java.lang.String> names()

Specified by:

names in interface ConvertibleValues<java.util.List<java.lang.String>>

Returns:

The names of the values

values

public java.util.Collection<java.util.List<java.lang.String>> values()

Specified by:

values in interface ConvertibleValues<java.util.List<java.lang.String>>

Returns:

The values

get

public java.lang.String get(java.lang.CharSequence name)

Description copied from interface: ConvertibleMultiValues

Get a value without applying any conversion.

Specified by:

get in interface ConvertibleMultiValues<java.lang.String>

Parameters:

name - The name of the value

Returns:

The raw value or null

See Also:

ConvertibleMultiValues.getFirst(CharSequence)

add

public MutableHttpHeaders add(java.lang.CharSequence header,
                              java.lang.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(java.lang.CharSequence header,
                          java.lang.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

remove

public MutableHttpHeaders remove(java.lang.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