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

Field Detail

ROOT

@NotNull
public static java.lang.String ROOT

See Also:

Constant Field Values

LINKS

@NotNull
public static java.lang.String LINKS

See Also:

Constant Field Values

PREEMPTIVE_AUTHENTICATION

@NotNull
public static java.lang.String PREEMPTIVE_AUTHENTICATION

See Also:

Constant Field Values

Companion

public static au.com.dius.pact.core.pactbroker.HalClient.Companion Companion

Constructor Detail

HalClient

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

HAL client for navigating the HAL links

HalClient

@JvmOverloads
public HalClient(@NotNull
                               java.lang.String baseUrl)

HAL client for navigating the HAL links

Method Detail

getHttpClient

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

setHttpClient

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

getHttpContext

@Nullable
public org.apache.http.client.protocol.HttpClientContext getHttpContext()

setHttpContext

public void setHttpContext(@Nullable
                           org.apache.http.client.protocol.HttpClientContext p)

getPathInfo

@Nullable
public au.com.dius.pact.core.support.json.JsonValue.Object getPathInfo()

setPathInfo

public void setPathInfo(@Nullable
                        au.com.dius.pact.core.support.json.JsonValue.Object p)

getLastUrl

@Nullable
public java.lang.String getLastUrl()

setLastUrl

public void setLastUrl(@Nullable
                       java.lang.String p)

getDefaultHeaders

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

setDefaultHeaders

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

initialiseRequest

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

postJson

@NotNull
public 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
public 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

setupHttpClient

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

navigate

@NotNull
public IHalClient navigate()

Navigates to the Root

navigate

@NotNull
public 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
public 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

fetch

@NotNull
public com.github.michaelbull.result.Result<au.com.dius.pact.core.support.json.JsonValue.Object,java.lang.Exception> 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

fetch

@NotNull
public com.github.michaelbull.result.Result<au.com.dius.pact.core.support.json.JsonValue.Object,java.lang.Exception> 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

withDocContext

@NotNull
public 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)

withDocContext

@NotNull
public IHalClient withDocContext(@NotNull
                                          au.com.dius.pact.core.support.json.JsonValue.Object docAttributes)

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

getJson

@NotNull
public com.github.michaelbull.result.Result<au.com.dius.pact.core.support.json.JsonValue,java.lang.Exception> getJson(@NotNull
                                                                                                                               java.lang.String path)

Get JSON from the provided path

getJson

@NotNull
public com.github.michaelbull.result.Result<au.com.dius.pact.core.support.json.JsonValue,java.lang.Exception> getJson(@NotNull
                                                                                                                               java.lang.String path,
                                                                                                                               boolean encodePath)

Get JSON from the provided path

Parameters:

path - Path to fetch the JSON document from

encodePath - If the path should be encoded

parseLinkUrl

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

initPathInfo

public void initPathInfo()

handleFailure

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

linkUrl

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

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

forAll

public 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

putJson

@NotNull
public 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

postJson

@NotNull
public com.github.michaelbull.result.Result<au.com.dius.pact.core.support.json.JsonValue.Object,java.lang.Exception> postJson(@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 POST request

getBaseUrl

@NotNull
public java.lang.String getBaseUrl()

getOptions

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

setOptions

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

asMap

@JvmStatic
 @NotNull
public static java.util.Map<java.lang.String,java.lang.Object> asMap(@NotNull
                                                                                          au.com.dius.pact.core.support.json.JsonValue.Object jsonObject)