jodd.http

Class HttpRequest

java.lang.Object

jodd.http.HttpBase<HttpRequest>

jodd.http.HttpRequest

public class HttpRequest
extends HttpBase<HttpRequest>

HTTP request.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	host
protected HttpConnection	httpConnection
protected HttpConnectionProvider	httpConnectionProvider
protected java.lang.String	method
protected java.lang.String	path
protected int	port
protected java.lang.String	protocol
protected HttpValuesMap	query
protected java.lang.String	queryEncoding

Fields inherited from class jodd.http.HttpBase

body, charset, form, formEncoding, HEADER_ACCEPT_ENCODING, HEADER_CLOSE, HEADER_CONNECTION, HEADER_CONTENT_ENCODING, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_ETAG, HEADER_HOST, HEADER_KEEP_ALIVE, headers, HTTP_1_0, HTTP_1_1, httpVersion, mediaType

Constructor Summary

Constructors

Constructor and Description
HttpRequest()

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	basicAuthentication(java.lang.String username, java.lang.String password) Enables basic authentication by adding required header.
HttpRequest	clearQueries() Clears all query parameters.
static HttpRequest	delete(java.lang.String destination) Builds a DELETE request.
static HttpRequest	get(java.lang.String destination) Builds a GET request.
static HttpRequest	head(java.lang.String destination) Builds a HEAD request.
java.lang.String	host() Returns request host name.
HttpRequest	host(java.lang.String host) Sets request host name.
HttpConnection	httpConnection() Returns HttpConnection that is going to be used for sending this request.
HttpConnectionProvider	httpConnectionProvider() Returns http connection provider that was used for creating current http connection.
protected void	initRequest() Prepares request on creation.
HttpRequest	keepAlive(HttpResponse httpResponse, boolean doContinue) Continues using the same keep-alive connection.
java.lang.String	method() Returns request method.
HttpRequest	method(java.lang.String method) Specifies request method.
HttpRequest	open() Opens a new connection using default connection provider.
HttpRequest	open(HttpConnection httpConnection) Assignees provided HttpConnection for communication.
HttpRequest	open(HttpConnectionProvider httpConnectionProvider) Opens a new connection using given HttpConnectionProvider.
static HttpRequest	options(java.lang.String destination) Builds an OPTIONS request.
java.lang.String	path() Returns request path, without the query.
HttpRequest	path(java.lang.String path) Sets request path.
int	port() Returns request port number.
HttpRequest	port(int port) Sets request port number.
static HttpRequest	post(java.lang.String destination) Builds a POST request.
java.lang.String	protocol() Returns used protocol.
HttpRequest	protocol(java.lang.String protocol) Defines protocol.
static HttpRequest	put(java.lang.String destination) Builds a PUT request.
java.util.Map<java.lang.String,java.lang.Object[]>	query() Returns backend map of query parameters.
HttpRequest	query(java.util.Map<java.lang.String,java.lang.String> queryMap) Adds all parameters from the provided map.
HttpRequest	query(java.lang.String name1, java.lang.Object value1, java.lang.Object... parameters) Adds many query parameters at once.
HttpRequest	query(java.lang.String name, java.lang.String value) Adds query parameter.
HttpRequest	queryEncoding(java.lang.String encoding) Defines encoding for query parameters.
java.lang.String	queryString() Generates query string.
HttpRequest	queryString(java.lang.String queryString)
HttpRequest	queryString(java.lang.String queryString, boolean decode) Sets query from provided query string.
static HttpRequest	readFrom(java.io.InputStream in) Parses input stream and creates new HttpRequest object.
HttpRequest	removeQuery(java.lang.String name) Removes query parameters for given name.
HttpResponse	send() Opens connection if not already open, sends request, reads response and closes the request.
HttpRequest	set(java.lang.String destination) Sets the destination (method, host, port... ) at once.
HttpRequest	setHostHeader() Sets 'Host' header from current host and port.
java.lang.String	toString() Returns string representation of the HTTP request.
java.lang.String	toString(boolean fullRequest) Returns full request or just headers.
static HttpRequest	trace(java.lang.String destination) Builds a TRACE request.
java.lang.String	url() Returns full URL path.

Methods inherited from class jodd.http.HttpBase

_header, acceptEncoding, acceptEncoding, body, body, body, bodyBytes, bodyText, bodyText, bodyText, bodyText, charset, charset, connectionKeepAlive, contentEncoding, contentLength, contentLength, contentType, contentType, contentType, form, form, form, form, form, formEncoding, formString, header, header, header, header, header, headers, httpVersion, httpVersion, initForm, isConnectionPersistent, isFormMultipart, mediaType, mediaType, readBody, readHeaders, removeHeader, sendTo, toByteArray, wrapFormValue

Methods inherited from class java.lang.Object

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

Field Detail

protocol

protected java.lang.String protocol

host

protected java.lang.String host

port

protected int port

method

protected java.lang.String method

path

protected java.lang.String path

query

protected HttpValuesMap query

queryEncoding

protected java.lang.String queryEncoding

httpConnection

