au.com.dius.pact.core.pactbroker

Class HalClient

au.com.dius.pact.core.pactbroker.HalClient

All Implemented Interfaces:

IHalClient

public class HalClient
implements IHalClient

HAL client for navigating the HAL links

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HalClient.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static HalClient.Companion	Companion
static java.lang.String	LINKS
static java.lang.String	ROOT

Constructor Summary

Constructors

Constructor and Description
HalClient(java.lang.String baseUrl, java.util.Map<java.lang.String,? extends java.lang.Object> options) HAL client for navigating the HAL links
HalClient(java.lang.String baseUrl) HAL client for navigating the HAL links

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	asMap(com.google.gson.JsonObject jsonObject)
com.google.gson.JsonElement	fetch(java.lang.String path) Fetches the HAL document from the provided path
com.google.gson.JsonElement	fetch(java.lang.String path, boolean encodePath) Fetches the HAL document from the provided path
void	forAll(java.lang.String linkName, java.util.function.Consumer<java.util.Map> closure) Calls the closure with a Map of attributes for all links associated with the link name
static java.lang.Object	fromJson(com.google.gson.JsonElement jsonValue)
java.lang.String	getBaseUrl()
java.util.Map<java.lang.String,java.lang.String>	getDefaultHeaders()
org.apache.http.impl.client.CloseableHttpClient	getHttpClient()
java.lang.String	getLastUrl()
java.util.Map<java.lang.String,java.lang.Object>	getOptions()
com.google.gson.JsonElement	getPathInfo()
java.lang.Object	handleFailure(org.apache.http.HttpResponse resp, java.lang.String body, java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure)
void	initPathInfo()
<Method extends HttpMessage> Method	initialiseRequest(Method method)
java.lang.String	linkUrl(java.lang.String name) Returns the HREF of the named link from the current HAL document
IHalClient	navigate(java.util.Map<java.lang.String,? extends java.lang.Object> options, java.lang.String link) Navigates the URL associated with the given link using the current HAL document
IHalClient	navigate(java.lang.String link) Navigates the URL associated with the given link using the current HAL document
java.lang.String	parseLinkUrl(java.lang.String href, java.util.Map<java.lang.String,? extends java.lang.Object> options)
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception>	postJson(java.lang.String url, java.lang.String body) Upload the JSON document to the provided URL, using a POST request
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception>	postJson(java.lang.String url, java.lang.String body, kotlin.jvm.functions.Function2<? super java.lang.Integer,? super org.apache.http.client.methods.CloseableHttpResponse,java.lang.Boolean> handler) Upload the JSON document to the provided URL, using a POST request
void	setDefaultHeaders(java.util.Map<java.lang.String,java.lang.String> p)
void	setHttpClient(org.apache.http.impl.client.CloseableHttpClient p)
void	setLastUrl(java.lang.String p)
void	setOptions(java.util.Map<java.lang.String,? extends java.lang.Object> p)
void	setPathInfo(com.google.gson.JsonElement p)
org.apache.http.impl.client.CloseableHttpClient	setupHttpClient()
java.lang.Object	uploadJson(java.lang.String path, java.lang.String bodyJson) Upload the JSON document to the provided path, using a PUT request
java.lang.Object	uploadJson(java.lang.String path, java.lang.String bodyJson, java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure) Upload the JSON document to the provided path, using a PUT request
java.lang.Object	uploadJson(java.lang.String path, java.lang.String bodyJson, java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure, boolean encodePath) Upload the JSON document to the provided path, using a PUT request

Methods inherited from interface au.com.dius.pact.core.pactbroker.IHalClient

fetch, fetch, forAll, linkUrl, navigate, navigate, postJson, postJson, uploadJson, uploadJson, uploadJson

Field Detail

ROOT

public static java.lang.String ROOT

LINKS

public static java.lang.String LINKS

Companion

public static HalClient.Companion Companion

Constructor Detail

HalClient

public HalClient(java.lang.String baseUrl,
                 java.util.Map<java.lang.String,? extends java.lang.Object> options)

HAL client for navigating the HAL links

HalClient

public HalClient(java.lang.String baseUrl)

HAL client for navigating the HAL links

Method Detail

getHttpClient

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

setHttpClient

public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient p)

getPathInfo

public com.google.gson.JsonElement getPathInfo()

setPathInfo

public void setPathInfo(com.google.gson.JsonElement p)

getLastUrl

