Package com.github.tomakehurst.wiremock.core

Class WireMockConfiguration

java.lang.Object

com.github.tomakehurst.wiremock.core.WireMockConfiguration

All Implemented Interfaces:

Options

public class WireMockConfiguration
extends Object
implements Options

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tomakehurst.wiremock.core.Options

Options.ChunkedEncodingPolicy

Field Summary

Fields inherited from interface com.github.tomakehurst.wiremock.core.Options

DEFAULT_BIND_ADDRESS, DEFAULT_CONTAINER_THREADS, DEFAULT_DISABLE_CONNECTION_REUSE, DEFAULT_MAX_HTTP_CONNECTIONS, DEFAULT_MAX_TEMPLATE_CACHE_ENTRIES, DEFAULT_PORT, DEFAULT_TIMEOUT, DEFAULT_WEBHOOK_THREADPOOL_SIZE, DEFAULT_WEBSOCKET_IDLE_TIMEOUT, DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE, DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE, DYNAMIC_PORT

Constructor Summary

Constructors

Constructor	Description
WireMockConfiguration()

Method Summary

Modifier and Type	Method	Description
WireMockConfiguration	adminAuthenticator(Authenticator authenticator)
WireMockConfiguration	asynchronousResponseEnabled(boolean asynchronousResponseEnabled)
WireMockConfiguration	asynchronousResponseThreads(int asynchronousResponseThreads)
WireMockConfiguration	basicAdminAuthenticator(String username, String password)
String	bindAddress()
WireMockConfiguration	bindAddress(String bindAddress)
boolean	browserProxyingEnabled()
BrowserProxySettings	browserProxySettings()
WireMockConfiguration	caKeystorePassword(String keyStorePassword)
WireMockConfiguration	caKeystorePath(String path)
WireMockConfiguration	caKeystoreSettings(KeyStoreSettings caKeyStoreSettings)
WireMockConfiguration	caKeystoreType(String caKeystoreType)
int	containerThreads()
WireMockConfiguration	containerThreads(Integer containerThreads)
WireMockConfiguration	disableConnectionReuse(boolean disableConnectionReuse)
WireMockConfiguration	disableOptimizeXmlFactoriesLoading(boolean disableOptimizeXmlFactoriesLoading)
WireMockConfiguration	disableRequestJournal()
WireMockConfiguration	disableStrictHttpHeaders(boolean disableStrictHttpHeaders)
WireMockConfiguration	dynamicHttpsPort()
WireMockConfiguration	dynamicPort()
WireMockConfiguration	enableBrowserProxying(boolean enabled)
WireMockConfiguration	extensionFactories(ExtensionFactory... extensionFactories)
WireMockConfiguration	extensionFactories(Class<? extends ExtensionFactory>... factoryClasses)
WireMockConfiguration	extensions(Extension... extensionInstances)
WireMockConfiguration	extensions(ExtensionFactory... extensionFactories)
WireMockConfiguration	extensions(Class<? extends Extension>... classes)
WireMockConfiguration	extensions(String... classNames)
WireMockConfiguration	extensionScanningEnabled(boolean enabled)
WireMockConfiguration	filenameTemplate(String filenameTemplate)
WireMockConfiguration	fileSource(FileSource fileSource)
FileSource	filesRoot()
Authenticator	getAdminAuthenticator()
AsynchronousResponseSettings	getAsynchronousResponseSettings()
Options.ChunkedEncodingPolicy	getChunkedEncodingPolicy()
DataTruncationSettings	getDataTruncationSettings()
ExtensionDeclarations	getDeclaredExtensions()
boolean	getDisableConnectionReuse()
boolean	getDisableOptimizeXmlFactoriesLoading()
boolean	getDisableStrictHttpHeaders()
FilenameMaker	getFilenameMaker()
boolean	getGzipDisabled()
boolean	getHttp2PlainDisabled()
boolean	getHttp2TlsDisabled()
boolean	getHttpDisabled()
boolean	getHttpsRequiredForAdminApi()
int	getMaxHttpClientConnections()
Long	getMaxTemplateCacheEntries()
Function<Extensions,NotMatchedRenderer>	getNotMatchedRendererFactory()
NetworkAddressRules	getProxyTargetRules()
boolean	getResponseTemplatingEnabled()
boolean	getResponseTemplatingGlobal()
Stores	getStores()
boolean	getStubCorsEnabled()
boolean	getStubRequestLoggingDisabled()
Set<String>	getSupportedProxyEncodings()
boolean	getTemplateEscapingDisabled()
Set<String>	getTemplatePermittedSystemKeys()
int	getWebhookThreadPoolSize()
long	getWebSocketIdleTimeout()
long	getWebSocketMaxBinaryMessageSize()
long	getWebSocketMaxTextMessageSize()
WireMockConfiguration	globalTemplating(boolean globalTemplating)
WireMockConfiguration	gzipDisabled(boolean gzipDisabled)
WireMockConfiguration	http2PlainDisabled(boolean enabled)
WireMockConfiguration	http2TlsDisabled(boolean enabled)
HttpClientFactory	httpClientFactory()
WireMockConfiguration	httpClientFactory(HttpClientFactory httpClientFactory)
WireMockConfiguration	httpDisabled(boolean httpDisabled)
HttpServerFactory	httpServerFactory()
WireMockConfiguration	httpServerFactory(HttpServerFactory serverFactory)
WireMockConfiguration	httpsPort(Integer httpsPort)
HttpsSettings	httpsSettings()
boolean	isExtensionScanningEnabled()
WireMockConfiguration	keyManagerPassword(String keyManagerPassword)
WireMockConfiguration	keystorePassword(String keyStorePassword)
WireMockConfiguration	keystorePath(String path)
WireMockConfiguration	keystoreType(String keyStoreType)
WireMockConfiguration	limitProxyTargets(NetworkAddressRules proxyTargetRules)
MappingsLoader	mappingsLoader()
WireMockConfiguration	mappingSource(MappingsSource mappingsSource)
MappingsSaver	mappingsSaver()
List<CaseInsensitiveKey>	matchingHeaders()
WireMockConfiguration	maxHttpClientConnections(int maxHttpClientConnections)
WireMockConfiguration	maxLoggedResponseSize(int maxSize)
Optional<Integer>	maxRequestJournalEntries()
WireMockConfiguration	maxRequestJournalEntries(int maxRequestJournalEntries)
WireMockConfiguration	maxRequestJournalEntries(Optional<Integer> maxRequestJournalEntries)	Deprecated.
WireMockConfiguration	needClientAuth(boolean needClientAuth)
WiremockNetworkTrafficListener	networkTrafficListener()
WireMockConfiguration	networkTrafficListener(WiremockNetworkTrafficListener networkTrafficListener)
Notifier	notifier()
WireMockConfiguration	notifier(Notifier notifier)
WireMockConfiguration	notMatchedRendererFactory(Function<Extensions,NotMatchedRenderer> notMatchedRendererFactory)
static WireMockConfiguration	options()
WireMockConfiguration	port(int portNumber)
int	portNumber()
WireMockConfiguration	preserveHostHeader(boolean preserveHostHeader)
WireMockConfiguration	preserveUserAgentProxyHeader(boolean preserveUserAgentProxyHeader)
String	proxyHostHeader()
WireMockConfiguration	proxyHostHeader(String hostHeaderValue)
WireMockConfiguration	proxyPassThrough(boolean proxyPassThrough)
int	proxyTimeout()
WireMockConfiguration	proxyTimeout(int proxyTimeout)
ProxySettings	proxyVia()
WireMockConfiguration	proxyVia(ProxySettings proxySettings)
WireMockConfiguration	proxyVia(String host, int port)
WireMockConfiguration	recordRequestHeadersForMatching(List<String> headers)
boolean	requestJournalDisabled()
WireMockConfiguration	requireHttpsForAdminApi()
boolean	shouldPreserveHostHeader()
boolean	shouldPreserveUserAgentProxyHeader()
WireMockConfiguration	stubCorsEnabled(boolean enabled)
WireMockConfiguration	stubRequestLoggingDisabled(boolean disabled)
WireMockConfiguration	templatingEnabled(boolean templatingEnabled)
long	timeout()
WireMockConfiguration	timeout(int timeout)
WireMockConfiguration	trustAllProxyTargets(boolean enabled)
WireMockConfiguration	trustedProxyTargets(String... trustedProxyTargets)
WireMockConfiguration	trustedProxyTargets(List<String> trustedProxyTargets)
WireMockConfiguration	trustStorePassword(String trustStorePassword)
WireMockConfiguration	trustStorePath(String truststorePath)
WireMockConfiguration	trustStoreType(String trustStoreType)
WireMockConfiguration	useChunkedTransferEncoding(Options.ChunkedEncodingPolicy policy)
WireMockConfiguration	usingFilesUnderClasspath(String path)
WireMockConfiguration	usingFilesUnderDirectory(String path)
WireMockConfiguration	webSocketIdleTimeout(long timeout)
WireMockConfiguration	webSocketMaxBinaryMessageSize(long size)
WireMockConfiguration	webSocketMaxTextMessageSize(long size)
static WireMockConfiguration	wireMockConfig()
WireMockConfiguration	withMaxTemplateCacheEntries(Long maxTemplateCacheEntries)
WireMockConfiguration	withPermittedSystemKeys(String... systemKeys)
WireMockConfiguration	withRootDirectory(String path)
WireMockConfiguration	withStores(Stores stores)
WireMockConfiguration	withSupportedProxyEncodings(String... supportedProxyEncodings)
WireMockConfiguration	withSupportedProxyEncodings(Set<String> supportedProxyEncodings)
WireMockConfiguration	withTemplateEscapingDisabled(boolean templateEscapingDisabled)
WireMockConfiguration	withWebhookThreadPoolSize(Integer webhookThreadPoolSize)

