HttpRequest (Jodd API Documentation)

java.lang.Object
- jodd.http.HttpBase<HttpRequest>
- - jodd.http.HttpRequest

public class HttpRequest
extends HttpBase<HttpRequest>

HTTP request.

Nested Class Summary
- Nested classes/interfaces inherited from class jodd.http.HttpBase
  HttpBase.Defaults

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`connectTimeout`
`protected boolean`	`followRedirects`
`protected java.lang.String`	`host`
`protected HttpConnection`	`httpConnection`
`protected HttpConnectionProvider`	`httpConnectionProvider`
`protected int`	`maxRedirects`
`protected java.lang.String`	`method`
`protected java.lang.String`	`path`
`protected int`	`port`
`protected java.lang.String`	`protocol`
`protected HttpMultiMap<java.lang.String>`	`query`
`protected java.lang.String`	`queryEncoding`
`protected int`	`timeout`

Fields inherited from class jodd.http.HttpBase
body, capitalizeHeaderKeys, charset, form, formEncoding, HEADER_ACCEPT, HEADER_ACCEPT_ENCODING, HEADER_AUTHORIZATION, 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, httpProgressListener, httpVersion, mediaType, multipart

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`acceptJson()` Accepts JSON content type.
`HttpRequest`	`basicAuthentication(java.lang.String username, java.lang.String password)` Enables basic authentication by adding required header.
`protected Buffer`	`buffer(boolean fullRequest)` Prepares the request buffer.
`HttpRequest`	`clearQueries()` Clears all query parameters.
`static HttpRequest`	`connect(java.lang.String destination)` Builds a CONNECT request.
`HttpConnection`	`connection()` Returns `HttpConnection` that is going to be used for sending this request.
`HttpConnectionProvider`	`connectionProvider()` Returns http connection provider that was used for creating current http connection.
`int`	`connectionTimeout()` Returns socket connection timeout.
`HttpRequest`	`connectionTimeout(int milliseconds)` Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).
`HttpRequest`	`contentTypeJson()` Specifies JSON content type.
`HttpRequest`	`cookies(Cookie... cookies)` Sets cookies to the request.
`static HttpRequest`	`create(java.lang.String method, java.lang.String destination)` Generic request builder, usually used when method is a variable.
`static HttpRequest`	`delete(java.lang.String destination)` Builds a DELETE request.
`HttpRequest`	`followRedirects(boolean followRedirects)` Defines if redirects responses should be followed.
`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.
`java.lang.String`	`hostUrl()` Returns just host url, without path and query.
`protected void`	`initRequest()` Prepares request on creation.
`boolean`	`isFollowRedirects()` Returns `true` if redirects are followed.
`HttpRequest`	`keepAlive(HttpResponse httpResponse, boolean doContinue)` Continues using the same keep-alive connection.
`int`	`maxRedirects()` Returns max number of redirects, used when `followRedirects` is enabled.
`HttpRequest`	`maxRedirects(int maxRedirects)` Sets the max number of redirects, used when `followRedirects` is enabled.
`java.lang.String`	`method()` Returns request method.
`HttpRequest`	`method(HttpMethod httpMethod)`
`HttpRequest`	`method(java.lang.String method)` Specifies request method.
`HttpRequest`	`monitor(HttpProgressListener httpProgressListener)` Registers `listener` that will monitor upload progress.
`HttpRequest`	`multipart(boolean multipart)` Forces multipart requests.
`HttpRequest`	`open()` Opens a new `connection` using either provided or `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.
`static HttpRequest`	`patch(java.lang.String destination)` Builds a PATCH 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.
`HttpMultiMap<java.lang.String>`	`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.
`HttpRequest`	`queryRemove(java.lang.String name)` Removes query parameters for given name.
`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.
`static HttpRequest`	`readFrom(java.io.InputStream in, java.lang.String encoding)`
`HttpResponse`	`send()` `Opens connection` if not already open, sends request, reads response and closes the request.
`void`	`sendAndReceive(java.util.function.Consumer<HttpResponse> responseHandler)` Syntax sugar.
`<R> R`	`sendAndReceive(java.util.function.Function<HttpResponse,R> responseHandler)` Syntax sugar.
`java.util.concurrent.CompletableFuture<HttpResponse>`	`sendAsync()` Sends http request asynchronously using common fork-join pool.
`HttpRequest`	`set(java.lang.String destination)` Sets the destination (method, host, port... ) at once.
`HttpRequest`	`setHostHeader()` Sets 'Host' header from current host and port.
`int`	`timeout()` Returns read timeout (SO_TIMEOUT) in milliseconds.
`HttpRequest`	`timeout(int milliseconds)` Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).
`HttpRequest`	`tokenAuthentication(java.lang.String token)` Enables token-based authentication.
`static HttpRequest`	`trace(java.lang.String destination)` Builds a TRACE request.
`boolean`	`trustAllCertificates()` Returns a flag if to trusts all certificates.
`HttpRequest`	`trustAllCerts(boolean trust)` Trusts all certificates, use with caution.
`java.lang.String`	`url()` Returns full URL path.
`boolean`	`verifyHttpsHost()` Returns a flag if to verify https hosts.
`HttpRequest`	`verifyHttpsHost(boolean verifyHttpsHost)` Verifies HTTPS hosts.
`HttpRequest`	`withConnectionProvider(HttpConnectionProvider httpConnectionProvider)` Uses custom connection provider when `opening` the connection.

