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

Class Input

java.lang.Object

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

org.springframework.cloud.contract.spec.internal.Input

public class Input
extends Common

Represents an input for messaging. The input can be a message or some action inside the application.

Since:

1.0.0

Author:

Marcin Grzejszczak, Tim Ysewyn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Input.BodyType

Constructor Summary

Constructors

Constructor	Description
Input()
Input(Input input)

Method Summary

Modifier and Type	Method	Description
DslProperty	$(ClientDslProperty client)
DslProperty	$(RegexProperty prop)
ClientDslProperty	aBoolean()
ClientDslProperty	anyAlphaNumeric()
ClientDslProperty	anyAlphaUnicode()
ClientDslProperty	anyDate()
ClientDslProperty	anyDateTime()
ClientDslProperty	anyDouble()
ClientDslProperty	anyEmail()
ClientDslProperty	anyHex()
ClientDslProperty	anyHostname()
ClientDslProperty	anyHttpsUrl()
ClientDslProperty	anyInteger()
ClientDslProperty	anyIpAddress()
ClientDslProperty	anyIso8601WithOffset()
ClientDslProperty	anyNonBlankString()
ClientDslProperty	anyNonEmptyString()
ClientDslProperty	anyNumber()
ClientDslProperty	anyOf(String... values)
ClientDslProperty	anyPositiveInt()
ClientDslProperty	anyTime()
ClientDslProperty	anyUrl()
ClientDslProperty	anyUuid()
void	assertThat(String assertThat)
void	bodyMatchers(groovy.lang.Closure consumer)	The stub matchers part of the contract.
void	bodyMatchers(Consumer<BodyMatchers> consumer)	The stub matchers part of the contract.
boolean	equals(Object o)
ExecutionProperty	getAssertThat()
BodyMatchers	getBodyMatchers()
Input.BodyType	getMessageBody()
DslProperty<String>	getMessageFrom()
Headers	getMessageHeaders()
org.springframework.cloud.contract.spec.internal.Input.ClientPatternValueDslProperty	getProperty()
ExecutionProperty	getTriggeredBy()
int	hashCode()
Input.BodyType	messageBody(Object bodyAsValue)
void	messageFrom(String messageFrom)	Name of a destination from which message would come to trigger action in the system.
void	messageFrom(DslProperty messageFrom)	Name of a destination from which message would come to trigger action in the system.
void	messageHeaders(groovy.lang.Closure consumer)	The message headers part of the contract.
void	messageHeaders(Consumer<Headers> consumer)	The message headers part of the contract.
RegexProperty	regexProperty(Object object)
void	setAssertThat(ExecutionProperty assertThat)
void	setBodyMatchers(BodyMatchers bodyMatchers)
void	setMessageBody(Input.BodyType messageBody)
void	setMessageFrom(DslProperty<String> messageFrom)
void	setMessageHeaders(Headers messageHeaders)
void	setProperty(org.springframework.cloud.contract.spec.internal.Input.ClientPatternValueDslProperty property)
void	setTriggeredBy(ExecutionProperty triggeredBy)
String	toString()
void	triggeredBy(String triggeredBy)	Function that needs to be executed to trigger action in the system.
DslProperty	value(ClientDslProperty client)
DslProperty	value(RegexProperty prop)

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

Input

public Input()

Input

public Input(Input input)

Method Detail

messageFrom

public void messageFrom(String messageFrom)

Name of a destination from which message would come to trigger action in the system.

Parameters:

messageFrom - message destination

messageFrom

public void messageFrom(DslProperty messageFrom)

Name of a destination from which message would come to trigger action in the system.

Parameters:

messageFrom - message destination

triggeredBy

public void triggeredBy(String triggeredBy)

Function that needs to be executed to trigger action in the system.

Parameters:

triggeredBy - method name that triggers the message

messageBody

public Input.BodyType messageBody(Object bodyAsValue)

value

public DslProperty value(ClientDslProperty client)

value

public DslProperty value(RegexProperty prop)

$

public DslProperty $(RegexProperty prop)

$

public DslProperty $(ClientDslProperty client)

regexProperty

public RegexProperty regexProperty(Object object)

Overrides:

regexProperty in class Common

assertThat

public void assertThat(String assertThat)

getProperty

public org.springframework.cloud.contract.spec.internal.Input.ClientPatternValueDslProperty getProperty()

setProperty

public void setProperty(org.springframework.cloud.contract.spec.internal.Input.ClientPatternValueDslProperty property)

getMessageFrom

public DslProperty<String> getMessageFrom()

setMessageFrom

public void setMessageFrom(DslProperty<String> messageFrom)

getTriggeredBy

public ExecutionProperty getTriggeredBy()

setTriggeredBy

public void setTriggeredBy(ExecutionProperty triggeredBy)

getMessageHeaders

public Headers getMessageHeaders()

setMessageHeaders

public void setMessageHeaders(Headers messageHeaders)

getMessageBody

public Input.BodyType getMessageBody()

setMessageBody

public void setMessageBody(Input.BodyType messageBody)

getAssertThat

public ExecutionProperty getAssertThat()

setAssertThat

public void setAssertThat(ExecutionProperty assertThat)

getBodyMatchers

public BodyMatchers getBodyMatchers()

setBodyMatchers

public void setBodyMatchers(BodyMatchers bodyMatchers)

anyAlphaUnicode

public ClientDslProperty anyAlphaUnicode()

anyAlphaNumeric

public ClientDslProperty anyAlphaNumeric()

anyNumber

public ClientDslProperty anyNumber()

anyInteger

public ClientDslProperty anyInteger()

anyPositiveInt

public ClientDslProperty anyPositiveInt()

anyDouble

public ClientDslProperty anyDouble()

anyHex

public ClientDslProperty anyHex()

aBoolean

public ClientDslProperty aBoolean()

anyIpAddress

public ClientDslProperty anyIpAddress()

anyHostname

public ClientDslProperty anyHostname()

anyEmail

public ClientDslProperty anyEmail()

anyUrl

public ClientDslProperty anyUrl()

anyHttpsUrl

public ClientDslProperty anyHttpsUrl()

anyUuid

public ClientDslProperty anyUuid()

anyDate

public ClientDslProperty anyDate()

anyDateTime

public ClientDslProperty anyDateTime()

anyTime

public ClientDslProperty anyTime()

anyIso8601WithOffset

public ClientDslProperty anyIso8601WithOffset()

anyNonBlankString

public ClientDslProperty anyNonBlankString()

anyNonEmptyString

public ClientDslProperty anyNonEmptyString()

anyOf

public ClientDslProperty anyOf(String... values)

messageHeaders

public void messageHeaders(Consumer<Headers> consumer)

The message headers part of the contract.

Parameters:

consumer - function to manipulate the message headers

bodyMatchers

public void bodyMatchers(Consumer<BodyMatchers> consumer)

The stub matchers part of the contract.

Parameters:

consumer - function to manipulate the message headers

messageHeaders

public void messageHeaders(@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(BodyMatchers.class)
                         groovy.lang.Closure consumer)

The stub matchers part of the contract.

Parameters:

consumer - function to manipulate the message headers

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