Modifier and Type	Class and Description
pack-priv static interface	HpackDecoder.HeaderEmitter Interface implemented by the intended recipient of the headers.

Field Summary

Modifier and Type	Field and Description
private volatile boolean	countedCookie
private int	currentMemorySize the current calculates memory size, as per the HPACK algorithm
private static final int	DEFAULT_RING_BUFFER_SIZE
private int	filledTableSlots The current table size by index (aka the number of index positions that are filled up)
private int	firstSlotPosition The current HEAD position of the header table.
private volatile int	headerCount
private HpackDecoder.HeaderEmitter	headerEmitter The object that receives the headers that are emitted from this decoder
private volatile int	headerSize
private Hpack.HeaderField[]	headerTable The header table
private static final Log	log
private int	maxHeaderCount
private int	maxHeaderSize
private int	maxMemorySizeHard The maximum allowed memory size set by the container.
private int	maxMemorySizeSoft The maximum memory size currently in use.
private static final StringManager	sm

Constructor Summary

Access	Constructor and Description
pack-priv	HpackDecoder(int maxMemorySize)
pack-priv	HpackDecoder()

Method Summary

Modifier and Type	Method and Description
private void	addEntryToHeaderTable(Hpack.HeaderField entry)
private void	addStaticTableEntry(int index)
pack-priv void	decode(ByteBuffer The buffer buffer) Decodes the provided frame data.
private void	emitHeader(String name, String value)
pack-priv int	getCurrentMemorySize()
pack-priv int	getFilledTableSlots()
pack-priv int	getFirstSlotPosition()
pack-priv HpackDecoder.HeaderEmitter	getHeaderEmitter()
pack-priv Hpack.HeaderField[]	getHeaderTable()
pack-priv int	getMaxMemorySizeSoft()
pack-priv int	Returns: the real index into the array getRealIndex(int The index from the hpack index) because we use a ring buffer type construct, and don't actually shuffle items in the array, we need to figure out the real index to use.
private void	handleIndex(int The index index) Handle an indexed header representation
private String	handleIndexedHeaderName(int index)
private boolean	handleMaxMemorySizeChange(ByteBuffer buffer, int originalPos)
pack-priv boolean	isHeaderCountExceeded()
pack-priv boolean	isHeaderSizeExceeded(int unreadSize)
pack-priv boolean	isHeaderSwallowSizeExceeded(int unreadSize)
private String	readHeaderName(ByteBuffer buffer, int prefixLength)
private String	readHpackString(ByteBuffer buffer)
private String	readHuffmanString(int length, ByteBuffer buffer)
private void	resizeIfRequired()
pack-priv void	setHeaderEmitter(HpackDecoder.HeaderEmitter headerEmitter)
pack-priv void	setMaxHeaderCount(int maxHeaderCount)
pack-priv void	setMaxHeaderSize(int maxHeaderSize)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

countedCookie	back to summary
private volatile boolean countedCookie

currentMemorySize	back to summary
private int currentMemorySize the current calculates memory size, as per the HPACK algorithm

DEFAULT_RING_BUFFER_SIZE	back to summary
private static final int DEFAULT_RING_BUFFER_SIZE

filledTableSlots	back to summary
private int filledTableSlots The current table size by index (aka the number of index positions that are filled up)

firstSlotPosition	back to summary
private int firstSlotPosition The current HEAD position of the header table. We use a ring buffer type construct as it would be silly to actually shuffle the items around in the array.

headerCount	back to summary
private volatile int headerCount

headerEmitter	back to summary
private HpackDecoder.HeaderEmitter headerEmitter The object that receives the headers that are emitted from this decoder

headerSize	back to summary
private volatile int headerSize

headerTable	back to summary
private Hpack.HeaderField[] headerTable The header table

log	back to summary
private static final Log log

maxHeaderCount	back to summary
private int maxHeaderCount

maxHeaderSize	back to summary
private int maxHeaderSize

maxMemorySizeHard	back to summary
private int maxMemorySizeHard The maximum allowed memory size set by the container.

maxMemorySizeSoft	back to summary
private int maxMemorySizeSoft The maximum memory size currently in use. May be less than the hard limit.

sm	back to summary
private static final StringManager sm

Constructor Detail

HpackDecoder	back to summary
pack-priv HpackDecoder(int maxMemorySize)

HpackDecoder	back to summary
pack-priv HpackDecoder()

Method Detail

addEntryToHeaderTable	back to summary
private void addEntryToHeaderTable(Hpack.HeaderField entry)

addStaticTableEntry	back to summary
private void addStaticTableEntry(int index) throws HpackException

decode	back to summary
pack-priv void decode(ByteBuffer buffer) throws HpackException Decodes the provided frame data. If this method leaves data in the buffer then this buffer should be compacted so this data is preserved, unless there is no more data in which case this should be considered a protocol error. Parameters buffer:ByteBuffer The buffer Exceptions HpackException: If the packed data is not valid

decode

back to summary

pack-priv void decode(ByteBuffer buffer) throws HpackException

Decodes the provided frame data. If this method leaves data in the buffer then this buffer should be compacted so this data is preserved, unless there is no more data in which case this should be considered a protocol error.

Parameters

buffer:ByteBuffer: The buffer

Exceptions

HpackException:: If the packed data is not valid

emitHeader	back to summary
private void emitHeader(String name, String value) throws HpackException

getCurrentMemorySize	back to summary
pack-priv int getCurrentMemorySize()

