Package com.github.tomakehurst.wiremock.client

Class WireMock

java.lang.Object

com.github.tomakehurst.wiremock.client.WireMock

public class WireMock
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WireMock.JsonSchemaVersion

Constructor Summary

Constructors

Constructor	Description
WireMock(int port)
WireMock(Admin admin)

Method Summary

Modifier and Type	Method	Description
static StringValuePattern	absent()
static AfterDateTimePattern	after(String dateTimeSpec)
static AfterDateTimePattern	after(LocalDateTime dateTime)
static AfterDateTimePattern	after(ZonedDateTime dateTime)
static AfterDateTimePattern	afterNow()
ListMessageChannelsResult	allMessageChannels()
ListMessageStubMappingsResult	allMessageStubMappings()
ListStubMappingsResult	allStubMappings()
static MultipartValuePatternBuilder	aMultipart()
static MultipartValuePatternBuilder	aMultipart(String name)
static StringValuePattern	and(StringValuePattern... matchers)
static MappingBuilder	any(UrlPattern urlPattern)
static RequestPatternBuilder	anyRequestedFor(UrlPattern urlPattern)
static UrlPattern	anyUrl()
static ResponseDefinitionBuilder	aResponse()
static ResponseDefinitionBuilder	badRequest()
static ResponseDefinitionBuilder	badRequestEntity()
static BeforeDateTimePattern	before(String dateTimeSpec)
static BeforeDateTimePattern	before(LocalDateTime dateTime)
static BeforeDateTimePattern	before(ZonedDateTime dateTime)
static BeforeDateTimePattern	beforeNow()
static BinaryEqualToPattern	binaryEqualTo(byte[] content)
static BinaryEqualToPattern	binaryEqualTo(String content)
static void	configure()
static void	configureFor(int port)
static void	configureFor(WireMock client)
static void	configureFor(String host, int port)
static void	configureFor(String host, int port, String urlPathPrefix)
static void	configureFor(String scheme, String host, int port)
static void	configureFor(String scheme, String host, int port, String urlPathPrefix)
static void	configureFor(String scheme, String host, int port, String proxyHost, int proxyPort)
static StringValuePattern	containing(String value)
static WireMockBuilder	create()
static ResponseDefinitionBuilder	created()
static MappingBuilder	delete(UrlPattern urlPattern)
static MappingBuilder	delete(String url)
void	deleteMessageServeEvent(UUID eventId)
void	deleteMessageStub(UUID id)
static RequestPatternBuilder	deleteRequestedFor(UrlPattern urlPattern)
static void	editStub(MappingBuilder mappingBuilder)
void	editStubMapping(MappingBuilder mappingBuilder)
static StringValuePattern	equalTo(String value)
static EqualToDateTimePattern	equalToDateTime(String dateTimeSpec)
static EqualToDateTimePattern	equalToDateTime(LocalDateTime dateTime)
static EqualToDateTimePattern	equalToDateTime(ZonedDateTime dateTime)
static StringValuePattern	equalToIgnoreCase(String value)
static StringValuePattern	equalToJson(String value)
static StringValuePattern	equalToJson(String value, boolean ignoreArrayOrder, boolean ignoreExtraElements)
static StringValuePattern	equalToNumber(Number value)
static EqualToXmlPattern	equalToXml(String value)
static EqualToXmlPattern	equalToXml(String value, boolean enablePlaceholders)
static EqualToXmlPattern	equalToXml(String value, boolean enablePlaceholders, boolean ignoreOrderOfSameNode)
static EqualToXmlPattern	equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex)
static EqualToXmlPattern	equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode)
static EqualToXmlPattern	equalToXml(String value, boolean enablePlaceholders, String placeholderOpeningDelimiterRegex, String placeholderClosingDelimiterRegex, boolean ignoreOrderOfSameNode, EqualToXmlPattern.NamespaceAwareness namespaceAwareness)
static EqualToXmlPattern	equalToXml(String value, EqualToXmlPattern.NamespaceAwareness namespaceAwareness)
static CountMatchingStrategy	exactly(int expected)
List<LoggedRequest>	find(RequestPatternBuilder requestPatternBuilder)
static List<LoggedRequest>	findAll(RequestPatternBuilder requestPatternBuilder)
static List<MessageServeEvent>	findAllMessageEvents(MessagePattern pattern)
List<MessageStubMapping>	findAllMessageStubsByMetadata(StringValuePattern pattern)
List<NearMiss>	findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)
List<StubMapping>	findAllStubsByMetadata(StringValuePattern pattern)
List<LoggedRequest>	findAllUnmatchedRequests()
List<MessageServeEvent>	findMessageEvents(MessagePattern pattern)
static List<MessageStubMapping>	findMessageStubsByMetadata(StringValuePattern pattern)
static List<NearMiss>	findNearMissesFor(RequestPatternBuilder requestPatternBuilder)
static List<NearMiss>	findNearMissesFor(LoggedRequest loggedRequest)
static List<NearMiss>	findNearMissesForAllUnmatched()
List<NearMiss>	findNearMissesForAllUnmatchedRequests()
static List<StubMapping>	findStubsByMetadata(StringValuePattern pattern)
List<NearMiss>	findTopNearMissesFor(LoggedRequest loggedRequest)
static List<LoggedRequest>	findUnmatchedRequests()
static ResponseDefinitionBuilder	forbidden()
static MappingBuilder	get(UrlPattern urlPattern)
static MappingBuilder	get(String url)
static List<MessageServeEvent>	getAllMessageServeEvents()
static List<Scenario>	getAllScenarios()
static List<ServeEvent>	getAllServeEvents()
static List<ServeEvent>	getAllServeEvents(ServeEventQuery query)
GlobalSettings	getGlobalSettings()
static MessageServeEvent	getMessageServeEvent(UUID id)
MessageServeEvent	getMessageServeEventById(UUID id)
List<MessageServeEvent>	getMessageServeEvents()
static MappingBuilder	getOrHead(UrlPattern urlPattern)	A mapping builder that can be used for both GET and HEAD http method.
static RecordingStatusResult	getRecordingStatus()
static RequestPatternBuilder	getRequestedFor(UrlPattern urlPattern)
List<Scenario>	getScenarios()
List<ServeEvent>	getServeEvents()
List<ServeEvent>	getServeEvents(ServeEventQuery query)
static GlobalSettings	getSettings()
static StubMapping	getSingleStubMapping(UUID id)
SingleStubMappingResult	getStubMapping(UUID id)
RecordingStatusResult	getStubRecordingStatus()
static StubMapping	givenThat(MappingBuilder mappingBuilder)
static StringValuePattern	greaterThanEqualNumber(Number value)
static StringValuePattern	greaterThanNumber(Number value)
static MultiValuePattern	havingExactly(StringValuePattern... valuePatterns)
static MultiValuePattern	havingExactly(String... values)
static MappingBuilder	head(UrlPattern urlPattern)
static RequestPatternBuilder	headRequestedFor(UrlPattern urlPattern)
void	importStubMappings(StubImport stubImport)
void	importStubMappings(StubImportBuilder stubImport)
static void	importStubs(StubImport stubImport)
static void	importStubs(StubImportBuilder stubImport)
static MultiValuePattern	including(StringValuePattern... valuePatterns)
static MultiValuePattern	including(String... values)
static EqualToDateTimePattern	isNow()
static ResponseDefinitionBuilder	jsonResponse(Object body, int status)
static ResponseDefinitionBuilder	jsonResponse(String body, int status)
static CountMatchingStrategy	lessThan(int expected)
static StringValuePattern	lessThanEqualNumber(Number value)
static StringValuePattern	lessThanNumber(Number value)
static CountMatchingStrategy	lessThanOrExactly(int expected)
static ListMessageChannelsResult	listAllMessageChannels()
static ListMessageStubMappingsResult	listAllMessageStubMappings()
static ListStubMappingsResult	listAllStubMappings()
void	loadMappingsFrom(File rootDir)
void	loadMappingsFrom(String rootDir)
static MatchesXPathPattern	matchesXPathWithSubMatcher(String value, StringValuePattern valuePattern)
static StringValuePattern	matching(String regex)
static StringValuePattern	matchingJsonPath(String value)
static StringValuePattern	matchingJsonPath(String value, StringValuePattern valuePattern)
static StringValuePattern	matchingJsonSchema(String schema)
static StringValuePattern	matchingJsonSchema(String schema, WireMock.JsonSchemaVersion jsonSchemaVersion)
static MatchesXPathPattern	matchingXPath(String value)
static StringValuePattern	matchingXPath(String value, StringValuePattern valuePattern)
static StringValuePattern	matchingXPath(String value, Map<String,String> namespaces)
static MessageStubMapping.Builder	message()
static MessageStubMapping	messageStubFor(MessageStubMappingBuilder builder)
static MessageStubMapping	messageStubFor(MessageStubMapping messageStubMapping)
static CountMatchingStrategy	moreThan(int expected)
static CountMatchingStrategy	moreThanOrExactly(int expected)
static ResponseDefinitionBuilder	noContent()
static StringValuePattern	not(StringValuePattern unexpectedPattern)
static StringValuePattern	notContaining(String value)
static ResponseDefinitionBuilder	notFound()
static StringValuePattern	notMatching(String regex)
static MultiValuePattern	noValues()
static ResponseDefinitionBuilder	ok()
static ResponseDefinitionBuilder	ok(String body)
static ResponseDefinitionBuilder	okForContentType(String contentType, String body)
static ResponseDefinitionBuilder	okJson(String body)
static ResponseDefinitionBuilder	okTextXml(String body)
static ResponseDefinitionBuilder	okXml(String body)
static MappingBuilder	options(UrlPattern urlPattern)
static RequestPatternBuilder	optionsRequestedFor(UrlPattern urlPattern)
static StringValuePattern	or(StringValuePattern... matchers)
static MappingBuilder	patch(UrlPattern urlPattern)
static MappingBuilder	patch(String url)
static RequestPatternBuilder	patchRequestedFor(UrlPattern urlPattern)
static ResponseDefinitionBuilder	permanentRedirect(String location)
static MappingBuilder	post(UrlPattern urlPattern)
static MappingBuilder	post(String url)
static RequestPatternBuilder	postRequestedFor(UrlPattern urlPattern)
static MappingBuilder	proxyAllTo(String url)
static MappingBuilder	put(UrlPattern urlPattern)
static MappingBuilder	put(String url)
static RequestPatternBuilder	putRequestedFor(UrlPattern urlPattern)
static MappingBuilder	query(UrlPattern urlPattern)
static MappingBuilder	query(String url)
static RequestPatternBuilder	queryRequestedFor(UrlPattern urlPattern)
static RecordSpecBuilder	recordSpec()
StubMapping	register(MappingBuilder mappingBuilder)
void	register(StubMapping mapping)
MessageStubMapping	registerMessageStub(MessageStubMappingBuilder builder)
MessageStubMapping	registerMessageStub(MessageStubMapping messageStubMapping)
static void	removeAllMappings()
void	removeAllMessageStubsByMetadata(StringValuePattern pattern)
void	removeEvent(UUID eventId)
List<ServeEvent>	removeEvents(RequestPatternBuilder requestPatternBuilder)
List<ServeEvent>	removeEventsByMetadata(StringValuePattern pattern)
static List<ServeEvent>	removeEventsByStubMetadata(StringValuePattern pattern)
void	removeMappings()
FindMessageServeEventsResult	removeMessageEvents(MessagePattern pattern)
FindMessageServeEventsResult	removeMessageEventsForStubsMatchingMetadata(StringValuePattern pattern)
static void	removeMessageServeEvent(UUID eventId)
static FindMessageServeEventsResult	removeMessageServeEventsForStubsMatchingMetadata(StringValuePattern pattern)
static FindMessageServeEventsResult	removeMessageServeEventsMatching(MessagePattern pattern)
static void	removeMessageStub(UUID id)
static void	removeMessageStubsByMetadata(StringValuePattern pattern)
static void	removeServeEvent(UUID eventId)
static List<ServeEvent>	removeServeEvents(RequestPatternBuilder requestPatternBuilder)
static void	removeStub(MappingBuilder mappingBuilder)
static void	removeStub(StubMapping stubMapping)
static void	removeStub(UUID id)
void	removeStubMapping(MappingBuilder mappingBuilder)
void	removeStubMapping(StubMapping stubMapping)
void	removeStubMapping(UUID id)
void	removeStubMappings(List<StubMapping> stubs)
static void	removeStubs(List<StubMapping> stubs)
static void	removeStubsByMetadata(StringValuePattern pattern)
void	removeStubsByMetadataPattern(StringValuePattern pattern)
static MappingBuilder	request(RequestMethod method, UrlPattern urlPattern)
static MappingBuilder	request(String method, UrlPattern urlPattern)
static RequestPatternBuilder	requestedFor(String method, UrlPattern urlPattern)
static RequestPatternBuilder	requestMadeFor(ValueMatcher<Request> requestMatcher)
static RequestPatternBuilder	requestMadeFor(String customMatcherName, Parameters parameters)
static MappingBuilder	requestMatching(ValueMatcher<Request> requestMatcher)
static MappingBuilder	requestMatching(String customRequestMatcherName)
static MappingBuilder	requestMatching(String customRequestMatcherName, Parameters parameters)
static void	reset()
void	resetAllMessageStubs()
static void	resetAllRequests()
static void	resetAllScenarios()
void	resetMappings()
static void	resetMessageJournal()
void	resetMessages()
static void	resetMessageStubs()
void	resetRequests()
static void	resetScenario(String name)
void	resetScenarios()
void	resetScenarioState(String name)
static void	resetToDefault()
void	resetToDefaultMappings()
static void	saveAllMappings()
void	saveMappings()
static ResponseDefinitionBuilder	seeOther(String location)
static SendMessageActionBuilder	sendMessage()
static SendMessageActionBuilder	sendMessage(String message)
static ResponseDefinitionBuilder	serverError()
static ResponseDefinitionBuilder	serviceUnavailable()
static void	setGlobalFixedDelay(int milliseconds)
void	setGlobalFixedDelayVariable(int milliseconds)
static void	setGlobalRandomDelay(DelayDistribution distribution)
void	setGlobalRandomDelayVariable(DelayDistribution distribution)
static void	setScenarioState(String name, String state)
void	setSingleScenarioState(String name, String state)
void	shutdown()
static void	shutdownServer()
static List<StubMapping>	snapshotRecord()
static List<StubMapping>	snapshotRecord(RecordSpecBuilder spec)
static void	startRecording()
static void	startRecording(RecordSpecBuilder spec)
static void	startRecording(String targetBaseUrl)
void	startStubRecording()
void	startStubRecording(RecordSpecBuilder spec)
void	startStubRecording(String targetBaseUrl)
static ResponseDefinitionBuilder	status(int status)
static SnapshotRecordResult	stopRecording()
SnapshotRecordResult	stopStubRecording()
static StubMapping	stubFor(MappingBuilder mappingBuilder)
List<StubMapping>	takeSnapshotRecording()
List<StubMapping>	takeSnapshotRecording(RecordSpecBuilder spec)
static ResponseDefinitionBuilder	temporaryRedirect(String location)
static MappingBuilder	trace(UrlPattern urlPattern)
static RequestPatternBuilder	traceRequestedFor(UrlPattern urlPattern)
static ResponseDefinitionBuilder	unauthorized()
void	updateGlobalSettings(GlobalSettings settings)
static void	updateSettings(GlobalSettings settings)
static UrlPattern	urlEqualTo(String testUrl)
static UrlPattern	urlEqualTo(org.wiremock.url.PathAndQuery testUrl)
static UrlPattern	urlMatching(String urlRegex)
static UrlPathPattern	urlPathEqualTo(String testUrl)
static UrlPathPattern	urlPathEqualTo(org.wiremock.url.Path testUrl)
static UrlPathPattern	urlPathMatching(String urlRegex)
static UrlPathPattern	urlPathTemplate(String pathTemplate)
static void	verify(int count, RequestPatternBuilder requestPatternBuilder)
static void	verify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder)
static void	verify(RequestPatternBuilder requestPatternBuilder)
static void	verifyMessageEvent(int expectedCount, MessagePattern pattern)
static void	verifyMessageEvent(CountMatchingStrategy expectedCount, MessagePattern pattern)
static void	verifyMessageEvent(MessagePattern pattern)
void	verifyThat(int expectedCount, RequestPatternBuilder requestPatternBuilder)
void	verifyThat(CountMatchingStrategy expectedCount, RequestPatternBuilder requestPatternBuilder)
void	verifyThat(RequestPatternBuilder requestPatternBuilder)
void	verifyThatMessageEvent(int expectedCount, MessagePattern pattern)
void	verifyThatMessageEvent(CountMatchingStrategy expectedCount, MessagePattern pattern)
void	verifyThatMessageEvent(MessagePattern pattern)
Optional<MessageServeEvent>	waitForMessage(MessagePattern pattern, Duration maxWait)
static Optional<MessageServeEvent>	waitForMessageEvent(MessagePattern pattern, Duration maxWait)
static List<MessageServeEvent>	waitForMessageEvents(MessagePattern pattern, int count, Duration maxWait)
List<MessageServeEvent>	waitForMessages(MessagePattern pattern, int count, Duration maxWait)

