HttpRequest (http-request 6.0 API)

java.lang.Object
- com.github.kevinsawicki.http.HttpRequest

```
public class HttpRequest
extends Object
```
A fluid interface for making HTTP requests using an underlying HttpURLConnection (or sub-class).
Each instance supports making a single request and cannot be reused for further requests.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpRequest.Base64` Encodes and decodes to and from Base64 notation.
`protected static class`	`HttpRequest.CloseOperation<V>` Class that ensures a `Closeable` gets closed with proper exception handling.
`static interface`	`HttpRequest.ConnectionFactory` Creates `HTTP connections` for `urls`.
`protected static class`	`HttpRequest.FlushOperation<V>` Class that and ensures a `Flushable` gets flushed with proper exception handling.
`static class`	`HttpRequest.HttpRequestException` HTTP request exception whose cause is always an `IOException`
`protected static class`	`HttpRequest.Operation<V>` Operation that handles executing a callback once complete and handling nested exceptions
`static class`	`HttpRequest.RequestOutputStream` Request output stream
`static interface`	`HttpRequest.UploadProgress` Callback interface for reporting upload progress for a request.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHARSET_UTF8` 'UTF-8' charset name
`static String`	`CONTENT_TYPE_FORM` 'application/x-www-form-urlencoded' content type header value
`static String`	`CONTENT_TYPE_JSON` 'application/json' content type header value
`static String`	`ENCODING_GZIP` 'gzip' encoding header value
`static String`	`HEADER_ACCEPT` 'Accept' header name
`static String`	`HEADER_ACCEPT_CHARSET` 'Accept-Charset' header name
`static String`	`HEADER_ACCEPT_ENCODING` 'Accept-Encoding' header name
`static String`	`HEADER_AUTHORIZATION` 'Authorization' header name
`static String`	`HEADER_CACHE_CONTROL` 'Cache-Control' header name
`static String`	`HEADER_CONTENT_ENCODING` 'Content-Encoding' header name
`static String`	`HEADER_CONTENT_LENGTH` 'Content-Length' header name
`static String`	`HEADER_CONTENT_TYPE` 'Content-Type' header name
`static String`	`HEADER_DATE` 'Date' header name
`static String`	`HEADER_ETAG` 'ETag' header name
`static String`	`HEADER_EXPIRES` 'Expires' header name
`static String`	`HEADER_IF_NONE_MATCH` 'If-None-Match' header name
`static String`	`HEADER_LAST_MODIFIED` 'Last-Modified' header name
`static String`	`HEADER_LOCATION` 'Location' header name
`static String`	`HEADER_PROXY_AUTHORIZATION` 'Proxy-Authorization' header name
`static String`	`HEADER_REFERER` 'Referer' header name
`static String`	`HEADER_SERVER` 'Server' header name
`static String`	`HEADER_USER_AGENT` 'User-Agent' header name
`static String`	`METHOD_DELETE` 'DELETE' request method
`static String`	`METHOD_GET` 'GET' request method
`static String`	`METHOD_HEAD` 'HEAD' request method
`static String`	`METHOD_OPTIONS` 'OPTIONS' options method
`static String`	`METHOD_POST` 'POST' request method
`static String`	`METHOD_PUT` 'PUT' request method
`static String`	`METHOD_TRACE` 'TRACE' request method
`static String`	`PARAM_CHARSET` 'charset' header value parameter

Constructor Summary

