Class Message
-
- All Implemented Interfaces:
-
au.com.dius.pact.core.model.Interaction
,au.com.dius.pact.core.model.messaging.MessageInteraction
public final class Message extends BaseInteraction implements MessageInteraction
Message in a Message Pact
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
Message.Companion
-
Field Summary
Fields Modifier and Type Field Description private final OptionalBody
messageContents
private final ContentType
contentType
private final Map<String, Map<String, JsonValue>>
pluginConfiguration
private OptionalBody
contents
private MatchingRules
matchingRules
private Generators
generators
private Map<String, Object>
metadata
private final String
interactionId
private String
description
private final List<ProviderState>
providerStates
private final Map<String, JsonValue>
comments
public final static Message.Companion
Companion
-
Constructor Summary
Constructors Constructor Description Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators, Map<String, Object> metadata, String interactionId)
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators, Map<String, Object> metadata)
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators)
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules)
Message(String description, List<ProviderState> providerStates, OptionalBody contents)
Message(String description, List<ProviderState> providerStates)
Message(String description)
-
Method Summary
Modifier and Type Method Description OptionalBody
getMessageContents()
Message contents ContentType
getContentType()
The content type of the message Map<String, Map<String, JsonValue>>
getPluginConfiguration()
Any configuration provided by plugins final OptionalBody
getContents()
final Unit
setContents(OptionalBody contents)
MatchingRules
getMatchingRules()
Matching rules for the message Unit
setMatchingRules(MatchingRules matchingRules)
Matching rules for the message Generators
getGenerators()
Generators for the message Unit
setGenerators(Generators generators)
Generators for the message Map<String, Object>
getMetadata()
Message Metadata Unit
setMetadata(Map<String, Object> metadata)
Message Metadata ByteArray
contentsAsBytes()
Returns the bytes of the message content String
contentsAsString()
Returns the message content as a String. Map<String, Object>
toMap(PactSpecVersion pactSpecVersion)
Converts this interaction to a Map final String
formatContents()
String
uniqueKey()
Generates a unique key for this interaction Boolean
conflictsWith(Interaction other)
Checks if this interaction conflicts with the other one. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final Message
withMetaData(Map<String, Object> metadata)
List<String>
validateForVersion(PactSpecVersion pactVersion)
Validates if this Interaction can be used with the provided Pact specification version V4Interaction
asV4Interaction()
Converts this interaction to a V4 format Boolean
isAsynchronousMessage()
If this interaction represents an asynchronous message Message
asMessage()
Return this interaction as a V3 message (if it is one), otherwise null V4Interaction.AsynchronousMessage
asAsynchronousMessage()
If this interaction is an asynchronous message, returns it. final static Message
fromJson(JsonValue.Object json)
Builds a message from a Map -
Methods inherited from class au.com.dius.pact.core.model.BaseInteraction
displayState, getComments, getDescription, getInteractionId, getProviderStates, setDescription
-
Methods inherited from class au.com.dius.pact.core.model.Interaction
asSynchronousMessages, asSynchronousRequestResponse, isSynchronousMessages, isSynchronousRequestResponse, isV4
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
Message
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators, Map<String, Object> metadata, String interactionId)
-
Message
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators, Map<String, Object> metadata)
-
Message
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules, Generators generators)
-
Message
Message(String description, List<ProviderState> providerStates, OptionalBody contents, MatchingRules matchingRules)
-
Message
Message(String description, List<ProviderState> providerStates, OptionalBody contents)
-
Message
Message(String description, List<ProviderState> providerStates)
-
Message
Message(String description)
-
-
Method Detail
-
getMessageContents
OptionalBody getMessageContents()
Message contents
-
getContentType
ContentType getContentType()
The content type of the message
-
getPluginConfiguration
Map<String, Map<String, JsonValue>> getPluginConfiguration()
Any configuration provided by plugins
-
getContents
final OptionalBody getContents()
-
setContents
final Unit setContents(OptionalBody contents)
-
getMatchingRules
MatchingRules getMatchingRules()
Matching rules for the message
-
setMatchingRules
Unit setMatchingRules(MatchingRules matchingRules)
Matching rules for the message
-
getGenerators
Generators getGenerators()
Generators for the message
-
setGenerators
Unit setGenerators(Generators generators)
Generators for the message
-
getMetadata
Map<String, Object> getMetadata()
Message Metadata
-
setMetadata
Unit setMetadata(Map<String, Object> metadata)
Message Metadata
-
contentsAsBytes
ByteArray contentsAsBytes()
Returns the bytes of the message content
-
contentsAsString
String contentsAsString()
Returns the message content as a String. This will convert the contents if necessary.
-
toMap
Map<String, Object> toMap(PactSpecVersion pactSpecVersion)
Converts this interaction to a Map
-
formatContents
final String formatContents()
-
conflictsWith
Boolean conflictsWith(Interaction other)
Checks if this interaction conflicts with the other one. Used for merging pact files.
-
withMetaData
final Message withMetaData(Map<String, Object> metadata)
-
validateForVersion
List<String> validateForVersion(PactSpecVersion pactVersion)
Validates if this Interaction can be used with the provided Pact specification version
-
asV4Interaction
V4Interaction asV4Interaction()
Converts this interaction to a V4 format
-
isAsynchronousMessage
Boolean isAsynchronousMessage()
If this interaction represents an asynchronous message
-
asMessage
Message asMessage()
Return this interaction as a V3 message (if it is one), otherwise null
-
asAsynchronousMessage
V4Interaction.AsynchronousMessage asAsynchronousMessage()
If this interaction is an asynchronous message, returns it. Otherwise returns null.
-
-
-
-