com.atlassian.ta.wiremockpactgenerator

Class WireMockPactGenerator.Builder

java.lang.Object

com.atlassian.ta.wiremockpactgenerator.WireMockPactGenerator.Builder

Enclosing class:

WireMockPactGenerator

public static class WireMockPactGenerator.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
WireMockPactGenerator	build() Build a WireMockPactGenerator request listener for WireMock with the provided settings.
WireMockPactGenerator.Builder	withIncludeNotConfiguredResponses(boolean includeNotConfiguredResponses) When a request does not match any stubbing in WireMock a default 404 response is generated.
WireMockPactGenerator.Builder	withRequestHeaderIncludeList(String... httpHeaders) Specify what request headers should be recorded in the pact interaction (all headers if unset).
WireMockPactGenerator.Builder	withRequestHeaderWhitelist(String... httpHeaders) Deprecated. method was renamed, use withRequestHeaderIncludeList(String...) instead.
WireMockPactGenerator.Builder	withRequestPathBlacklist(String... regexPatterns) Deprecated. method was renamed, use withRequestPathExcludeList(String...) instead.
WireMockPactGenerator.Builder	withRequestPathExcludeList(String... regexPatterns) Specify path patterns of requests that should not be recorded as pact interactions.
WireMockPactGenerator.Builder	withRequestPathIncludeList(String... regexPatterns) Specify path patterns of requests that should be recorded as pact interactions (everything if unset).
WireMockPactGenerator.Builder	withRequestPathWhitelist(String... regexPatterns) Deprecated. method was renamed, use withRequestPathIncludeList(String...) instead.
WireMockPactGenerator.Builder	withResponseHeaderIncludeList(String... httpHeaders) Specify what response headers should be recorded in the pact interaction (all headers if unset).
WireMockPactGenerator.Builder	withResponseHeaderWhitelist(String... httpHeaders) Deprecated. method was renamed, use withResponseHeaderIncludeList(String...) instead.
WireMockPactGenerator.Builder	withStrictApplicationJson(boolean strictApplicationJson) According to [RFC-4627](https://tools.ietf.org/html/rfc4627) Section 2.
WireMockPactGenerator.Builder	withUnexpectedErrorHandler(Consumer<RuntimeException> unexpectedErrorHandler) There's no mechanism to instruct WireMock to fail when an unexpected error occurs in WireMockPactGenerator for that reason the default behaviour is to terminate the Java process which might be too intrusive.

Methods inherited from class java.lang.Object

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

Method Detail

withRequestPathIncludeList

public WireMockPactGenerator.Builder withRequestPathIncludeList(String... regexPatterns)

Specify path patterns of requests that should be recorded as pact interactions (everything if unset).

Parameters:

regexPatterns - List of regex path patterns to match request that should be captured.

Returns:

an updated instance of the options builder.

withRequestPathExcludeList

public WireMockPactGenerator.Builder withRequestPathExcludeList(String... regexPatterns)

Specify path patterns of requests that should not be recorded as pact interactions.

Parameters:

regexPatterns - List of regex patterns of request paths that should be omitted.

Returns:

an updated instance of the options builder.

withStrictApplicationJson

public WireMockPactGenerator.Builder withStrictApplicationJson(boolean strictApplicationJson)

According to [RFC-4627](https://tools.ietf.org/html/rfc4627) Section 2. A valid application/json payload must include as root element either a JSON object or a JSON array. By default, WireMock Pact Generator sticks to this rule. This means that when saving pact files for captured request or response bodies with contents such as `true`, `null`, `33`, `"a quoted string"`, these will not be interpreted as JSON payloads and bodies will be saved as unserialized raw strings (keeping the quotes in the last example).However, for some APIs that are not that strict the default behavior is not desired. In those cases WireMock Pact Generator can be instructed to disable this strict mode and allow serialization of every primitive JSON element.

Parameters:

strictApplicationJson - enable/disable strict application/json mode (default: true).

Returns:

an updated instance of the options builder.

withRequestHeaderIncludeList

public WireMockPactGenerator.Builder withRequestHeaderIncludeList(String... httpHeaders)

Specify what request headers should be recorded in the pact interaction (all headers if unset).

Parameters:

httpHeaders - List of request headers to be captured (case insensitive).

Returns:

an updated instance of the options builder.

withResponseHeaderIncludeList

public WireMockPactGenerator.Builder withResponseHeaderIncludeList(String... httpHeaders)

Specify what response headers should be recorded in the pact interaction (all headers if unset).

Parameters:

httpHeaders - List of response headers to be captured (case insensitive).

Returns:

an updated instance of the options builder.

withUnexpectedErrorHandler

public WireMockPactGenerator.Builder withUnexpectedErrorHandler(Consumer<RuntimeException> unexpectedErrorHandler)

There's no mechanism to instruct WireMock to fail when an unexpected error occurs in WireMockPactGenerator for that reason the default behaviour is to terminate the Java process which might be too intrusive. This method allows specifying a custom error handler function for specific projects to implement a more graceful way to fail the build.

Parameters:

unexpectedErrorHandler - function to handle unexpected errors occurring in WireMockPactGenerator.

Returns:

an updated instance of the options builder.

build

public WireMockPactGenerator build()

Build a WireMockPactGenerator request listener for WireMock with the provided settings.

Returns:

a WireMockPactGenerator request listener.

withIncludeNotConfiguredResponses

public WireMockPactGenerator.Builder withIncludeNotConfiguredResponses(boolean includeNotConfiguredResponses)

When a request does not match any stubbing in WireMock a default 404 response is generated. By default, these interactions are captured by WireMockPactGenerator. This behaviour can be disabled by this method.

Parameters:

includeNotConfiguredResponses - false to prevent capturing interactions for responses not configured in WireMock (defaults to true if unset)

Returns:

an updated instance of the options builder.

withRequestPathWhitelist

@Deprecated
public WireMockPactGenerator.Builder withRequestPathWhitelist(String... regexPatterns)

Deprecated. method was renamed, use withRequestPathIncludeList(String...) instead.

Specify path patterns of requests that should be recorded as pact interactions (everything if unset).

Parameters:

regexPatterns - List of regex path patterns to match request that should be captured.

Returns:

an updated instance of the options builder.

withRequestPathBlacklist

@Deprecated
public WireMockPactGenerator.Builder withRequestPathBlacklist(String... regexPatterns)

Deprecated. method was renamed, use withRequestPathExcludeList(String...) instead.

Specify path patterns of requests that should not be recorded as pact interactions.

Parameters:

regexPatterns - List of regex patterns of request paths that should be omitted.

Returns:

an updated instance of the options builder.

withRequestHeaderWhitelist

@Deprecated
public WireMockPactGenerator.Builder withRequestHeaderWhitelist(String... httpHeaders)

Deprecated. method was renamed, use withRequestHeaderIncludeList(String...) instead.

Specify what request headers should be recorded in the pact interaction (all headers if unset).

Parameters:

httpHeaders - List of request headers to be captured (case insensitive).

Returns:

an updated instance of the options builder.

withResponseHeaderWhitelist

@Deprecated
public WireMockPactGenerator.Builder withResponseHeaderWhitelist(String... httpHeaders)

Deprecated. method was renamed, use withResponseHeaderIncludeList(String...) instead.

Specify what response headers should be recorded in the pact interaction (all headers if unset).

Parameters:

httpHeaders - List of response headers to be captured (case insensitive).

Returns:

an updated instance of the options builder.