Package com.badlogic.gdx.net
Class HttpRequestBuilder
- java.lang.Object
-
- com.badlogic.gdx.net.HttpRequestBuilder
-
public class HttpRequestBuilder extends java.lang.Object
A builder forNet.HttpRequest
s. Make sure to callnewRequest()
first, then set the request up and obtain it viabuild()
when you are done. It also offers a few utility methods to deal with content encoding and HTTP headers.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
baseUrl
Will be added as a prefix to each URL whenurl(String)
is called.static int
defaultTimeout
Will be set for each new HttpRequest.static Json
json
Will be used for the object serialization in casejsonContent(Object)
is called.
-
Constructor Summary
Constructors Constructor Description HttpRequestBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpRequestBuilder
basicAuthentication(java.lang.String username, java.lang.String password)
Sets theAuthorization
header via the Base64 encoded username and password.Net.HttpRequest
build()
Returns theNet.HttpRequest
that has been setup by this builder so far.HttpRequestBuilder
content(java.io.InputStream contentStream, long contentLength)
HttpRequestBuilder
content(java.lang.String content)
HttpRequestBuilder
followRedirects(boolean followRedirects)
HttpRequestBuilder
formEncodedContent(java.util.Map<java.lang.String,java.lang.String> content)
Sets the correctContentType
and encodes the given parameter map, then sets it as the content.HttpRequestBuilder
header(java.lang.String name, java.lang.String value)
HttpRequestBuilder
includeCredentials(boolean includeCredentials)
HttpRequestBuilder
jsonContent(java.lang.Object content)
Sets the correctContentType
and encodes the given content object viajson
, then sets it as the content.HttpRequestBuilder
method(java.lang.String httpMethod)
HttpRequestBuilder
newRequest()
Initializes the builder and sets it up to build a newNet.HttpRequest
.HttpRequestBuilder
timeout(int timeOut)
If this method is not called, thedefaultTimeout
will be used.HttpRequestBuilder
url(java.lang.String url)
ThebaseUrl
will automatically be added as a prefix to the given URL.
-
-
-
Field Detail
-
baseUrl
public static java.lang.String baseUrl
Will be added as a prefix to each URL whenurl(String)
is called. Empty by default.
-
defaultTimeout
public static int defaultTimeout
Will be set for each new HttpRequest. By default set to1000
. Can be overwritten viatimeout(int)
.
-
json
public static Json json
Will be used for the object serialization in casejsonContent(Object)
is called.
-
-
Method Detail
-
newRequest
public HttpRequestBuilder newRequest()
Initializes the builder and sets it up to build a newNet.HttpRequest
.
-
method
public HttpRequestBuilder method(java.lang.String httpMethod)
- See Also:
Net.HttpRequest.setMethod(String)
-
url
public HttpRequestBuilder url(java.lang.String url)
ThebaseUrl
will automatically be added as a prefix to the given URL.- See Also:
Net.HttpRequest.setUrl(String)
-
timeout
public HttpRequestBuilder timeout(int timeOut)
If this method is not called, thedefaultTimeout
will be used.- See Also:
Net.HttpRequest.setTimeOut(int)
-
followRedirects
public HttpRequestBuilder followRedirects(boolean followRedirects)
-
includeCredentials
public HttpRequestBuilder includeCredentials(boolean includeCredentials)
-
header
public HttpRequestBuilder header(java.lang.String name, java.lang.String value)
-
content
public HttpRequestBuilder content(java.lang.String content)
- See Also:
Net.HttpRequest.setContent(String)
-
content
public HttpRequestBuilder content(java.io.InputStream contentStream, long contentLength)
-
formEncodedContent
public HttpRequestBuilder formEncodedContent(java.util.Map<java.lang.String,java.lang.String> content)
Sets the correctContentType
and encodes the given parameter map, then sets it as the content.
-
jsonContent
public HttpRequestBuilder jsonContent(java.lang.Object content)
Sets the correctContentType
and encodes the given content object viajson
, then sets it as the content.
-
basicAuthentication
public HttpRequestBuilder basicAuthentication(java.lang.String username, java.lang.String password)
Sets theAuthorization
header via the Base64 encoded username and password.
-
build
public Net.HttpRequest build()
Returns theNet.HttpRequest
that has been setup by this builder so far. After using the request, it should be returned to the pool viaPools.free(request)
.
-
-