com.loopj.android.http

Class AsyncHttpClient

java.lang.Object

com.loopj.android.http.AsyncHttpClient

Direct Known Subclasses:

SyncHttpClient

public class AsyncHttpClient
extends java.lang.Object

The AsyncHttpClient can be used to make asynchronous GET, POST, PUT and DELETE HTTP requests in your Android applications. Requests can be made with additional parameters by passing a RequestParams instance, and responses can be handled by passing an anonymously overridden ResponseHandlerInterface instance.

For example:

 AsyncHttpClient client = new AsyncHttpClient();
 client.get("https://www.google.com", new AsyncHttpResponseHandler() {
     @Override
     public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {
          System.out.println(response);
     }
     @Override
     public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable
 error)
 {
          error.printStackTrace(System.out);
     }
 });
 

See Also:

AsyncHttpResponseHandler, ResponseHandlerInterface, RequestParams

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CONNECTIONS
static int	DEFAULT_MAX_RETRIES
static int	DEFAULT_RETRY_SLEEP_TIME_MILLIS
static int	DEFAULT_SOCKET_BUFFER_SIZE
static int	DEFAULT_SOCKET_TIMEOUT
static java.lang.String	ENCODING_GZIP
static java.lang.String	HEADER_ACCEPT_ENCODING
static java.lang.String	HEADER_CONTENT_DISPOSITION
static java.lang.String	HEADER_CONTENT_ENCODING
static java.lang.String	HEADER_CONTENT_RANGE
static java.lang.String	HEADER_CONTENT_TYPE
static LogInterface	log
static java.lang.String	LOG_TAG

Constructor Summary

Constructors

Constructor and Description
AsyncHttpClient() Creates a new AsyncHttpClient with default constructor arguments values
AsyncHttpClient(boolean fixNoHttpResponseException, int httpPort, int httpsPort) Creates new AsyncHttpClient using given params
AsyncHttpClient(int httpPort) Creates a new AsyncHttpClient.
AsyncHttpClient(int httpPort, int httpsPort) Creates a new AsyncHttpClient.
AsyncHttpClient(cz.msebera.android.httpclient.conn.scheme.SchemeRegistry schemeRegistry) Creates a new AsyncHttpClient.

Method Summary