Methods inherited from class java.lang.Object

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

Constructor Details

WireMock

public WireMock(Admin admin)

WireMock

public WireMock(int port)

Method Details

create

public static WireMockBuilder create()

givenThat

public static StubMapping givenThat(MappingBuilder mappingBuilder)

stubFor

public static StubMapping stubFor(MappingBuilder mappingBuilder)

editStub

public static void editStub(MappingBuilder mappingBuilder)

removeStub

public static void removeStub(MappingBuilder mappingBuilder)

removeStub

public static void removeStub(StubMapping stubMapping)

removeStub

public static void removeStub(UUID id)

listAllStubMappings

public static ListStubMappingsResult listAllStubMappings()

getSingleStubMapping

public static StubMapping getSingleStubMapping(UUID id)

configureFor

public static void configureFor(int port)

configureFor

public static void configureFor(String host,
 int port)

configureFor

public static void configureFor(String host,
 int port,
 String urlPathPrefix)

configureFor

public static void configureFor(String scheme,
 String host,
 int port,
 String urlPathPrefix)

configureFor

public static void configureFor(String scheme,
 String host,
 int port)

configureFor

public static void configureFor(String scheme,
 String host,
 int port,
 String proxyHost,
 int proxyPort)

configureFor

public static void configureFor(WireMock client)

