Modifier and Type	Class and Description
private static class	Http11InputBuffer.HeaderParseData
private static enum	Http11InputBuffer.HeaderParsePosition
private static enum	Http11InputBuffer.HeaderParseStatus
private class	Http11InputBuffer.SocketInputBuffer This class is an input buffer which will read its data from an input stream.

Field Summary

Modifier and Type	Field and Description
private InputFilter[]	activeFilters Active filters (in order).
private ByteBuffer	byteBuffer The read buffer.
private byte	chr
private static final byte[]	CLIENT_PREFACE_START
private int	end Pos of the end of the header in the buffer, which is also the start of the body.
private InputFilter[]	filterLibrary Filter library.
private final int	headerBufferSize Maximum allowed size of the HTTP request line plus headers plus any leading blank lines.
private final Http11InputBuffer.HeaderParseData	headerData
private Http11InputBuffer.HeaderParsePosition	headerParsePos
private final MimeHeaders	headers Headers of the associated request.
private final HttpParser	httpParser
private InputBuffer	inputStreamInputBuffer Underlying input buffer.
private int	lastActiveFilter Index of the last active filter.
private static final Log	log
private volatile boolean	parsingHeader State.
private volatile boolean	parsingRequestLine
private boolean	parsingRequestLineEol
private int	parsingRequestLinePhase
private int	parsingRequestLineQPos
private int	parsingRequestLineStart
private byte	prevChr Parsing state - used for non blocking parsing so that when more data arrives, we can pick up where we left off.
private final boolean	rejectIllegalHeader
private final Request	request Associated Coyote request.
private static final StringManager	sm The string manager for this package.
private int	socketReadBufferSize Known size of the NioChannel read buffer.
private boolean	swallowInput Swallow input ?
private SocketWrapperBase<?>	wrapper Wrapper that provides access to the underlying socket.

Constructor Summary

Access	Constructor and Description
public	Http11InputBuffer(Request request, int headerBufferSize, boolean rejectIllegalHeader, HttpParser httpParser)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addActiveFilter(InputFilter filter) Add an input filter to the filter library.
pack-priv void	addFilter(InputFilter filter) Add an input filter to the filter library.
public int	available() Implements org.apache.coyote.InputBuffer.available. Obtain an estimate of the number of bytes that can be read without blocking.
pack-priv int	available(boolean read) Available bytes in the buffers for the current request.
public int	doRead(ApplicationBufferHandler ApplicationBufferHandler that provides the buffer to read data into. handler) Implements org.apache.coyote.InputBuffer.doRead. Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.
pack-priv void	endRequest() End request (consumes leftover bytes).
public void	expand(int size) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand.
private boolean	Returns: `true` if more data was added to the input buffer otherwise `false` fill(boolean block) Attempts to read some data into the input buffer.
public ByteBuffer	getByteBuffer() Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer.
pack-priv InputFilter[]	getFilters() Get filters.
pack-priv ByteBuffer	getLeftover()
pack-priv int	getParsingRequestLinePhase()
pack-priv void	init(SocketWrapperBase<?> socketWrapper)
pack-priv boolean	isChunking()
pack-priv boolean	isFinished() Has all of the request body been read?
pack-priv void	nextRequest() End processing of current HTTP request.
private Http11InputBuffer.HeaderParseStatus	Returns: One of `HeaderParseStatus#NEED_MORE_DATA`, `HeaderParseStatus#HAVE_MORE_HEADERS` or `HeaderParseStatus#DONE`. parseHeader() Parse an HTTP header.
pack-priv boolean	parseHeaders() Parse the HTTP headers.
private String	parseInvalid(int startPos, ByteBuffer buffer)
pack-priv boolean	Returns: true if data is properly fed; false if no data is available immediately and thread should be freed parseRequestLine(boolean keptAlive, int connectionTimeout, int keepAliveTimeout) Read the request line.
pack-priv void	recycle() Recycle the input buffer.
public void	setByteBuffer(ByteBuffer buffer) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.setByteBuffer.
pack-priv void	setSwallowInput(boolean swallowInput) Set the swallow input flag.
private Http11InputBuffer.HeaderParseStatus	skipLine(boolean deleteHeader)

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