Constructors
Constructor and Description
`HttpRequest(CharSequence url, String method)` Create HTTP connection wrapper
`HttpRequest(URL url, String method)` Create HTTP connection wrapper

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRequest`	`accept(String accept)` Set the 'Accept' header to given value
`HttpRequest`	`acceptCharset(String acceptCharset)` Set the 'Accept-Charset' header to given value
`HttpRequest`	`acceptEncoding(String acceptEncoding)` Set the 'Accept-Encoding' header to given value
`HttpRequest`	`acceptGzipEncoding()` Set the 'Accept-Encoding' header to 'gzip'
`HttpRequest`	`acceptJson()` Set the 'Accept' header to 'application/json'
`static String`	`append(CharSequence url, Map<?,?> params)` Append given map as query parameters to the base URL
`static String`	`append(CharSequence url, Object... params)` Append given name/value pairs as query parameters to the base URL
`HttpRequest`	`authorization(String authorization)` Set the 'Authorization' header to given value
`boolean`	`badRequest()` Is the response code a 400 Bad Request?
`HttpRequest`	`basic(String name, String password)` Set the 'Authorization' header to given values in Basic authentication format
`String`	`body()` Get response as `String` using character set returned from `charset()`
`HttpRequest`	`body(AtomicReference<String> output)` Get the response body as a `String` and set it as the value of the given reference.
`HttpRequest`	`body(AtomicReference<String> output, String charset)` Get the response body as a `String` and set it as the value of the given reference.
`String`	`body(String charset)` Get response as `String` in given character set
`BufferedInputStream`	`buffer()` Get response in a buffered stream
`BufferedReader`	`bufferedReader()` Get buffered reader to response body using the character set returned from `charset()` and the configured buffer size
`BufferedReader`	`bufferedReader(String charset)` Get buffered reader to response body using the given character set r and the configured buffer size
`int`	`bufferSize()` Get the configured buffer size
`HttpRequest`	`bufferSize(int size)` Set the size used when buffering and copying between streams
`byte[]`	`bytes()` Get response as byte array
`protected ByteArrayOutputStream`	`byteStream()` Create byte array output stream
`String`	`cacheControl()` Get the 'Cache-Control' header from the response
`String`	`charset()` Get 'charset' parameter from 'Content-Type' response header
`HttpRequest`	`chunk(int size)` Set chunked streaming mode to the given size
`protected HttpRequest`	`closeOutput()` Close output stream
`protected HttpRequest`	`closeOutputQuietly()` Call `closeOutput()` and re-throw a caught `IOException`s as an `HttpRequest.HttpRequestException`
`int`	`code()` Get the status code of the response
`HttpRequest`	`code(AtomicInteger output)` Set the value of the given `AtomicInteger` to the status code of the response
`HttpRequest`	`connectTimeout(int timeout)` Set connect timeout on connection to given value
`String`	`contentEncoding()` Get the 'Content-Encoding' header from the response
`int`	`contentLength()` Get the 'Content-Length' header from the response
`HttpRequest`	`contentLength(int contentLength)` Set the 'Content-Length' request header to the given value
`HttpRequest`	`contentLength(String contentLength)` Set the 'Content-Length' request header to the given value
`String`	`contentType()` Get the 'Content-Type' header from the response
`HttpRequest`	`contentType(String contentType)` Set the 'Content-Type' request header to the given value
`HttpRequest`	`contentType(String contentType, String charset)` Set the 'Content-Type' request header to the given value and charset
`protected HttpRequest`	`copy(InputStream input, OutputStream output)` Copy from input stream to output stream
`protected HttpRequest`	`copy(Reader input, Writer output)` Copy from reader to writer
`boolean`	`created()` Is the response code a 201 Created?
`long`	`date()` Get the 'Date' header from the response
`long`	`dateHeader(String name)` Get a date header from the response falling back to returning -1 if the header is missing or parsing fails
`long`	`dateHeader(String name, long defaultValue)` Get a date header from the response falling back to returning the given default value if the header is missing or parsing fails
`static HttpRequest`	`delete(CharSequence url)` Start a 'DELETE' request to the given URL
`static HttpRequest`	`delete(CharSequence baseUrl, boolean encode, Object... params)` Start a 'DELETE' request to the given URL along with the query params
`static HttpRequest`	`delete(CharSequence baseUrl, Map<?,?> params, boolean encode)` Start a 'DELETE' request to the given URL along with the query params
`static HttpRequest`	`delete(URL url)` Start a 'DELETE' request to the given URL
`HttpRequest`	`disconnect()` Disconnect the connection
`static String`	`encode(CharSequence url)` Encode the given URL as an ASCII `String`
`String`	`eTag()` Get the 'ETag' header from the response
`long`	`expires()` Get the 'Expires' header from the response
`HttpRequest`	`followRedirects(boolean followRedirects)` Set whether or not the underlying connection should follow redirects in the response.
`HttpRequest`	`form(Map.Entry<?,?> entry)` Write the key and value in the entry as form data to the request body
`HttpRequest`	`form(Map.Entry<?,?> entry, String charset)` Write the key and value in the entry as form data to the request body
`HttpRequest`	`form(Map<?,?> values)` Write the values in the map as form data to the request body
`HttpRequest`	`form(Map<?,?> values, String charset)` Write the values in the map as encoded form data to the request body
`HttpRequest`	`form(Object name, Object value)` Write the name/value pair as form data to the request body
`HttpRequest`	`form(Object name, Object value, String charset)` Write the name/value pair as form data to the request body
`static HttpRequest`	`get(CharSequence url)` Start a 'GET' request to the given URL
`static HttpRequest`	`get(CharSequence baseUrl, boolean encode, Object... params)` Start a 'GET' request to the given URL along with the query params
`static HttpRequest`	`get(CharSequence baseUrl, Map<?,?> params, boolean encode)` Start a 'GET' request to the given URL along with the query params
`static HttpRequest`	`get(URL url)` Start a 'GET' request to the given URL
`HttpURLConnection`	`getConnection()` Get underlying connection
`protected String`	`getParam(String value, String paramName)` Get parameter value from header value
`protected Map<String,String>`	`getParams(String header)` Get parameter values from header value
`static HttpRequest`	`head(CharSequence url)` Start a 'HEAD' request to the given URL
`static HttpRequest`	`head(CharSequence baseUrl, boolean encode, Object... params)` Start a 'GET' request to the given URL along with the query params
`static HttpRequest`	`head(CharSequence baseUrl, Map<?,?> params, boolean encode)` Start a 'HEAD' request to the given URL along with the query params
`static HttpRequest`	`head(URL url)` Start a 'HEAD' request to the given URL
`HttpRequest`	`header(Map.Entry<String,String> header)` Set header to have given entry's key as the name and value as the value
`String`	`header(String name)` Get a response header
`HttpRequest`	`header(String name, Number value)` Set header name to given value
`HttpRequest`	`header(String name, String value)` Set header name to given value
`Map<String,List<String>>`	`headers()` Get all the response headers
`HttpRequest`	`headers(Map<String,String> headers)` Set all headers found in given map where the keys are the header names and the values are the header values
`String[]`	`headers(String name)` Get all values of the given header from the response
`HttpRequest`	`ifModifiedSince(long ifModifiedSince)` Set the 'If-Modified-Since' request header to the given value
`HttpRequest`	`ifNoneMatch(String ifNoneMatch)` Set the 'If-None-Match' request header to the given value
`boolean`	`ignoreCloseExceptions()` Get whether or not exceptions thrown by `Closeable.close()` are ignored
`HttpRequest`	`ignoreCloseExceptions(boolean ignore)` Set whether or not to ignore exceptions that occur from calling `Closeable.close()`
`int`	`intHeader(String name)` Get an integer header from the response falling back to returning -1 if the header is missing or parsing fails
`int`	`intHeader(String name, int defaultValue)` Get an integer header value from the response falling back to the given default value if the header is missing or if parsing fails
`boolean`	`isBodyEmpty()` Is the response body empty?
`static void`	`keepAlive(boolean keepAlive)` Set the 'http.keepAlive' property to the given value.
`long`	`lastModified()` Get the 'Last-Modified' header from the response
`String`	`location()` Get the 'Location' header from the response
`static void`	`maxConnections(int maxConnections)` Set the 'http.maxConnections' property to the given value.
`String`	`message()` Get status message of the response
`String`	`method()` Get the HTTP method of this request
`boolean`	`noContent()` Is the response code a 204 No Content?
`static void`	`nonProxyHosts(String... hosts)` Set the 'http.nonProxyHosts' property to the given host values.
`boolean`	`notFound()` Is the response code a 404 Not Found?
`boolean`	`notModified()` Is the response code a 304 Not Modified?
`boolean`	`ok()` Is the response code a 200 OK?
`protected HttpRequest`	`openOutput()` Open output stream
`static HttpRequest`	`options(CharSequence url)` Start an 'OPTIONS' request to the given URL
`static HttpRequest`	`options(URL url)` Start an 'OPTIONS' request to the given URL
`String`	`parameter(String headerName, String paramName)` Get parameter with given name from header value in response
`Map<String,String>`	`parameters(String headerName)` Get all parameters from header value in response
`HttpRequest`	`part(String name, File part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, InputStream part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, Number part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, File part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, Number part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, String part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, String contentType, File part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, String contentType, InputStream part)` Write part of a multipart request to the request body
`HttpRequest`	`part(String name, String filename, String contentType, String part)` Write part of a multipart request to the request body
`HttpRequest`	`partHeader(String name, String value)` Write a multipart header to the response body
`static HttpRequest`	`post(CharSequence url)` Start a 'POST' request to the given URL
`static HttpRequest`	`post(CharSequence baseUrl, boolean encode, Object... params)` Start a 'POST' request to the given URL along with the query params
`static HttpRequest`	`post(CharSequence baseUrl, Map<?,?> params, boolean encode)` Start a 'POST' request to the given URL along with the query params
`static HttpRequest`	`post(URL url)` Start a 'POST' request to the given URL
`HttpRequest`	`progress(HttpRequest.UploadProgress callback)` Set the UploadProgress callback for this request
`HttpRequest`	`proxyAuthorization(String proxyAuthorization)` Set the 'Proxy-Authorization' header to given value
`HttpRequest`	`proxyBasic(String name, String password)` Set the 'Proxy-Authorization' header to given values in Basic authentication format
`static void`	`proxyHost(String host)` Set the 'http.proxyHost' and 'https.proxyHost' properties to the given host value.
`static void`	`proxyPort(int port)` Set the 'http.proxyPort' and 'https.proxyPort' properties to the given port number.
`static HttpRequest`	`put(CharSequence url)` Start a 'PUT' request to the given URL
`static HttpRequest`	`put(CharSequence baseUrl, boolean encode, Object... params)` Start a 'PUT' request to the given URL along with the query params
`static HttpRequest`	`put(CharSequence baseUrl, Map<?,?> params, boolean encode)` Start a 'PUT' request to the given URL along with the query params
`static HttpRequest`	`put(URL url)` Start a 'PUT' request to the given URL
`InputStreamReader`	`reader()` Get reader to response body using the character set returned from `charset()`
`InputStreamReader`	`reader(String charset)` Get reader to response body using given character set.
`HttpRequest`	`readTimeout(int timeout)` Set read timeout on connection to given value
`HttpRequest`	`receive(Appendable appendable)` Receive response into the given appendable
`HttpRequest`	`receive(File file)` Stream response body to file
`HttpRequest`	`receive(OutputStream output)` Stream response to given output stream
`HttpRequest`	`receive(PrintStream output)` Stream response to given print stream
`HttpRequest`	`receive(Writer writer)` Receive response into the given writer
`HttpRequest`	`referer(String referer)` Set the 'Referer' header to given value
`HttpRequest`	`send(byte[] input)` Write byte array to request body
`HttpRequest`	`send(CharSequence value)` Write char sequence to request body
`HttpRequest`	`send(File input)` Write contents of file to request body
`HttpRequest`	`send(InputStream input)` Write stream to request body
`HttpRequest`	`send(Reader input)` Write reader to request body
`String`	`server()` Get the 'Server' header from the response
`boolean`	`serverError()` Is the response code a 500 Internal Server Error?
`static void`	`setConnectionFactory(HttpRequest.ConnectionFactory connectionFactory)` Specify the `HttpRequest.ConnectionFactory` used to create new requests.
`protected HttpRequest`	`startPart()` Start part of a multipart
`InputStream`	`stream()` Get stream to response body
`String`	`toString()`
`static HttpRequest`	`trace(CharSequence url)` Start a 'TRACE' request to the given URL
`static HttpRequest`	`trace(URL url)` Start a 'TRACE' request to the given URL
`HttpRequest`	`trustAllCerts()` Configure HTTPS connection to trust all certificates
`HttpRequest`	`trustAllHosts()` Configure HTTPS connection to trust all hosts using a custom `HostnameVerifier` that always returns `true` for each host verified
`HttpRequest`	`uncompress(boolean uncompress)` Set whether or not the response body should be automatically uncompressed when read from.
`URL`	`url()` Get the `URL` of this request's connection
`HttpRequest`	`useCaches(boolean useCaches)` Set value of `URLConnection.setUseCaches(boolean)`
`HttpRequest`	`useProxy(String proxyHost, int proxyPort)` Configure an HTTP proxy on this connection.
`HttpRequest`	`userAgent(String userAgent)` Set the 'User-Agent' header to given value
`protected HttpRequest`	`writePartHeader(String name, String filename)` Write part header
`protected HttpRequest`	`writePartHeader(String name, String filename, String contentType)` Write part header
`OutputStreamWriter`	`writer()` Create writer to request output stream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CHARSET_UTF8
```
public static final String CHARSET_UTF8
```
    'UTF-8' charset name
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_FORM
```
public static final String CONTENT_TYPE_FORM
```
    'application/x-www-form-urlencoded' content type header value
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_JSON
```
public static final String CONTENT_TYPE_JSON
```
    'application/json' content type header value
    
    See Also:
    
    Constant Field Values
  - ENCODING_GZIP
```
public static final String ENCODING_GZIP
```
    'gzip' encoding header value
    
    See Also:
    
    Constant Field Values
  - HEADER_ACCEPT
```
public static final String HEADER_ACCEPT
```
    'Accept' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_ACCEPT_CHARSET
```
public static final String HEADER_ACCEPT_CHARSET
```
    'Accept-Charset' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_ACCEPT_ENCODING
```
public static final String HEADER_ACCEPT_ENCODING
```
    'Accept-Encoding' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_AUTHORIZATION
```
public static final String HEADER_AUTHORIZATION
```
    'Authorization' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_CACHE_CONTROL
```
public static final String HEADER_CACHE_CONTROL
```
    'Cache-Control' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_CONTENT_ENCODING
```
public static final String HEADER_CONTENT_ENCODING
```
    'Content-Encoding' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_CONTENT_LENGTH
```
public static final String HEADER_CONTENT_LENGTH
```
    'Content-Length' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_CONTENT_TYPE
```
public static final String HEADER_CONTENT_TYPE
```
    'Content-Type' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_DATE
```
public static final String HEADER_DATE
```
    'Date' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_ETAG
```
public static final String HEADER_ETAG
```
    'ETag' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_EXPIRES
```
public static final String HEADER_EXPIRES
```
    'Expires' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_IF_NONE_MATCH
```
public static final String HEADER_IF_NONE_MATCH
```
    'If-None-Match' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_LAST_MODIFIED
```
public static final String HEADER_LAST_MODIFIED
```
    'Last-Modified' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_LOCATION
```
public static final String HEADER_LOCATION
```
    'Location' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_PROXY_AUTHORIZATION
```
public static final String HEADER_PROXY_AUTHORIZATION
```
    'Proxy-Authorization' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_REFERER
```
public static final String HEADER_REFERER
```
    'Referer' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_SERVER
```
public static final String HEADER_SERVER
```
    'Server' header name
    
    See Also:
    
    Constant Field Values
  - HEADER_USER_AGENT
```
public static final String HEADER_USER_AGENT
```
    'User-Agent' header name
    
    See Also:
    
    Constant Field Values
  - METHOD_DELETE
```
public static final String METHOD_DELETE
```
    'DELETE' request method
    
    See Also:
    
    Constant Field Values
  - METHOD_GET
```
public static final String METHOD_GET
```
    'GET' request method
    
    See Also:
    
    Constant Field Values
  - METHOD_HEAD
```
public static final String METHOD_HEAD
```
    'HEAD' request method
    
    See Also:
    
    Constant Field Values
  - METHOD_OPTIONS
```
public static final String METHOD_OPTIONS
```
    'OPTIONS' options method
    
    See Also:
    
    Constant Field Values
  - METHOD_POST
```
public static final String METHOD_POST
```
    'POST' request method
    
    See Also:
    
    Constant Field Values
  - METHOD_PUT
```
public static final String METHOD_PUT
```
    'PUT' request method
    
    See Also:
    
    Constant Field Values
  - METHOD_TRACE
```
public static final String METHOD_TRACE
```
    'TRACE' request method
    
    See Also:
    
    Constant Field Values
  - PARAM_CHARSET
```
public static final String PARAM_CHARSET
```
    'charset' header value parameter
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpRequest
```
public HttpRequest(CharSequence url,
                   String method)
            throws HttpRequest.HttpRequestException
