io.specto.hoverfly.junit.core

Class HoverflyConfig

java.lang.Object

io.specto.hoverfly.junit.core.HoverflyConfig

Direct Known Subclasses:

LocalHoverflyConfig, RemoteHoverflyConfig

public abstract class HoverflyConfig
extends java.lang.Object

Config builder interface for common settings of Hoverfly

Field Summary

Fields

Modifier and Type	Field and Description
protected int	adminPort
protected java.util.List<java.lang.String>	captureHeaders
protected java.lang.String	destination
protected boolean	incrementalCapture
protected java.lang.String	proxyCaCert
protected boolean	proxyLocalHost
protected int	proxyPort
protected SimulationPreprocessor	simulationPreprocessor
protected boolean	statefulCapture
protected boolean	webServer

Constructor Summary

Constructors

Constructor and Description
HoverflyConfig()

Method Summary

Modifier and Type	Method and Description
HoverflyConfig	adminPort(int adminPort) Sets the admin port for Hoverfly
HoverflyConfig	asWebServer()
abstract HoverflyConfiguration	build() Validate and build HoverflyConfiguration
HoverflyConfig	captureAllHeaders() Set to capture all request headers
HoverflyConfig	captureHeaders(java.lang.String... headers) Specifies which request headers to capture
static LocalHoverflyConfig	configs() Deprecated. use localConfigs()
HoverflyConfig	destination(java.lang.String destination) Sets destination filter to what target urls to simulate or capture
HoverflyConfig	enableIncrementalCapture() By default Hoverfly exports the captured requests and responses to a new file by replacing any existing one.
HoverflyConfig	enableStatefulCapture() By default Hoverfly captures multiple identical requests once only, enable to capture all requests sequentially
static LocalHoverflyConfig	localConfigs() Creates a new instance of LocalHoverflyConfig
HoverflyConfig	proxyCaCert(java.lang.String proxyCaCert) Set proxy CA certificate to validate the authenticity of a Hoverfly instance.
HoverflyConfig	proxyLocalHost() Invoke to enable proxying of localhost requests By default it is false
HoverflyConfig	proxyLocalHost(boolean proxyLocalHost) Deprecated.
HoverflyConfig	proxyPort(int proxyPort) Sets the proxy port for Hoverfly
RemoteHoverflyConfig	remote() Deprecated. use remoteConfigs()
static RemoteHoverflyConfig	remoteConfigs() Creates a new instance of RemoteHoverflyConfig
HoverflyConfig	simulationPreprocessor(SimulationPreprocessor simulationPreprocessor) Provides the ability to pre-process the mutable Simulation instance prior to handing it over to the Hoverfly client.

Methods inherited from class java.lang.Object

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

Field Detail

proxyPort

protected int proxyPort

adminPort

protected int adminPort

proxyLocalHost

protected boolean proxyLocalHost

destination

protected java.lang.String destination

proxyCaCert

protected java.lang.String proxyCaCert

captureHeaders

protected java.util.List<java.lang.String> captureHeaders

webServer

protected boolean webServer

statefulCapture

protected boolean statefulCapture

incrementalCapture

protected boolean incrementalCapture

simulationPreprocessor

protected SimulationPreprocessor simulationPreprocessor

Constructor Detail

HoverflyConfig

public HoverflyConfig()

Method Detail

configs

@Deprecated
public static LocalHoverflyConfig configs()

Deprecated. use localConfigs()

New instance

Returns:

a LocalHoverflyConfig implementation

localConfigs

public static LocalHoverflyConfig localConfigs()

Creates a new instance of LocalHoverflyConfig

Returns:

A new instance of LocalHoverflyConfig

remoteConfigs

public static RemoteHoverflyConfig remoteConfigs()

Creates a new instance of RemoteHoverflyConfig

Returns:

A new instance of RemoteHoverflyConfig

adminPort

public HoverflyConfig adminPort(int adminPort)

Sets the admin port for Hoverfly

Parameters:

adminPort - the admin port

Returns:

the HoverflyConfig for further customizations

proxyPort

public HoverflyConfig proxyPort(int proxyPort)

Sets the proxy port for Hoverfly

Parameters:

proxyPort - the proxy port

Returns:

the HoverflyConfig for further customizations

destination

public HoverflyConfig destination(java.lang.String destination)

Sets destination filter to what target urls to simulate or capture

Parameters:

destination - the destination filter

Returns:

the HoverflyConfig for further customizations

proxyLocalHost

@Deprecated
public HoverflyConfig proxyLocalHost(boolean proxyLocalHost)

Deprecated.

Controls whether we want to proxy localhost. If false then any request to localhost will not be proxied through Hoverfly.

Parameters:

proxyLocalHost - true if you want to proxy requests through localhost

Returns:

the HoverflyConfig for further customizations

proxyLocalHost

public HoverflyConfig proxyLocalHost()

Invoke to enable proxying of localhost requests By default it is false

Returns:

a config

captureHeaders

public HoverflyConfig captureHeaders(java.lang.String... headers)

Specifies which request headers to capture

Parameters:

headers - an array of header names

Returns:

the HoverflyConfig for further customizations

captureAllHeaders

public HoverflyConfig captureAllHeaders()

Set to capture all request headers

Returns:

the HoverflyConfig for further customizations

enableStatefulCapture

public HoverflyConfig enableStatefulCapture()

By default Hoverfly captures multiple identical requests once only, enable to capture all requests sequentially

Returns:

the HoverflyConfig for further customizations

enableIncrementalCapture

public HoverflyConfig enableIncrementalCapture()

By default Hoverfly exports the captured requests and responses to a new file by replacing any existing one. Enable this option to import any existing simulation file and append new requests to it in capture mode.

Returns:

the HoverflyConfig for further customizations

proxyCaCert

public HoverflyConfig proxyCaCert(java.lang.String proxyCaCert)

Set proxy CA certificate to validate the authenticity of a Hoverfly instance. If your hoverfly instance is not started with custom CA cert, then this option is not required.

Parameters:

proxyCaCert - the path for the PEM encoded certificate relative to classpath

Returns:

the HoverflyConfig for further customizations

asWebServer

public HoverflyConfig asWebServer()

remote

@Deprecated
public RemoteHoverflyConfig remote()

Deprecated. use remoteConfigs()

Enable remote Hoverfly configurations

Returns:

a RemoteHoverflyConfig implementation

simulationPreprocessor

public HoverflyConfig simulationPreprocessor(SimulationPreprocessor simulationPreprocessor)

Provides the ability to pre-process the mutable Simulation instance prior to handing it over to the Hoverfly client.

Parameters:

simulationPreprocessor - pre-processor

Returns:

the HoverflyConfig for further customizations

build

public abstract HoverflyConfiguration build()

Validate and build HoverflyConfiguration

Returns:

a validated hoverfly configuration object