au.com.dius.pact.pactbroker

Interface IHalClient

All Known Implementing Classes:

HalClientBase

public IHalClient

Interface to a HAL Client

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonElement	fetch(java.lang.String path, boolean encodePath) Fetches the HAL document from the provided path
com.google.gson.JsonElement	fetch(java.lang.String path) 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
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
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
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
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

Method Detail

navigate

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

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

linkUrl

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

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

forAll

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

uploadJson

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

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

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.

postJson

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

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

fetch

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

fetch

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