```
    Create HTTP connection wrapper
    
    Parameters:
    
    url - Remote resource URL.
    
    method - HTTP request method (e.g., "GET", "POST").
    
    Throws:
    
    HttpRequest.HttpRequestException
  - HttpRequest
```
public HttpRequest(URL url,
                   String method)
            throws HttpRequest.HttpRequestException
```
    Create HTTP connection wrapper
    
    Parameters:
    
    url - Remote resource URL.
    
    method - HTTP request method (e.g., "GET", "POST").
    
    Throws:
    
    HttpRequest.HttpRequestException
- Method Detail
  - setConnectionFactory
```
public static void setConnectionFactory(HttpRequest.ConnectionFactory connectionFactory)
```
    Specify the HttpRequest.ConnectionFactory used to create new requests.
  - encode
```
public static String encode(CharSequence url)
                     throws HttpRequest.HttpRequestException
```
    Encode the given URL as an ASCII String
    This method ensures the path and query segments of the URL are properly encoded such as ' ' characters being encoded to '%20' or any UTF-8 characters that are non-ASCII. No encoding of URLs is done by default by the HttpRequest constructors and so if URL encoding is needed this method should be called before calling the HttpRequest constructor.
    
    Parameters:
    
    url -
    
    Returns:
    
    encoded URL
    
    Throws:
    
    HttpRequest.HttpRequestException
  - append
```
public static String append(CharSequence url,
                            Map<?,?> params)
