Package org.mockserver.serialization.model

Class PausedStreamFrameDTO

java.lang.Object
org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString
org.mockserver.serialization.model.PausedStreamFrameDTO
public class PausedStreamFrameDTO extends ObjectWithReflectiveEqualsHashCodeToString
Server-to-client WebSocket message carrying a paused stream frame for interactive breakpoint resolution. Sent to the owning callback client when a stream-frame breakpoint matches and the breakpoint matcher has a non-null clientId.

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) — unique ID for this paused frame; the client MUST echo it in the reply.
  • streamId (String) — the stream this frame belongs to (multiple frames from the same forwarded response share the same streamId).
  • sequenceNumber (int) — 0-based monotonic index within the stream. Frames MUST be resolved in order.
  • direction (String) — "INBOUND" (client-to-server) or "OUTBOUND" (server-to-client).
  • phase (String) — "RESPONSE_STREAM" or "INBOUND_STREAM".
  • body (String) — the frame payload encoded as Base64 (frames are arbitrary bytes: gRPC length-prefixed, WebSocket text/binary, SSE/chunked).
  • requestMethod (String, nullable) — the HTTP method of the original request.
  • requestPath (String, nullable) — the path of the original request.

Encoding

The body field uses standard Base64 (RFC 4648 section 4, no line breaks). Clients decode with their platform's standard Base64 decoder.