Class DeliveryOutputSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

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

public class DeliveryOutputSpecV1
extends AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

Authenticated output delivery operation.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
DeliveryOutputSpecV1()

Method Summary

Modifier and Type	Method	Description
DeliveryMiddlewareInput	buildInput(io.javalin.http.Context context)	Build the typed input; identity always comes from the authenticated session.
BasicOperation	defineBasicOperation()	Describe this versioned operation.
BasicResponse	defineBasicSuccessResponse()	Success response contract.
Map<String,Schema>	defineComponentSchemas()	Publish response and request schemas.
List<Parameter>	defineRequestParameters()	Parameters from the URL path only.
void	handleOutput(io.javalin.http.Context context, DeliveryOutputResponseV1 output)	Write the operation response.

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, defineResponses, defineRoute, getOpenApiOperationId, 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

DeliveryOutputSpecV1

public DeliveryOutputSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Describe this versioned operation.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Parameters from the URL path only.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

buildInput

public DeliveryMiddlewareInput buildInput(io.javalin.http.Context context)
                                   throws Exception

Build the typed input; identity always comes from the authenticated session.

Specified by:

buildInput in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Publish response and request schemas.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Success response contract.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 DeliveryOutputResponseV1 output)
                  throws Exception

Write the operation response.

Overrides:

handleOutput in class AbstractEndpointSpec<DeliveryMiddlewareInput,DeliveryOutputResponseV1,DeliveryExecutor>

Throws:

Exception