au.com.dius.pact.consumer.dsl

Class PactDslRequestWithPath

PactDslRequestBase

au.com.dius.pact.consumer.dsl.PactDslRequestWithPath

public class PactDslRequestWithPath
extends PactDslRequestBase

Method Detail

method

public PactDslRequestWithPath method(java.lang.String method)

The HTTP method for the request

Parameters:

method - Valid HTTP method

headers

public PactDslRequestWithPath headers(java.lang.String firstHeaderName,
                                      java.lang.String firstHeaderValue,
                                      java.lang.String... headerNameValuePairs)

Headers to be included in the request

Parameters:

firstHeaderName - The name of the first header

firstHeaderValue - The value of the first header

headerNameValuePairs - Additional headers in name-value pairs.

headers

public 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 PactDslRequestWithPath query(java.lang.String query)

The query string for the request

Parameters:

query - query string

encodedQuery

public PactDslRequestWithPath encodedQuery(java.lang.String query)

The encoded query string for the request

Parameters:

query - query string

body

public PactDslRequestWithPath body(java.lang.String body)

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

body - Request body in string form

body

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

The body of the request

Parameters:

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

body

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

The body of the request

Parameters:

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

body

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

The body of the request

Parameters:

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

bodyWithSingleQuotes

public PactDslRequestWithPath bodyWithSingleQuotes(java.lang.String body)

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

Parameters:

body - Request body in string form

See Also:

class QuoteUtil

bodyWithSingleQuotes

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

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

Parameters:

body - Request body in string form

See Also:

class QuoteUtil

bodyWithSingleQuotes

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

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

Parameters:

body - Request body in string form

See Also:

class QuoteUtil

body

public PactDslRequestWithPath body(org.json.JSONObject body)

The body of the request

Parameters:

body - Request body in JSON form

body

public PactDslRequestWithPath body(DslPart body)

The body of the request

Parameters:

body - Built using the Pact body DSL

body

public PactDslRequestWithPath body(org.w3c.dom.Document body)

The body of the request

Parameters:

body - XML Document

body

public PactDslRequestWithPath body(PactXmlBuilder xmlBuilder)

XML body to return

Parameters:

xmlBuilder - XML Builder used to construct the XML document

path

public PactDslRequestWithPath path(java.lang.String path)

The path of the request

Parameters:

path - string path

matchPath

public 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 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 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 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 PactDslResponse willRespondWith()

Define the response to return

matchQuery

public PactDslRequestWithPath matchQuery(java.lang.String parameter,
                                         java.lang.String regex)

Match a query parameter with a regex. A random query parameter value will be generated from the regex.

Parameters:

parameter - Query parameter

regex - Regular expression to match with

matchQuery

public PactDslRequestWithPath matchQuery(java.lang.String parameter,
                                         java.lang.String regex,
                                         java.lang.String example)

Match a query parameter with a regex.

Parameters:

parameter - Query parameter

regex - Regular expression to match with

example - Example value to use for the query parameter (unencoded)

matchQuery

public PactDslRequestWithPath matchQuery(java.lang.String parameter,
                                         java.lang.String regex,
                                         java.util.List<java.lang.String> example)

Match a repeating query parameter with a regex.

Parameters:

parameter - Query parameter

regex - Regular expression to match with each element

example - Example value list to use for the query parameter (unencoded)

withFileUpload

public PactDslRequestWithPath withFileUpload(java.lang.String partName,
                                             java.lang.String fileName,
                                             java.lang.String fileContentType,
                                             kotlin.Array[] data)

Sets up a file upload request. This will add the correct content type header to the request

Parameters:

partName - This is the name of the part in the multipart body.

fileName - This is the name of the file that was uploaded

fileContentType - This is the content type of the uploaded file

data - This is the actual file contents

headerFromProviderState

public PactDslRequestWithPath 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

queryParameterFromProviderState

public PactDslRequestWithPath queryParameterFromProviderState(java.lang.String name,
                                                              java.lang.String expression,
                                                              java.lang.String example)

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

Parameters:

name - Name

expression - Expression to be evaluated from the provider state

example - Example value to use in the consumer test

pathFromProviderState

public PactDslRequestWithPath pathFromProviderState(java.lang.String expression,
                                                    java.lang.String example)

Sets the path to have it's value injected from the provider state

Parameters:

expression - Expression to be evaluated from the provider state

example - Example value to use in the consumer test

queryMatchingDate

public PactDslRequestWithPath queryMatchingDate(java.lang.String field,
                                                java.lang.String pattern,
                                                java.lang.String example)

Matches a date field using the provided date pattern

Parameters:

field - field name

pattern - pattern to match

example - Example value

queryMatchingDate

public PactDslRequestWithPath queryMatchingDate(java.lang.String field,
                                                java.lang.String pattern)

Matches a date field using the provided date pattern. The current system date will be used for the example value.

Parameters:

field - field name

pattern - pattern to match

queryMatchingTime

public PactDslRequestWithPath queryMatchingTime(java.lang.String field,
                                                java.lang.String pattern,
                                                java.lang.String example)

Matches a time field using the provided time pattern

Parameters:

field - field name

pattern - pattern to match

example - Example value

queryMatchingTime

public PactDslRequestWithPath queryMatchingTime(java.lang.String field,
                                                java.lang.String pattern)

Matches a time field using the provided time pattern. The current system time will be used for the example value.

Parameters:

field - field name

pattern - pattern to match

queryMatchingDatetime

public PactDslRequestWithPath queryMatchingDatetime(java.lang.String field,
                                                    java.lang.String pattern,
                                                    java.lang.String example)

Matches a datetime field using the provided pattern

Parameters:

field - field name

pattern - pattern to match

example - Example value

queryMatchingDatetime

public PactDslRequestWithPath queryMatchingDatetime(java.lang.String field,
                                                    java.lang.String pattern)

Matches a datetime field using the provided pattern. The current system date and time will be used for the example value.

Parameters:

field - field name

pattern - pattern to match

queryMatchingISODate

public PactDslRequestWithPath queryMatchingISODate(java.lang.String field,
                                                   java.lang.String example)

Matches a date field using the ISO date pattern

Parameters:

field - field name

example - Example value

queryMatchingISODate

public PactDslRequestWithPath queryMatchingISODate(java.lang.String field)

Matches a date field using the ISO date pattern. The current system date will be used for the example value.

Parameters:

field - field name

queryMatchingISOTime

public PactDslRequestWithPath queryMatchingISOTime(java.lang.String field,
                                                   java.lang.String example)

Matches a time field using the ISO time pattern

Parameters:

field - field name

example - Example value

queryMatchingTime

public PactDslRequestWithPath queryMatchingTime(java.lang.String field)

Matches a time field using the ISO time pattern. The current system time will be used for the example value.

Parameters:

field - field name

queryMatchingISODatetime

public PactDslRequestWithPath queryMatchingISODatetime(java.lang.String field,
                                                       java.lang.String example)

Matches a datetime field using the ISO pattern

Parameters:

field - field name

example - Example value

queryMatchingISODatetime

public PactDslRequestWithPath queryMatchingISODatetime(java.lang.String field)

Matches a datetime field using the ISO pattern. The current system date and time will be used for the example value.

Parameters:

field - field name