HttpClient 4 Cookbook

1. Overview

This cookbook shows how to use the Apache HttpClient 4 in a variety of examples and usecases.

The focus is on HttpClient 4.3.x and above, so some of the examples may not work with the older versions of the API.

The format of the cookbook is example focused and practical – no extraneous details and explanations necessary.

2. Cookbook

create the http client

CloseableHttpClient client = HttpClientBuilder.create().build();

send basic GET request

instance.execute(new HttpGet(""));

get the Status Code of the HTTP Response

CloseableHttpResponse response = instance.execute(new HttpGet(""));
assertThat(response.getStatusLine().getStatusCode(), equalTo(200));

get the Media Type of the response

CloseableHttpResponse response = instance.execute(new HttpGet(""));
String contentMimeType = ContentType.getOrDefault(response.getEntity()).getMimeType();
assertThat(contentMimeType, equalTo(ContentType.TEXT_HTML.getMimeType()));

get the body of the response

CloseableHttpResponse response = instance.execute(new HttpGet(""));
String bodyAsString = EntityUtils.toString(response.getEntity());
assertThat(bodyAsString, notNullValue());

configure the timeout on a request

@Test(expected = SocketTimeoutException.class)
public void givenLowTimeout_whenExecutingRequestWithTimeout_thenException() 
    throws ClientProtocolException, IOException {
    RequestConfig requestConfig = RequestConfig.custom()
    HttpGet request = new HttpGet(SAMPLE_URL);

configure timeout on the entire client

RequestConfig requestConfig = RequestConfig.custom().
HttpClientBuilder builder = HttpClientBuilder.create().setDefaultRequestConfig(requestConfig);

send a POST request

instance.execute(new HttpPost(SAMPLE_URL));

add parameters to a request

List<NameValuePair> params = new ArrayList<NameValuePair>();
params.add(new BasicNameValuePair("key1", "value1"));
params.add(new BasicNameValuePair("key2", "value2"));
request.setEntity(new UrlEncodedFormEntity(params, Consts.UTF_8));

configure how redirect are handled for an HTTP Request

CloseableHttpClient instance = HttpClientBuilder.create().disableRedirectHandling().build();
CloseableHttpResponse response = instance.execute(new HttpGet(""));
assertThat(response.getStatusLine().getStatusCode(), equalTo(301));

configure the headers for a request

HttpGet request = new HttpGet(SAMPLE_URL);
request.addHeader(HttpHeaders.ACCEPT, "application/xml");
response = instance.execute(request);

get the headers from response

CloseableHttpResponse response = instance.execute(new HttpGet(SAMPLE_URL));
Header[] headers = response.getHeaders(HttpHeaders.CONTENT_TYPE);
assertThat(headers, not(emptyArray()));

close/release resources

response = instance.execute(new HttpGet(SAMPLE_URL));
try {
    HttpEntity entity = response.getEntity();
    if (entity != null) {
        InputStream instream = entity.getContent();
} finally {

3. Conclusion

This format is a bit different from how I usually structure my articles – I’m publishing some of my internal development cookbooks on a given topic – on Google Guava, Hamcrest andMockito – and now HttpClient. The goal is to have this information readily available online – and to add to it whenever I run into a new useful example.

The implementation of all these examples and code snippets can be found in my github project – this is an Eclipse based project, so it should be easy to import and run as it is.

I usually post about Dev stuff on Google+ - you can follow me there:

Free eBook - REST Services with Spring
Join more than 2,200 engineers!


  • webiyo

    Please add an example which makes the use of HTTP Connection Pool :)

    • baeldung

      I did think about adding that in – but the PoolingHttpClientConnectionManager is used by default (as opposed to older versions of the library) – so it does make use of a connection pool out of the box.

  • Jimmy Bway

    Thx very usefull ;)

    • Eugen Paraschiv

      Glad you liked it.

  • donald

    Thank you so much. Really helpful