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

Interface HttpRequestParser

All Known Implementing Classes:

HttpRequestParserImpl

public interface HttpRequestParser

Parses a HttpRequest.

Author:

Daniel Sagenschneider

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 parse(byte[], int).
boolean	parse(byte[] data, int startIndex) Parses the HttpRequest from the data.
void	reset() Resets for parsing another HttpRequest.

Method Detail

parse

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

Parses the HttpRequest from the data.

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:

nextByteToParseIndex()

nextByteToParseIndex

int nextByteToParseIndex()

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

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

Returns:

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

reset

void reset()

Resets for parsing another HttpRequest.

getMethod

String getMethod()

Obtains the method.

Returns:

Method.

getRequestURI

String getRequestURI()

Obtains the request URI.

Returns:

Request URI.

getHttpVersion

String getHttpVersion()

Obtains the HTTP version.

Returns:

HTTP version.

getHeaders

List<HttpHeader> getHeaders()

Obtains the HttpHeader instances in the order supplied.

Returns:

HttpHeader instances in the order supplied.

getEntity

HttpEntity getEntity()

Obtains the HttpEntity of the HttpRequest.

Returns:

HttpEntity of the HttpRequest.