Field Detail

activeFilters	back to summary
private InputFilter[] activeFilters Active filters (in order).

byteBuffer	back to summary
private ByteBuffer byteBuffer The read buffer.

chr	back to summary
private byte chr

CLIENT_PREFACE_START	back to summary
private static final byte[] CLIENT_PREFACE_START

end	back to summary
private int end Pos of the end of the header in the buffer, which is also the start of the body.

filterLibrary	back to summary
private InputFilter[] filterLibrary Filter library. Note Filter[Constants.CHUNKED_FILTER] is always the "chunked" filter.

headerBufferSize	back to summary
private final int headerBufferSize Maximum allowed size of the HTTP request line plus headers plus any leading blank lines.

headerData	back to summary
private final Http11InputBuffer.HeaderParseData headerData

headerParsePos	back to summary
private Http11InputBuffer.HeaderParsePosition headerParsePos

headers	back to summary
private final MimeHeaders headers Headers of the associated request.

httpParser	back to summary
private final HttpParser httpParser

inputStreamInputBuffer	back to summary
private InputBuffer inputStreamInputBuffer Underlying input buffer.

lastActiveFilter	back to summary
private int lastActiveFilter Index of the last active filter.

log	back to summary
private static final Log log

parsingHeader	back to summary
private volatile boolean parsingHeader State.

parsingRequestLine	back to summary
private volatile boolean parsingRequestLine

parsingRequestLineEol	back to summary
private boolean parsingRequestLineEol

parsingRequestLinePhase	back to summary
private int parsingRequestLinePhase

parsingRequestLineQPos	back to summary
private int parsingRequestLineQPos

parsingRequestLineStart	back to summary
private int parsingRequestLineStart

prevChr	back to summary
private byte prevChr Parsing state - used for non blocking parsing so that when more data arrives, we can pick up where we left off.

rejectIllegalHeader	back to summary
private final boolean rejectIllegalHeader

request	back to summary
private final Request request Associated Coyote request.

sm	back to summary
private static final StringManager sm The string manager for this package.

socketReadBufferSize	back to summary
private int socketReadBufferSize Known size of the NioChannel read buffer.

swallowInput	back to summary
private boolean swallowInput Swallow input ? (in the case of an expectation)

wrapper	back to summary
private SocketWrapperBase<?> wrapper Wrapper that provides access to the underlying socket.

wrapper

back to summary

private SocketWrapperBase<?> wrapper

Wrapper that provides access to the underlying socket.

Constructor Detail

Http11InputBuffer	back to summary
public Http11InputBuffer(Request request, int headerBufferSize, boolean rejectIllegalHeader, HttpParser httpParser)

Method Detail

addActiveFilter	back to summary
pack-priv void addActiveFilter(InputFilter filter) Add an input filter to the filter library.

addFilter	back to summary
pack-priv void addFilter(InputFilter filter) Add an input filter to the filter library. Exceptions NullPointerException: if the supplied filter is null

addFilter

back to summary

pack-priv void addFilter(InputFilter filter)

Add an input filter to the filter library.

Exceptions

NullPointerException:: if the supplied filter is null

available	back to summary
public int available() Implements org.apache.coyote.InputBuffer.available. Doc from org.apache.coyote.InputBuffer.available. Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered. Returns:int The number of bytes that can be read without blocking Annotations @Override

available

back to summary

public int available()

Implements org.apache.coyote.InputBuffer.available.

Doc from org.apache.coyote.InputBuffer.available.

Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.

Returns:int

The number of bytes that can be read without blocking

Annotations

@Override

available	back to summary
pack-priv int available(boolean read) Available bytes in the buffers for the current request. Note that when requests are pipelined, the data in byteBuffer may relate to the next request rather than this one.

doRead	back to summary
public int doRead(ApplicationBufferHandler handler) throws IOException Implements org.apache.coyote.InputBuffer.doRead. Doc from org.apache.coyote.InputBuffer.doRead. Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler. Important Note the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it. Parameters handler:ApplicationBufferHandler ApplicationBufferHandler that provides the buffer to read data into. Returns:int The number of bytes that have been added to the buffer or -1 for end of stream Annotations @Override Exceptions IOException: If an I/O error occurs reading from the input stream