Methods inherited from class java.lang.Object

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

Constructor Details

WireMockConfiguration

public WireMockConfiguration()

Method Details

wireMockConfig

public static WireMockConfiguration wireMockConfig()

options

public static WireMockConfiguration options()

proxyPassThrough

public WireMockConfiguration proxyPassThrough(boolean proxyPassThrough)

timeout

public WireMockConfiguration timeout(int timeout)

webSocketIdleTimeout

public WireMockConfiguration webSocketIdleTimeout(long timeout)

webSocketMaxTextMessageSize

public WireMockConfiguration webSocketMaxTextMessageSize(long size)

webSocketMaxBinaryMessageSize

public WireMockConfiguration webSocketMaxBinaryMessageSize(long size)

port

public WireMockConfiguration port(int portNumber)

filenameTemplate

public WireMockConfiguration filenameTemplate(String filenameTemplate)

dynamicPort

public WireMockConfiguration dynamicPort()

httpDisabled

public WireMockConfiguration httpDisabled(boolean httpDisabled)

http2PlainDisabled

public WireMockConfiguration http2PlainDisabled(boolean enabled)

http2TlsDisabled

public WireMockConfiguration http2TlsDisabled(boolean enabled)

httpsPort

public WireMockConfiguration httpsPort(Integer httpsPort)

