Package io.netty.handler.codec.http3

Interface Http3Headers

All Superinterfaces:

Headers<CharSequence,CharSequence,Http3Headers>, Iterable<Map.Entry<CharSequence,CharSequence>>

All Known Implementing Classes:

DefaultHttp3Headers

public interface Http3Headers
extends Headers<CharSequence,CharSequence,Http3Headers>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Http3Headers.PseudoHeaderName	HTTP/2 (and HTTP/3) pseudo-headers names.

Method Summary

Modifier and Type	Method	Description
@Nullable CharSequence	authority()	Gets the Http3Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
Http3Headers	authority(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.AUTHORITY header
boolean	contains(CharSequence name, CharSequence value, boolean caseInsensitive)	Returns true if a header with the name and value exists, false otherwise.
Iterator<Map.Entry<CharSequence,CharSequence>>	iterator()	Returns an iterator over all HTTP/3 headers.
@Nullable CharSequence	method()	Gets the Http3Headers.PseudoHeaderName.METHOD header or null if there is no such header
Http3Headers	method(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.METHOD header
@Nullable CharSequence	path()	Gets the Http3Headers.PseudoHeaderName.PATH header or null if there is no such header
Http3Headers	path(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.PATH header
default @Nullable CharSequence	protocol()	Gets the Http3Headers.PseudoHeaderName.PROTOCOL header or null if there is no such header
default Http3Headers	protocol(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.PROTOCOL header
@Nullable CharSequence	scheme()	Gets the Http3Headers.PseudoHeaderName.SCHEME header or null if there is no such header
Http3Headers	scheme(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.SCHEME header
@Nullable CharSequence	status()	Gets the Http3Headers.PseudoHeaderName.STATUS header or null if there is no such header
Http3Headers	status(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.STATUS header
Iterator<CharSequence>	valueIterator(CharSequence name)	Equivalent to Headers.getAll(Object) but no intermediate list is generated.

Methods inherited from interface io.netty.handler.codec.Headers

add, add, add, add, addBoolean, addByte, addChar, addDouble, addFloat, addInt, addLong, addObject, addObject, addObject, addShort, addTimeMillis, clear, contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsShort, containsTimeMillis, get, get, getAll, getAllAndRemove, getAndRemove, getAndRemove, getBoolean, getBoolean, getBooleanAndRemove, getBooleanAndRemove, getByte, getByte, getByteAndRemove, getByteAndRemove, getChar, getChar, getCharAndRemove, getCharAndRemove, getDouble, getDouble, getDoubleAndRemove, getDoubleAndRemove, getFloat, getFloat, getFloatAndRemove, getFloatAndRemove, getInt, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, isEmpty, names, remove, set, set, set, set, setAll, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setObject, setObject, setShort, setTimeMillis, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

iterator

Iterator<Map.Entry<CharSequence,CharSequence>> iterator()

Returns an iterator over all HTTP/3 headers. The iteration order is as follows: 1. All pseudo headers (order not specified). 2. All non-pseudo headers (in insertion order).

Specified by:

iterator in interface Headers<CharSequence,CharSequence,Http3Headers>

Specified by:

iterator in interface Iterable<Map.Entry<CharSequence,CharSequence>>

valueIterator

Iterator<CharSequence> valueIterator(CharSequence name)

Equivalent to Headers.getAll(Object) but no intermediate list is generated.

Parameters:

name - the name of the header to retrieve

Returns:

an Iterator of header values corresponding to name.

method

Http3Headers method(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.METHOD header

Parameters:

value - the value for the header.

Returns:

this instance itself.

scheme

Http3Headers scheme(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.SCHEME header

Parameters:

value - the value for the header.

Returns:

this instance itself.

authority

Http3Headers authority(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.AUTHORITY header

Parameters:

value - the value for the header.

Returns:

this instance itself.

path

Http3Headers path(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.PATH header

Parameters:

value - the value for the header.

Returns:

this instance itself.

status

Http3Headers status(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.STATUS header

Parameters:

value - the value for the header.

Returns:

this instance itself.

protocol

default Http3Headers protocol(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.PROTOCOL header

This pseudo-header is used for Extended CONNECT requests as defined in RFC 9220. Common values include "webtransport" and "websocket".

Parameters:

value - the value for the header.

Returns:

this instance itself.

See Also:

• RFC 9220: Bootstrapping WebSockets with HTTP/3

method

@Nullable
@Nullable CharSequence method()

Gets the Http3Headers.PseudoHeaderName.METHOD header or null if there is no such header

Returns:

the value of the header.

scheme

@Nullable
@Nullable CharSequence scheme()

Gets the Http3Headers.PseudoHeaderName.SCHEME header or null if there is no such header

Returns:

the value of the header.

authority

@Nullable
@Nullable CharSequence authority()

Gets the Http3Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header

Returns:

the value of the header.

path

@Nullable
@Nullable CharSequence path()

Gets the Http3Headers.PseudoHeaderName.PATH header or null if there is no such header

Returns:

the value of the header.

status

@Nullable
@Nullable CharSequence status()

Gets the Http3Headers.PseudoHeaderName.STATUS header or null if there is no such header

Returns:

the value of the header.

protocol

@Nullable
default @Nullable CharSequence protocol()

Gets the Http3Headers.PseudoHeaderName.PROTOCOL header or null if there is no such header

This pseudo-header is used for Extended CONNECT requests as defined in RFC 9220.

Returns:

the value of the header.

See Also:

• RFC 9220: Bootstrapping WebSockets with HTTP/3

contains

boolean contains(CharSequence name,
 CharSequence value,
 boolean caseInsensitive)

Returns true if a header with the name and value exists, false otherwise.

If caseInsensitive is true then a case insensitive compare is done on the value.

Parameters:

name - the name of the header to find

value - the value of the header to find

caseInsensitive - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

Returns:

true if its contained, false otherwise.