getFilledTableSlots	back to summary
pack-priv int getFilledTableSlots()

getFirstSlotPosition	back to summary
pack-priv int getFirstSlotPosition()

getHeaderEmitter	back to summary
pack-priv HpackDecoder.HeaderEmitter getHeaderEmitter()

getHeaderTable	back to summary
pack-priv Hpack.HeaderField[] getHeaderTable()

getMaxMemorySizeSoft	back to summary
pack-priv int getMaxMemorySizeSoft()

getRealIndex	back to summary
pack-priv int getRealIndex(int index) throws HpackException because we use a ring buffer type construct, and don't actually shuffle items in the array, we need to figure out the real index to use. package private for unit tests Parameters index:int The index from the hpack Returns:int the real index into the array

getRealIndex

back to summary

pack-priv int getRealIndex(int index) throws HpackException

because we use a ring buffer type construct, and don't actually shuffle items in the array, we need to figure out the real index to use.

package private for unit tests

Parameters

index:int: The index from the hpack

Returns:int

the real index into the array

handleIndex	back to summary
private void handleIndex(int index) throws HpackException Handle an indexed header representation Parameters index:int The index Exceptions HpackException: If an error occurs processing the given index

handleIndex

back to summary

private void handleIndex(int index) throws HpackException

Handle an indexed header representation

Parameters

index:int: The index

Exceptions

HpackException:: If an error occurs processing the given index

handleIndexedHeaderName	back to summary
private String handleIndexedHeaderName(int index) throws HpackException

handleMaxMemorySizeChange	back to summary
private boolean handleMaxMemorySizeChange(ByteBuffer buffer, int originalPos) throws HpackException

isHeaderCountExceeded	back to summary
pack-priv boolean isHeaderCountExceeded()

isHeaderSizeExceeded	back to summary
pack-priv boolean isHeaderSizeExceeded(int unreadSize)

isHeaderSwallowSizeExceeded	back to summary
pack-priv boolean isHeaderSwallowSizeExceeded(int unreadSize)

readHeaderName	back to summary
private String readHeaderName(ByteBuffer buffer, int prefixLength) throws HpackException

readHpackString	back to summary
private String readHpackString(ByteBuffer buffer) throws HpackException

readHuffmanString	back to summary
private String readHuffmanString(int length, ByteBuffer buffer) throws HpackException

resizeIfRequired	back to summary
private void resizeIfRequired()

setHeaderEmitter	back to summary
pack-priv void setHeaderEmitter(HpackDecoder.HeaderEmitter headerEmitter)

setMaxHeaderCount	back to summary
pack-priv void setMaxHeaderCount(int maxHeaderCount)

setMaxHeaderSize	back to summary
pack-priv void setMaxHeaderSize(int maxHeaderSize)

org.apache.coyote.http2 back to summary

pack-priv Interface HpackDecoder.HeaderEmitter

Known Direct Implementers: org.apache.coyote.http2.Stream, org.apache.coyote.http2.HeaderSink

Interface implemented by the intended recipient of the headers.

Method Summary

Modifier and Type	Method and Description
public void	emitHeader(String Header name name, String Header value value) Pass a single header to the recipient.
public void	setHeaderException(StreamException The exception to use when resetting the stream streamException) Inform the recipient of the headers that a stream error needs to be triggered using the given message when `validateHeaders()` is called.
public void	validateHeaders() Are the headers pass to the recipient so far valid?

Method Detail

emitHeader	back to summary
public void emitHeader(String name, String value) throws HpackException Pass a single header to the recipient. Parameters name:String Header name value:String Header value Exceptions HpackException: If a header is received that is not compliant with the HTTP/2 specification

emitHeader

back to summary

public void emitHeader(String name, String value) throws HpackException

Pass a single header to the recipient.

Parameters

name:String: Header name
value:String: Header value

Exceptions

HpackException:: If a header is received that is not compliant with the HTTP/2 specification

setHeaderException back to summary

setHeaderException	back to summary
public void setHeaderException(StreamException streamException) Inform the recipient of the headers that a stream error needs to be triggered using the given message when `validateHeaders()` is called. This is used when the Parser becomes aware of an error that is not visible to the recipient. Parameters streamException:StreamException The exception to use when resetting the stream

public void setHeaderException(StreamException streamException)

Inform the recipient of the headers that a stream error needs to be triggered using the given message when validateHeaders() is called. This is used when the Parser becomes aware of an error that is not visible to the recipient.

Parameters

streamException:StreamException: The exception to use when resetting the stream

validateHeaders	back to summary
public void validateHeaders() throws StreamException Are the headers pass to the recipient so far valid? The decoder needs to process all the headers to maintain state even if there is a problem. In addition, it is easy for the the intended recipient to track if the complete set of headers is valid since to do that state needs to be maintained between the parsing of the initial headers and the parsing of any trailer headers. The recipient is the best place to maintain that state. Exceptions StreamException: If the headers received to date are not valid

validateHeaders

back to summary

public void validateHeaders() throws StreamException

Are the headers pass to the recipient so far valid? The decoder needs to process all the headers to maintain state even if there is a problem. In addition, it is easy for the the intended recipient to track if the complete set of headers is valid since to do that state needs to be maintained between the parsing of the initial headers and the parsing of any trailer headers. The recipient is the best place to maintain that state.

Exceptions

StreamException:: If the headers received to date are not valid

public Class HpackDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface HpackDecoder.HeaderEmitter

Method Summary

Method Detail