Package org.mockserver.mock.breakpoint

Class StreamFrameDecision

java.lang.Object

org.mockserver.mock.breakpoint.StreamFrameDecision

public class StreamFrameDecision
extends Object

The resolution decision for a paused (breakpointed) streaming response frame.

Five actions are supported:

• StreamFrameDecision.Action.CONTINUE — write the original frame as-is
• StreamFrameDecision.Action.MODIFY — write a replacement frame body
• StreamFrameDecision.Action.DROP — discard the frame (do not write to client)
• StreamFrameDecision.Action.INJECT — write the original frame AND an additional injected frame
• StreamFrameDecision.Action.CLOSE — end the stream (send LastHttpContent, close connection)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StreamFrameDecision.Action

Method Summary

Modifier and Type	Method	Description
static StreamFrameDecision	close()	Close: end the stream (drop the held frame, send LastHttpContent, close the connection).
static StreamFrameDecision	continueFrame()	Continue: write the original frame unchanged.
static StreamFrameDecision	drop()	Drop: discard the frame without writing anything to the client.
StreamFrameDecision.Action	getAction()
byte[]	getInjectedBody()	The injected body (non-null only for StreamFrameDecision.Action.INJECT).
byte[]	getReplacementBody()	The replacement body (non-null only for StreamFrameDecision.Action.MODIFY).
static StreamFrameDecision	inject(byte[] injectedBody)	Inject: write the original frame, then also write an additional injected frame.
static StreamFrameDecision	modify(byte[] replacementBody)	Modify: write a replacement frame body instead of the original.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

continueFrame

public static StreamFrameDecision continueFrame()

Continue: write the original frame unchanged.

modify

public static StreamFrameDecision modify(byte[] replacementBody)

Modify: write a replacement frame body instead of the original.

Parameters:

replacementBody - the replacement bytes (must not be null)

drop

public static StreamFrameDecision drop()

Drop: discard the frame without writing anything to the client.

inject

public static StreamFrameDecision inject(byte[] injectedBody)

Inject: write the original frame, then also write an additional injected frame.

Parameters:

injectedBody - the extra frame body to inject after the original

close

public static StreamFrameDecision close()

Close: end the stream (drop the held frame, send LastHttpContent, close the connection).

getAction

public StreamFrameDecision.Action getAction()

getReplacementBody

public byte[] getReplacementBody()

The replacement body (non-null only for StreamFrameDecision.Action.MODIFY).

getInjectedBody

public byte[] getInjectedBody()

The injected body (non-null only for StreamFrameDecision.Action.INJECT).