dynamicHttpsPort

public WireMockConfiguration dynamicHttpsPort()

containerThreads

public WireMockConfiguration containerThreads(Integer containerThreads)

keystorePath

public WireMockConfiguration keystorePath(String path)

keystorePassword

public WireMockConfiguration keystorePassword(String keyStorePassword)

keyManagerPassword

public WireMockConfiguration keyManagerPassword(String keyManagerPassword)

keystoreType

public WireMockConfiguration keystoreType(String keyStoreType)

caKeystoreSettings

public WireMockConfiguration caKeystoreSettings(KeyStoreSettings caKeyStoreSettings)

caKeystorePath

public WireMockConfiguration caKeystorePath(String path)

caKeystorePassword

public WireMockConfiguration caKeystorePassword(String keyStorePassword)

caKeystoreType

public WireMockConfiguration caKeystoreType(String caKeystoreType)

trustStorePath

public WireMockConfiguration trustStorePath(String truststorePath)

trustStorePassword

public WireMockConfiguration trustStorePassword(String trustStorePassword)

trustStoreType

public WireMockConfiguration trustStoreType(String trustStoreType)

needClientAuth

public WireMockConfiguration needClientAuth(boolean needClientAuth)

enableBrowserProxying

public WireMockConfiguration enableBrowserProxying(boolean enabled)

proxyVia

public WireMockConfiguration proxyVia(String host,
 int port)

proxyVia

