io.specto.hoverfly.junit.core

Class HoverflyConfig

java.lang.Object

io.specto.hoverfly.junit.core.HoverflyConfig

public class HoverflyConfig
extends java.lang.Object

Config used to change the settings for Hoverfly

Method Summary

Modifier and Type	Method and Description
HoverflyConfig	adminPort(int adminPort) Sets the admin port for Hoverfly
static HoverflyConfig	configs() New instance
int	getAdminPort() Gets the admin port Hoverfly is configured to run on
java.lang.String	getHost() Returns the host for the remote instance of hoverfly
int	getProxyPort() Gets the proxy port Hoverfly is configured to run on
java.lang.String	getSslCertificatePath() Gets the path to SSL certificate
java.lang.String	getSslKeyPath() Gets the path to SSL key
boolean	isProxyLocalHost() Whether localhost should be proxied
boolean	isRemoteInstance() True is a remote Hoverfly should be used
HoverflyConfig	proxyLocalHost(boolean proxyLocalHost) Controls whether we want to proxy localhost.
HoverflyConfig	proxyPort(int proxyPort) Sets the proxy port for Hoverfly
HoverflyConfig	sslCertificatePath(java.lang.String sslCertificatePath) Sets the SSL certificate file for overriding default Hoverfly self-signed certificate The file can be in any PEM encoded certificate, in .crt or .pem extensions
HoverflyConfig	sslKeyPath(java.lang.String sslKeyPath) Sets the SSL key file for overriding default Hoverfly SSL key The file can be in any PEM encoded key, in .key or .pem extensions
HoverflyConfig	useRemoteInstance() By calling this it means a remote Hoverfly will be used - not started by Java.
HoverflyConfig	useRemoteInstance(java.lang.String remoteHost) By calling this it means a remote Hoverfly will be used - not started by Java

Methods inherited from class java.lang.Object

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

Method Detail

configs

public static HoverflyConfig configs()

New instance

Returns:

a config

proxyPort

public HoverflyConfig proxyPort(int proxyPort)

Sets the proxy port for Hoverfly

Parameters:

proxyPort - the proxy port

Returns:

the HoverflyConfig for further customizations

adminPort

public HoverflyConfig adminPort(int adminPort)

Sets the admin port for Hoverfly

Parameters:

adminPort - the admin port

Returns:

the HoverflyConfig for further customizations

proxyLocalHost

public HoverflyConfig proxyLocalHost(boolean proxyLocalHost)

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

Parameters:

proxyLocalHost - whether to proxy localhost, default to false

Returns:

the HoverflyConfig for further customizations

getProxyPort

public int getProxyPort()

Gets the proxy port Hoverfly is configured to run on

Returns:

the proxy port

getAdminPort

public int getAdminPort()

Gets the admin port Hoverfly is configured to run on

Returns:

the admin port

isProxyLocalHost

public boolean isProxyLocalHost()

Whether localhost should be proxied

Returns:

true if proxied

useRemoteInstance

public HoverflyConfig useRemoteInstance()

By calling this it means a remote Hoverfly will be used - not started by Java. This method will assume the host is localhost.

Returns:

the HoverflyConfig for further customizations

useRemoteInstance

public HoverflyConfig useRemoteInstance(java.lang.String remoteHost)

By calling this it means a remote Hoverfly will be used - not started by Java

Parameters:

remoteHost - the hostname of the remote hoverfly

Returns:

the HoverflyConfig for further customizations

isRemoteInstance

public boolean isRemoteInstance()

True is a remote Hoverfly should be used

Returns:

whether it's remote or not

getHost

public java.lang.String getHost()

Returns the host for the remote instance of hoverfly

Returns:

the remote host

sslCertificatePath

public HoverflyConfig sslCertificatePath(java.lang.String sslCertificatePath)

Sets the SSL certificate file for overriding default Hoverfly self-signed certificate The file can be in any PEM encoded certificate, in .crt or .pem extensions

Parameters:

sslCertificatePath - certificate file in classpath

Returns:

the HoverflyConfig for further customizations

sslKeyPath

public HoverflyConfig sslKeyPath(java.lang.String sslKeyPath)

Sets the SSL key file for overriding default Hoverfly SSL key The file can be in any PEM encoded key, in .key or .pem extensions

Parameters:

sslKeyPath - key file in classpath

Returns:

the HoverflyConfig for further customizations

getSslCertificatePath

public java.lang.String getSslCertificatePath()

Gets the path to SSL certificate

Returns:

the SSL certificate path

getSslKeyPath

public java.lang.String getSslKeyPath()

Gets the path to SSL key

Returns:

the SSL key path