Package org.mockserver.model

Class HttpWebSocketResponse

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Action<HttpWebSocketResponse>

org.mockserver.model.HttpWebSocketResponse

public class HttpWebSocketResponse
extends Action<HttpWebSocketResponse>

Nested Class Summary

Nested classes/interfaces inherited from class org.mockserver.model.Action

Action.Direction, Action.Type

Constructor Summary

Constructors

Constructor	Description
HttpWebSocketResponse()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getCloseConnection()
GraphQLBody	getGraphqlSubscriptionFilter()
List<WebSocketMessageMatcher>	getMatchers()
List<WebSocketMessage>	getMessages()
String	getSubprotocol()
HttpTemplate.TemplateType	getTemplateType()
Action.Type	getType()
int	hashCode()
static HttpWebSocketResponse	webSocketResponse()
HttpWebSocketResponse	withCloseConnection(Boolean closeConnection)
HttpWebSocketResponse	withGraphqlSubscriptionFilter(GraphQLBody filter)	Set a GraphQL subscription filter for the graphql-transport-ws protocol.
HttpWebSocketResponse	withMatcher(WebSocketMessageMatcher matcher)
HttpWebSocketResponse	withMatchers(List<WebSocketMessageMatcher> matchers)
HttpWebSocketResponse	withMatchers(WebSocketMessageMatcher... matchers)
HttpWebSocketResponse	withMessage(WebSocketMessage message)
HttpWebSocketResponse	withMessages(List<WebSocketMessage> messages)
HttpWebSocketResponse	withMessages(WebSocketMessage... messages)
HttpWebSocketResponse	withSubprotocol(String subprotocol)
HttpWebSocketResponse	withTemplateType(HttpTemplate.TemplateType templateType)	Opt-in response templating: when set (to HttpTemplate.TemplateType.VELOCITY, HttpTemplate.TemplateType.MUSTACHE or HttpTemplate.TemplateType.JAVASCRIPT), each configured text WebSocketMessage is rendered as a response template against the triggering request (so $!request.body, $jsonPath(...), the built-in helpers, the faker helper and the scenario helper are all available) rather than sent verbatim.

Methods inherited from class org.mockserver.model.Action

getDelay, getExpectationId, isPrimary, setExpectationId, withDelay, withDelay, withPrimary

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

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

Constructor Details

HttpWebSocketResponse

public HttpWebSocketResponse()

Method Details

webSocketResponse

public static HttpWebSocketResponse webSocketResponse()

withSubprotocol

public HttpWebSocketResponse withSubprotocol(String subprotocol)

getSubprotocol

public String getSubprotocol()

withMessages

public HttpWebSocketResponse withMessages(List<WebSocketMessage> messages)

withMessages

public HttpWebSocketResponse withMessages(WebSocketMessage... messages)

withMessage

public HttpWebSocketResponse withMessage(WebSocketMessage message)

getMessages

public List<WebSocketMessage> getMessages()

withMatchers

public HttpWebSocketResponse withMatchers(List<WebSocketMessageMatcher> matchers)

withMatchers

public HttpWebSocketResponse withMatchers(WebSocketMessageMatcher... matchers)

withMatcher

public HttpWebSocketResponse withMatcher(WebSocketMessageMatcher matcher)

getMatchers

public List<WebSocketMessageMatcher> getMatchers()

withCloseConnection

public HttpWebSocketResponse withCloseConnection(Boolean closeConnection)

getCloseConnection

public Boolean getCloseConnection()

withGraphqlSubscriptionFilter

public HttpWebSocketResponse withGraphqlSubscriptionFilter(GraphQLBody filter)

Set a GraphQL subscription filter for the graphql-transport-ws protocol. When the negotiated subprotocol is graphql-transport-ws or graphql-ws, incoming subscribe messages will have their query matched against this filter. On match, the configured messages are pushed as next payloads.

Parameters:

filter - the GraphQL body to match subscription queries against

Returns:

this instance for fluent chaining

getGraphqlSubscriptionFilter

public GraphQLBody getGraphqlSubscriptionFilter()

withTemplateType

public HttpWebSocketResponse withTemplateType(HttpTemplate.TemplateType templateType)

Opt-in response templating: when set (to HttpTemplate.TemplateType.VELOCITY, HttpTemplate.TemplateType.MUSTACHE or HttpTemplate.TemplateType.JAVASCRIPT), each configured text WebSocketMessage is rendered as a response template against the triggering request (so $!request.body, $jsonPath(...), the built-in helpers, the faker helper and the scenario helper are all available) rather than sent verbatim. The template is rendered once per message, immediately before the frame is written. Binary messages are never templated.

When null (the default) every message is sent byte-for-byte unchanged, exactly as before this field existed.

getTemplateType

public HttpTemplate.TemplateType getTemplateType()

getType

public Action.Type getType()

Specified by:

getType in class Action<HttpWebSocketResponse>

equals

public boolean equals(Object o)

Overrides:

equals in class Action<HttpWebSocketResponse>

hashCode

public int hashCode()

Overrides:

hashCode in class Action<HttpWebSocketResponse>