net.officefloor.plugin.socket.server.http.parse.impl

Class HttpRequestParserImpl

java.lang.Object

net.officefloor.plugin.socket.server.http.parse.impl.HttpRequestParserImpl

All Implemented Interfaces:

HttpRequestParser

public class HttpRequestParserImpl
extends Object
implements HttpRequestParser

Parser for a HTTP request.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	US_ASCII

Constructor Summary

Constructors

Constructor and Description
HttpRequestParserImpl(int maxHeaderCount, int maxTextLength, long maxEntityLength) Initiate.

Method Summary

Modifier and Type	Method and Description
HttpEntity	getEntity() Obtains the HttpEntity of the HttpRequest.
List<HttpHeader>	getHeaders() Obtains the HttpHeader instances in the order supplied.
String	getHttpVersion() Obtains the HTTP version.
String	getMethod() Obtains the method.
String	getRequestURI() Obtains the request URI.
int	nextByteToParseIndex() Obtains the index of the next byte to parse from the previous HttpRequestParser.parse(byte[], int).
boolean	parse(byte[] data, int startIndex) Parses the HttpRequest from the data.
void	reset() Resets for parsing another HttpRequest.

Methods inherited from class java.lang.Object

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

Field Detail

US_ASCII

public static final Charset US_ASCII

Constructor Detail

HttpRequestParserImpl

public HttpRequestParserImpl(int maxHeaderCount,
                             int maxTextLength,
                             long maxEntityLength)

Initiate.

Parameters:

maxHeaderCount - Maximum number of HttpHeader instances for a HttpRequest.

maxTextLength - Maximum number of bytes per TEXT.

maxEntityLength - Maximum length of the entity. Requests with entities greater than this will fail parsing.

Method Detail

reset

public void reset()

Description copied from interface: HttpRequestParser

Resets for parsing another HttpRequest.

Specified by:

reset in interface HttpRequestParser

nextByteToParseIndex

public int nextByteToParseIndex()

Description copied from interface: HttpRequestParser

Obtains the index of the next byte to parse from the previous HttpRequestParser.parse(byte[], int).

Should all bytes be consumed this will return -1. Note that if HttpRequestParser.parse(byte[], int) returns false, this will always return -1 as all bytes are to be consumed.

Specified by:

nextByteToParseIndex in interface HttpRequestParser

Returns:

Index of the next byte to parse or -1 if all bytes consumed.

parse

public boolean parse(byte[] data,
                     int startIndex)
              throws IOException,
                     HttpRequestParseException

Description copied from interface: HttpRequestParser

Parses the HttpRequest from the data.

Specified by:

parse in interface HttpRequestParser

Parameters:

data - Data to be parsed for the HttpRequest.

startIndex - Index within the data to start parsing.

Returns:

true if the HttpRequest has been fully parsed. false indicates this method should be called again when further data is available to obtain the full HttpRequest.

Throws:

IOException - If fails to read bytes.

HttpRequestParseException - If failure to parse HttpRequest.

See Also:

HttpRequestParser.nextByteToParseIndex()

getMethod

public String getMethod()

Description copied from interface: HttpRequestParser

Obtains the method.

Specified by:

getMethod in interface HttpRequestParser

Returns:

Method.

getRequestURI

public String getRequestURI()

Description copied from interface: HttpRequestParser

Obtains the request URI.

Specified by:

getRequestURI in interface HttpRequestParser

Returns:

Request URI.

getHttpVersion

public String getHttpVersion()

Description copied from interface: HttpRequestParser

Obtains the HTTP version.

Specified by:

getHttpVersion in interface HttpRequestParser

Returns:

HTTP version.

getHeaders

public List<HttpHeader> getHeaders()

Description copied from interface: HttpRequestParser

Obtains the HttpHeader instances in the order supplied.

Specified by:

getHeaders in interface HttpRequestParser

Returns:

HttpHeader instances in the order supplied.

getEntity

public HttpEntity getEntity()

Description copied from interface: HttpRequestParser

Obtains the HttpEntity of the HttpRequest.

Specified by:

getEntity in interface HttpRequestParser

Returns:

HttpEntity of the HttpRequest.