com.github.tomakehurst.wiremock.client

Class WireMock

java.lang.Object

com.github.tomakehurst.wiremock.client.WireMock

public class WireMock
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WireMock()
WireMock(Admin admin)
WireMock(int port)
WireMock(java.lang.String host, int port)
WireMock(java.lang.String host, int port, java.lang.String urlPathPrefix)
WireMock(java.lang.String scheme, java.lang.String host, int port)
WireMock(java.lang.String scheme, java.lang.String host, int port, java.lang.String urlPathPrefix)
WireMock(java.lang.String scheme, java.lang.String host, int port, java.lang.String urlPathPrefix, java.lang.String hostHeader, java.lang.String proxyHost, int proxyPort, ClientAuthenticator authenticator)

Method Summary

Modifier and Type	Method and Description
static StringValuePattern	absent()
ListStubMappingsResult	allStubMappings()
static MultipartValuePatternBuilder	aMultipart()
static MultipartValuePatternBuilder	aMultipart(java.lang.String name)
static MappingBuilder	any(UrlPattern urlPattern)
static RequestPatternBuilder	anyRequestedFor(UrlPattern urlPattern)
static UrlPattern	anyUrl()
static ResponseDefinitionBuilder	aResponse()
static ResponseDefinitionBuilder	badRequest()
static ResponseDefinitionBuilder	badRequestEntity()
static BinaryEqualToPattern	binaryEqualTo(byte[] content)
static BinaryEqualToPattern	binaryEqualTo(java.lang.String content)
static void	configure()
static void	configureFor(int port)
static void	configureFor(java.lang.String host, int port)
static void	configureFor(java.lang.String host, int port, java.lang.String urlPathPrefix)
static void	configureFor(java.lang.String scheme, java.lang.String host, int port)
static void	configureFor(java.lang.String scheme, java.lang.String host, int port, java.lang.String urlPathPrefix)
static void	configureFor(java.lang.String scheme, java.lang.String host, int port, java.lang.String proxyHost, int proxyPort)
static void	configureFor(WireMock client)
static StringValuePattern	containing(java.lang.String value)
static WireMockBuilder	create()
static ResponseDefinitionBuilder	created()
static MappingBuilder	delete(java.lang.String url)
static MappingBuilder	delete(UrlPattern urlPattern)
static RequestPatternBuilder	deleteRequestedFor(UrlPattern urlPattern)
static void	editStub(MappingBuilder mappingBuilder)
void	editStubMapping(MappingBuilder mappingBuilder)
static StringValuePattern	equalTo(java.lang.String value)
static StringValuePattern	equalToIgnoreCase(java.lang.String value)
static StringValuePattern	equalToJson(java.lang.String value)
static StringValuePattern	equalToJson(java.lang.String value, boolean ignoreArrayOrder, boolean ignoreExtraElements)
static StringValuePattern	equalToXml(java.lang.String value)
static CountMatchingStrategy	exactly(int expected)
java.util.List<LoggedRequest>	find(RequestPatternBuilder requestPatternBuilder)
static java.util.List<LoggedRequest>	findAll(RequestPatternBuilder requestPatternBuilder)
java.util.List<NearMiss>	findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)
java.util.List<StubMapping>	findAllStubsByMetadata(StringValuePattern pattern)
java.util.List<LoggedRequest>	findAllUnmatchedRequests()
static java.util.List<NearMiss>	findNearMissesFor(LoggedRequest loggedRequest)
static java.util.List<NearMiss>	findNearMissesFor(RequestPatternBuilder requestPatternBuilder)
static java.util.List<NearMiss>	findNearMissesForAllUnmatched()
java.util.List<NearMiss>	findNearMissesForAllUnmatchedRequests()
static java.util.List<StubMapping>	findStubsByMetadata(StringValuePattern pattern)
java.util.List<NearMiss>	findTopNearMissesFor(LoggedRequest loggedRequest)
static java.util.List<LoggedRequest>	findUnmatchedRequests()
static ResponseDefinitionBuilder	forbidden()
static MappingBuilder	get(java.lang.String url)
static MappingBuilder	get(UrlPattern urlPattern)
static java.util.List<Scenario>	getAllScenarios()
static java.util.List<ServeEvent>	getAllServeEvents()
static RecordingStatusResult	getRecordingStatus()
static RequestPatternBuilder	getRequestedFor(UrlPattern urlPattern)
java.util.List<ServeEvent>	getServeEvents()
static StubMapping	getSingleStubMapping(java.util.UUID id)
SingleStubMappingResult	getStubMapping(java.util.UUID id)
RecordingStatusResult	getStubRecordingStatus()
static StubMapping	givenThat(MappingBuilder mappingBuilder)
static MappingBuilder	head(UrlPattern urlPattern)
static RequestPatternBuilder	headRequestedFor(UrlPattern urlPattern)
static CountMatchingStrategy	lessThan(int expected)
static CountMatchingStrategy	lessThanOrExactly(int expected)
static ListStubMappingsResult	listAllStubMappings()
void	loadMappingsFrom(java.io.File rootDir)
void	loadMappingsFrom(java.lang.String rootDir)
static StringValuePattern	matching(java.lang.String regex)
static StringValuePattern	matchingJsonPath(java.lang.String value)
static StringValuePattern	matchingJsonPath(java.lang.String value, StringValuePattern valuePattern)
static MatchesXPathPattern	matchingXPath(java.lang.String value)
static StringValuePattern	matchingXPath(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> namespaces)
static StringValuePattern	matchingXPath(java.lang.String value, StringValuePattern valuePattern)
static CountMatchingStrategy	moreThan(int expected)
static CountMatchingStrategy	moreThanOrExactly(int expected)
static ResponseDefinitionBuilder	noContent()
static ResponseDefinitionBuilder	notFound()
static StringValuePattern	notMatching(java.lang.String regex)
static ResponseDefinitionBuilder	ok()
static ResponseDefinitionBuilder	ok(java.lang.String body)
static ResponseDefinitionBuilder	okForContentType(java.lang.String contentType, java.lang.String body)
static ResponseDefinitionBuilder	okJson(java.lang.String body)
static ResponseDefinitionBuilder	okTextXml(java.lang.String body)
static ResponseDefinitionBuilder	okXml(java.lang.String body)
static MappingBuilder	options(UrlPattern urlPattern)
static RequestPatternBuilder	optionsRequestedFor(UrlPattern urlPattern)
static MappingBuilder	patch(UrlPattern urlPattern)
static RequestPatternBuilder	patchRequestedFor(UrlPattern urlPattern)
static ResponseDefinitionBuilder	permanentRedirect(java.lang.String location)
static MappingBuilder	post(java.lang.String url)
static MappingBuilder	post(UrlPattern urlPattern)
static RequestPatternBuilder	postRequestedFor(UrlPattern urlPattern)
static MappingBuilder	proxyAllTo(java.lang.String url)
static MappingBuilder	put(java.lang.String url)
static MappingBuilder	put(UrlPattern urlPattern)
static RequestPatternBuilder	putRequestedFor(UrlPattern urlPattern)
static RecordSpecBuilder	recordSpec()
StubMapping	register(MappingBuilder mappingBuilder)
void	register(StubMapping mapping)
static void	removeAllMappings()
void	removeMappings()
static void	removeStub(MappingBuilder mappingBuilder)
static void	removeStub(StubMapping stubMapping)
void	removeStubMapping(MappingBuilder mappingBuilder)
void	removeStubMapping(StubMapping stubMapping)
static void	removeStubsByMetadata(StringValuePattern pattern)
void	removeStubsByMetadataPattern(StringValuePattern pattern)
static MappingBuilder	request(java.lang.String method, UrlPattern urlPattern)
static RequestPatternBuilder	requestMadeFor(java.lang.String customMatcherName, Parameters parameters)
static RequestPatternBuilder	requestMadeFor(ValueMatcher<Request> requestMatcher)
static MappingBuilder	requestMatching(java.lang.String customRequestMatcherName)
static MappingBuilder	requestMatching(java.lang.String customRequestMatcherName, Parameters parameters)
static MappingBuilder	requestMatching(ValueMatcher<Request> requestMatcher)
static void	reset()
static void	resetAllRequests()
static void	resetAllScenarios()
void	resetMappings()
void	resetRequests()
void	resetScenarios()
static void	resetToDefault()
void	resetToDefaultMappings()
static void	saveAllMappings()
void	saveMappings()
static ResponseDefinitionBuilder	seeOther(java.lang.String location)
static ResponseDefinitionBuilder	serverError()
static ResponseDefinitionBuilder	serviceUnavailable()
static void	setGlobalFixedDelay(int milliseconds)
void	setGlobalFixedDelayVariable(int milliseconds)
static void	setGlobalRandomDelay(DelayDistribution distribution)
void	setGlobalRandomDelayVariable(DelayDistribution distribution)
void	shutdown()
static void	shutdownServer()
static java.util.List<StubMapping>	snapshotRecord()
static java.util.List<StubMapping>	snapshotRecord(RecordSpecBuilder spec)
static void	startRecording(RecordSpecBuilder spec)
static void	startRecording(java.lang.String targetBaseUrl)
void	startStubRecording(RecordSpecBuilder spec)
void	startStubRecording(java.lang.String targetBaseUrl)
static ResponseDefinitionBuilder	status(int status)
static SnapshotRecordResult	stopRecording()
SnapshotRecordResult	stopStubRecording()
static StubMapping	stubFor(MappingBuilder mappingBuilder)
java.util.List<StubMapping>	takeSnapshotRecording()
java.util.List<StubMapping>	takeSnapshotRecording(RecordSpecBuilder spec)
static ResponseDefinitionBuilder	temporaryRedirect(java.lang.String location)
static MappingBuilder	trace(UrlPattern urlPattern)
static RequestPatternBuilder	traceRequestedFor(UrlPattern urlPattern)
static ResponseDefinitionBuilder	unauthorized()
static UrlPattern	urlEqualTo(java.lang.String testUrl)
static UrlPattern	urlMatching(java.lang.String urlRegex)
static UrlPathPattern	urlPathEqualTo(java.lang.String testUrl)
static UrlPathPattern	urlPathMatching(java.lang.String urlRegex)
static void	verify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder)
static void	verify(int count, RequestPatternBuilder requestPatternBuilder)
static void	verify(RequestPatternBuilder requestPatternBuilder)
void	verifyThat(CountMatchingStrategy expectedCount, RequestPatternBuilder requestPatternBuilder)
void	verifyThat(int expectedCount, RequestPatternBuilder requestPatternBuilder)
void	verifyThat(RequestPatternBuilder requestPatternBuilder)