doRead

back to summary

public int doRead(ApplicationBufferHandler handler) throws IOException

Implements org.apache.coyote.InputBuffer.doRead.

Doc from org.apache.coyote.InputBuffer.doRead.

Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.

Important Note

the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.

Parameters

handler:ApplicationBufferHandler: ApplicationBufferHandler that provides the buffer to read data into.

Returns:int

The number of bytes that have been added to the buffer or -1 for end of stream

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs reading from the input stream

endRequest	back to summary
pack-priv void endRequest() throws IOException End request (consumes leftover bytes). Exceptions IOException: an underlying I/O error occurred

endRequest

back to summary

pack-priv void endRequest() throws IOException

End request (consumes leftover bytes).

Exceptions

IOException:: an underlying I/O error occurred

expand	back to summary
public void expand(int size) Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand. Annotations @Override

expand

back to summary

public void expand(int size)

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.expand.

Annotations

@Override

fill back to summary

fill	back to summary
private boolean fill(boolean block) throws IOException Attempts to read some data into the input buffer. Returns:boolean `true` if more data was added to the input buffer otherwise `false`

private boolean fill(boolean block) throws IOException

Attempts to read some data into the input buffer.

Returns:boolean: true if more data was added to the input buffer otherwise false

getByteBuffer	back to summary
public ByteBuffer getByteBuffer() Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer. Annotations @Override

getByteBuffer

back to summary

public ByteBuffer getByteBuffer()

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.getByteBuffer.

Annotations

@Override

getFilters	back to summary
pack-priv InputFilter[] getFilters() Get filters.

getLeftover	back to summary
pack-priv ByteBuffer getLeftover()

getParsingRequestLinePhase	back to summary
pack-priv int getParsingRequestLinePhase()

init	back to summary
pack-priv void init(SocketWrapperBase<?> socketWrapper)

isChunking	back to summary
pack-priv boolean isChunking()

isFinished	back to summary
pack-priv boolean isFinished() Has all of the request body been read? There are subtle differences between this and available() > 0 primarily because of having to handle faking non-blocking reads with the blocking IO connector.

nextRequest	back to summary
pack-priv void nextRequest() End processing of current HTTP request. Note All bytes of the current request should have been already consumed. This method only resets all the pointers so that we are ready to parse the next HTTP request.

parseHeader back to summary

parseHeader	back to summary
private Http11InputBuffer.HeaderParseStatus parseHeader() throws IOException Parse an HTTP header. Returns:Http11InputBuffer.HeaderParseStatus One of `HeaderParseStatus#NEED_MORE_DATA`, `HeaderParseStatus#HAVE_MORE_HEADERS` or `HeaderParseStatus#DONE`.

private Http11InputBuffer.HeaderParseStatus parseHeader() throws IOException

Parse an HTTP header.

Returns:Http11InputBuffer.HeaderParseStatus: One of HeaderParseStatus#NEED_MORE_DATA, HeaderParseStatus#HAVE_MORE_HEADERS or HeaderParseStatus#DONE.

parseHeaders	back to summary
pack-priv boolean parseHeaders() throws IOException Parse the HTTP headers.

parseInvalid	back to summary
private String parseInvalid(int startPos, ByteBuffer buffer)

parseRequestLine

back to summary

pack-priv boolean parseRequestLine(boolean keptAlive, int connectionTimeout, int keepAliveTimeout) throws IOException

Read the request line. This function is meant to be used during the HTTP request header parsing. Do NOT attempt to read the request body using it.

Returns:boolean

true if data is properly fed; false if no data is available immediately and thread should be freed

Exceptions

IOException:: If an exception occurs during the underlying socket read operations, or if the given buffer is not big enough to accommodate the whole line.

recycle	back to summary
pack-priv void recycle() Recycle the input buffer. This should be called when closing the connection.

setByteBuffer

back to summary

public void setByteBuffer(ByteBuffer buffer)

Implements org.apache.tomcat.util.net.ApplicationBufferHandler.setByteBuffer.

Annotations

@Override

setSwallowInput	back to summary
pack-priv void setSwallowInput(boolean swallowInput) Set the swallow input flag.

