Package org.mockserver.serialization.model

Class StreamFrameDecisionDTO

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.serialization.model.StreamFrameDecisionDTO

public class StreamFrameDecisionDTO
extends ObjectWithReflectiveEqualsHashCodeToString

Client-to-server WebSocket reply carrying the resolution decision for a paused stream frame. The client sends this after receiving a PausedStreamFrameDTO and inspecting/modifying the frame.

This DTO is the frozen contract consumed by all language clients (Java, Node, Python, Ruby, Go, .NET, Rust) and the dashboard UI. Field names, types, and encoding MUST NOT change in a backward-incompatible way once shipped.

Fields

• correlationId (String) — MUST match the correlationId from the corresponding PausedStreamFrameDTO.
• action (String) — one of "CONTINUE", "MODIFY", "DROP", "INJECT", "CLOSE".
• body (String, nullable) — Base64-encoded replacement/injected frame bytes. Required for MODIFY and INJECT; ignored for CONTINUE, DROP, and CLOSE.

Action semantics

• CONTINUE — write the original frame unchanged.
• MODIFY — write the body bytes instead of the original.
• DROP — discard the frame (do not write to client/process inbound).
• INJECT — write the original frame AND an additional frame with body bytes.
• CLOSE — end the stream (drop the frame, send stream-end signal, evict remaining frames).

Encoding

The body field uses standard Base64 (RFC 4648 section 4, no line breaks).

Constructor Summary

Constructors

Constructor	Description
StreamFrameDecisionDTO()

Method Summary

Modifier and Type	Method	Description
String	getAction()
String	getBody()
String	getCorrelationId()
StreamFrameDecisionDTO	setAction(String action)
StreamFrameDecisionDTO	setBody(String body)
StreamFrameDecisionDTO	setCorrelationId(String correlationId)

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

StreamFrameDecisionDTO

public StreamFrameDecisionDTO()

Method Details

getCorrelationId

public String getCorrelationId()

setCorrelationId

public StreamFrameDecisionDTO setCorrelationId(String correlationId)

getAction

public String getAction()

setAction

public StreamFrameDecisionDTO setAction(String action)

getBody

public String getBody()

setBody

public StreamFrameDecisionDTO setBody(String body)