Package dev.galasa.http

Interface IHttpClient

public interface IHttpClient

Method Summary

Modifier and Type	Method	Description
void	addCommonHeader(String name, String value)	Add a header that will be used on all http requests
void	addOkResponseCode(int responseCode)	Add a response code for the execute to ignore and treat as OK
IHttpClient	build()	Build the client
void	clearCommonHeaders()	Remove all headers for this http request
void	close()	close the underlying HTTPClient
HttpClientResponse<byte[]>	deleteBinary(String url, byte[] binary)	Issue an HTTP DELETE to the provided URL, sending the provided byte and receiving a byte in the response.
HttpClientResponse<Object>	deleteJaxb(String url, Class<?>... responseTypes)	Issue an HTTP DELETE to the provided URL, receiving a JAXB Object in the response.
HttpClientResponse<com.google.gson.JsonObject>	deleteJson(String url)	Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in the response.
HttpClientResponse<com.google.gson.JsonObject>	deleteJson(String url, com.google.gson.JsonObject json)	Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in the response.
HttpClientResponse<String>	deleteText(String url)	Issue an HTTP DELETE to the provided URL, receiving a String in the response.
HttpClientResponse<byte[]>	getBinary(String url, byte[] binary)	Issue an HTTP GET to the provided URL, sending the provided byte and receiving a byte in the response.
org.apache.http.client.methods.CloseableHttpResponse	getFile(String path)	Download a file from a specified location to a specified destination on local host.
org.apache.http.client.methods.CloseableHttpResponse	getFile(String path, ContentType... acceptTypes)	Download a file from a specified location to a specified destination on local host.
HttpClientResponse<Object>	getJaxb(String url, Class<?>... responseTypes)	Issue an HTTP GET to the provided URL, receiving a JAXB Object in the response.
HttpClientResponse<com.google.gson.JsonObject>	getJson(String url)	Issue an HTTP GET to the provided URL, receiving a com.google.gson.JsonObject in the response.
SSLContext	getSSLContext()	Get the SSL context used by this client
HttpClientResponse<String>	getText(String url)	Issue an HTTP GET to the provided URL, receiving a String in the response.
String	getUsername()	Get the username set for this client
String	getUsername(URI scope)	Get the username set for this client for a specific scope
HttpClientResponse<String>	head(String url)	Execute an HttpClientRequest returning a JAXB object available through the returned HttpClientResponse.
HttpClientResponse<com.google.gson.JsonObject>	patchJson(String url, com.google.gson.JsonObject json)	Issue an HTTP PATCH to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.
Object	post(String path, Map<String,String> queryParams, ContentType contentType, Object data, ContentType[] acceptTypes, Class<?>[] jaxbClasses, boolean retry)
HttpClientResponse<byte[]>	postBinary(String url, byte[] binary)	Issue an HTTP POST to the provided URL, sending the provided byte and receiving a byte in the response.
Object	postForm(String path, Map<String,String> queryParams, HashMap<String,String> fields, ContentType[] acceptTypes, Class<?>[] jaxbClasses, boolean retry)
HttpClientResponse<Object>	postJaxb(String url, Object jaxbObject, Class<?>... responseTypes)	Issue an HTTP POST to the provided URL, sending the provided jaxbObject and receiving a JAXB Object in the response.
HttpClientResponse<com.google.gson.JsonObject>	postJson(String url, com.google.gson.JsonObject json)	Issue an HTTP POST to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.
HttpClientResponse<String>	postSOAP(String url, String xml)	Issue an HTTP POST to the provided URL, sending the provided XML as a String and receiving a String in the response.
HttpClientResponse<String>	postText(String url, String text)	Issue an HTTP POST to the provided URL, sending the provided String and receiving a String in the response.
HttpClientResponse<String>	postXML(String url, String xml)	Issue an HTTP POST to the provided URL, sending the provided XML as a String and receiving a String in the response.
HttpClientResponse<byte[]>	putBinary(String url, byte[] binary)	Issue an HTTP PUT to the provided URL, sending the provided byte and receiving a byte in the response.
void	putFile(String path, InputStream file)	Send a compressed (tar) file from a local location to a specified destination on a host.
HttpClientResponse<Object>	putJaxb(String url, Object jaxbObject, Class<?>... responseTypes)	Issue an HTTP PUT to the provided URL, sending the provided jaxbObject and receiving a JAXB Object in the response.
HttpClientResponse<com.google.gson.JsonObject>	putJson(String url, com.google.gson.JsonObject json)	Issue an HTTP PUT to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.
HttpClientResponse<String>	putSOAP(String url, String xml)	Issue an HTTP PUT to the provided URL, sending the provided XML as a String and receiving a String in the response.
HttpClientResponse<String>	putText(String url, String text)	Issue an HTTP PUT to the provided URL, sending the provided String and receiving a String in the response.
HttpClientResponse<String>	putXML(String url, String xml)	Issue an HTTP PUT to the provided URL, sending the provided XML as a String and receiving a String in the response.
IHttpClient	setAuthorisation(String username, String password)	Set the username and password for all scopes
IHttpClient	setAuthorisation(String username, String password, URI scope)	Set the username and password for a specific scope
IHttpClient	setHostnameVerifier(HostnameVerifier hostnameVerifier)	Set the hostname verifier
IHttpClient	setNoopHostnameVerifier()	Set the hostname verifier to a no-op verifier
IHttpClient	setSSLContext(SSLContext sslContext)	Set the SSL Context
IHttpClient	setTrustingSSLContext()	Set the SSL Context to a Trust All context
IHttpClient	setupClientAuth(KeyStore clientKeyStore, KeyStore serverKeyStore, String alias, String password)	Set up Client Authentication SSL Context and install
void	setURI(URI host)	Set the URI endpoint for this client

