Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	Http2HeadersEncoder.Configuration Configuration related elements for the `Http2HeadersEncoder` interface
public static interface	Http2HeadersEncoder.SensitivityDetector Determine if a header name/value pair is treated as sensitive.

Field Summary

Modifier and Type	Field and Description
public static final Http2HeadersEncoder.SensitivityDetector	ALWAYS_SENSITIVE Always return `true` for `SensitivityDetector#isSensitive(CharSequence, CharSequence)`.
public static final Http2HeadersEncoder.SensitivityDetector	NEVER_SENSITIVE Always return `false` for `SensitivityDetector#isSensitive(CharSequence, CharSequence)`.

Method Summary

Modifier and Type	Method and Description
public Http2HeadersEncoder.Configuration	configuration() Get the `Configuration` for this `Http2HeadersEncoder`
public void	encodeHeaders(int the identifier of the stream for which the headers are encoded. streamId, Http2Headers the headers to be encoded. headers, ByteBuf the buffer to receive the encoded headers. buffer) Encodes the given headers and writes the output headers block to the given output buffer.

Field Detail

ALWAYS_SENSITIVE	back to summary
public static final Http2HeadersEncoder.SensitivityDetector ALWAYS_SENSITIVE Always return `true` for `SensitivityDetector#isSensitive(CharSequence, CharSequence)`.

NEVER_SENSITIVE	back to summary
public static final Http2HeadersEncoder.SensitivityDetector NEVER_SENSITIVE Always return `false` for `SensitivityDetector#isSensitive(CharSequence, CharSequence)`.

Method Detail

configuration	back to summary
public Http2HeadersEncoder.Configuration configuration() Get the `Configuration` for this `Http2HeadersEncoder`

encodeHeaders	back to summary
public void encodeHeaders(int streamId, Http2Headers headers, ByteBuf buffer) throws Http2Exception Encodes the given headers and writes the output headers block to the given output buffer. Parameters streamId:int the identifier of the stream for which the headers are encoded. headers:Http2Headers the headers to be encoded. buffer:ByteBuf the buffer to receive the encoded headers.

encodeHeaders

back to summary

public void encodeHeaders(int streamId, Http2Headers headers, ByteBuf buffer) throws Http2Exception

Encodes the given headers and writes the output headers block to the given output buffer.

Parameters

streamId:int: the identifier of the stream for which the headers are encoded.
headers:Http2Headers: the headers to be encoded.
buffer:ByteBuf: the buffer to receive the encoded headers.

io.netty.handler.codec.http2 back to summary

public Interface Http2HeadersEncoder.Configuration

Known Direct Implementers: io.netty.handler.codec.http2.DefaultHttp2HeadersEncoder

Configuration related elements for the Http2HeadersEncoder interface

Method Summary

Modifier and Type	Method and Description
public void	maxHeaderListSize(long max) Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.
public long	maxHeaderListSize() Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.
public void	maxHeaderTableSize(long max) Represents the value for SETTINGS_HEADER_TABLE_SIZE.
public long	maxHeaderTableSize() Represents the value for SETTINGS_HEADER_TABLE_SIZE.

Method Detail

maxHeaderListSize	back to summary
public void maxHeaderListSize(long max) throws Http2Exception Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE. This method should only be called by Netty (not users) as a result of a receiving a `SETTINGS` frame.

maxHeaderListSize	back to summary
public long maxHeaderListSize() Represents the value for SETTINGS_MAX_HEADER_LIST_SIZE.

maxHeaderTableSize	back to summary
public void maxHeaderTableSize(long max) throws Http2Exception Represents the value for SETTINGS_HEADER_TABLE_SIZE. This method should only be called by Netty (not users) as a result of a receiving a `SETTINGS` frame.

maxHeaderTableSize	back to summary
public long maxHeaderTableSize() Represents the value for SETTINGS_HEADER_TABLE_SIZE. The initial value returned by this method must be `Http2CodecUtil#DEFAULT_HEADER_TABLE_SIZE`.

io.netty.handler.codec.http2 back to summary

public Interface Http2HeadersEncoder.SensitivityDetector

Determine if a header name/value pair is treated as sensitive. If the object can be dynamically modified and shared across multiple connections it may need to be thread safe.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if a header `name`/`value` pair should be treated as sensitive. `false` otherwise. isSensitive(CharSequence The name for the header. name, CharSequence The value of the header. value) Determine if a header `name`/`value` pair should be treated as sensitive.

Method Detail

isSensitive back to summary

isSensitive	back to summary
public boolean isSensitive(CharSequence name, CharSequence value) Determine if a header `name`/`value` pair should be treated as sensitive. Parameters name:CharSequence The name for the header. value:CharSequence The value of the header. Returns:boolean `true` if a header `name`/`value` pair should be treated as sensitive. `false` otherwise.

public boolean isSensitive(CharSequence name, CharSequence value)

Determine if a header name/value pair should be treated as sensitive.

Parameters

name:CharSequence: The name for the header.
value:CharSequence: The value of the header.

Returns:boolean

true if a header name/value pair should be treated as sensitive. false otherwise.