au.com.dius.pact.consumer

Class MessagePactBuilder

au.com.dius.pact.consumer.MessagePactBuilder

public class MessagePactBuilder

PACT DSL builder for v3 specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessagePactBuilder.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static MessagePactBuilder.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
MessagePactBuilder(au.com.dius.pact.model.Consumer consumer, au.com.dius.pact.model.Provider provider, java.util.List<au.com.dius.pact.model.ProviderState> providerStates, java.util.List<au.com.dius.pact.model.v3.messaging.Message> messages) PACT DSL builder for v3 specification

Method Summary

Modifier and Type	Method and Description
static MessagePactBuilder	consumer(java.lang.String consumer) Name the consumer of the pact
MessagePactBuilder	expectsToReceive(java.lang.String description) Adds a message expectation in the pact.
MessagePactBuilder	given(java.lang.String providerState) Sets the provider state.
MessagePactBuilder	hasPactWith(java.lang.String provider) Name the provider that the consumer has a pact with.
au.com.dius.pact.model.v3.messaging.MessagePact	toPact() Convert this builder into a Pact
MessagePactBuilder	withContent(au.com.dius.pact.consumer.dsl.DslPart body) Adds the JSON body as the message content
MessagePactBuilder	withMetadata(java.util.Map<java.lang.String,? extends java.lang.Object> metadata) Adds the expected metadata to the message

Field Detail

Companion

public static MessagePactBuilder.Companion Companion

Constructor Detail

MessagePactBuilder

public MessagePactBuilder(au.com.dius.pact.model.Consumer consumer,
                          au.com.dius.pact.model.Provider provider,
                          java.util.List<au.com.dius.pact.model.ProviderState> providerStates,
                          java.util.List<au.com.dius.pact.model.v3.messaging.Message> messages)

PACT DSL builder for v3 specification

Parameters:

consumer - The consumer for the pact.

provider - The provider for the pact.

providerStates - Provider states

messages - Messages for the pact

Method Detail

hasPactWith

public MessagePactBuilder hasPactWith(java.lang.String provider)

Name the provider that the consumer has a pact with.

Parameters:

provider - provider name

Returns:

this builder.

given

public MessagePactBuilder given(java.lang.String providerState)

Sets the provider state.

Parameters:

providerState - state of the provider

Returns:

this builder.

expectsToReceive

public MessagePactBuilder expectsToReceive(java.lang.String description)

Adds a message expectation in the pact.

Parameters:

description - message description.

withMetadata

public MessagePactBuilder withMetadata(java.util.Map<java.lang.String,? extends java.lang.Object> metadata)

Adds the expected metadata to the message

withContent

public MessagePactBuilder withContent(au.com.dius.pact.consumer.dsl.DslPart body)

Adds the JSON body as the message content

toPact

public au.com.dius.pact.model.v3.messaging.MessagePact toPact()

Convert this builder into a Pact

consumer

public static MessagePactBuilder consumer(java.lang.String consumer)

Name the consumer of the pact

Parameters:

consumer - Consumer name