public java.lang.String getLastUrl()

setLastUrl

public void setLastUrl(java.lang.String p)

getDefaultHeaders

public java.util.Map<java.lang.String,java.lang.String> getDefaultHeaders()

setDefaultHeaders

public void setDefaultHeaders(java.util.Map<java.lang.String,java.lang.String> p)

initialiseRequest

public <Method extends HttpMessage> Method initialiseRequest(Method method)

postJson

public au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> postJson(java.lang.String url,
                                                                                                             java.lang.String body)

Upload the JSON document to the provided URL, using a POST request

Parameters:

url - Url to upload the document to

body - JSON contents for the body

Returns:

Returns a Success result object with a boolean value to indicate if the request was successful or not. Any exception will be wrapped in a Failure

postJson

public au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> postJson(java.lang.String url,
                                                                                                             java.lang.String body,
                                                                                                             kotlin.jvm.functions.Function2<? super java.lang.Integer,? super org.apache.http.client.methods.CloseableHttpResponse,java.lang.Boolean> handler)

Upload the JSON document to the provided URL, using a POST request

Parameters:

url - Url to upload the document to

body - JSON contents for the body

handler - Response handler

Returns:

Returns a Success result object with the boolean value returned from the handler closure. Any exception will be wrapped in a Failure

setupHttpClient

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

navigate

public IHalClient navigate(java.util.Map<java.lang.String,? extends java.lang.Object> options,
                           java.lang.String link)

Navigates the URL associated with the given link using the current HAL document

Parameters:

options - Map of key-value pairs to use for parsing templated links

link - Link name to navigate

navigate

public IHalClient navigate(java.lang.String link)

Navigates the URL associated with the given link using the current HAL document

Parameters:

link - Link name to navigate

fetch

public com.google.gson.JsonElement fetch(java.lang.String path)

Fetches the HAL document from the provided path

Parameters:

path - The path to the HAL document. If it is a relative path, it is relative to the base URL

fetch

public com.google.gson.JsonElement fetch(java.lang.String path,
                                         boolean encodePath)

Fetches the HAL document from the provided path

Parameters:

path - The path to the HAL document. If it is a relative path, it is relative to the base URL

encodePath - If the path should be encoded to make a valid URL

parseLinkUrl

public java.lang.String parseLinkUrl(java.lang.String href,
                                     java.util.Map<java.lang.String,? extends java.lang.Object> options)

initPathInfo

public void initPathInfo()

uploadJson

public java.lang.Object uploadJson(java.lang.String path,
                                   java.lang.String bodyJson)

Upload the JSON document to the provided path, using a PUT request

Parameters:

path - Path to upload the document

bodyJson - JSON contents for the body

uploadJson

public java.lang.Object uploadJson(java.lang.String path,
                                   java.lang.String bodyJson,
                                   java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure)

Upload the JSON document to the provided path, using a PUT request

Parameters:

path - Path to upload the document

bodyJson - JSON contents for the body

closure - Closure that will be invoked with details about the response. The result from the closure will be returned.

uploadJson

public java.lang.Object uploadJson(java.lang.String path,
                                   java.lang.String bodyJson,
                                   java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure,
                                   boolean encodePath)

Upload the JSON document to the provided path, using a PUT request

Parameters:

path - Path to upload the document

bodyJson - JSON contents for the body

closure - Closure that will be invoked with details about the response. The result from the closure will be returned.

encodePath - If the path must be encoded beforehand.

handleFailure

public java.lang.Object handleFailure(org.apache.http.HttpResponse resp,
                                      java.lang.String body,
                                      java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure)

linkUrl

public java.lang.String linkUrl(java.lang.String name)

Returns the HREF of the named link from the current HAL document

forAll

public void forAll(java.lang.String linkName,
                   java.util.function.Consumer<java.util.Map> closure)

Calls the closure with a Map of attributes for all links associated with the link name

Parameters:

linkName - Name of the link to loop over

closure - Closure to invoke with the link attributes

getBaseUrl

public java.lang.String getBaseUrl()

getOptions

public java.util.Map<java.lang.String,java.lang.Object> getOptions()

setOptions

public void setOptions(java.util.Map<java.lang.String,? extends java.lang.Object> p)

asMap

public static java.util.Map<java.lang.String,java.lang.Object> asMap(com.google.gson.JsonObject jsonObject)

fromJson

public static java.lang.Object fromJson(com.google.gson.JsonElement jsonValue)