Class GeneralDownloadSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

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

public class GeneralDownloadSpecV1
extends AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

Spec for the general file download endpoint (GET /download/{file}). This endpoint returns binary file content from server-side storage.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
GeneralDownloadSpecV1()

Method Summary

Modifier and Type	Method	Description
GeneralDownloadInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
Map<Integer,Response>	defineResponses()	Binary download endpoints do not return a JSON schema.
void	handleOutput(io.javalin.http.Context context, GeneralDownloadResponseV1 output)	Override handleOutput to stream binary content rather than JSON.

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineBasicSuccessResponse, defineCompleteOperation, defineMethod, defineRequestBody, 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

GeneralDownloadSpecV1

public GeneralDownloadSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

buildInput

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

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

defineResponses

public Map<Integer,Response> defineResponses()

Binary download endpoints do not return a JSON schema. Override to describe the response as application/octet-stream binary content.

Overrides:

defineResponses in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

handleOutput

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

Override handleOutput to stream binary content rather than JSON.

Overrides:

handleOutput in class AbstractEndpointSpec<GeneralDownloadInput,GeneralDownloadResponseV1,GeneralDownloadExecutor>

Throws:

Exception