configure

public static void configure()

equalTo

public static StringValuePattern equalTo(String value)

equalToNumber

public static StringValuePattern equalToNumber(Number value)

greaterThanNumber

public static StringValuePattern greaterThanNumber(Number value)

greaterThanEqualNumber

public static StringValuePattern greaterThanEqualNumber(Number value)

lessThanNumber

public static StringValuePattern lessThanNumber(Number value)

lessThanEqualNumber

public static StringValuePattern lessThanEqualNumber(Number value)

binaryEqualTo

public static BinaryEqualToPattern binaryEqualTo(byte[] content)

binaryEqualTo

public static BinaryEqualToPattern binaryEqualTo(String content)

equalToIgnoreCase

public static StringValuePattern equalToIgnoreCase(String value)

equalToJson

public static StringValuePattern equalToJson(String value)

equalToJson

public static StringValuePattern equalToJson(String value,
 boolean ignoreArrayOrder,
 boolean ignoreExtraElements)

matchingJsonPath

public static StringValuePattern matchingJsonPath(String value)

matchingJsonPath

public static StringValuePattern matchingJsonPath(String value,
 StringValuePattern valuePattern)

matchingJsonSchema

public static StringValuePattern matchingJsonSchema(String schema)

matchingJsonSchema

public static StringValuePattern matchingJsonSchema(String schema,
 WireMock.JsonSchemaVersion jsonSchemaVersion)

