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 java.lang.String	proxyCaCert
protected boolean	proxyLocalHost
protected int	proxyPort

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
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() New instance
HoverflyConfig	destination(java.lang.String destination) Sets destination filter to what target urls to simulate or capture
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() Enable remote Hoverfly configurations

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

Constructor Detail

HoverflyConfig

public HoverflyConfig()

Method Detail

configs

public static LocalHoverflyConfig configs()

New instance

Returns:

a LocalHoverflyConfig implementation

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

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

remote

public RemoteHoverflyConfig remote()

Enable remote Hoverfly configurations

Returns:

a RemoteHoverflyConfig implementation

build

public abstract HoverflyConfiguration build()

Validate and build HoverflyConfiguration

Returns:

a validated hoverfly configuration object