Mokksy/dev.mokksy.mokksy/JavaBuildingStep/respondsWithSseStream

respondsWithSseStream

fun <T : Any> respondsWithSseStream(dataType: Class<T>, configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, ServerSentEventMetadata<T>>>): StubHandle(source)

Configures a typed SSE streaming response for this stub.

The dataType parameter represents the type of the data field in each ServerSentEventMetadata event. The consumer receives a JavaStreamingResponseDefinitionBuilder parameterised over ServerSentEventMetadata<T>, so chunks should be ServerSentEvent or TypedServerSentEvent instances.

Example (Java):

mokksy.get(spec -> spec.path("/sse"))
      .respondsWithSseStream(String.class, builder -> builder
          .chunk(new ServerSentEvent("Hello", null, null, null, null))
          .chunk(new ServerSentEvent("World", null, null, null, null)));

Return

A StubHandle for further inspection (e.g. StubHandle.matchCount).

Parameters

dataType

The Java Class of the SSE event data type.

configurer

A Consumer that configures a JavaStreamingResponseDefinitionBuilder.

Type Parameters

The type of the data field in each SSE event.

fun respondsWithSseStream(configurer: Consumer<JavaStreamingResponseDefinitionBuilder<P, ServerSentEventMetadata<String>>>): StubHandle(source)

Configures an SSE streaming response for this stub with ServerSentEventMetadata<String> chunks.

Shorthand for respondsWithSseStream(String.class, configurer).

Return

A StubHandle for further inspection (e.g. StubHandle.matchCount).

Parameters

configurer

A Consumer that configures a JavaStreamingResponseDefinitionBuilder.