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
ListStubMappingsResult	allStubMappings()
static RemoteMappingBuilder	any(UrlMatchingStrategy urlMatchingStrategy)
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 ValueMatchingStrategy	containing(java.lang.String value)
static RemoteMappingBuilder	delete(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	deleteRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static void	editStub(com.github.tomakehurst.wiremock.client.MappingBuilder mappingBuilder)
void	editStubMapping(RemoteMappingBuilder mappingBuilder)
static ValueMatchingStrategy	equalTo(java.lang.String value)
static ValueMatchingStrategy	equalToJson(java.lang.String value)
static ValueMatchingStrategy	equalToJson(java.lang.String value, org.skyscreamer.jsonassert.JSONCompareMode jsonCompareMode)
static ValueMatchingStrategy	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)
static RemoteMappingBuilder	get(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	getRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static void	givenThat(RemoteMappingBuilder mappingBuilder)
static RemoteMappingBuilder	head(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	headRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static CountMatchingStrategy	lessThan(int expected)
static CountMatchingStrategy	lessThanOrExactly(int expected)
static ListStubMappingsResult	listAllStubMappings()
static ValueMatchingStrategy	matching(java.lang.String value)
static ValueMatchingStrategy	matchingJsonPath(java.lang.String jsonPath)
static ValueMatchingStrategy	matchingXPath(java.lang.String value)
static CountMatchingStrategy	moreThan(int expected)
static CountMatchingStrategy	moreThanOrExactly(int expected)
static ValueMatchingStrategy	notMatching(java.lang.String value)
static RemoteMappingBuilder	options(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	optionsRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static RemoteMappingBuilder	patch(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	patchRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static RemoteMappingBuilder	post(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	postRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static RemoteMappingBuilder	put(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	putRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
void	register(RemoteMappingBuilder mappingBuilder)
void	register(StubMapping mapping)
static RemoteMappingBuilder	request(java.lang.String method, UrlMatchingStrategy urlMatchingStrategy)
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(UrlMatchingStrategy urlMatchingStrategy)
static RequestPatternBuilder	traceRequestedFor(UrlMatchingStrategy urlMatchingStrategy)
static UrlMatchingStrategy	urlEqualTo(java.lang.String url)
static UrlMatchingStrategy	urlMatching(java.lang.String url)
static UrlMatchingStrategy	urlPathEqualTo(java.lang.String urlPath)
static UrlMatchingStrategy	urlPathMatching(java.lang.String urlPath)
static void	verify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder)
static void	verify(int count, RequestPatternBuilder requestPatternBuilder)
static void	verify(RequestPatternBuilder requestPatternBuilder)
void	verifyThat(CountMatchingStrategy count, RequestPatternBuilder requestPatternBuilder)
void	verifyThat(int count, 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)

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

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)

allStubMappings

public ListStubMappingsResult allStubMappings()

urlEqualTo

public static UrlMatchingStrategy urlEqualTo(java.lang.String url)

urlMatching

public static UrlMatchingStrategy urlMatching(java.lang.String url)

urlPathEqualTo

public static UrlMatchingStrategy urlPathEqualTo(java.lang.String urlPath)

urlPathMatching

public static UrlMatchingStrategy urlPathMatching(java.lang.String urlPath)

equalTo

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

equalToJson

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

equalToJson

public static ValueMatchingStrategy equalToJson(java.lang.String value,
                                org.skyscreamer.jsonassert.JSONCompareMode jsonCompareMode)

equalToXml

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

matchingXPath

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

containing

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

matching

public static ValueMatchingStrategy matching(java.lang.String value)

notMatching

public static ValueMatchingStrategy notMatching(java.lang.String value)

matchingJsonPath

public static ValueMatchingStrategy matchingJsonPath(java.lang.String jsonPath)

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

post

public static RemoteMappingBuilder post(UrlMatchingStrategy urlMatchingStrategy)

put

public static RemoteMappingBuilder put(UrlMatchingStrategy urlMatchingStrategy)

delete

public static RemoteMappingBuilder delete(UrlMatchingStrategy urlMatchingStrategy)

patch

public static RemoteMappingBuilder patch(UrlMatchingStrategy urlMatchingStrategy)

head

public static RemoteMappingBuilder head(UrlMatchingStrategy urlMatchingStrategy)

options

public static RemoteMappingBuilder options(UrlMatchingStrategy urlMatchingStrategy)

trace

public static RemoteMappingBuilder trace(UrlMatchingStrategy urlMatchingStrategy)

any

public static RemoteMappingBuilder any(UrlMatchingStrategy urlMatchingStrategy)

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)

request

public static RemoteMappingBuilder request(java.lang.String method,
                           UrlMatchingStrategy urlMatchingStrategy)

aResponse

public static ResponseDefinitionBuilder aResponse()

verifyThat

public void verifyThat(RequestPatternBuilder requestPatternBuilder)

verifyThat

public void verifyThat(int count,
              RequestPatternBuilder requestPatternBuilder)

verifyThat

public void verifyThat(CountMatchingStrategy count,
              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(UrlMatchingStrategy urlMatchingStrategy)

postRequestedFor

public static RequestPatternBuilder postRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

putRequestedFor

public static RequestPatternBuilder putRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

deleteRequestedFor

public static RequestPatternBuilder deleteRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

patchRequestedFor

public static RequestPatternBuilder patchRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

headRequestedFor

public static RequestPatternBuilder headRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

optionsRequestedFor

public static RequestPatternBuilder optionsRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

traceRequestedFor

public static RequestPatternBuilder traceRequestedFor(UrlMatchingStrategy urlMatchingStrategy)

requestMadeFor

public static LocalRequestPatternBuilder requestMadeFor(RequestMatcher requestMatcher)

requestMadeFor

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

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