com.badlogic.gdx.net

Class HttpRequestBuilder

java.lang.Object

com.badlogic.gdx.net.HttpRequestBuilder

public class HttpRequestBuilder
extends Object

A builder for Net.HttpRequests. 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.

Author:

Daniel Holderbaum

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
HttpRequestBuilder()

Method Summary

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	includeCredentials(boolean includeCredentials)
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.

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

public static String baseUrl

Will be added as a prefix to each URL when url(String) is called. Empty by default.

defaultTimeout

public static int defaultTimeout

Will be set for each new HttpRequest. By default set to 1000. Can be overwritten via timeout(int).

json

public static Json json

Will be used for the object serialization in case jsonContent(Object) is called.

Constructor Detail

HttpRequestBuilder

public HttpRequestBuilder()

Method Detail

newRequest

public HttpRequestBuilder newRequest()

Initializes the builder and sets it up to build a new Net.HttpRequest .

method

public HttpRequestBuilder method(String httpMethod)

See Also:

Net.HttpRequest.setMethod(String)

url

public HttpRequestBuilder url(String url)

The baseUrl 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, the defaultTimeout will be used.

See Also:

Net.HttpRequest.setTimeOut(int)

followRedirects

public HttpRequestBuilder followRedirects(boolean followRedirects)

See Also:

Net.HttpRequest.setFollowRedirects(boolean)

includeCredentials

public HttpRequestBuilder includeCredentials(boolean includeCredentials)

See Also:

Net.HttpRequest.setIncludeCredentials(boolean)

header

public HttpRequestBuilder header(String name,
                                 String value)

See Also:

Net.HttpRequest.setHeader(String, String)

content

public HttpRequestBuilder content(String content)

See Also:

Net.HttpRequest.setContent(String)

content

public HttpRequestBuilder content(InputStream contentStream,
                                  long contentLength)

See Also:

Net.HttpRequest.setContent(java.io.InputStream, long)

formEncodedContent

public HttpRequestBuilder formEncodedContent(Map<String,String> content)

Sets the correct ContentType and encodes the given parameter map, then sets it as the content.

jsonContent

public HttpRequestBuilder jsonContent(Object content)

Sets the correct ContentType and encodes the given content object via json, then sets it as the content.

basicAuthentication

public HttpRequestBuilder basicAuthentication(String username,
                                              String password)

Sets the Authorization header via the Base64 encoded username and password.

build

public Net.HttpRequest build()

Returns the 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).