Package com.github.tomakehurst.wiremock.client

Interface MappingBuilder

All Known Subinterfaces:

ScenarioMappingBuilder

public interface MappingBuilder

Method Summary

Modifier and Type	Method	Description
MappingBuilder	andMatching(CustomMatcherDefinition matcherDefinition)
MappingBuilder	andMatching(ValueMatcher<Request> requestMatcher)
MappingBuilder	andMatching(String customRequestMatcherName)
MappingBuilder	andMatching(String customRequestMatcherName, Parameters parameters)
MappingBuilder	atPriority(Integer priority)
StubMapping	build()
ScenarioMappingBuilder	inScenario(String scenarioName)
MappingBuilder	persistent()
MappingBuilder	persistent(boolean persistent)
MappingBuilder	willReturn(ResponseDefinitionBuilder responseDefBuilder)
MappingBuilder	withBasicAuth(String username, String password)
MappingBuilder	withClientIp(StringValuePattern hostPattern)
MappingBuilder	withCookie(String name, StringValuePattern cookieValuePattern)
MappingBuilder	withFormParam(String key, MultiValuePattern multiValueFormParamPattern)
MappingBuilder	withFormParam(String key, StringValuePattern formParamPattern)
MappingBuilder	withFormParams(Map<String,MultiValuePattern> formParams)
MappingBuilder	withHeader(String key, MultiValuePattern headerPattern)
MappingBuilder	withHeader(String key, StringValuePattern headerPattern)
MappingBuilder	withHost(StringValuePattern hostPattern)
MappingBuilder	withId(UUID id)
MappingBuilder	withMetadata(Metadata metadata)
MappingBuilder	withMetadata(Metadata.Builder metadata)
MappingBuilder	withMetadata(Map<String,?> metadata)
MappingBuilder	withMultipartRequestBody(MultipartValuePatternBuilder multipartPatternBuilder)
MappingBuilder	withName(String name)
MappingBuilder	withPathParam(String name, StringValuePattern pattern)
MappingBuilder	withPort(int port)
<P> MappingBuilder	withPostServeAction(String extensionName, P parameters)
MappingBuilder	withQueryParam(String key, MultiValuePattern multiValueQueryParamPattern)
MappingBuilder	withQueryParam(String key, StringValuePattern queryParamPattern)
MappingBuilder	withQueryParams(Map<String,StringValuePattern> queryParams)
MappingBuilder	withRequestBody(ContentPattern<?> bodyPattern)
MappingBuilder	withScheme(String scheme)
default <P> MappingBuilder	withServeEventListener(ServeEventListener.RequestPhase requestPhase, String extensionName, P parameters)
<P> MappingBuilder	withServeEventListener(String extensionName, P parameters)
<P> MappingBuilder	withServeEventListener(Set<ServeEventListener.RequestPhase> requestPhases, String extensionName, P parameters)

Method Details

withScheme

MappingBuilder withScheme(String scheme)

withHost

MappingBuilder withHost(StringValuePattern hostPattern)

withPort

MappingBuilder withPort(int port)

withClientIp

MappingBuilder withClientIp(StringValuePattern hostPattern)

atPriority

MappingBuilder atPriority(Integer priority)

withHeader

MappingBuilder withHeader(String key,
 StringValuePattern headerPattern)

withHeader

MappingBuilder withHeader(String key,
 MultiValuePattern headerPattern)

withPathParam

MappingBuilder withPathParam(String name,
 StringValuePattern pattern)

withQueryParam

MappingBuilder withQueryParam(String key,
 StringValuePattern queryParamPattern)

withQueryParam

MappingBuilder withQueryParam(String key,
 MultiValuePattern multiValueQueryParamPattern)

withFormParam

MappingBuilder withFormParam(String key,
 StringValuePattern formParamPattern)

withFormParam

MappingBuilder withFormParam(String key,
 MultiValuePattern multiValueFormParamPattern)

withFormParams

MappingBuilder withFormParams(Map<String,MultiValuePattern> formParams)

withQueryParams

MappingBuilder withQueryParams(Map<String,StringValuePattern> queryParams)

withRequestBody

MappingBuilder withRequestBody(ContentPattern<?> bodyPattern)

withMultipartRequestBody

MappingBuilder withMultipartRequestBody(MultipartValuePatternBuilder multipartPatternBuilder)

inScenario

ScenarioMappingBuilder inScenario(String scenarioName)

withId

MappingBuilder withId(UUID id)

withName

MappingBuilder withName(String name)

persistent

MappingBuilder persistent()

persistent

MappingBuilder persistent(boolean persistent)

withBasicAuth

MappingBuilder withBasicAuth(String username,
 String password)

withCookie

MappingBuilder withCookie(String name,
 StringValuePattern cookieValuePattern)

withPostServeAction

<P> MappingBuilder withPostServeAction(String extensionName,
 P parameters)

withServeEventListener

default <P> MappingBuilder withServeEventListener(ServeEventListener.RequestPhase requestPhase,
 String extensionName,
 P parameters)

withServeEventListener

<P> MappingBuilder withServeEventListener(Set<ServeEventListener.RequestPhase> requestPhases,
 String extensionName,
 P parameters)

withServeEventListener

<P> MappingBuilder withServeEventListener(String extensionName,
 P parameters)

withMetadata

MappingBuilder withMetadata(Map<String,?> metadata)

withMetadata

MappingBuilder withMetadata(Metadata metadata)

withMetadata

MappingBuilder withMetadata(Metadata.Builder metadata)

andMatching

MappingBuilder andMatching(ValueMatcher<Request> requestMatcher)

andMatching

MappingBuilder andMatching(String customRequestMatcherName)

andMatching

MappingBuilder andMatching(String customRequestMatcherName,
 Parameters parameters)

andMatching

MappingBuilder andMatching(CustomMatcherDefinition matcherDefinition)

willReturn

MappingBuilder willReturn(ResponseDefinitionBuilder responseDefBuilder)

build

StubMapping build()