public class HttpRequestBuilder extends Object
Net.HttpRequest
s.
Make sure to call newRequest()
first, then set the request up and obtain it via build()
when you are done.
It also offers a few utility methods to deal with content encoding and HTTP headers.Modifier and Type | Field and Description |
---|---|
static String |
baseUrl
Will be added as a prefix to each URL when
url(String) is called. |
static int |
defaultTimeout
Will be set for each new HttpRequest.
|
static Json |
json
Will be used for the object serialization in case
jsonContent(Object) is called. |
Constructor and Description |
---|
HttpRequestBuilder() |
Modifier and Type | Method and Description |
---|---|
HttpRequestBuilder |
basicAuthentication(String username,
String password)
Sets the
Authorization header via the Base64 encoded username and password. |
Net.HttpRequest |
build()
Returns the
Net.HttpRequest that has been setup by this builder so far. |
HttpRequestBuilder |
content(InputStream contentStream,
long contentLength) |
HttpRequestBuilder |
content(String content) |
HttpRequestBuilder |
followRedirects(boolean followRedirects) |
HttpRequestBuilder |
formEncodedContent(Map<String,String> content)
Sets the correct
ContentType and encodes the given parameter map, then sets it as the content. |
HttpRequestBuilder |
header(String name,
String value) |
HttpRequestBuilder |
jsonContent(Object content)
Sets the correct
ContentType and encodes the given content object via json , then sets it as the content. |
HttpRequestBuilder |
method(String httpMethod) |
HttpRequestBuilder |
newRequest()
Initializes the builder and sets it up to build a new
Net.HttpRequest . |
HttpRequestBuilder |
timeout(int timeOut)
If this method is not called, the
defaultTimeout will be used. |
HttpRequestBuilder |
url(String url)
The
baseUrl will automatically be added as a prefix to the given URL. |
public static String baseUrl
url(String)
is called. Empty by default.public static int defaultTimeout
1000
. Can be overwritten via timeout(int)
.public static Json json
jsonContent(Object)
is called.public HttpRequestBuilder newRequest()
Net.HttpRequest
.public HttpRequestBuilder method(String httpMethod)
Net.HttpRequest.setMethod(String)
public HttpRequestBuilder url(String url)
baseUrl
will automatically be added as a prefix to the given URL.Net.HttpRequest.setUrl(String)
public HttpRequestBuilder timeout(int timeOut)
defaultTimeout
will be used.Net.HttpRequest.setTimeOut(int)
public HttpRequestBuilder followRedirects(boolean followRedirects)
public HttpRequestBuilder header(String name, String value)
public HttpRequestBuilder content(String content)
Net.HttpRequest.setContent(String)
public HttpRequestBuilder content(InputStream contentStream, long contentLength)
public HttpRequestBuilder formEncodedContent(Map<String,String> content)
ContentType
and encodes the given parameter map, then sets it as the content.public HttpRequestBuilder jsonContent(Object content)
ContentType
and encodes the given content object via json
, then sets it as the content.public HttpRequestBuilder basicAuthentication(String username, String password)
Authorization
header via the Base64 encoded username and password.public Net.HttpRequest build()
Net.HttpRequest
that has been setup by this builder so far. After using the request, it should be returned
to the pool via Pools.free(request)
.Copyright © 2015. All rights reserved.