Class EsbSpecSupport.AbstractEsbSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>

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

Direct Known Subclasses:

EsbDeadLettersSpecV1, EsbMessagesSpecV1, EsbOverviewSpecV1, EsbProcessSpecV1, EsbTableSpecV1

Enclosing class:

EsbSpecSupport

public abstract static class EsbSpecSupport.AbstractEsbSpecV1
extends AbstractEndpointSpec<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>

base of the ESB specs: secured, tagged, JSON written with nulls kept (as the route provider before them did), success schema per operation.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
AbstractEsbSpecV1()

Method Summary

Modifier and Type	Method	Description
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
protected abstract String	getResponseSchemaName()	name of the component schema of the success response
void	handleOutput(io.javalin.http.Context context, EsbSpecSupport.EsbResponseV1 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

buildInput, checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineBasicOperation, defineCompleteOperation, defineMethod, defineRequestBody, defineRequestParameters, 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

AbstractEsbSpecV1

public AbstractEsbSpecV1()

Method Details

getResponseSchemaName

protected abstract String getResponseSchemaName()

name of the component schema of the success response

handleOutput

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

Description copied from class: AbstractEndpointSpec

build the endpoint's http response (written to the javalin context) from an execution output object

Overrides:

handleOutput in class AbstractEndpointSpec<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>