au.com.dius.pact.core.pactbroker

Class PactBrokerClient

au.com.dius.pact.core.pactbroker.PactBrokerClient

public class PactBrokerClient

Client for the pact broker service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PactBrokerClient.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static PactBrokerClient.Companion	Companion
static java.lang.String	LATEST_PROVIDER_PACTS
static java.lang.String	LATEST_PROVIDER_PACTS_WITH_NO_TAG
static java.lang.String	LATEST_PROVIDER_PACTS_WITH_TAG
static java.lang.String	PACTS
static java.lang.String	UTF8

Constructor Summary

Constructors

Constructor and Description
PactBrokerClient(java.lang.String pactBrokerUrl, java.util.Map<java.lang.String,? extends java.lang.Object> options) Client for the pact broker service
PactBrokerClient(java.lang.String pactBrokerUrl)

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	buildPayload(TestResult result, java.lang.String version, java.lang.String buildUrl)
java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer>	fetchConsumers(java.lang.String provider) Fetches all consumers for the given provider
java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer>	fetchConsumersWithTag(java.lang.String provider, java.lang.String tag) Fetches all consumers for the given provider and tag
java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer>	fetchLatestConsumersWithNoTag(java.lang.String provider) Fetches the consumers of the provider that have no associated tag
PactResponse	fetchPact(java.lang.String url)
java.util.Map<java.lang.String,java.lang.Object>	getOptions()
java.lang.String	getPactBrokerUrl()
java.lang.String	getUrlForProvider(java.lang.String providerName, java.lang.String tag)
IHalClient	newHalClient()
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception>	publishVerificationResults(java.util.Map<java.lang.String,? extends java.util.Map<java.lang.String,? extends java.lang.Object>> docAttributes, TestResult result, java.lang.String version, java.lang.String buildUrl) Publishes the result to the "pb:publish-verification-results" link in the document attributes.
au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception>	publishVerificationResults(java.util.Map<java.lang.String,? extends java.util.Map<java.lang.String,? extends java.lang.Object>> docAttributes, TestResult result, java.lang.String version) Publishes the result to the "pb:publish-verification-results" link in the document attributes.
java.lang.Object	uploadPactFile(java.io.File pactFile, java.lang.String unescapedVersion, java.util.List<java.lang.String> tags) Uploads the given pact file to the broker, and optionally applies any tags
java.lang.Object	uploadPactFile(java.io.File pactFile, java.lang.String unescapedVersion) Uploads the given pact file to the broker, and optionally applies any tags

Field Detail

LATEST_PROVIDER_PACTS_WITH_NO_TAG

public static java.lang.String LATEST_PROVIDER_PACTS_WITH_NO_TAG

LATEST_PROVIDER_PACTS

public static java.lang.String LATEST_PROVIDER_PACTS

LATEST_PROVIDER_PACTS_WITH_TAG

public static java.lang.String LATEST_PROVIDER_PACTS_WITH_TAG

PACTS

public static java.lang.String PACTS

UTF8

public static java.lang.String UTF8

Companion

public static PactBrokerClient.Companion Companion

Constructor Detail

PactBrokerClient

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

Client for the pact broker service

PactBrokerClient

public PactBrokerClient(java.lang.String pactBrokerUrl)

Method Detail

fetchConsumers

public java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer> fetchConsumers(java.lang.String provider)

Fetches all consumers for the given provider

fetchConsumersWithTag

public java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer> fetchConsumersWithTag(java.lang.String provider,
                                                                                                 java.lang.String tag)

Fetches all consumers for the given provider and tag

uploadPactFile

public java.lang.Object uploadPactFile(java.io.File pactFile,
                                       java.lang.String unescapedVersion,
                                       java.util.List<java.lang.String> tags)

Uploads the given pact file to the broker, and optionally applies any tags

uploadPactFile

public java.lang.Object uploadPactFile(java.io.File pactFile,
                                       java.lang.String unescapedVersion)

Uploads the given pact file to the broker, and optionally applies any tags

getUrlForProvider

public java.lang.String getUrlForProvider(java.lang.String providerName,
                                          java.lang.String tag)

fetchPact

public PactResponse fetchPact(java.lang.String url)

newHalClient

public IHalClient newHalClient()

publishVerificationResults

public au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> publishVerificationResults(java.util.Map<java.lang.String,? extends java.util.Map<java.lang.String,? extends java.lang.Object>> docAttributes,
                                                                                                                               TestResult result,
                                                                                                                               java.lang.String version,
                                                                                                                               java.lang.String buildUrl)

Publishes the result to the "pb:publish-verification-results" link in the document attributes.

publishVerificationResults

public au.com.dius.pact.com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.Exception> publishVerificationResults(java.util.Map<java.lang.String,? extends java.util.Map<java.lang.String,? extends java.lang.Object>> docAttributes,
                                                                                                                               TestResult result,
                                                                                                                               java.lang.String version)

Publishes the result to the "pb:publish-verification-results" link in the document attributes.

buildPayload

public com.google.gson.JsonObject buildPayload(TestResult result,
                                               java.lang.String version,
                                               java.lang.String buildUrl)

fetchLatestConsumersWithNoTag

public java.util.List<au.com.dius.pact.core.pactbroker.PactBrokerConsumer> fetchLatestConsumersWithNoTag(java.lang.String provider)

Fetches the consumers of the provider that have no associated tag

getPactBrokerUrl

public java.lang.String getPactBrokerUrl()

getOptions

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