Methods inherited from class java.lang.Object

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

Constructor Detail

WireMock

public WireMock(Admin admin)

WireMock

public WireMock(int port)

WireMock

public WireMock(java.lang.String host,
                int port)

WireMock

public WireMock(java.lang.String host,
                int port,
                java.lang.String urlPathPrefix)

WireMock

public WireMock(java.lang.String scheme,
                java.lang.String host,
                int port)

WireMock

public WireMock(java.lang.String scheme,
                java.lang.String host,
                int port,
                java.lang.String urlPathPrefix)

WireMock

public WireMock(java.lang.String scheme,
                java.lang.String host,
                int port,
                java.lang.String urlPathPrefix,
                java.lang.String hostHeader,
                java.lang.String proxyHost,
                int proxyPort,
                ClientAuthenticator authenticator)

WireMock

public WireMock()

Method Detail

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)

listAllStubMappings

public static ListStubMappingsResult listAllStubMappings()

getSingleStubMapping

public static StubMapping getSingleStubMapping(java.util.UUID id)

configureFor

public static void configureFor(int port)

configureFor

public static void configureFor(java.lang.String host,
                                int port)

configureFor

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

configureFor

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

configureFor

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

configureFor

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

configureFor

public static void configureFor(WireMock client)

configure

public static void configure()

