Package io.netty.handler.codec.http2

Enum Http2Headers.PseudoHeaderName

java.lang.Object

java.lang.Enum<Http2Headers.PseudoHeaderName>

io.netty.handler.codec.http2.Http2Headers.PseudoHeaderName

All Implemented Interfaces:

Serializable, Comparable<Http2Headers.PseudoHeaderName>, java.lang.constant.Constable

Enclosing interface:

Http2Headers

public static enum Http2Headers.PseudoHeaderName
extends Enum<Http2Headers.PseudoHeaderName>

HTTP/2 pseudo-headers names.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHORITY	:authority.
METHOD	:method.
PATH	:path.
PROTOCOL	:protocol, as defined in RFC 8441, Bootstrapping WebSockets with HTTP/2.
SCHEME	:scheme.
STATUS	:status.

Field Summary

Fields

Modifier and Type	Field	Description
private static final char	PSEUDO_HEADER_PREFIX
private static final byte	PSEUDO_HEADER_PREFIX_BYTE
private final boolean	requestOnly
private final AsciiString	value

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PseudoHeaderName(String value, boolean requestOnly)

Method Summary

Modifier and Type	Method	Description
static Http2Headers.PseudoHeaderName	getPseudoHeader(AsciiString header)	Returns the Http2Headers.PseudoHeaderName corresponding to the specified header name.
static Http2Headers.PseudoHeaderName	getPseudoHeader(CharSequence header)	Returns the Http2Headers.PseudoHeaderName corresponding to the specified header name.
private static Http2Headers.PseudoHeaderName	getPseudoHeaderName(CharSequence header)
static boolean	hasPseudoHeaderFormat(CharSequence headerName)	Indicates whether the specified header follows the pseudo-header format (begins with ':' character)
static boolean	isPseudoHeader(AsciiString header)	Indicates whether the given header name is a valid HTTP/2 pseudo header.
static boolean	isPseudoHeader(CharSequence header)	Indicates whether the given header name is a valid HTTP/2 pseudo header.
static boolean	isPseudoHeader(String header)	Indicates whether the given header name is a valid HTTP/2 pseudo header.
boolean	isRequestOnly()	Indicates whether the pseudo-header is to be used in a request context.
AsciiString	value()
static Http2Headers.PseudoHeaderName	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Http2Headers.PseudoHeaderName[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

METHOD

public static final Http2Headers.PseudoHeaderName METHOD

:method.

SCHEME

public static final Http2Headers.PseudoHeaderName SCHEME

:scheme.

AUTHORITY

public static final Http2Headers.PseudoHeaderName AUTHORITY

:authority.

PATH

public static final Http2Headers.PseudoHeaderName PATH

:path.

STATUS

public static final Http2Headers.PseudoHeaderName STATUS

:status.

PROTOCOL

public static final Http2Headers.PseudoHeaderName PROTOCOL

:protocol, as defined in RFC 8441, Bootstrapping WebSockets with HTTP/2.

Field Details

PSEUDO_HEADER_PREFIX

private static final char PSEUDO_HEADER_PREFIX

See Also:

• Constant Field Values

PSEUDO_HEADER_PREFIX_BYTE

private static final byte PSEUDO_HEADER_PREFIX_BYTE

See Also:

• Constant Field Values

value

private final AsciiString value

requestOnly

private final boolean requestOnly

Constructor Details

PseudoHeaderName

private PseudoHeaderName(String value,
 boolean requestOnly)

Method Details

values

public static Http2Headers.PseudoHeaderName[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Http2Headers.PseudoHeaderName valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public AsciiString value()

hasPseudoHeaderFormat

public static boolean hasPseudoHeaderFormat(CharSequence headerName)

Indicates whether the specified header follows the pseudo-header format (begins with ':' character)

Returns:

true if the header follow the pseudo-header format

isPseudoHeader

public static boolean isPseudoHeader(CharSequence header)

Indicates whether the given header name is a valid HTTP/2 pseudo header.

isPseudoHeader

public static boolean isPseudoHeader(AsciiString header)

Indicates whether the given header name is a valid HTTP/2 pseudo header.

isPseudoHeader

public static boolean isPseudoHeader(String header)

Indicates whether the given header name is a valid HTTP/2 pseudo header.

getPseudoHeader

public static Http2Headers.PseudoHeaderName getPseudoHeader(CharSequence header)

Returns the Http2Headers.PseudoHeaderName corresponding to the specified header name.

Returns:

corresponding Http2Headers.PseudoHeaderName if any, null otherwise.

getPseudoHeaderName

private static Http2Headers.PseudoHeaderName getPseudoHeaderName(CharSequence header)

getPseudoHeader

public static Http2Headers.PseudoHeaderName getPseudoHeader(AsciiString header)

Returns the Http2Headers.PseudoHeaderName corresponding to the specified header name.

Returns:

corresponding Http2Headers.PseudoHeaderName if any, null otherwise.

isRequestOnly

public boolean isRequestOnly()

Indicates whether the pseudo-header is to be used in a request context.

Returns:

true if the pseudo-header is to be used in a request context