Package org.mockserver.model

Class CaptureRule

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.CaptureRule

public class CaptureRule
extends ObjectWithReflectiveEqualsHashCodeToString

Declarative capture rule (WS2.2): when an expectation matches an incoming request, each capture rule extracts a value from the request and stores it into scenario state under the into name, so a later request's response template can read it back via scenario.get(name) (WS2.1).

A rule has three parts:

• source — where in the request to look (jsonPath, xpath, header, queryStringParameter, cookie, pathParameter).
• expression — the selector evaluated against that source (a JSONPath / XPath expression, or a header / parameter / cookie name).
• into — the scenario name whose state is set to the captured value.

This enables realistic auth→resource→confirm journeys without manual scenario-trigger calls.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CaptureRule.Source	The part of the request a capture rule reads from.

Constructor Summary

Constructors

Constructor	Description
CaptureRule()

Method Summary

Modifier and Type	Method	Description
static CaptureRule	capture(CaptureRule.Source source, String expression, String into)
static CaptureRule	captureRule()
String	getExpression()
String	getInto()
CaptureRule.Source	getSource()
CaptureRule	withExpression(String expression)
CaptureRule	withInto(String into)
CaptureRule	withSource(CaptureRule.Source source)

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

equals, fieldsExcludedFromEqualsAndHashCode, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Details

CaptureRule

public CaptureRule()

Method Details

captureRule

public static CaptureRule captureRule()

capture

public static CaptureRule capture(CaptureRule.Source source,
 String expression,
 String into)

getSource

public CaptureRule.Source getSource()

withSource

public CaptureRule withSource(CaptureRule.Source source)

getExpression

public String getExpression()

withExpression

public CaptureRule withExpression(String expression)

getInto

public String getInto()

withInto

public CaptureRule withInto(String into)