Class EsbSpecSupport

java.lang.Object

com.kingsrook.qqq.esb.api.specs.EsbSpecSupport

public class EsbSpecSupport
extends Object

Shared pieces of the ESB UI API specs (QRun-IO/qqq docs/UI-API-EXTENSIONS.md): the input (which body to build, from what parameters), the executor (runs EsbStatusBuilder with the session in context), the response (the built body, written with nulls kept), and the base spec.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EsbSpecSupport.AbstractEsbSpecV1	base of the ESB specs: secured, tagged, JSON written with nulls kept (as the route provider before them did), success schema per operation.
static interface	EsbSpecSupport.BodyBuilder	Builds one operation's body from an EsbStatusBuilder.
static class	EsbSpecSupport.EsbExecutor	executor: build the body with the session the spec set up
static class	EsbSpecSupport.EsbInput	input: the body builder bound to the request's parameters
static interface	EsbSpecSupport.EsbOutputInterface	output interface
static class	EsbSpecSupport.EsbResponseV1	response: the body EsbStatusBuilder built (its schema is per operation)
static enum	EsbSpecSupport.EsbTag	OpenAPI tag of the ESB operations.

Constructor Summary

Constructors

Constructor	Description
EsbSpecSupport()

Method Summary

Modifier and Type	Method	Description
static Integer	getIntegerParam(io.javalin.http.Context context, String name)	An integer query parameter - null if absent; QBadRequestException if it isn't an integer.
static List<Parameter>	pagingParameters()	the offset and limit paging parameters
static Parameter	pathParameter(String name, String description)	a required string path parameter
static Parameter	queryParameter(String name, String description, Type type)	an optional query parameter

Methods inherited from class java.lang.Object

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

Constructor Details

EsbSpecSupport

public EsbSpecSupport()

Method Details

pathParameter

public static Parameter pathParameter(String name,
 String description)

a required string path parameter

queryParameter

public static Parameter queryParameter(String name,
 String description,
 Type type)

an optional query parameter

pagingParameters

public static List<Parameter> pagingParameters()

the offset and limit paging parameters

getIntegerParam

public static Integer getIntegerParam(io.javalin.http.Context context,
 String name)
                               throws QBadRequestException

An integer query parameter - null if absent; QBadRequestException if it isn't an integer.

Throws:

QBadRequestException