au.com.dius.pact.core.pactbroker

Class PactBrokerClient

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

public class PactBrokerClient

Client for the pact broker service

Field Detail

LATEST_PROVIDER_PACTS_WITH_NO_TAG

@NotNull
public static java.lang.String LATEST_PROVIDER_PACTS_WITH_NO_TAG

See Also:

Constant Field Values

LATEST_PROVIDER_PACTS

@NotNull
public static java.lang.String LATEST_PROVIDER_PACTS

See Also:

Constant Field Values

LATEST_PROVIDER_PACTS_WITH_TAG

@NotNull
public static java.lang.String LATEST_PROVIDER_PACTS_WITH_TAG

See Also:

Constant Field Values

PROVIDER

@NotNull
public static java.lang.String PROVIDER

See Also:

Constant Field Values

PROVIDER_TAG_VERSION

@NotNull
public static java.lang.String PROVIDER_TAG_VERSION

See Also:

Constant Field Values

PACTS

@NotNull
public static java.lang.String PACTS

See Also:

Constant Field Values

UTF8

@NotNull
public static java.lang.String UTF8

See Also:

Constant Field Values

Companion

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

Constructor Detail

PactBrokerClient

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

Client for the pact broker service

PactBrokerClient

public PactBrokerClient(@NotNull
                        java.lang.String pactBrokerUrl)

Method Detail

fetchConsumers

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

Fetches all consumers for the given provider

fetchConsumersWithTag

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

Fetches all consumers for the given provider and tag

uploadPactFile

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

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

uploadPactFile

@JvmOverloads
 @Nullable
public java.lang.Object uploadPactFile(@NotNull
                                                                java.io.File pactFile,
                                                                @NotNull
                                                                java.lang.String unescapedVersion)

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

getUrlForProvider

@Nullable
public java.lang.String getUrlForProvider(@NotNull
                                                    java.lang.String providerName,
                                                    @NotNull
                                                    java.lang.String tag)

fetchPact

@NotNull
public PactResponse fetchPact(@NotNull
                                       java.lang.String url)

newHalClient

@NotNull
public IHalClient newHalClient()

publishVerificationResults

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

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

publishVerificationResults

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

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

buildPayload

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

fetchLatestConsumersWithNoTag

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

Fetches the consumers of the provider that have no associated tag

publishProviderTag

public void publishProviderTag(@NotNull
                               java.util.Map<java.lang.String,? extends java.lang.Object> docAttributes,
                               @NotNull
                               java.lang.String name,
                               @NotNull
                               java.lang.String tag,
                               @NotNull
                               java.lang.String version)

getPactBrokerUrl

@NotNull
public java.lang.String getPactBrokerUrl()

getOptions

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