Methods inherited from class jodd.http.HttpBase
_header, _headerRaw, _this, accept, accept, acceptEncoding, acceptEncoding, body, body, body, bodyBytes, bodyText, bodyText, bodyText, bodyText, capitalizeHeaderKeys, capitalizeHeaderKeys, charset, charset, connectionKeepAlive, contentEncoding, contentLength, contentLength, contentType, contentType, contentType, cookies, form, form, form, form, formBuffer, formEncoding, formOverwrite, header, header, header, header, header, headerNames, headerOverwrite, headerRemove, headers, httpVersion, httpVersion, initForm, isConnectionPersistent, isFormMultipart, mediaType, mediaType, populateHeaderAndBody, readBody, readHeaders, resolveFormEncoding, sendTo, toByteArray, tokenAuthentication, toString, toString, 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 HttpMultiMap<java.lang.String> query
```
  - queryEncoding
```
protected java.lang.String queryEncoding
```
  - timeout
```
protected int timeout
```
  - connectTimeout
```
protected int connectTimeout
```
  - followRedirects
```
protected boolean followRedirects
```
  - maxRedirects
```
protected int maxRedirects
```
  - 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.
  - create
```
public static HttpRequest create(java.lang.String method,
                                 java.lang.String destination)
```
    Generic request builder, usually used when method is a variable. Otherwise, use one of the other static request builder methods.
  - connect
```
public static HttpRequest connect(java.lang.String destination)
```
    Builds a CONNECT request.
  - 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.
  - patch
```
public static HttpRequest patch(java.lang.String destination)
```
    Builds a PATCH 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. Does not validate if method is one of the HTTP methods.
  - method
```
public HttpRequest method(HttpMethod httpMethod)
```
  - 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()
  - multipart
```
public HttpRequest multipart(boolean multipart)
```
    Forces multipart requests. When set to false, it will be detected if request should be multipart. By setting this to true we are forcing usage of multipart request.
  - cookies
```
public HttpRequest cookies(Cookie... cookies)
```
    Sets cookies to the request.
  - 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 HttpMultiMap<java.lang.String> query()
```
    Returns backend map of query parameters.
  - clearQueries
```
public HttpRequest clearQueries()
```
    Clears all query parameters.
  - queryRemove
```
public HttpRequest queryRemove(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.
  - url
```
public java.lang.String url()
```
    Returns full URL path. Simply concatenates protocol, host, port, path and query string.
  - hostUrl
```
public java.lang.String hostUrl()
```
    Returns just host url, without path and query.
  - basicAuthentication
```
public HttpRequest basicAuthentication(java.lang.String username,
                                       java.lang.String password)
