Package org.mockserver.model

Class HttpSseResponse

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.Action<HttpSseResponse>

org.mockserver.model.HttpSseResponse

public class HttpSseResponse
extends Action<HttpSseResponse>

Nested Class Summary

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

Action.Direction, Action.Type

Constructor Summary

Constructors

Constructor	Description
HttpSseResponse()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getCloseConnection()
List<SseEvent>	getEvents()
Headers	getHeaders()
Integer	getStatusCode()
HttpTemplate.TemplateType	getTemplateType()
Action.Type	getType()
int	hashCode()
static HttpSseResponse	sseResponse()
HttpSseResponse	withCloseConnection(Boolean closeConnection)
HttpSseResponse	withEvent(SseEvent event)
HttpSseResponse	withEvents(List<SseEvent> events)
HttpSseResponse	withEvents(SseEvent... events)
HttpSseResponse	withHeader(String name, String... values)
HttpSseResponse	withHeader(Header header)
HttpSseResponse	withHeaders(Headers headers)
HttpSseResponse	withStatusCode(Integer statusCode)
HttpSseResponse	withTemplateType(HttpTemplate.TemplateType templateType)	Opt-in response templating: when set (to HttpTemplate.TemplateType.VELOCITY, HttpTemplate.TemplateType.MUSTACHE or HttpTemplate.TemplateType.JAVASCRIPT), each event's data payload 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 emitted 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

HttpSseResponse

public HttpSseResponse()

Method Details

sseResponse

public static HttpSseResponse sseResponse()

withStatusCode

public HttpSseResponse withStatusCode(Integer statusCode)

getStatusCode

public Integer getStatusCode()

withHeaders

public HttpSseResponse withHeaders(Headers headers)

withHeader

public HttpSseResponse withHeader(Header header)

withHeader

public HttpSseResponse withHeader(String name,
 String... values)

getHeaders

public Headers getHeaders()

withEvents

public HttpSseResponse withEvents(List<SseEvent> events)

withEvents

public HttpSseResponse withEvents(SseEvent... events)

withEvent

public HttpSseResponse withEvent(SseEvent event)

getEvents

public List<SseEvent> getEvents()

withCloseConnection

public HttpSseResponse withCloseConnection(Boolean closeConnection)

getCloseConnection

public Boolean getCloseConnection()

withTemplateType

public HttpSseResponse withTemplateType(HttpTemplate.TemplateType templateType)

Opt-in response templating: when set (to HttpTemplate.TemplateType.VELOCITY, HttpTemplate.TemplateType.MUSTACHE or HttpTemplate.TemplateType.JAVASCRIPT), each event's data payload 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 emitted verbatim. The template is rendered once per event, immediately before the event is written.

When null (the default) every event is emitted 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<HttpSseResponse>

equals

public boolean equals(Object o)

Overrides:

equals in class Action<HttpSseResponse>

hashCode

public int hashCode()

Overrides:

hashCode in class Action<HttpSseResponse>