Method Details

getJaxb

HttpClientResponse<Object> getJaxb(String url,
 Class<?>... responseTypes)
                            throws HttpClientException

Issue an HTTP GET to the provided URL, receiving a JAXB Object in the response. In order to unmarshal the response, an array of possible response classes must be provided in responseTypes

Parameters:

url -

responseTypes -

Returns:

- HttpClientResponse with a JAXB content type

Throws:

HttpClientException

putJaxb

HttpClientResponse<Object> putJaxb(String url,
 Object jaxbObject,
 Class<?>... responseTypes)
                            throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided jaxbObject and receiving a JAXB Object in the response. In order to unmarshal the response, an array of possible response classes must be provided in responseTypes

Parameters:

url -

jaxbObject -

responseTypes -

Returns:

- HttpClientResponse with a JAXB content type

Throws:

HttpClientException

postJaxb

HttpClientResponse<Object> postJaxb(String url,
 Object jaxbObject,
 Class<?>... responseTypes)
                             throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided jaxbObject and receiving a JAXB Object in the response. In order to unmarshal the response, an array of possible response classes must be provided in responseTypes

Parameters:

url -

jaxbObject -

responseTypes -

Returns:

- HttpClientResponse with a JAXB content type

Throws:

HttpClientException

deleteJaxb

HttpClientResponse<Object> deleteJaxb(String url,
 Class<?>... responseTypes)
                               throws HttpClientException

Issue an HTTP DELETE to the provided URL, receiving a JAXB Object in the response. In order to unmarshal the response, an array of possible response classes must be provided in responseTypes

Parameters:

url -

responseTypes -

Returns:

- HttpClientResponse with a JAXB content type

Throws:

HttpClientException

putXML

HttpClientResponse<String> putXML(String url,
 String xml)
                           throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided XML as a String and receiving a String in the response.

Parameters:

url -

xml -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

postSOAP

HttpClientResponse<String> postSOAP(String url,
 String xml)
                             throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided XML as a String and receiving a String in the response. Uses a content type of application/soap+xml

Parameters:

url -

xml -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

putSOAP

HttpClientResponse<String> putSOAP(String url,
 String xml)
                            throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided XML as a String and receiving a String in the response. Uses a content type of application/soap+xml

Parameters:

url -

xml -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

postXML

HttpClientResponse<String> postXML(String url,
 String xml)
                            throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided XML as a String and receiving a String in the response.

Parameters:

url -

xml -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

getJson

HttpClientResponse<com.google.gson.JsonObject> getJson(String url)
                                                throws HttpClientException

Issue an HTTP GET to the provided URL, receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

postJson

HttpClientResponse<com.google.gson.JsonObject> postJson(String url,
 com.google.gson.JsonObject json)
                                                 throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

json -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

patchJson

HttpClientResponse<com.google.gson.JsonObject> patchJson(String url,
 com.google.gson.JsonObject json)
                                                  throws HttpClientException

Issue an HTTP PATCH to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

json -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

putJson

HttpClientResponse<com.google.gson.JsonObject> putJson(String url,
 com.google.gson.JsonObject json)
                                                throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

json -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

deleteJson

HttpClientResponse<com.google.gson.JsonObject> deleteJson(String url)
                                                   throws HttpClientException

Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

deleteJson

HttpClientResponse<com.google.gson.JsonObject> deleteJson(String url,
 com.google.gson.JsonObject json)
                                                   throws HttpClientException

Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in the response.

Parameters:

url -

json -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

getText

HttpClientResponse<String> getText(String url)
                            throws HttpClientException

Issue an HTTP GET to the provided URL, receiving a String in the response.

Parameters:

url -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

postText

HttpClientResponse<String> postText(String url,
 String text)
                             throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided String and receiving a String in the response.

Parameters:

url -

text -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

putText

HttpClientResponse<String> putText(String url,
 String text)
                            throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided String and receiving a String in the response.

Parameters:

url -

text -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

deleteText

HttpClientResponse<String> deleteText(String url)
                               throws HttpClientException

Issue an HTTP DELETE to the provided URL, receiving a String in the response.

Parameters:

url -

Returns:

- HttpClientResponse with a String content type

