net.sf.mmm.util.http

Class HttpParser

java.lang.Object

net.sf.mmm.util.http.HttpParser

public final class HttpParser
extends Object

This is a utility class used to parse HTTP-messages.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static Charset	CHARSET_US_ASCII the default encoding
private static CharFilter	TOKEN_FILTER char-filter for a token as defined by the HTTP specification

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HttpParser() The constructor.

Method Summary

Modifier and Type	Method and Description
private static String	parseLine(InputStream stream, byte[] buffer, Charset charset) This method parses a single line of an HTTP header from the given stream.
private static void	parseProperties(InputStream stream, HttpMessage message, Charset charset, byte[] buffer) This method parses the HTTP header properties from the given stream.
static void	parseRequest(InputStream stream, HttpRequest request) This method parses the HTTP-header from the given stream and applies all information to the given request.
static void	parseRequest(InputStream stream, HttpRequest request, Charset charset) This method parses the HTTP-header from the given stream and applies all information to the given request.

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET_US_ASCII

private static final Charset CHARSET_US_ASCII

the default encoding

TOKEN_FILTER

private static final CharFilter TOKEN_FILTER

char-filter for a token as defined by the HTTP specification

Constructor Detail

HttpParser

private HttpParser()

The constructor.

Method Detail

parseLine

private static String parseLine(InputStream stream,
                                byte[] buffer,
                                Charset charset)
                         throws IOException

This method parses a single line of an HTTP header from the given stream. It (re)uses the given buffer to cache bytes while reading. To convert the read bytes to a string the given charset is used.

Parameters:

stream - is the input stream to read from.

buffer - is where the bytes can be cached.

charset - is used to convert the bytes to a string.

Returns:

the parsed string or null if the stream is already at EOF.

Throws:

IOException - if the operation failes with an I/O problem.

parseProperties

private static void parseProperties(InputStream stream,
                                    HttpMessage message,
                                    Charset charset,
                                    byte[] buffer)
                             throws IOException

This method parses the HTTP header properties from the given stream. This method should be called after the first line has been read and an HTTP-version greator or equal to "1.0" has been detected.

Parameters:

stream - is the stream to read from.

message - is the HTTP-message where to set the parsed properties.

charset - is the charset used to parse the properties.

buffer - is a buffer used to cache bytes.

Throws:

IOException - if the operation failes with an I/O problem.

parseRequest

public static void parseRequest(InputStream stream,
                                HttpRequest request)
                         throws IOException

This method parses the HTTP-header from the given stream and applies all information to the given request. After this method has been called, the given stream is pointing to the beginning of the HTTP-body (or EOF if empty).

Parameters:

stream - is the input-stream to read the header from. Only the header is read so the stream is NOT closed by this method.

request - is where to apply the parsed information to. Simply supply a new instance.

Throws:

IOException - if the operation failes with an I/O problem.

parseRequest

public static void parseRequest(InputStream stream,
                                HttpRequest request,
                                Charset charset)
                         throws IOException

This method parses the HTTP-header from the given stream and applies all information to the given request. After this method has been called, the given stream is pointing to the beginning of the HTTP-body (or EOF if empty).

Parameters:

stream - is the input-stream to read the header from. Only the header is read so the stream is NOT closed by this method.

request - is where to apply the parsed information to. Simply supply a new instance.

charset - is the charset used to convert the read bytes to strings.

Throws:

IOException - if the operation failes with an I/O problem.