equalToXml

public static EqualToXmlPattern equalToXml(String value)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 EqualToXmlPattern.NamespaceAwareness namespaceAwareness)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 boolean enablePlaceholders)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 boolean enablePlaceholders,
 boolean ignoreOrderOfSameNode)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 boolean enablePlaceholders,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 boolean enablePlaceholders,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex,
 boolean ignoreOrderOfSameNode)

equalToXml

public static EqualToXmlPattern equalToXml(String value,
 boolean enablePlaceholders,
 String placeholderOpeningDelimiterRegex,
 String placeholderClosingDelimiterRegex,
 boolean ignoreOrderOfSameNode,
 EqualToXmlPattern.NamespaceAwareness namespaceAwareness)

matchingXPath

public static MatchesXPathPattern matchingXPath(String value)

matchingXPath

public static StringValuePattern matchingXPath(String value,
 Map<String,String> namespaces)

matchingXPath

public static StringValuePattern matchingXPath(String value,
 StringValuePattern valuePattern)

matchesXPathWithSubMatcher

public static MatchesXPathPattern matchesXPathWithSubMatcher(String value,
 StringValuePattern valuePattern)

containing

public static StringValuePattern containing(String value)

notContaining

public static StringValuePattern notContaining(String value)

not

public static StringValuePattern not(StringValuePattern unexpectedPattern)

