Class WidgetSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

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

public class WidgetSpecV1
extends AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

Endpoint spec for rendering a widget via POST.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
WidgetSpecV1()

Method Summary

Modifier and Type	Method	Description
WidgetInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()	Note: Legacy widget endpoint supported both GET and POST.
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, WidgetResponseV1 output)	Override to serialize just the widgetData portion directly, rather than the wrapper response object.

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, 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

WidgetSpecV1

public WidgetSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Note: Legacy widget endpoint supported both GET and POST. V1 API uses POST-only since widget parameters are passed in the JSON request body.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

buildInput

public WidgetInput 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<WidgetInput,WidgetResponseV1,WidgetExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

handleOutput

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

Override to serialize just the widgetData portion directly, rather than the wrapper response object.

Overrides:

handleOutput in class AbstractEndpointSpec<WidgetInput,WidgetResponseV1,WidgetExecutor>

Throws:

Exception