Class ProcessSpecUtilsV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.utils.ProcessSpecUtilsV1

public class ProcessSpecUtilsV1
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXAMPLE_JOB_UUID
static final String	EXAMPLE_PROCESS_UUID
static final String	TABLE_VARIANT_PARAM

Constructor Summary

Constructors

Constructor	Description
ProcessSpecUtilsV1()

Method Summary

Modifier and Type	Method	Description
static void	addUploadedFiles(io.javalin.http.Context context, ProcessInitOrStepInput input)	Read the files uploaded with a process init or step request (QRun-IO/qqq#543) the same way the legacy process routes do: every value is validated and every filename checked before anything is stored; each file is streamed to the uploaded-file archive table, and the field's process value becomes the list of StorageInputs that reference the stored files.
static LinkedHashMap<String,Example>	buildResponseExample()
static Schema	buildResponseSchema()
static Schema	defineTableVariantFormProperty()	OpenAPI definition of the (optional) tableVariant form field.
static Parameter	defineTableVariantQueryParameter()	OpenAPI definition of the (optional) tableVariant query parameter.
static String	getResponseSchemaRefName()
static TableVariant	getTableVariantParam(io.javalin.http.Context context)	The (optional) table variant for a process request: a JSON object with the variant's `type` and `id` (as for the table routes), read from the form field or query parameter named `tableVariant`.
static void	handleOutput(io.javalin.http.Context context, ProcessInitOrStepOrStatusResponseV1 response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TABLE_VARIANT_PARAM

public static final String TABLE_VARIANT_PARAM

See Also:

• Constant Field Values

EXAMPLE_PROCESS_UUID

public static final String EXAMPLE_PROCESS_UUID

See Also:

• Constant Field Values

EXAMPLE_JOB_UUID

public static final String EXAMPLE_JOB_UUID

See Also:

• Constant Field Values

Constructor Details

ProcessSpecUtilsV1

public ProcessSpecUtilsV1()

Method Details

getTableVariantParam

public static TableVariant getTableVariantParam(io.javalin.http.Context context)

The (optional) table variant for a process request: a JSON object with the variant's `type` and `id` (as for the table routes), read from the form field or query parameter named `tableVariant`.

defineTableVariantQueryParameter

public static Parameter defineTableVariantQueryParameter()

OpenAPI definition of the (optional) tableVariant query parameter.

defineTableVariantFormProperty

public static Schema defineTableVariantFormProperty()

OpenAPI definition of the (optional) tableVariant form field.

getResponseSchemaRefName

public static String getResponseSchemaRefName()

buildResponseSchema

public static Schema buildResponseSchema()

buildResponseExample

public static LinkedHashMap<String,Example> buildResponseExample()

handleOutput

public static void handleOutput(io.javalin.http.Context context,
 ProcessInitOrStepOrStatusResponseV1 response)

addUploadedFiles

public static void addUploadedFiles(io.javalin.http.Context context,
 ProcessInitOrStepInput input)
                             throws IOException,
QException

Read the files uploaded with a process init or step request (QRun-IO/qqq#543) the same way the legacy process routes do: every value is validated and every filename checked before anything is stored; each file is streamed to the uploaded-file archive table, and the field's process value becomes the list of StorageInputs that reference the stored files.

Throws:

IOException

QException