Class ProcessStepSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

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

public class ProcessStepSpecV1
extends AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_ASYNC_STEP_TIMEOUT_MILLIS

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

qInstance

Constructor Summary

Constructors

Constructor	Description
ProcessStepSpecV1()

Method Summary

Modifier and Type	Method	Description
ProcessInitOrStepInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, ProcessInitOrStepOrStatusResponseV1 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, defineComponentSchemas, defineMethod, 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

Field Details

DEFAULT_ASYNC_STEP_TIMEOUT_MILLIS

public static int DEFAULT_ASYNC_STEP_TIMEOUT_MILLIS

Constructor Details

ProcessStepSpecV1

public ProcessStepSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

buildInput

public ProcessInitOrStepInput 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<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

Throws:

Exception

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 ProcessInitOrStepOrStatusResponseV1 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<ProcessInitOrStepInput,ProcessInitOrStepOrStatusResponseV1,ProcessInitOrStepExecutor>

Throws:

Exception