au.com.dius.pact.core.pactbroker

Class PactBrokerClient

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

All Implemented Interfaces:

IPactBrokerClient

public class PactBrokerClient
implements IPactBrokerClient

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_PACTS_FOR_VERIFICATION

@NotNull
public static java.lang.String PROVIDER_PACTS_FOR_VERIFICATION

See Also:

Constant Field Values

BETA_PROVIDER_PACTS_FOR_VERIFICATION

@NotNull
public static java.lang.String BETA_PROVIDER_PACTS_FOR_VERIFICATION

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,java.lang.Object> options,
                        @NotNull
                        PactBrokerClientConfig config)

Client for the pact broker service

PactBrokerClient

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

Deprecated.

Method Detail

fetchConsumers

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

Deprecated.

Fetches all consumers for the given provider

fetchConsumersWithTag

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

Deprecated.

Fetches all consumers for the given provider and tag

fetchConsumersWithSelectors

@NotNull
public com.github.michaelbull.result.Result<java.util.List,java.lang.Exception> fetchConsumersWithSelectors(@NotNull
                                                                                                                     java.lang.String providerName,
                                                                                                                     @NotNull
                                                                                                                     java.util.List<au.com.dius.pact.core.pactbroker.ConsumerVersionSelector> selectors,
                                                                                                                     @NotNull
                                                                                                                     java.util.List<java.lang.String> providerTags,
                                                                                                                     boolean enablePending,
                                                                                                                     @Nullable
                                                                                                                     java.lang.String includeWipPactsSince)

Fetches all consumers for the given provider and selectors

uploadPactFile

@JvmOverloads
 @NotNull
public com.github.michaelbull.result.Result<java.lang.String,java.lang.Exception> uploadPactFile(@NotNull
                                                                                                                         java.io.File pactFile,
                                                                                                                         @NotNull
                                                                                                                         java.lang.String version,
                                                                                                                         @NotNull
                                                                                                                         java.util.List<java.lang.String> tags)

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

uploadPactFile

@JvmOverloads
 @NotNull
public com.github.michaelbull.result.Result<java.lang.String,java.lang.Exception> uploadPactFile(@NotNull
                                                                                                                         java.io.File pactFile,
                                                                                                                         @NotNull
                                                                                                                         java.lang.String version)

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,
                                       boolean encodePath)

newHalClient

@NotNull
public IHalClient newHalClient()

publishVerificationResults

@NotNull
public com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.String> 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.

publishVerificationResults

@NotNull
public com.github.michaelbull.result.Result<java.lang.Boolean,java.lang.String> 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.

buildPayload

@NotNull
public au.com.dius.pact.core.support.json.JsonValue.Object buildPayload(@NotNull
                                                                                 TestResult result,
                                                                                 @NotNull
                                                                                 java.lang.String version,
                                                                                 @Nullable
                                                                                 java.lang.String buildUrl)

fetchLatestConsumersWithNoTag

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

Deprecated.

Fetches the consumers of the provider that have no associated tag

publishProviderTag

@Deprecated
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)

Deprecated.

publishProviderTags

@NotNull
public com.github.michaelbull.result.Result<java.lang.Boolean,java.util.List> publishProviderTags(@NotNull
                                                                                                           java.util.Map<java.lang.String,? extends java.lang.Object> docAttributes,
                                                                                                           @NotNull
                                                                                                           java.lang.String name,
                                                                                                           @NotNull
                                                                                                           java.util.List<java.lang.String> tags,
                                                                                                           @NotNull
                                                                                                           java.lang.String version)

Publish all the tags for the provider to the Pact broker

Parameters:

docAttributes - Attributes associated with the fetched Pact file

tags - Provider tags to tag the provider with

version - Provider version

canIDeploy

@NotNull
public CanIDeployResult canIDeploy(@NotNull
                                            java.lang.String pacticipant,
                                            @NotNull
                                            java.lang.String pacticipantVersion,
                                            @NotNull
                                            Latest latest,
                                            @Nullable
                                            java.lang.String to)

createVersionTag

@NotNull
public com.github.michaelbull.result.Result<java.lang.String,java.lang.Exception> createVersionTag(@NotNull
                                                                                                            java.lang.String pacticipant,
                                                                                                            @NotNull
                                                                                                            java.lang.String pacticipantVersion,
                                                                                                            @NotNull
                                                                                                            java.lang.String tag)

getPactBrokerUrl

@NotNull
public java.lang.String getPactBrokerUrl()

getOptions

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

Deprecated.

getConfig

@NotNull
public PactBrokerClientConfig getConfig()