Package com.github.tomakehurst.wiremock

Class WireMockServer

java.lang.Object

com.github.tomakehurst.wiremock.WireMockServer

All Implemented Interfaces:

Admin, Container, Stubbing

Direct Known Subclasses:

WireMockClassRule, WireMockRule

public class WireMockServer
extends Object
implements Container, Stubbing, Admin

Field Summary

Fields

Modifier and Type	Field	Description
protected final WireMock	client
protected final Options	options

Constructor Summary

Constructors

Constructor	Description
WireMockServer()
WireMockServer(int port)
WireMockServer(int port, FileSource fileSource, boolean enableBrowserProxying)
WireMockServer(int port, FileSource fileSource, boolean enableBrowserProxying, ProxySettings proxySettings)
WireMockServer(int port, Integer httpsPort)
WireMockServer(int port, Integer httpsPort, FileSource fileSource, boolean enableBrowserProxying, ProxySettings proxySettings, Notifier notifier)
WireMockServer(Options options)
WireMockServer(String filenameTemplate)

Method Summary

Modifier and Type	Method	Description
void	addMockServiceRequestListener(RequestListener listener)
void	addStubMapping(StubMapping stubMapping)
String	baseUrl()
void	checkForUnmatchedRequests()
VerificationResult	countRequestsMatching(RequestPattern requestPattern)
void	editStub(MappingBuilder mappingBuilder)
void	editStubMapping(StubMapping stubMapping)
void	enableRecordMappings(FileSource mappingsFileSource, FileSource filesFileSource)
List<LoggedRequest>	findAll(RequestPatternBuilder requestPatternBuilder)
List<NearMiss>	findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)
ListStubMappingsResult	findAllStubsByMetadata(StringValuePattern pattern)
List<LoggedRequest>	findAllUnmatchedRequests()
List<NearMiss>	findNearMissesFor(LoggedRequest loggedRequest)
List<NearMiss>	findNearMissesForAllUnmatchedRequests()
FindNearMissesResult	findNearMissesForUnmatchedRequests()
FindRequestsResult	findRequestsMatching(RequestPattern requestPattern)
List<StubMapping>	findStubMappingsByMetadata(StringValuePattern pattern)
FindNearMissesResult	findTopNearMissesFor(RequestPattern requestPattern)
FindNearMissesResult	findTopNearMissesFor(LoggedRequest loggedRequest)
FindRequestsResult	findUnmatchedRequests()
ListStubMappingsResult	findUnmatchedStubs()
GetScenariosResult	getAllScenarios()
List<ServeEvent>	getAllServeEvents()
GetGlobalSettingsResult	getGlobalSettings()
Set<String>	getLoadedExtensionNames()
Options	getOptions()
RecordingStatusResult	getRecordingStatus()
SingleServedStubResult	getServedStub(UUID id)
GetServeEventsResult	getServeEvents()
GetServeEventsResult	getServeEvents(ServeEventQuery query)
StubMapping	getSingleStubMapping(UUID id)
SingleStubMappingResult	getStubMapping(UUID id)
List<StubMapping>	getStubMappings()
StubMapping	givenThat(MappingBuilder mappingBuilder)
int	httpsPort()
void	importStubs(StubImport stubImport)
boolean	isHttpEnabled()
boolean	isHttpsEnabled()
boolean	isRunning()
ListStubMappingsResult	listAllStubMappings()
void	loadMappingsUsing(MappingsLoader mappingsLoader)
int	port()
void	removeServeEvent(UUID eventId)
FindServeEventsResult	removeServeEventsForStubsMatchingMetadata(StringValuePattern metadataPattern)
FindServeEventsResult	removeServeEventsMatching(RequestPattern requestPattern)
void	removeStub(MappingBuilder mappingBuilder)
void	removeStub(StubMapping stubMapping)
void	removeStub(UUID id)
void	removeStubMapping(StubMapping stubMapping)
void	removeStubMapping(UUID id)
void	removeStubMappingsByMetadata(StringValuePattern pattern)
void	removeStubsByMetadata(StringValuePattern pattern)
void	resetAll()
void	resetMappings()
void	resetRequests()
void	resetScenario(String name)
void	resetScenarios()
void	resetToDefaultMappings()
void	saveMappings()
void	setGlobalFixedDelay(int milliseconds)
void	setScenarioState(String name, String state)
void	shutdown()	Gracefully shutdown the server.
void	shutdownServer()
SnapshotRecordResult	snapshotRecord()
SnapshotRecordResult	snapshotRecord(RecordSpec spec)
SnapshotRecordResult	snapshotRecord(RecordSpecBuilder spec)
void	start()
void	startRecording(RecordSpec spec)
void	startRecording(RecordSpecBuilder recordSpec)
void	startRecording(String targetBaseUrl)
void	stop()
SnapshotRecordResult	stopRecording()
StubMapping	stubFor(MappingBuilder mappingBuilder)
void	updateGlobalSettings(GlobalSettings newSettings)
String	url(String path)
void	verify(int count, RequestPatternBuilder requestPatternBuilder)
void	verify(CountMatchingStrategy countMatchingStrategy, RequestPatternBuilder requestPatternBuilder)
void	verify(RequestPatternBuilder requestPatternBuilder)