public WireMockConfiguration proxyVia(ProxySettings proxySettings)

withStores

public WireMockConfiguration withStores(Stores stores)

withRootDirectory

public WireMockConfiguration withRootDirectory(String path)

usingFilesUnderDirectory

public WireMockConfiguration usingFilesUnderDirectory(String path)

usingFilesUnderClasspath

public WireMockConfiguration usingFilesUnderClasspath(String path)

fileSource

public WireMockConfiguration fileSource(FileSource fileSource)

mappingSource

public WireMockConfiguration mappingSource(MappingsSource mappingsSource)

notifier

public WireMockConfiguration notifier(Notifier notifier)

bindAddress

public WireMockConfiguration bindAddress(String bindAddress)

disableRequestJournal

public WireMockConfiguration disableRequestJournal()

maxRequestJournalEntries

@Deprecated
public WireMockConfiguration maxRequestJournalEntries(Optional<Integer> maxRequestJournalEntries)

Deprecated.

maxRequestJournalEntries

public WireMockConfiguration maxRequestJournalEntries(int maxRequestJournalEntries)

recordRequestHeadersForMatching

public WireMockConfiguration recordRequestHeadersForMatching(List<String> headers)

preserveHostHeader

public WireMockConfiguration preserveHostHeader(boolean preserveHostHeader)

preserveUserAgentProxyHeader

public WireMockConfiguration preserveUserAgentProxyHeader(boolean preserveUserAgentProxyHeader)

proxyHostHeader

public WireMockConfiguration proxyHostHeader(String hostHeaderValue)

extensions

public WireMockConfiguration extensions(String... classNames)

extensions

public WireMockConfiguration extensions(Extension... extensionInstances)

extensionFactories

public WireMockConfiguration extensionFactories(ExtensionFactory... extensionFactories)

extensions

public WireMockConfiguration extensions(ExtensionFactory... extensionFactories)

extensions

public WireMockConfiguration extensions(Class<? extends Extension>... classes)

extensionFactories

public WireMockConfiguration extensionFactories(Class<? extends ExtensionFactory>... factoryClasses)

extensionScanningEnabled

public WireMockConfiguration extensionScanningEnabled(boolean enabled)

httpServerFactory

public WireMockConfiguration httpServerFactory(HttpServerFactory serverFactory)

httpClientFactory

public WireMockConfiguration httpClientFactory(HttpClientFactory httpClientFactory)

networkTrafficListener

public WireMockConfiguration networkTrafficListener(WiremockNetworkTrafficListener networkTrafficListener)

adminAuthenticator

public WireMockConfiguration adminAuthenticator(Authenticator authenticator)

basicAdminAuthenticator

public WireMockConfiguration basicAdminAuthenticator(String username,
 String password)

requireHttpsForAdminApi

public WireMockConfiguration requireHttpsForAdminApi()

notMatchedRendererFactory

public WireMockConfiguration notMatchedRendererFactory(Function<Extensions,NotMatchedRenderer> notMatchedRendererFactory)

asynchronousResponseEnabled

public WireMockConfiguration asynchronousResponseEnabled(boolean asynchronousResponseEnabled)

asynchronousResponseThreads

public WireMockConfiguration asynchronousResponseThreads(int asynchronousResponseThreads)

useChunkedTransferEncoding

public WireMockConfiguration useChunkedTransferEncoding(Options.ChunkedEncodingPolicy policy)

gzipDisabled

public WireMockConfiguration gzipDisabled(boolean gzipDisabled)

stubRequestLoggingDisabled

public WireMockConfiguration stubRequestLoggingDisabled(boolean disabled)

stubCorsEnabled

public WireMockConfiguration stubCorsEnabled(boolean enabled)

trustAllProxyTargets

public WireMockConfiguration trustAllProxyTargets(boolean enabled)

trustedProxyTargets

public WireMockConfiguration trustedProxyTargets(String... trustedProxyTargets)

trustedProxyTargets

public WireMockConfiguration trustedProxyTargets(List<String> trustedProxyTargets)

disableOptimizeXmlFactoriesLoading

public WireMockConfiguration disableOptimizeXmlFactoriesLoading(boolean disableOptimizeXmlFactoriesLoading)

maxLoggedResponseSize