Throws:

HttpClientException

putBinary

HttpClientResponse<byte[]> putBinary(String url,
 byte[] binary)
                              throws HttpClientException

Issue an HTTP PUT to the provided URL, sending the provided byte and receiving a byte in the response.

Parameters:

url -

binary -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

getBinary

HttpClientResponse<byte[]> getBinary(String url,
 byte[] binary)
                              throws HttpClientException

Issue an HTTP GET to the provided URL, sending the provided byte and receiving a byte in the response.

Parameters:

url -

binary -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

postBinary

HttpClientResponse<byte[]> postBinary(String url,
 byte[] binary)
                               throws HttpClientException

Issue an HTTP POST to the provided URL, sending the provided byte and receiving a byte in the response.

Parameters:

url -

binary -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

deleteBinary

HttpClientResponse<byte[]> deleteBinary(String url,
 byte[] binary)
                                 throws HttpClientException

Issue an HTTP DELETE to the provided URL, sending the provided byte and receiving a byte in the response.

Parameters:

url -

binary -

Returns:

- HttpClientResponse with a com.google.gson.JsonObject content type

Throws:

HttpClientException

getFile

org.apache.http.client.methods.CloseableHttpResponse getFile(String path)
                                                      throws HttpClientException

Download a file from a specified location to a specified destination on local host.

Parameters:

path - = URL path

Throws:

HttpClientException

getFile

org.apache.http.client.methods.CloseableHttpResponse getFile(String path,
 ContentType... acceptTypes)
                                                      throws HttpClientException

Download a file from a specified location to a specified destination on local host.

Parameters:

acceptTypes -

path - - URL path

Throws:

HttpClientException

putFile

void putFile(String path,
 InputStream file)

Send a compressed (tar) file from a local location to a specified destination on a host.

Parameters:

path - - URL path

file - - tar archive file

head

HttpClientResponse<String> head(String url)
                         throws HttpClientException

Execute an HttpClientRequest returning a JAXB object available through the returned HttpClientResponse. In order to unmarshal the response, an array of possible response classes must be provided in responseTypes *

Parameters:

url -

Returns:

- HttpClientResponse

Throws:

HttpClientException

post

Object post(String path,
 Map<String,String> queryParams,
 ContentType contentType,
 Object data,
 ContentType[] acceptTypes,
 Class<?>[] jaxbClasses,
 boolean retry)
     throws HttpClientException

Throws:

HttpClientException

postForm

Object postForm(String path,
 Map<String,String> queryParams,
 HashMap<String,String> fields,
 ContentType[] acceptTypes,
 Class<?>[] jaxbClasses,
 boolean retry)
         throws HttpClientException

Throws:

HttpClientException

getSSLContext

SSLContext getSSLContext()

Get the SSL context used by this client

Returns:

the SSLContext or null if there is none

getUsername

String getUsername()

Get the username set for this client

Returns:

the username

getUsername

String getUsername(URI scope)

Get the username set for this client for a specific scope

Parameters:

scope -

Returns:

the username

addCommonHeader

void addCommonHeader(String name,
 String value)

Add a header that will be used on all http requests

Parameters:

name -

value -

clearCommonHeaders

void clearCommonHeaders()

Remove all headers for this http request

addOkResponseCode

void addOkResponseCode(int responseCode)

Add a response code for the execute to ignore and treat as OK

Parameters:

responseCode -

build

IHttpClient build()

Build the client

Returns:

the built client

close

void close()

close the underlying HTTPClient

setAuthorisation

IHttpClient setAuthorisation(String username,
 String password)

Set the username and password for all scopes

Parameters:

username -

password -

Returns:

the updated client

setAuthorisation

IHttpClient setAuthorisation(String username,
 String password,
 URI scope)

Set the username and password for a specific scope

Parameters:

username -

password -

scope -

Returns:

the updated client

setHostnameVerifier

IHttpClient setHostnameVerifier(HostnameVerifier hostnameVerifier)

Set the hostname verifier

Parameters:

hostnameVerifier -

Returns:

the updated client

setNoopHostnameVerifier

IHttpClient setNoopHostnameVerifier()

Set the hostname verifier to a no-op verifier

Returns:

the updated client

setSSLContext

IHttpClient setSSLContext(SSLContext sslContext)

Set the SSL Context

Parameters:

sslContext -

Returns:

the updated client

setTrustingSSLContext

IHttpClient setTrustingSSLContext()
                           throws HttpClientException

Set the SSL Context to a Trust All context

Returns:

the updated client

Throws:

HttpClientException

setupClientAuth

IHttpClient setupClientAuth(KeyStore clientKeyStore,
 KeyStore serverKeyStore,
 String alias,
 String password)
                     throws HttpClientException

Set up Client Authentication SSL Context and install

Parameters:

clientKeyStore -

serverKeyStore -

alias -

password -

Returns:

the updated client

Throws:

HttpClientException

setURI

void setURI(URI host)

Set the URI endpoint for this client

Parameters:

host -