```
    Append given map as query parameters to the base URL
    Each map entry's key will be a parameter name and the value's Object.toString() will be the parameter value.
    
    Parameters:
    
    url -
    
    params -
    
    Returns:
    
    URL with appended query params
  - append
```
public static String append(CharSequence url,
                            Object... params)
```
    Append given name/value pairs as query parameters to the base URL
    The params argument is interpreted as a sequence of name/value pairs so the given number of params must be divisible by 2.
    
    Parameters:
    
    url -
    
    params - name/value pairs
    
    Returns:
    
    URL with appended query params
  - get
```
public static HttpRequest get(CharSequence url)
                       throws HttpRequest.HttpRequestException
```
    Start a 'GET' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - get
```
public static HttpRequest get(URL url)
                       throws HttpRequest.HttpRequestException
```
    Start a 'GET' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - get
```
public static HttpRequest get(CharSequence baseUrl,
                              Map<?,?> params,
                              boolean encode)
```
    Start a 'GET' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    params - The query parameters to include as part of the baseUrl
    
    encode - true to encode the full URL
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Map), encode(CharSequence)
  - get
```
public static HttpRequest get(CharSequence baseUrl,
                              boolean encode,
                              Object... params)
```
    Start a 'GET' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    encode - true to encode the full URL
    
    params - the name/value query parameter pairs to include as part of the baseUrl
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Object...), encode(CharSequence)
  - post
```
public static HttpRequest post(CharSequence url)
                        throws HttpRequest.HttpRequestException
```
    Start a 'POST' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - post
```
public static HttpRequest post(URL url)
                        throws HttpRequest.HttpRequestException
```
    Start a 'POST' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - post
```
public static HttpRequest post(CharSequence baseUrl,
                               Map<?,?> params,
                               boolean encode)
```
    Start a 'POST' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    params - the query parameters to include as part of the baseUrl
    
    encode - true to encode the full URL
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Map), encode(CharSequence)
  - post
```
public static HttpRequest post(CharSequence baseUrl,
                               boolean encode,
                               Object... params)
```
    Start a 'POST' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    encode - true to encode the full URL
    
    params - the name/value query parameter pairs to include as part of the baseUrl
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Object...), encode(CharSequence)
  - put
```
public static HttpRequest put(CharSequence url)
                       throws HttpRequest.HttpRequestException
```
    Start a 'PUT' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - put
```
public static HttpRequest put(URL url)
                       throws HttpRequest.HttpRequestException
```
    Start a 'PUT' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - put
```
public static HttpRequest put(CharSequence baseUrl,
                              Map<?,?> params,
                              boolean encode)
```
    Start a 'PUT' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    params - the query parameters to include as part of the baseUrl
    
    encode - true to encode the full URL
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Map), encode(CharSequence)
  - put
```
public static HttpRequest put(CharSequence baseUrl,
                              boolean encode,
                              Object... params)
```
    Start a 'PUT' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    encode - true to encode the full URL
    
    params - the name/value query parameter pairs to include as part of the baseUrl
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Object...), encode(CharSequence)
  - delete
```
public static HttpRequest delete(CharSequence url)
                          throws HttpRequest.HttpRequestException
```
    Start a 'DELETE' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - delete
```
public static HttpRequest delete(URL url)
                          throws HttpRequest.HttpRequestException
```
    Start a 'DELETE' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - delete
```
public static HttpRequest delete(CharSequence baseUrl,
                                 Map<?,?> params,
                                 boolean encode)
```
    Start a 'DELETE' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    params - The query parameters to include as part of the baseUrl
    
    encode - true to encode the full URL
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Map), encode(CharSequence)
  - delete
```
public static HttpRequest delete(CharSequence baseUrl,
                                 boolean encode,
                                 Object... params)
```
    Start a 'DELETE' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    encode - true to encode the full URL
    
    params - the name/value query parameter pairs to include as part of the baseUrl
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Object...), encode(CharSequence)
  - head
```
public static HttpRequest head(CharSequence url)
                        throws HttpRequest.HttpRequestException
```
    Start a 'HEAD' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - head
```
public static HttpRequest head(URL url)
                        throws HttpRequest.HttpRequestException
```
    Start a 'HEAD' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - head
```
public static HttpRequest head(CharSequence baseUrl,
                               Map<?,?> params,
                               boolean encode)
```
    Start a 'HEAD' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    params - The query parameters to include as part of the baseUrl
    
    encode - true to encode the full URL
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Map), encode(CharSequence)
  - head
```
public static HttpRequest head(CharSequence baseUrl,
                               boolean encode,
                               Object... params)
```
    Start a 'GET' request to the given URL along with the query params
    
    Parameters:
    
    baseUrl -
    
    encode - true to encode the full URL
    
    params - the name/value query parameter pairs to include as part of the baseUrl
    
    Returns:
    
    request
    
    See Also:
    
    append(CharSequence, Object...), encode(CharSequence)
  - options
```
public static HttpRequest options(CharSequence url)
                           throws HttpRequest.HttpRequestException
