de.unkrig.commons.net.http

Class HttpRequest

java.lang.Object

de.unkrig.commons.net.http.HttpMessage

de.unkrig.commons.net.http.HttpRequest

public class HttpRequest
extends HttpMessage

Representation of an HTTP request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequest.Method Representation of the various HTTP methods.

Nested classes/interfaces inherited from class de.unkrig.commons.net.http.HttpMessage

HttpMessage.Body, HttpMessage.HasBody

Field Summary

Fields inherited from class de.unkrig.commons.net.http.HttpMessage

EMPTY_BODY, NO_BODY

Constructor Summary

Constructors

Constructor and Description
HttpRequest(HttpRequest.Method method, URI uri, String httpVersion)
HttpRequest(HttpRequest.Method method, URI uri, String httpVersion, InputStream in)
HttpRequest(HttpRequest.Method method, URI uri, String httpVersion, InputStream in, String loggingPrefix)

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name, String value) Adds another parameter.
void	addParameter(String name, String[] values) Adds a multi-value parameter.
String	getHttpVersion()
HttpRequest.Method	getMethod()
String[]	getParameter(String name)
List<Map.Entry<String,String>>	getParameterList()
URI	getUri()
static HttpRequest	read(InputStream in) Parses and returns one HTTP request from the given InputStream.
static HttpRequest	read(InputStream in, String loggingPrefix) Parses and returns one HTTP request from the given InputStream.
static void	read(ReadableByteChannel in, Multiplexer multiplexer, de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpRequest,IOException> requestConsumer) Reads one HTTP request from in through the multiplexer and passes it to the requestConsumer.
static void	read(ReadableByteChannel in, Multiplexer multiplexer, de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpRequest,IOException> requestConsumer, String loggingPrefix) Reads one HTTP request from in through the multiplexer and passes it to the requestConsumer.
void	setHttpVersion(String httpVersion) Changes the HTTP version of this request.
void	setMethod(HttpRequest.Method method) Changes the HTTP method of this request.
void	setParameter(String name, String value) Removes all parameters with the given name and adds another parameter.
void	setParameter(String name, String[] values) Removes all parameters with the given name and adds another multi-value parameter.
void	setParameterList(Iterable<Map.Entry<String,String>> parameters) Changes this HTTP request's parameters.
void	setUri(URI uri) Changes the URI of this HTTP request.
void	write(OutputStream out) Writes this HTTP request to the given OutputStream.
void	write(OutputStream out, String loggingPrefix) Writes this HTTP request to the given OutputStream.

Methods inherited from class de.unkrig.commons.net.http.HttpMessage

addHeader, addHeader, addHeader, addHeader, body, body, body, body, body, getCharset, getDateHeader, getHeader, getHeaders, getHeaders, getIntHeader, getLongHeader, readBody, readHeaders, readHeaders, readLine, readLine, removeBody, removeHeader, setAttemptUnstreaming, setBody, setHeader, setHeader, setHeader, setHeader, writeHeadersAndBody, writeHeadersAndBody

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(HttpRequest.Method method,
                   URI uri,
                   String httpVersion,
                   InputStream in)
            throws IOException

Throws:

IOException

HttpRequest

public HttpRequest(HttpRequest.Method method,
                   URI uri,
                   String httpVersion,
                   InputStream in,
                   String loggingPrefix)
            throws IOException

Parameters:

loggingPrefix - E.g. ">>> "

Throws:

IOException

HttpRequest

public HttpRequest(HttpRequest.Method method,
                   URI uri,
                   String httpVersion)

Method Detail

read

public static HttpRequest read(InputStream in)
                        throws IOException,
                               InvalidHttpMessageException

Parses and returns one HTTP request from the given InputStream.

Throws:

IOException

InvalidHttpMessageException

read

public static HttpRequest read(InputStream in,
                               String loggingPrefix)
                        throws IOException,
                               InvalidHttpMessageException

Parses and returns one HTTP request from the given InputStream.

Parameters:

loggingPrefix - E.g. ">>> "

Throws:

IOException

InvalidHttpMessageException

getMethod

public HttpRequest.Method getMethod()

Returns:

The HTTP request's HttpRequest.Method

getHttpVersion

public String getHttpVersion()

Returns:

This HTTP request's HTTP version, as given in the request line

getUri

public URI getUri()

Returns:

The URI of this HTTP request

setUri

public final void setUri(URI uri)

Changes the URI of this HTTP request.

getParameterList

public List<Map.Entry<String,String>> getParameterList()
                                                throws IOException

Returns:

The parameters of this request, in order, as they exist in the body (POST, PUT) or in the query string (all other HTTP methods)

Throws:

IOException

setParameterList

public void setParameterList(Iterable<Map.Entry<String,String>> parameters)

Changes this HTTP request's parameters.

getParameter

@Nullable
public String[] getParameter(String name)
                                 throws IOException

Returns:

The values of all parameters with the given name

Throws:

IOException

addParameter

public void addParameter(String name,
                         String value)
                  throws IOException

Adds another parameter.

Throws:

IOException

addParameter

public void addParameter(String name,
                         String[] values)
                  throws IOException

Adds a multi-value parameter.

Throws:

IOException

setParameter

public void setParameter(String name,
                         String value)
                  throws IOException

Removes all parameters with the given name and adds another parameter.

Throws:

IOException

setParameter

public void setParameter(String name,
                         String[] values)
                  throws IOException

Removes all parameters with the given name and adds another multi-value parameter.

Throws:

IOException

setMethod

public void setMethod(HttpRequest.Method method)

Changes the HTTP method of this request.

setHttpVersion

public void setHttpVersion(String httpVersion)

Changes the HTTP version of this request.

write

public void write(OutputStream out)
           throws IOException

Writes this HTTP request to the given OutputStream.

Throws:

IOException

write

public void write(OutputStream out,
                  String loggingPrefix)
           throws IOException

Writes this HTTP request to the given OutputStream.

Parameters:

loggingPrefix - E.g. "<<< "

Throws:

IOException

read

public static void read(ReadableByteChannel in,
                        Multiplexer multiplexer,
                        de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpRequest,IOException> requestConsumer)
                 throws IOException

Reads one HTTP request from in through the multiplexer and passes it to the requestConsumer.

Throws:

IOException

read

public static void read(ReadableByteChannel in,
                        Multiplexer multiplexer,
                        de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpRequest,IOException> requestConsumer,
                        String loggingPrefix)
                 throws IOException

Reads one HTTP request from in through the multiplexer and passes it to the requestConsumer.

Parameters:

loggingPrefix - E.g. ">>> "

Throws:

IOException