Class TableMetaDataSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

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

Direct Known Subclasses:

ApiAwareTableMetaDataSpecV1

public class TableMetaDataSpecV1
extends AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
TableMetaDataSpecV1()

Method Summary

Modifier and Type	Method	Description
TableMetaDataInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, TableMetaDataResponseV1 output)	build the endpoint's http response (written to the javalin context) from an execution output object

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

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

TableMetaDataSpecV1

public TableMetaDataSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

buildInput

public TableMetaDataInput 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<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

handleOutput

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

Description copied from class: AbstractEndpointSpec

build the endpoint's http response (written to the javalin context) from an execution output object

Overrides:

handleOutput in class AbstractEndpointSpec<TableMetaDataInput,TableMetaDataResponseV1,TableMetaDataExecutor>

Throws:

Exception