Class EsbOverviewSpecV1

java.lang.Object

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

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

com.kingsrook.qqq.esb.api.specs.EsbOverviewSpecV1

public class EsbOverviewSpecV1
extends EsbSpecSupport.AbstractEsbSpecV1

GET /esb/overview - ESB overview

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
EsbOverviewSpecV1()

Method Summary

Modifier and Type	Method	Description
EsbSpecSupport.EsbInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
List<Parameter>	defineRequestParameters()
protected String	getResponseSchemaName()	name of the component schema of the success response

Methods inherited from class com.kingsrook.qqq.esb.api.specs.EsbSpecSupport.AbstractEsbSpecV1

defineBasicSuccessResponse, defineComponentSchemas, handleOutput

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

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

EsbOverviewSpecV1

public EsbOverviewSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

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

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

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

buildInput

public EsbSpecSupport.EsbInput 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<EsbSpecSupport.EsbInput,EsbSpecSupport.EsbResponseV1,EsbSpecSupport.EsbExecutor>

Throws:

Exception

getResponseSchemaName

protected String getResponseSchemaName()

Description copied from class: EsbSpecSupport.AbstractEsbSpecV1

name of the component schema of the success response

Specified by:

getResponseSchemaName in class EsbSpecSupport.AbstractEsbSpecV1