Package com.wingman.client.api.net

Class HttpClient

java.lang.Object

okhttp3.OkHttpClient

com.wingman.client.api.net.HttpClient

public class HttpClient
extends okhttp3.OkHttpClient

HttpClient contains the recommended API for handling web requests.

It utilizes the OkHttpClient library for efficient request handling.

Request caching is not enabled by default because of potential file conflict in the event of multiple client instances being run at the same time.

Nested Class Summary

Nested classes/interfaces inherited from class okhttp3.OkHttpClient

okhttp3.OkHttpClient.Builder

Constructor Summary

Constructors

Constructor	Description
HttpClient()

Method Summary

Modifier and Type	Method	Description
void	downloadFileAsync(java.lang.String url, java.nio.file.Path savePath)	Performs an asynchronous download of the file from the URL specified, to the save path specified.
void	downloadFileSync(java.lang.String url, java.nio.file.Path savePath)	Performs a synchronous download of the file from the URL specified, to the save path specified.
void	downloadUrlAsync(java.lang.String url, okhttp3.Callback callback)	Constructs an asynchronous request to the URL specified, and places it on the OkHttp worker thread.
okhttp3.Response	downloadUrlSync(java.lang.String url)	Constructs a synchronous request to the URL specified.
int	getContentLength(java.lang.String url)	Sends a HEAD request to the URL specified and returns the value of the Content-Length response header.
okhttp3.Request.Builder	getRequestBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from class okhttp3.OkHttpClient

authenticator, cache, certificatePinner, connectionPool, connectionSpecs, connectTimeoutMillis, cookieJar, dispatcher, dns, eventListenerFactory, followRedirects, followSslRedirects, hostnameVerifier, interceptors, networkInterceptors, newBuilder, newCall, newWebSocket, pingIntervalMillis, protocols, proxy, proxyAuthenticator, proxySelector, readTimeoutMillis, retryOnConnectionFailure, socketFactory, sslSocketFactory, writeTimeoutMillis

Constructor Detail

HttpClient

public HttpClient()

Method Detail

downloadFileSync

public void downloadFileSync(java.lang.String url,
                             java.nio.file.Path savePath)
                      throws java.io.IOException

Performs a synchronous download of the file from the URL specified, to the save path specified.

Parameters:

url - the URL of the file

savePath - the save path of the downloaded file

Throws:

java.io.IOException - if the download failed

downloadFileAsync

public void downloadFileAsync(java.lang.String url,
                              java.nio.file.Path savePath)
                       throws java.io.IOException

Performs an asynchronous download of the file from the URL specified, to the save path specified.

Parameters:

url - the URL of the file

savePath - the save path of the downloaded file

Throws:

java.io.IOException - if the download failed

downloadUrlSync

public okhttp3.Response downloadUrlSync(java.lang.String url)
                                 throws java.io.IOException

Constructs a synchronous request to the URL specified.

Parameters:

url - the URL of a request

Returns:

the response for the download request

Throws:

java.io.IOException - if the download failed

downloadUrlAsync

public void downloadUrlAsync(java.lang.String url,
                             okhttp3.Callback callback)
                      throws java.io.IOException

Constructs an asynchronous request to the URL specified, and places it on the OkHttp worker thread. The instance of Callback specified in the arguments is called upon completion of the request.

Parameters:

url - the URL of your request

callback - the Callback called after request completion

Throws:

java.io.IOException - if the download failed

getContentLength

public int getContentLength(java.lang.String url)
                     throws java.io.IOException,
                            java.lang.NumberFormatException

Sends a HEAD request to the URL specified and returns the value of the Content-Length response header.

Parameters:

url - the URL to get the Content-Length of

Returns:

the Content-Length of the URL

Throws:

java.io.IOException - if the download failed

java.lang.NumberFormatException - if the Content-Length returned is not a number

getRequestBuilder

public okhttp3.Request.Builder getRequestBuilder()

Returns:

a request builder with request headers attempting to mimic a real browser