equalTo

public static StringValuePattern equalTo(java.lang.String value)

binaryEqualTo

public static BinaryEqualToPattern binaryEqualTo(byte[] content)

binaryEqualTo

public static BinaryEqualToPattern binaryEqualTo(java.lang.String content)

equalToIgnoreCase

public static StringValuePattern equalToIgnoreCase(java.lang.String value)

equalToJson

public static StringValuePattern equalToJson(java.lang.String value)

equalToJson

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

matchingJsonPath

public static StringValuePattern matchingJsonPath(java.lang.String value)

matchingJsonPath

public static StringValuePattern matchingJsonPath(java.lang.String value,
                                                  StringValuePattern valuePattern)

equalToXml

public static StringValuePattern equalToXml(java.lang.String value)

matchingXPath

public static MatchesXPathPattern matchingXPath(java.lang.String value)

matchingXPath

public static StringValuePattern matchingXPath(java.lang.String value,
                                               java.util.Map<java.lang.String,java.lang.String> namespaces)

matchingXPath

public static StringValuePattern matchingXPath(java.lang.String value,
                                               StringValuePattern valuePattern)

containing

public static StringValuePattern containing(java.lang.String value)

matching

public static StringValuePattern matching(java.lang.String regex)

notMatching

public static StringValuePattern notMatching(java.lang.String regex)

absent

public static StringValuePattern absent()

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()

getAllScenarios

public static java.util.List<Scenario> getAllScenarios()

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)

allStubMappings

public ListStubMappingsResult allStubMappings()

getStubMapping

public SingleStubMappingResult getStubMapping(java.util.UUID id)

