Class RealtimeSubscriptionsSpecV1

java.lang.Object

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

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

public class RealtimeSubscriptionsSpecV1
extends AbstractEndpointSpec<RealtimeExecutor.Input,RealtimeExecutor.Output,RealtimeExecutor>

Change channels on a connection belonging to the authenticated session.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
RealtimeSubscriptionsSpecV1()	The standalone spec constructor supports schema tooling.
RealtimeSubscriptionsSpecV1(Supplier<RealtimeHub> hub)	Share the stream spec hub, scoped to this middleware server.

Method Summary

Modifier and Type	Method	Description
RealtimeExecutor.Input	buildInput(io.javalin.http.Context context)	Reject malformed bodies before they reach permission checks.
List<BasicResponse>	defineAdditionalBasicResponses()	Do not distinguish unknown connections from another session's connection.
BasicOperation	defineBasicOperation()	Channel grammar and refusal semantics are part of the public contract.
BasicResponse	defineBasicSuccessResponse()	Active channels and refused requested channels.
Map<String,Schema>	defineComponentSchemas()	Publish both sides of the subscription contract.
RequestBody	defineRequestBody()	Typed JSON request body.
void	handleOutput(io.javalin.http.Context context, RealtimeExecutor.Output output)	Only the typed wire result is serialized.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

RealtimeSubscriptionsSpecV1

public RealtimeSubscriptionsSpecV1(Supplier<RealtimeHub> hub)

Share the stream spec hub, scoped to this middleware server.

RealtimeSubscriptionsSpecV1

public RealtimeSubscriptionsSpecV1()

The standalone spec constructor supports schema tooling.

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Channel grammar and refusal semantics are part of the public contract.

Overrides:

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

defineRequestBody

public RequestBody defineRequestBody()

Typed JSON request body.

Overrides:

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

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Active channels and refused requested channels.

Overrides:

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

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Publish both sides of the subscription contract.

Overrides:

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

buildInput

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

Reject malformed bodies before they reach permission checks.

Specified by:

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

Throws:

QBadRequestException

handleOutput

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

Only the typed wire result is serialized.

Overrides:

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

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

Do not distinguish unknown connections from another session's connection.

Overrides:

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