io.specto.hoverfly.junit.dsl

Class ResponseBuilder

java.lang.Object

io.specto.hoverfly.junit.dsl.ResponseBuilder

public class ResponseBuilder
extends java.lang.Object

A builder for building Response

See Also:

ResponseCreators

Method Summary

Modifier and Type	Method and Description
ResponseBuilder	andRemoveState(java.lang.String stateToRemove) Sets state to be removed
ResponseBuilder	andSetState(java.lang.String key, java.lang.String value) Sets a transition state
ResponseBuilder	body(HttpBodyConverter httpBodyConverter)
ResponseBuilder	body(java.lang.String body) Sets the body
ResponseBuilder	disableTemplating()
ResponseBuilder	header(java.lang.String key, java.lang.String value) Sets a header
static ResponseBuilder	response() Deprecated.
ResponseBuilder	status(int status) Sets the status
ResponseBuilder	withDelay(int delay, java.util.concurrent.TimeUnit delayTimeUnit) Deprecated.
ResponseBuilder	withFixedDelay(int delay, java.util.concurrent.TimeUnit delayTimeUnit) Set fixed delay for the request-response pair
ResponseBuilder	withLogNormalDelay(int mean, int median, int min, int max, java.util.concurrent.TimeUnit delayTimeUnit) Set Log Normal delay for the request-response pair.
ResponseBuilder	withLogNormalDelay(int mean, int median, java.util.concurrent.TimeUnit delayTimeUnit) Set Log Normal delay for the request-response pair.

Methods inherited from class java.lang.Object

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

Method Detail

response

@Deprecated
public static ResponseBuilder response()

Deprecated.

Instantiates a new instance

Returns:

the builder

body

public ResponseBuilder body(java.lang.String body)

Sets the body

Parameters:

body - body of the response

Returns:

the for further customizations

status

public ResponseBuilder status(int status)

Sets the status

Parameters:

status - status of the response

Returns:

the for further customizations

header

public ResponseBuilder header(java.lang.String key,
                              java.lang.String value)

Sets a header

Parameters:

key - header name

value - header value

Returns:

the for further customizations

andSetState

public ResponseBuilder andSetState(java.lang.String key,
                                   java.lang.String value)

Sets a transition state

Parameters:

key - state key

value - state value

Returns:

the for further customizations

andRemoveState

public ResponseBuilder andRemoveState(java.lang.String stateToRemove)

Sets state to be removed

Parameters:

stateToRemove - a state to be removed

Returns:

the for further customizations

body

public ResponseBuilder body(HttpBodyConverter httpBodyConverter)

disableTemplating

public ResponseBuilder disableTemplating()

withFixedDelay

public ResponseBuilder withFixedDelay(int delay,
                                      java.util.concurrent.TimeUnit delayTimeUnit)

Set fixed delay for the request-response pair

Parameters:

delay - amount of delay

delayTimeUnit - time unit of delay (e.g. SECONDS)

Returns:

the for further customizations

withLogNormalDelay

public ResponseBuilder withLogNormalDelay(int mean,
                                          int median,
                                          java.util.concurrent.TimeUnit delayTimeUnit)

Set Log Normal delay for the request-response pair. The delay value will be generated randomly based on the distribution which is defined by 2 parameters μ and σ. We will compute these parameters from the mean and median of a server response time. You can typically find these values in your monitoring of the production server.

Parameters:

mean - mean value of the delays to simulate

median - median value of the delays to simulate

delayTimeUnit - time unit of delay (e.g. SECONDS)

Returns:

the for further customizations

withLogNormalDelay

public ResponseBuilder withLogNormalDelay(int mean,
                                          int median,
                                          int min,
                                          int max,
                                          java.util.concurrent.TimeUnit delayTimeUnit)

Set Log Normal delay for the request-response pair. The delay value will be generated randomly based on the distribution which is defined by 2 parameters μ and σ. We will compute these parameters from the mean and median of a server response time. You can typically find these values in your monitoring of the production server.

Parameters:

mean - mean value of the delays to simulate

median - median value of the delays to simulate

min - lower bound of the delays

max - upper bound of the delays

delayTimeUnit - time unit of delay (e.g. SECONDS)

Returns:

the for further customizations

withDelay

@Deprecated
public ResponseBuilder withDelay(int delay,
                                             java.util.concurrent.TimeUnit delayTimeUnit)

Deprecated.

Sets delay parameters.

Parameters:

delay - amount of delay

delayTimeUnit - time unit of delay (e.g. SECONDS)

Returns:

the for further customizations