Package com.github.tomakehurst.wiremock.core

Class WireMockApp

java.lang.Object

com.github.tomakehurst.wiremock.core.WireMockApp

All Implemented Interfaces:

Admin, StubServer

public class WireMockApp
extends Object
implements StubServer, Admin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_CONTEXT_ROOT
static final org.wiremock.url.Segment	ADMIN_CONTEXT_ROOT_SEGMENT
static final String	FILES_ROOT
static final String	MAPPINGS_ROOT
static final String	MESSAGE_MAPPINGS_ROOT

Constructor Summary

Constructors

Constructor	Description
WireMockApp(boolean browserProxyingEnabled, MappingsLoader defaultMappingsLoader, Map<String,MappingsLoaderExtension> mappingsLoaderExtensions, MappingsSaver mappingsSaver, boolean requestJournalDisabled, Integer maxRequestJournalEntries, Map<String,ResponseDefinitionTransformer> transformers, Map<String,ResponseDefinitionTransformerV2> v2transformers, Map<String,RequestMatcherExtension> requestMatchers, FileSource rootFileSource, Container container)
WireMockApp(Options options, Container container)

Method Summary

Modifier and Type	Method	Description
void	addMessageStubMapping(MessageStubMapping messageStubMapping)	Adds a message stub mapping that will be matched against incoming messages on channels.
void	addStubMapping(StubMapping stubMapping)
AdminRequestHandler	buildAdminRequestHandler()
MessageStubRequestHandler	buildMessageStubRequestHandler()
StubRequestHandler	buildStubRequestHandler()
int	countMessageEventsMatching(MessagePattern pattern)	Counts message events matching the given pattern.
VerificationResult	countRequestsMatching(RequestPattern requestPattern)
void	editStubMapping(StubMapping stubMapping)
ListMessageStubMappingsResult	findAllMessageStubsByMetadata(StringValuePattern pattern)	Finds all message stub mappings matching the given metadata pattern.
ListStubMappingsResult	findAllStubsByMetadata(StringValuePattern pattern)
List<MessageServeEvent>	findMessageEventsMatching(MessagePattern pattern)	Gets message events matching the given pattern.
FindNearMissesResult	findNearMissesForUnmatchedRequests()
FindRequestsResult	findRequestsMatching(RequestPattern requestPattern)
FindNearMissesResult	findTopNearMissesFor(RequestPattern requestPattern)
FindNearMissesResult	findTopNearMissesFor(LoggedRequest loggedRequest)
FindRequestsResult	findUnmatchedRequests()
ListStubMappingsResult	findUnmatchedStubs()
GetScenariosResult	getAllScenarios()
Extensions	getExtensions()
GetGlobalSettingsResult	getGlobalSettings()
Set<String>	getLoadedExtensionNames()
SingleMessageServeEventResult	getMessageServeEvent(UUID id)	Gets a specific message serve event by ID.
GetMessageServeEventsResult	getMessageServeEvents()	Gets all message serve events from the message journal.
Options	getOptions()
RecordingStatusResult	getRecordingStatus()
SingleServedStubResult	getServedStub(UUID id)
GetServeEventsResult	getServeEvents()
GetServeEventsResult	getServeEvents(ServeEventQuery query)
SingleStubMappingResult	getStubMapping(UUID id)
void	importStubs(StubImport stubImport)
ListMessageChannelsResult	listAllMessageChannels()	Lists all active message channels.
ListMessageStubMappingsResult	listAllMessageStubMappings()	Lists all message stub mappings.
ListStubMappingsResult	listAllStubMappings()
void	loadMappingsUsing(MappingsLoader mappingsLoader)
void	loadMessageMappingsUsing(MappingsLoader mappingsLoader)
int	port()
void	removeMessageServeEvent(UUID eventId)	Removes a specific message serve event from the journal.
FindMessageServeEventsResult	removeMessageServeEventsForStubsMatchingMetadata(StringValuePattern pattern)	Removes all message serve events for stubs matching the given metadata pattern.
FindMessageServeEventsResult	removeMessageServeEventsMatching(MessagePattern pattern)	Removes all message serve events matching the given pattern.
void	removeMessageStubMapping(UUID id)	Removes a message stub mapping by its ID.
void	removeMessageStubsByMetadata(StringValuePattern pattern)	Removes all message stub mappings matching the given metadata pattern.
void	removeServeEvent(UUID eventId)
FindServeEventsResult	removeServeEventsForStubsMatchingMetadata(StringValuePattern metadataPattern)
FindServeEventsResult	removeServeEventsMatching(RequestPattern requestPattern)
void	removeStubMapping(StubMapping stubMapping)
void	removeStubMapping(UUID id)
void	removeStubMappings(List<StubMapping> stubMappings)
void	removeStubsByMetadata(StringValuePattern pattern)
void	resetAll()
void	resetMappings()
void	resetMessageJournal()	Resets the message journal, removing all events.
void	resetMessageStubMappings()	Removes all message stub mappings.
void	resetRequests()
void	resetScenario(String name)
void	resetScenarios()
void	resetToDefaultMappings()
void	saveMappings()
SendChannelMessageResult	sendChannelMessage(ChannelType type, RequestPattern requestPattern, MessageDefinition message)	Sends a message to all channels of the specified type matching the given request pattern.
ServeEvent	serveStubFor(ServeEvent initialServeEvent)
void	setScenarioState(String name, String state)
void	shutdownServer()
SnapshotRecordResult	snapshotRecord()
SnapshotRecordResult	snapshotRecord(RecordSpec recordSpec)
SnapshotRecordResult	snapshotRecord(RecordSpecBuilder spec)
void	startRecording(RecordSpec recordSpec)
void	startRecording(RecordSpecBuilder recordSpec)
void	startRecording(String targetBaseUrl)
SnapshotRecordResult	stopRecording()
void	updateGlobalSettings(GlobalSettings newSettings)
Optional<MessageServeEvent>	waitForMessageEvent(MessagePattern pattern, Duration maxWait)	Waits for a message event matching the given pattern to appear in the journal.
List<MessageServeEvent>	waitForMessageEvents(MessagePattern pattern, int count, Duration maxWait)	Waits for a specific number of message events matching the given pattern.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tomakehurst.wiremock.core.Admin