```
    Enables basic authentication by adding required header.
  - tokenAuthentication
```
public HttpRequest tokenAuthentication(java.lang.String token)
```
    Enables token-based authentication.
  - trustAllCerts
```
public HttpRequest trustAllCerts(boolean trust)
```
    Trusts all certificates, use with caution.
  - trustAllCertificates
```
public boolean trustAllCertificates()
```
    Returns a flag if to trusts all certificates.
  - verifyHttpsHost
```
public HttpRequest verifyHttpsHost(boolean verifyHttpsHost)
```
    Verifies HTTPS hosts.
  - verifyHttpsHost
```
public boolean verifyHttpsHost()
```
    Returns a flag if to verify https hosts.
  - setHostHeader
```
public HttpRequest setHostHeader()
```
    Sets 'Host' header from current host and port.
  - monitor
```
public HttpRequest monitor(HttpProgressListener httpProgressListener)
```
    Registers listener that will monitor upload progress. Be aware that the whole size of the request is being monitored, not only the files content.
  - timeout
```
public HttpRequest timeout(int milliseconds)
```
    Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). After establishing the connection, the client socket waits for response after sending the request. This is the elapsed time since the client has sent request to the server before server responds. Please note that this is not same as HTTP Error 408 which the server sends to the client. In other words its maximum period inactivity between two consecutive data packets arriving at client side after connection is established. A timeout value of zero is interpreted as an infinite timeout.
    
    See Also:
    
    HttpConnection.setTimeout(int)
  - timeout
```
public int timeout()
```
    Returns read timeout (SO_TIMEOUT) in milliseconds. Negative value means that default value is used.
    
    See Also:
    
    timeout(int)
  - connectionTimeout
```
public HttpRequest connectionTimeout(int milliseconds)
```
    Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout.
  - connectionTimeout
```
public int connectionTimeout()
```
    Returns socket connection timeout. Negative value means that default value is used.
    
    See Also:
    
    connectionTimeout(int)
  - followRedirects
```
public HttpRequest followRedirects(boolean followRedirects)
```
    Defines if redirects responses should be followed. NOTE: when redirection is enabled, the original URL will NOT be preserved in the request!
  - isFollowRedirects
```
public boolean isFollowRedirects()
```
    Returns true if redirects are followed.
  - maxRedirects
```
public HttpRequest maxRedirects(int maxRedirects)
```
    Sets the max number of redirects, used when followRedirects is enabled.
  - maxRedirects
```
public int maxRedirects()
```
    Returns max number of redirects, used when followRedirects is enabled.
  - withConnectionProvider
```
public HttpRequest withConnectionProvider(HttpConnectionProvider httpConnectionProvider)
```
    Uses custom connection provider when opening the connection.
  - connectionProvider
```
public HttpConnectionProvider connectionProvider()
```
    Returns http connection provider that was used for creating current http connection. If null, default connection provider will be used.
  - connection
```
public HttpConnection connection()
```
    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 either provided or 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.
  - buffer
```
protected Buffer buffer(boolean fullRequest)
```
    Prepares the request buffer.
    
    Specified by:
    
    buffer in class HttpBase<HttpRequest>
  - readFrom
```
public static HttpRequest readFrom(java.io.InputStream in)
```
    Parses input stream and creates new HttpRequest object. Assumes input stream is in ISO_8859_1 encoding.
  - readFrom
```
public static HttpRequest readFrom(java.io.InputStream in,
                                   java.lang.String encoding)
```
  - contentTypeJson
```
public HttpRequest contentTypeJson()
```
    Specifies JSON content type.
  - acceptJson
```
public HttpRequest acceptJson()
```
    Accepts JSON content type.
  - sendAsync
```
public java.util.concurrent.CompletableFuture<HttpResponse> sendAsync()
```
    Sends http request asynchronously using common fork-join pool. Note that this is not the right non-blocking call (not a NIO), it is just a regular call that is operated in a separate thread.
  - sendAndReceive
```
public <R> R sendAndReceive(java.util.function.Function<HttpResponse,R> responseHandler)
```
    Syntax sugar.
  - sendAndReceive
```
public void sendAndReceive(java.util.function.Consumer<HttpResponse> responseHandler)
```
    Syntax sugar.

Class HttpRequest

Nested Class Summary

Nested classes/interfaces inherited from class jodd.http.HttpBase

Field Summary

Fields inherited from class jodd.http.HttpBase

Constructor Summary

Method Summary

Methods inherited from class jodd.http.HttpBase

Methods inherited from class java.lang.Object

Field Detail

protocol

host

port

method

path

query

queryEncoding

timeout

connectTimeout

followRedirects

maxRedirects

httpConnection

httpConnectionProvider

Constructor Detail

HttpRequest

Method Detail

initRequest

host

host

protocol

protocol

port

port

set

create

connect

get

post

put

patch

delete

head

trace

options

method

method

method

path

path

multipart

cookies

query

query

query

query

clearQueries

queryRemove

queryString

queryString

queryString

queryEncoding

url

hostUrl

basicAuthentication

tokenAuthentication

trustAllCerts

trustAllCertificates

verifyHttpsHost

verifyHttpsHost

setHostHeader

monitor

timeout

timeout

connectionTimeout

connectionTimeout

followRedirects

isFollowRedirects

maxRedirects

maxRedirects

withConnectionProvider