serguei.http

Class HttpRequest

java.lang.Object

serguei.http.HttpRequest

public class HttpRequest
extends Object

This represents a request as received by a server

Author:

Serguei Poliakov

Constructor Summary

Constructors

Constructor and Description
HttpRequest(InputStream inputStream)

Method Summary

Modifier and Type	Method and Description
InputStream	getBodyAsStream() This returns the body of the request as a stream Please note it is the user needs to close this stream if connection is to be reused
long	getContentLength()
String	getHeader(String headerName) This returns an HTTP header by name, if there are more then one header with this name, the first one will be returned, if header with this name does not exist, null is returned.
HttpRequestHeaders	getHeaders()
List<String>	getHeaders(String headerName) This returns headers by name, if there are more then one header with this name, all of them will be returned, if headers with this name don't exist, an empty list is returned The name is not case-sensitive.
String	getHost()
String	getMethod()
URL	getUrl()
String	getVersion()
boolean	hasMultipartBody()
boolean	isBodyCompressed()
boolean	isContentChunked()
byte[]	readBodyAsBytes() This reads the body of the request and returns it as an array of bytes
String	readBodyAsString() This reads the body of the request and returns it as a string
RequestValues	readBodyAsValues() This reads the body of the request and parses it assuming it contains HTML Form data
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(InputStream inputStream)
            throws IOException

Throws:

IOException

Method Detail

getMethod

public String getMethod()

Returns:

HTTP method (e.g. GET, POST etc)

getUrl

public URL getUrl()

Returns:

Request url (build from a request line and, if it is missing host name, from Host header)

getVersion

public String getVersion()

Returns:

HTTP version ("HTTP/1.0" or "HTTP/1.1")

getHost

public String getHost()

Returns:

Host name. Comes from Host header or, if absent (e.g. when HTTP/1.0) then from request line

getContentLength

public long getContentLength()

Returns:

content length (as set in Content-Length header). If absent - returns -1

isContentChunked

public boolean isContentChunked()

Returns:

true if body is sent using chunked encoding

hasMultipartBody

public boolean hasMultipartBody()

Returns:

true if it is multi-part request

getHeader

public String getHeader(String headerName)

This returns an HTTP header by name, if there are more then one header with this name, the first one will be returned, if header with this name does not exist, null is returned. The name is not case-sensitive.

getHeaders

public List<String> getHeaders(String headerName)

This returns headers by name, if there are more then one header with this name, all of them will be returned, if headers with this name don't exist, an empty list is returned The name is not case-sensitive.

readBodyAsString

public String readBodyAsString()
                        throws IOException

This reads the body of the request and returns it as a string

Throws:

IOException

readBodyAsBytes

public byte[] readBodyAsBytes()
                       throws IOException

This reads the body of the request and returns it as an array of bytes

Throws:

IOException

readBodyAsValues

public RequestValues readBodyAsValues()
                               throws IOException

This reads the body of the request and parses it assuming it contains HTML Form data

Throws:

IOException

getBodyAsStream

public InputStream getBodyAsStream()

This returns the body of the request as a stream Please note it is the user needs to close this stream if connection is to be reused

getHeaders

public HttpRequestHeaders getHeaders()

Returns:

copy of the HTTP headers

isBodyCompressed

public boolean isBodyCompressed()

Returns:

true if request has a body and the body is compressed

toString

public String toString()

Overrides:

toString in class Object