public WireMockConfiguration maxLoggedResponseSize(int maxSize)

limitProxyTargets

public WireMockConfiguration limitProxyTargets(NetworkAddressRules proxyTargetRules)

proxyTimeout

public WireMockConfiguration proxyTimeout(int proxyTimeout)

maxHttpClientConnections

public WireMockConfiguration maxHttpClientConnections(int maxHttpClientConnections)

disableConnectionReuse

public WireMockConfiguration disableConnectionReuse(boolean disableConnectionReuse)

templatingEnabled

public WireMockConfiguration templatingEnabled(boolean templatingEnabled)

globalTemplating

public WireMockConfiguration globalTemplating(boolean globalTemplating)

withPermittedSystemKeys

public WireMockConfiguration withPermittedSystemKeys(String... systemKeys)

withTemplateEscapingDisabled

public WireMockConfiguration withTemplateEscapingDisabled(boolean templateEscapingDisabled)

withMaxTemplateCacheEntries

public WireMockConfiguration withMaxTemplateCacheEntries(Long maxTemplateCacheEntries)

withSupportedProxyEncodings

public WireMockConfiguration withSupportedProxyEncodings(Set<String> supportedProxyEncodings)

withSupportedProxyEncodings

public WireMockConfiguration withSupportedProxyEncodings(String... supportedProxyEncodings)

withWebhookThreadPoolSize

public WireMockConfiguration withWebhookThreadPoolSize(Integer webhookThreadPoolSize)

portNumber

public int portNumber()

Specified by:

portNumber in interface Options

getHttpDisabled

public boolean getHttpDisabled()

Specified by:

getHttpDisabled in interface Options

getHttp2PlainDisabled

public boolean getHttp2PlainDisabled()

Specified by:

getHttp2PlainDisabled in interface Options

getHttp2TlsDisabled

public boolean getHttp2TlsDisabled()

Specified by:

getHttp2TlsDisabled in interface Options

containerThreads

public int containerThreads()

Specified by:

containerThreads in interface Options

httpsSettings

public HttpsSettings httpsSettings()

Specified by:

httpsSettings in interface Options

browserProxyingEnabled

public boolean browserProxyingEnabled()

Specified by:

browserProxyingEnabled in interface Options

proxyVia

public ProxySettings proxyVia()

Specified by:

proxyVia in interface Options

getStores

public Stores getStores()

Specified by:

getStores in interface Options

filesRoot

public FileSource filesRoot()

Specified by:

filesRoot in interface Options

mappingsLoader

public MappingsLoader mappingsLoader()

Specified by:

mappingsLoader in interface Options

mappingsSaver

public MappingsSaver mappingsSaver()

Specified by:

mappingsSaver in interface Options

notifier

public Notifier notifier()

Specified by:

notifier in interface Options

requestJournalDisabled

public boolean requestJournalDisabled()

Specified by:

requestJournalDisabled in interface Options

maxRequestJournalEntries

public Optional<Integer> maxRequestJournalEntries()

Specified by:

maxRequestJournalEntries in interface Options

bindAddress

public String bindAddress()

Specified by:

bindAddress in interface Options

getFilenameMaker

public FilenameMaker getFilenameMaker()

Specified by:

getFilenameMaker in interface Options

matchingHeaders

public List<CaseInsensitiveKey> matchingHeaders()

Specified by:

matchingHeaders in interface Options

httpServerFactory

public HttpServerFactory httpServerFactory()

Specified by:

httpServerFactory in interface Options

httpClientFactory

public HttpClientFactory httpClientFactory()

Specified by:

httpClientFactory in interface Options

shouldPreserveHostHeader

public boolean shouldPreserveHostHeader()

Specified by:

shouldPreserveHostHeader in interface Options

shouldPreserveUserAgentProxyHeader

public boolean shouldPreserveUserAgentProxyHeader()

Specified by:

shouldPreserveUserAgentProxyHeader in interface Options

proxyHostHeader

public String proxyHostHeader()

Specified by:

proxyHostHeader in interface Options

getDeclaredExtensions

public ExtensionDeclarations getDeclaredExtensions()

Specified by:

getDeclaredExtensions in interface Options

isExtensionScanningEnabled

public boolean isExtensionScanningEnabled()

