Package com.github.tomakehurst.wiremock.matching

Class RequestPattern

java.lang.Object

com.github.tomakehurst.wiremock.matching.RequestPattern

All Implemented Interfaces:

NamedValueMatcher<Request>, ValueMatcher<Request>

public class RequestPattern
extends java.lang.Object
implements NamedValueMatcher<Request>

Field Summary

Fields

Modifier and Type	Field	Description
static RequestPattern	ANYTHING

Constructor Summary

Constructors

Constructor	Description
RequestPattern(CustomMatcherDefinition customMatcherDefinition)
RequestPattern(ValueMatcher<Request> customMatcher)
RequestPattern(java.lang.String scheme, StringValuePattern host, java.lang.Integer port, StringValuePattern clientIp, UrlPattern url, RequestMethod method, java.util.Map<java.lang.String,MultiValuePattern> headers, java.util.Map<java.lang.String,StringValuePattern> pathParams, java.util.Map<java.lang.String,MultiValuePattern> queryParams, java.util.Map<java.lang.String,MultiValuePattern> formParams, java.util.Map<java.lang.String,StringValuePattern> cookies, BasicCredentials basicAuthCredentials, java.util.List<ContentPattern<?>> bodyPatterns, CustomMatcherDefinition customMatcherDefinition, ValueMatcher<Request> customMatcher, java.util.List<MultipartValuePattern> multiPattern)
RequestPattern(java.lang.String scheme, StringValuePattern host, java.lang.Integer port, java.lang.String url, StringValuePattern clientIp, java.lang.String urlPattern, java.lang.String urlPath, java.lang.String urlPathPattern, java.lang.String urlPathTemplate, RequestMethod method, java.util.Map<java.lang.String,MultiValuePattern> headers, java.util.Map<java.lang.String,StringValuePattern> pathParams, java.util.Map<java.lang.String,MultiValuePattern> queryParams, java.util.Map<java.lang.String,MultiValuePattern> formParams, java.util.Map<java.lang.String,StringValuePattern> cookies, BasicCredentials basicAuthCredentials, java.util.List<ContentPattern<?>> bodyPatterns, CustomMatcherDefinition customMatcherDefinition, java.util.List<MultipartValuePattern> multiPattern)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,MultiValuePattern>	combineBasicAuthAndOtherHeaders()
boolean	equals(java.lang.Object o)
static RequestPattern	everything()
BasicCredentials	getBasicAuthCredentials()
java.util.List<ContentPattern<?>>	getBodyPatterns()
StringValuePattern	getClientIp()
java.util.Map<java.lang.String,StringValuePattern>	getCookies()
CustomMatcherDefinition	getCustomMatcher()
java.lang.String	getExpected()
java.util.Map<java.lang.String,MultiValuePattern>	getFormParameters()
java.util.Map<java.lang.String,MultiValuePattern>	getHeaders()
StringValuePattern	getHost()
ValueMatcher<Request>	getMatcher()
RequestMethod	getMethod()
java.util.List<MultipartValuePattern>	getMultipartPatterns()
java.lang.String	getName()
java.util.Map<java.lang.String,StringValuePattern>	getPathParameters()
java.lang.Integer	getPort()
java.util.Map<java.lang.String,MultiValuePattern>	getQueryParameters()
java.lang.String	getScheme()
java.lang.String	getUrl()
UrlPattern	getUrlMatcher()
java.lang.String	getUrlPath()
java.lang.String	getUrlPathPattern()
java.lang.String	getUrlPathTemplate()
java.lang.String	getUrlPattern()
boolean	hasCustomMatcher()
int	hashCode()
boolean	hasInlineCustomMatcher()
boolean	hasNamedCustomMatcher()
boolean	isMatchedBy(Request request, java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)
MatchResult	match(Request request)
MatchResult	match(Request request, java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)
static java.util.function.Predicate<Request>	thatMatch(RequestPattern pattern)
static java.util.function.Predicate<Request>	thatMatch(RequestPattern pattern, java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)
java.lang.String	toString()
static java.util.function.Predicate<ServeEvent>	withRequestMatching(RequestPattern pattern)
static java.util.function.Predicate<ServeEvent>	withRequestMatching(RequestPattern pattern, java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ANYTHING

public static final RequestPattern ANYTHING

Constructor Detail

RequestPattern

public RequestPattern(java.lang.String scheme,
                      StringValuePattern host,
                      java.lang.Integer port,
                      StringValuePattern clientIp,
                      UrlPattern url,
                      RequestMethod method,
                      java.util.Map<java.lang.String,MultiValuePattern> headers,
                      java.util.Map<java.lang.String,StringValuePattern> pathParams,
                      java.util.Map<java.lang.String,MultiValuePattern> queryParams,
                      java.util.Map<java.lang.String,MultiValuePattern> formParams,
                      java.util.Map<java.lang.String,StringValuePattern> cookies,
                      BasicCredentials basicAuthCredentials,
                      java.util.List<ContentPattern<?>> bodyPatterns,
                      CustomMatcherDefinition customMatcherDefinition,
                      ValueMatcher<Request> customMatcher,
                      java.util.List<MultipartValuePattern> multiPattern)

RequestPattern

public RequestPattern(java.lang.String scheme,
                      StringValuePattern host,
                      java.lang.Integer port,
                      java.lang.String url,
                      StringValuePattern clientIp,
                      java.lang.String urlPattern,
                      java.lang.String urlPath,
                      java.lang.String urlPathPattern,
                      java.lang.String urlPathTemplate,
                      RequestMethod method,
                      java.util.Map<java.lang.String,MultiValuePattern> headers,
                      java.util.Map<java.lang.String,StringValuePattern> pathParams,
                      java.util.Map<java.lang.String,MultiValuePattern> queryParams,
                      java.util.Map<java.lang.String,MultiValuePattern> formParams,
                      java.util.Map<java.lang.String,StringValuePattern> cookies,
                      BasicCredentials basicAuthCredentials,
                      java.util.List<ContentPattern<?>> bodyPatterns,
                      CustomMatcherDefinition customMatcherDefinition,
                      java.util.List<MultipartValuePattern> multiPattern)

RequestPattern

public RequestPattern(ValueMatcher<Request> customMatcher)

RequestPattern

public RequestPattern(CustomMatcherDefinition customMatcherDefinition)

Method Detail

match

public MatchResult match(Request request)

Specified by:

match in interface ValueMatcher<Request>

everything

public static RequestPattern everything()

match

public MatchResult match(Request request,
                         java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)

combineBasicAuthAndOtherHeaders

public java.util.Map<java.lang.String,MultiValuePattern> combineBasicAuthAndOtherHeaders()

isMatchedBy

public boolean isMatchedBy(Request request,
                           java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)

getScheme

public java.lang.String getScheme()

getHost

public StringValuePattern getHost()

getPort

public java.lang.Integer getPort()

getClientIp

public StringValuePattern getClientIp()

getUrl

public java.lang.String getUrl()

getUrlPattern

public java.lang.String getUrlPattern()

getUrlPath

public java.lang.String getUrlPath()

getUrlPathPattern

public java.lang.String getUrlPathPattern()

getUrlPathTemplate

public java.lang.String getUrlPathTemplate()

getUrlMatcher

public UrlPattern getUrlMatcher()

getMethod

public RequestMethod getMethod()

getHeaders

public java.util.Map<java.lang.String,MultiValuePattern> getHeaders()

getBasicAuthCredentials

public BasicCredentials getBasicAuthCredentials()

getPathParameters

public java.util.Map<java.lang.String,StringValuePattern> getPathParameters()

getQueryParameters

public java.util.Map<java.lang.String,MultiValuePattern> getQueryParameters()

getFormParameters

public java.util.Map<java.lang.String,MultiValuePattern> getFormParameters()

getCookies

public java.util.Map<java.lang.String,StringValuePattern> getCookies()

getBodyPatterns

public java.util.List<ContentPattern<?>> getBodyPatterns()

getCustomMatcher

public CustomMatcherDefinition getCustomMatcher()

getMultipartPatterns

public java.util.List<MultipartValuePattern> getMultipartPatterns()

getMatcher

public ValueMatcher<Request> getMatcher()

getName

public java.lang.String getName()

Specified by:

getName in interface NamedValueMatcher<Request>

getExpected

public java.lang.String getExpected()

Specified by:

getExpected in interface NamedValueMatcher<Request>

hasInlineCustomMatcher

public boolean hasInlineCustomMatcher()

hasNamedCustomMatcher

public boolean hasNamedCustomMatcher()

hasCustomMatcher

public boolean hasCustomMatcher()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

thatMatch

public static java.util.function.Predicate<Request> thatMatch(RequestPattern pattern)

thatMatch

public static java.util.function.Predicate<Request> thatMatch(RequestPattern pattern,
                                                              java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)

withRequestMatching

public static java.util.function.Predicate<ServeEvent> withRequestMatching(RequestPattern pattern)

withRequestMatching

public static java.util.function.Predicate<ServeEvent> withRequestMatching(RequestPattern pattern,
                                                                           java.util.Map<java.lang.String,RequestMatcherExtension> customMatchers)