Package com.github.tomakehurst.wiremock.matching

Class RequestPatternBuilder

java.lang.Object

com.github.tomakehurst.wiremock.matching.RequestPatternBuilder

public class RequestPatternBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
RequestPatternBuilder()
RequestPatternBuilder(RequestMethod method, UrlPattern url)
RequestPatternBuilder(ValueMatcher<Request> customMatcher)
RequestPatternBuilder(String customRequestMatcherName, Parameters parameters)

Method Summary

Modifier and Type	Method	Description
static RequestPatternBuilder	allRequests()
RequestPatternBuilder	andMatching(CustomMatcherDefinition matcherDefinition)
RequestPatternBuilder	andMatching(ValueMatcher<Request> customMatcher)
RequestPatternBuilder	andMatching(String customRequestMatcherName)
RequestPatternBuilder	andMatching(String customRequestMatcherName, Parameters parameters)
RequestPattern	build()
RequestPatternBuilder	but()	Deprecated. intended for use with now-deprecated like() method.
RequestPatternBuilder	clearBodyPatterns()
RequestPatternBuilder	clearFormParams()
RequestPatternBuilder	clearQueryParams()
static RequestPatternBuilder	forCustomMatcher(ValueMatcher<Request> requestMatcher)
static RequestPatternBuilder	forCustomMatcher(String customRequestMatcherName, Parameters parameters)
static RequestPatternBuilder	like(RequestPattern requestPattern)	Deprecated. use RequestPattern.transform() instead
static RequestPatternBuilder	newRequestPattern()
static RequestPatternBuilder	newRequestPattern(RequestMethod method, UrlPattern url)
RequestPatternBuilder	withAllRequestBodyParts(MultipartValuePatternBuilder multiPatternBuilder)
RequestPatternBuilder	withAnyRequestBodyPart(MultipartValuePatternBuilder multiPatternBuilder)
RequestPatternBuilder	withBasicAuth(BasicCredentials basicCredentials)
RequestPatternBuilder	withClientIp(StringValuePattern clientIpPattern)
RequestPatternBuilder	withCookie(String key, StringValuePattern valuePattern)
RequestPatternBuilder	withFormParam(String key, MultiValuePattern multiValuePattern)
RequestPatternBuilder	withFormParam(String key, StringValuePattern valuePattern)
RequestPatternBuilder	withHeader(String key, MultiValuePattern multiValuePattern)
RequestPatternBuilder	withHeader(String key, StringValuePattern valuePattern)
RequestPatternBuilder	withHost(StringValuePattern hostPattern)
RequestPatternBuilder	withoutFormParam(String key)
RequestPatternBuilder	withoutHeader(String key)
RequestPatternBuilder	withoutQueryParam(String key)
RequestPatternBuilder	withPathParam(String key, StringValuePattern valuePattern)
RequestPatternBuilder	withPort(int port)
RequestPatternBuilder	withQueryParam(String key, MultiValuePattern multiValuePattern)
RequestPatternBuilder	withQueryParam(String key, StringValuePattern valuePattern)
RequestPatternBuilder	withRequestBody(ContentPattern valuePattern)
RequestPatternBuilder	withRequestBodyPart(MultipartValuePattern multiPattern)
RequestPatternBuilder	withScheme(String scheme)
RequestPatternBuilder	withUrl(UrlPattern urlPattern)
RequestPatternBuilder	withUrl(String url)

Methods inherited from class java.lang.Object

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

Constructor Details

RequestPatternBuilder

public RequestPatternBuilder()

RequestPatternBuilder

public RequestPatternBuilder(ValueMatcher<Request> customMatcher)

RequestPatternBuilder

public RequestPatternBuilder(RequestMethod method,
 UrlPattern url)

RequestPatternBuilder

public RequestPatternBuilder(String customRequestMatcherName,
 Parameters parameters)

Method Details

newRequestPattern

public static RequestPatternBuilder newRequestPattern(RequestMethod method,
 UrlPattern url)

newRequestPattern

public static RequestPatternBuilder newRequestPattern()

forCustomMatcher

public static RequestPatternBuilder forCustomMatcher(ValueMatcher<Request> requestMatcher)

forCustomMatcher

public static RequestPatternBuilder forCustomMatcher(String customRequestMatcherName,
 Parameters parameters)

allRequests

public static RequestPatternBuilder allRequests()

like

@Deprecated
public static RequestPatternBuilder like(RequestPattern requestPattern)

Deprecated.

use RequestPattern.transform() instead

Construct a builder that uses an existing RequestPattern as a template

Parameters:

requestPattern - A RequestPattern to copy

Returns:

A builder based on the RequestPattern

but

@Deprecated
public RequestPatternBuilder but()

Deprecated.

intended for use with now-deprecated like() method. Use RequestPattern.transform() instead.

withScheme

public RequestPatternBuilder withScheme(String scheme)

withHost

public RequestPatternBuilder withHost(StringValuePattern hostPattern)

withPort

public RequestPatternBuilder withPort(int port)

withClientIp

public RequestPatternBuilder withClientIp(StringValuePattern clientIpPattern)

withUrl

public RequestPatternBuilder withUrl(String url)

withUrl

public RequestPatternBuilder withUrl(UrlPattern urlPattern)

withHeader

public RequestPatternBuilder withHeader(String key,
 StringValuePattern valuePattern)

withHeader

public RequestPatternBuilder withHeader(String key,
 MultiValuePattern multiValuePattern)

withoutHeader

public RequestPatternBuilder withoutHeader(String key)

withPathParam

public RequestPatternBuilder withPathParam(String key,
 StringValuePattern valuePattern)

withQueryParam

public RequestPatternBuilder withQueryParam(String key,
 StringValuePattern valuePattern)

withQueryParam

public RequestPatternBuilder withQueryParam(String key,
 MultiValuePattern multiValuePattern)

withFormParam

public RequestPatternBuilder withFormParam(String key,
 StringValuePattern valuePattern)

withFormParam

public RequestPatternBuilder withFormParam(String key,
 MultiValuePattern multiValuePattern)

withoutFormParam

public RequestPatternBuilder withoutFormParam(String key)

withoutQueryParam

public RequestPatternBuilder withoutQueryParam(String key)

withCookie

public RequestPatternBuilder withCookie(String key,
 StringValuePattern valuePattern)

withBasicAuth

public RequestPatternBuilder withBasicAuth(BasicCredentials basicCredentials)

withRequestBody

public RequestPatternBuilder withRequestBody(ContentPattern valuePattern)

withRequestBodyPart

public RequestPatternBuilder withRequestBodyPart(MultipartValuePattern multiPattern)

withAnyRequestBodyPart

public RequestPatternBuilder withAnyRequestBodyPart(MultipartValuePatternBuilder multiPatternBuilder)

withAllRequestBodyParts

public RequestPatternBuilder withAllRequestBodyParts(MultipartValuePatternBuilder multiPatternBuilder)

andMatching

public RequestPatternBuilder andMatching(ValueMatcher<Request> customMatcher)

andMatching

public RequestPatternBuilder andMatching(String customRequestMatcherName)

andMatching

public RequestPatternBuilder andMatching(String customRequestMatcherName,
 Parameters parameters)

andMatching

public RequestPatternBuilder andMatching(CustomMatcherDefinition matcherDefinition)

clearQueryParams

public RequestPatternBuilder clearQueryParams()

clearFormParams

public RequestPatternBuilder clearFormParams()

clearBodyPatterns

public RequestPatternBuilder clearBodyPatterns()

build

public RequestPattern build()