```
    Start an 'OPTIONS' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - options
```
public static HttpRequest options(URL url)
                           throws HttpRequest.HttpRequestException
```
    Start an 'OPTIONS' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - trace
```
public static HttpRequest trace(CharSequence url)
                         throws HttpRequest.HttpRequestException
```
    Start a 'TRACE' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - trace
```
public static HttpRequest trace(URL url)
                         throws HttpRequest.HttpRequestException
```
    Start a 'TRACE' request to the given URL
    
    Parameters:
    
    url -
    
    Returns:
    
    request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - keepAlive
```
public static void keepAlive(boolean keepAlive)
```
    Set the 'http.keepAlive' property to the given value.
    This setting will apply to all requests.
    
    Parameters:
    
    keepAlive -
  - maxConnections
```
public static void maxConnections(int maxConnections)
```
    Set the 'http.maxConnections' property to the given value.
    This setting will apply to all requests.
    
    Parameters:
    
    maxConnections -
  - proxyHost
```
public static void proxyHost(String host)
```
    Set the 'http.proxyHost' and 'https.proxyHost' properties to the given host value.
    This setting will apply to all requests.
    
    Parameters:
    
    host -
  - proxyPort
```
public static void proxyPort(int port)
```
    Set the 'http.proxyPort' and 'https.proxyPort' properties to the given port number.
    This setting will apply to all requests.
    
    Parameters:
    
    port -
  - nonProxyHosts
```
public static void nonProxyHosts(String... hosts)
```
    Set the 'http.nonProxyHosts' property to the given host values.
    Hosts will be separated by a '|' character.
    This setting will apply to all requests.
    
    Parameters:
    
    hosts -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getConnection
```
public HttpURLConnection getConnection()
```
    Get underlying connection
    
    Returns:
    
    connection
  - ignoreCloseExceptions
```
public HttpRequest ignoreCloseExceptions(boolean ignore)
```
    Set whether or not to ignore exceptions that occur from calling Closeable.close()
    The default value of this setting is true
    
    Parameters:
    
    ignore -
    
    Returns:
    
    this request
  - ignoreCloseExceptions
```
public boolean ignoreCloseExceptions()
```
    Get whether or not exceptions thrown by Closeable.close() are ignored
    
    Returns:
    
    true if ignoring, false if throwing
  - code
```
public int code()
         throws HttpRequest.HttpRequestException
```
    Get the status code of the response
    
    Returns:
    
    the response code
    
    Throws:
    
    HttpRequest.HttpRequestException
  - code
```
public HttpRequest code(AtomicInteger output)
                 throws HttpRequest.HttpRequestException
```
    Set the value of the given AtomicInteger to the status code of the response
    
    Parameters:
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - ok
```
public boolean ok()
           throws HttpRequest.HttpRequestException
```
    Is the response code a 200 OK?
    
    Returns:
    
    true if 200, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - created
```
public boolean created()
                throws HttpRequest.HttpRequestException
```
    Is the response code a 201 Created?
    
    Returns:
    
    true if 201, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - noContent
```
public boolean noContent()
                  throws HttpRequest.HttpRequestException
```
    Is the response code a 204 No Content?
    
    Returns:
    
    true if 204, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - serverError
```
public boolean serverError()
                    throws HttpRequest.HttpRequestException
```
    Is the response code a 500 Internal Server Error?
    
    Returns:
    
    true if 500, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - badRequest
```
public boolean badRequest()
                   throws HttpRequest.HttpRequestException
```
    Is the response code a 400 Bad Request?
    
    Returns:
    
    true if 400, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - notFound
```
public boolean notFound()
                 throws HttpRequest.HttpRequestException
```
    Is the response code a 404 Not Found?
    
    Returns:
    
    true if 404, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - notModified
```
public boolean notModified()
                    throws HttpRequest.HttpRequestException
```
    Is the response code a 304 Not Modified?
    
    Returns:
    
    true if 304, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - message
```
public String message()
               throws HttpRequest.HttpRequestException
```
    Get status message of the response
    
    Returns:
    
    message
    
    Throws:
    
    HttpRequest.HttpRequestException
  - disconnect
```
public HttpRequest disconnect()
```
    Disconnect the connection
    
    Returns:
    
    this request
  - chunk
```
public HttpRequest chunk(int size)
```
    Set chunked streaming mode to the given size
    
    Parameters:
    
    size -
    
    Returns:
    
    this request
  - bufferSize
```
public HttpRequest bufferSize(int size)
```
    Set the size used when buffering and copying between streams
    This size is also used for send and receive buffers created for both char and byte arrays
    The default buffer size is 8,192 bytes
    
    Parameters:
    
    size -
    
    Returns:
    
    this request
  - bufferSize
```
public int bufferSize()
```
    Get the configured buffer size
    The default buffer size is 8,192 bytes
    
    Returns:
    
    buffer size
  - uncompress
```
public HttpRequest uncompress(boolean uncompress)
```
    Set whether or not the response body should be automatically uncompressed when read from.
    This will only affect requests that have the 'Content-Encoding' response header set to 'gzip'.
    This causes all receive methods to use a GZIPInputStream when applicable so that higher level streams and readers can read the data uncompressed.
    Setting this option does not cause any request headers to be set automatically so acceptGzipEncoding() should be used in conjunction with this setting to tell the server to gzip the response.
    
    Parameters:
    
    uncompress -
    
    Returns:
    
    this request
  - byteStream
```
protected ByteArrayOutputStream byteStream()
```
    Create byte array output stream
    
    Returns:
    
    stream
  - body
```
public String body(String charset)
            throws HttpRequest.HttpRequestException
```
    Get response as String in given character set
    This will fall back to using the UTF-8 character set if the given charset is null
    
    Parameters:
    
    charset -
    
    Returns:
    
    string
    
    Throws:
    
    HttpRequest.HttpRequestException
  - body
```
public String body()
            throws HttpRequest.HttpRequestException
```
    Get response as String using character set returned from charset()
    
    Returns:
    
    string
    
    Throws:
    
    HttpRequest.HttpRequestException
  - body
```
public HttpRequest body(AtomicReference<String> output)
                 throws HttpRequest.HttpRequestException
```
    Get the response body as a String and set it as the value of the given reference.
    
    Parameters:
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - body
```
public HttpRequest body(AtomicReference<String> output,
                        String charset)
                 throws HttpRequest.HttpRequestException
```
    Get the response body as a String and set it as the value of the given reference.
    
    Parameters:
    
    output -
    
    charset -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - isBodyEmpty
```
public boolean isBodyEmpty()
                    throws HttpRequest.HttpRequestException
