Class ReportRunSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

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

public class ReportRunSpecV1
extends AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

Spec for running a report and downloading the generated file (GET /reports/{reportName}) - the v1 form of the legacy streaming report route, for reports that are not run through a process. Returns the file (CSV, XLSX, JSON, ...) rather than a JSON response body.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
ReportRunSpecV1()

Method Summary

Modifier and Type	Method	Description
ReportRunInput	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, TableExportResponseV1 output)	Stream the file rather than a JSON body.

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

ReportRunSpecV1

public ReportRunSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

buildInput

public ReportRunInput 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<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

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<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

handleOutput

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

Stream the file rather than a JSON body.

Overrides:

handleOutput in class AbstractEndpointSpec<ReportRunInput,TableExportResponseV1,ReportRunExecutor>

Throws:

Exception