Class HealthSpecSupport

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

Direct Known Subclasses:

HealthComponentSpecV1, HealthHistorySpecV1, HealthRunSpecV1, HealthSummarySpecV1

public abstract class HealthSpecSupport
extends AbstractJsonEndpointSpec

Shared secured table projections. No elevated session is used for reads.

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
HealthSpecSupport()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	component(QRecord record)	Component state shared by summary and detail.
Map<String,Schema>	defineComponentSchemas()	All schemas are owned by this extension.
protected Object	history(AbstractJsonEndpointSpec.JsonInput input)	History is always bounded, newest first, with inclusive ISO-8601 bounds.
protected QRecord	named(String table, String name)	Missing names are 404, including on-demand requests.
protected Parameter	nameParameter()	Shared path parameter.
protected Map<String,Object>	project(QRecord record, String... fields)	Project only contract fields; table values have already been redacted.
protected void	requirePermission(boolean write)	Require the same permissions as the health record screens.
protected List<QRecord>	rows(String table, QQueryFilter filter)	Read through standard actions under the caller's session.
protected Object	runNow(String name)	Reuse the live runner, closing a transient one on every exit path.
protected Object	summary()	Aggregate follows core severity semantics; pod presence is inferred from recent results, as in the System Health home.

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

buildInput, defineBasicSuccessResponse, defineRequestBody, defineRequestBodySchema, getResponseSchemaName, handle, handleOutput

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

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

HealthSpecSupport

public HealthSpecSupport()

Method Details

requirePermission

protected void requirePermission(boolean write)
                          throws QException

Require the same permissions as the health record screens.

Throws:

QException

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

All schemas are owned by this extension.

Overrides:

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

nameParameter

protected Parameter nameParameter()

Shared path parameter.

rows

protected List<QRecord> rows(String table,
 QQueryFilter filter)
                      throws QException

Read through standard actions under the caller's session.

Throws:

QException

named

protected QRecord named(String table,
 String name)
                 throws QException

Missing names are 404, including on-demand requests.

Throws:

QException

project

protected Map<String,Object> project(QRecord record,
 String... fields)

Project only contract fields; table values have already been redacted.

component

protected Map<String,Object> component(QRecord record)

Component state shared by summary and detail.

summary

protected Object summary()
                  throws QException

Aggregate follows core severity semantics; pod presence is inferred from recent results, as in the System Health home.

Throws:

QException

history

protected Object history(AbstractJsonEndpointSpec.JsonInput input)
                  throws QException

History is always bounded, newest first, with inclusive ISO-8601 bounds.

Throws:

QException

runNow

protected Object runNow(String name)
                 throws QException

Reuse the live runner, closing a transient one on every exit path.

Throws:

QException