Specified by:

isExtensionScanningEnabled in interface Options

networkTrafficListener

public WiremockNetworkTrafficListener networkTrafficListener()

Specified by:

networkTrafficListener in interface Options

getAdminAuthenticator

public Authenticator getAdminAuthenticator()

Specified by:

getAdminAuthenticator in interface Options

getHttpsRequiredForAdminApi

public boolean getHttpsRequiredForAdminApi()

Specified by:

getHttpsRequiredForAdminApi in interface Options

getNotMatchedRendererFactory

public Function<Extensions,NotMatchedRenderer> getNotMatchedRendererFactory()

Specified by:

getNotMatchedRendererFactory in interface Options

getAsynchronousResponseSettings

public AsynchronousResponseSettings getAsynchronousResponseSettings()

Specified by:

getAsynchronousResponseSettings in interface Options

getChunkedEncodingPolicy

public Options.ChunkedEncodingPolicy getChunkedEncodingPolicy()

Specified by:

getChunkedEncodingPolicy in interface Options

getGzipDisabled

public boolean getGzipDisabled()

Specified by:

getGzipDisabled in interface Options

getStubRequestLoggingDisabled

public boolean getStubRequestLoggingDisabled()

Specified by:

getStubRequestLoggingDisabled in interface Options

getStubCorsEnabled

public boolean getStubCorsEnabled()

Specified by:

getStubCorsEnabled in interface Options

timeout

public long timeout()

Specified by:

timeout in interface Options

getDisableOptimizeXmlFactoriesLoading

public boolean getDisableOptimizeXmlFactoriesLoading()

Specified by:

getDisableOptimizeXmlFactoriesLoading in interface Options

getDisableStrictHttpHeaders

public boolean getDisableStrictHttpHeaders()

Specified by:

getDisableStrictHttpHeaders in interface Options

getDataTruncationSettings

public DataTruncationSettings getDataTruncationSettings()

Specified by:

getDataTruncationSettings in interface Options

disableStrictHttpHeaders

public WireMockConfiguration disableStrictHttpHeaders(boolean disableStrictHttpHeaders)

browserProxySettings

public BrowserProxySettings browserProxySettings()

Specified by:

browserProxySettings in interface Options

getProxyTargetRules

public NetworkAddressRules getProxyTargetRules()

Specified by:

getProxyTargetRules in interface Options

proxyTimeout

public int proxyTimeout()

Specified by:

proxyTimeout in interface Options

getMaxHttpClientConnections

public int getMaxHttpClientConnections()

Specified by:

getMaxHttpClientConnections in interface Options

getDisableConnectionReuse

public boolean getDisableConnectionReuse()

Specified by:

getDisableConnectionReuse in interface Options

getResponseTemplatingEnabled

public boolean getResponseTemplatingEnabled()

Specified by:

getResponseTemplatingEnabled in interface Options

getResponseTemplatingGlobal

public boolean getResponseTemplatingGlobal()

Specified by:

getResponseTemplatingGlobal in interface Options

getMaxTemplateCacheEntries

public Long getMaxTemplateCacheEntries()

Specified by:

getMaxTemplateCacheEntries in interface Options

getTemplatePermittedSystemKeys

public Set<String> getTemplatePermittedSystemKeys()

Specified by:

getTemplatePermittedSystemKeys in interface Options

getTemplateEscapingDisabled

public boolean getTemplateEscapingDisabled()

Specified by:

getTemplateEscapingDisabled in interface Options

getSupportedProxyEncodings

public Set<String> getSupportedProxyEncodings()

Specified by:

getSupportedProxyEncodings in interface Options

getWebhookThreadPoolSize

public int getWebhookThreadPoolSize()

Specified by:

getWebhookThreadPoolSize in interface Options

getWebSocketIdleTimeout

public long getWebSocketIdleTimeout()

Specified by:

getWebSocketIdleTimeout in interface Options

getWebSocketMaxTextMessageSize

public long getWebSocketMaxTextMessageSize()

Specified by:

getWebSocketMaxTextMessageSize in interface Options

getWebSocketMaxBinaryMessageSize

public long getWebSocketMaxBinaryMessageSize()

Specified by:

getWebSocketMaxBinaryMessageSize in interface Options