Package com.github.tomakehurst.wiremock.http

Class ResponseDefinition

java.lang.Object

com.github.tomakehurst.wiremock.http.ResponseDefinition

public class ResponseDefinition
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponseDefinition.Builder

Constructor Summary

Constructors

Constructor	Description
ResponseDefinition(int status, String statusMessage, Body body, String bodyFileName, HttpHeaders headers, HttpHeaders additionalProxyRequestHeaders, List<String> removeProxyRequestHeaders, Integer fixedDelayMilliseconds, DelayDistribution delayDistribution, ChunkedDribbleDelay chunkedDribbleDelay, @Nullable String proxyBaseUrl, @Nullable org.wiremock.url.Path proxyUrlPrefixToRemove, Fault fault, List<String> transformers, Parameters transformerParameters, @Nullable org.wiremock.url.AbsoluteUrl browserProxyUrl, Boolean wasConfigured)
ResponseDefinition(int status, String statusMessage, String body, com.fasterxml.jackson.databind.JsonNode jsonBody, String base64Body, String bodyFileName, HttpHeaders headers, HttpHeaders additionalProxyRequestHeaders, List<String> removeProxyRequestHeaders, Integer fixedDelayMilliseconds, DelayDistribution delayDistribution, ChunkedDribbleDelay chunkedDribbleDelay, String proxyBaseUrl, String proxyUrlPrefixToRemove, Fault fault, List<String> transformers, Parameters transformerParameters, Boolean wasConfigured)

Method Summary

Modifier and Type	Method	Description
static ResponseDefinition	badRequest(Errors errors)
static ResponseDefinition	badRequestEntity(Errors errors)
static ResponseDefinition	browserProxy(Request originalRequest)
ResponseDefinition	copy()
static ResponseDefinition	copyOf(ResponseDefinition original)
static ResponseDefinition	created()
boolean	equals(Object o)
@NonNull HttpHeaders	getAdditionalProxyRequestHeaders()
String	getBase64Body()
String	getBody()
String	getBodyFileName()
@Nullable org.wiremock.url.AbsoluteUrl	getBrowserProxyUrl()
byte[]	getByteBody()
byte[]	getByteBodyIfBinary()
ChunkedDribbleDelay	getChunkedDribbleDelay()
DelayDistribution	getDelayDistribution()
Fault	getFault()
Integer	getFixedDelayMilliseconds()
@NonNull HttpHeaders	getHeaders()
com.fasterxml.jackson.databind.JsonNode	getJsonBody()
@Nullable String	getProxyBaseUrl()
@Nullable org.wiremock.url.Path	getProxyUrlPrefixToRemove()
@NonNull List<String>	getRemoveProxyRequestHeaders()
Body	getReponseBody()
int	getStatus()
String	getStatusMessage()
String	getTextBody()
@NonNull Parameters	getTransformerParameters()
@NonNull List<String>	getTransformers()
int	hashCode()
boolean	hasTransformer(Extension transformer)
Boolean	isFromConfiguredStub()
boolean	isProxyResponse()
static ResponseDefinition	noContent()
static ResponseDefinition	notAuthorised()
static ResponseDefinition	notConfigured()
static ResponseDefinition	notFound()
static ResponseDefinition	notPermitted(Errors errors)
static ResponseDefinition	notPermitted(String message)
static ResponseDefinition	ok()
static ResponseDefinition	okEmptyJson()
static <T> ResponseDefinition	okForJson(T body)
static ResponseDefinition	redirectTo(String path)
static ResponseDefinition	serverError()
boolean	specifiesBinaryBodyContent()
boolean	specifiesBodyContent()
boolean	specifiesBodyFile()
boolean	specifiesTextBodyContent()
ResponseDefinition.Builder	toBuilder()
String	toString()
ResponseDefinition	transform(Consumer<ResponseDefinition.Builder> transformer)
boolean	wasConfigured()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ResponseDefinition

public ResponseDefinition(int status,
 String statusMessage,
 String body,
 com.fasterxml.jackson.databind.JsonNode jsonBody,
 String base64Body,
 String bodyFileName,
 HttpHeaders headers,
 HttpHeaders additionalProxyRequestHeaders,
 List<String> removeProxyRequestHeaders,
 Integer fixedDelayMilliseconds,
 DelayDistribution delayDistribution,
 ChunkedDribbleDelay chunkedDribbleDelay,
 String proxyBaseUrl,
 String proxyUrlPrefixToRemove,
 Fault fault,
 List<String> transformers,
 Parameters transformerParameters,
 Boolean wasConfigured)

