au.com.dius.pact.provider

Class PactBrokerOptions

au.com.dius.pact.provider.PactBrokerOptions

public class PactBrokerOptions

Field Detail

Companion

public static au.com.dius.pact.provider.PactBrokerOptions.Companion Companion

Constructor Detail

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags,
                                       @Nullable
                                       java.lang.String providerBranch,
                                       @Nullable
                                       java.lang.String includeWipPactsSince,
                                       boolean insecureTLS,
                                       @Nullable
                                       au.com.dius.pact.core.support.Auth auth)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

providerTags - Provider tags. Either this or providerBranch if pending pacts are enabled

providerBranch - Provider branch. Either this or providerTags if pending pacts are enabled

includeWipPactsSince - Only include WIP pacts since the provided date. Dates need to be in ISO format (YYYY-MM-DD).See https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/

insecureTLS - If we should enable insecure TLS. This will disable certificate hostname checks and accept all certificates.

auth - Authentication for the pact broker

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags,
                                       @Nullable
                                       java.lang.String providerBranch,
                                       @Nullable
                                       java.lang.String includeWipPactsSince,
                                       boolean insecureTLS)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

providerTags - Provider tags. Either this or providerBranch if pending pacts are enabled

providerBranch - Provider branch. Either this or providerTags if pending pacts are enabled

includeWipPactsSince - Only include WIP pacts since the provided date. Dates need to be in ISO format (YYYY-MM-DD).See https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/

insecureTLS - If we should enable insecure TLS. This will disable certificate hostname checks and accept all certificates.

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags,
                                       @Nullable
                                       java.lang.String providerBranch,
                                       @Nullable
                                       java.lang.String includeWipPactsSince)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

providerTags - Provider tags. Either this or providerBranch if pending pacts are enabled

providerBranch - Provider branch. Either this or providerTags if pending pacts are enabled

includeWipPactsSince - Only include WIP pacts since the provided date. Dates need to be in ISO format (YYYY-MM-DD).See https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags,
                                       @Nullable
                                       java.lang.String providerBranch)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

providerTags - Provider tags. Either this or providerBranch if pending pacts are enabled

providerBranch - Provider branch. Either this or providerTags if pending pacts are enabled

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

providerTags - Provider tags. Either this or providerBranch if pending pacts are enabled

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions(boolean enablePending)

Parameters:

enablePending - Enable pending pacts.See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

PactBrokerOptions

@JvmOverloads
public PactBrokerOptions()

Method Detail

toMutableMap

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

Deprecated.

getEnablePending

public boolean getEnablePending()

Enable pending pacts.

See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

getProviderTags

@NotNull
public java.util.List<java.lang.String> getProviderTags()

Provider tags.

Either this or providerBranch if pending pacts are enabled

getProviderBranch

@Nullable
public java.lang.String getProviderBranch()

Provider branch.

Either this or providerTags if pending pacts are enabled

getIncludeWipPactsSince

@Nullable
public java.lang.String getIncludeWipPactsSince()

Only include WIP pacts since the provided date.

Dates need to be in ISO format (YYYY-MM-DD).See https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/

getInsecureTLS

public boolean getInsecureTLS()

If we should enable insecure TLS.

This will disable certificate hostname checks and accept all certificates.

getAuth

@Nullable
public au.com.dius.pact.core.support.Auth getAuth()

Authentication for the pact broker

component1

public boolean component1()

Enable pending pacts.

See https://docs.pact.io/pact_broker/advanced_topics/pending_pacts

component2

@NotNull
public java.util.List<java.lang.String> component2()

Provider tags.

Either this or providerBranch if pending pacts are enabled

component3

@Nullable
public java.lang.String component3()

Provider branch.

Either this or providerTags if pending pacts are enabled

component4

@Nullable
public java.lang.String component4()

Only include WIP pacts since the provided date.

Dates need to be in ISO format (YYYY-MM-DD).See https://docs.pact.io/pact_broker/advanced_topics/wip_pacts/

component5

public boolean component5()

If we should enable insecure TLS.

This will disable certificate hostname checks and accept all certificates.

component6

@Nullable
public au.com.dius.pact.core.support.Auth component6()

Authentication for the pact broker

copy

@NotNull
public PactBrokerOptions copy(boolean enablePending,
                                       @NotNull
                                       java.util.List<java.lang.String> providerTags,
                                       @Nullable
                                       java.lang.String providerBranch,
                                       @Nullable
                                       java.lang.String includeWipPactsSince,
                                       boolean insecureTLS,
                                       @Nullable
                                       au.com.dius.pact.core.support.Auth auth)

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)

parseAuthSettings

@JvmStatic
 @Nullable
public static au.com.dius.pact.core.support.Auth parseAuthSettings(@NotNull
                                                                                         java.util.Map<java.lang.String,? extends java.lang.Object> options)

Parse the authentication options provided from the build tools. These must be under an 'authentication' key and must be either an instance of au.com.dius.pact.core.support.Auth or must be a list of strings, where the first item is the scheme.