au.com.dius.pact.core.pactbroker

Interface IHalClient

All Known Implementing Classes:

HalClient

public IHalClient

Interface to a HAL Client

Method Detail

navigate

@NotNull
IHalClient navigate(@NotNull
                             java.util.Map<java.lang.String,? extends java.lang.Object> options,
                             @NotNull
                             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

@NotNull
IHalClient navigate(@NotNull
                             java.lang.String link)

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

Parameters:

link - Link name to navigate

linkUrl

@Nullable
java.lang.String linkUrl(@NotNull
                                   java.lang.String name)

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

forAll

void forAll(@NotNull
            java.lang.String linkName,
            @NotNull
            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

@Deprecated
 @Nullable
java.lang.Object uploadJson(@NotNull
                                                   java.lang.String path,
                                                   @NotNull
                                                   java.lang.String bodyJson)

Deprecated.

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

@Deprecated
 @Nullable
java.lang.Object uploadJson(@NotNull
                                                   java.lang.String path,
                                                   @NotNull
                                                   java.lang.String bodyJson,
                                                   @NotNull
                                                   java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure)

Deprecated.

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 bereturned.

uploadJson

@Deprecated
 @Nullable
java.lang.Object uploadJson(@NotNull
                                                   java.lang.String path,
                                                   @NotNull
                                                   java.lang.String bodyJson,
                                                   @NotNull
                                                   java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> closure,
                                                   boolean encodePath)

Deprecated.

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 bereturned.

encodePath - If the path must be encoded beforehand.

postJson

@NotNull
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> postJson(@NotNull
                                                                                                               java.lang.String url,
                                                                                                               @NotNull
                                                                                                               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

@NotNull
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> postJson(@NotNull
                                                                                                               java.lang.String url,
                                                                                                               @NotNull
                                                                                                               java.lang.String body,
                                                                                                               @Nullable
                                                                                                               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

@NotNull
com.google.gson.JsonElement fetch(@NotNull
                                           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

@NotNull
com.google.gson.JsonElement fetch(@NotNull
                                           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

withDocContext

@NotNull
IHalClient withDocContext(@NotNull
                                   java.util.Map<java.lang.String,? extends java.lang.Object> docAttributes)

Sets the starting context from a previous broker interaction (Pact document)

putJson

@NotNull
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> putJson(@NotNull
                                                                                                              java.lang.String link,
                                                                                                              @NotNull
                                                                                                              java.util.Map<java.lang.String,? extends java.lang.Object> options,
                                                                                                              @NotNull
                                                                                                              java.lang.String json)

Upload a JSON document to the current path link, using a PUT request