matching

public static StringValuePattern matching(String regex)

notMatching

public static StringValuePattern notMatching(String regex)

before

public static BeforeDateTimePattern before(String dateTimeSpec)

before

public static BeforeDateTimePattern before(ZonedDateTime dateTime)

before

public static BeforeDateTimePattern before(LocalDateTime dateTime)

beforeNow

public static BeforeDateTimePattern beforeNow()

equalToDateTime

public static EqualToDateTimePattern equalToDateTime(String dateTimeSpec)

equalToDateTime

public static EqualToDateTimePattern equalToDateTime(ZonedDateTime dateTime)

equalToDateTime

public static EqualToDateTimePattern equalToDateTime(LocalDateTime dateTime)

isNow

public static EqualToDateTimePattern isNow()

after

public static AfterDateTimePattern after(String dateTimeSpec)

after

public static AfterDateTimePattern after(ZonedDateTime dateTime)

after

public static AfterDateTimePattern after(LocalDateTime dateTime)

afterNow

public static AfterDateTimePattern afterNow()

absent

public static StringValuePattern absent()

and

public static StringValuePattern and(StringValuePattern... matchers)

or

public static StringValuePattern or(StringValuePattern... matchers)

saveMappings

public void saveMappings()

saveAllMappings

public static void saveAllMappings()

removeMappings

public void removeMappings()

removeAllMappings

public static void removeAllMappings()

resetMappings

public void resetMappings()

reset

public static void reset()

resetAllRequests

public static void resetAllRequests()

resetRequests

public void resetRequests()

resetScenarios

public void resetScenarios()

resetScenario

public static void resetScenario(String name)

resetScenarioState

public void resetScenarioState(String name)

setScenarioState

public static void setScenarioState(String name,
 String state)

setSingleScenarioState

public void setSingleScenarioState(String name,
 String state)

getAllScenarios

public static List<Scenario> getAllScenarios()

getScenarios

public List<Scenario> getScenarios()

resetAllScenarios

public static void resetAllScenarios()

resetToDefaultMappings

public void resetToDefaultMappings()

resetToDefault

public static void resetToDefault()

register

public StubMapping register(MappingBuilder mappingBuilder)

register

public void register(StubMapping mapping)

editStubMapping

public void editStubMapping(MappingBuilder mappingBuilder)

removeStubMapping

public void removeStubMapping(MappingBuilder mappingBuilder)

removeStubMapping

public void removeStubMapping(StubMapping stubMapping)

removeStubMapping

public void removeStubMapping(UUID id)

allStubMappings

public ListStubMappingsResult allStubMappings()

getStubMapping

public SingleStubMappingResult getStubMapping(UUID id)

urlEqualTo

public static UrlPattern urlEqualTo(org.wiremock.url.PathAndQuery testUrl)

urlEqualTo

public static UrlPattern urlEqualTo(String testUrl)

urlMatching

public static UrlPattern urlMatching(String urlRegex)

urlPathEqualTo

public static UrlPathPattern urlPathEqualTo(org.wiremock.url.Path testUrl)

urlPathEqualTo

public static UrlPathPattern urlPathEqualTo(String testUrl)

urlPathMatching

public static UrlPathPattern urlPathMatching(String urlRegex)

urlPathTemplate

public static UrlPathPattern urlPathTemplate(String pathTemplate)

havingExactly

public static MultiValuePattern havingExactly(StringValuePattern... valuePatterns)

havingExactly

public static MultiValuePattern havingExactly(String... values)

including

public static MultiValuePattern including(StringValuePattern... valuePatterns)

