au.com.dius.pact.core.model.messaging

Class Message

au.com.dius.pact.core.model.messaging.Message

All Implemented Interfaces:

Interaction

public class Message
implements Interaction

Message in a Message Pact

Field Detail

JSON

@NotNull
public static java.lang.String JSON

See Also:

Constant Field Values

Companion

public static au.com.dius.pact.core.model.messaging.Message.Companion Companion

Constructor Detail

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                             @NotNull
                             OptionalBody contents,
                             @NotNull
                             MatchingRules matchingRules,
                             @NotNull
                             Generators generators,
                             @NotNull
                             java.util.Map<java.lang.String,? extends java.lang.Object> metaData,
                             @Nullable
                             java.lang.String interactionId)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

interactionId - Interaction ID. Will only be populated from pacts loaded from a Pact Broker

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                             @NotNull
                             OptionalBody contents,
                             @NotNull
                             MatchingRules matchingRules,
                             @NotNull
                             Generators generators,
                             @NotNull
                             java.util.Map<java.lang.String,? extends java.lang.Object> metaData)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                             @NotNull
                             OptionalBody contents,
                             @NotNull
                             MatchingRules matchingRules,
                             @NotNull
                             Generators generators)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                             @NotNull
                             OptionalBody contents,
                             @NotNull
                             MatchingRules matchingRules)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates,
                             @NotNull
                             OptionalBody contents)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description,
                             @NotNull
                             java.util.List<au.com.dius.pact.core.model.ProviderState> providerStates)

Message in a Message Pact

Parameters:

description - Interaction description

providerStates - Returns the provider states for this interaction

Message

@JvmOverloads
public Message(@NotNull
                             java.lang.String description)

Message in a Message Pact

Parameters:

description - Interaction description

Method Detail

contentsAsBytes

@NotNull
public kotlin.Array[] contentsAsBytes()

contentsAsString

@NotNull
public java.lang.String contentsAsString()

getContentType

@NotNull
public java.lang.String getContentType()

getParsedContentType

@Deprecated
 @Nullable
public org.apache.http.entity.ContentType getParsedContentType()

Deprecated.

toMap

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> toMap(@NotNull
                                                                       PactSpecVersion pactSpecVersion)

Converts this interaction to a Map

formatContents

@NotNull
public java.lang.String formatContents()

uniqueKey

@NotNull
public java.lang.String uniqueKey()

Generates a unique key for this interaction

conflictsWith

public boolean conflictsWith(@NotNull
                             Interaction other)

Checks if this interaction conflicts with the other one. Used for merging pact files.

equals

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

hashCode

public int hashCode()

toString

@NotNull
public java.lang.String toString()

withMetaData

@NotNull
public Message withMetaData(@NotNull
                                     java.util.Map<java.lang.String,? extends java.lang.Object> metadata)

getDescription

@NotNull
public java.lang.String getDescription()

Interaction description

getProviderStates

@NotNull
public java.util.List<au.com.dius.pact.core.model.ProviderState> getProviderStates()

Returns the provider states for this interaction

getContents

@NotNull
public OptionalBody getContents()

setContents

public void setContents(@NotNull
                        OptionalBody p)

getMatchingRules

@NotNull
public MatchingRules getMatchingRules()

setMatchingRules

public void setMatchingRules(@NotNull
                             MatchingRules p)

getGenerators

@NotNull
public Generators getGenerators()

setGenerators

public void setGenerators(@NotNull
                          Generators p)

getMetaData

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

setMetaData

public void setMetaData(@NotNull
                        java.util.Map<java.lang.String,? extends java.lang.Object> p)

getInteractionId

@Nullable
public java.lang.String getInteractionId()

Interaction ID.

Will only be populated from pacts loaded from a Pact Broker

fromJson

@JvmStatic
 @NotNull
public static Message fromJson(@NotNull
                                                    com.google.gson.JsonObject json)

Builds a message from a Map