skipLine	back to summary
private Http11InputBuffer.HeaderParseStatus skipLine(boolean deleteHeader) throws IOException

org.apache.coyote.http11 back to summary

private Class Http11InputBuffer.HeaderParseData

Class Inheritance

extends Object

java.lang.Object
org.apache.coyote.http11.Http11InputBuffer.HeaderParseData

Field Summary

Modifier and Type	Field and Description
pack-priv MessageBytes	headerValue MB that will store the value of the header.
pack-priv int	lastSignificantChar When parsing header name: not used (stays as 0).
pack-priv int	lineStart The first character of the header line.
pack-priv int	realPos When parsing header name: not used (stays as 0).
pack-priv int	start When parsing header name: first character of the header.

Constructor Summary

Access	Constructor and Description
private	HeaderParseData()

Method Summary

Modifier and Type	Method and Description
public void	recycle()

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

Field Detail

headerValue	back to summary
pack-priv MessageBytes headerValue MB that will store the value of the header. It is null while parsing header name and is created after the name has been parsed.

lastSignificantChar	back to summary
pack-priv int lastSignificantChar When parsing header name: not used (stays as 0). When skipping broken header line: last non-CR/non-LF character. When parsing header value: position after the last not-LWS character.

lineStart	back to summary
pack-priv int lineStart The first character of the header line.

realPos

back to summary

pack-priv int realPos

When parsing header name: not used (stays as 0).
When skipping broken header line: not used (stays as 0).
When parsing header value: starts as the first character after ':'. Then is increased as far as more bytes of the header are harvested. Bytes from buf[pos] are copied to buf[realPos]. Thus the string from [start] to [realPos-1] is the prepared value of the header, with whitespaces removed as needed.

start	back to summary
pack-priv int start When parsing header name: first character of the header. When skipping broken header line: first character of the header. When parsing header value: first character after ':'.

Constructor Detail

HeaderParseData	back to summary
private HeaderParseData()

Method Detail

recycle	back to summary
public void recycle()

org.apache.coyote.http11 back to summary

private final Enum Http11InputBuffer.HeaderParsePosition

Class Inheritance

extends Enum<Http11InputBuffer.HeaderParsePosition>

java.lang.Object
java.lang.Enum
org.apache.coyote.http11.Http11InputBuffer.HeaderParsePosition

Field Summary

Modifier and Type	Field and Description
public static final Http11InputBuffer.HeaderParsePosition	HEADER_MULTI_LINE Before reading a new line of a header.
public static final Http11InputBuffer.HeaderParsePosition	HEADER_NAME Reading a header name.
public static final Http11InputBuffer.HeaderParsePosition	HEADER_SKIPLINE Reading all bytes until the next CRLF.
public static final Http11InputBuffer.HeaderParsePosition	HEADER_START Start of a new header.
public static final Http11InputBuffer.HeaderParsePosition	HEADER_VALUE Reading the header value.
public static final Http11InputBuffer.HeaderParsePosition	HEADER_VALUE_START Skipping whitespace before text of header value starts, either on the first line of header value (just after ':') or on subsequent lines when it is known that subsequent line starts with SP or HT.

Constructor Summary

Access	Constructor and Description
private	HeaderParsePosition()

Method Summary

