au.com.dius.pact.consumer

Class ConsumerPactBuilder.PactDslRequestWithPath

java.lang.Object

au.com.dius.pact.consumer.ConsumerPactBuilder.PactDslRequestWithPath

Enclosing class:

ConsumerPactBuilder

public class ConsumerPactBuilder.PactDslRequestWithPath
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PactDslRequestWithPath(ConsumerPactBuilder.PactDslRequestWithPath existing, java.lang.String description)
PactDslRequestWithPath(java.lang.String consumerName, java.lang.String providerName, java.lang.String state, java.lang.String description, java.lang.String path, java.lang.String requestMethod, java.util.Map<java.lang.String,java.lang.String> requestHeaders, java.lang.String query, java.lang.String requestBody, java.util.Map<java.lang.String,java.lang.Object> requestMatchers)

Method Summary

Modifier and Type	Method and Description
ConsumerPactBuilder.PactDslRequestWithPath	body(org.w3c.dom.Document body) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	body(DslPart body) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	body(org.json.JSONObject body) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	body(java.lang.String body) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	body(java.lang.String body, org.apache.http.entity.ContentType mimeType) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	body(java.lang.String body, java.lang.String mimeType) The body of the request
ConsumerPactBuilder.PactDslRequestWithPath	headers(java.util.Map<java.lang.String,java.lang.String> headers) Headers to be included in the request
ConsumerPactBuilder.PactDslRequestWithPath	matchHeader(java.lang.String header, java.lang.String regex) Match a request header.
ConsumerPactBuilder.PactDslRequestWithPath	matchHeader(java.lang.String header, java.lang.String regex, java.lang.String headerExample) Match a request header.
ConsumerPactBuilder.PactDslRequestWithPath	matchPath(java.lang.String pathRegex) The path of the request.
ConsumerPactBuilder.PactDslRequestWithPath	matchPath(java.lang.String pathRegex, java.lang.String path) The path of the request
ConsumerPactBuilder.PactDslRequestWithPath	method(java.lang.String method) The HTTP method for the request
ConsumerPactBuilder.PactDslRequestWithPath	path(java.lang.String path) The path of the request
ConsumerPactBuilder.PactDslRequestWithPath	query(java.lang.String query) The query string for the request
ConsumerPactBuilder.PactDslResponse	willRespondWith() Define the response to return

Methods inherited from class java.lang.Object

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

Constructor Detail

PactDslRequestWithPath

public PactDslRequestWithPath(java.lang.String consumerName,
                              java.lang.String providerName,
                              java.lang.String state,
                              java.lang.String description,
                              java.lang.String path,
                              java.lang.String requestMethod,
                              java.util.Map<java.lang.String,java.lang.String> requestHeaders,
                              java.lang.String query,
                              java.lang.String requestBody,
                              java.util.Map<java.lang.String,java.lang.Object> requestMatchers)

PactDslRequestWithPath

public PactDslRequestWithPath(ConsumerPactBuilder.PactDslRequestWithPath existing,
                              java.lang.String description)

Method Detail

method

public ConsumerPactBuilder.PactDslRequestWithPath method(java.lang.String method)

The HTTP method for the request

Parameters:

method - Valid HTTP method

headers

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

Headers to be included in the request

Parameters:

headers - Key-value pairs

query

public ConsumerPactBuilder.PactDslRequestWithPath query(java.lang.String query)

The query string for the request

Parameters:

query - query string

body

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

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

body - Request body in JSON form

body

public ConsumerPactBuilder.PactDslRequestWithPath body(DslPart body)

The body of the request

Parameters:

body - Built using the Pact body DSL

body

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

The body of the request

Parameters:

body - XML Document

Throws:

javax.xml.transform.TransformerException

path

public ConsumerPactBuilder.PactDslRequestWithPath path(java.lang.String path)

The path of the request

Parameters:

path - string path

matchPath

public ConsumerPactBuilder.PactDslRequestWithPath matchPath(java.lang.String pathRegex)

The path of the request. This will generate a random path to use when generating requests

Parameters:

pathRegex - string path regular expression to match with

matchPath

public ConsumerPactBuilder.PactDslRequestWithPath matchPath(java.lang.String pathRegex,
                                                            java.lang.String path)

The path of the request

Parameters:

path - string path to use when generating requests

pathRegex - regular expression to use to match paths

matchHeader

public ConsumerPactBuilder.PactDslRequestWithPath matchHeader(java.lang.String header,
                                                              java.lang.String regex)

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

Parameters:

header - Header to match

regex - Regular expression to match

matchHeader

public ConsumerPactBuilder.PactDslRequestWithPath matchHeader(java.lang.String header,
                                                              java.lang.String regex,
                                                              java.lang.String headerExample)

Match a request header.

Parameters:

header - Header to match

regex - Regular expression to match

headerExample - Example value to use

willRespondWith

public ConsumerPactBuilder.PactDslResponse willRespondWith()

Define the response to return