including

public static MultiValuePattern including(String... values)

noValues

public static MultiValuePattern noValues()

anyUrl

public static UrlPattern anyUrl()

lessThan

public static CountMatchingStrategy lessThan(int expected)

lessThanOrExactly

public static CountMatchingStrategy lessThanOrExactly(int expected)

exactly

public static CountMatchingStrategy exactly(int expected)

moreThanOrExactly

public static CountMatchingStrategy moreThanOrExactly(int expected)

moreThan

public static CountMatchingStrategy moreThan(int expected)

get

public static MappingBuilder get(UrlPattern urlPattern)

post

public static MappingBuilder post(UrlPattern urlPattern)

put

public static MappingBuilder put(UrlPattern urlPattern)

delete

public static MappingBuilder delete(UrlPattern urlPattern)

patch

public static MappingBuilder patch(UrlPattern urlPattern)

head

public static MappingBuilder head(UrlPattern urlPattern)

options

public static MappingBuilder options(UrlPattern urlPattern)

trace

public static MappingBuilder trace(UrlPattern urlPattern)

any

public static MappingBuilder any(UrlPattern urlPattern)

query

public static MappingBuilder query(UrlPattern urlPattern)

getOrHead

public static MappingBuilder getOrHead(UrlPattern urlPattern)

A mapping builder that can be used for both GET and HEAD http method. Returns a response body in case for GET and not in case of HEAD method. In case of tie the request is treated as a GET request

Parameters:

urlPattern - for the specified method

Returns:

a mapping builder for RequestMethod.GET_OR_HEAD http method

request

public static MappingBuilder request(String method,
 UrlPattern urlPattern)

request

public static MappingBuilder request(RequestMethod method,
 UrlPattern urlPattern)

requestMatching

public static MappingBuilder requestMatching(String customRequestMatcherName)

requestMatching

public static MappingBuilder requestMatching(String customRequestMatcherName,
 Parameters parameters)

requestMatching

public static MappingBuilder requestMatching(ValueMatcher<Request> requestMatcher)

aResponse

public static ResponseDefinitionBuilder aResponse()

ok

public static ResponseDefinitionBuilder ok()

ok

public static ResponseDefinitionBuilder ok(String body)

okForContentType

public static ResponseDefinitionBuilder okForContentType(String contentType,
 String body)

okJson

public static ResponseDefinitionBuilder okJson(String body)

okXml

public static ResponseDefinitionBuilder okXml(String body)

okTextXml

public static ResponseDefinitionBuilder okTextXml(String body)

jsonResponse

public static ResponseDefinitionBuilder jsonResponse(String body,
 int status)

jsonResponse

public static ResponseDefinitionBuilder jsonResponse(Object body,
 int status)

proxyAllTo

public static MappingBuilder proxyAllTo(String url)

get

public static MappingBuilder get(String url)

post

public static MappingBuilder post(String url)

put

public static MappingBuilder put(String url)

delete

public static MappingBuilder delete(String url)

patch

public static MappingBuilder patch(String url)

query

public static MappingBuilder query(String url)

created

public static ResponseDefinitionBuilder created()

noContent

public static ResponseDefinitionBuilder noContent()

permanentRedirect

public static ResponseDefinitionBuilder permanentRedirect(String location)

temporaryRedirect

public static ResponseDefinitionBuilder temporaryRedirect(String location)

seeOther

public static ResponseDefinitionBuilder seeOther(String location)

badRequest

public static ResponseDefinitionBuilder badRequest()

badRequestEntity

public static ResponseDefinitionBuilder badRequestEntity()

unauthorized

public static ResponseDefinitionBuilder unauthorized()

forbidden

public static ResponseDefinitionBuilder forbidden()

notFound

public static ResponseDefinitionBuilder notFound()

serverError

public static ResponseDefinitionBuilder serverError()

serviceUnavailable

public static ResponseDefinitionBuilder serviceUnavailable()

status

public static ResponseDefinitionBuilder status(int status)

verifyThat

public void verifyThat(RequestPatternBuilder requestPatternBuilder)

verifyThat

public void verifyThat(int expectedCount,
 RequestPatternBuilder requestPatternBuilder)

verifyThat

public void verifyThat(CountMatchingStrategy expectedCount,
 RequestPatternBuilder requestPatternBuilder)

verify

public static void verify(RequestPatternBuilder requestPatternBuilder)

verify

public static void verify(int count,
 RequestPatternBuilder requestPatternBuilder)

verify

public static void verify(CountMatchingStrategy countMatchingStrategy,
 RequestPatternBuilder requestPatternBuilder)

find

public List<LoggedRequest> find(RequestPatternBuilder requestPatternBuilder)

findAll

public static List<LoggedRequest> findAll(RequestPatternBuilder requestPatternBuilder)

getAllServeEvents

public static List<ServeEvent> getAllServeEvents()

getServeEvents

public List<ServeEvent> getServeEvents()

getAllServeEvents

public static List<ServeEvent> getAllServeEvents(ServeEventQuery query)

getServeEvents