Modifier and Type	Method and Description
public static Http11InputBuffer.HeaderParsePosition	valueOf(String name)
public static Http11InputBuffer.HeaderParsePosition[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

HEADER_MULTI_LINE	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_MULTI_LINE Before reading a new line of a header. Once the next byte is peeked, the state changes without advancing our position. The state becomes either HEADER_VALUE_START (if that first byte is SP or HT), or HEADER_START (otherwise).

HEADER_NAME	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_NAME Reading a header name. All characters of header are HTTP_TOKEN_CHAR. Header name is followed by ':'. No whitespace is allowed. Any non-HTTP_TOKEN_CHAR (this includes any whitespace) encountered before ':' will result in the whole line being ignored.

HEADER_SKIPLINE	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_SKIPLINE Reading all bytes until the next CRLF. The line is being ignored.

HEADER_START	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_START Start of a new header. A CRLF here means that there are no more headers. Any other character starts a header name.

HEADER_VALUE	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_VALUE Reading the header value. We are inside the value. Either on the first line or on any subsequent line. We come into this state from HEADER_VALUE_START after the first non-SP/non-HT byte is encountered on the line.

HEADER_VALUE_START	back to summary
public static final Http11InputBuffer.HeaderParsePosition HEADER_VALUE_START Skipping whitespace before text of header value starts, either on the first line of header value (just after ':') or on subsequent lines when it is known that subsequent line starts with SP or HT.

Constructor Detail

HeaderParsePosition	back to summary
private HeaderParsePosition()

Method Detail

valueOf	back to summary
public static Http11InputBuffer.HeaderParsePosition valueOf(String name)

values	back to summary
public static Http11InputBuffer.HeaderParsePosition[] values()

org.apache.coyote.http11 back to summary

private final Enum Http11InputBuffer.HeaderParseStatus

Class Inheritance

extends Enum<Http11InputBuffer.HeaderParseStatus>

java.lang.Object
java.lang.Enum
org.apache.coyote.http11.Http11InputBuffer.HeaderParseStatus

Field Summary

Modifier and Type	Field and Description
public static final Http11InputBuffer.HeaderParseStatus	DONE
public static final Http11InputBuffer.HeaderParseStatus	HAVE_MORE_HEADERS
public static final Http11InputBuffer.HeaderParseStatus	NEED_MORE_DATA

Constructor Summary

Access	Constructor and Description
private	HeaderParseStatus()

Method Summary

Modifier and Type	Method and Description
public static Http11InputBuffer.HeaderParseStatus	valueOf(String name)
public static Http11InputBuffer.HeaderParseStatus[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DONE	back to summary
public static final Http11InputBuffer.HeaderParseStatus DONE

HAVE_MORE_HEADERS	back to summary
public static final Http11InputBuffer.HeaderParseStatus HAVE_MORE_HEADERS

NEED_MORE_DATA	back to summary
public static final Http11InputBuffer.HeaderParseStatus NEED_MORE_DATA

Constructor Detail

HeaderParseStatus	back to summary
private HeaderParseStatus()

Method Detail

valueOf	back to summary
public static Http11InputBuffer.HeaderParseStatus valueOf(String name)

values	back to summary
public static Http11InputBuffer.HeaderParseStatus[] values()

org.apache.coyote.http11 back to summary

private Class Http11InputBuffer.SocketInputBuffer

Class Inheritance

extends Object
implements InputBuffer

java.lang.Object
org.apache.coyote.http11.Http11InputBuffer.SocketInputBuffer

All Implemented Interfaces

org.apache.coyote.InputBuffer

This class is an input buffer which will read its data from an input stream.

Constructor Summary

Access	Constructor and Description
private	SocketInputBuffer()

Method Summary

Modifier and Type	Method and Description
public int	available() Implements org.apache.coyote.InputBuffer.available. Obtain an estimate of the number of bytes that can be read without blocking.
public int	doRead(ApplicationBufferHandler ApplicationBufferHandler that provides the buffer to read data into. handler) Implements org.apache.coyote.InputBuffer.doRead. Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.

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

Constructor Detail

SocketInputBuffer	back to summary
private SocketInputBuffer()

Method Detail

available

back to summary

public int available()

Implements org.apache.coyote.InputBuffer.available.

Doc from org.apache.coyote.InputBuffer.available.

Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.

Returns:int

The number of bytes that can be read without blocking

Annotations

@Override

doRead

back to summary

public int doRead(ApplicationBufferHandler handler) throws IOException

Implements org.apache.coyote.InputBuffer.doRead.

Doc from org.apache.coyote.InputBuffer.doRead.

Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.

Important Note

the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.

Parameters

handler:ApplicationBufferHandler: ApplicationBufferHandler that provides the buffer to read data into.

Returns:int

The number of bytes that have been added to the buffer or -1 for end of stream

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs reading from the input stream

public Class Http11InputBuffer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Http11InputBuffer.HeaderParseData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Http11InputBuffer.HeaderParsePosition

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Http11InputBuffer.HeaderParseStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Http11InputBuffer.SocketInputBuffer

Constructor Summary

Method Summary

Constructor Detail

Method Detail