Package arc.util

Class Http.HttpRequest

java.lang.Object

arc.util.Http.HttpRequest

Enclosing class:

Http

public static class Http.HttpRequest
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	content	The content to be used in the HTTP request: A string encoded in the corresponding Content-Encoding set in the headers, with the data to send with the HTTP request.
long	contentLength	Length of the content stream.
InputStream	contentStream	The content as a stream to be used for a POST for example, to transmit custom data.
Cons<Throwable>	errorHandler	Handler for 4xx + 5xx errors, as well as exceptions thrown during connection.
boolean	followRedirects	Sets whether 301 and 302 redirects are followed.
ObjectMap<String,String>	headers
boolean	includeCredentials	Whether a cross-origin request will include credentials.
Http.HttpMethod	method
int	timeout	The time to wait for the HTTP request to be processed, use 0 to block until it is done.
String	url	The URL to send this request to.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpRequest()
protected	HttpRequest(Http.HttpMethod method)

Method Summary

Modifier and Type	Method	Description
void	block(ConsT<Http.HttpResponse,Exception> success)	Blocks until this request is done.
Http.HttpRequest	content(InputStream contentStream, long contentLength)
Http.HttpRequest	content(String content)
Http.HttpRequest	credentials(boolean includeCredentials)
Http.HttpRequest	error(Cons<Throwable> failed)
Http.HttpRequest	header(String name, String value)
Http.HttpRequest	method(Http.HttpMethod method)
Http.HttpRequest	redirects(boolean followRedirects)
void	submit(ConsT<Http.HttpResponse,Exception> success)	Submits this request asynchronously.
Http.HttpRequest	timeout(int timeout)
Http.HttpRequest	url(String url)

Methods inherited from class java.lang.Object

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

Field Details

method

public Http.HttpMethod method

url

public String url

The URL to send this request to.

headers

public ObjectMap<String,String> headers

timeout

public int timeout

The time to wait for the HTTP request to be processed, use 0 to block until it is done. The timeout is used for both the timeout when establishing TCP connection, and the timeout until the first byte of data is received.

content

public String content

The content to be used in the HTTP request: A string encoded in the corresponding Content-Encoding set in the headers, with the data to send with the HTTP request. For example, in case of HTTP GET, the content is used as the query string of the GET while on a HTTP POST it is used to send the POST data.

contentStream

public InputStream contentStream

The content as a stream to be used for a POST for example, to transmit custom data.

contentLength

public long contentLength

Length of the content stream.

followRedirects

public boolean followRedirects

Sets whether 301 and 302 redirects are followed. By default true. Can't be changed in the web backend because this uses XmlHttpRequests which always redirect.

includeCredentials

public boolean includeCredentials

Whether a cross-origin request will include credentials. Default: false

errorHandler

public Cons<Throwable> errorHandler

Handler for 4xx + 5xx errors, as well as exceptions thrown during connection.

Constructor Details

HttpRequest

protected HttpRequest()

HttpRequest

protected HttpRequest(Http.HttpMethod method)

Method Details

error

public Http.HttpRequest error(Cons<Throwable> failed)

method

public Http.HttpRequest method(Http.HttpMethod method)

url

public Http.HttpRequest url(String url)

timeout

public Http.HttpRequest timeout(int timeout)

redirects

public Http.HttpRequest redirects(boolean followRedirects)

credentials

public Http.HttpRequest credentials(boolean includeCredentials)

header

public Http.HttpRequest header(String name,
 String value)

content

public Http.HttpRequest content(String content)

content

public Http.HttpRequest content(InputStream contentStream,
 long contentLength)

submit

public void submit(ConsT<Http.HttpResponse,Exception> success)

Submits this request asynchronously.

block

public void block(ConsT<Http.HttpResponse,Exception> success)

Blocks until this request is done.