Class RealtimeStreamSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

com.kingsrook.qqq.middleware.javalin.specs.v1.RealtimeStreamSpecV1

All Implemented Interfaces:

AutoCloseable

public class RealtimeStreamSpecV1
extends AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>
implements AutoCloseable

Authenticated v1 SSE stream. One virtual writer per stream; hub callbacks only enqueue.

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
RealtimeStreamSpecV1()

Method Summary

Modifier and Type	Method	Description
RealtimeExecutor.Input	buildInput(io.javalin.http.Context context)	Authentication has already established QContext before this runs.
void	close()	Server shutdown releases the hub even if no clients remain.
BasicOperation	defineBasicOperation()	Declare the streaming contract without an extension-point dependency.
BasicResponse	defineBasicSuccessResponse()	The 200 response is explicitly a stream, not a JSON response.
Map<String,Schema>	defineComponentSchemas()	Every named core event is a separate schema component.
List<Parameter>	defineRequestParameters()	A reconnect cursor never grants ownership of another session connection.
RealtimeHub	getHub()	Initialize lazily so OpenAPI generation does not start resources.
void	handleOutput(io.javalin.http.Context context, RealtimeExecutor.Output output)	Use Javalin SSE lifetime handling and one virtual writer for ordered frames.
void	setQInstance(QInstance instance)	A metadata hot swap retires connections bound to the prior instance.

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, defineResponses, defineRoute, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, isSecured, newExecutor, newOutput, serveRequest

Methods inherited from class java.lang.Object

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

Constructor Details

RealtimeStreamSpecV1

public RealtimeStreamSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Declare the streaming contract without an extension-point dependency.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

A reconnect cursor never grants ownership of another session connection.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

The 200 response is explicitly a stream, not a JSON response.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Every named core event is a separate schema component.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

getHub

public RealtimeHub getHub()

Initialize lazily so OpenAPI generation does not start resources.

setQInstance

public void setQInstance(QInstance instance)

A metadata hot swap retires connections bound to the prior instance.

Overrides:

setQInstance in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

buildInput

public RealtimeExecutor.Input buildInput(io.javalin.http.Context context)

Authentication has already established QContext before this runs.

Specified by:

buildInput in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 RealtimeExecutor.Output output)

Use Javalin SSE lifetime handling and one virtual writer for ordered frames.

Overrides:

handleOutput in class AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

close

public void close()

Server shutdown releases the hub even if no clients remain.

Specified by:

close in interface AutoCloseable