public List<ServeEvent> getServeEvents(ServeEventQuery query)

removeServeEvent

public static void removeServeEvent(UUID eventId)

removeEvent

public void removeEvent(UUID eventId)

removeEvents

public List<ServeEvent> removeEvents(RequestPatternBuilder requestPatternBuilder)

removeServeEvents

public static List<ServeEvent> removeServeEvents(RequestPatternBuilder requestPatternBuilder)

removeEventsByStubMetadata

public static List<ServeEvent> removeEventsByStubMetadata(StringValuePattern pattern)

removeEventsByMetadata

public List<ServeEvent> removeEventsByMetadata(StringValuePattern pattern)

getRequestedFor

public static RequestPatternBuilder getRequestedFor(UrlPattern urlPattern)

postRequestedFor

public static RequestPatternBuilder postRequestedFor(UrlPattern urlPattern)

putRequestedFor

public static RequestPatternBuilder putRequestedFor(UrlPattern urlPattern)

deleteRequestedFor

public static RequestPatternBuilder deleteRequestedFor(UrlPattern urlPattern)

patchRequestedFor

public static RequestPatternBuilder patchRequestedFor(UrlPattern urlPattern)

headRequestedFor

public static RequestPatternBuilder headRequestedFor(UrlPattern urlPattern)

optionsRequestedFor

public static RequestPatternBuilder optionsRequestedFor(UrlPattern urlPattern)

traceRequestedFor

public static RequestPatternBuilder traceRequestedFor(UrlPattern urlPattern)

anyRequestedFor

public static RequestPatternBuilder anyRequestedFor(UrlPattern urlPattern)

queryRequestedFor

public static RequestPatternBuilder queryRequestedFor(UrlPattern urlPattern)

requestedFor

public static RequestPatternBuilder requestedFor(String method,
 UrlPattern urlPattern)

requestMadeFor

public static RequestPatternBuilder requestMadeFor(String customMatcherName,
 Parameters parameters)

requestMadeFor

public static RequestPatternBuilder requestMadeFor(ValueMatcher<Request> requestMatcher)

setGlobalFixedDelay

public static void setGlobalFixedDelay(int milliseconds)

setGlobalFixedDelayVariable

public void setGlobalFixedDelayVariable(int milliseconds)

setGlobalRandomDelay

public static void setGlobalRandomDelay(DelayDistribution distribution)

setGlobalRandomDelayVariable

public void setGlobalRandomDelayVariable(DelayDistribution distribution)

updateSettings

public static void updateSettings(GlobalSettings settings)

updateGlobalSettings

public void updateGlobalSettings(GlobalSettings settings)

shutdown

public void shutdown()

shutdownServer

public static void shutdownServer()

findNearMissesForAllUnmatched

public static List<NearMiss> findNearMissesForAllUnmatched()

findNearMissesForAllUnmatchedRequests

public List<NearMiss> findNearMissesForAllUnmatchedRequests()

findUnmatchedRequests

public static List<LoggedRequest> findUnmatchedRequests()

findAllUnmatchedRequests

public List<LoggedRequest> findAllUnmatchedRequests()

findNearMissesFor

public static List<NearMiss> findNearMissesFor(LoggedRequest loggedRequest)

findTopNearMissesFor

public List<NearMiss> findTopNearMissesFor(LoggedRequest loggedRequest)

findNearMissesFor

public static List<NearMiss> findNearMissesFor(RequestPatternBuilder requestPatternBuilder)

findAllNearMissesFor

public List<NearMiss> findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)

loadMappingsFrom

public void loadMappingsFrom(String rootDir)

loadMappingsFrom

public void loadMappingsFrom(File rootDir)

snapshotRecord

public static List<StubMapping> snapshotRecord()

snapshotRecord

public static List<StubMapping> snapshotRecord(RecordSpecBuilder spec)

takeSnapshotRecording

public List<StubMapping> takeSnapshotRecording()

takeSnapshotRecording

public List<StubMapping> takeSnapshotRecording(RecordSpecBuilder spec)

aMultipart

public static MultipartValuePatternBuilder aMultipart()

aMultipart

public static MultipartValuePatternBuilder aMultipart(String name)

startRecording

public static void startRecording(String targetBaseUrl)

startRecording

public static void startRecording()

startRecording

public static void startRecording(RecordSpecBuilder spec)

startStubRecording

public void startStubRecording(String targetBaseUrl)

startStubRecording

public void startStubRecording()

startStubRecording

public void startStubRecording(RecordSpecBuilder spec)

stopRecording

public static SnapshotRecordResult stopRecording()

stopStubRecording

public SnapshotRecordResult stopStubRecording()

getRecordingStatus

public static RecordingStatusResult getRecordingStatus()

getStubRecordingStatus

public RecordingStatusResult getStubRecordingStatus()

recordSpec

public static RecordSpecBuilder recordSpec()

findAllStubsByMetadata

public List<StubMapping> findAllStubsByMetadata(StringValuePattern pattern)

findStubsByMetadata

public static List<StubMapping> findStubsByMetadata(StringValuePattern pattern)

