Class HealthRunSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

com.kingsrook.qqq.middleware.javalin.health.HealthSpecSupport

com.kingsrook.qqq.middleware.javalin.health.HealthRunSpecV1

public class HealthRunSpecV1
extends HealthSpecSupport

POST /health/checks/{name}/run.

Nested Class Summary

Nested classes/interfaces inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

AbstractJsonEndpointSpec.JsonExecutor, AbstractJsonEndpointSpec.JsonInput, AbstractJsonEndpointSpec.JsonOutput, AbstractJsonEndpointSpec.JsonOutputInterface

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
HealthRunSpecV1()

Method Summary

Modifier and Type	Method	Description
BasicOperation	defineBasicOperation()	Public contract of this secured operation.
List<Parameter>	defineRequestParameters()	Parameters declared in the extension contract.
protected String	getResponseSchemaName()	Versioned response schema.
protected Object	handle(AbstractJsonEndpointSpec.JsonInput input)	Check permissions before looking up names or executing a probe.

Methods inherited from class com.kingsrook.qqq.middleware.javalin.health.HealthSpecSupport

component, defineComponentSchemas, history, named, nameParameter, project, requirePermission, rows, runNow, summary

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

buildInput, defineBasicSuccessResponse, defineRequestBody, defineRequestBodySchema, handleOutput

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

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

HealthRunSpecV1

public HealthRunSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Public contract of this secured operation.

Overrides:

defineBasicOperation in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Parameters declared in the extension contract.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

getResponseSchemaName

protected String getResponseSchemaName()

Versioned response schema.

Specified by:

getResponseSchemaName in class AbstractJsonEndpointSpec

handle

protected Object handle(AbstractJsonEndpointSpec.JsonInput input)
                 throws Exception

Check permissions before looking up names or executing a probe.

Specified by:

handle in class AbstractJsonEndpointSpec

Throws:

Exception