Modifier and Type	Method and Description
void	addHeader(java.lang.String header, java.lang.String value) Sets headers that will be added to all requests this client makes (before sending).
static void	allowRetryExceptionClass(java.lang.Class<?> cls)
static void	blockRetryExceptionClass(java.lang.Class<?> cls)
void	cancelAllRequests(boolean mayInterruptIfRunning) Cancels all pending (or potentially active) requests.
void	cancelRequests(android.content.Context context, boolean mayInterruptIfRunning) Cancels any pending (or potentially active) requests associated with the passed Context.
void	cancelRequestsByTAG(java.lang.Object TAG, boolean mayInterruptIfRunning) Allows you to cancel all requests currently in queue or running, by set TAG, if passed TAG is null, will not attempt to cancel any requests, if TAG is null on RequestHandle, it cannot be canceled by this call
void	clearCredentialsProvider() Removes previously set auth credentials
protected cz.msebera.android.httpclient.conn.ClientConnectionManager	createConnectionManager(cz.msebera.android.httpclient.conn.scheme.SchemeRegistry schemeRegistry, cz.msebera.android.httpclient.params.BasicHttpParams httpParams) Provided so it is easier for developers to provide custom ThreadSafeClientConnManager implementation
RequestHandle	delete(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP DELETE request.
RequestHandle	delete(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, ResponseHandlerInterface responseHandler) Perform a HTTP DELETE request.
RequestHandle	delete(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP DELETE request and track the Android Context which initiated the request.
RequestHandle	delete(android.content.Context context, java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP DELETE request.
void	delete(java.lang.String url, RequestParams params, AsyncHttpResponseHandler responseHandler) Perform a HTTP DELETE request.
RequestHandle	delete(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP DELETE request.
static void	endEntityViaReflection(cz.msebera.android.httpclient.HttpEntity entity) This horrible hack is required on Android, due to implementation of BasicManagedEntity, which doesn't chain call consumeContent on underlying wrapped HttpEntity
RequestHandle	get(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP GET request and track the Android Context which initiated the request with customized headers
RequestHandle	get(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP GET request and track the Android Context which initiated the request.
RequestHandle	get(android.content.Context context, java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP GET request and track the Android Context which initiated the request.
RequestHandle	get(android.content.Context context, java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP GET request without any parameters and track the Android Context which initiated the request.
RequestHandle	get(java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP GET request with parameters.
RequestHandle	get(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP GET request, without any parameters.
int	getConnectTimeout() Returns current connection timeout limit (milliseconds).
protected java.util.concurrent.ExecutorService	getDefaultThreadPool() Get the default threading pool to be used for this HTTP client.
cz.msebera.android.httpclient.client.HttpClient	getHttpClient() Get the underlying HttpClient instance.
cz.msebera.android.httpclient.protocol.HttpContext	getHttpContext() Get the underlying HttpContext instance.
int	getLoggingLevel() Retrieves current log level from underlying LogInterface instance.
LogInterface	getLogInterface() Will return current LogInterface used in AsyncHttpClient instance
int	getMaxConnections() Returns current limit of parallel connections
int	getResponseTimeout() Returns current response timeout limit (milliseconds).
java.util.concurrent.ExecutorService	getThreadPool() Returns the current executor service used.
protected java.net.URI	getURI(java.lang.String url) Returns a URI instance for the specified, absolute URL string.
static java.lang.String	getUrlWithQueryString(boolean shouldEncodeUrl, java.lang.String url, RequestParams params) Will encode url, if not disabled, and adds params on the end of it
RequestHandle	head(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP HEAD request and track the Android Context which initiated the request with customized headers
RequestHandle	head(android.content.Context context, java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP HEAD request and track the Android Context which initiated the request.
RequestHandle	head(android.content.Context context, java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP HEAD request without any parameters and track the Android Context which initiated the request.
RequestHandle	head(java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP HEAD request with parameters.
RequestHandle	head(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP HEAD request, without any parameters.
static boolean	isInputStreamGZIPCompressed(java.io.PushbackInputStream inputStream) Checks the InputStream if it contains GZIP compressed data
boolean	isLoggingEnabled() Returns logging enabled flag from underlying LogInterface instance Default setting is logging enabled.
boolean	isUrlEncodingEnabled()
protected AsyncHttpRequest	newAsyncHttpRequest(cz.msebera.android.httpclient.impl.client.DefaultHttpClient client, cz.msebera.android.httpclient.protocol.HttpContext httpContext, cz.msebera.android.httpclient.client.methods.HttpUriRequest uriRequest, java.lang.String contentType, ResponseHandlerInterface responseHandler, android.content.Context context) Instantiate a new asynchronous HTTP request for the passed parameters.
RequestHandle	patch(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP PATCH request and track the Android Context which initiated the request.
RequestHandle	patch(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP PATCH request and track the Android Context which initiated the request.
RequestHandle	patch(android.content.Context context, java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP PATCH request and track the Android Context which initiated the request.
RequestHandle	patch(java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP PATCH request with parameters.
RequestHandle	patch(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP request, without any parameters.
RequestHandle	post(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP POST request and track the Android Context which initiated the request.
RequestHandle	post(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, RequestParams params, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP POST request and track the Android Context which initiated the request.
RequestHandle	post(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP POST request and track the Android Context which initiated the request.
RequestHandle	post(android.content.Context context, java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP POST request and track the Android Context which initiated the request.
RequestHandle	post(java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP POST request with parameters.
RequestHandle	post(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP POST request, without any parameters.
RequestHandle	put(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.Header[] headers, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP PUT request and track the Android Context which initiated the request.
RequestHandle	put(android.content.Context context, java.lang.String url, cz.msebera.android.httpclient.HttpEntity entity, java.lang.String contentType, ResponseHandlerInterface responseHandler) Perform a HTTP PUT request and track the Android Context which initiated the request.
RequestHandle	put(android.content.Context context, java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP PUT request and track the Android Context which initiated the request.
RequestHandle	put(java.lang.String url, RequestParams params, ResponseHandlerInterface responseHandler) Perform a HTTP PUT request with parameters.
RequestHandle	put(java.lang.String url, ResponseHandlerInterface responseHandler) Perform a HTTP PUT request, without any parameters.
void	removeAllHeaders() Will, before sending, remove all headers currently present in AsyncHttpClient instance, which applies on all requests this client makes
void	removeHeader(java.lang.String header) Remove header from all requests this client makes (before sending).
protected RequestHandle	sendRequest(cz.msebera.android.httpclient.impl.client.DefaultHttpClient client, cz.msebera.android.httpclient.protocol.HttpContext httpContext, cz.msebera.android.httpclient.client.methods.HttpUriRequest uriRequest, java.lang.String contentType, ResponseHandlerInterface responseHandler, android.content.Context context) Puts a new request in queue as a new thread in pool to be executed
void	setAuthenticationPreemptive(boolean isPreemptive) Sets HttpRequestInterceptor which handles authorization in preemptive way, as workaround you can use call `AsyncHttpClient.addHeader("Authorization","Basic base64OfUsernameAndPassword==")`
void	setBasicAuth(java.lang.String username, java.lang.String password) Sets basic authentication for the request.
void	setBasicAuth(java.lang.String username, java.lang.String password, cz.msebera.android.httpclient.auth.AuthScope scope) Sets basic authentication for the request.
void	setBasicAuth(java.lang.String username, java.lang.String password, cz.msebera.android.httpclient.auth.AuthScope scope, boolean preemptive) Sets basic authentication for the request.
void	setBasicAuth(java.lang.String username, java.lang.String password, boolean preemptive) Sets basic authentication for the request.
void	setConnectTimeout(int value) Set connection timeout limit (milliseconds).
void	setCookieStore(cz.msebera.android.httpclient.client.CookieStore cookieStore) Sets an optional CookieStore to use when making requests
void	setCredentials(cz.msebera.android.httpclient.auth.AuthScope authScope, cz.msebera.android.httpclient.auth.Credentials credentials)
void	setEnableRedirects(boolean enableRedirects)
void	setEnableRedirects(boolean enableRedirects, boolean enableRelativeRedirects) Circular redirects are enabled by default
void	setEnableRedirects(boolean enableRedirects, boolean enableRelativeRedirects, boolean enableCircularRedirects) Simple interface method, to enable or disable redirects.
void	setLoggingEnabled(boolean loggingEnabled) Will set logging enabled flag on underlying LogInterface instance.
void	setLoggingLevel(int logLevel) Sets log level to be used across all library default implementation Default setting is VERBOSE log level.
void	setLogInterface(LogInterface logInterfaceInstance) Sets default LogInterface (similar to std Android Log util class) instance, to be used in AsyncHttpClient instance
void	setMaxConnections(int maxConnections) Sets maximum limit of parallel connections
void	setMaxRetriesAndTimeout(int retries, int timeout) Sets the maximum number of retries and timeout for a particular Request.
void	setProxy(java.lang.String hostname, int port) Sets the Proxy by it's hostname and port
void	setProxy(java.lang.String hostname, int port, java.lang.String username, java.lang.String password) Sets the Proxy by it's hostname,port,username and password
void	setRedirectHandler(cz.msebera.android.httpclient.client.RedirectHandler customRedirectHandler) Allows you to set custom RedirectHandler implementation, if the default provided doesn't suit your needs
void	setResponseTimeout(int value) Set response timeout limit (milliseconds).
void	setSSLSocketFactory(cz.msebera.android.httpclient.conn.ssl.SSLSocketFactory sslSocketFactory) Sets the SSLSocketFactory to user when making requests.
void	setThreadPool(java.util.concurrent.ExecutorService threadPool) Overrides the threadpool implementation used when queuing/pooling requests.
void	setTimeout(int value) Set both the connection and socket timeouts.
void	setURLEncodingEnabled(boolean enabled) Sets state of URL encoding feature, see bug #227, this method allows you to turn off and on this auto-magic feature on-demand.
void	setUserAgent(java.lang.String userAgent) Sets the User-Agent header to be sent with each request.
static void	silentCloseInputStream(java.io.InputStream is) A utility function to close an input stream without raising an exception.
static void	silentCloseOutputStream(java.io.OutputStream os) A utility function to close an output stream without raising an exception.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

See Also:

Constant Field Values

HEADER_CONTENT_TYPE

public static final java.lang.String HEADER_CONTENT_TYPE

See Also:

Constant Field Values

HEADER_CONTENT_RANGE

public static final java.lang.String HEADER_CONTENT_RANGE

See Also:

Constant Field Values

HEADER_CONTENT_ENCODING

public static final java.lang.String HEADER_CONTENT_ENCODING

See Also:

Constant Field Values

HEADER_CONTENT_DISPOSITION

public static final java.lang.String HEADER_CONTENT_DISPOSITION

See Also:

Constant Field Values

HEADER_ACCEPT_ENCODING

public static final java.lang.String HEADER_ACCEPT_ENCODING

See Also:

Constant Field Values

ENCODING_GZIP

public static final java.lang.String ENCODING_GZIP

See Also:

Constant Field Values

DEFAULT_MAX_CONNECTIONS

public static final int DEFAULT_MAX_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

See Also:

Constant Field Values

DEFAULT_RETRY_SLEEP_TIME_MILLIS

public static final int DEFAULT_RETRY_SLEEP_TIME_MILLIS

See Also:

Constant Field Values

DEFAULT_SOCKET_BUFFER_SIZE

public static final int DEFAULT_SOCKET_BUFFER_SIZE

See Also:

Constant Field Values

log

public static LogInterface log

Constructor Detail

AsyncHttpClient

public AsyncHttpClient()

Creates a new AsyncHttpClient with default constructor arguments values

AsyncHttpClient

public AsyncHttpClient(int httpPort)

Creates a new AsyncHttpClient.

Parameters:

httpPort - non-standard HTTP-only port

AsyncHttpClient

public AsyncHttpClient(int httpPort,
                       int httpsPort)

Creates a new AsyncHttpClient.

Parameters:

httpPort - non-standard HTTP-only port

httpsPort - non-standard HTTPS-only port

AsyncHttpClient

public AsyncHttpClient(boolean fixNoHttpResponseException,
                       int httpPort,
                       int httpsPort)

Creates new AsyncHttpClient using given params

Parameters:

fixNoHttpResponseException - Whether to fix issue or not, by omitting SSL verification

httpPort - HTTP port to be used, must be greater than 0

httpsPort - HTTPS port to be used, must be greater than 0

AsyncHttpClient

public AsyncHttpClient(cz.msebera.android.httpclient.conn.scheme.SchemeRegistry schemeRegistry)

Creates a new AsyncHttpClient.

Parameters:

schemeRegistry - SchemeRegistry to be used

Method Detail

allowRetryExceptionClass

public static void allowRetryExceptionClass(java.lang.Class<?> cls)

blockRetryExceptionClass

public static void blockRetryExceptionClass(java.lang.Class<?> cls)

getUrlWithQueryString

public static java.lang.String getUrlWithQueryString(boolean shouldEncodeUrl,
                                                     java.lang.String url,
                                                     RequestParams params)

Will encode url, if not disabled, and adds params on the end of it

Parameters:

url - String with URL, should be valid URL without params

params - RequestParams to be appended on the end of URL

shouldEncodeUrl - whether url should be encoded (replaces spaces with %20)

Returns:

encoded url if requested with params appended if any available

isInputStreamGZIPCompressed

public static boolean isInputStreamGZIPCompressed(java.io.PushbackInputStream inputStream)
                                           throws java.io.IOException

Checks the InputStream if it contains GZIP compressed data

Parameters:

inputStream - InputStream to be checked

Returns:

true or false if the stream contains GZIP compressed data

Throws:

java.io.IOException - if read from inputStream fails

silentCloseInputStream

public static void silentCloseInputStream(java.io.InputStream is)

A utility function to close an input stream without raising an exception.

Parameters:

is - input stream to close safely

silentCloseOutputStream

public static void silentCloseOutputStream(java.io.OutputStream os)

A utility function to close an output stream without raising an exception.

Parameters:

os - output stream to close safely

endEntityViaReflection

public static void endEntityViaReflection(cz.msebera.android.httpclient.HttpEntity entity)

This horrible hack is required on Android, due to implementation of BasicManagedEntity, which doesn't chain call consumeContent on underlying wrapped HttpEntity

Parameters:

entity - HttpEntity, may be null

getHttpClient

public cz.msebera.android.httpclient.client.HttpClient getHttpClient()

Get the underlying HttpClient instance. This is useful for setting additional fine-grained settings for requests by accessing the client's ConnectionManager, HttpParams and SchemeRegistry.

Returns:

underlying HttpClient instance

getHttpContext

public cz.msebera.android.httpclient.protocol.HttpContext getHttpContext()

Get the underlying HttpContext instance. This is useful for getting and setting fine-grained settings for requests by accessing the context's attributes such as the CookieStore.

Returns:

underlying HttpContext instance

isLoggingEnabled

public boolean isLoggingEnabled()

Returns logging enabled flag from underlying LogInterface instance Default setting is logging enabled.

Returns:

boolean whether is logging across the library currently enabled

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Will set logging enabled flag on underlying LogInterface instance. Default setting is logging enabled.

Parameters:

loggingEnabled - whether the logging should be enabled or not

getLoggingLevel

public int getLoggingLevel()

Retrieves current log level from underlying LogInterface instance. Default setting is VERBOSE log level.

Returns:

int log level currently in effect

setLoggingLevel

public void setLoggingLevel(int logLevel)

Sets log level to be used across all library default implementation Default setting is VERBOSE log level.

Parameters:

logLevel - int log level, either from LogInterface interface or from Log

getLogInterface

public LogInterface getLogInterface()

Will return current LogInterface used in AsyncHttpClient instance

Returns:

LogInterface currently used by AsyncHttpClient instance

setLogInterface

public void setLogInterface(LogInterface logInterfaceInstance)

Sets default LogInterface (similar to std Android Log util class) instance, to be used in AsyncHttpClient instance

Parameters:

logInterfaceInstance - LogInterface instance, if null, nothing is done

setCookieStore

public void setCookieStore(cz.msebera.android.httpclient.client.CookieStore cookieStore)

Sets an optional CookieStore to use when making requests

Parameters:

cookieStore - The CookieStore implementation to use, usually an instance of PersistentCookieStore

getThreadPool

public java.util.concurrent.ExecutorService getThreadPool()

Returns the current executor service used. By default, Executors.newCachedThreadPool() is used.

Returns:

current executor service used

setThreadPool

public void setThreadPool(java.util.concurrent.ExecutorService threadPool)

Overrides the threadpool implementation used when queuing/pooling requests. By default, Executors.newCachedThreadPool() is used.

Parameters:

threadPool - an instance of ExecutorService to use for queuing/pooling requests.

getDefaultThreadPool

protected java.util.concurrent.ExecutorService getDefaultThreadPool()

Get the default threading pool to be used for this HTTP client.

Returns:

The default threading pool to be used

createConnectionManager

protected cz.msebera.android.httpclient.conn.ClientConnectionManager createConnectionManager(cz.msebera.android.httpclient.conn.scheme.SchemeRegistry schemeRegistry,
                                                                                             cz.msebera.android.httpclient.params.BasicHttpParams httpParams)

Provided so it is easier for developers to provide custom ThreadSafeClientConnManager implementation

Parameters:

schemeRegistry - SchemeRegistry, usually provided by getDefaultSchemeRegistry(boolean, int, int)

httpParams - BasicHttpParams

Returns:

ClientConnectionManager instance

setEnableRedirects

public void setEnableRedirects(boolean enableRedirects,
                               boolean enableRelativeRedirects,
                               boolean enableCircularRedirects)

Simple interface method, to enable or disable redirects. If you set manually RedirectHandler on underlying HttpClient, effects of this method will be canceled.

Default setting is to disallow redirects.

Parameters:

enableRedirects - boolean

enableRelativeRedirects - boolean

enableCircularRedirects - boolean

setEnableRedirects

public void setEnableRedirects(boolean enableRedirects,
                               boolean enableRelativeRedirects)

Circular redirects are enabled by default

Parameters:

enableRedirects - boolean

enableRelativeRedirects - boolean

See Also:

setEnableRedirects(boolean, boolean, boolean)

setEnableRedirects

public void setEnableRedirects(boolean enableRedirects)

Parameters:

enableRedirects - boolean

See Also:

setEnableRedirects(boolean, boolean, boolean)

setRedirectHandler

public void setRedirectHandler(cz.msebera.android.httpclient.client.RedirectHandler customRedirectHandler)

Allows you to set custom RedirectHandler implementation, if the default provided doesn't suit your needs

Parameters:

customRedirectHandler - RedirectHandler instance

See Also:

MyRedirectHandler

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Sets the User-Agent header to be sent with each request. By default, "Android Asynchronous Http Client/VERSION (https://loopj.com/android-async-http/)" is used.

Parameters:

userAgent - the string to use in the User-Agent header.

getMaxConnections

public int getMaxConnections()

Returns current limit of parallel connections

Returns:

maximum limit of parallel connections, default is 10

setMaxConnections

public void setMaxConnections(int maxConnections)

Sets maximum limit of parallel connections

Parameters:

maxConnections - maximum parallel connections, must be at least 1

setTimeout

public void setTimeout(int value)

Set both the connection and socket timeouts. By default, both are set to 10 seconds.

Parameters:

value - the connect/socket timeout in milliseconds, at least 1 second

See Also:

setConnectTimeout(int), setResponseTimeout(int)

getConnectTimeout

public int getConnectTimeout()

Returns current connection timeout limit (milliseconds). By default, this is set to 10 seconds.

Returns:

Connection timeout limit in milliseconds

setConnectTimeout

public void setConnectTimeout(int value)

Set connection timeout limit (milliseconds). By default, this is set to 10 seconds.

Parameters:

value - Connection timeout in milliseconds, minimal value is 1000 (1 second).

getResponseTimeout

public int getResponseTimeout()

Returns current response timeout limit (milliseconds). By default, this is set to 10 seconds.

Returns:

Response timeout limit in milliseconds

setResponseTimeout

public void setResponseTimeout(int value)

Set response timeout limit (milliseconds). By default, this is set to 10 seconds.

Parameters:

value - Response timeout in milliseconds, minimal value is 1000 (1 second).

setProxy

public void setProxy(java.lang.String hostname,
                     int port)

Sets the Proxy by it's hostname and port

Parameters:

hostname - the hostname (IP or DNS name)

port - the port number. -1 indicates the scheme default port.

setProxy

public void setProxy(java.lang.String hostname,
                     int port,
                     java.lang.String username,
                     java.lang.String password)

Sets the Proxy by it's hostname,port,username and password

Parameters:

hostname - the hostname (IP or DNS name)

port - the port number. -1 indicates the scheme default port.

username - the username

password - the password

setSSLSocketFactory

public void setSSLSocketFactory(cz.msebera.android.httpclient.conn.ssl.SSLSocketFactory sslSocketFactory)

Sets the SSLSocketFactory to user when making requests. By default, a new, default SSLSocketFactory is used.

Parameters:

sslSocketFactory - the socket factory to use for https requests.

setMaxRetriesAndTimeout

public void setMaxRetriesAndTimeout(int retries,
                                    int timeout)

Sets the maximum number of retries and timeout for a particular Request.

Parameters:

retries - maximum number of retries per request

timeout - sleep between retries in milliseconds

removeAllHeaders

public void removeAllHeaders()

Will, before sending, remove all headers currently present in AsyncHttpClient instance, which applies on all requests this client makes

addHeader

public void addHeader(java.lang.String header,
                      java.lang.String value)

Sets headers that will be added to all requests this client makes (before sending).

Parameters:

header - the name of the header

value - the contents of the header

removeHeader

public void removeHeader(java.lang.String header)

Remove header from all requests this client makes (before sending).

Parameters:

header - the name of the header

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password)

Sets basic authentication for the request. Uses AuthScope.ANY. This is the same as setBasicAuth('username','password',AuthScope.ANY)

Parameters:

username - Basic Auth username

password - Basic Auth password

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password,
                         boolean preemptive)

Sets basic authentication for the request. Uses AuthScope.ANY. This is the same as setBasicAuth('username','password',AuthScope.ANY)

Parameters:

username - Basic Auth username

password - Basic Auth password

preemptive - sets authorization in preemptive manner

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password,
                         cz.msebera.android.httpclient.auth.AuthScope scope)

Sets basic authentication for the request. You should pass in your AuthScope for security. It should be like this setBasicAuth("username","password", new AuthScope("host",port,AuthScope.ANY_REALM))

Parameters:

username - Basic Auth username

password - Basic Auth password

scope - - an AuthScope object

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password,
                         cz.msebera.android.httpclient.auth.AuthScope scope,
                         boolean preemptive)

Sets basic authentication for the request. You should pass in your AuthScope for security. It should be like this setBasicAuth("username","password", new AuthScope("host",port,AuthScope.ANY_REALM))

Parameters:

username - Basic Auth username

password - Basic Auth password

scope - an AuthScope object

preemptive - sets authorization in preemptive manner

setCredentials

public void setCredentials(cz.msebera.android.httpclient.auth.AuthScope authScope,
                           cz.msebera.android.httpclient.auth.Credentials credentials)

setAuthenticationPreemptive

public void setAuthenticationPreemptive(boolean isPreemptive)

Sets HttpRequestInterceptor which handles authorization in preemptive way, as workaround you can use call `AsyncHttpClient.addHeader("Authorization","Basic base64OfUsernameAndPassword==")`

Parameters:

isPreemptive - whether the authorization is processed in preemptive way

clearCredentialsProvider

public void clearCredentialsProvider()

Removes previously set auth credentials

cancelRequests

public void cancelRequests(android.content.Context context,
                           boolean mayInterruptIfRunning)

Cancels any pending (or potentially active) requests associated with the passed Context.

Note: This will only affect requests which were created with a non-null android Context. This method is intended to be used in the onDestroy method of your android activities to destroy all requests which are no longer required.

Parameters:

context - the android Context instance associated to the request.

mayInterruptIfRunning - specifies if active requests should be cancelled along with pending requests.

cancelAllRequests

public void cancelAllRequests(boolean mayInterruptIfRunning)

Cancels all pending (or potentially active) requests.

Note: This will only affect requests which were created with a non-null android Context. This method is intended to be used in the onDestroy method of your android activities to destroy all requests which are no longer required.

Parameters:

mayInterruptIfRunning - specifies if active requests should be cancelled along with pending requests.

cancelRequestsByTAG

public void cancelRequestsByTAG(java.lang.Object TAG,
                                boolean mayInterruptIfRunning)

Allows you to cancel all requests currently in queue or running, by set TAG, if passed TAG is null, will not attempt to cancel any requests, if TAG is null on RequestHandle, it cannot be canceled by this call

Parameters:

TAG - TAG to be matched in RequestHandle

mayInterruptIfRunning - specifies if active requests should be cancelled along with pending requests.

head

public RequestHandle head(java.lang.String url,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP HEAD request, without any parameters.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

head

public RequestHandle head(java.lang.String url,
                          RequestParams params,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP HEAD request with parameters.

Parameters:

url - the URL to send the request to.

params - additional HEAD parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

head

public RequestHandle head(android.content.Context context,
                          java.lang.String url,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP HEAD request without any parameters and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

head

public RequestHandle head(android.content.Context context,
                          java.lang.String url,
                          RequestParams params,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP HEAD request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

params - additional HEAD parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

head

public RequestHandle head(android.content.Context context,
                          java.lang.String url,
                          cz.msebera.android.httpclient.Header[] headers,
                          RequestParams params,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP HEAD request and track the Android Context which initiated the request with customized headers

Parameters:

context - Context to execute request against

url - the URL to send the request to.

headers - set headers only for this request

params - additional HEAD parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(java.lang.String url,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request, without any parameters.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(java.lang.String url,
                         RequestParams params,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request with parameters.

Parameters:

url - the URL to send the request to.

params - additional GET parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(android.content.Context context,
                         java.lang.String url,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request without any parameters and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(android.content.Context context,
                         java.lang.String url,
                         RequestParams params,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

params - additional GET parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(android.content.Context context,
                         java.lang.String url,
                         cz.msebera.android.httpclient.Header[] headers,
                         RequestParams params,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request and track the Android Context which initiated the request with customized headers

Parameters:

context - Context to execute request against

url - the URL to send the request to.

headers - set headers only for this request

params - additional GET parameters to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

get

public RequestHandle get(android.content.Context context,
                         java.lang.String url,
                         cz.msebera.android.httpclient.HttpEntity entity,
                         java.lang.String contentType,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP GET request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response ha ndler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(java.lang.String url,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request, without any parameters.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(java.lang.String url,
                          RequestParams params,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request with parameters.

Parameters:

url - the URL to send the request to.

params - additional POST parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(android.content.Context context,
                          java.lang.String url,
                          RequestParams params,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

params - additional POST parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(android.content.Context context,
                          java.lang.String url,
                          cz.msebera.android.httpclient.HttpEntity entity,
                          java.lang.String contentType,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response ha ndler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(android.content.Context context,
                          java.lang.String url,
                          cz.msebera.android.httpclient.Header[] headers,
                          RequestParams params,
                          java.lang.String contentType,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request and track the Android Context which initiated the request. Set headers only for this request

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set headers only for this request

params - additional POST parameters to send with the request.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

post

public RequestHandle post(android.content.Context context,
                          java.lang.String url,
                          cz.msebera.android.httpclient.Header[] headers,
                          cz.msebera.android.httpclient.HttpEntity entity,
                          java.lang.String contentType,
                          ResponseHandlerInterface responseHandler)

Perform a HTTP POST request and track the Android Context which initiated the request. Set headers only for this request

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set headers only for this request

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

put

public RequestHandle put(java.lang.String url,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP PUT request, without any parameters.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

put

public RequestHandle put(java.lang.String url,
                         RequestParams params,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP PUT request with parameters.

Parameters:

url - the URL to send the request to.

params - additional PUT parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

put

public RequestHandle put(android.content.Context context,
                         java.lang.String url,
                         RequestParams params,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP PUT request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

params - additional PUT parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

put

public RequestHandle put(android.content.Context context,
                         java.lang.String url,
                         cz.msebera.android.httpclient.HttpEntity entity,
                         java.lang.String contentType,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP PUT request and track the Android Context which initiated the request. And set one-time headers for the request

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

put

public RequestHandle put(android.content.Context context,
                         java.lang.String url,
                         cz.msebera.android.httpclient.Header[] headers,
                         cz.msebera.android.httpclient.HttpEntity entity,
                         java.lang.String contentType,
                         ResponseHandlerInterface responseHandler)

Perform a HTTP PUT request and track the Android Context which initiated the request. And set one-time headers for the request

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set one-time headers for this request

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

patch

public RequestHandle patch(java.lang.String url,
                           ResponseHandlerInterface responseHandler)

Perform a HTTP request, without any parameters.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

patch

public RequestHandle patch(java.lang.String url,
                           RequestParams params,
                           ResponseHandlerInterface responseHandler)

Perform a HTTP PATCH request with parameters.

Parameters:

url - the URL to send the request to.

params - additional PUT parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

patch

public RequestHandle patch(android.content.Context context,
                           java.lang.String url,
                           RequestParams params,
                           ResponseHandlerInterface responseHandler)

Perform a HTTP PATCH request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

params - additional PUT parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

patch

public RequestHandle patch(android.content.Context context,
                           java.lang.String url,
                           cz.msebera.android.httpclient.HttpEntity entity,
                           java.lang.String contentType,
                           ResponseHandlerInterface responseHandler)

Perform a HTTP PATCH request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity

contentType - the content type of the payload you are sending, for example "application/json" if sending a json payload.

Returns:

RequestHandle of future request process

patch

public RequestHandle patch(android.content.Context context,
                           java.lang.String url,
                           cz.msebera.android.httpclient.Header[] headers,
                           cz.msebera.android.httpclient.HttpEntity entity,
                           java.lang.String contentType,
                           ResponseHandlerInterface responseHandler)

Perform a HTTP PATCH request and track the Android Context which initiated the request. And set one-time headers for the request

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set one-time headers for this request

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

delete

public RequestHandle delete(java.lang.String url,
                            ResponseHandlerInterface responseHandler)

Perform a HTTP DELETE request.

Parameters:

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

delete

public RequestHandle delete(android.content.Context context,
                            java.lang.String url,
                            ResponseHandlerInterface responseHandler)

Perform a HTTP DELETE request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

delete

public RequestHandle delete(android.content.Context context,
                            java.lang.String url,
                            cz.msebera.android.httpclient.Header[] headers,
                            ResponseHandlerInterface responseHandler)

Perform a HTTP DELETE request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set one-time headers for this request

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

delete

public void delete(java.lang.String url,
                   RequestParams params,
                   AsyncHttpResponseHandler responseHandler)

Perform a HTTP DELETE request.

Parameters:

url - the URL to send the request to.

params - additional DELETE parameters or files to send with the request.

responseHandler - the response handler instance that should handle the response.

delete

public RequestHandle delete(android.content.Context context,
                            java.lang.String url,
                            cz.msebera.android.httpclient.Header[] headers,
                            RequestParams params,
                            ResponseHandlerInterface responseHandler)

Perform a HTTP DELETE request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

headers - set one-time headers for this request

params - additional DELETE parameters or files to send along with request

responseHandler - the response handler instance that should handle the response.

Returns:

RequestHandle of future request process

delete

public RequestHandle delete(android.content.Context context,
                            java.lang.String url,
                            cz.msebera.android.httpclient.HttpEntity entity,
                            java.lang.String contentType,
                            ResponseHandlerInterface responseHandler)

Perform a HTTP DELETE request and track the Android Context which initiated the request.

Parameters:

context - the Android Context which initiated the request.

url - the URL to send the request to.

entity - a raw HttpEntity to send with the request, for example, use this to send string/json/xml payloads to a server by passing a StringEntity.

contentType - the content type of the payload you are sending, for example application/json if sending a json payload.

responseHandler - the response ha ndler instance that should handle the response.

Returns:

RequestHandle of future request process

newAsyncHttpRequest

protected AsyncHttpRequest newAsyncHttpRequest(cz.msebera.android.httpclient.impl.client.DefaultHttpClient client,
                                               cz.msebera.android.httpclient.protocol.HttpContext httpContext,
                                               cz.msebera.android.httpclient.client.methods.HttpUriRequest uriRequest,
                                               java.lang.String contentType,
                                               ResponseHandlerInterface responseHandler,
                                               android.content.Context context)

Instantiate a new asynchronous HTTP request for the passed parameters.

Parameters:

client - HttpClient to be used for request, can differ in single requests

contentType - MIME body type, for POST and PUT requests, may be null

context - Context of Android application, to hold the reference of request

httpContext - HttpContext in which the request will be executed

responseHandler - ResponseHandler or its subclass to put the response into

uriRequest - instance of HttpUriRequest, which means it must be of HttpDelete, HttpPost, HttpGet, HttpPut, etc.

Returns:

AsyncHttpRequest ready to be dispatched

sendRequest

protected RequestHandle sendRequest(cz.msebera.android.httpclient.impl.client.DefaultHttpClient client,
                                    cz.msebera.android.httpclient.protocol.HttpContext httpContext,
                                    cz.msebera.android.httpclient.client.methods.HttpUriRequest uriRequest,
                                    java.lang.String contentType,
                                    ResponseHandlerInterface responseHandler,
                                    android.content.Context context)

Puts a new request in queue as a new thread in pool to be executed

Parameters:

client - HttpClient to be used for request, can differ in single requests

contentType - MIME body type, for POST and PUT requests, may be null

context - Context of Android application, to hold the reference of request

httpContext - HttpContext in which the request will be executed

responseHandler - ResponseHandler or its subclass to put the response into

uriRequest - instance of HttpUriRequest, which means it must be of HttpDelete, HttpPost, HttpGet, HttpPut, etc.

Returns:

RequestHandle of future request process

getURI

protected java.net.URI getURI(java.lang.String url)

Returns a URI instance for the specified, absolute URL string.

Parameters:

url - absolute URL string, containing scheme, host and path

Returns:

URI instance for the URL string

setURLEncodingEnabled

public void setURLEncodingEnabled(boolean enabled)

Sets state of URL encoding feature, see bug #227, this method allows you to turn off and on this auto-magic feature on-demand.

Parameters:

enabled - desired state of feature

isUrlEncodingEnabled

public boolean isUrlEncodingEnabled()