removeStubsByMetadataPattern

public void removeStubsByMetadataPattern(StringValuePattern pattern)

removeStubsByMetadata

public static void removeStubsByMetadata(StringValuePattern pattern)

importStubMappings

public void importStubMappings(StubImport stubImport)

importStubMappings

public void importStubMappings(StubImportBuilder stubImport)

importStubs

public static void importStubs(StubImportBuilder stubImport)

importStubs

public static void importStubs(StubImport stubImport)

removeStubMappings

public void removeStubMappings(List<StubMapping> stubs)

removeStubs

public static void removeStubs(List<StubMapping> stubs)

getGlobalSettings

public GlobalSettings getGlobalSettings()

getSettings

public static GlobalSettings getSettings()

message

public static MessageStubMapping.Builder message()

sendMessage

public static SendMessageActionBuilder sendMessage()

sendMessage

public static SendMessageActionBuilder sendMessage(String message)

messageStubFor

public static MessageStubMapping messageStubFor(MessageStubMappingBuilder builder)

registerMessageStub

public MessageStubMapping registerMessageStub(MessageStubMappingBuilder builder)

messageStubFor

public static MessageStubMapping messageStubFor(MessageStubMapping messageStubMapping)

registerMessageStub

public MessageStubMapping registerMessageStub(MessageStubMapping messageStubMapping)

removeMessageStub

public static void removeMessageStub(UUID id)

deleteMessageStub

public void deleteMessageStub(UUID id)

resetMessageStubs

public static void resetMessageStubs()

resetAllMessageStubs

public void resetAllMessageStubs()

findMessageStubsByMetadata

public static List<MessageStubMapping> findMessageStubsByMetadata(StringValuePattern pattern)

findAllMessageStubsByMetadata

public List<MessageStubMapping> findAllMessageStubsByMetadata(StringValuePattern pattern)

removeMessageStubsByMetadata

public static void removeMessageStubsByMetadata(StringValuePattern pattern)

removeAllMessageStubsByMetadata

public void removeAllMessageStubsByMetadata(StringValuePattern pattern)

listAllMessageStubMappings

public static ListMessageStubMappingsResult listAllMessageStubMappings()

allMessageStubMappings

public ListMessageStubMappingsResult allMessageStubMappings()

listAllMessageChannels

public static ListMessageChannelsResult listAllMessageChannels()

allMessageChannels

public ListMessageChannelsResult allMessageChannels()

getAllMessageServeEvents

public static List<MessageServeEvent> getAllMessageServeEvents()

getMessageServeEvents

public List<MessageServeEvent> getMessageServeEvents()

getMessageServeEvent

public static MessageServeEvent getMessageServeEvent(UUID id)

getMessageServeEventById

public MessageServeEvent getMessageServeEventById(UUID id)

removeMessageServeEvent

public static void removeMessageServeEvent(UUID eventId)

deleteMessageServeEvent

public void deleteMessageServeEvent(UUID eventId)

findAllMessageEvents

public static List<MessageServeEvent> findAllMessageEvents(MessagePattern pattern)

findMessageEvents

public List<MessageServeEvent> findMessageEvents(MessagePattern pattern)

verifyMessageEvent

public static void verifyMessageEvent(MessagePattern pattern)

verifyThatMessageEvent

public void verifyThatMessageEvent(MessagePattern pattern)

verifyMessageEvent

public static void verifyMessageEvent(int expectedCount,
 MessagePattern pattern)

verifyThatMessageEvent

public void verifyThatMessageEvent(int expectedCount,
 MessagePattern pattern)

verifyMessageEvent

public static void verifyMessageEvent(CountMatchingStrategy expectedCount,
 MessagePattern pattern)

verifyThatMessageEvent

public void verifyThatMessageEvent(CountMatchingStrategy expectedCount,
 MessagePattern pattern)

waitForMessageEvent

public static Optional<MessageServeEvent> waitForMessageEvent(MessagePattern pattern,
 Duration maxWait)

waitForMessage

public Optional<MessageServeEvent> waitForMessage(MessagePattern pattern,
 Duration maxWait)

waitForMessageEvents

public static List<MessageServeEvent> waitForMessageEvents(MessagePattern pattern,
 int count,
 Duration maxWait)

waitForMessages

public List<MessageServeEvent> waitForMessages(MessagePattern pattern,
 int count,
 Duration maxWait)

resetMessageJournal

public static void resetMessageJournal()

resetMessages

public void resetMessages()

removeMessageServeEventsMatching

public static FindMessageServeEventsResult removeMessageServeEventsMatching(MessagePattern pattern)

removeMessageEvents

public FindMessageServeEventsResult removeMessageEvents(MessagePattern pattern)

removeMessageServeEventsForStubsMatchingMetadata

public static FindMessageServeEventsResult removeMessageServeEventsForStubsMatchingMetadata(StringValuePattern pattern)

removeMessageEventsForStubsMatchingMetadata

public FindMessageServeEventsResult removeMessageEventsForStubsMatchingMetadata(StringValuePattern pattern)