au.com.dius.pact.consumer.dsl

Class PactDslResponse

java.lang.Object

au.com.dius.pact.consumer.dsl.PactDslResponse

public class PactDslResponse
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues)

Method Summary

Modifier and Type	Method and Description
PactDslResponse	body(org.w3c.dom.Document body) Response body to return
PactDslResponse	body(DslPart body) Response body to return
PactDslResponse	body(org.json.JSONObject body) Response body to return
PactDslResponse	body(au.com.dius.pact.consumer.xml.PactXmlBuilder xmlBuilder) XML Response body to return
PactDslResponse	body(java.lang.String body) Response body to return
PactDslResponse	body(java.lang.String body, org.apache.http.entity.ContentType contentType) Response body to return
PactDslResponse	body(java.lang.String body, java.lang.String contentType) Response body to return
PactDslResponse	body(java.util.function.Supplier<java.lang.String> body) The body of the request
PactDslResponse	body(java.util.function.Supplier<java.lang.String> body, org.apache.http.entity.ContentType contentType) The body of the request
PactDslResponse	body(java.util.function.Supplier<java.lang.String> body, java.lang.String contentType) The body of the request
PactDslResponse	bodyWithSingleQuotes(java.lang.String body) The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
PactDslResponse	bodyWithSingleQuotes(java.lang.String body, org.apache.http.entity.ContentType contentType) The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
PactDslResponse	bodyWithSingleQuotes(java.lang.String body, java.lang.String contentType) The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.
protected java.lang.String	getContentTypeHeader()
PactDslWithState	given(java.lang.String state) Adds a provider state to this interaction
PactDslWithState	given(java.lang.String state, java.util.Map<java.lang.String,java.lang.Object> params) Adds a provider state to this interaction
PactDslResponse	headerFromProviderState(java.lang.String name, java.lang.String expression, java.lang.String example) Adds a header that will have it's value injected from the provider state
PactDslResponse	headers(java.util.Map<java.lang.String,java.lang.String> headers) Response headers to return Provide the headers you want to validate, other headers will be ignored.
protected boolean	isContentTypeHeaderNotSet()
PactDslResponse	matchHeader(java.lang.String header, java.lang.String regexp) Match a response header.
PactDslResponse	matchHeader(java.lang.String header, java.lang.String regexp, java.lang.String headerExample) Match a response header.
PactDslResponse	matchSetCookie(java.lang.String cookie, java.lang.String regex, java.lang.String example) Match a set cookie header
PactDslResponse	status(int status) Response status code
au.com.dius.pact.core.model.RequestResponsePact	toPact() Terminates the DSL and builds a pact to represent the interactions
PactDslRequestWithPath	uponReceiving(java.lang.String description) Description of the request that is expected to be received
PactDslResponse	withBinaryData(byte[] example, java.lang.String contentType) Response body as a binary data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PactDslResponse

public PactDslResponse(ConsumerPactBuilder consumerPactBuilder,
                       PactDslRequestWithPath request,
                       PactDslRequestWithoutPath defaultRequestValues,
                       PactDslResponse defaultResponseValues)

Method Detail

status

public PactDslResponse status(int status)

Response status code

Parameters:

status - HTTP status code

headers

public PactDslResponse headers(java.util.Map<java.lang.String,java.lang.String> headers)

Response headers to return Provide the headers you want to validate, other headers will be ignored.

Parameters:

headers - key-value pairs of headers

body

public PactDslResponse body(java.lang.String body)

Response body to return

Parameters:

body - Response body in string form

body

public PactDslResponse body(java.lang.String body,
                            java.lang.String contentType)

Response body to return

Parameters:

body - body in string form

contentType - the Content-Type response header value

body

public PactDslResponse body(java.lang.String body,
                            org.apache.http.entity.ContentType contentType)

Response body to return

Parameters:

body - body in string form

contentType - the Content-Type response header value

body

public PactDslResponse body(java.util.function.Supplier<java.lang.String> body)

The body of the request

