io.specto.hoverfly.junit.api

Interface HoverflyClient

public interface HoverflyClient

Http client for querying Hoverfly admin endpoints

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HoverflyClient.Builder HTTP client builder for Hoverfly admin API

Method Summary

Modifier and Type	Method and Description
void	addSimulation(Simulation simulation) Append the given simulation to the existing one in Hoverfly, duplicated pair will not be added
void	cleanDiffs()
static HoverflyClient	createDefault() Static factory method for default Hoverfly client
static HoverflyClient.Builder	custom() Static factory method for creating a HoverflyClient.Builder
void	deleteJournal()
void	deleteSimulation()
void	deleteState() Deletes all state from Hoverfly.
HoverflyInfoView	getConfigInfo()
DiffView	getDiffs()
boolean	getHealth() Check Hoverfly is healthy
Journal	getJournal(int offset, int limit)
Journal	getJournal(int offset, int limit, SortParams sortParams)
Simulation	getSimulation()
com.fasterxml.jackson.databind.JsonNode	getSimulationJson() Get the simulation from Hoverfly as JsonNode
StateView	getState() Gets the state from Hoverfly.
Journal	searchJournal(Request request)
void	setDestination(java.lang.String destination)
void	setMode(HoverflyMode mode) Update Hoverfly mode
void	setMode(HoverflyMode mode, ModeArguments modeArguments) Update Hoverfly mode with additional arguments
void	setSimulation(Simulation simulation) Set the given simulation data, overwriting any existing one.
void	setSimulation(java.lang.String simulation)
void	setState(StateView stateView) Deletes all state from Hoverfly and then sets the state with the specified StateView.
void	updateState(StateView stateView) Updates state in Hoverfly.

Method Detail

setSimulation

void setSimulation(Simulation simulation)

Set the given simulation data, overwriting any existing one.

Parameters:

simulation - Hoverfly simulation data to set

setSimulation

void setSimulation(java.lang.String simulation)

addSimulation

void addSimulation(Simulation simulation)

Append the given simulation to the existing one in Hoverfly, duplicated pair will not be added

Parameters:

simulation - Hoverfly simulation data to append

getSimulation

Simulation getSimulation()

getSimulationJson

com.fasterxml.jackson.databind.JsonNode getSimulationJson()

Get the simulation from Hoverfly as JsonNode

Returns:

simulation data as JsonNode

deleteSimulation

void deleteSimulation()

getJournal

Journal getJournal(int offset,
                   int limit)

getJournal

Journal getJournal(int offset,
                   int limit,
                   SortParams sortParams)

searchJournal

Journal searchJournal(Request request)

deleteJournal

void deleteJournal()

deleteState

void deleteState()

Deletes all state from Hoverfly.

getState

StateView getState()

Gets the state from Hoverfly.

Returns:

the StateView

setState

void setState(StateView stateView)

Deletes all state from Hoverfly and then sets the state with the specified StateView.

Parameters:

stateView - the StateView

updateState

void updateState(StateView stateView)

Updates state in Hoverfly. Will update each state key referenced in the specified StateView.

Parameters:

stateView - the StateView

getDiffs

DiffView getDiffs()

cleanDiffs

void cleanDiffs()

getConfigInfo

HoverflyInfoView getConfigInfo()

setDestination

void setDestination(java.lang.String destination)

setMode

void setMode(HoverflyMode mode)

Update Hoverfly mode

Parameters:

mode - HoverflyMode

setMode

void setMode(HoverflyMode mode,
             ModeArguments modeArguments)

Update Hoverfly mode with additional arguments

Parameters:

mode - HoverflyMode

modeArguments - additional arguments such as headers to capture

getHealth

boolean getHealth()

Check Hoverfly is healthy

Returns:

the status of Hoverfly

custom

static HoverflyClient.Builder custom()

Static factory method for creating a HoverflyClient.Builder

Returns:

a builder for HoverflyClient

createDefault

static HoverflyClient createDefault()

Static factory method for default Hoverfly client

Returns:

a default HoverflyClient