Package com.github.tomakehurst.wiremock.client

Class HttpAdminClient

java.lang.Object

com.github.tomakehurst.wiremock.client.HttpAdminClient

All Implemented Interfaces:

Admin

public class HttpAdminClient
extends Object
implements Admin

Constructor Summary

Constructors

Constructor	Description
HttpAdminClient(String host, int port)
HttpAdminClient(String host, int port, String urlPathPrefix)
HttpAdminClient(String scheme, String host)
HttpAdminClient(String scheme, String host, int port)
HttpAdminClient(String scheme, String host, int port, String urlPathPrefix)
HttpAdminClient(String scheme, String host, int port, String urlPathPrefix, String hostHeader)
HttpAdminClient(String scheme, String host, int port, String urlPathPrefix, String hostHeader, ClientAuthenticator authenticator, org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient)
HttpAdminClient(String scheme, String host, int port, String urlPathPrefix, String hostHeader, String proxyHost, int proxyPort)
HttpAdminClient(String scheme, String host, int port, String urlPathPrefix, String hostHeader, String proxyHost, int proxyPort, ClientAuthenticator authenticator)

Method Summary

Modifier and Type	Method	Description
void	addStubMapping(StubMapping stubMapping)
VerificationResult	countRequestsMatching(RequestPattern requestPattern)
void	editStubMapping(StubMapping stubMapping)
ListStubMappingsResult	findAllStubsByMetadata(StringValuePattern pattern)
FindNearMissesResult	findNearMissesForUnmatchedRequests()
FindRequestsResult	findRequestsMatching(RequestPattern requestPattern)
FindNearMissesResult	findTopNearMissesFor(RequestPattern requestPattern)
FindNearMissesResult	findTopNearMissesFor(LoggedRequest loggedRequest)
FindRequestsResult	findUnmatchedRequests()
ListStubMappingsResult	findUnmatchedStubs()
GetScenariosResult	getAllScenarios()
GetGlobalSettingsResult	getGlobalSettings()
protected String	getJsonAssertOkAndReturnBody(String url)
Options	getOptions()
RecordingStatusResult	getRecordingStatus()
SingleServedStubResult	getServedStub(UUID id)
GetServeEventsResult	getServeEvents()
GetServeEventsResult	getServeEvents(ServeEventQuery query)
SingleStubMappingResult	getStubMapping(UUID id)
void	importStubs(StubImport stubImport)
ListStubMappingsResult	listAllStubMappings()
int	port()
void	removeServeEvent(UUID eventId)
FindServeEventsResult	removeServeEventsForStubsMatchingMetadata(StringValuePattern metadataPattern)
FindServeEventsResult	removeServeEventsMatching(RequestPattern requestPattern)
void	removeStubMapping(StubMapping stubbMapping)
void	removeStubMapping(UUID id)
void	removeStubsByMetadata(StringValuePattern pattern)
void	resetAll()
void	resetMappings()
void	resetRequests()
void	resetScenario(String name)
void	resetScenarios()
void	resetToDefaultMappings()
void	saveMappings()
void	setScenarioState(String name, String state)
void	shutdownServer()
SnapshotRecordResult	snapshotRecord()
SnapshotRecordResult	snapshotRecord(RecordSpec spec)
SnapshotRecordResult	snapshotRecord(RecordSpecBuilder spec)
void	startRecording(RecordSpec recordSpec)
void	startRecording(RecordSpecBuilder recordSpec)
void	startRecording(String targetBaseUrl)
SnapshotRecordResult	stopRecording()
void	updateGlobalSettings(GlobalSettings settings)

Methods inherited from class java.lang.Object

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

Constructor Details

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host)

HttpAdminClient

public HttpAdminClient(String host,
 int port,
 String urlPathPrefix)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port,
 String urlPathPrefix)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port,
 String urlPathPrefix,
 String hostHeader)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port,
 String urlPathPrefix,
 String hostHeader,
 String proxyHost,
 int proxyPort)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port,
 String urlPathPrefix,
 String hostHeader,
 String proxyHost,
 int proxyPort,
 ClientAuthenticator authenticator)

HttpAdminClient

public HttpAdminClient(String scheme,
 String host,
 int port,
 String urlPathPrefix,
 String hostHeader,
 ClientAuthenticator authenticator,
 org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient)

HttpAdminClient

public HttpAdminClient(String host,
 int port)

Method Details

addStubMapping

public void addStubMapping(StubMapping stubMapping)

Specified by:

addStubMapping in interface Admin

editStubMapping

public void editStubMapping(StubMapping stubMapping)

Specified by:

editStubMapping in interface Admin

removeStubMapping

public void removeStubMapping(StubMapping stubbMapping)

Specified by:

removeStubMapping in interface Admin

removeStubMapping

public void removeStubMapping(UUID id)

Specified by:

removeStubMapping 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

resetScenarios

public void resetScenarios()

Specified by:

resetScenarios in interface Admin

resetMappings

public void resetMappings()

Specified by:

resetMappings 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

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

updateGlobalSettings

public void updateGlobalSettings(GlobalSettings settings)

Specified by:

updateGlobalSettings 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

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

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

port

public int port()

getJsonAssertOkAndReturnBody

protected String getJsonAssertOkAndReturnBody(String url)