Package org.mockserver.closurecallback.websocketregistry

Class WebSocketClientRegistry

java.lang.Object

org.mockserver.closurecallback.websocketregistry.WebSocketClientRegistry

public class WebSocketClientRegistry
extends Object

Author:

jamesdbloom

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebSocketClientRegistry.StreamFrameDecisionCallback	Callback interface for stream-frame breakpoint decision replies received over the callback WebSocket.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BREAKPOINT_ID_HEADER_NAME	Header name carrying the matched breakpoint id so the client can route each pushed paused item to the handler of the SPECIFIC breakpoint that matched.
static final String	REQUEST_TIMESTAMP_HEADER_NAME	Header name carrying the epoch-millis timestamp of when MockServer first received the request.
static final String	WEB_SOCKET_CORRELATION_ID_HEADER_NAME
static final io.netty.util.AttributeKey<WebSocketClientRegistry>	WS_REGISTRY_KEY	Channel attribute key for the per-server WebSocketClientRegistry.

Constructor Summary

Constructors

Constructor	Description
WebSocketClientRegistry(Configuration configuration, MockServerLogger mockServerLogger)

Method Summary

Modifier and Type	Method	Description
void	receivedTextWebSocketFrame(io.netty.handler.codec.http.websocketx.TextWebSocketFrame textWebSocketFrame)
void	registerClient(String clientId, io.netty.channel.ChannelHandlerContext ctx)
void	registerForwardCallbackHandler(String webSocketCorrelationId, WebSocketRequestCallback expectationForwardCallback)
void	registerResponseCallbackHandler(String webSocketCorrelationId, WebSocketResponseCallback expectationResponseCallback)
void	registerStreamFrameCallbackHandler(String correlationId, WebSocketClientRegistry.StreamFrameDecisionCallback callback)
void	reset()
boolean	sendClientMessage(String clientId, HttpRequest httpRequest, HttpResponse httpResponse)
boolean	sendStreamFrameMessage(String clientId, PausedStreamFrameDTO pausedFrameDTO)	Send a paused stream frame DTO to the specified client over the callback WebSocket.
int	size()
void	unregisterClient(String clientId)
void	unregisterForwardCallbackHandler(String webSocketCorrelationId)
void	unregisterResponseCallbackHandler(String webSocketCorrelationId)
void	unregisterStreamFrameCallbackHandler(String correlationId)

Methods inherited from class java.lang.Object

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

Field Details

WEB_SOCKET_CORRELATION_ID_HEADER_NAME

public static final String WEB_SOCKET_CORRELATION_ID_HEADER_NAME

See Also:

• Constant Field Values

BREAKPOINT_ID_HEADER_NAME

public static final String BREAKPOINT_ID_HEADER_NAME

Header name carrying the matched breakpoint id so the client can route each pushed paused item to the handler of the SPECIFIC breakpoint that matched. Set by the server dispatchers on REQUEST/RESPONSE phase messages.

See Also:

• Constant Field Values

REQUEST_TIMESTAMP_HEADER_NAME

public static final String REQUEST_TIMESTAMP_HEADER_NAME

Header name carrying the epoch-millis timestamp of when MockServer first received the request. All phases (REQUEST, RESPONSE) of the same exchange share the same value, enabling the dashboard to sort exchanges by original request time rather than by WS arrival time.

See Also:

• Constant Field Values

WS_REGISTRY_KEY

public static final io.netty.util.AttributeKey<WebSocketClientRegistry> WS_REGISTRY_KEY

Channel attribute key for the per-server WebSocketClientRegistry. Set once on the parent/server channel at pipeline construction; read at hold points in Netty handlers that need the registry but do not have HttpState in direct scope.

Constructor Details

WebSocketClientRegistry

public WebSocketClientRegistry(Configuration configuration,
 MockServerLogger mockServerLogger)

Method Details

receivedTextWebSocketFrame

public void receivedTextWebSocketFrame(io.netty.handler.codec.http.websocketx.TextWebSocketFrame textWebSocketFrame)

size

public int size()

registerClient

public void registerClient(String clientId,
 io.netty.channel.ChannelHandlerContext ctx)

unregisterClient

public void unregisterClient(String clientId)

registerResponseCallbackHandler

public void registerResponseCallbackHandler(String webSocketCorrelationId,
 WebSocketResponseCallback expectationResponseCallback)

unregisterResponseCallbackHandler

public void unregisterResponseCallbackHandler(String webSocketCorrelationId)

registerForwardCallbackHandler

public void registerForwardCallbackHandler(String webSocketCorrelationId,
 WebSocketRequestCallback expectationForwardCallback)

unregisterForwardCallbackHandler

public void unregisterForwardCallbackHandler(String webSocketCorrelationId)

registerStreamFrameCallbackHandler

public void registerStreamFrameCallbackHandler(String correlationId,
 WebSocketClientRegistry.StreamFrameDecisionCallback callback)

unregisterStreamFrameCallbackHandler

public void unregisterStreamFrameCallbackHandler(String correlationId)

sendStreamFrameMessage

public boolean sendStreamFrameMessage(String clientId,
 PausedStreamFrameDTO pausedFrameDTO)

Send a paused stream frame DTO to the specified client over the callback WebSocket.

Parameters:

clientId - the target client

pausedFrameDTO - the paused frame to send

Returns:

true if the client was found and the message was sent

sendClientMessage

public boolean sendClientMessage(String clientId,
 HttpRequest httpRequest,
 HttpResponse httpResponse)

reset

public void reset()