Class RecordFieldDownloadSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

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

public class RecordFieldDownloadSpecV1
extends AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

Spec for the record field download endpoint (GET /table/{tableName}/{primaryKey}/{fieldName}/{filename}). This endpoint returns binary content for a blob field on a record.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
RecordFieldDownloadSpecV1()

Method Summary

Modifier and Type	Method	Description
RecordFieldDownloadInput	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, RecordFieldDownloadResponseV1 output)	Override handleOutput to write binary content or issue a redirect 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

RecordFieldDownloadSpecV1

public RecordFieldDownloadSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

buildInput

public RecordFieldDownloadInput 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<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

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<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

handleOutput

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

Override handleOutput to write binary content or issue a redirect rather than JSON.

Overrides:

handleOutput in class AbstractEndpointSpec<RecordFieldDownloadInput,RecordFieldDownloadResponseV1,RecordFieldDownloadExecutor>

Throws:

Exception