Package org.springframework.cloud.contract.spec.internal

Class OutputMessage

java.lang.Object

org.springframework.cloud.contract.spec.internal.Common

org.springframework.cloud.contract.spec.internal.OutputMessage

public class OutputMessage
extends Common

Represents an output for messaging. Used for verifying the body and headers that are sent.

Since:

1.0.0

Author:

Marcin Grzejszczak, Tim Ysewyn

Constructor Summary

Constructors

Constructor	Description
OutputMessage()
OutputMessage(OutputMessage outputMessage)

Method Summary

Modifier and Type	Method	Description
DslProperty	$(Pattern pattern)
DslProperty	$(OptionalProperty property)
DslProperty	$(RegexProperty pattern)
DslProperty	$(ServerDslProperty property)
ServerDslProperty	aBoolean()
ServerDslProperty	anyAlphaNumeric()
ServerDslProperty	anyAlphaUnicode()
ServerDslProperty	anyDate()
ServerDslProperty	anyDateTime()
ServerDslProperty	anyDouble()
ServerDslProperty	anyEmail()
ServerDslProperty	anyHex()
ServerDslProperty	anyHostname()
ServerDslProperty	anyHttpsUrl()
ServerDslProperty	anyInteger()
ServerDslProperty	anyIpAddress()
ServerDslProperty	anyIso8601WithOffset()
ServerDslProperty	anyNonBlankString()
ServerDslProperty	anyNonEmptyString()
ServerDslProperty	anyNumber()
ServerDslProperty	anyOf(String... values)
ServerDslProperty	anyPositiveInt()
ServerDslProperty	anyTime()
ServerDslProperty	anyUrl()
ServerDslProperty	anyUuid()
void	assertThat(String assertThat)
void	body(Object bodyAsValue)
void	body(DslProperty bodyAsValue)
void	bodyMatchers(groovy.lang.Closure consumer)	The stub matchers part of the contract.
void	bodyMatchers(Consumer<ResponseBodyMatchers> consumer)	The stub matchers part of the contract.
boolean	equals(Object o)
ExecutionProperty	getAssertThat()
DslProperty	getBody()
ResponseBodyMatchers	getBodyMatchers()
Headers	getHeaders()
org.springframework.cloud.contract.spec.internal.OutputMessage.ServerPatternValueDslProperty	getProperty()
DslProperty<String>	getSentTo()
int	hashCode()
void	headers(groovy.lang.Closure consumer)	The message headers part of the contract.
void	headers(Consumer<Headers> consumer)	The message headers part of the contract.
RegexProperty	regexProperty(Object object)
void	sentTo(String sentTo)
void	sentTo(DslProperty sentTo)
void	setAssertThat(ExecutionProperty assertThat)
void	setBody(DslProperty body)
void	setBodyMatchers(ResponseBodyMatchers bodyMatchers)
void	setHeaders(Headers headers)
void	setProperty(org.springframework.cloud.contract.spec.internal.OutputMessage.ServerPatternValueDslProperty property)
void	setSentTo(DslProperty<String> sentTo)
String	toString()
DslProperty	value(RegexProperty pattern)
DslProperty	value(ServerDslProperty serverDslProperty)

Methods inherited from class org.springframework.cloud.contract.spec.internal.Common

$, $, $, $, aDouble, alphaNumeric, anInteger, anyBoolean, assertThatSidesMatch, c, client, consumer, convertObjectsToDslProperties, convertObjectsToDslProperties, email, execute, file, file, fileAsBytes, hostname, httpsUrl, ipAddress, iso8601WithOffset, isoDate, isoDateTime, isoTime, named, named, named, nonBlank, nonEmpty, number, onlyAlphaUnicode, optional, p, positiveInt, producer, regex, regex, regex, server, stub, test, toDslProperty, toDslProperty, toDslProperty, toDslProperty, url, uuid, value, value, value, value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OutputMessage

public OutputMessage()

OutputMessage

public OutputMessage(OutputMessage outputMessage)

Method Detail

sentTo

public void sentTo(String sentTo)

sentTo

public void sentTo(DslProperty sentTo)

body

public void body(Object bodyAsValue)

body

public void body(DslProperty bodyAsValue)

assertThat

public void assertThat(String assertThat)

value

public DslProperty value(ServerDslProperty serverDslProperty)

$

public DslProperty $(ServerDslProperty property)

$

public DslProperty $(Pattern pattern)

$

public DslProperty $(RegexProperty pattern)

value

public DslProperty value(RegexProperty pattern)

$

public DslProperty $(OptionalProperty property)

regexProperty

public RegexProperty regexProperty(Object object)

Overrides:

regexProperty in class Common

getProperty

public org.springframework.cloud.contract.spec.internal.OutputMessage.ServerPatternValueDslProperty getProperty()

setProperty

public void setProperty(org.springframework.cloud.contract.spec.internal.OutputMessage.ServerPatternValueDslProperty property)

getSentTo

public DslProperty<String> getSentTo()

setSentTo

public void setSentTo(DslProperty<String> sentTo)

getHeaders

public Headers getHeaders()

setHeaders

public void setHeaders(Headers headers)

getBody

public DslProperty getBody()

setBody

public void setBody(DslProperty body)

getAssertThat

public ExecutionProperty getAssertThat()

setAssertThat

public void setAssertThat(ExecutionProperty assertThat)

getBodyMatchers

public ResponseBodyMatchers getBodyMatchers()

setBodyMatchers

public void setBodyMatchers(ResponseBodyMatchers bodyMatchers)

anyAlphaUnicode

public ServerDslProperty anyAlphaUnicode()

anyAlphaNumeric

public ServerDslProperty anyAlphaNumeric()

anyNumber

public ServerDslProperty anyNumber()

anyInteger

public ServerDslProperty anyInteger()

anyPositiveInt

public ServerDslProperty anyPositiveInt()

anyDouble

public ServerDslProperty anyDouble()

anyHex

public ServerDslProperty anyHex()

aBoolean

public ServerDslProperty aBoolean()

anyIpAddress

public ServerDslProperty anyIpAddress()

anyHostname

public ServerDslProperty anyHostname()

anyEmail

public ServerDslProperty anyEmail()

anyUrl

public ServerDslProperty anyUrl()

anyHttpsUrl

public ServerDslProperty anyHttpsUrl()

anyUuid

public ServerDslProperty anyUuid()

anyDate

public ServerDslProperty anyDate()

anyDateTime

public ServerDslProperty anyDateTime()

anyTime

public ServerDslProperty anyTime()

anyIso8601WithOffset

public ServerDslProperty anyIso8601WithOffset()

anyNonBlankString

public ServerDslProperty anyNonBlankString()

anyNonEmptyString

public ServerDslProperty anyNonEmptyString()

anyOf

public ServerDslProperty anyOf(String... values)

headers

public void headers(Consumer<Headers> consumer)

The message headers part of the contract.

Parameters:

consumer - function to manipulate the message headers

bodyMatchers

public void bodyMatchers(Consumer<ResponseBodyMatchers> consumer)

The stub matchers part of the contract.

Parameters:

consumer - function to manipulate the body matchers

headers

public void headers(@DelegatesTo(Headers.class)
                    groovy.lang.Closure consumer)

The message headers part of the contract.

Parameters:

consumer - function to manipulate the message headers

bodyMatchers

public void bodyMatchers(@DelegatesTo(ResponseBodyMatchers.class)
                         groovy.lang.Closure consumer)

The stub matchers part of the contract.

Parameters:

consumer - function to manipulate the body matchers

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object