urlEqualTo

public static UrlPattern urlEqualTo(java.lang.String testUrl)

urlMatching

public static UrlPattern urlMatching(java.lang.String urlRegex)

urlPathEqualTo

public static UrlPathPattern urlPathEqualTo(java.lang.String testUrl)

urlPathMatching

public static UrlPathPattern urlPathMatching(java.lang.String urlRegex)

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)

request

public static MappingBuilder request(java.lang.String method,
                                     UrlPattern urlPattern)

requestMatching

public static MappingBuilder requestMatching(java.lang.String customRequestMatcherName)

requestMatching

public static MappingBuilder requestMatching(java.lang.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(java.lang.String body)

okForContentType

public static ResponseDefinitionBuilder okForContentType(java.lang.String contentType,
                                                         java.lang.String body)

okJson

public static ResponseDefinitionBuilder okJson(java.lang.String body)

okXml

public static ResponseDefinitionBuilder okXml(java.lang.String body)

okTextXml

public static ResponseDefinitionBuilder okTextXml(java.lang.String body)

proxyAllTo

public static MappingBuilder proxyAllTo(java.lang.String url)

get

public static MappingBuilder get(java.lang.String url)

post

public static MappingBuilder post(java.lang.String url)

put

public static MappingBuilder put(java.lang.String url)

delete

public static MappingBuilder delete(java.lang.String url)

created

public static ResponseDefinitionBuilder created()

noContent

public static ResponseDefinitionBuilder noContent()

permanentRedirect

public static ResponseDefinitionBuilder permanentRedirect(java.lang.String location)

temporaryRedirect

public static ResponseDefinitionBuilder temporaryRedirect(java.lang.String location)

seeOther

public static ResponseDefinitionBuilder seeOther(java.lang.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 java.util.List<LoggedRequest> find(RequestPatternBuilder requestPatternBuilder)

findAll

public static java.util.List<LoggedRequest> findAll(RequestPatternBuilder requestPatternBuilder)

getAllServeEvents

public static java.util.List<ServeEvent> getAllServeEvents()

getServeEvents

public java.util.List<ServeEvent> getServeEvents()

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)

requestMadeFor

public static RequestPatternBuilder requestMadeFor(java.lang.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)

shutdown

public void shutdown()

shutdownServer

public static void shutdownServer()

findNearMissesForAllUnmatched

public static java.util.List<NearMiss> findNearMissesForAllUnmatched()

findNearMissesForAllUnmatchedRequests

public java.util.List<NearMiss> findNearMissesForAllUnmatchedRequests()

findUnmatchedRequests

public static java.util.List<LoggedRequest> findUnmatchedRequests()

findAllUnmatchedRequests

public java.util.List<LoggedRequest> findAllUnmatchedRequests()

findNearMissesFor

public static java.util.List<NearMiss> findNearMissesFor(LoggedRequest loggedRequest)

findTopNearMissesFor

public java.util.List<NearMiss> findTopNearMissesFor(LoggedRequest loggedRequest)

findNearMissesFor

public static java.util.List<NearMiss> findNearMissesFor(RequestPatternBuilder requestPatternBuilder)

findAllNearMissesFor

public java.util.List<NearMiss> findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)

loadMappingsFrom

public void loadMappingsFrom(java.lang.String rootDir)

loadMappingsFrom

public void loadMappingsFrom(java.io.File rootDir)

snapshotRecord

public static java.util.List<StubMapping> snapshotRecord()

snapshotRecord

public static java.util.List<StubMapping> snapshotRecord(RecordSpecBuilder spec)

takeSnapshotRecording

public java.util.List<StubMapping> takeSnapshotRecording()

takeSnapshotRecording

public java.util.List<StubMapping> takeSnapshotRecording(RecordSpecBuilder spec)

aMultipart

public static MultipartValuePatternBuilder aMultipart()

aMultipart

public static MultipartValuePatternBuilder aMultipart(java.lang.String name)

startRecording

public static void startRecording(java.lang.String targetBaseUrl)

startRecording

public static void startRecording(RecordSpecBuilder spec)

startStubRecording

public void startStubRecording(java.lang.String targetBaseUrl)

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 java.util.List<StubMapping> findAllStubsByMetadata(StringValuePattern pattern)

findStubsByMetadata

public static java.util.List<StubMapping> findStubsByMetadata(StringValuePattern pattern)

removeStubsByMetadataPattern

public void removeStubsByMetadataPattern(StringValuePattern pattern)

removeStubsByMetadata

public static void removeStubsByMetadata(StringValuePattern pattern)