com.github.leonardoxh.asyncokhttpclient

Class AsyncOkHttpClient

java.lang.Object

com.github.leonardoxh.asyncokhttpclient.AsyncOkHttpClient

public class AsyncOkHttpClient
extends java.lang.Object

Main class should be used to controll all the client

Constructor Summary

Constructors

Constructor and Description
AsyncOkHttpClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String key, java.lang.String value) Add a header on the request, please note a null header key of a null header value will quietly be ignored from the final headers ensure that passe parameter is not null
void	delete(java.lang.String url, AsyncHttpResponse response) Execute a DELETE request
void	delete(java.lang.String url, RequestParams params, AsyncHttpResponse response) Execute a DELETE request
void	get(java.lang.String url, AsyncHttpResponse response) Execute a GET request
void	get(java.lang.String url, RequestParams params, AsyncHttpResponse response) Execute a GET request
OkHttpClient	getOkHttpClient() Return a instance used for the requests on this client
void	post(java.lang.String url, AsyncHttpResponse response) Execute a POST request
void	post(java.lang.String url, RequestParams params, AsyncHttpResponse response) Execute a POST request
void	put(java.lang.String url, AsyncHttpResponse response) Execute a PUT request
void	put(java.lang.String url, RequestParams params, AsyncHttpResponse response) Execute a PUT request
protected void	sendRequest(OkHttpClient client, java.lang.String url, AsyncHttpResponse response, RequestParams params, java.lang.String requestMethod) Send the specific request for the request response
void	setConnectionTimeut(long timeout, java.util.concurrent.TimeUnit unit) Set the connection timeout for the requests based on the time unit 0 means no timeout
void	setReadTieout(long timeout, java.util.concurrent.TimeUnit unit) Set the read timeout for the requests based on the time unit 0 means no timeout
void	setThreadPool(java.util.concurrent.ThreadPoolExecutor threadPool) Set the executor to execute the requests on the most use cases this is not necessary but is a good choice for make unit tests

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncOkHttpClient

public AsyncOkHttpClient()

Method Detail

getOkHttpClient

public OkHttpClient getOkHttpClient()

Return a instance used for the requests on this client

Returns:

a valid instance of the OkHttp used for the requests on this client

See Also:

com.squareup.okhttp.OkHttpClient

addHeader

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

Add a header on the request, please note a null header key of a null header value will quietly be ignored from the final headers ensure that passe parameter is not null

Parameters:

key - the header name

value - the header value

setThreadPool

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

Set the executor to execute the requests on the most use cases this is not necessary but is a good choice for make unit tests

Parameters:

threadPool - a new thread pool for execute the incoming requests

setConnectionTimeut

public void setConnectionTimeut(long timeout,
                       java.util.concurrent.TimeUnit unit)

Set the connection timeout for the requests based on the time unit 0 means no timeout

Parameters:

timeout - a new timeout value

unit - the unit for the timeout

See Also:

TimeUnit

setReadTieout

public void setReadTieout(long timeout,
                 java.util.concurrent.TimeUnit unit)

Set the read timeout for the requests based on the time unit 0 means no timeout

Parameters:

timeout - a new timeout value

unit - the unit for the timeout

See Also:

TimeUnit

sendRequest

protected void sendRequest(OkHttpClient client,
               java.lang.String url,
               AsyncHttpResponse response,
               RequestParams params,
               java.lang.String requestMethod)

Send the specific request for the request response

Parameters:

client - the client for execute the request

url - the url for execute

response - the response handler for this request

params - the request parameters null parameters means no parameters

requestMethod - the request method for requests

See Also:

AsyncHttpRequest, RequestMethod

get

public void get(java.lang.String url,
       AsyncHttpResponse response)

Execute a GET request

Parameters:

url - the url for execute

response - the response handler to manage the results

get

public void get(java.lang.String url,
       RequestParams params,
       AsyncHttpResponse response)

Execute a GET request

Parameters:

url - the url for execute

params - the request parameters null parameters means no parameters

response - the response handler to manage the results

post

public void post(java.lang.String url,
        AsyncHttpResponse response)

Execute a POST request

Parameters:

url - the url for execute

response - the response handler to manage the results

post

public void post(java.lang.String url,
        RequestParams params,
        AsyncHttpResponse response)

Execute a POST request

Parameters:

url - the url for execute

params - the request parameters null parameters means no parameters

response - the response handler to manage the results

put

public void put(java.lang.String url,
       RequestParams params,
       AsyncHttpResponse response)

Execute a PUT request

Parameters:

url - the url for execute

params - the request parameters null parameters means no parameters

response - the response handler to manage the results

put

public void put(java.lang.String url,
       AsyncHttpResponse response)

Execute a PUT request

Parameters:

url - the url for execute

response - the response handler to manage the results

delete

public void delete(java.lang.String url,
          RequestParams params,
          AsyncHttpResponse response)

Execute a DELETE request

Parameters:

url - the url for execute

params - the request parameters null parameters means no parameters

response - the response handler to manage the results

delete

public void delete(java.lang.String url,
          AsyncHttpResponse response)

Execute a DELETE request

Parameters:

url - the url for execute

response - the response handler to manage the results