Class MetaDataSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

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

public class MetaDataSpecV1
extends AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
MetaDataSpecV1()

Method Summary

Modifier and Type	Method	Description
MetaDataInput	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, MetaDataResponseV1 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, 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

MetaDataSpecV1

public MetaDataSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

buildInput

public MetaDataInput 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<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

handleOutput

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

Description copied from class: AbstractEndpointSpec

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

Specified by:

handleOutput in class AbstractEndpointSpec<MetaDataInput,MetaDataResponseV1,MetaDataExecutor>

Throws:

Exception