Java Async HTTP Client

A simple, lightweight, asynchronous HTTP client built on top of Java's HttpURLConnection.

Please feel free to report any issues.

Download

Download Latest

Basics

Simply create either an AsyncHttpClient (asynchronous) or SyncHttpClient (synchronous) instance and make requests with the get(), post(), put(), delete(), or head() methods. Responses are handled by callbacks through HttpResponseHandler usually created as an anonymous inner class of the function call.

Examples

String url = "https://api.twitch.tv/kraken/games/top";

// Set the GET parameters
RequestParams params = new RequestParams();
params.put("limit", 1);
params.put("offset", 0);

HttpClient client = new AsyncHttpClient();
client.setHeader("Accept", "application/vnd.twitchtv.v3+json"); // Optional: send custom headers; sent with all future requests
client.setUserAgent("my-java-application"); // Optional: set a custom user-agent

client.get(url, params, new StringHttpResponseHandler() {
    @Override
    public void onSuccess(int statusCode, Map<String, List<String>> headers, String content) {
        /* Request was successful */
    }

    @Override
    public void onFailure(int statusCode, Map<String, List<String>> headers, String content) {
        /* Server responded with a status code 4xx or 5xx error */
    }

    @Override
    public void onFailure(Throwable throwable) {
        /* An exception occurred during the request. Usually unable to connect or there was an error reading the response */
    }
});

The above example reads String responses using StringHttpResponseHandler. It will automatically determine the response encoding and encode the String for you.

For raw data, use HttpResponseHandler as it returns an array of bytes,

client.get(url, params, new HttpResponseHandler() {
    @Override
    public void onSuccess(int statusCode, Map<String, List<String>> headers, byte[] content) {}

    @Override
    public void onFailure(int statusCode, Map<String, List<String>> headers, byte[] content) {}
});

Download files using FileHttpResponseHandler:

String url = "https://example.org/cool-file.zip";
File file = new File("C:\\cool-file.zip"); // Save path
HttpClient client = new AsyncHttpClient();

client.get(url, new FileHttpResponseHandler(file) {
    @Override
    public void onSuccess(int statusCode, Map<String, List<String>> headers, File content) {}

    @Override
    public void onFailure(int statusCode, Map<String, List<String>> headers, File content) {}

    @Override
    public void onProgressChanged(long bytesReceived, long totalBytes) {
        /* Optional: Track download progress. Will be called several times during file download */
        System.out.println("Downloaded: " + bytesReceived + " / " + totalBytes);
    }
});

RequestParams

The RequestParams object is used to specify HTTP request parameters such as for GET and POST. GET parameters are automatically appended to the URL and POST parameters will be sent in the content body.

Upload files by placing File objects in the RequestParams object.

File uploadFile = new File("party.png");
params.put("photo", uploadFile); 

HTTP Basic Authentication

Set HTTP Basic Authentication credentials by calling setBasicAuth(). These credentials will be sent with all future requests.

client.setBasicAuth("username", "password");

Clear credentials with

client.clearBasicAuth()

Roadmap

• Handle cookies

Thanks

API inspired by android-async-http