Methods inherited from class java.lang.Object

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

Field Details

options

protected final Options options

client

protected final WireMock client

Constructor Details

WireMockServer

public WireMockServer(Options options)

WireMockServer

public WireMockServer(int port,
 Integer httpsPort,
 FileSource fileSource,
 boolean enableBrowserProxying,
 ProxySettings proxySettings,
 Notifier notifier)

WireMockServer

public WireMockServer(int port,
 FileSource fileSource,
 boolean enableBrowserProxying,
 ProxySettings proxySettings)

WireMockServer

public WireMockServer(int port,
 FileSource fileSource,
 boolean enableBrowserProxying)

WireMockServer

public WireMockServer(int port)

WireMockServer

public WireMockServer(int port,
 Integer httpsPort)

WireMockServer

public WireMockServer()

WireMockServer

public WireMockServer(String filenameTemplate)

Method Details

loadMappingsUsing

public void loadMappingsUsing(MappingsLoader mappingsLoader)

addMockServiceRequestListener

public void addMockServiceRequestListener(RequestListener listener)

enableRecordMappings

public void enableRecordMappings(FileSource mappingsFileSource,
 FileSource filesFileSource)

stop

public void stop()

start

public void start()

shutdown

public void shutdown()

Gracefully shutdown the server.

This method assumes it is being called as the result of an incoming HTTP request.

Specified by:

shutdown in interface Container

isHttpEnabled

public boolean isHttpEnabled()

isHttpsEnabled

public boolean isHttpsEnabled()

port

public int port()

Specified by:

port in interface Container

httpsPort

public int httpsPort()

url

public String url(String path)

baseUrl

public String baseUrl()

isRunning

public boolean isRunning()

givenThat

public StubMapping givenThat(MappingBuilder mappingBuilder)

Specified by:

givenThat in interface Stubbing

stubFor

public StubMapping stubFor(MappingBuilder mappingBuilder)

Specified by:

stubFor in interface Stubbing

editStub

public void editStub(MappingBuilder mappingBuilder)

Specified by:

editStub in interface Stubbing

removeStub

public void removeStub(MappingBuilder mappingBuilder)

Specified by:

removeStub in interface Stubbing

removeStub

public void removeStub(StubMapping stubMapping)

Specified by:

removeStub in interface Stubbing

removeStub

public void removeStub(UUID id)

Specified by:

removeStub in interface Stubbing

getStubMappings

public List<StubMapping> getStubMappings()

Specified by:

getStubMappings in interface Stubbing

getSingleStubMapping

public StubMapping getSingleStubMapping(UUID id)

Specified by:

getSingleStubMapping in interface Stubbing

findStubMappingsByMetadata

public List<StubMapping> findStubMappingsByMetadata(StringValuePattern pattern)

Specified by:

findStubMappingsByMetadata in interface Stubbing

removeStubMappingsByMetadata

public void removeStubMappingsByMetadata(StringValuePattern pattern)

Specified by:

removeStubMappingsByMetadata in interface Stubbing

removeStubMapping

public void removeStubMapping(StubMapping stubMapping)

Specified by:

removeStubMapping in interface Admin

removeStubMapping

public void removeStubMapping(UUID id)

Specified by:

removeStubMapping in interface Admin

verify

public void verify(RequestPatternBuilder requestPatternBuilder)

Specified by:

verify in interface Stubbing

verify

public void verify(int count,
 RequestPatternBuilder requestPatternBuilder)

Specified by:

verify in interface Stubbing

verify

public void verify(CountMatchingStrategy countMatchingStrategy,
 RequestPatternBuilder requestPatternBuilder)

Specified by:

verify in interface Stubbing

findAll

public List<LoggedRequest> findAll(RequestPatternBuilder requestPatternBuilder)

Specified by:

findAll in interface Stubbing

getAllServeEvents

public List<ServeEvent> getAllServeEvents()

Specified by:

getAllServeEvents in interface Stubbing

setGlobalFixedDelay

public void setGlobalFixedDelay(int milliseconds)

Specified by:

setGlobalFixedDelay in interface Stubbing

findAllUnmatchedRequests

public List<LoggedRequest> findAllUnmatchedRequests()

Specified by:

findAllUnmatchedRequests in interface Stubbing

findNearMissesForAllUnmatchedRequests

public List<NearMiss> findNearMissesForAllUnmatchedRequests()

Specified by:

findNearMissesForAllUnmatchedRequests in interface Stubbing

findAllNearMissesFor

public List<NearMiss> findAllNearMissesFor(RequestPatternBuilder requestPatternBuilder)

Specified by:

findAllNearMissesFor in interface Stubbing

findNearMissesFor

public List<NearMiss> findNearMissesFor(LoggedRequest loggedRequest)

Specified by:

findNearMissesFor in interface Stubbing

addStubMapping

public void addStubMapping(StubMapping stubMapping)

Specified by:

addStubMapping in interface Admin

editStubMapping

public void editStubMapping(StubMapping stubMapping)

Specified by:

