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)

Method Summary

Methods

Modifier and Type	Method and Description
static StringValuePattern	absent()
ListStubMappingsResult	allStubMappings()
static RemoteMappingBuilder	any(UrlPattern urlPattern)
static UrlPattern	anyUrl()
static ResponseDefinitionBuilder	aResponse()
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 StringValuePattern	containing(java.lang.String value)
static RemoteMappingBuilder	delete(UrlPattern urlPattern)
static RequestPatternBuilder	deleteRequestedFor(UrlPattern urlPattern)
static void	editStub(com.github.tomakehurst.wiremock.client.MappingBuilder mappingBuilder)
void	editStubMapping(RemoteMappingBuilder mappingBuilder)
static StringValuePattern	equalTo(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<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()
java.util.List<NearMiss>	findTopNearMissesFor(LoggedRequest loggedRequest)
static java.util.List<LoggedRequest>	findUnmatchedRequests()
static RemoteMappingBuilder	get(UrlPattern urlPattern)
static RequestPatternBuilder	getRequestedFor(UrlPattern urlPattern)
static void	givenThat(RemoteMappingBuilder mappingBuilder)
static RemoteMappingBuilder	head(UrlPattern urlPattern)
static RequestPatternBuilder	headRequestedFor(UrlPattern urlPattern)
static CountMatchingStrategy	lessThan(int expected)
static CountMatchingStrategy	lessThanOrExactly(int expected)
static ListStubMappingsResult	listAllStubMappings()
static StringValuePattern	matching(java.lang.String regex)
static StringValuePattern	matchingJsonPath(java.lang.String value)
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 CountMatchingStrategy	moreThan(int expected)
static CountMatchingStrategy	moreThanOrExactly(int expected)
static StringValuePattern	notMatching(java.lang.String regex)
static RemoteMappingBuilder	options(UrlPattern urlPattern)
static RequestPatternBuilder	optionsRequestedFor(UrlPattern urlPattern)
static RemoteMappingBuilder	patch(UrlPattern urlPattern)
static RequestPatternBuilder	patchRequestedFor(UrlPattern urlPattern)
static RemoteMappingBuilder	post(UrlPattern urlPattern)
static RequestPatternBuilder	postRequestedFor(UrlPattern urlPattern)
static RemoteMappingBuilder	put(UrlPattern urlPattern)
static RequestPatternBuilder	putRequestedFor(UrlPattern urlPattern)
void	register(RemoteMappingBuilder mappingBuilder)
void	register(StubMapping mapping)
static void	removeStub(RemoteMappingBuilder mappingBuilder)
void	removeStubMapping(RemoteMappingBuilder mappingBuilder)
static RemoteMappingBuilder	request(java.lang.String method, UrlPattern urlPattern)
static LocalRequestPatternBuilder	requestMadeFor(RequestMatcher requestMatcher)
static RequestPatternBuilder	requestMadeFor(java.lang.String customMatcherName, Parameters parameters)
static LocalMappingBuilder	requestMatching(RequestMatcher requestMatcher)
static com.github.tomakehurst.wiremock.client.MappingBuilder	requestMatching(java.lang.String customRequestMatcherName)
static RemoteMappingBuilder	requestMatching(java.lang.String customRequestMatcherName, Parameters parameters)
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 void	setGlobalFixedDelay(int milliseconds)
void	setGlobalFixedDelayVariable(int milliseconds)
static void	setGlobalRandomDelay(DelayDistribution distribution)
void	setGlobalRandomDelayVariable(DelayDistribution distribution)
void	shutdown()
static void	shutdownServer()
static void	stubFor(RemoteMappingBuilder mappingBuilder)
static RemoteMappingBuilder	trace(UrlPattern urlPattern)
static RequestPatternBuilder	traceRequestedFor(UrlPattern urlPattern)
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()

Method Detail

givenThat

public static void givenThat(RemoteMappingBuilder mappingBuilder)

stubFor

public static void stubFor(RemoteMappingBuilder mappingBuilder)

editStub

public static void editStub(com.github.tomakehurst.wiremock.client.MappingBuilder mappingBuilder)

removeStub

public static void removeStub(RemoteMappingBuilder mappingBuilder)

listAllStubMappings

public static ListStubMappingsResult listAllStubMappings()

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)

configure

public static void configure()

equalTo

public static StringValuePattern equalTo(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)

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)

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

resetMappings

public void resetMappings()

reset

public static void reset()

resetAllRequests

public static void resetAllRequests()

resetRequests

public void resetRequests()

resetScenarios

public void resetScenarios()

resetAllScenarios

public static void resetAllScenarios()

resetToDefaultMappings

public void resetToDefaultMappings()

resetToDefault

public static void resetToDefault()

register

public void register(RemoteMappingBuilder mappingBuilder)

register

public void register(StubMapping mapping)

editStubMapping

public void editStubMapping(RemoteMappingBuilder mappingBuilder)

removeStubMapping

public void removeStubMapping(RemoteMappingBuilder mappingBuilder)

allStubMappings

public ListStubMappingsResult allStubMappings()

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 RemoteMappingBuilder get(UrlPattern urlPattern)

post

public static RemoteMappingBuilder post(UrlPattern urlPattern)

put

public static RemoteMappingBuilder put(UrlPattern urlPattern)

delete

public static RemoteMappingBuilder delete(UrlPattern urlPattern)

patch

public static RemoteMappingBuilder patch(UrlPattern urlPattern)

head

public static RemoteMappingBuilder head(UrlPattern urlPattern)

options

public static RemoteMappingBuilder options(UrlPattern urlPattern)

trace

public static RemoteMappingBuilder trace(UrlPattern urlPattern)

any

public static RemoteMappingBuilder any(UrlPattern urlPattern)

request

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

requestMatching

public static com.github.tomakehurst.wiremock.client.MappingBuilder requestMatching(java.lang.String customRequestMatcherName)

requestMatching

public static RemoteMappingBuilder requestMatching(java.lang.String customRequestMatcherName,
                                   Parameters parameters)

requestMatching

public static LocalMappingBuilder requestMatching(RequestMatcher requestMatcher)

aResponse

public static ResponseDefinitionBuilder aResponse()

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)

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)

requestMadeFor

public static RequestPatternBuilder requestMadeFor(java.lang.String customMatcherName,
                                   Parameters parameters)

requestMadeFor

public static LocalRequestPatternBuilder requestMadeFor(RequestMatcher 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)