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 Object
implements NamedValueMatcher<Request>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RequestPattern.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final RequestPattern	ANYTHING

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

ANYTHING

public static final RequestPattern ANYTHING

Constructor Details

RequestPattern

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

Method Details

transform

public RequestPattern transform(Consumer<RequestPattern.Builder> transformer)

toBuilder

public RequestPattern.Builder toBuilder()

match

public MatchResult match(Request request)

Specified by:

match in interface ValueMatcher<Request>

match

public MatchResult match(Request request,
 Map<String,RequestMatcherExtension> customMatchers)

combineBasicAuthAndOtherHeaders

public Map<String,MultiValuePattern> combineBasicAuthAndOtherHeaders()

isMatchedBy

public boolean isMatchedBy(Request request,
 Map<String,RequestMatcherExtension> customMatchers)

getScheme

public String getScheme()

getHost

public StringValuePattern getHost()

getPort

public Integer getPort()

getClientIp

public StringValuePattern getClientIp()

getUrl

public String getUrl()

getUrlPattern

public String getUrlPattern()

getUrlPath

public String getUrlPath()

getUrlPathPattern

public String getUrlPathPattern()

getUrlPathTemplate

public String getUrlPathTemplate()

getUrlMatcher

public UrlPattern getUrlMatcher()

getMethod

public RequestMethod getMethod()

getHeaders

public @NonNull Map<String,MultiValuePattern> getHeaders()

getBasicAuthCredentials

public BasicCredentials getBasicAuthCredentials()

getPathParameters

public @NonNull Map<String,StringValuePattern> getPathParameters()

getQueryParameters

public @NonNull Map<String,MultiValuePattern> getQueryParameters()

getFormParameters

public @NonNull Map<String,MultiValuePattern> getFormParameters()

getCookies

public @NonNull Map<String,StringValuePattern> getCookies()

getBodyPatterns

public @NonNull List<ContentPattern<?>> getBodyPatterns()

getCustomMatcher

public CustomMatcherDefinition getCustomMatcher()

getMultipartPatterns

public @NonNull List<MultipartValuePattern> getMultipartPatterns()

getInlineCustomMatcher

public ValueMatcher<Request> getInlineCustomMatcher()

getName

public String getName()

Specified by:

getName in interface NamedValueMatcher<Request>

getExpected

public 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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

thatMatch

public static Predicate<Request> thatMatch(RequestPattern pattern)

thatMatch

public static Predicate<Request> thatMatch(RequestPattern pattern,
 Map<String,RequestMatcherExtension> customMatchers)

withRequestMatching

public static Predicate<ServeEvent> withRequestMatching(RequestPattern pattern)

withRequestMatching

public static Predicate<ServeEvent> withRequestMatching(RequestPattern pattern,
 Map<String,RequestMatcherExtension> customMatchers)