au.com.dius.pact.consumer

Class ConsumerPactBuilder.PactDslResponse

java.lang.Object

au.com.dius.pact.consumer.ConsumerPactBuilder.PactDslResponse

Enclosing class:

ConsumerPactBuilder

public class ConsumerPactBuilder.PactDslResponse
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PactDslResponse(ConsumerPactBuilder.PactDslRequestWithPath existing)

Method Summary

Modifier and Type	Method and Description
ConsumerPactBuilder.PactDslResponse	body(org.w3c.dom.Document body) Response body to return
ConsumerPactBuilder.PactDslResponse	body(DslPart body) Response body to return
ConsumerPactBuilder.PactDslResponse	body(org.json.JSONObject body) Response body to return
ConsumerPactBuilder.PactDslResponse	body(java.lang.String body) Response body to return
ConsumerPactBuilder.PactDslResponse	body(java.lang.String body, org.apache.http.entity.ContentType mimeType) Response body to return
ConsumerPactBuilder.PactDslResponse	body(java.lang.String body, java.lang.String mimeType) Response body to return
ConsumerPactBuilder.PactDslResponse	headers(java.util.Map<java.lang.String,java.lang.String> headers) Response headers to return
ConsumerPactBuilder.PactDslResponse	matchHeader(java.lang.String header, java.lang.String regexp) Match a response header.
ConsumerPactBuilder.PactDslResponse	matchHeader(java.lang.String header, java.lang.String regexp, java.lang.String headerExample) Match a response header.
ConsumerPactBuilder.PactDslResponse	status(int status) Response status code
au.com.dius.pact.model.PactFragment	toFragment() Terminates the DSL and builds a pact fragment to represent the interactions
ConsumerPactBuilder.PactDslRequestWithPath	uponReceiving(java.lang.String description) Description of the request that is expected to be received

Methods inherited from class java.lang.Object

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

Constructor Detail

PactDslResponse

public PactDslResponse(ConsumerPactBuilder.PactDslRequestWithPath existing)

Method Detail

status

public ConsumerPactBuilder.PactDslResponse status(int status)

Response status code

Parameters:

status - HTTP status code

headers

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

Response headers to return

Parameters:

headers - key-value pairs of headers

body

public ConsumerPactBuilder.PactDslResponse body(java.lang.String body)

Response body to return

Parameters:

body - Response body in string form

body

public ConsumerPactBuilder.PactDslResponse body(java.lang.String body,
                                                java.lang.String mimeType)

Response body to return

Parameters:

body - body in string form

body

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

Response body to return

Parameters:

body - body in string form

body

public ConsumerPactBuilder.PactDslResponse body(org.json.JSONObject body)

Response body to return

Parameters:

body - Response body in JSON form

body

public ConsumerPactBuilder.PactDslResponse body(DslPart body)

Response body to return

Parameters:

body - Response body built using the Pact body DSL

body

public ConsumerPactBuilder.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

matchHeader

public ConsumerPactBuilder.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 ConsumerPactBuilder.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

toFragment

public au.com.dius.pact.model.PactFragment toFragment()

Terminates the DSL and builds a pact fragment to represent the interactions

Returns:

uponReceiving

public ConsumerPactBuilder.PactDslRequestWithPath uponReceiving(java.lang.String description)

Description of the request that is expected to be received

Parameters:

description - request description