Package org.mockserver.model

Class ExpectationStep

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.ExpectationStep

public class ExpectationStep
extends ObjectWithJsonToString

Represents a single step in an ordered multi-action expectation pipeline.

Each step carries exactly ONE action target and a responder flag. Steps without responder = true are side-effects (like beforeActions: fire-and-forget webhooks/callbacks). Exactly one step in the list must be marked as the responder; that step's action produces the HTTP response.

Side-effect targets (responder = false)

• httpRequest — webhook (HTTP call to an external URL)
• httpClassCallback — server-side class callback
• httpObjectCallback — WebSocket object callback
• httpForward — side-effect forward (response discarded)
• httpOverrideForwardedRequest — side-effect forward-replace

Responder targets (responder = true)

• httpResponse — static response
• httpForward — proxy forward (response returned to client)
• httpOverrideForwardedRequest — forward-replace (response returned)
• httpClassCallback — class callback response
• httpObjectCallback — object callback response
• httpError — connection-level error (cannot combine with other steps)

Side-effect step controls

• blocking — when true (default) the pipeline waits for completion
• timeout — max wait for a blocking side-effect
• failurePolicy — FAIL_FAST or BEST_EFFORT on failure/timeout

Constructor Summary

Constructors

Constructor	Description
ExpectationStep()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getBlocking()	Side-effect steps only: when true (the default when unset) the pipeline waits for this step to complete before proceeding; when false the step is started but not awaited.
Delay	getDelay()
FailurePolicy	getFailurePolicy()	Side-effect steps only: what to do when a blocking step fails or times out.
HttpClassCallback	getHttpClassCallback()
HttpError	getHttpError()
HttpForward	getHttpForward()
HttpObjectCallback	getHttpObjectCallback()
HttpOverrideForwardedRequest	getHttpOverrideForwardedRequest()
HttpRequest	getHttpRequest()
HttpResponse	getHttpResponse()
Boolean	getResponder()
Delay	getTimeout()	Side-effect steps only: maximum time to wait for a blocking step.
int	hashCode()
static ExpectationStep	step()
ExpectationStep	withBlocking(Boolean blocking)
ExpectationStep	withDelay(Delay delay)
ExpectationStep	withFailurePolicy(FailurePolicy failurePolicy)
ExpectationStep	withHttpClassCallback(HttpClassCallback httpClassCallback)
ExpectationStep	withHttpError(HttpError httpError)
ExpectationStep	withHttpForward(HttpForward httpForward)
ExpectationStep	withHttpObjectCallback(HttpObjectCallback httpObjectCallback)
ExpectationStep	withHttpOverrideForwardedRequest(HttpOverrideForwardedRequest httpOverrideForwardedRequest)
ExpectationStep	withHttpRequest(HttpRequest httpRequest)
ExpectationStep	withHttpResponse(HttpResponse httpResponse)
ExpectationStep	withResponder(Boolean responder)
ExpectationStep	withTimeout(Delay timeout)

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 Details

ExpectationStep

public ExpectationStep()

Method Details

step

public static ExpectationStep step()

getHttpRequest

public HttpRequest getHttpRequest()

withHttpRequest

public ExpectationStep withHttpRequest(HttpRequest httpRequest)

getHttpClassCallback

public HttpClassCallback getHttpClassCallback()

withHttpClassCallback

public ExpectationStep withHttpClassCallback(HttpClassCallback httpClassCallback)

getHttpObjectCallback

public HttpObjectCallback getHttpObjectCallback()

withHttpObjectCallback

public ExpectationStep withHttpObjectCallback(HttpObjectCallback httpObjectCallback)

getHttpForward

public HttpForward getHttpForward()

withHttpForward

public ExpectationStep withHttpForward(HttpForward httpForward)

getHttpOverrideForwardedRequest

public HttpOverrideForwardedRequest getHttpOverrideForwardedRequest()

withHttpOverrideForwardedRequest

public ExpectationStep withHttpOverrideForwardedRequest(HttpOverrideForwardedRequest httpOverrideForwardedRequest)

getHttpResponse

public HttpResponse getHttpResponse()

withHttpResponse

public ExpectationStep withHttpResponse(HttpResponse httpResponse)

getHttpError

public HttpError getHttpError()

withHttpError

public ExpectationStep withHttpError(HttpError httpError)

getResponder

public Boolean getResponder()

withResponder

public ExpectationStep withResponder(Boolean responder)

getDelay

public Delay getDelay()

withDelay

public ExpectationStep withDelay(Delay delay)

getBlocking

public Boolean getBlocking()

Side-effect steps only: when true (the default when unset) the pipeline waits for this step to complete before proceeding; when false the step is started but not awaited. Ignored for responder steps.

withBlocking

public ExpectationStep withBlocking(Boolean blocking)

getTimeout

public Delay getTimeout()

Side-effect steps only: maximum time to wait for a blocking step.

withTimeout

public ExpectationStep withTimeout(Delay timeout)

getFailurePolicy

public FailurePolicy getFailurePolicy()

Side-effect steps only: what to do when a blocking step fails or times out.

withFailurePolicy

public ExpectationStep withFailurePolicy(FailurePolicy failurePolicy)

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString