Class AbstractJsonEndpointSpec

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

Direct Known Subclasses:

HealthSpecSupport, TableApiDocumentSpecV1, TableApisSpecV1, TableFormAdjusterSpecV1

public abstract class AbstractJsonEndpointSpec
extends AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

Base for extension endpoint specs whose request is path/query parameters and an optional JSON object body, and whose response is a JSON value - the common shape of module and qbit endpoints. A subclass defines the operation (path, method, parameters, request and response schemas) and handle(); the session is set up (for secured specs) before handle runs, and the result is written as JSON with nulls kept. Each subclass needs a public no-arg constructor (it is registered by class in a MiddlewareSpecExtension). See docs/UI-API-EXTENSIONS.md.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractJsonEndpointSpec.JsonExecutor	runs the spec's handle()
static class	AbstractJsonEndpointSpec.JsonInput	The request: path parameters, the first value of each query parameter, and the JSON body (empty unless the spec defines one).
static class	AbstractJsonEndpointSpec.JsonOutput	the response body
static interface	AbstractJsonEndpointSpec.JsonOutputInterface	output interface

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
AbstractJsonEndpointSpec()

Method Summary

Modifier and Type	Method	Description
AbstractJsonEndpointSpec.JsonInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicResponse	defineBasicSuccessResponse()
RequestBody	defineRequestBody()
protected Schema	defineRequestBodySchema()	The schema of the JSON request body, or null (the default) for none.
protected abstract String	getResponseSchemaName()	The component schema name of the 200 response body.
protected abstract Object	handle(AbstractJsonEndpointSpec.JsonInput input)	Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).
void	handleOutput(io.javalin.http.Context context, AbstractJsonEndpointSpec.JsonOutput 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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineBasicOperation, defineCompleteOperation, defineComponentSchemas, defineMethod, defineRequestParameters, defineResponses, 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

AbstractJsonEndpointSpec

public AbstractJsonEndpointSpec()

Method Details

handle

protected abstract Object handle(AbstractJsonEndpointSpec.JsonInput input)
                          throws Exception

Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).

Throws:

Exception

getResponseSchemaName

protected abstract String getResponseSchemaName()

The component schema name of the 200 response body.

defineRequestBodySchema

protected Schema defineRequestBodySchema()

The schema of the JSON request body, or null (the default) for none.

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

buildInput

public AbstractJsonEndpointSpec.JsonInput 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<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

Throws:

Exception

handleOutput

public void handleOutput(io.javalin.http.Context context,
 AbstractJsonEndpointSpec.JsonOutput 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<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

Throws:

Exception