ResponseDefinition

public ResponseDefinition(int status,
 String statusMessage,
 Body body,
 String bodyFileName,
 HttpHeaders headers,
 HttpHeaders additionalProxyRequestHeaders,
 List<String> removeProxyRequestHeaders,
 Integer fixedDelayMilliseconds,
 DelayDistribution delayDistribution,
 ChunkedDribbleDelay chunkedDribbleDelay,
 @Nullable String proxyBaseUrl,
 @Nullable org.wiremock.url.Path proxyUrlPrefixToRemove,
 Fault fault,
 List<String> transformers,
 Parameters transformerParameters,
 @Nullable org.wiremock.url.AbsoluteUrl browserProxyUrl,
 Boolean wasConfigured)

Method Details

notFound

public static ResponseDefinition notFound()

ok

public static ResponseDefinition ok()

okEmptyJson

public static ResponseDefinition okEmptyJson()

okForJson

public static <T> ResponseDefinition okForJson(T body)

created

public static ResponseDefinition created()

noContent

public static ResponseDefinition noContent()

badRequest

public static ResponseDefinition badRequest(Errors errors)

badRequestEntity

public static ResponseDefinition badRequestEntity(Errors errors)

redirectTo

public static ResponseDefinition redirectTo(String path)

notConfigured

public static ResponseDefinition notConfigured()

notAuthorised

public static ResponseDefinition notAuthorised()

notPermitted

public static ResponseDefinition notPermitted(String message)

notPermitted

public static ResponseDefinition notPermitted(Errors errors)

serverError

public static ResponseDefinition serverError()

browserProxy

public static ResponseDefinition browserProxy(Request originalRequest)

copyOf

public static ResponseDefinition copyOf(ResponseDefinition original)

copy

public ResponseDefinition copy()

transform

public ResponseDefinition transform(Consumer<ResponseDefinition.Builder> transformer)

toBuilder

public ResponseDefinition.Builder toBuilder()

getHeaders

public @NonNull HttpHeaders getHeaders()

getAdditionalProxyRequestHeaders

public @NonNull HttpHeaders getAdditionalProxyRequestHeaders()

getRemoveProxyRequestHeaders

public @NonNull List<String> getRemoveProxyRequestHeaders()

getStatus

public int getStatus()

getStatusMessage

public String getStatusMessage()

getBody

public String getBody()

getTextBody

public String getTextBody()

getByteBody

public byte[] getByteBody()

getByteBodyIfBinary

public byte[] getByteBodyIfBinary()

getBase64Body

public String getBase64Body()

getReponseBody

public Body getReponseBody()

getJsonBody

public com.fasterxml.jackson.databind.JsonNode getJsonBody()

getBodyFileName

public String getBodyFileName()

wasConfigured

public boolean wasConfigured()

isFromConfiguredStub

public Boolean isFromConfiguredStub()

getFixedDelayMilliseconds

public Integer getFixedDelayMilliseconds()

getDelayDistribution

public DelayDistribution getDelayDistribution()

getChunkedDribbleDelay

public ChunkedDribbleDelay getChunkedDribbleDelay()

getProxyBaseUrl

public @Nullable String getProxyBaseUrl()

getProxyUrlPrefixToRemove

public @Nullable org.wiremock.url.Path getProxyUrlPrefixToRemove()

specifiesBodyFile

public boolean specifiesBodyFile()

specifiesBodyContent

public boolean specifiesBodyContent()

specifiesTextBodyContent

public boolean specifiesTextBodyContent()

specifiesBinaryBodyContent

public boolean specifiesBinaryBodyContent()

isProxyResponse

public boolean isProxyResponse()

getBrowserProxyUrl

public @Nullable org.wiremock.url.AbsoluteUrl getBrowserProxyUrl()

getFault

public Fault getFault()

getTransformers

public @NonNull List<String> getTransformers()

getTransformerParameters

public @NonNull Parameters getTransformerParameters()

hasTransformer

public boolean hasTransformer(Extension transformer)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object