```
    Is the response body empty?
    
    Returns:
    
    true if the Content-Length response header is 0, false otherwise
    
    Throws:
    
    HttpRequest.HttpRequestException
  - bytes
```
public byte[] bytes()
             throws HttpRequest.HttpRequestException
```
    Get response as byte array
    
    Returns:
    
    byte array
    
    Throws:
    
    HttpRequest.HttpRequestException
  - buffer
```
public BufferedInputStream buffer()
                           throws HttpRequest.HttpRequestException
```
    Get response in a buffered stream
    
    Returns:
    
    stream
    
    Throws:
    
    HttpRequest.HttpRequestException
    
    See Also:
    
    bufferSize(int)
  - stream
```
public InputStream stream()
                   throws HttpRequest.HttpRequestException
```
    Get stream to response body
    
    Returns:
    
    stream
    
    Throws:
    
    HttpRequest.HttpRequestException
  - reader
```
public InputStreamReader reader(String charset)
                         throws HttpRequest.HttpRequestException
```
    Get reader to response body using given character set.
    This will fall back to using the UTF-8 character set if the given charset is null
    
    Parameters:
    
    charset -
    
    Returns:
    
    reader
    
    Throws:
    
    HttpRequest.HttpRequestException
  - reader
```
public InputStreamReader reader()
                         throws HttpRequest.HttpRequestException
```
    Get reader to response body using the character set returned from charset()
    
    Returns:
    
    reader
    
    Throws:
    
    HttpRequest.HttpRequestException
  - bufferedReader
```
public BufferedReader bufferedReader(String charset)
                              throws HttpRequest.HttpRequestException
```
    Get buffered reader to response body using the given character set r and the configured buffer size
    
    Parameters:
    
    charset -
    
    Returns:
    
    reader
    
    Throws:
    
    HttpRequest.HttpRequestException
    
    See Also:
    
    bufferSize(int)
  - bufferedReader
```
public BufferedReader bufferedReader()
                              throws HttpRequest.HttpRequestException
```
    Get buffered reader to response body using the character set returned from charset() and the configured buffer size
    
    Returns:
    
    reader
    
    Throws:
    
    HttpRequest.HttpRequestException
    
    See Also:
    
    bufferSize(int)
  - receive
```
public HttpRequest receive(File file)
                    throws HttpRequest.HttpRequestException
```
    Stream response body to file
    
    Parameters:
    
    file -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - receive
```
public HttpRequest receive(OutputStream output)
                    throws HttpRequest.HttpRequestException
```
    Stream response to given output stream
    
    Parameters:
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - receive
```
public HttpRequest receive(PrintStream output)
                    throws HttpRequest.HttpRequestException
```
    Stream response to given print stream
    
    Parameters:
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - receive
```
public HttpRequest receive(Appendable appendable)
                    throws HttpRequest.HttpRequestException
```
    Receive response into the given appendable
    
    Parameters:
    
    appendable -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - receive
```
public HttpRequest receive(Writer writer)
                    throws HttpRequest.HttpRequestException
```
    Receive response into the given writer
    
    Parameters:
    
    writer -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - readTimeout
```
public HttpRequest readTimeout(int timeout)
```
    Set read timeout on connection to given value
    
    Parameters:
    
    timeout -
    
    Returns:
    
    this request
  - connectTimeout
```
public HttpRequest connectTimeout(int timeout)
```
    Set connect timeout on connection to given value
    
    Parameters:
    
    timeout -
    
    Returns:
    
    this request
  - header
```
public HttpRequest header(String name,
                          String value)
```
    Set header name to given value
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    this request
  - header
```
public HttpRequest header(String name,
                          Number value)
```
    Set header name to given value
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    this request
  - headers
```
public HttpRequest headers(Map<String,String> headers)
```
    Set all headers found in given map where the keys are the header names and the values are the header values
    
    Parameters:
    
    headers -
    
    Returns:
    
    this request
  - header
```
public HttpRequest header(Map.Entry<String,String> header)
```
    Set header to have given entry's key as the name and value as the value
    
    Parameters:
    
    header -
    
    Returns:
    
    this request
  - header
```
public String header(String name)
              throws HttpRequest.HttpRequestException
```
    Get a response header
    
    Parameters:
    
    name -
    
    Returns:
    
    response header
    
    Throws:
    
    HttpRequest.HttpRequestException
  - headers
```
public Map<String,List<String>> headers()
                                 throws HttpRequest.HttpRequestException
```
    Get all the response headers
    
    Returns:
    
    map of response header names to their value(s)
    
    Throws:
    
    HttpRequest.HttpRequestException
  - dateHeader
```
public long dateHeader(String name)
                throws HttpRequest.HttpRequestException
```
    Get a date header from the response falling back to returning -1 if the header is missing or parsing fails
    
    Parameters:
    
    name -
    
    Returns:
    
    date, -1 on failures
    
    Throws:
    
    HttpRequest.HttpRequestException
  - dateHeader
```
public long dateHeader(String name,
                       long defaultValue)
                throws HttpRequest.HttpRequestException
```
    Get a date header from the response falling back to returning the given default value if the header is missing or parsing fails
    
    Parameters:
    
    name -
    
    defaultValue -
    
    Returns:
    
    date, default value on failures
    
    Throws:
    
    HttpRequest.HttpRequestException
  - intHeader
```
public int intHeader(String name)
              throws HttpRequest.HttpRequestException
```
    Get an integer header from the response falling back to returning -1 if the header is missing or parsing fails
    
    Parameters:
    
    name -
    
    Returns:
    
    header value as an integer, -1 when missing or parsing fails
    
    Throws:
    
    HttpRequest.HttpRequestException
  - intHeader
```
public int intHeader(String name,
                     int defaultValue)
              throws HttpRequest.HttpRequestException
```
    Get an integer header value from the response falling back to the given default value if the header is missing or if parsing fails
    
    Parameters:
    
    name -
    
    defaultValue -
    
    Returns:
    
    header value as an integer, default value when missing or parsing fails
    
    Throws:
    
    HttpRequest.HttpRequestException
  - headers
```
public String[] headers(String name)
```
    Get all values of the given header from the response
    
    Parameters:
    
    name -
    
    Returns:
    
    non-null but possibly empty array of String header values
  - parameter
```
public String parameter(String headerName,
                        String paramName)
```
    Get parameter with given name from header value in response
    
    Parameters:
    
    headerName -
    
    paramName -
    
    Returns:
    
    parameter value or null if missing
  - parameters
```
public Map<String,String> parameters(String headerName)
```
    Get all parameters from header value in response
    This will be all key=value pairs after the first ';' that are separated by a ';'
    
    Parameters:
    
    headerName -
    
    Returns:
    
    non-null but possibly empty map of parameter headers
  - getParams
```
protected Map<String,String> getParams(String header)
```
    Get parameter values from header value
    
    Parameters:
    
    header -
    
    Returns:
    
    parameter value or null if none
  - getParam
```
protected String getParam(String value,
                          String paramName)
