Class AbstractMessageParser<T extends HttpMessage>

java.lang.Object

org.apache.hc.core5.http.impl.nio.AbstractMessageParser<T>

Type Parameters:

T - The type of HttpMessage.

All Implemented Interfaces:

NHttpMessageParser<T>

Direct Known Subclasses:

DefaultHttpRequestParser, DefaultHttpResponseParser

public abstract class AbstractMessageParser<T extends HttpMessage>
extends Object
implements NHttpMessageParser<T>

Abstract NHttpMessageParser that serves as a base for all message parser implementations.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	AbstractMessageParser.State

Field Summary

Fields

Modifier and Type	Field	Description
private int	emptyLineCount
private final List<CharArrayBuffer>	headerBufs
private final Http1Config	http1Config
private CharArrayBuffer	lineBuf
private final LineParser	lineParser
private T	message
private AbstractMessageParser.State	state

Constructor Summary

Constructors

Constructor	Description
AbstractMessageParser(Http1Config http1Config, LineParser lineParser)	Constructs a new instance for a subclass.
AbstractMessageParser(LineParser lineParser, Http1Config messageConstraints)	Deprecated. Use AbstractMessageParser(Http1Config, LineParser)

Method Summary

Modifier and Type	Method	Description
protected abstract T	createMessage(CharArrayBuffer buffer)	Creates HttpMessage instance based on the content of the input buffer containing the first line of the incoming HTTP message.
(package private) LineParser	getLineParser()
T	parse(SessionInputBuffer sessionBuffer, boolean endOfStream)	Attempts to parse a complete message head from the content of the internal buffer.
private void	parseHeader()
private T	parseHeadLine()
void	reset()	Resets the parser.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

http1Config

private final Http1Config http1Config

lineParser

private final LineParser lineParser

state

private AbstractMessageParser.State state

message

private T extends HttpMessage message

lineBuf

private CharArrayBuffer lineBuf

headerBufs

private final List<CharArrayBuffer> headerBufs

emptyLineCount

private int emptyLineCount

Constructor Details

AbstractMessageParser

public AbstractMessageParser(Http1Config http1Config,
 LineParser lineParser)

Constructs a new instance for a subclass.

Parameters:

http1Config - HTTP/1.1 protocol parameters.

lineParser - How to parse lines in an HTTP message.

Since:

5.3

AbstractMessageParser

@Deprecated
public AbstractMessageParser(LineParser lineParser,
 Http1Config messageConstraints)

Deprecated.

Use AbstractMessageParser(Http1Config, LineParser)

Constructs a new instance for a subclass.

Parameters:

lineParser - How to parse lines in an HTTP message.

messageConstraints - HTTP/1.1 protocol parameters.

Method Details

getLineParser

LineParser getLineParser()

reset

public void reset()

Description copied from interface: NHttpMessageParser

Resets the parser. The parser will be ready to start parsing another HTTP message.

Specified by:

reset in interface NHttpMessageParser<T extends HttpMessage>

createMessage

protected abstract T createMessage(CharArrayBuffer buffer)
                            throws HttpException

Creates HttpMessage instance based on the content of the input buffer containing the first line of the incoming HTTP message.

Parameters:

buffer - the line buffer.

Returns:

HTTP message.

Throws:

HttpException - in case of HTTP protocol violation

parseHeadLine

private T parseHeadLine()
                 throws IOException,
HttpException

Throws:

IOException

HttpException

parseHeader

private void parseHeader()
                  throws IOException

Throws:

IOException

parse

public T parse(SessionInputBuffer sessionBuffer,
 boolean endOfStream)
        throws IOException,
HttpException

Description copied from interface: NHttpMessageParser

Attempts to parse a complete message head from the content of the internal buffer. If the message in the input buffer is incomplete this method will return null.

Specified by:

parse in interface NHttpMessageParser<T extends HttpMessage>

Parameters:

sessionBuffer - session input buffer.

endOfStream - end of stream flag

Returns:

HTTP message head, if available, null otherwise.

Throws:

IOException - in case of an I/O error.

HttpException - in case the HTTP message is malformed or violates the HTTP protocol.