org.dstadler.commons.http

Class HttpClientWrapper

java.lang.Object

org.dstadler.commons.http.HttpClientWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HttpClientWrapper
extends java.lang.Object
implements java.io.Closeable

Helper class which configures a HttpClient instance for usage with BasicAuthentication user/pwd and also disables SSL verification to work with self-signed SSL certificates on webpages.

Constructor Summary

Constructors

Constructor and Description
HttpClientWrapper(java.lang.String user, java.lang.String password, int timeoutMs) Construct the HttpClient with the given authentication values and all timeouts set to the given number of milliseconds

Method Summary

Modifier and Type	Method and Description
static org.apache.http.HttpEntity	checkAndFetch(org.apache.http.HttpResponse response, java.lang.String url) Helper method to check the status code of the response and throw an IOException if it is an error or moved state.
void	close()
org.apache.http.impl.client.CloseableHttpClient	getHttpClient() Return the current HttpClient instance.
static java.lang.String	retrieveData(java.lang.String url) Small helper method to simply query the URL without password and return the resulting data.
static java.lang.String	retrieveData(java.lang.String url, java.lang.String user, java.lang.String password, int timeoutMs) Small helper method to simply query the URL without password and return the resulting data.
java.lang.String	simpleGet(java.lang.String url) Perform a simple get-operation and return the resulting String.
void	simpleGet(java.lang.String url, java.util.function.Consumer<java.io.InputStream> consumer) Perform a simple get-operation and passes the resulting InputStream to the given Consumer
byte[]	simpleGetBytes(java.lang.String url) Perform a simple get-operation and return the resulting byte-array.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientWrapper

public HttpClientWrapper(java.lang.String user,
                         java.lang.String password,
                         int timeoutMs)

Construct the HttpClient with the given authentication values and all timeouts set to the given number of milliseconds

Parameters:

user - The username for basic authentication, use an empty string when no authentication is required

password - The password for basic authentication, null when no authentication is required

timeoutMs - The timeout for socket connection and reading, specified in milliseconds

Method Detail

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient()

Return the current HttpClient instance.

Returns:

The internally used instance of the HttpClient

simpleGet

public java.lang.String simpleGet(java.lang.String url)
                           throws java.io.IOException

Perform a simple get-operation and return the resulting String.

Parameters:

url - The URL to query

Returns:

The data returned when retrieving the data from the given url, converted to a String.

Throws:

java.io.IOException - if the HTTP status code is not 200.

simpleGetBytes

public byte[] simpleGetBytes(java.lang.String url)
                      throws java.io.IOException

Perform a simple get-operation and return the resulting byte-array.

Parameters:

url - The URL to query

Returns:

The data returned when retrieving the data from the given url.

Throws:

java.io.IOException - if the HTTP status code is not 200.

simpleGet

public void simpleGet(java.lang.String url,
                      java.util.function.Consumer<java.io.InputStream> consumer)
               throws java.io.IOException

Perform a simple get-operation and passes the resulting InputStream to the given Consumer

Parameters:

url - The URL to query

consumer - A Consumer which receives the InputStream and can process the data on-the-fly in streaming fashion without retrieving all of the data into memory at once.

Throws:

java.io.IOException - if the HTTP status code is not 200.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

retrieveData

public static java.lang.String retrieveData(java.lang.String url)
                                     throws java.io.IOException

Small helper method to simply query the URL without password and return the resulting data.

Parameters:

url - The URL to query data from.

Returns:

The resulting data read from the URL

Throws:

java.io.IOException - If the URL is not accessible or the query returns a HTTP code other than 200.

retrieveData

public static java.lang.String retrieveData(java.lang.String url,
                                            java.lang.String user,
                                            java.lang.String password,
                                            int timeoutMs)
                                     throws java.io.IOException

Small helper method to simply query the URL without password and return the resulting data.

Parameters:

url - The URL to query data from.

user - The username to send

password - The password to send

timeoutMs - How long in milliseconds to wait for the request

Returns:

The resulting data read from the URL

Throws:

java.io.IOException - If the URL is not accessible or the query returns a HTTP code other than 200.

checkAndFetch

public static org.apache.http.HttpEntity checkAndFetch(org.apache.http.HttpResponse response,
                                                       java.lang.String url)
                                                throws java.io.IOException

Helper method to check the status code of the response and throw an IOException if it is an error or moved state.

Parameters:

response - A HttpResponse that is resulting from executing a HttpMethod.

url - The url, only used for building the error message of the exception.

Returns:

The HttpEntity returned from response.getEntity().

Throws:

java.io.IOException - if the HTTP status code is higher than 206.