Package org.mockserver.model

Class HttpOverrideForwardedRequest

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Action<HttpOverrideForwardedRequest>

org.mockserver.model.HttpOverrideForwardedRequest

public class HttpOverrideForwardedRequest
extends Action<HttpOverrideForwardedRequest>

Author:

jamesdbloom

Nested Class Summary

Nested classes/interfaces inherited from class org.mockserver.model.Action

Action.Direction, Action.Type

Constructor Summary

Constructors

Constructor	Description
HttpOverrideForwardedRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static HttpOverrideForwardedRequest	forwardOverriddenRequest()	Static builder which will allow overriding proxied request with the specified request.
static HttpOverrideForwardedRequest	forwardOverriddenRequest(HttpRequest httpRequest)	Static builder which will allow overriding proxied request with the specified request.
static HttpOverrideForwardedRequest	forwardOverriddenRequest(HttpRequest httpRequest, HttpRequestModifier requestModifier)	Static builder which will allow overriding or modifying proxied request with the specified request.
static HttpOverrideForwardedRequest	forwardOverriddenRequest(HttpRequest httpRequest, HttpRequestModifier requestModifier, HttpResponse httpResponse, HttpResponseModifier responseModifier)	Static builder which will allow overriding proxied request with the specified request.
static HttpOverrideForwardedRequest	forwardOverriddenRequest(HttpRequest httpRequest, HttpResponse httpResponse)	Static builder which will allow overriding proxied request with the specified request.
HttpRequestModifier	getRequestModifier()
HttpRequest	getRequestOverride()
HttpResponseModifier	getResponseModifier()
HttpResponse	getResponseOverride()
HttpTemplate	getResponseTemplate()
Action.Type	getType()
int	hashCode()
HttpOverrideForwardedRequest	withRequestModifier(HttpRequestModifier requestModifier)	Allow path, query parameters, headers and cookies to be modified
HttpOverrideForwardedRequest	withRequestOverride(HttpRequest httpRequest)	All fields, headers, cookies, etc of the provided request will be overridden
HttpOverrideForwardedRequest	withResponseModifier(HttpResponseModifier responseModifier)	Allow headers and cookies to be modified
HttpOverrideForwardedRequest	withResponseOverride(HttpResponse httpResponse)	All fields, headers, cookies, etc of the provided response will be overridden
HttpOverrideForwardedRequest	withResponseTemplate(HttpTemplate responseTemplate)	Template to transform the response using request and response context

Methods inherited from class org.mockserver.model.Action

getDelay, getExpectationId, isPrimary, setExpectationId, withDelay, withDelay, withPrimary

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpOverrideForwardedRequest

public HttpOverrideForwardedRequest()

Method Detail

forwardOverriddenRequest

public static HttpOverrideForwardedRequest forwardOverriddenRequest()

Static builder which will allow overriding proxied request with the specified request.

forwardOverriddenRequest

public static HttpOverrideForwardedRequest forwardOverriddenRequest(HttpRequest httpRequest)

Static builder which will allow overriding proxied request with the specified request.

Parameters:

httpRequest - the HttpRequest specifying what to override

forwardOverriddenRequest

public static HttpOverrideForwardedRequest forwardOverriddenRequest(HttpRequest httpRequest,
                                                                    HttpRequestModifier requestModifier)

Static builder which will allow overriding or modifying proxied request with the specified request.

Parameters:

httpRequest - the HttpRequest specifying what to override

requestModifier - what to modify in the request

forwardOverriddenRequest

public static HttpOverrideForwardedRequest forwardOverriddenRequest(HttpRequest httpRequest,
                                                                    HttpResponse httpResponse)

Static builder which will allow overriding proxied request with the specified request.

Parameters:

httpRequest - the HttpRequest specifying what to override

httpResponse - the HttpRequest specifying what to override

forwardOverriddenRequest

public static HttpOverrideForwardedRequest forwardOverriddenRequest(HttpRequest httpRequest,
                                                                    HttpRequestModifier requestModifier,
                                                                    HttpResponse httpResponse,
                                                                    HttpResponseModifier responseModifier)

Static builder which will allow overriding proxied request with the specified request.

Parameters:

httpRequest - the HttpRequest specifying what to override

requestModifier - what to modify in the request

httpResponse - the HttpRequest specifying what to override

responseModifier - what to modify in the response

getRequestOverride

public HttpRequest getRequestOverride()

withRequestOverride

public HttpOverrideForwardedRequest withRequestOverride(HttpRequest httpRequest)

All fields, headers, cookies, etc of the provided request will be overridden

Parameters:

httpRequest - the HttpRequest specifying what to override

getRequestModifier

public HttpRequestModifier getRequestModifier()

withRequestModifier

public HttpOverrideForwardedRequest withRequestModifier(HttpRequestModifier requestModifier)

Allow path, query parameters, headers and cookies to be modified

Parameters:

requestModifier - what to modify

getResponseOverride

public HttpResponse getResponseOverride()

withResponseOverride

public HttpOverrideForwardedRequest withResponseOverride(HttpResponse httpResponse)

All fields, headers, cookies, etc of the provided response will be overridden

Parameters:

httpResponse - the HttpResponse specifying what to override

getResponseModifier

public HttpResponseModifier getResponseModifier()

withResponseModifier

public HttpOverrideForwardedRequest withResponseModifier(HttpResponseModifier responseModifier)

Allow headers and cookies to be modified

Parameters:

responseModifier - what to modify

getResponseTemplate

public HttpTemplate getResponseTemplate()

withResponseTemplate

public HttpOverrideForwardedRequest withResponseTemplate(HttpTemplate responseTemplate)

Template to transform the response using request and response context

Parameters:

responseTemplate - the template to use for transforming the response

getType

public Action.Type getType()

Specified by:

getType in class Action<HttpOverrideForwardedRequest>

equals

public boolean equals(Object o)

Overrides:

equals in class Action<HttpOverrideForwardedRequest>

hashCode

public int hashCode()

Overrides:

hashCode in class Action<HttpOverrideForwardedRequest>