Class JobsSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

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

public class JobsSpecV1
extends AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

Jobs tray, detail, polling and actions, registered only with the jobs tables.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
JobsSpecV1(String operation, String path, HttpMethod method, String responseSchema)	One specification per operation, sharing parsing and schema definitions.

Method Summary

Modifier and Type	Method	Description
static List<JobsSpecV1>	all()	The six jobs UI operations.
JobsInput	buildInput(io.javalin.http.Context context)	Validate all numeric bounds and enumerated query values.
List<BasicResponse>	defineAdditionalBasicResponses()	Additional documented errors.
BasicOperation	defineBasicOperation()	Declare the operation and cursor overlap contract.
BasicResponse	defineBasicSuccessResponse()	Document success and state conflicts.
Map<String,Schema>	defineComponentSchemas()	All versioned jobs representations.
RequestBody	defineRequestBody()	Tracking request is a named schema.
List<Parameter>	defineRequestParameters()	Typed query and path parameters.
void	defineRoute(AbstractMiddlewareVersion version, String base)	Do not bind routes when the instance has no durable jobs tables.
protected void	handleException(io.javalin.http.Context context, Exception exception)	Map only transition conflicts to 409.
void	handleOutput(io.javalin.http.Context context, JobsOutput output)	Serialize the operation-specific response directly.

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

checkCredentialScopeOperation, customizeMethod, defineCompleteOperation, defineMethod, defineResponses, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, 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

JobsSpecV1

public JobsSpecV1(String operation,
 String path,
 HttpMethod method,
 String responseSchema)

One specification per operation, sharing parsing and schema definitions.

Method Details

all

public static List<JobsSpecV1> all()

The six jobs UI operations.

defineBasicOperation

public BasicOperation defineBasicOperation()

Declare the operation and cursor overlap contract.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineRoute

public void defineRoute(AbstractMiddlewareVersion version,
 String base)

Do not bind routes when the instance has no durable jobs tables.

Overrides:

defineRoute in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Typed query and path parameters.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Tracking request is a named schema.

Overrides:

defineRequestBody in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

buildInput

public JobsInput buildInput(io.javalin.http.Context context)
                     throws Exception

Validate all numeric bounds and enumerated query values.

Specified by:

buildInput in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

Throws:

Exception

handleOutput

public void handleOutput(io.javalin.http.Context context,
 JobsOutput output)

Serialize the operation-specific response directly.

Overrides:

handleOutput in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

handleException

protected void handleException(io.javalin.http.Context context,
 Exception exception)

Map only transition conflicts to 409.

Overrides:

handleException in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Document success and state conflicts.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

Additional documented errors.

Overrides:

defineAdditionalBasicResponses in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

All versioned jobs representations.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<JobsInput,JobsOutput,JobsExecutor>