Parameters:

body - Response body in Java Functional Interface Supplier that must return a string

body

public PactDslResponse body(java.util.function.Supplier<java.lang.String> body,
                            java.lang.String contentType)

The body of the request

Parameters:

body - Response body in Java Functional Interface Supplier that must return a string

contentType - the Content-Type response header value

body

public PactDslResponse body(java.util.function.Supplier<java.lang.String> body,
                            org.apache.http.entity.ContentType contentType)

The body of the request

Parameters:

body - Response body in Java Functional Interface Supplier that must return a string

contentType - the Content-Type response header value

bodyWithSingleQuotes

public PactDslResponse bodyWithSingleQuotes(java.lang.String body)

The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

Parameters:

body - Request body in string form

bodyWithSingleQuotes

public PactDslResponse bodyWithSingleQuotes(java.lang.String body,
                                            java.lang.String contentType)

The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

Parameters:

body - Request body in string form

contentType - the Content-Type response header value

bodyWithSingleQuotes

public PactDslResponse bodyWithSingleQuotes(java.lang.String body,
                                            org.apache.http.entity.ContentType contentType)

The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

Parameters:

body - Request body in string form

contentType - the Content-Type response header value

body

public PactDslResponse body(org.json.JSONObject body)

Response body to return

Parameters:

body - Response body in JSON form

body

public PactDslResponse body(DslPart body)

Response body to return

Parameters:

body - Response body built using the Pact body DSL

body

public PactDslResponse body(org.w3c.dom.Document body)
                     throws javax.xml.transform.TransformerException

Response body to return

Parameters:

body - Response body as an XML Document

Throws:

javax.xml.transform.TransformerException

withBinaryData

public PactDslResponse withBinaryData(byte[] example,
                                      java.lang.String contentType)

Response body as a binary data. It will match any expected bodies against the content type.

Parameters:

example - Example contents to use in the consumer test

contentType - Content type of the data

matchHeader

public PactDslResponse matchHeader(java.lang.String header,
                                   java.lang.String regexp)

Match a response header. A random example header value will be generated from the provided regular expression.

Parameters:

header - Header to match

regexp - Regular expression to match

matchHeader

public PactDslResponse matchHeader(java.lang.String header,
                                   java.lang.String regexp,
                                   java.lang.String headerExample)

Match a response header.

Parameters:

header - Header to match

regexp - Regular expression to match

headerExample - Example value to use

toPact

public au.com.dius.pact.core.model.RequestResponsePact toPact()

Terminates the DSL and builds a pact to represent the interactions

uponReceiving

public PactDslRequestWithPath uponReceiving(java.lang.String description)

Description of the request that is expected to be received

Parameters:

description - request description

given

public PactDslWithState given(java.lang.String state)

Adds a provider state to this interaction

Parameters:

state - Description of the state

given

public PactDslWithState given(java.lang.String state,
                              java.util.Map<java.lang.String,java.lang.Object> params)

Adds a provider state to this interaction

Parameters:

state - Description of the state

params - Data parameters for this state

headerFromProviderState

public PactDslResponse headerFromProviderState(java.lang.String name,
                                               java.lang.String expression,
                                               java.lang.String example)

Adds a header that will have it's value injected from the provider state

Parameters:

name - Header Name

expression - Expression to be evaluated from the provider state

example - Example value to use in the consumer test

matchSetCookie

public PactDslResponse matchSetCookie(java.lang.String cookie,
                                      java.lang.String regex,
                                      java.lang.String example)

Match a set cookie header

Parameters:

cookie - Cookie name to match

regex - Regex to match the cookie value with

example - Example value

body

public PactDslResponse body(au.com.dius.pact.consumer.xml.PactXmlBuilder xmlBuilder)

XML Response body to return

Parameters:

xmlBuilder - XML Builder used to construct the XML document

isContentTypeHeaderNotSet

protected boolean isContentTypeHeaderNotSet()

getContentTypeHeader

protected java.lang.String getContentTypeHeader()