editStubMapping in interface Admin

listAllStubMappings

public ListStubMappingsResult listAllStubMappings()

Specified by:

listAllStubMappings in interface Admin

getStubMapping

public SingleStubMappingResult getStubMapping(UUID id)

Specified by:

getStubMapping in interface Admin

saveMappings

public void saveMappings()

Specified by:

saveMappings in interface Admin

resetAll

public void resetAll()

Specified by:

resetAll in interface Admin

resetRequests

public void resetRequests()

Specified by:

resetRequests in interface Admin

resetToDefaultMappings

public void resetToDefaultMappings()

Specified by:

resetToDefaultMappings in interface Admin

getServeEvents

public GetServeEventsResult getServeEvents()

Specified by:

getServeEvents in interface Admin

getServeEvents

public GetServeEventsResult getServeEvents(ServeEventQuery query)

Specified by:

getServeEvents in interface Admin

getServedStub

public SingleServedStubResult getServedStub(UUID id)

Specified by:

getServedStub in interface Admin

resetScenarios

public void resetScenarios()

Specified by:

resetScenarios in interface Admin

resetMappings

public void resetMappings()

Specified by:

resetMappings in interface Admin

countRequestsMatching

public VerificationResult countRequestsMatching(RequestPattern requestPattern)

Specified by:

countRequestsMatching in interface Admin

findRequestsMatching

public FindRequestsResult findRequestsMatching(RequestPattern requestPattern)

Specified by:

findRequestsMatching in interface Admin

findUnmatchedRequests

public FindRequestsResult findUnmatchedRequests()

Specified by:

findUnmatchedRequests in interface Admin

removeServeEvent

public void removeServeEvent(UUID eventId)

Specified by:

removeServeEvent in interface Admin

removeServeEventsMatching

public FindServeEventsResult removeServeEventsMatching(RequestPattern requestPattern)

Specified by:

removeServeEventsMatching in interface Admin

removeServeEventsForStubsMatchingMetadata

public FindServeEventsResult removeServeEventsForStubsMatchingMetadata(StringValuePattern metadataPattern)

Specified by:

removeServeEventsForStubsMatchingMetadata in interface Admin

updateGlobalSettings

public void updateGlobalSettings(GlobalSettings newSettings)

Specified by:

updateGlobalSettings in interface Admin

findNearMissesForUnmatchedRequests

public FindNearMissesResult findNearMissesForUnmatchedRequests()

Specified by:

findNearMissesForUnmatchedRequests in interface Admin

getAllScenarios

public GetScenariosResult getAllScenarios()

Specified by:

getAllScenarios in interface Admin

resetScenario

public void resetScenario(String name)

Specified by:

resetScenario in interface Admin

setScenarioState

public void setScenarioState(String name,
 String state)

Specified by:

setScenarioState in interface Admin

findTopNearMissesFor

public FindNearMissesResult findTopNearMissesFor(LoggedRequest loggedRequest)

Specified by:

findTopNearMissesFor in interface Admin

findTopNearMissesFor

public FindNearMissesResult findTopNearMissesFor(RequestPattern requestPattern)

Specified by:

findTopNearMissesFor in interface Admin

startRecording

public void startRecording(String targetBaseUrl)

Specified by:

startRecording in interface Admin

startRecording

public void startRecording(RecordSpec spec)

Specified by:

startRecording in interface Admin

startRecording

public void startRecording(RecordSpecBuilder recordSpec)

Specified by:

startRecording in interface Admin

stopRecording

public SnapshotRecordResult stopRecording()

Specified by:

stopRecording in interface Admin

getRecordingStatus

public RecordingStatusResult getRecordingStatus()

Specified by:

getRecordingStatus in interface Admin

snapshotRecord

public SnapshotRecordResult snapshotRecord()

Specified by:

snapshotRecord in interface Admin

snapshotRecord

public SnapshotRecordResult snapshotRecord(RecordSpecBuilder spec)

Specified by:

snapshotRecord in interface Admin

snapshotRecord

public SnapshotRecordResult snapshotRecord(RecordSpec spec)

Specified by:

snapshotRecord in interface Admin

getOptions

public Options getOptions()

Specified by:

getOptions in interface Admin

shutdownServer

public void shutdownServer()

Specified by:

shutdownServer in interface Admin

findUnmatchedStubs

public ListStubMappingsResult findUnmatchedStubs()

Specified by:

findUnmatchedStubs in interface Admin

findAllStubsByMetadata

public ListStubMappingsResult findAllStubsByMetadata(StringValuePattern pattern)

Specified by:

findAllStubsByMetadata in interface Admin

removeStubsByMetadata

public void removeStubsByMetadata(StringValuePattern pattern)

Specified by:

removeStubsByMetadata in interface Admin

importStubs

public void importStubs(StubImport stubImport)

Specified by:

importStubs in interface Admin

getGlobalSettings

public GetGlobalSettingsResult getGlobalSettings()

Specified by:

getGlobalSettings in interface Admin

checkForUnmatchedRequests

public void checkForUnmatchedRequests()

getLoadedExtensionNames

public Set<String> getLoadedExtensionNames()