Package org.mockserver.model

Class ConditionalRequestDefinition

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Not

org.mockserver.model.RequestDefinition

org.mockserver.model.ConditionalRequestDefinition

public class ConditionalRequestDefinition
extends RequestDefinition

A conditional (if-then-else) request matcher.

Unlike the default AND-only matching (where every field of a single HttpRequest must match), a conditional matcher evaluates one of two branches depending on whether a guard request definition matches:

   if (ifMatches.matches(request)) {
       require thenMatches.matches(request)
   } else {
       require elseMatches.matches(request)   // when elseMatches is absent the
                                              // expectation matches whenever the
                                              // guard is false
   }
 

Each branch reuses the existing RequestDefinition matching machinery, so any request definition (an HttpRequest, an OpenAPIDefinition, even a nested ConditionalRequestDefinition) may be used as the if, then or else branch.

This construct is entirely additive and opt-in: existing AND-only expectations are unchanged.

Author:

jamesdbloom

Constructor Summary

Constructors

Constructor	Description
ConditionalRequestDefinition()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RequestDefinition	getElse()
RequestDefinition	getIf()
RequestDefinition	getThen()
int	hashCode()
static ConditionalRequestDefinition	requestIf(RequestDefinition ifMatches)
static ConditionalRequestDefinition	requestIf(RequestDefinition ifMatches, RequestDefinition thenMatches)
static ConditionalRequestDefinition	requestIf(RequestDefinition ifMatches, RequestDefinition thenMatches, RequestDefinition elseMatches)
ConditionalRequestDefinition	shallowClone()
ConditionalRequestDefinition	withElse(RequestDefinition elseMatches)
ConditionalRequestDefinition	withIf(RequestDefinition ifMatches)
ConditionalRequestDefinition	withThen(RequestDefinition thenMatches)

Methods inherited from class org.mockserver.model.RequestDefinition

cloneWithLogCorrelationId, getLogCorrelationId, getReceivedTimestamp, withLogCorrelationId, withReceivedTimestamp

Methods inherited from class org.mockserver.model.Not

getNot, isNot, not, not, setNot, withNot

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

ConditionalRequestDefinition

public ConditionalRequestDefinition()

Method Details

requestIf

public static ConditionalRequestDefinition requestIf(RequestDefinition ifMatches)

requestIf

public static ConditionalRequestDefinition requestIf(RequestDefinition ifMatches,
 RequestDefinition thenMatches)

requestIf

public static ConditionalRequestDefinition requestIf(RequestDefinition ifMatches,
 RequestDefinition thenMatches,
 RequestDefinition elseMatches)

getIf

public RequestDefinition getIf()

withIf

public ConditionalRequestDefinition withIf(RequestDefinition ifMatches)

getThen

public RequestDefinition getThen()

withThen

public ConditionalRequestDefinition withThen(RequestDefinition thenMatches)

getElse

public RequestDefinition getElse()

withElse

public ConditionalRequestDefinition withElse(RequestDefinition elseMatches)

shallowClone

public ConditionalRequestDefinition shallowClone()

Specified by:

shallowClone in class RequestDefinition

equals

public boolean equals(Object o)

Overrides:

equals in class RequestDefinition

hashCode

public int hashCode()

Overrides:

hashCode in class RequestDefinition