sendChannelMessage

Field Details

FILES_ROOT

public static final String FILES_ROOT

See Also:

• Constant Field Values

ADMIN_CONTEXT_ROOT_SEGMENT

public static final org.wiremock.url.Segment ADMIN_CONTEXT_ROOT_SEGMENT

ADMIN_CONTEXT_ROOT

public static final String ADMIN_CONTEXT_ROOT

MAPPINGS_ROOT

public static final String MAPPINGS_ROOT

See Also:

• Constant Field Values

MESSAGE_MAPPINGS_ROOT

public static final String MESSAGE_MAPPINGS_ROOT

See Also:

• Constant Field Values

Constructor Details

WireMockApp

public WireMockApp(Options options,
 Container container)

WireMockApp

public WireMockApp(boolean browserProxyingEnabled,
 MappingsLoader defaultMappingsLoader,
 Map<String,MappingsLoaderExtension> mappingsLoaderExtensions,
 MappingsSaver mappingsSaver,
 boolean requestJournalDisabled,
 Integer maxRequestJournalEntries,
 Map<String,ResponseDefinitionTransformer> transformers,
 Map<String,ResponseDefinitionTransformerV2> v2transformers,
 Map<String,RequestMatcherExtension> requestMatchers,
 FileSource rootFileSource,
 Container container)

Method Details

buildAdminRequestHandler

public AdminRequestHandler buildAdminRequestHandler()

buildStubRequestHandler

public StubRequestHandler buildStubRequestHandler()

buildMessageStubRequestHandler

public MessageStubRequestHandler buildMessageStubRequestHandler()

loadMappingsUsing

public void loadMappingsUsing(MappingsLoader mappingsLoader)

loadMessageMappingsUsing

public void loadMessageMappingsUsing(MappingsLoader mappingsLoader)

serveStubFor

public ServeEvent serveStubFor(ServeEvent initialServeEvent)

Specified by:

serveStubFor in interface StubServer

addStubMapping

public void addStubMapping(StubMapping stubMapping)

Specified by:

addStubMapping in interface Admin

removeStubMapping

public void removeStubMapping(StubMapping stubMapping)

Specified by:

removeStubMapping in interface Admin

removeStubMapping

public void removeStubMapping(UUID id)

Specified by:

removeStubMapping 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

resetScenarios

public void resetScenarios()

Specified by:

resetScenarios in interface Admin

resetMappings

public void resetMappings()

Specified by:

resetMappings 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

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

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

getGlobalSettings

public GetGlobalSettingsResult getGlobalSettings()

Specified by:

getGlobalSettings in interface Admin

updateGlobalSettings

public void updateGlobalSettings(GlobalSettings newSettings)

Specified by:

updateGlobalSettings in interface Admin

port

public int port()

getOptions

public Options getOptions()

Specified by:

getOptions in interface Admin

getExtensions

public Extensions getExtensions()

shutdownServer

public void shutdownServer()

Specified by:

shutdownServer 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 recordSpec)

Specified by:

snapshotRecord in interface Admin

startRecording

public void startRecording(String targetBaseUrl)

Specified by:

startRecording in interface Admin

startRecording

public void startRecording(RecordSpec recordSpec)

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

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

removeStubMappings

public void removeStubMappings(List<StubMapping> stubMappings)

Specified by:

removeStubMappings in interface Admin

getLoadedExtensionNames

public Set<String> getLoadedExtensionNames()

sendChannelMessage

public SendChannelMessageResult sendChannelMessage(ChannelType type,
 RequestPattern requestPattern,
 MessageDefinition message)

Description copied from interface: Admin

Sends a message to all channels of the specified type matching the given request pattern.

Specified by:

sendChannelMessage in interface Admin

Parameters:

type - the channel type to target