```
    Get parameter value from header value
    
    Parameters:
    
    value -
    
    paramName -
    
    Returns:
    
    parameter value or null if none
  - charset
```
public String charset()
```
    Get 'charset' parameter from 'Content-Type' response header
    
    Returns:
    
    charset or null if none
  - userAgent
```
public HttpRequest userAgent(String userAgent)
```
    Set the 'User-Agent' header to given value
    
    Parameters:
    
    userAgent -
    
    Returns:
    
    this request
  - referer
```
public HttpRequest referer(String referer)
```
    Set the 'Referer' header to given value
    
    Parameters:
    
    referer -
    
    Returns:
    
    this request
  - useCaches
```
public HttpRequest useCaches(boolean useCaches)
```
    Set value of URLConnection.setUseCaches(boolean)
    
    Parameters:
    
    useCaches -
    
    Returns:
    
    this request
  - acceptEncoding
```
public HttpRequest acceptEncoding(String acceptEncoding)
```
    Set the 'Accept-Encoding' header to given value
    
    Parameters:
    
    acceptEncoding -
    
    Returns:
    
    this request
  - acceptGzipEncoding
```
public HttpRequest acceptGzipEncoding()
```
    Set the 'Accept-Encoding' header to 'gzip'
    
    Returns:
    
    this request
    
    See Also:
    
    uncompress(boolean)
  - acceptCharset
```
public HttpRequest acceptCharset(String acceptCharset)
```
    Set the 'Accept-Charset' header to given value
    
    Parameters:
    
    acceptCharset -
    
    Returns:
    
    this request
  - contentEncoding
```
public String contentEncoding()
```
    Get the 'Content-Encoding' header from the response
    
    Returns:
    
    this request
  - server
```
public String server()
```
    Get the 'Server' header from the response
    
    Returns:
    
    server
  - date
```
public long date()
```
    Get the 'Date' header from the response
    
    Returns:
    
    date value, -1 on failures
  - cacheControl
```
public String cacheControl()
```
    Get the 'Cache-Control' header from the response
    
    Returns:
    
    cache control
  - eTag
```
public String eTag()
```
    Get the 'ETag' header from the response
    
    Returns:
    
    entity tag
  - expires
```
public long expires()
```
    Get the 'Expires' header from the response
    
    Returns:
    
    expires value, -1 on failures
  - lastModified
```
public long lastModified()
```
    Get the 'Last-Modified' header from the response
    
    Returns:
    
    last modified value, -1 on failures
  - location
```
public String location()
```
    Get the 'Location' header from the response
    
    Returns:
    
    location
  - authorization
```
public HttpRequest authorization(String authorization)
```
    Set the 'Authorization' header to given value
    
    Parameters:
    
    authorization -
    
    Returns:
    
    this request
  - proxyAuthorization
```
public HttpRequest proxyAuthorization(String proxyAuthorization)
```
    Set the 'Proxy-Authorization' header to given value
    
    Parameters:
    
    proxyAuthorization -
    
    Returns:
    
    this request
  - basic
```
public HttpRequest basic(String name,
                         String password)
```
    Set the 'Authorization' header to given values in Basic authentication format
    
    Parameters:
    
    name -
    
    password -
    
    Returns:
    
    this request
  - proxyBasic
```
public HttpRequest proxyBasic(String name,
                              String password)
```
    Set the 'Proxy-Authorization' header to given values in Basic authentication format
    
    Parameters:
    
    name -
    
    password -
    
    Returns:
    
    this request
  - ifModifiedSince
```
public HttpRequest ifModifiedSince(long ifModifiedSince)
```
    Set the 'If-Modified-Since' request header to the given value
    
    Parameters:
    
    ifModifiedSince -
    
    Returns:
    
    this request
  - ifNoneMatch
```
public HttpRequest ifNoneMatch(String ifNoneMatch)
```
    Set the 'If-None-Match' request header to the given value
    
    Parameters:
    
    ifNoneMatch -
    
    Returns:
    
    this request
  - contentType
```
public HttpRequest contentType(String contentType)
```
    Set the 'Content-Type' request header to the given value
    
    Parameters:
    
    contentType -
    
    Returns:
    
    this request
  - contentType
```
public HttpRequest contentType(String contentType,
                               String charset)
```
    Set the 'Content-Type' request header to the given value and charset
    
    Parameters:
    
    contentType -
    
    charset -
    
    Returns:
    
    this request
  - contentType
```
public String contentType()
```
    Get the 'Content-Type' header from the response
    
    Returns:
    
    response header value
  - contentLength
```
public int contentLength()
```
    Get the 'Content-Length' header from the response
    
    Returns:
    
    response header value
  - contentLength
```
public HttpRequest contentLength(String contentLength)
```
    Set the 'Content-Length' request header to the given value
    
    Parameters:
    
    contentLength -
    
    Returns:
    
    this request
  - contentLength
```
public HttpRequest contentLength(int contentLength)
```
    Set the 'Content-Length' request header to the given value
    
    Parameters:
    
    contentLength -
    
    Returns:
    
    this request
  - accept
```
public HttpRequest accept(String accept)
```
    Set the 'Accept' header to given value
    
    Parameters:
    
    accept -
    
    Returns:
    
    this request
  - acceptJson
```
public HttpRequest acceptJson()
```
    Set the 'Accept' header to 'application/json'
    
    Returns:
    
    this request
  - copy
```
protected HttpRequest copy(InputStream input,
                           OutputStream output)
                    throws IOException
```
    Copy from input stream to output stream
    
    Parameters:
    
    input -
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - copy
```
protected HttpRequest copy(Reader input,
                           Writer output)
                    throws IOException
```
    Copy from reader to writer
    
    Parameters:
    
    input -
    
    output -
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - progress
```
public HttpRequest progress(HttpRequest.UploadProgress callback)
```
    Set the UploadProgress callback for this request
    
    Parameters:
    
    callback -
    
    Returns:
    
    this request
  - closeOutput
```
protected HttpRequest closeOutput()
                           throws IOException
```
    Close output stream
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
    
    IOException
  - closeOutputQuietly
```
protected HttpRequest closeOutputQuietly()
                                  throws HttpRequest.HttpRequestException
```
    Call closeOutput() and re-throw a caught IOExceptions as an HttpRequest.HttpRequestException
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - openOutput
```
protected HttpRequest openOutput()
                          throws IOException
```
    Open output stream
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - startPart
```
protected HttpRequest startPart()
                         throws IOException
```
    Start part of a multipart
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - writePartHeader
```
protected HttpRequest writePartHeader(String name,
                                      String filename)
                               throws IOException