protected HttpConnection httpConnection

httpConnectionProvider

protected HttpConnectionProvider httpConnectionProvider

Constructor Detail

HttpRequest

public HttpRequest()

Method Detail

initRequest

protected void initRequest()

Prepares request on creation. By default, it just adds "Connection: Close" header.

host

public java.lang.String host()

Returns request host name.

host

public HttpRequest host(java.lang.String host)

Sets request host name.

protocol

public java.lang.String protocol()

Returns used protocol. By default it's "http".

protocol

public HttpRequest protocol(java.lang.String protocol)

Defines protocol.

port

public int port()

Returns request port number. When port is not explicitly defined, returns default port for current protocol.

port

public HttpRequest port(int port)

Sets request port number.

set

public HttpRequest set(java.lang.String destination)

Sets the destination (method, host, port... ) at once.

get

public static HttpRequest get(java.lang.String destination)

Builds a GET request.

post

public static HttpRequest post(java.lang.String destination)

Builds a POST request.

put

public static HttpRequest put(java.lang.String destination)

Builds a PUT request.

delete

public static HttpRequest delete(java.lang.String destination)

Builds a DELETE request.

head

public static HttpRequest head(java.lang.String destination)

Builds a HEAD request.

trace

public static HttpRequest trace(java.lang.String destination)

Builds a TRACE request.

options

public static HttpRequest options(java.lang.String destination)

Builds an OPTIONS request.

method

public java.lang.String method()

Returns request method.

method

public HttpRequest method(java.lang.String method)

Specifies request method. It will be converted into uppercase.

path

public java.lang.String path()

Returns request path, without the query.

path

public HttpRequest path(java.lang.String path)

Sets request path. Query string is allowed. Adds a slash if path doesn't start with one. Query will be stripped out from the path. Previous query is discarded.

See Also:

query()

query

public HttpRequest query(java.lang.String name,
                java.lang.String value)

Adds query parameter.

query

public HttpRequest query(java.lang.String name1,
                java.lang.Object value1,
                java.lang.Object... parameters)

Adds many query parameters at once. Although it accepts objects, each value will be converted to string.

query

public HttpRequest query(java.util.Map<java.lang.String,java.lang.String> queryMap)

Adds all parameters from the provided map.

query

public java.util.Map<java.lang.String,java.lang.Object[]> query()

Returns backend map of query parameters.

clearQueries

public HttpRequest clearQueries()

Clears all query parameters.

removeQuery

public HttpRequest removeQuery(java.lang.String name)

Removes query parameters for given name.

queryString

public HttpRequest queryString(java.lang.String queryString)

See Also:

queryString(String, boolean)

queryString

public HttpRequest queryString(java.lang.String queryString,
                      boolean decode)

Sets query from provided query string. Previous query values are discarded.

queryString

public java.lang.String queryString()

Generates query string. All values are URL encoded.

queryEncoding

public HttpRequest queryEncoding(java.lang.String encoding)

Defines encoding for query parameters. Default value is copied from JoddHttp.defaultQueryEncoding.

url

public java.lang.String url()

Returns full URL path. Simply concatenates protocol, host, port, path and query string.

basicAuthentication

public HttpRequest basicAuthentication(java.lang.String username,
                              java.lang.String password)

Enables basic authentication by adding required header.

setHostHeader

public HttpRequest setHostHeader()

Sets 'Host' header from current host and port.

httpConnectionProvider

public HttpConnectionProvider httpConnectionProvider()

Returns http connection provider that was used for creating current http connection.

httpConnection

public HttpConnection httpConnection()

Returns HttpConnection that is going to be used for sending this request. Value is available ONLY after calling open() and before send().

open

public HttpRequest open()

Opens a new connection using default connection provider.

open

public HttpRequest open(HttpConnectionProvider httpConnectionProvider)

Opens a new connection using given HttpConnectionProvider.

open

public HttpRequest open(HttpConnection httpConnection)

Assignees provided HttpConnection for communication. It does not actually opens it until the sending.

keepAlive

public HttpRequest keepAlive(HttpResponse httpResponse,
                    boolean doContinue)

Continues using the same keep-alive connection. Don't use any variant of open() when continuing the communication! First it checks if "Connection" header exist in the response and if it is equal to "Keep-Alive" value. Then it checks the "Keep-Alive" headers "max" parameter. If its value is positive, then the existing HttpConnection from the request will be reused. If max value is 1, connection will be sent with "Connection: Close" header, indicating its the last request. When new connection is created, the same HttpConnectionProvider that was used for creating initial connection is used for opening the new connection.

Parameters:

doContinue - set it to false to indicate the last connection

send

public HttpResponse send()

Opens connection if not already open, sends request, reads response and closes the request. If keep-alive mode is enabled connection will not be closed.

toString

public java.lang.String toString()

Returns string representation of the HTTP request. Important: some initialization is done here as well, before resulting string is created.

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean fullRequest)

Returns full request or just headers. Useful for debugging.

readFrom

public static HttpRequest readFrom(java.io.InputStream in)

Parses input stream and creates new HttpRequest object.