requestPattern - the pattern to match against the original upgrade request

message - the message to send

Returns:

result containing the matched channels that were messaged

listAllMessageChannels

public ListMessageChannelsResult listAllMessageChannels()

Description copied from interface: Admin

Lists all active message channels.

Specified by:

listAllMessageChannels in interface Admin

Returns:

result containing all message channels

addMessageStubMapping

public void addMessageStubMapping(MessageStubMapping messageStubMapping)

Description copied from interface: Admin

Adds a message stub mapping that will be matched against incoming messages on channels.

Specified by:

addMessageStubMapping in interface Admin

Parameters:

messageStubMapping - the message stub mapping to add

removeMessageStubMapping

public void removeMessageStubMapping(UUID id)

Description copied from interface: Admin

Removes a message stub mapping by its ID.

Specified by:

removeMessageStubMapping in interface Admin

Parameters:

id - the ID of the message stub mapping to remove

resetMessageStubMappings

public void resetMessageStubMappings()

Description copied from interface: Admin

Removes all message stub mappings.

Specified by:

resetMessageStubMappings in interface Admin

findAllMessageStubsByMetadata

public ListMessageStubMappingsResult findAllMessageStubsByMetadata(StringValuePattern pattern)

Description copied from interface: Admin

Finds all message stub mappings matching the given metadata pattern.

Specified by:

findAllMessageStubsByMetadata in interface Admin

Parameters:

pattern - the pattern to match stub metadata against

Returns:

result containing matching message stub mappings

removeMessageStubsByMetadata

public void removeMessageStubsByMetadata(StringValuePattern pattern)

Description copied from interface: Admin

Removes all message stub mappings matching the given metadata pattern.

Specified by:

removeMessageStubsByMetadata in interface Admin

Parameters:

pattern - the pattern to match stub metadata against

listAllMessageStubMappings

public ListMessageStubMappingsResult listAllMessageStubMappings()

Description copied from interface: Admin

Lists all message stub mappings.

Specified by:

listAllMessageStubMappings in interface Admin

Returns:

result containing all message stub mappings

getMessageServeEvents

public GetMessageServeEventsResult getMessageServeEvents()

Description copied from interface: Admin

Gets all message serve events from the message journal.

Specified by:

getMessageServeEvents in interface Admin

Returns:

result containing all message serve events

getMessageServeEvent

public SingleMessageServeEventResult getMessageServeEvent(UUID id)

Description copied from interface: Admin

Gets a specific message serve event by ID.

Specified by:

getMessageServeEvent in interface Admin

Parameters:

id - the event ID

Returns:

the event if found

countMessageEventsMatching

public int countMessageEventsMatching(MessagePattern pattern)

Description copied from interface: Admin

Counts message events matching the given pattern.

Specified by:

countMessageEventsMatching in interface Admin

Parameters:

pattern - the pattern to match events against

Returns:

the count of matching events

findMessageEventsMatching

public List<MessageServeEvent> findMessageEventsMatching(MessagePattern pattern)

Description copied from interface: Admin

Gets message events matching the given pattern.

Specified by:

findMessageEventsMatching in interface Admin

Parameters:

pattern - the pattern to match events against

Returns:

list of matching events

removeMessageServeEvent

public void removeMessageServeEvent(UUID eventId)

Description copied from interface: Admin

Removes a specific message serve event from the journal.

Specified by:

removeMessageServeEvent in interface Admin

Parameters:

eventId - the ID of the event to remove

removeMessageServeEventsMatching

public FindMessageServeEventsResult removeMessageServeEventsMatching(MessagePattern pattern)

Description copied from interface: Admin

Removes all message serve events matching the given pattern.

Specified by:

removeMessageServeEventsMatching in interface Admin

Parameters:

pattern - the pattern to match events against

Returns:

result containing the removed events

removeMessageServeEventsForStubsMatchingMetadata

public FindMessageServeEventsResult removeMessageServeEventsForStubsMatchingMetadata(StringValuePattern pattern)

Description copied from interface: Admin

Removes all message serve events for stubs matching the given metadata pattern.

Specified by:

removeMessageServeEventsForStubsMatchingMetadata in interface Admin

Parameters:

pattern - the pattern to match stub metadata against

Returns:

result containing the removed events

resetMessageJournal

public void resetMessageJournal()

Description copied from interface: Admin

Resets the message journal, removing all events.

Specified by:

resetMessageJournal in interface Admin

waitForMessageEvent

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

Description copied from interface: Admin

Waits for a message event matching the given pattern to appear in the journal.

Specified by:

waitForMessageEvent in interface Admin

Parameters:

pattern - the pattern to match events against

maxWait - the maximum duration to wait

Returns:

the matching event if found within the timeout

waitForMessageEvents

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

Description copied from interface: Admin

Waits for a specific number of message events matching the given pattern.

Specified by:

waitForMessageEvents in interface Admin

Parameters:

pattern - the pattern to match events against

count - the number of events to wait for

maxWait - the maximum duration to wait

Returns:

list of matching events