```
    Write part header
    
    Parameters:
    
    name -
    
    filename -
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - writePartHeader
```
protected HttpRequest writePartHeader(String name,
                                      String filename,
                                      String contentType)
                               throws IOException
```
    Write part header
    
    Parameters:
    
    name -
    
    filename -
    
    contentType -
    
    Returns:
    
    this request
    
    Throws:
    
    IOException
  - part
```
public HttpRequest part(String name,
                        String part)
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    part -
    
    Returns:
    
    this request
  - part
```
public HttpRequest part(String name,
                        String filename,
                        String part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        String filename,
                        String contentType,
                        String part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    contentType - value of the Content-Type part header
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        Number part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        String filename,
                        Number part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        File part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        String filename,
                        File part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        String filename,
                        String contentType,
                        File part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    contentType - value of the Content-Type part header
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        InputStream part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - part
```
public HttpRequest part(String name,
                        String filename,
                        String contentType,
                        InputStream part)
                 throws HttpRequest.HttpRequestException
```
    Write part of a multipart request to the request body
    
    Parameters:
    
    name -
    
    filename -
    
    contentType - value of the Content-Type part header
    
    part -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - partHeader
```
public HttpRequest partHeader(String name,
                              String value)
                       throws HttpRequest.HttpRequestException
```
    Write a multipart header to the response body
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - send
```
public HttpRequest send(File input)
                 throws HttpRequest.HttpRequestException
```
    Write contents of file to request body
    
    Parameters:
    
    input -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - send
```
public HttpRequest send(byte[] input)
                 throws HttpRequest.HttpRequestException
```
    Write byte array to request body
    
    Parameters:
    
    input -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - send
```
public HttpRequest send(InputStream input)
                 throws HttpRequest.HttpRequestException
```
    Write stream to request body
    The given stream will be closed once sending completes
    
    Parameters:
    
    input -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - send
```
public HttpRequest send(Reader input)
                 throws HttpRequest.HttpRequestException
```
    Write reader to request body
    The given reader will be closed once sending completes
    
    Parameters:
    
    input -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - send
```
public HttpRequest send(CharSequence value)
                 throws HttpRequest.HttpRequestException
```
    Write char sequence to request body
    The charset configured via contentType(String) will be used and UTF-8 will be used if it is unset.
    
    Parameters:
    
    value -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - writer
```
public OutputStreamWriter writer()
                          throws HttpRequest.HttpRequestException
```
    Create writer to request output stream
    
    Returns:
    
    writer
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Map<?,?> values)
                 throws HttpRequest.HttpRequestException
```
    Write the values in the map as form data to the request body
    The pairs specified will be URL-encoded in UTF-8 and sent with the 'application/x-www-form-urlencoded' content-type
    
    Parameters:
    
    values -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Map.Entry<?,?> entry)
                 throws HttpRequest.HttpRequestException
```
    Write the key and value in the entry as form data to the request body
    The pair specified will be URL-encoded in UTF-8 and sent with the 'application/x-www-form-urlencoded' content-type
    
    Parameters:
    
    entry -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Map.Entry<?,?> entry,
                        String charset)
                 throws HttpRequest.HttpRequestException
```
    Write the key and value in the entry as form data to the request body
    The pair specified will be URL-encoded and sent with the 'application/x-www-form-urlencoded' content-type
    
    Parameters:
    
    entry -
    
    charset -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Object name,
                        Object value)
                 throws HttpRequest.HttpRequestException
```
    Write the name/value pair as form data to the request body
    The pair specified will be URL-encoded in UTF-8 and sent with the 'application/x-www-form-urlencoded' content-type
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Object name,
                        Object value,
                        String charset)
                 throws HttpRequest.HttpRequestException
```
    Write the name/value pair as form data to the request body
    The values specified will be URL-encoded and sent with the 'application/x-www-form-urlencoded' content-type
    
    Parameters:
    
    name -
    
    value -
    
    charset -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - form
```
public HttpRequest form(Map<?,?> values,
                        String charset)
                 throws HttpRequest.HttpRequestException
```
    Write the values in the map as encoded form data to the request body
    
    Parameters:
    
    values -
    
    charset -
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - trustAllCerts
```
public HttpRequest trustAllCerts()
                          throws HttpRequest.HttpRequestException
```
    Configure HTTPS connection to trust all certificates
    This method does nothing if the current request is not a HTTPS request
    
    Returns:
    
    this request
    
    Throws:
    
    HttpRequest.HttpRequestException
  - trustAllHosts
```
public HttpRequest trustAllHosts()
```
    Configure HTTPS connection to trust all hosts using a custom HostnameVerifier that always returns true for each host verified
    This method does nothing if the current request is not a HTTPS request
    
    Returns:
    
    this request
  - url
```
public URL url()
```
    Get the URL of this request's connection
    
    Returns:
    
    request URL
  - method
```
public String method()
```
    Get the HTTP method of this request
    
    Returns:
    
    method
  - useProxy
```
public HttpRequest useProxy(String proxyHost,
                            int proxyPort)
```
    Configure an HTTP proxy on this connection. Use {proxyBasic(String, String) if this proxy requires basic authentication.
    
    Parameters:
    
    proxyHost -
    
    proxyPort -
    
    Returns:
    
    this request
  - followRedirects
```
public HttpRequest followRedirects(boolean followRedirects)
```
    Set whether or not the underlying connection should follow redirects in the response.
    
    Parameters:
    
    followRedirects - - true fo follow redirects, false to not.
    
    Returns:
    
    this request

Class HttpRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARSET_UTF8

CONTENT_TYPE_FORM

CONTENT_TYPE_JSON

ENCODING_GZIP

HEADER_ACCEPT

HEADER_ACCEPT_CHARSET

HEADER_ACCEPT_ENCODING

HEADER_AUTHORIZATION

HEADER_CACHE_CONTROL

HEADER_CONTENT_ENCODING

HEADER_CONTENT_LENGTH

HEADER_CONTENT_TYPE

HEADER_DATE

HEADER_ETAG

HEADER_EXPIRES

HEADER_IF_NONE_MATCH

HEADER_LAST_MODIFIED

HEADER_LOCATION

HEADER_PROXY_AUTHORIZATION

HEADER_REFERER

HEADER_SERVER

HEADER_USER_AGENT

METHOD_DELETE

METHOD_GET

METHOD_HEAD

METHOD_OPTIONS

METHOD_POST

METHOD_PUT

METHOD_TRACE

PARAM_CHARSET

Constructor Detail

HttpRequest

HttpRequest

Method Detail

setConnectionFactory

encode

append

append

get

get

get

get

post

post

post

post

put

put

put

put

delete

delete

delete

delete

head

head

head

head

options

options

trace

trace

keepAlive

maxConnections

proxyHost

proxyPort

nonProxyHosts

toString

getConnection

ignoreCloseExceptions

ignoreCloseExceptions

code

code