Constructor Detail

• PactDslRequestWithPath

  PactDslRequestWithPath(ConsumerPactBuilder consumerPactBuilder, String consumerName, String providerName, List<ProviderState> state, String description, String path, String requestMethod, Map<String, List<String>> requestHeaders, Map<String, List<String>> query, OptionalBody requestBody, MatchingRules requestMatchers, Generators requestGenerators, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues)

• PactDslRequestWithPath

  PactDslRequestWithPath(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath existing, String description, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues)

Method Detail

• method

   PactDslRequestWithPath method(String method)

  The HTTP method for the request

  Parameters:

  method - Valid HTTP method

• headers

   PactDslRequestWithPath headers(String firstHeaderName, String firstHeaderValue, Array<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

   PactDslRequestWithPath headers(Map<String, String> headers)

  Headers to be included in the request

  Parameters:

  headers - Key-value pairs

• query

   PactDslRequestWithPath query(String query)

  The query string for the request

  Parameters:

  query - query string

• encodedQuery

   PactDslRequestWithPath encodedQuery(String query)

  The encoded query string for the request

  Parameters:

  query - query string

• body

   PactDslRequestWithPath body(String body)

  The body of the request

  Parameters:

  body - Request body in string form

• body

   PactDslRequestWithPath body(String body, String contentType)

  The body of the request

  Parameters:

  body - Request body in string form

• body

   PactDslRequestWithPath body(String body, ContentType contentType)

  The body of the request

  Parameters:

  body - Request body in string form

• body

   PactDslRequestWithPath body(Supplier<String> body)

  The body of the request

  Parameters:

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

• body

   PactDslRequestWithPath body(Supplier<String> body, String contentType)

  The body of the request

  Parameters:

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

• body

   PactDslRequestWithPath body(Supplier<String> body, ContentType contentType)

  The body of the request

  Parameters:

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

• bodyWithSingleQuotes

   PactDslRequestWithPath bodyWithSingleQuotes(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

   PactDslRequestWithPath bodyWithSingleQuotes(String body, 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

• bodyWithSingleQuotes

   PactDslRequestWithPath bodyWithSingleQuotes(String body, 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

• body

   PactDslRequestWithPath body(JSONObject body)

  The body of the request

  Parameters:

  body - Request body in JSON form

• body

   PactDslRequestWithPath body(DslPart body)

  The body of the request

  Parameters:

  body - Built using the Pact body DSL

• body

   PactDslRequestWithPath body(Document body)

  The body of the request

  Parameters:

  body - XML Document

• body

   PactDslRequestWithPath body(PactXmlBuilder xmlBuilder)

  XML body to return

  Parameters:

  xmlBuilder - XML Builder used to construct the XML document

• path

   PactDslRequestWithPath path(String path)

  The path of the request

  Parameters:

  path - string path

• matchPath

   PactDslRequestWithPath matchPath(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

   PactDslRequestWithPath matchPath(String pathRegex, String path)

  The path of the request

  Parameters:

  pathRegex - regular expression to use to match paths

  path - string path to use when generating requests

• matchHeader

   PactDslRequestWithPath matchHeader(String header, 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

   PactDslRequestWithPath matchHeader(String header, String regex, String headerExample)

  Match a request header.

  Parameters:

  header - Header to match

  regex - Regular expression to match

  headerExample - Example value to use

• willRespondWith

   PactDslResponse willRespondWith()

  Define the response to return

• matchQuery

   PactDslRequestWithPath matchQuery(String parameter, 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

   PactDslRequestWithPath matchQuery(String parameter, String regex, 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

   PactDslRequestWithPath matchQuery(String parameter, String regex, List<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

   PactDslRequestWithPath withFileUpload(String partName, String fileName, String fileContentType, Array<byte> 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

   PactDslRequestWithPath headerFromProviderState(String name, String expression, 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

   PactDslRequestWithPath queryParameterFromProviderState(String name, String expression, 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

   PactDslRequestWithPath pathFromProviderState(String expression, 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

   PactDslRequestWithPath queryMatchingDate(String field, String pattern, String example)

  Matches a date field using the provided date pattern

  Parameters:

  field - field name

  pattern - pattern to match

  example - Example value

• queryMatchingDate

   PactDslRequestWithPath queryMatchingDate(String field, 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

   PactDslRequestWithPath queryMatchingTime(String field, String pattern, String example)

  Matches a time field using the provided time pattern

  Parameters:

  field - field name

  pattern - pattern to match

  example - Example value

• queryMatchingTime

   PactDslRequestWithPath queryMatchingTime(String field, 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

   PactDslRequestWithPath queryMatchingDatetime(String field, String pattern, String example)

  Matches a datetime field using the provided pattern

  Parameters:

  field - field name

  pattern - pattern to match

  example - Example value

• queryMatchingDatetime

   PactDslRequestWithPath queryMatchingDatetime(String field, 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

   PactDslRequestWithPath queryMatchingISODate(String field, String example)

  Matches a date field using the ISO date pattern

  Parameters:

  field - field name

  example - Example value

• queryMatchingISODate

   PactDslRequestWithPath queryMatchingISODate(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

   PactDslRequestWithPath queryMatchingISOTime(String field, String example)

  Matches a time field using the ISO time pattern

  Parameters:

  field - field name

  example - Example value

• queryMatchingTime

   PactDslRequestWithPath queryMatchingTime(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

   PactDslRequestWithPath queryMatchingISODatetime(String field, String example)

  Matches a datetime field using the ISO pattern

  Parameters:

  field - field name

  example - Example value

• queryMatchingISODatetime

   PactDslRequestWithPath queryMatchingISODatetime(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

• body

   PactDslRequestWithPath body(BodyBuilder builder)

  Sets the body using the buidler

  Parameters:

  builder - Body Builder