Uses of Class
com.kingsrook.qqq.backend.core.exceptions.QException
Packages that use QException
Package
Description
This package contains (hopefully generally) api-version-agnostic classes
that implement the actual QQQ Middleware.
These classes are input/output wrappers for middleware executors.
This tools path - is for non-production code - rather, development and CI/CD
tools.
-
Uses of QException in com.kingsrook.qqq.api.actions
Methods in com.kingsrook.qqq.api.actions that throw QExceptionModifier and TypeMethodDescriptionstatic QRecordQRecordApiAdapter.apiJsonObjectToQRecord(org.json.JSONObject jsonObject, String tableName, String apiName, String apiVersion, boolean includeNonEditableFields) static QRecordQRecordApiAdapter.apiJsonObjectToQRecord(org.json.JSONObject jsonObject, String tableName, String apiName, String apiVersion, boolean includeNonEditableFields, InputSource inputSource) static List<Map<String, Serializable>> ApiImplementation.bulkDelete(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String body) static List<Map<String, Serializable>> ApiImplementation.bulkInsert(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String body) static List<Map<String, Serializable>> ApiImplementation.bulkUpdate(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String body) UiApiModelApiParityChecker.check(QInstance instance, String apiName, String version, ParityExclusions exclusions) Check an already validated/enriched instance.static voidApiImplementation.delete(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String primaryKey) GenerateOpenApiSpecAction.execute(GenerateOpenApiSpecInput input) GetTableApiFieldsAction.execute(GetTableApiFieldsInput input) static Map<String, Serializable> ApiImplementation.get(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String primaryKey) static HttpApiResponseApiImplementation.getProcessStatus(ApiInstanceMetaData apiInstanceMetaData, String version, String apiProcessName, String jobUUID) static List<QFieldMetaData> GetTableApiFieldsAction.getTableApiFieldList(GetTableApiFieldsInput input) convenience (and caching) wrapperstatic Map<String, QFieldMetaData> GetTableApiFieldsAction.getTableApiFieldMap(GetTableApiFieldsInput input) convenience (and caching) wrapperstatic Map<String, Serializable> ApiImplementation.insert(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String body) static ArrayList<Map<String, Serializable>> QRecordApiAdapter.qRecordsToApiMapList(List<QRecord> records, String tableName, String apiName, String apiVersion) bulk-version of the qRecordToApiMap - will use ApiFieldCustomValueMapperBulkSupportInterface's in the bulky way.QRecordApiAdapter.qRecordsToApiVersionedQRecordList(QRecordApiAdapterToApiInput input) version of the qRecordToApiMap that returns QRecords, not maps.QRecordApiAdapter.qRecordsToApiVersionedQRecordList(List<QRecord> records, String tableName, String apiName, String apiVersion) version of the qRecordToApiMap that returns QRecords, not maps.static Map<String, Serializable> QRecordApiAdapter.qRecordToApiMap(QRecord record, String tableName, String apiName, String apiVersion) Simple/short form of convert a QRecord to a map for the API - e.g., meant for public consumption.static Map<String, Serializable> ApiImplementation.query(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, Map<String, List<String>> paramMap) static HttpApiResponseApiImplementation.runProcess(ApiInstanceMetaData apiInstanceMetaData, String version, String processApiName, Map<String, String> paramMap) static voidQRecordApiAdapter.setValueFromApiFieldInQRecord(org.json.JSONObject apiObject, String apiFieldName, String apiName, Map<String, QFieldMetaData> apiFieldsMap, QRecord qRecord, boolean includeNonEditableFields) static voidApiImplementation.update(ApiInstanceMetaData apiInstanceMetaData, String version, String tableApiName, String primaryKey, String body) -
Uses of QException in com.kingsrook.qqq.api.implementations.savedreports
Methods in com.kingsrook.qqq.api.implementations.savedreports that throw QExceptionModifier and TypeMethodDescriptionvoidRenderSavedReportProcessApiProcessOutput.customizeHttpApiResponse(HttpApiResponse httpApiResponse, RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) RenderSavedReportProcessApiProcessOutput.getOutputForProcess(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) voidRenderSavedReportProcessApiCustomizer.preApiRun(RunProcessInput runProcessInput) -
Uses of QException in com.kingsrook.qqq.api.javalin
Subclasses of QException in com.kingsrook.qqq.api.javalin -
Uses of QException in com.kingsrook.qqq.api.middleware.executors
Methods in com.kingsrook.qqq.api.middleware.executors that throw QExceptionModifier and TypeMethodDescriptionvoidApiAwareTableCountExecutor.execute(TableCountInput input, TableCountOutputInterface output) voidApiAwareTableMetaDataExecutor.execute(TableMetaDataInput input, TableMetaDataOutputInterface output) voidApiAwareTableQueryExecutor.execute(TableQueryInput input, TableQueryOutputInterface output) -
Uses of QException in com.kingsrook.qqq.api.middleware.specs.v1
Methods in com.kingsrook.qqq.api.middleware.specs.v1 that throw QExceptionModifier and TypeMethodDescriptionvoidApiAwareMiddlewareVersionV1.preExecute(io.javalin.http.Context context) -
Uses of QException in com.kingsrook.qqq.api.model
Constructors in com.kingsrook.qqq.api.model that throw QException -
Uses of QException in com.kingsrook.qqq.api.model.metadata
Methods in com.kingsrook.qqq.api.model.metadata that throw QExceptionModifier and TypeMethodDescriptionstatic voidApiInstanceMetaDataProvider.defineAll(QInstance qInstance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) -
Uses of QException in com.kingsrook.qqq.api.model.metadata.processes
Methods in com.kingsrook.qqq.api.model.metadata.processes that throw QExceptionModifier and TypeMethodDescriptiondefault voidApiProcessOutputInterface.customizeHttpApiResponse(HttpApiResponse httpApiResponse, RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) ApiProcessOutputInterface.getOutputForProcess(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) ApiProcessSummaryListOutput.getOutputForProcess(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) voidPostRunApiProcessCustomizer.postApiRun(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput) voidPreRunApiProcessCustomizer.preApiRun(RunProcessInput runProcessInput) -
Uses of QException in com.kingsrook.qqq.api.utils
Methods in com.kingsrook.qqq.api.utils that throw QExceptionModifier and TypeMethodDescriptionApiScriptUtils.bulkDelete(String tableApiName, Object body) ApiScriptUtils.bulkInsert(String tableApiName, Object body) ApiScriptUtils.bulkUpdate(String tableApiName, Object body) voidApiScriptUtils.getProcessStatus(String processApiName, String jobId) static voidApiQueryFilterUtils.manageCriteriaFields(QQueryFilter filter, Map<String, QFieldMetaData> tableApiFields, List<String> badRequestMessages, String apiName, String apiVersion, QueryOrCountInputInterface input) static ArrayList<Map<String, Serializable>> ApiScriptUtils.qRecordListToApiRecordList(List<QRecord> qRecordList, String tableName, String apiName, String apiVersion) ApiScriptUtils.runProcess(String processApiName) ApiScriptUtils.runProcess(String processApiName, Object params) void -
Uses of QException in com.kingsrook.qqq.backend.core.actions
Methods in com.kingsrook.qqq.backend.core.actions that throw QExceptionModifier and TypeMethodDescriptionvoidQBackendTransaction.commit()Commit the transaction.abstract voidabstract Ostatic QBackendTransactionQBackendTransaction.openConsistentReadFor(ConsistentReadInput input) Open a consistent-read transaction (see QBackendModuleInterface .openConsistentReadTransaction) on the named backend.static QBackendTransactionQBackendTransaction.openFor(AbstractTableActionInput input) voidQBackendTransaction.rollback()Rollback the transaction.static voidActionHelper.validateSession(AbstractActionInput request) Validate the session using the appropriate authentication provider. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.ai
Methods in com.kingsrook.qqq.backend.core.actions.ai that throw QExceptionModifier and TypeMethodDescriptionAiDataGateway.count(CountInput input) Count records.CoreAiDataGateway.count(CountInput input) Get one record (with display values) - null when missing or not readable.AiDataGateway.query(QueryInput input) Query records (with display values).CoreAiDataGateway.query(QueryInput input) AiDataGateway.renderWidget(RenderWidgetInput input) Render a widget's data, as its JSON tree (null when there is none).CoreAiDataGateway.renderWidget(RenderWidgetInput input) AiDataGateway.search(RecordSearchInput input) Free-text record search.CoreAiDataGateway.search(RecordSearchInput input) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.ai.tools
Subclasses of QException in com.kingsrook.qqq.backend.core.actions.ai.toolsModifier and TypeClassDescriptionclassThrown by an AI tool to end its call with a non-OK outcome (DENIED, NOT_FOUND, INVALID_INPUT) and a polite message for the model.Methods in com.kingsrook.qqq.backend.core.actions.ai.tools that throw QExceptionModifier and TypeMethodDescriptionAbstractAiTool.execute(AiToolContext context, AiToolInput input) Run the tool - returning the data to send to the model.CountRecordsTool.execute(AiToolContext context, AiToolInput input) DescribeTableTool.execute(AiToolContext context, AiToolInput input) GetRecordHistoryTool.execute(AiToolContext context, AiToolInput input) GetRecordTool.execute(AiToolContext context, AiToolInput input) ListTablesTool.execute(AiToolContext context, AiToolInput input) NavigateTool.execute(AiToolContext context, AiToolInput input) QueryRecordsTool.execute(AiToolContext context, AiToolInput input) RenderWidgetTool.execute(AiToolContext context, AiToolInput input) SearchHelpTool.execute(AiToolContext context, AiToolInput input) SearchRecordsTool.execute(AiToolContext context, AiToolInput input) AiToolContext.personalize(QTableMetaData table) The table as personalized for this session (fields the session may not see removed by any table personalizer). -
Uses of QException in com.kingsrook.qqq.backend.core.actions.async
Method parameters in com.kingsrook.qqq.backend.core.actions.async with type arguments of type QExceptionModifier and TypeMethodDescriptionintAsyncRecordPipeLoop.run(String jobName, Integer recordLimit, RecordPipe recordPipe, UnsafeFunction<AsyncJobCallback, ? extends Serializable, QException> supplier, UnsafeSupplier<Integer, QException> consumer) Run an async-record-pipe-loop.intAsyncRecordPipeLoop.run(String jobName, Integer recordLimit, RecordPipe recordPipe, UnsafeFunction<AsyncJobCallback, ? extends Serializable, QException> supplier, UnsafeSupplier<Integer, QException> consumer) Run an async-record-pipe-loop.Methods in com.kingsrook.qqq.backend.core.actions.async that throw QExceptionModifier and TypeMethodDescriptionAsyncJobManager.getJobStatusForUser(String uuid, String processName, String processUUID) Check ownership even while the process has not produced any state yet.intAsyncRecordPipeLoop.run(String jobName, Integer recordLimit, RecordPipe recordPipe, UnsafeFunction<AsyncJobCallback, ? extends Serializable, QException> supplier, UnsafeSupplier<Integer, QException> consumer) Run an async-record-pipe-loop.<T extends Serializable>
TStart a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.<T extends Serializable>
StringStart a job, and always, just get back the job UUID.<T extends Serializable>
TStart a job - if it finishes within the specified timeout, get its results, else, get back an exception with the job id.<T extends Serializable>
StringStart a job, and always, just get back the job UUID. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.audits
Methods in com.kingsrook.qqq.backend.core.actions.audits that throw QExceptionModifier and TypeMethodDescriptionDMLAuditAction.execute(DMLAuditInput input) Execute the DML audit action for a table operation.voidAuditHandlerExecutor.executeDMLHandlers(String tableName, DMLAuditHandlerInput input) Execute all DML audit handlers for the given table.voidAuditHandlerExecutor.executeProcessedHandlers(String tableName, ProcessedAuditHandlerInput input) Execute all processed audit handlers for the given table.voidProcessedAuditHandlerInterface.handleAudit(ProcessedAuditHandlerInput input) Handle processed audit events.voidDMLAuditHandlerInterface.handleDMLAudit(DMLAuditHandlerInput input) Handle a DML audit event with full record data.static voidAuditShreddedEvent.shreddedDetail(QTableMetaData table, Serializable pk, QFieldMetaData field, String ruleId) Use the transaction in the current context, if any.static voidAuditShreddedEvent.shreddedDetail(QTableMetaData table, Serializable pk, QFieldMetaData field, String ruleId, QBackendTransaction transaction) Write through AuditAction; callers destroying keys pass the same transaction. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.automation
Methods in com.kingsrook.qqq.backend.core.actions.automation that throw QExceptionModifier and TypeMethodDescriptionvoidRecordAutomationHandlerInterface.execute(RecordAutomationInput recordAutomationInput) voidRunCustomTableTriggerRecordAutomationHandler.execute(RecordAutomationInput recordAutomationInput) voidRunRecordScriptAutomationHandler.execute(RecordAutomationInput recordAutomationInput) booleanCustomTableTriggerRecordAutomationHandler.handlesThisInput(RecordAutomationInput recordAutomationInput) static voidRecordAutomationStatusUpdater.setAutomationStatusInRecordsAndUpdate(QTableMetaData table, List<QRecord> records, AutomationStatus automationStatus, QBackendTransaction transaction) for a list of records, update their automation status and actually Update the backend as well. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.automation.polling
Methods in com.kingsrook.qqq.backend.core.actions.automation.polling that throw QExceptionModifier and TypeMethodDescriptionvoidPollingAutomationPerTableRunner.processTableInsertOrUpdate(QTableMetaData table, AutomationStatus automationStatus) Query for and process records that have a PENDING_INSERT or PENDING_UPDATE status on a given table. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.collaboration
Methods in com.kingsrook.qqq.backend.core.actions.collaboration that throw QExceptionModifier and TypeMethodDescriptionRecordAccessCheckerInterface.canRead(String userId, RecordReference ref) Empty means access could not be determined.static booleanRecordReferenceSecurityHelper.canReadReference(QTableMetaData table, QRecord record, QBackendTransaction transaction) static booleanRecordFeaturePermissions.checkRecordCapability(QTableMetaData table, RecordFeature feature, QRecord parent) static booleanRecordFeaturePermissions.checkRecordCapability(QTableMetaData table, RecordFeature feature, QRecord parent, QBackendTransaction transaction) voidRecordFeatureSummaryProviderInterface.contribute(RecordReference reference, QRecord parent, RecordFeatureSummary summary) Contribute optional summary values and namespaced extensions for one visible record.static voidRecordReferenceSecurityHelper.copyMirroredLocks(QTableMetaData parentTable, QRecord parent, QTableMetaData extension, QRecord row) RuntimeMetaDataProviderInterface.getContribution(QInstance instance) Runtime table fields, virtual fields, presentation and feature overrides.RecordFollowersProviderInterface.getFollowers(QInstance instance, RecordReference reference, FollowEvent event) Return followers who want this event.RecordFeatureOverrideProviderInterface.getOverrides(QInstance instance) Runtime feature declarations, collected only during overlay refresh.voidRecordReferenceCleanupInterface.onParentsDeleted(String tableName, List<Serializable> primaryKeys) Cleanup invoked only after successful parent deletion commit.voidRecordReferenceChangeListener.onRecordsChanged(RecordChangeEvent event) Propagate only derived lock columns through the backend, without re-running user edits or own-row checks.static voidAtomically publish a new generation.static voidRecordFeaturePermissions.requireRecordCapability(QTableMetaData table, RecordFeature feature, QRecord parent) static QQueryFilterRecordReferenceSecurityHelper.secureFilter(QTableMetaData table, QQueryFilter filter, QBackendTransaction transaction) UserSessionProviderInterface.sessionForUser(String userId) Build a session for another user without changing the current session.static RecordFeatureSummaryRecordFeatureSummaryHelper.summarize(QTableMetaData table, QRecord parent) static voidRecordReferenceSecurityHelper.validateWrites(QTableMetaData table, List<QRecord> records, RecordChangeType type, QBackendTransaction transaction) Validate stored and proposed parents, so moving a row cannot evade either policy.static QRecordRecordReferenceSecurityHelper.visibleParent(String tableName, Serializable primaryKey, QBackendTransaction transaction) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.customizers
Subclasses of QException in com.kingsrook.qqq.backend.core.actions.customizersModifier and TypeClassDescriptionstatic classMethods in com.kingsrook.qqq.backend.core.actions.customizers that throw QExceptionModifier and TypeMethodDescriptionabstract QRecordChildInserterPostInsertCustomizer.buildChildForRecord(QRecord parentRecord) AbstractPostDeleteCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) MultiCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) run postDelete method over all sub-customizersTableCustomizerInterface.postDelete(DeleteInput deleteInput, List<QRecord> records) Custom actions after a delete takes place.AbstractPostInsertCustomizer.postInsert(InsertInput insertInput, List<QRecord> records) MultiCustomizer.postInsert(InsertInput insertInput, List<QRecord> records) run postInsert method over all sub-customizersTableCustomizerInterface.postInsert(InsertInput insertInput, List<QRecord> records) custom actions after an insert takes place.TableCustomizerInterface.postInsertOrUpdate(AbstractActionInput input, List<QRecord> records, Optional<List<QRecord>> oldRecordList) Optional method to override in a customizer that does the same thing for both postInsert invalid input: '&' postUpdate.default voidTableCustomizerInterface.postMetaDataAction(TableMetaDataInput tableMetaDataInput, TableMetaDataOutput tableMetaDataOutput) custom actions to run after table meta data was created by the meta data actionAbstractPostQueryCustomizer.postQuery(QueryOrGetInputInterface queryInput, List<QRecord> records) MultiCustomizer.postQuery(QueryOrGetInputInterface queryInput, List<QRecord> records) run postQuery method over all sub-customizersTableCustomizerInterface.postQuery(QueryOrGetInputInterface queryInput, List<QRecord> records) custom actions to run after a query (or get!)AbstractPostUpdateCustomizer.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) MultiCustomizer.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) run postUpdate method over all sub-customizersTableCustomizerInterface.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) custom actions after an update takes place.AbstractPreDeleteCustomizer.preDelete(DeleteInput deleteInput, List<QRecord> records, boolean isPreview) MultiCustomizer.preDelete(DeleteInput deleteInput, List<QRecord> records, boolean isPreview) run preDelete method over all sub-customizersTableCustomizerInterface.preDelete(DeleteInput deleteInput, List<QRecord> records, boolean isPreview) Custom actions before a delete takes place.AbstractPreInsertCustomizer.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) MultiCustomizer.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) run preInsert method over all sub-customizersTableCustomizerInterface.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) custom actions before an insert takes place.TableCustomizerInterface.preInsertOrUpdate(AbstractActionInput input, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) Optional method to override in a customizer that does the same thing for both preInsert invalid input: '&' preUpdate.AbstractPreUpdateCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) MultiCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) run preUpdate method over all sub-customizersTableCustomizerInterface.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) custom actions before an update takes place. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.dashboard
Methods in com.kingsrook.qqq.backend.core.actions.dashboard that throw QExceptionModifier and TypeMethodDescriptionstatic voidAbstractHTMLWidgetRenderer.addTableFilterToListIfPermissed(RenderWidgetInput input, String tableName, List<String> urls, QQueryFilter filter) static StringAbstractHTMLWidgetRenderer.aHrefTableCreateChild(RenderWidgetInput input, String childTableName, Map<String, Serializable> defaultValues) static StringAbstractHTMLWidgetRenderer.aHrefTableCreateChild(RenderWidgetInput input, String childTableName, Map<String, Serializable> defaultValues, Set<String> disabledFields) static StringAbstractHTMLWidgetRenderer.aHrefTableFilterNoOfRecords(String tableName, QQueryFilter filter, Integer noOfRecords, String singularLabel, String pluralLabel) static StringAbstractHTMLWidgetRenderer.aHrefTableFilterNoOfRecords(String tableName, QQueryFilter filter, Integer noOfRecords, String singularLabel, String pluralLabel, boolean onlyLinkCount) static StringAbstractHTMLWidgetRenderer.aHrefViewRecord(String tableName, Serializable id, String linkText) RenderWidgetAction.execute(RenderWidgetInput input) static StringAbstractHTMLWidgetRenderer.getChipElement(String icon, String label, String color) static StringAbstractHTMLWidgetRenderer.getCountLink(RenderWidgetInput input, String tableName, QQueryFilter filter, int count) static StringAbstractHTMLWidgetRenderer.linkProcessForFilter(String processName, QQueryFilter filter) static StringAbstractHTMLWidgetRenderer.linkProcessForRecord(String processName, Serializable recordId) static StringAbstractHTMLWidgetRenderer.linkRecordEdit(String tableName, Serializable recordId) static StringAbstractHTMLWidgetRenderer.linkRecordView(String tableName, Serializable recordId) static StringAbstractHTMLWidgetRenderer.linkTableBulkLoad(RenderWidgetInput input, String tableName) static StringAbstractHTMLWidgetRenderer.linkTableBulkLoadChildren(RenderWidgetInput input, String tableName) static StringAbstractHTMLWidgetRenderer.linkTableCreate(RenderWidgetInput input, String tableName) static StringAbstractHTMLWidgetRenderer.linkTableCreateChild(RenderWidgetInput input, String childTableName, Map<String, Serializable> defaultValues) static StringAbstractHTMLWidgetRenderer.linkTableCreateChild(RenderWidgetInput input, String childTableName, Map<String, Serializable> defaultValues, Set<String> disabledFields) static StringAbstractHTMLWidgetRenderer.linkTableCreateWithDefaultValues(RenderWidgetInput input, String tableName, Map<String, Serializable> defaultValues) static StringAbstractHTMLWidgetRenderer.linkTableFilter(String tableName, QQueryFilter filter) static StringAbstractHTMLWidgetRenderer.linkTableFilterUnencoded(RenderWidgetInput input, String tableName, QQueryFilter filter) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.dashboard.widgets
Methods in com.kingsrook.qqq.backend.core.actions.dashboard.widgets that throw QExceptionModifier and TypeMethodDescriptionprotected QueryOutputChildRecordListRenderer.executeQuery(QueryInput queryInput) execute the query input, producing a query output.protected List<USMapWidgetData.MapMarker> USMapWidgetRenderer.generateMapMarkerList()abstract RenderWidgetOutputAbstractWidgetRenderer.render(RenderWidgetInput input) Aggregate2DTableWidgetRenderer.render(RenderWidgetInput input) AlertWidgetRenderer.render(RenderWidgetInput input) ChildRecordListRenderer.render(RenderWidgetInput input) CronUIWidgetRenderer.render(RenderWidgetInput input) DefaultWidgetRenderer.render(RenderWidgetInput input) DividerWidgetRenderer.render(RenderWidgetInput input) NoCodeWidgetRenderer.render(RenderWidgetInput input) ParentWidgetRenderer.render(RenderWidgetInput input) ProcessWidgetRenderer.render(RenderWidgetInput input) QuickSightChartRenderer.render(RenderWidgetInput input) RecordListWidgetRenderer.render(RenderWidgetInput input) RowBuilderWidgetRenderer.render(RenderWidgetInput input) USMapWidgetRenderer.render(RenderWidgetInput input) NoCodeWidgetRenderer.renderOutputs(Map<String, Object> context, List<AbstractWidgetOutput> outputs) protected booleanAbstractWidgetRenderer.setupDropdowns(RenderWidgetInput input, QWidgetMetaData metaData, QWidgetData widgetData) NoCodeWidgetVelocityUtils.tableCountFilterLink(String countVariableName, String singular, String plural) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.help
Methods in com.kingsrook.qqq.backend.core.actions.help that throw QExceptionModifier and TypeMethodDescriptionvoidHelpBundleSyncAction.acceptUpstream(Collection<? extends Serializable> ids) Apply upstream text to selected pending rows.HelpSearchAction.collectCandidates()Collect visible documentation, including label-only targets for navigation.HelpBundleSyncAction.execute()Apply the current registered bundles.HelpCoverageAction.execute(HelpCoverageInput input) Totals reflect kind/parent scope before missingOnly filters the entries.HelpSearchAction.execute(HelpSearchInput input) Search help with the current user's metadata and table-read permissions.voidHelpBundleSyncAction.keepMine(Collection<? extends Serializable> ids) Retain local text while acknowledging the current upstream baseline.HelpBundleSyncAction.preview()Calculate the same decisions without writes, alerts or live metadata changes.voidHelpBundleProcessStep.run(RunBackendStepInput input, RunBackendStepOutput output) Preview never writes; execution recalculates against current database text. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.interfaces
Methods in com.kingsrook.qqq.backend.core.actions.interfaces that throw QExceptionModifier and TypeMethodDescriptionQStorageInterface.createOutputStream(StorageInput storageInput) ConditionalUpdateInterface.databaseNow(QBackendMetaData backend) The backend's current time (for an RDBMS, the database clock).default voidQStorageInterface.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.AggregateInterface.execute(AggregateInput aggregateInput) intConditionalUpdateInterface.execute(ConditionalUpdateInput input) Run the update; return the number of rows updated.CountInterface.execute(CountInput countInput) DeleteInterface.execute(DeleteInput deleteInput) InsertInterface.execute(InsertInput insertInput) QueryInterface.execute(QueryInput queryInput) UpdateInterface.execute(UpdateInput updateInput) default QueryOutputQueryInterface.executeForDml(QueryInput queryInput) Native lookup whose returned identities will drive writes.default List<Serializable> QueryInterface.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) Native structural lookup for associated-write permission preflight.default StringQStorageInterface.getDownloadURL(StorageInput storageInput) QStorageInterface.getInputStream(StorageInput storageInput) QueryInterface.lookupUniqueKey(UniqueKeyLookup.Input input) Native, schema-constrained unique-key validation, independent of read visibility.default voidQStorageInterface.makePublic(StorageInput storageInput) QueryInterface.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Native, exact-key projection of declared parent association values.default voidGetInterface.validateInput(GetInput getInput) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.messaging
Methods in com.kingsrook.qqq.backend.core.actions.messaging that throw QExceptionModifier and TypeMethodDescriptionSendMessageAction.execute(SendMessageInput input) Dispatch through the named provider. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.metadata
Methods in com.kingsrook.qqq.backend.core.actions.metadata that throw QExceptionModifier and TypeMethodDescriptionMetaDataAction.execute(MetaDataInput metaDataInput) ProcessMetaDataAction.execute(ProcessMetaDataInput processMetaDataInput) TableMetaDataAction.execute(TableMetaDataInput tableMetaDataInput) default voidMetaDataActionCustomizerInterface.postProcess(MetaDataOutput metaDataOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.metadata.personalization
Methods in com.kingsrook.qqq.backend.core.actions.metadata.personalization that throw QExceptionModifier and TypeMethodDescriptionstatic QTableMetaDataTableMetaDataPersonalizerAction.execute(AbstractTableActionInput tableActionInput) execute the personalizer, using the table in the tableActionInput param, returning the table that was modified (as a clone!)static QTableMetaDataTableMetaDataPersonalizerAction.execute(AbstractTableActionInput tableActionInput, boolean applyFieldSecurityLocks) Variant of execute that lets the caller (e.g., a core action that has already decided whether permissions are enforced for this call) say whether fields denied to the session by a FieldSecurityLock should be removed from the returned table (in addition to any personalizer changes).TableMetaDataPersonalizerInterface.execute(TableMetaDataPersonalizerInput tableMetaDataPersonalizerInput) It is vitally important that theQTableMetaDatareturned is a clone if it has any changes, to avoid changing the meta data for the whole application! -
Uses of QException in com.kingsrook.qqq.backend.core.actions.permissions
Methods in com.kingsrook.qqq.backend.core.actions.permissions that throw QExceptionModifier and TypeMethodDescriptionstatic voidAssociatedWritePermissions.check(DeleteInput input) The caller has already authorized DELETE on the parent table.static voidAssociatedWritePermissions.check(InsertInput input) The caller has already authorized INSERT on the parent table.static voidAssociatedWritePermissions.check(UpdateInput input) The caller has already authorized EDIT on the parent table.static voidCorePermissionEnforcer.checkAssociatedWrites(AbstractTableActionInput input) For write actions that are being enforced: check permissions (and field security locks) for the associated child records the write will insert, update or delete - including an update's omitted children and a delete's cascades.static voidPermissionsHelper.checkJoinedTableReadPermissions(AbstractTableActionInput input, List<QueryJoin> queryJoins, QQueryFilter filter) Call after the base table's READ check.static booleanCorePermissionEnforcer.checkProcessPermission(AbstractActionInput input, String processName, Map<String, Serializable> processValues) If enforcing for this input, check the process permission (using the input's process values, for custom permission checkers that consider them).CorePermissionEnforcer.checkReadCriteria(AbstractTableActionInput input, List<QueryJoin> queryJoins, QQueryFilter filter, Collection<String> additionalFieldNames) For read-style actions that are being enforced: check READ on every joined table (explicit or implied by the filter), and that the filter / additional field names satisfy field access policy.static booleanCorePermissionEnforcer.checkTablePermissions(AbstractTableActionInput input, TablePermissionSubType... permissionSubTypes) If enforcing for this input, check the table permission(s) - throwing QPermissionDeniedException if denied.static voidAssociatedWritePermissions.checkWithFieldSecurityLocks(DeleteInput input) As check, also rejecting child records that write fields denied to the session by a FieldSecurityLock (used by the core actions when enforcing).static voidAssociatedWritePermissions.checkWithFieldSecurityLocks(InsertInput input) As check, also rejecting child records that write fields denied to the session by a FieldSecurityLock (used by the core actions when enforcing).static voidAssociatedWritePermissions.checkWithFieldSecurityLocks(UpdateInput input) As check, also rejecting child records that write fields denied to the session by a FieldSecurityLock (used by the core actions when enforcing). -
Uses of QException in com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess
Methods in com.kingsrook.qqq.backend.core.actions.permissions.fieldaccess that throw QException -
Uses of QException in com.kingsrook.qqq.backend.core.actions.preferences
Methods in com.kingsrook.qqq.backend.core.actions.preferences that throw QExceptionModifier and TypeMethodDescriptionUserPreferencesAction.getSection(String name) Load the session user's section, or hide it with not found.UserPreferencesAction.listSections()List only visible installed sections, ordered by order then label.KeyValueUserPreferenceProvider.load(UserPreferenceRequestContext context) Load only rows owned by the session user and this section; absent rows use defaults.UserPreferencesAction.patchSection(String name, UserPreferenceChange change) Apply a typed partial change from an in-process caller.UserPreferencesAction.patchSection(String name, Map<String, ?> body) Validate the complete body without discarding unknown properties.Validate action inputs and row ownership before entering trusted provider code.voidKeyValueUserPreferenceProvider.store(UserPreferenceRequestContext context, UserPreferenceChange change) Write partial changes through standard actions, retaining audit attribution. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.processes
Methods in com.kingsrook.qqq.backend.core.actions.processes that throw QExceptionModifier and TypeMethodDescriptionvoidBackendStepListener.afterBackendStep(String stepName, ProcessState processState) Called after a backend step.protected StringRunProcessAction.determineBasepullKeyValue(QProcessMetaData process, RunProcessInput runProcessInput, BasepullConfiguration basepullConfiguration) CancelProcessAction.execute(RunProcessInput runProcessInput) RunBackendStepAction.execute(RunBackendStepInput runBackendStepInput) RunProcessAction.execute(RunProcessInput runProcessInput) static Optional<ProcessState> RunProcessAction.getStateForUser(String processUUID, String processName) External reads must verify ownership before exposing any stored values.static InputStreamOpen only an exact registered path belonging to the active session.protected voidRunProcessAction.persistLastRunTime(RunProcessInput runProcessInput, QProcessMetaData process, BasepullConfiguration basepullConfiguration) Lookup the last runtime for this basepull, and set it (plus now) in the process's values.static StringGrant access to an existing process output and return its canonical path.static voidProcessStateAccess.requireAccess(ProcessStateAccess access, String expectedName, String expectedUUID) Unowned internal state cannot be made public by presenting its identifier.voidProcessStateAccess.requireAccess(String expectedName, String expectedUUID) A null expected name is used by process-dependent possible-value lookups.voidBackendStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.protected voidRunProcessAction.storeLastRunTime(RunProcessInput runProcessInput, QProcessMetaData process, BasepullConfiguration basepullConfiguration) Insert or update the last runtime value for this basepull into the backend. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.queues
Methods in com.kingsrook.qqq.backend.core.actions.queues that throw QExceptionModifier and TypeMethodDescriptionGetQueueSize.getQueueSize(QQueueProviderMetaData queueProviderMetaData, QQueueMetaData queueMetaData) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.reporting
Method parameters in com.kingsrook.qqq.backend.core.actions.reporting with type arguments of type QExceptionModifier and TypeMethodDescriptionvoidRecordPipe.setPostRecordActions(UnsafeConsumer<List<QRecord>, QException> postRecordActions) Methods in com.kingsrook.qqq.backend.core.actions.reporting that throw QExceptionModifier and TypeMethodDescriptionvoidvoidvoidAdd a record to the pipe.voidBufferedRecordPipe.addRecords(List<QRecord> records) voidDistinctFilteringRecordPipe.addRecords(List<QRecord> records) voidRecordPipe.addRecords(List<QRecord> records) Add a list of records to the pipe.ExportAction.execute(ExportInput exportInput) Run the report.GenerateReportAction.execute(ReportInput reportInput) voidBufferedRecordPipe.finalFlush()protected voidBufferedRecordPipe.flush()protected voidRecordPipeBufferedWrapper.flush()when it's time to actually add records into the pipe (flushing from buffer int pipe), actually add them into the wrapped pipe!voidExportAction.preExecute(ExportInput exportInput) Validation logic, that will run before the action is executed -- ideally, if a caller is going to run the execution in a thread, they'd call this method first, in their thread, to catch any validation errors before they start the thread (which they may abandon).voidExportsFullInstanceVerifier.verify(Collection<QTableMetaData> tables) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.reporting.customizers
Methods in com.kingsrook.qqq.backend.core.actions.reporting.customizers that throw QExceptionModifier and TypeMethodDescriptionvoidReportCustomRecordSourceInterface.execute(ReportInput reportInput, QReportDataSource reportDataSource, RecordPipe recordPipe) Given the report input, put records into the pipe, for the report.DataSourceQueryInputCustomizer.run(ReportInput reportInput, QueryInput queryInput) -
Uses of QException in com.kingsrook.qqq.backend.core.actions.scripts
Methods in com.kingsrook.qqq.backend.core.actions.scripts that throw QExceptionModifier and TypeMethodDescriptionvoidQqqScriptUtils.delete(String tableName, QQueryFilter filter) voidvoidQqqScriptUtils.delete(String tableName, Serializable primaryKey) voidvoidRecordScriptTestInterface.execute(TestScriptInput input, TestScriptOutput output) default voidTestScriptActionInterface.execute(TestScriptInput input, TestScriptOutput output) Execute a test script.voidvoidvoidAssociatedScriptContextPrimerInterface.primeContext(ExecuteCodeInput executeCodeInput, ScriptRevision scriptRevision) QqqScriptUtils.query(QueryInput queryInput) QqqScriptUtils.query(String tableName, QQueryFilter filter) voidExecuteCodeAction.run(ExecuteCodeInput input, ExecuteCodeOutput output) voidRunAdHocRecordScriptAction.run(RunAdHocRecordScriptInput input, RunAdHocRecordScriptOutput output) voidRunAssociatedScriptAction.run(RunAssociatedScriptInput input, RunAssociatedScriptOutput output) voidStoreAssociatedScriptAction.run(StoreAssociatedScriptInput input, StoreAssociatedScriptOutput output) static ExecuteCodeInputExecuteCodeAction.setupExecuteCodeInput(AbstractRunScriptInput<?> input, ScriptRevision scriptRevision) static ExecuteCodeInputExecuteCodeAction.setupExecuteCodeInput(AbstractRunScriptInput<?> input, ScriptRevision scriptRevision, String fileName) voidRecordScriptTestInterface.setupTestScriptInput(TestScriptInput testScriptInput, ExecuteCodeInput executeCodeInput) voidTestScriptActionInterface.setupTestScriptInput(TestScriptInput testScriptInput, ExecuteCodeInput executeCodeInput) Called to adapt or translate data from the TestScriptInput (which would just have a map of name-value pairs) to the actual input object(s) used by the script.voidvoid -
Uses of QException in com.kingsrook.qqq.backend.core.actions.tables
Method parameters in com.kingsrook.qqq.backend.core.actions.tables with type arguments of type QExceptionModifier and TypeMethodDescriptionvoidKeysetPager.forEachPage(UnsafeConsumer<List<QRecord>, QException> consumer) Run the consumer on each page, in primary key order, until the records are exhausted.Methods in com.kingsrook.qqq.backend.core.actions.tables that throw QExceptionModifier and TypeMethodDescriptionstatic QueryInputGetAction.convertGetInputToQueryInput(GetInput getInput) StorageAction.createOutputStream(StorageInput storageInput) create an output stream in the storage backend - that can be written to, for the purpose of inserting or writing a file into storage.ConditionalUpdateAction.databaseNow(String tableName) The backend clock for the backend that holds a table.voidStorageAction.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.AggregateAction.execute(AggregateInput aggregateInput) intConditionalUpdateAction.execute(ConditionalUpdateInput input) Run the update; return the number of rows updated.CountAction.execute(CountInput countInput) static IntegerCountAction.execute(String tableName, QQueryFilter filter) shorthand way to call for the most common use-case, when you just want the count to be returned, and you just want to pass in a table name and filter.DeleteAction.execute(DeleteInput deleteInput) static QRecordGetAction.execute(String tableName, Serializable primaryKey) more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and primary key.static QRecordGetAction.execute(String tableName, Map<String, Serializable> uniqueKey) more shorthand way to call for the most common use-case, when you just want the output record to be returned, and you just want to pass in a table name and unique keyInsertAction.execute(InsertInput insertInput) QueryAction.execute(QueryInput queryInput) QueryAction.execute(QueryInput input, String actionName) Execute with the owning egress action name, including export reveal suppression.QueryAction.execute(String tableName, QQueryFilter filter) shorthand way to call for the most common use-case, when you just want the records to be returned, and you just want to pass in a table name and filter.static <T extends QRecordEntity>
List<T> QueryAction.execute(String tableName, Class<T> entityClass, QQueryFilter filter) shorthand way to call for the most common use-case, when you just want the entities to be returned, and you just want to pass in a table name and filter.RecordSearchAction.execute(RecordSearchInput input) ReplaceAction.execute(ReplaceInput input) StreamedAggregateEvaluator.execute(AggregateInput input) Execute the fallback with the configured row budget.StreamedAggregateEvaluator.execute(AggregateInput input, int rowLimit, boolean samplingSupported) Paged reads retain only group accumulators, plus percentile/distinct values up to the row budget.UpdateAction.execute(UpdateInput updateInput) GetAction.executeForRecord(GetInput getInput) shorthand way to call for the most common use-case, when you just want the output record to be returned.InsertAction.executeForRecord(InsertInput insertInput) UpdateAction.executeForRecord(UpdateInput updateInput) InsertAction.executeForRecords(InsertInput insertInput) UpdateAction.executeForRecords(UpdateInput updateInput) GetAction.executeViaQuery(GetInput getInput) Run a GetAction by using the QueryAction instead (e.g., with a filter made from the pkey/ukey, and returning the single record if found).voidKeysetPager.forEachPage(UnsafeConsumer<List<QRecord>, QException> consumer) Run the consumer on each page, in primary key order, until the records are exhausted.StorageAction.getDownloadURL(StorageInput storageInput) StorageAction.getInputStream(StorageInput storageInput) create an input stream in the storage backend - that can be read from, for the purpose of getting or reading a file from storage.static List<Serializable> DeleteAction.getPrimaryKeysFromQueryFilter(DeleteInput deleteInput) For an implementation that doesn't support a queryFilter as its input, but a scenario where a query filter was passed in - run the query, to get a list of primary keys.booleanKeysetPager.isPrimaryKeyOrderable()Is the table's primary key of a type that can be keyset-paged?voidStorageAction.makePublic(StorageInput storageInput) KeysetPager.pageIterator()Iterate over pages (lazily - each is queried as the iterator is advanced).DeleteAction.performValidations(DeleteInput deleteInput, Optional<List<QRecord>> oldRecordList, boolean isPreview) this method takes in the deleteInput, and the list of old records that matched the pkeys in that input.voidInsertAction.performValidations(InsertInput insertInput, boolean isPreview, boolean didAlreadyRunCustomizer) voidUpdateAction.performValidations(UpdateInput updateInput, Optional<List<QRecord>> oldRecordList, boolean isPreview) GetAction.postRecordActions(QRecord record) Run the necessary actions on a record.voidQueryAction.postRecordActions(List<QRecord> records) Run the necessary actions on a list of records (which must be a mutable list - e.g., not one created via List.of()).KeysetPager.recordIterator()Iterate over individual records, fetching a page at a time.RecordSearchProviderInterface.search(RecordSearchInput input) Search the claimed tables. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.tables.helpers
Methods in com.kingsrook.qqq.backend.core.actions.tables.helpers that throw QExceptionModifier and TypeMethodDescriptionstatic booleanValidateRecordSecurityLockHelper.allowedToReadRecord(QTableMetaData table, QRecord record, QSession qSession, QBackendTransaction transaction) return boolean if given session can read given recordUniqueKeyLookup.findConflicts(QTableMetaData activeTable, UniqueKey declaredKey, QRecord candidate, QBackendTransaction transaction) Keep all native matches associated with this one declared key predicate.static Map<QRecord, Serializable> UniqueKeyHelper.findMatches(QTableMetaData table, List<QRecord> records, UniqueKey key, boolean allowNullKeyValuesToEqual, InputSource inputSource, QBackendTransaction transaction) Match a complete Replace request against native READ-visible values.static List<Serializable> AssociatedRecordDiscovery.findPrimaryKeys(QTableMetaData parentTable, Association association, List<AssociatedRecordDiscovery.Parent> parents, QBackendTransaction transaction) Resolve only the supplied parent's declared association and relationship values.static Map<List<Serializable>, Serializable> UniqueKeyHelper.getExistingKeys(QBackendTransaction transaction, QTableMetaData table, List<QRecord> recordList, UniqueKey uniqueKey) static Map<List<Serializable>, Serializable> UniqueKeyHelper.getExistingKeys(QBackendTransaction transaction, QTableMetaData table, List<QRecord> recordList, UniqueKey uniqueKey, boolean allowNullKeyValuesToEqual) SelectionValidationHelper.getUnrecognizedFieldNames(QueryOrCountInputInterface input, Set<String> fieldNames) For the given set of field names, and a query (or aggregate) input - figure out if any field names (which may be joinTable (or alias) dot field name) - figure out if any of those aren't recognized fields in the input table or any tables that'll e joined.voidGetActionCacheHelper.handleCaching(GetInput getInput, GetOutput getOutput) voidQueryActionCacheHelper.handleCaching(QueryInput queryInput, QueryOutput queryOutput) booleanCollection adapters match only the exact typed target primary keys.booleanNative collection adapters use metadata-typed equality on raw values.static QTableMetaDataAssociatedRecordDiscovery.physicalParentTable(QTableMetaData active) Retain the active write graph and routing while privately restoring physical fields removed from display metadata.static Map<QRecord, AssociatedRecordUpdate.Values> AssociatedRecordUpdate.prepare(QTableMetaData activeTable, List<QRecord> records, QBackendTransaction transaction) Existing membership uses stored tuples; assignments use normalized patch overlays.static ObjectAssociatedRecordUpdate.primaryKey(QTableMetaData table, QRecord record) Typed Java bookkeeping for exact target identifiers, including numeric scale.AssociatedRecordDiscovery.readParentValues(QTableMetaData activeParentTable, List<Association> associations, List<Serializable> primaryKeys, QBackendTransaction transaction) Read exact stored parent keys and only their declared relationship fields.UniqueKeyLookup.readStoredComponents(QTableMetaData activeTable, List<Serializable> typedPrimaryKeys, QBackendTransaction transaction) Fetch only declared key components for exact typed target primary keys.static AssociationJoinAssociationJoin.resolve(QTableMetaData parentTable, Association association) Resolve the supplied parent's declared graph, including personalized metadata.static QQueryFilterCurrentUserFilterHelper.resolve(QueryOrCountInputInterface input, QQueryFilter filter) Copy only when necessary, so reusable filters retain their expressions.static voidValidateContingentPossibleValuesHelper.validate(QTableMetaData table, List<QRecord> records, List<QRecord> oldRecords, QBackendTransaction transaction) Null oldRecords means insert; updates may supply an empty list to fetch only missing values needed for touched dependent fields.static voidFilterValidationHelper.validateFieldNamesInFilter(QueryOrCountInputInterface input) throw an exception if a filter contains any field names (in its criteria or orderBys) that aren't in the input table (which may be user-personalized).static voidUniqueKeyHelper.validateInsertBatchKeys(InsertInput input) Reserve in-request keys only after required-field and security validation.static voidUniqueKeyHelper.validateInsertStoredKeys(InsertInput input) Persisted conflicts remain checked at the existing INSERT unique-key phase.static voidValidateRecordSecurityLockHelper.validateSecurityFields(QTableMetaData table, List<QRecord> records, ValidateRecordSecurityLockHelper.Action action, QBackendTransaction transaction) ValidateRecordSecurityLockHelper.validateStoredWriteLocks(QTableMetaData table, Map<Object, QRecord> visibleRecords, ValidateRecordSecurityLockHelper.Action action, QBackendTransaction transaction) Authorize stored owners before mutation without exposing private values to public results or the separate audit/customizer snapshot.static voidUniqueKeyHelper.validateUpdateUniqueKeys(UpdateInput input) Validate final sparse candidates without hydrating caller patches or replacing the ordinary access-checked old records. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.tables.listeners
Methods in com.kingsrook.qqq.backend.core.actions.tables.listeners that throw QExceptionModifier and TypeMethodDescriptionvoidRecordChangeListenerInterface.onRecordsChanged(RecordChangeEvent event) Called once per action with the records that were written without errors. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.tables.picker
Methods in com.kingsrook.qqq.backend.core.actions.tables.picker that throw QExceptionModifier and TypeMethodDescriptionRelatedRecordPickerAction.add(RelatedRecordPickerInput input) Insert one child row per target (or per given record), all or nothing.RelatedRecordPickerAction.prepare(RelatedRecordPickerInput input) Build (without saving) one child row per target, with defaults, values copied from the target, and the forced join values.RelatedRecordPickerAction.query(RelatedRecordPickerInput input) Query the target table: the user's filter AND the picker's filter AND the search, one page, with hasMore (no count) and the already-linked targets.RelatedRecordPickerAction.remove(RelatedRecordPickerInput input) Delete this parent's join rows for the given targets (LINK only).Find a table's picker and resolve its tables and join fields. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.tables.query
Methods in com.kingsrook.qqq.backend.core.actions.tables.query that throw QExceptionModifier and TypeMethodDescriptionVirtualFieldCriteriaExpanderInterface.expand(QTableMetaData table, QFilterCriteria criteria, CriteriaExpansionContext context) Expand one criterion, preserving its semantics as a nested filter.VirtualFieldCriteriaExpanderInterface.expandSearchTerm(QTableMetaData table, String term, SearchTermKind kind, CriteriaExpansionContext context) Return a matching filter, or null when this field does not match the term.static voidQueryFilterPreprocessor.prepare(QueryOrCountInputInterface input) Expand before validation, then prepare each sub-query for the backend. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.templates
Methods in com.kingsrook.qqq.backend.core.actions.templates that throw QExceptionModifier and TypeMethodDescriptionConvertHtmlToPdfAction.execute(ConvertHtmlToPdfInput input) RenderTemplateAction.execute(RenderTemplateInput input) static StringConvenient static wrapper to render a template of an arbitrary type (language).static StringRenderTemplateAction.renderVelocity(Map<String, Object> context, String code) Most convenient static wrapper to render a Velocity template. -
Uses of QException in com.kingsrook.qqq.backend.core.actions.values
Methods in com.kingsrook.qqq.backend.core.actions.values that throw QExceptionModifier and TypeMethodDescriptionSearchPossibleValueSourceAction.execute(SearchPossibleValueSourceInput input) BasicCustomPossibleValueProvider.getAllSourceObjects()BasicCustomPossibleValueProvider.getPossibleValue(Serializable idValue) QCustomPossibleValueProvider.getPossibleValue(Serializable idValue) protected abstract SBasicCustomPossibleValueProvider.getSourceObject(Serializable id) BasicCustomPossibleValueProvider.search(SearchPossibleValueSourceInput input) QCustomPossibleValueProvider.search(SearchPossibleValueSourceInput input) -
Uses of QException in com.kingsrook.qqq.backend.core.adapters
Methods in com.kingsrook.qqq.backend.core.adapters that throw QExceptionModifier and TypeMethodDescriptionvoidCsvToQRecordAdapter.buildRecordsFromCsv(RecordPipe recordPipe, String csv, QTableMetaData table, AbstractQFieldMapping<?> mapping, Consumer<QRecord> recordCustomizer) stream records from a CSV String into a RecordPipe, for a given table, optionally using a given mapping.voidCsvToQRecordAdapter.buildRecordsFromCsv(CsvToQRecordAdapter.InputWrapper inputWrapper) convert a CSV String into a List of QRecords, for a given table, optionally using a given mapping.CsvToQRecordAdapter.buildRecordsFromCsv(String csv, QTableMetaData table, AbstractQFieldMapping<?> mapping) convert a CSV String into a List of QRecords, for a given table, optionally using a given mapping.QQueryFilterJsonAdapter.jsonToQQueryFilter(String json) convert a JSON String into a QQueryFilter -
Uses of QException in com.kingsrook.qqq.backend.core.crypto
Methods in com.kingsrook.qqq.backend.core.crypto that throw QExceptionModifier and TypeMethodDescriptionstatic byte[]KeyMaterialUtils.decodeBase64Key(String base64Key, String settingName, int expectedLengthBytes) Decode base64 key text, requiring the given length in bytes.Get the current version of the key.Get a specific version of the key.StreamingArtifactCipher.newDecryptingStream(InputStream source) Wrap an input stream of encrypted data (as written by newEncryptingStream) so that reading from it yields the plaintext.StreamingArtifactCipher.newEncryptingStream(String keyRef, OutputStream destination) Wrap an output stream so that what is written to it is encrypted (under a new data key, wrapped by the CURRENT version of keyRef) into the destination.static String[]StreamingArtifactCipher.readKeyIdAndVersion(InputStream source) Read just the key id and version named in the header of an encrypted stream (consumes the header from the stream).static voidKeyMaterialUtils.validateKeyId(String keyId, String settingName) Make sure a key id (or version) can be embedded in a stored format. -
Uses of QException in com.kingsrook.qqq.backend.core.exceptions
Subclasses of QException in com.kingsrook.qqq.backend.core.exceptionsModifier and TypeClassDescriptionclassException thrown doing authenticationclassException thrown doing authenticationclassUser-facing exception for when user provided bad or missing data in their requestclassException thrown while executing custom code in QQQ.classException thrown while generating reportsclassException thrown during qqq-starup, if a QInstance is found to have validation issues.classException thrown while doing module-dispatchclassUser-facing exception for when something wasn't found (e.g., a named table or record-by-id).classException thrown if user doesn't have permission for an actionclassException thrown while generating reportsclassA user-facing refusal because a capacity limit was reached (HTTP 429), e.g., too many queued durable jobs for one user.classException with a good-quality message meant to be shown to an end-user.classCarries a per-record conflict to transports that use an HTTP conflict response.Methods in com.kingsrook.qqq.backend.core.exceptions that return QExceptionModifier and TypeMethodDescriptionQException.withHasLoggedError(boolean hasLoggedError) Fluent setter for hasLoggedErrorQException.withHasLoggedWarning(boolean hasLoggedWarning) Fluent setter for hasLoggedWarning -
Uses of QException in com.kingsrook.qqq.backend.core.health
Methods in com.kingsrook.qqq.backend.core.health that throw QExceptionModifier and TypeMethodDescriptionvoidHealthMetaDataProvider.defineAll(QInstance qInstance, String backendName, Consumer<QTableMetaData> enricher) Install metadata on the application's chosen backend.HealthLatencyWidget.render(RenderWidgetInput input) A missing record id returns an honest empty chart, never sample data.HealthWidgets.render(RenderWidgetInput input) Use the ordinary widget action's session and table read permissions.HealthChecksMetaData.resolveAll(QInstance qInstance) Resolve dynamic checks without letting a supplier escape its namespace.HealthCheck.run(HealthCheckInput input) Run the probe; expected failures should be returned as outcomes.On-demand uses a unique request id and deliberately ignores enabled.voidHealthRunCheckNowProcess.Run.runOnePage(RunBackendStepInput input, RunBackendStepOutput output) Reuse the application runner where available.voidHealthRunner.start()Synchronize definitions before beginning fixed-delay ticks.Return checks with stable names beneath the supplier name prefix.static longSweep using the current automated session.Sync a newly resolved snapshot. -
Uses of QException in com.kingsrook.qqq.backend.core.instances
Methods in com.kingsrook.qqq.backend.core.instances that throw QExceptionModifier and TypeMethodDescriptionAbstractMetaDataProducerBasedQQQApplication.defineQInstance()abstract QInstanceAbstractQQQApplication.defineQInstance()ConfigFilesBasedQQQApplication.defineQInstance()AbstractQQQApplication.defineValidatedQInstance()static voidQInstanceEnricher.discoverAndAddPluginsInPackage(String packageName) scan the classpath for classes in the specified package name which implement the QInstanceEnricherPluginInterface - any found get addedvoidQMetaDataVariableInterpreter.interpretObject(Object o) voidStart the service, for the application's (validated) instance. -
Uses of QException in com.kingsrook.qqq.backend.core.instances.loaders
Methods in com.kingsrook.qqq.backend.core.instances.loaders that throw QExceptionModifier and TypeMethodDescriptionstatic voidMetaDataLoaderHelper.processAllMetaDataFilesInDirectory(QInstance instance, String path) Load top-level metadata in filename order, recursively.static QMetaDataObjectMetaDataLoaderHelper.readMetaDataFile(QInstance instance, InputStream input, String fileName) Read a YAML/JSON stream. -
Uses of QException in com.kingsrook.qqq.backend.core.jobs
Methods in com.kingsrook.qqq.backend.core.jobs that throw QExceptionModifier and TypeMethodDescriptionstatic <T> TSystemScope.call(SystemScope.Body<T> body) Run the body under a system session in the current instance, keeping the current transaction, then restore the caller's context.static StringTake a control action on a job, as the current session.voidDurableJobsMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) Add every durable-jobs table, join, possible-value source, security key type and control process to the instance.static Map<String, Serializable> Write a job's failed rows as CSV to the jobs storage table and grant the current session its download.static Map<String, Serializable> DurableJobs.downloadFailedRows(Integer jobId) Write a job's failed rows as CSV for download (standard process download values: downloadFileName, storageTableName, storageReference).static voidRe-evaluate a job's status from its chunks (finish, pause or cancel it when its chunks allow).static QSessionBuild the session a job's chunk runs under.static IntegerDurableJobs.launch(LaunchRequest request) Launch a process as a durable job, as the current session's user.static IntegerScheduledJobs.launchIfDurable(QProcessMetaData process, Map<String, Serializable> values) When a scheduled run of the process should be a job, launch it and return the job id.static Optional<RunBackendStepOutput> DurableJobDiversion.maybeDivert(RunBackendStepInput input, QProcessMetaData process, QBackendStepMetaData step) If this backend step should become a durable job, launch it and return the step's output; else empty (run the step as usual).static voidFailedRows.resolveAfterRetry(QRecord retryJob) A retry job finished: its parent's rows that did not fail again are resolved.static IntegerLaunch a child job over a job's unresolved failed rows.static IntegerDurableJobs.retryFailedRows(Integer jobId, String correctedProfileJson, Integer correctedSavedProfileId) Retry a job's failed rows as a child job, optionally with a corrected bulk-load profile (JSON, or a saved profile id).SystemScope.Body.run()static IntegerRun again and return the child id to clients.static DurableJobsMetaDataDurableJobs.settings()The instance settings; throws when durable jobs are off.static QRecordStatus of a job the current session can see (owner or jobs_admin). -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.effects
Methods in com.kingsrook.qqq.backend.core.jobs.effects that throw QExceptionModifier and TypeMethodDescriptionClaim up to batch effects that are due: PENDING (deliver) and UNKNOWN not yet sent to review (reconcile).EffectStore.countsForJob(Integer jobId) A job's effects, summarized for its finalizer.intEffectDispatcher.dispatchOnce()One pass: reap dead dispatchers' leases, then claim and handle a batch.static StringJobEffects.emit(RunBackendStepInput input, String effectName, String rowKey, Map<String, Serializable> payload) Emit a declared effect for a row (rowKey: a stable id of the row the effect is for, e.g. its primary key).static StringJobEffects.emit(RunBackendStepInput input, String effectName, String rowKey, Map<String, Serializable> payload, String payloadRef) Emit a declared effect, with a reference to a larger stored payload.static booleanJobEffects.emitForJob(Integer jobId, JobLevelEffect effect) Write a job-level effect (not from a chunk) to the outbox, with key jobId:-1:rowKey:effectName.Read an effect (as the system user).static EffectTargetThe target registered under the name in the current instance.intEffectStore.insertEffects(List<QRecord> effects, QBackendTransaction transaction) Write outbox rows (in the chunk's transaction when given).EffectStore.markNotDelivered(EffectLease lease, String message, boolean retry) Definitely not delivered: retry later with backoff, or FAILED when the attempts are used up (or retry is false).booleanEffectStore.markNotFound(EffectLease lease) A reconcile lookup found the effect was definitely not delivered: due again (safe to send).booleanEffectStore.markSent(EffectLease lease, String providerRef) Delivered.EffectStore.markUnknown(EffectLease lease, JobEffectType type, String message) The outcome is unknown (it may have been delivered).EffectStore.now()The database clock.EffectStore.query(QQueryFilter filter) Query the outbox (as the system user).EffectStore.reapExpired()Leases held past their expiry (the dispatcher died mid-delivery): the outcome is unknown.booleanEffectStore.resolve(Integer effectId, EffectStatus to, String note) Review: an operator resolves an effect (not while a dispatcher holds it). -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.plans
Subclasses of QException in com.kingsrook.qqq.backend.core.jobs.plansModifier and TypeClassDescriptionclassThrown from a cooperative check to stop a chunk at a safe point: the job was paused or cancelled, this pod is draining, or the lease was lost.Methods in com.kingsrook.qqq.backend.core.jobs.plans that throw QExceptionModifier and TypeMethodDescriptionvoidChunkContext.check()The cooperative check: throw JobInterruptedException when the chunk should stop here.voidJobChunkScope.PageCheck.check()Throw to stop the chunk here.static voidJobChunkScope.checkBetweenPages()Between pages: run the chunk's cooperative check, if a job chunk with one is running on this thread (no-op otherwise).voidChunkContext.checkpoint(String checkpointJson) Save a checkpoint (fenced by the lease).voidChunkContext.completeInTransaction(ChunkOutcome outcome, List<QRecord> rowErrors, QBackendTransaction transaction) Mark the chunk DONE inside the plan's own transaction (SAME_TRANSACTION: the chunk's writes and its DONE mark commit together, fenced by the lease).voidChunkContext.completeInTransaction(ChunkOutcome outcome, List<QRecord> rowErrors, List<QRecord> effects, QBackendTransaction transaction) Mark the chunk DONE in the plan's transaction, with its row errors and its outbox effects: the chunk's writes, its effects and its DONE mark commit together (spec section 2.13).ChunkedProcessPlan.planChunks(QRecord job) JobPlan.planChunks(QRecord job) Plan the chunks for a newly launched job (runs as the launching user).static Map<String, Serializable> StepsJobPlan.readValues(String paramsJson) The job's parameter values (JSON object), or an empty map.voidChunkContext.recordEffects(List<QRecord> effects) Write outbox effects outside a transaction (keys already written are skipped, so a rerun never doubles them). -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.processes
Methods in com.kingsrook.qqq.backend.core.jobs.processes that throw QExceptionModifier and TypeMethodDescriptionvoidJobControlProcesses.Load.runOnePage(RunBackendStepInput input, RunBackendStepOutput output) voidJobControlProcesses.Transform.runOnePage(RunBackendStepInput input, RunBackendStepOutput output) voidJobEffectReviewProcesses.Load.runOnePage(RunBackendStepInput input, RunBackendStepOutput output) Apply the operator's decision, clear its alert, then re-evaluate job completion.voidJobEffectReviewProcesses.Transform.runOnePage(RunBackendStepInput input, RunBackendStepOutput output) Summarize eligible effects and explain why protected statuses are skipped. -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.progress
Methods in com.kingsrook.qqq.backend.core.jobs.progress that throw QExceptionModifier and TypeMethodDescriptionstatic voidFinalize with COMPLETED, FAILED or CANCELLED (the first final status wins).static voidRecord that the work is alive (progress flushes do this too).static voidRegister a listener run on this pod when a client cancels the job; it must stop the work and call finish(..., CANCELLED).static JobProgressA progress reporter for the tracking job (phases, counts, message, log).static voidJobProgressLifecycle.reclaimed(DurableJobStore store, QRecord chunk) Reset live fields to committed work, preserving the interrupted attempt log.static IntegerJobTracking.start(TrackedJobRequest request) Start a RUNNING tracking job; returns its jobs_job id. -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.runtime
Methods in com.kingsrook.qqq.backend.core.jobs.runtime that throw QExceptionModifier and TypeMethodDescriptionJobClaimer.claimNext()Claim the next chunk this pod may run, or empty when there is none.Re-evaluate one job.voidInlineJobTracker.finishTracked(Integer jobId, JobStatus terminal, String message) Finalize a tracking job (first terminal status wins).voidRecord that a tracking job is alive.voidInlineJobTracker.reap()Fail inline jobs whose worker heartbeat has disappeared.Start a fresh inline run with the captured process values.InlineJobTracker.startTracked(String processName, String label, String owner, String clientChannel, String tableName, Serializable recordId) Start a tracking job that no process backs (see JobTracking): RUNNING, owned by this pod, failed by the reaper if this pod goes away.Validate process ownership before creating or returning a tracking job. -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.store
Subclasses of QException in com.kingsrook.qqq.backend.core.jobs.storeModifier and TypeClassDescriptionclassThrown when a fenced chunk write finds that the lease is no longer held (it expired and was reclaimed).Methods in com.kingsrook.qqq.backend.core.jobs.store that throw QExceptionModifier and TypeMethodDescriptionvoidDurableJobStore.checkpoint(JobLease lease, String checkpointJson, QBackendTransaction transaction) Save a mid-chunk checkpoint (e.g., process values after a step).static <T> TSkipLockedClaims.claim(String tableName, QQueryFilter filter, SkipLockedClaims.Claimer<T> claimer) Lock the filter's rows (skipping locked ones) and claim them, in one transaction (as the system user).SkipLockedClaims.Claimer.claim(List<QRecord> lockedCandidates, QBackendTransaction transaction) Claim (conditionally update) the locked rows, in the transaction.DurableJobStore.claimChunk(QRecord chunk, String podId, int leaseTtlSeconds) Try to claim one specific claimable chunk.DurableJobStore.claimChunk(QRecord chunk, String podId, int leaseTtlSeconds, QBackendTransaction transaction) Claim one specific chunk, optionally in a (claiming) transaction.DurableJobStore.claimNextChunkSkipLocked(Integer jobId, String podId, int leaseTtlSeconds) Claim the job's next claimable chunk (lowest seq) that no other claimer has locked: FOR UPDATE SKIP LOCKED plus the fenced conditional update, in one transaction.voidDurableJobStore.completeChunk(JobLease lease, ChunkOutcome outcome, QBackendTransaction transaction) Mark a chunk DONE with its outcome.A chunk run threw.Read a chunk (as the system user).The chunks of a job, in sequence order.Read a job (as the system user).booleanRenew a lease.booleanDurableJobStore.heartbeat(JobLease lease, int leaseTtlSeconds, QBackendTransaction transaction) Renew under the progress transaction, holding the fence until its commit.voidDurableJobStore.insertChunks(List<QRecord> chunks, QBackendTransaction transaction) Insert planned chunks for a job.DurableJobStore.insertJob(QRecord job, QBackendTransaction transaction) Insert a job row; return its id.DurableJobStore.now()The database clock.DurableJobStore.query(String tableName, QQueryFilter filter) Query a jobs table (as the system user).DurableJobStore.reapExpired(String reaperPodId) Reclaim every RUNNING chunk whose lease expired (by the database clock).voidDurableJobStore.recordRowErrors(List<QRecord> rowErrors, QBackendTransaction transaction) Record row errors for a chunk (batched), in the chunk's transaction.DurableJobStore.refreshCounters(Integer jobId) Recompute a job's row and chunk counters from its chunks; return the chunks.booleanDurableJobStore.releaseChunk(JobLease lease, ChunkStatus to) Give a chunk back without counting the attempt (graceful drain, pause): RUNNING -> PENDING.intDurableJobStore.setChunkStatuses(Integer jobId, Collection<ChunkStatus> from, ChunkStatus to, Map<String, Serializable> extraValues) Set chunks of a job from some statuses to another (control actions).booleanDurableJobStore.setJobStatus(Integer jobId, Collection<JobStatus> from, JobStatus to, Map<String, Serializable> extraValues) Compare-and-set a job's status: from one of the expected statuses to a new one, setting any extra values at the same time.booleanDurableJobStore.setJobStatusWithEvent(Integer jobId, Collection<JobStatus> from, JobStatus to, Map<String, Serializable> extraValues, JobEventType eventType, String detail) Compare-and-set a job's status and record its timeline event in one transaction, so a reader that sees the new status also sees the event (status first and event after left a window where a finished job had no COMPLETED event yet).voidDurableJobStore.updateJob(Integer jobId, Map<String, Serializable> values) Set values on a job without a status condition (counters, reasons). -
Uses of QException in com.kingsrook.qqq.backend.core.jobs.uploads
Methods in com.kingsrook.qqq.backend.core.jobs.uploads that throw QExceptionModifier and TypeMethodDescriptionstatic voidUploadRefs.extendForJob(String ref, Integer jobId) A job uses this upload: keep it at least uploadExpiryDays from now.static QRecordThe upload row for a ref the current user may use (owner, or jobs_admin), if it has not expired.static StorageInputWhere an upload's bytes are (checks the ref as get does).static UploadRefUploadRefs.register(String fileName, StorageInput existing) Give a ref to a file that is already in a storage table (e.g., the bulk insert wizard's process upload), owned by the current user.static UploadRefUploadRefs.store(String fileName, String contentType, InputStream inputStream) Stream a file into the uploads storage table as the current user; return its ref. -
Uses of QException in com.kingsrook.qqq.backend.core.model.actions.processes
Methods in com.kingsrook.qqq.backend.core.model.actions.processes that throw QExceptionModifier and TypeMethodDescriptionstatic <T extends QProcessPayload>
TQProcessPayload.fromProcessState(Class<T> c, ProcessState processState) Build an entity of this QRecord type from a QRecord<T extends QProcessPayload>
TRunBackendStepInput.getProcessPayload(Class<T> payloadClass) return a QProcessPayload subclass instance, with values populated from the current process state.<E extends QRecordEntity>
List<E> RunBackendStepInput.getRecordsAsEntities(Class<E> entityClass) Getter for records converted to entities of a given type. -
Uses of QException in com.kingsrook.qqq.backend.core.model.actions.tables.query
Methods in com.kingsrook.qqq.backend.core.model.actions.tables.query that throw QExceptionModifier and TypeMethodDescriptionvoidAdd a record to this output.voidQueryOutput.addRecords(List<QRecord> records) add a list of records to this outputJoinsContext.forSubQuery(String tableName, QQueryFilter filter) Build an independent, secured context for a sub-query, preserving the input source used by table personalization.<T extends QRecordEntity>
List<T> QueryOutput.getRecordEntities(Class<T> entityClass) voidQQueryFilter.interpretValues(Map<String, Serializable> inputValues) Replace any criteria values that look like ${input.XXX} with the value of XXX from the supplied inputValues map.voidQQueryFilter.interpretValues(Map<String, Map<String, Serializable>> valueMap, FilterUseCase useCase) Replace any criteria values that look like ${input.XXX} with the value of XXX from the supplied valueMap map - where the handling of missing values is specified in the inputted FilterUseCase parameter input values is a map of maps, so that more than one 'inputValue' map can be used e.g.Constructors in com.kingsrook.qqq.backend.core.model.actions.tables.query that throw QExceptionModifierConstructorDescriptionJoinsContext(QInstance instance, QueryOrCountInputInterface input, QQueryFilter filter) Keep the active root metadata and personalize joined tables using the same input source.JoinsContext(QInstance instance, String tableName, List<QueryJoin> queryJoins, QQueryFilter filter) Primary constructor.JoinsContext(String tableName, QQueryFilter filter, boolean omitSecurity) Constructor that starts with an empty join list and optionally skips security-lock processing.JoinsContext(String tableName, List<QueryJoin> queryJoins, QQueryFilter filter) -
Uses of QException in com.kingsrook.qqq.backend.core.model.actions.tables.query.expressions
Methods in com.kingsrook.qqq.backend.core.model.actions.tables.query.expressions that throw QExceptionModifier and TypeMethodDescriptionabstract TAbstractFilterExpression.evaluate(QFieldMetaData field) FilterVariableExpression.evaluate(QFieldMetaData field) Now.evaluate(QFieldMetaData field) NowWithOffset.evaluate(QFieldMetaData field) StartOfPeriod.evaluate(QFieldMetaData field) StartOfPeriod.evaluate(QFieldMetaData field, Instant now) Evaluate, as of a given moment (so tests don't depend on the clock).ThisOrLastPeriod.evaluate(QFieldMetaData field) AbstractFilterExpression.evaluateInputValues(Map<String, Serializable> inputValues) Evaluate the expression, given a map of input values.FilterVariableExpression.evaluateInputValues(Map<String, Serializable> inputValues) -
Uses of QException in com.kingsrook.qqq.backend.core.model.audits
Methods in com.kingsrook.qqq.backend.core.model.audits that throw QExceptionModifier and TypeMethodDescriptionvoidAuditsMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) voidAuditsMetaDataProvider.defineStandardAuditTables(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) -
Uses of QException in com.kingsrook.qqq.backend.core.model.automation
Constructors in com.kingsrook.qqq.backend.core.model.automation that throw QException -
Uses of QException in com.kingsrook.qqq.backend.core.model.backends
Methods in com.kingsrook.qqq.backend.core.model.backends that throw QExceptionModifier and TypeMethodDescriptionvoidQQQBackendsMetaDataProvider.defineAll(QInstance instance, String persistentBackendName, String cacheBackendName, Consumer<QTableMetaData> backendDetailEnricher) QQQBackendsMetaDataProvider.defineQQQBackend(String backendName, Consumer<QTableMetaData> backendDetailEnricher) QQQBackendsMetaDataProvider.defineQQQBackendCache(String backendName, Consumer<QTableMetaData> backendDetailEnricher) static IntegerQQQBackendTableManager.getQQQBackendId(QInstance qInstance, String backendName) -
Uses of QException in com.kingsrook.qqq.backend.core.model.bulk
Methods in com.kingsrook.qqq.backend.core.model.bulk that throw QExceptionModifier and TypeMethodDescriptionTableKeyFieldsPossibleValueSource.search(SearchPossibleValueSourceInput input) -
Uses of QException in com.kingsrook.qqq.backend.core.model.dashboard.widgets
Constructors in com.kingsrook.qqq.backend.core.model.dashboard.widgets that throw QExceptionModifierConstructorDescriptionChildRecordListData(String title, QueryOutput queryOutput, QTableMetaData childTableMetaData, String tablePath, String viewAllLink, Integer totalRows) -
Uses of QException in com.kingsrook.qqq.backend.core.model.data
Methods in com.kingsrook.qqq.backend.core.model.data that throw QExceptionModifier and TypeMethodDescriptionvoidQRecord.capturePrimaryKey(QTableMetaData table, Serializable primaryKey) Preserve an internal identity separately from its current presentation.static <T extends QRecordEntity>
TQRecordEntity.fromQRecord(Class<T> c, QRecord qRecord) Build an entity of this QRecord type from a QRecordstatic <T extends QRecordEntity>
TQRecordEntity.fromQRecord(Class<T> c, QRecord qRecord, String fieldNamePrefix) Build an entity of this QRecord type from a QRecord - where the fields for this entity have the given prefix - e.g., if they were selected as part of a join.static StringQRecordEntity.getTableName(Class<? extends QRecordEntity> entityClass) QRecord.resolvePrimaryKey(QTableMetaData table) Resolve an operational key without restoring it to values or displayValues.QRecordEntity.tableName()named without the 'get' to avoid conflict w/ entity fields named that...<T extends QRecordEntity>
TConvert this record to an QRecordEntitydefault QRecordQRecordEnum.toQRecord()Convert this entity to a QRecord. -
Uses of QException in com.kingsrook.qqq.backend.core.model.developer
Methods in com.kingsrook.qqq.backend.core.model.developer that throw QExceptionModifier and TypeMethodDescriptionDeveloperPanelProviderInterface.build(DeveloperPanelContext context) Build the panel's content.booleanDeveloperPanelProviderInterface.isAvailable(DeveloperPanelContext context) Whether this provider has anything to show for the context's table (and record) for the current user - e.g., the module is installed and active for the table, and the user may use it. -
Uses of QException in com.kingsrook.qqq.backend.core.model.helpcontent
Methods in com.kingsrook.qqq.backend.core.model.helpcontent that throw QExceptionModifier and TypeMethodDescriptionvoidHelpContentMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata
Methods in com.kingsrook.qqq.backend.core.model.metadata that throw QExceptionModifier and TypeMethodDescriptionstatic List<MetaDataProducerInterface<?>> MetaDataProducerHelper.findProducers(QInstance instance, String packageName) Find (but do not run) the meta-data producers in (and under) a package.static List<MetaDataProducerInterface<?>> MetaDataProducerHelper.findProducers(String packageName) Find (but do not run) the meta-data producers in (and under) a package.QInstance.getProcessPath(String processName) Get the full path to a process - note - this will be regardless of whether or not the active session/user has access to the process.QInstance.getTablePath(String tableName) Get the full path to a table - note - this will be regardless of whether or not the active session/user has access to the table.static voidMetaDataProducerHelper.processAllMetaDataProducersInPackage(QInstance instance, String packageName) Recursively find all classes in the given package, that implement MetaDataProducerInterface run them, and add their output to the given qInstance.static voidMetaDataProducerHelper.processAllMetaDataProducersInPackage(QInstance instance, String packageName, MetaDataCustomizerInterface<QTableMetaData> tableMetaDataCustomizer) Recursively find all classes in the given package, that implement MetaDataProducerInterface run them, and add their output to the given qInstance - using the provided tableMetaDataCustomizer to help with all RecordEntity's that are configured to make tables.Produce the metaData object. -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.authentication
Methods in com.kingsrook.qqq.backend.core.model.metadata.authentication that throw QExceptionModifier and TypeMethodDescriptionstatic QAuthenticationMetaDataAuthenticationResolver.resolve(QInstance instance, AuthResolutionContext context) Resolve the authentication provider for the given context. -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.dashboard.nocode
Methods in com.kingsrook.qqq.backend.core.model.metadata.dashboard.nocode that throw QExceptionModifier and TypeMethodDescriptionabstract ObjectAbstractWidgetValueSource.evaluate(Map<String, Object> context, RenderWidgetInput input) QueueSizeWidgetValue.evaluate(Map<String, Object> context, RenderWidgetInput input) WidgetAdHocValue.evaluate(Map<String, Object> context, RenderWidgetInput input) WidgetAggregate.evaluate(Map<String, Object> context, RenderWidgetInput input) WidgetCalculation.evaluate(Map<String, Object> context, RenderWidgetInput input) WidgetCount.evaluate(Map<String, Object> context, RenderWidgetInput input) WidgetQueryField.evaluate(Map<String, Object> context, RenderWidgetInput input) abstract String -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.fields
Methods in com.kingsrook.qqq.backend.core.model.metadata.fields that throw QExceptionModifier and TypeMethodDescriptionstatic QFieldTypeGet a field type enum constant for a java class.static FieldAndJoinTableFieldAndJoinTable.get(QTableMetaData mainTable, String fieldName) given a table, and a field-name string (which should either be the name of a field on that table, or another tableName + "." + fieldName (from that table) - get back the pair of table invalid input: '&' field metaData that the input string is talking about.static FieldAndJoinTableFieldAndJoinTable.get(QTableMetaData mainTable, String fieldName, Collection<QueryJoin> queryJoins, boolean allowVirtualFields) given a table, and a field-name string (which should either be the name of a field on that table, or another tableName + "." + fieldName (from that table - or an alias insteaad of tableName) - get back the pair of table invalid input: '&' field metaData that the input string is talking about.Constructors in com.kingsrook.qqq.backend.core.model.metadata.fields that throw QExceptionModifierConstructorDescriptionQFieldMetaData(com.github.hervian.reflection.Fun.With1ParamAndVoid<T> getterRef) Initialize a fieldMetaData from a reference to a getter on an entity.QFieldMetaData(Method getter) Initialize a fieldMetaData from a getter method from an entity -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.fields.functions
Methods in com.kingsrook.qqq.backend.core.model.metadata.fields.functions that throw QExceptionModifier and TypeMethodDescriptionFieldFunctionType.apply(FieldFunction fieldFunction, QRecord record) Applies this function to the given record's field value and returns the result.default SerializableFieldFunctionType.applyForSorting(FieldFunction fieldFunction, QRecord record) Applies this function for sort-order purposes. -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.fields.functions.implementations
Methods in com.kingsrook.qqq.backend.core.model.metadata.fields.functions.implementations that throw QExceptionModifier and TypeMethodDescriptionSubStringFunction.apply(FieldFunction fieldFunction, QRecord record) Extracts and returns the substring of the field value using 1-based fromIndex and optional length; returns null if the field value is null, or an empty string if fromIndex is beyond the string's length.WeekdayOfDateFunction.applyForSorting(FieldFunction fieldFunction, QRecord record) Returns the day-of-week value adjusted for sort ordering.WeekdayOfDateTimeFunction.applyForSorting(FieldFunction fieldFunction, QRecord record) Returns the day-of-week value adjusted for sort ordering. -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.messaging.email
Methods in com.kingsrook.qqq.backend.core.model.metadata.messaging.email that throw QExceptionModifier and TypeMethodDescriptionEmailMessagingProvider.sendMessage(SendMessageInput sendMessageInput) SendEmailAction.sendMessage(SendMessageInput sendMessageInput) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.messaging.ses
Methods in com.kingsrook.qqq.backend.core.model.metadata.messaging.ses that throw QExceptionModifier and TypeMethodDescriptionSendSESAction.sendMessage(SendMessageInput sendMessageInput) SESMessagingProvider.sendMessage(SendMessageInput sendMessageInput) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.preferences
Methods in com.kingsrook.qqq.backend.core.model.metadata.preferences that throw QExceptionModifier and TypeMethodDescriptionUserPreferenceProviderInterface.load(UserPreferenceRequestContext context) Load the user's values and fixed rows.default UserPreferenceActionResultUserPreferenceProviderInterface.runAction(UserPreferenceRequestContext context, UserPreferenceActionRequest request) Execute a validated action for the session user.voidUserPreferenceProviderInterface.store(UserPreferenceRequestContext context, UserPreferenceChange change) Store only the supplied fields and rows using ordinary audited table actions.UserPreferenceProviderInterface.validate(UserPreferenceRequestContext context, UserPreferenceChange change) Add domain validation after core has validated and coerced the partial change. -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.processes
Methods in com.kingsrook.qqq.backend.core.model.metadata.processes that throw QExceptionModifier and TypeMethodDescriptionQFunctionInputMetaData.getFieldThrowing(String name) Getter a field with the given name - throwing if it wasn't found -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.producers
Methods in com.kingsrook.qqq.backend.core.model.metadata.producers that throw QExceptionModifier and TypeMethodDescriptionMetaDataCustomizerInterface.customizeMetaData(QInstance qInstance, T metaData) MetaDataCustomizerInterface.NoopMetaDataCustomizer.customizeMetaData(QInstance qInstance, T metaData) Constructors in com.kingsrook.qqq.backend.core.model.metadata.producers that throw QExceptionModifierConstructorDescriptionRecordEntityToTableGenericMetaDataProducer(String tableName, Class<? extends QRecordEntity> entityClass, Class<? extends MetaDataCustomizerInterface<QTableMetaData>> metaDataProductionCustomizerClass) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.qbits
Subclasses of QException in com.kingsrook.qqq.backend.core.model.metadata.qbitsModifier and TypeClassDescriptionclassthrown by QBitConfig.validate() if there's an issue.Methods in com.kingsrook.qqq.backend.core.model.metadata.qbits that throw QExceptionModifier and TypeMethodDescriptiondefault <C extends QBitConfig>
voidQBitProducer.finishProducing(QInstance qInstance, QBitMetaData qBitMetaData, C qBitConfig, List<MetaDataProducerInterface<?>> producers) default voidQBitMetaDataProducer.postProduceActions(MetaDataProducerMultiOutput metaDataProducerMultiOutput, QInstance qinstance) default MetaDataProducerMultiOutputdefault voidvoid -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.scheduleing
Methods in com.kingsrook.qqq.backend.core.model.metadata.scheduleing that throw QExceptionModifier and TypeMethodDescriptionabstract QSchedulerInterfaceQSchedulerMetaData.initSchedulerInstance(QInstance qInstance, Supplier<QSession> systemSessionSupplier) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.quartz
Methods in com.kingsrook.qqq.backend.core.model.metadata.scheduleing.quartz that throw QExceptionModifier and TypeMethodDescriptionQuartzSchedulerMetaData.initSchedulerInstance(QInstance qInstance, Supplier<QSession> systemSessionSupplier) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.sharing
Methods in com.kingsrook.qqq.backend.core.model.metadata.sharing that throw QExceptionModifier and TypeMethodDescription -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.tables
Methods in com.kingsrook.qqq.backend.core.model.metadata.tables that throw QExceptionModifier and TypeMethodDescriptionQTableMetaData.withFieldsFromEntity(Class<? extends QRecordEntity> entityClass) -
Uses of QException in com.kingsrook.qqq.backend.core.model.metadata.variants
Methods in com.kingsrook.qqq.backend.core.model.metadata.variants that throw QExceptionModifier and TypeMethodDescriptionstatic SerializableBackendVariantsUtil.getVariantId(QBackendMetaData backendMetaData) Get the variant id from the session for the backend.static QRecordBackendVariantsUtil.getVariantRecord(QBackendMetaData backendMetaData) For backends that use variants, look up the variant record (in theory, based on an id in the session's backend variants map, then fetched from the backend's variant options table. -
Uses of QException in com.kingsrook.qqq.backend.core.model.processes
Methods in com.kingsrook.qqq.backend.core.model.processes that throw QExceptionModifier and TypeMethodDescriptionvoidQQQProcessesMetaDataProvider.defineAll(QInstance instance, String persistentBackendName, String cacheBackendName, Consumer<QTableMetaData> backendDetailEnricher) QQQProcessesMetaDataProvider.defineQQQProcess(String backendName, Consumer<QTableMetaData> backendDetailEnricher) QQQProcessesMetaDataProvider.defineQQQProcessCache(String backendName, Consumer<QTableMetaData> backendDetailEnricher) static IntegerQQQProcessTableManager.getQQQProcessId(QInstance qInstance, String processName) -
Uses of QException in com.kingsrook.qqq.backend.core.model.querystats
Methods in com.kingsrook.qqq.backend.core.model.querystats that throw QExceptionModifier and TypeMethodDescriptionvoidQueryStatMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) -
Uses of QException in com.kingsrook.qqq.backend.core.model.savedbulkloadprofiles
Methods in com.kingsrook.qqq.backend.core.model.savedbulkloadprofiles that throw QExceptionModifier and TypeMethodDescriptionvoidSavedBulkLoadProfileMetaDataProvider.defineAll(QInstance instance, String recordTablesBackendName, Consumer<QTableMetaData> backendDetailEnricher) SavedBulkLoadProfileMetaDataProvider.defineSavedBulkLoadProfileTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) SavedBulkLoadProfileMetaDataProvider.defineSharedSavedBulkLoadProfileTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) Constructors in com.kingsrook.qqq.backend.core.model.savedbulkloadprofiles that throw QExceptionModifierConstructorDescriptionSavedBulkLoadProfile(QRecord qRecord) ConstructorSharedSavedBulkLoadProfile(QRecord qRecord) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.savedreports
Methods in com.kingsrook.qqq.backend.core.model.savedreports that throw QExceptionModifier and TypeMethodDescriptionvoidSavedReportsMetaDataProvider.defineAll(QInstance instance, String recordTablesBackendName, String reportStorageBackendName, Consumer<QTableMetaData> backendDetailEnricher) SavedReportsMetaDataProvider.defineSavedReportTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) SavedReportsMetaDataProvider.defineSharedSavedReportTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) ScheduledReportSyncToScheduledJobProcess.populateRecordToStore(RunBackendStepInput runBackendStepInput, QRecord destinationRecord, QRecord sourceRecord) ScheduledReportTableCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) ScheduledReportTableCustomizer.postInsert(InsertInput insertInput, List<QRecord> records) ScheduledReportTableCustomizer.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) SavedReportTableCustomizer.preDelete(DeleteInput deleteInput, List<QRecord> records, boolean isPreview) SavedReportTableCustomizer.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) ScheduledReportTableCustomizer.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) SavedReportTableCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) ScheduledReportTableCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) ReportValuesDynamicFormWidgetRenderer.render(RenderWidgetInput input) SavedReportsFilterAndColumnsSetupRenderer.render(RenderWidgetInput input) static Map<Serializable, QRecord> SavedReportTableCustomizer.validateStoredOwner(List<QRecord> records, QTableMetaData table, QBackendTransaction transaction, String verb, boolean isUpdate) Validate saved-asset ownership using a private native snapshot.Constructors in com.kingsrook.qqq.backend.core.model.savedreports that throw QExceptionModifierConstructorDescriptionRenderedReport(QRecord qRecord) ConstructorSavedReport(QRecord qRecord) ConstructorScheduledReport(QRecord qRecord) ConstructorSharedSavedReport(QRecord qRecord) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.savedviews
Methods in com.kingsrook.qqq.backend.core.model.savedviews that throw QExceptionModifier and TypeMethodDescriptionvoidSavedViewsMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) SavedViewsMetaDataProvider.defineSavedViewTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) SavedViewsMetaDataProvider.defineSharedSavedViewTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) SavedViewTableCustomizer.preDelete(DeleteInput deleteInput, List<QRecord> records, boolean isPreview) SavedViewTableCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) Constructors in com.kingsrook.qqq.backend.core.model.savedviews that throw QExceptionModifierConstructorDescriptionQuickSavedView(QRecord qRecord) ConstructorConstructorSharedSavedView(QRecord qRecord) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.scheduledjobs
Methods in com.kingsrook.qqq.backend.core.model.scheduledjobs that throw QExceptionModifier and TypeMethodDescriptionvoidScheduledJobsMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) voidScheduledJobsMetaDataProvider.defineStandardTables(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) ScheduledJobTypePossibleValueSource.search(SearchPossibleValueSourceInput input) SchedulersPossibleValueSource.search(SearchPossibleValueSourceInput input) Constructors in com.kingsrook.qqq.backend.core.model.scheduledjobs that throw QExceptionModifierConstructorDescriptionScheduledJob(QRecord qRecord) ConstructorScheduledJobParameter(QRecord qRecord) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.scheduledjobs.customizers
Methods in com.kingsrook.qqq.backend.core.model.scheduledjobs.customizers that throw QExceptionModifier and TypeMethodDescriptionScheduledJobParameterTableCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) ScheduledJobTableCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) ScheduledJobParameterTableCustomizer.postInsert(InsertInput insertInput, List<QRecord> records) ScheduledJobTableCustomizer.postInsert(InsertInput insertInput, List<QRecord> records) ScheduledJobParameterTableCustomizer.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) ScheduledJobTableCustomizer.postUpdate(UpdateInput updateInput, List<QRecord> records, Optional<List<QRecord>> oldRecordList) ScheduledJobTableCustomizer.preInsert(InsertInput insertInput, List<QRecord> records, boolean isPreview) ScheduledJobTableCustomizer.preUpdate(UpdateInput updateInput, List<QRecord> records, boolean isPreview, Optional<List<QRecord>> oldRecordList) -
Uses of QException in com.kingsrook.qqq.backend.core.model.scripts
Methods in com.kingsrook.qqq.backend.core.model.scripts that throw QExceptionModifier and TypeMethodDescriptionvoidScriptsMetaDataProvider.defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) voidScriptsMetaDataProvider.defineStandardScriptsPossibleValueSources(QInstance instance) voidScriptsMetaDataProvider.defineStandardScriptsTables(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) ScriptsMetaDataProvider.defineTableTriggerTable(String backendName) Constructors in com.kingsrook.qqq.backend.core.model.scripts that throw QExceptionModifierConstructorDescriptionConstructorScriptRevision(QRecord qRecord) ConstructorScriptRevisionFile(QRecord qRecord) ConstructorScriptTypeFileSchema(QRecord qRecord) Constructor -
Uses of QException in com.kingsrook.qqq.backend.core.model.tables
Methods in com.kingsrook.qqq.backend.core.model.tables that throw QExceptionModifier and TypeMethodDescriptionvoidQQQTablesMetaDataProvider.defineAll(QInstance instance, String persistentBackendName, String cacheBackendName, Consumer<QTableMetaData> backendDetailEnricher) QQQTablesMetaDataProvider.defineQQQTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher) QQQTablesMetaDataProvider.defineQQQTableCache(String backendName, Consumer<QTableMetaData> backendDetailEnricher) QQQTableCustomPossibleValueProvider.getAllSourceObjects()static IntegerQQQTableTableManager.getQQQTableId(QInstance qInstance, String tableName) protected QRecordQQQTableCustomPossibleValueProvider.getSourceObject(Serializable id) QQQTableTableManager.setRecordLinksToRecordsFromTableDynamicForPostQuery(QueryOrGetInputInterface queryInput, List<QRecord> records, String tableIdField, String recordIdField) -
Uses of QException in com.kingsrook.qqq.backend.core.modules.authentication.implementations
Methods in com.kingsrook.qqq.backend.core.modules.authentication.implementations that throw QExceptionModifier and TypeMethodDescriptionDecrypt a stored value.static voidOAuth2AuthenticationModule.deleteStoredRefreshTokens(QInstance qInstance, Collection<String> sessionUuids) Delete stored refresh tokens for the given sessions (no-op if the instance has no refresh-token table).Encrypt a refresh token under the current key.static RefreshTokenCipherRefreshTokenCipher.fromMetaData(OAuth2AuthenticationMetaData metaData) Build a cipher from the OAuth2 meta-data's key settings. -
Uses of QException in com.kingsrook.qqq.backend.core.modules.authentication.implementations.metadata
Methods in com.kingsrook.qqq.backend.core.modules.authentication.implementations.metadata that throw QExceptionModifier and TypeMethodDescription -
Uses of QException in com.kingsrook.qqq.backend.core.modules.backend
Methods in com.kingsrook.qqq.backend.core.modules.backend that throw QExceptionModifier and TypeMethodDescriptiondefault Optional<QBackendTransaction> QBackendModuleInterface.openConsistentReadTransaction(ConsistentReadInput input) Open a read-only transaction through which every table read (passed as the transaction on the read's input) reflects one instant - see ConsistencyScope and ConsistencyGuarantee (QBackendTransaction.getConsistencyGuarantee).default QBackendTransactionQBackendModuleInterface.openTransaction(AbstractTableActionInput input) default List<SequenceResyncResult> QBackendModuleInterface.resyncKeySequences(QBackendMetaData backend, Collection<QTableMetaData> tables) Advance each table's generated-key sequence past the largest key now in the table, so the next generated insert gets max+1. -
Uses of QException in com.kingsrook.qqq.backend.core.modules.backend.implementations.enumeration
Methods in com.kingsrook.qqq.backend.core.modules.backend.implementations.enumeration that throw QExceptionModifier and TypeMethodDescriptionEnumerationCountAction.execute(CountInput countInput) EnumerationQueryAction.execute(QueryInput queryInput) -
Uses of QException in com.kingsrook.qqq.backend.core.modules.backend.implementations.memory
Methods in com.kingsrook.qqq.backend.core.modules.backend.implementations.memory that throw QExceptionModifier and TypeMethodDescriptionMemoryRecordStore.aggregate(AggregateInput aggregateInput) intMemoryRecordStore.conditionalUpdate(ConditionalUpdateInput input) Atomic conditional update: under the table's lock, set the values on every row that matches the filter; return how many rows changed.MemoryRecordStore.count(CountInput input) intMemoryRecordStore.delete(DeleteInput input) voidMemoryStorageAction.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.MemoryAggregateAction.execute(AggregateInput aggregateInput) intMemoryConditionalUpdateAction.execute(ConditionalUpdateInput input) MemoryCountAction.execute(CountInput countInput) MemoryDeleteAction.execute(DeleteInput deleteInput) MemoryInsertAction.execute(InsertInput insertInput) MemoryQueryAction.execute(QueryInput queryInput) MemoryUpdateAction.execute(UpdateInput updateInput) MemoryQueryAction.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) MemoryRecordStore.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) Inspect only structural relationship values; never expose whole stored rows.MemoryStorageAction.getInputStream(StorageInput storageInput) MemoryRecordStore.insert(InsertInput input, boolean returnInsertedRecords) MemoryQueryAction.lookupUniqueKey(UniqueKeyLookup.Input input) MemoryRecordStore.lookupUniqueKey(UniqueKeyLookup.Input input) Return only schema-constrained key material, without read transformations.MemoryRecordStore.query(QueryInput input) MemoryQueryAction.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) MemoryRecordStore.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Return only declared parent relationship values without read transformations.MemoryRecordStore.update(UpdateInput input, boolean returnUpdatedRecords) -
Uses of QException in com.kingsrook.qqq.backend.core.modules.backend.implementations.mock
Methods in com.kingsrook.qqq.backend.core.modules.backend.implementations.mock that throw QExceptionModifier and TypeMethodDescriptionMockCountAction.execute(CountInput countInput) MockDeleteAction.execute(DeleteInput deleteInput) MockInsertAction.execute(InsertInput insertInput) MockQueryAction.execute(QueryInput queryInput) MockUpdateAction.execute(UpdateInput updateInput) -
Uses of QException in com.kingsrook.qqq.backend.core.modules.backend.implementations.utils
Methods in com.kingsrook.qqq.backend.core.modules.backend.implementations.utils that throw QExceptionModifier and TypeMethodDescriptionBackendQueryFilterUtils.identifyJoinsInFilter(String mainTableName, QQueryFilter filter) BackendQueryFilterUtils.identifyJoinTablesInFilter(String mainTableName, QQueryFilter filter) -
Uses of QException in com.kingsrook.qqq.backend.core.modules.messaging
Methods in com.kingsrook.qqq.backend.core.modules.messaging that throw QExceptionModifier and TypeMethodDescriptionMessagingProviderInterface.sendMessage(SendMessageInput sendMessageInput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.audits
Methods in com.kingsrook.qqq.backend.core.processes.implementations.audits that throw QExceptionModifier and TypeMethodDescriptionvoidGetAuditsForRecordProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.automation
Methods in com.kingsrook.qqq.backend.core.processes.implementations.automation that throw QExceptionModifier and TypeMethodDescriptionvoidHealBadRecordAutomationStatusesProcessStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidRunTableAutomationsProcessStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.basepull
Methods in com.kingsrook.qqq.backend.core.processes.implementations.basepull that throw QExceptionModifier and TypeMethodDescriptionprotected StringExtractViaBasepullQueryStep.getLastRunTimeString(RunBackendStepInput runBackendStepInput) protected QQueryFilterExtractViaBasepullQueryStep.getQueryFilter(RunBackendStepInput runBackendStepInput) protected StringExtractViaBasepullQueryStep.getThisRunTimeString(RunBackendStepInput runBackendStepInput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.delete
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.delete that throw QExceptionModifier and TypeMethodDescriptionvoidBulkDeleteLoadStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkDeleteTransformStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkDeleteLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidBulkDeleteTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.edit
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.edit that throw QExceptionModifier and TypeMethodDescriptionvoidBulkEditLoadStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkEditTransformStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidPrepareBulkEditStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkEditLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkEditTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert that throw QExceptionModifier and TypeMethodDescriptionstatic StorageInputBulkInsertStepUtils.getStorageInputForTheFile(RunBackendStepInput input) BulkInsertPrepareValueMappingStep.getTableAndField(String tableName, String fullFieldName) static QRecordBulkInsertStepUtils.handleSavedBulkLoadProfileIdValue(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) BulkInsertTransformStep.loadPotentialRecordsByUniqueKey(RunBackendStepInput runBackendStepInput, List<QRecord> fileRecords, QTableMetaData table, List<String> keyFields) BulkInsertTransformStep.loadPotentialRecordsByUniqueKeyByOrQueries(List<QRecord> fileRecords, QTableMetaData table, List<String> keyFields) This approach builds a big query, in the format:BulkInsertTransformStep.loadPotentialRecordsByUniqueKeyByPerFieldInLists(List<QRecord> fileRecords, QTableMetaData table, List<String> keyFields) The approach in this method is designed to minimize the number of queries needed to look up the records to update.BulkInsertTransformStep.loadPotentialRecordsByUniqueKeyRecordByRecord(List<QRecord> fileRecords, QTableMetaData table, List<String> keyFields) voidBulkInsertTransformStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertExtractStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertPrepareFileMappingStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertPrepareFileUploadStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertPrepareValueMappingStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertReceiveFileMappingStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertReceiveValueMappingStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBulkInsertTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.assist
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.assist that throw QExceptionModifier and TypeMethodDescriptionOpen an upload by its ref.static StorageInputOpen an upload through the registered source, or fail with a user-facing error when there is none or no ref was given.BulkLoadAssist.profile(String tableName, String uploadRef, BulkLoadAiRoute route, Integer sampleCount) The header guess and column profiles of an upload.BulkLoadAssist.suggestMapping(String tableName, String uploadRef, boolean isBulkEdit) A suggested mapping for an upload's header row, with the columns it leaves unmapped, the required fields it does not fill, and the mapped fields with a possible value source (whose file values need mapping).BulkLoadAssist.validate(String tableName, String uploadRef, BulkLoadProfile profile, BulkLoadAssist.Mode mode, BulkLoadAiRoute route) A dry run of a profile over an upload, through the table's bulk-insert process: headless, starting after the file mapping screen and stopping at the review screen (FrontendStepBehavior.BREAK), so nothing is stored. -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.filehandling
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.filehandling that throw QExceptionModifier and TypeMethodDescriptionstatic FileToRowsInterfaceFileToRowsInterface.forFile(String fileName, InputStream inputStream) static CsvFileToRowsvoidCsvFileToRows.init(InputStream inputStream) voidFileToRowsInterface.init(InputStream inputStream) voidJsonlFileToRows.init(InputStream inputStream) voidXlsxFileToRows.init(InputStream inputStream) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.mapping
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.mapping that throw QExceptionModifier and TypeMethodDescriptionstatic BulkLoadTableStructureBulkLoadTableStructureBuilder.buildTableStructure(String tableName) static BulkLoadTableStructureBulkLoadTableStructureBuilder.buildTableStructure(String tableName, Boolean isBulkEdit) FlatRowsToRecord.nextPage(FileToRowsInterface fileToRowsInterface, BulkLoadFileRow headerRow, BulkInsertMapping mapping, Integer limit) RowsToRecordInterface.nextPage(FileToRowsInterface fileToRowsInterface, BulkLoadFileRow headerRow, BulkInsertMapping mapping, Integer limit) TallRowsToRecord.nextPage(FileToRowsInterface fileToRowsInterface, BulkLoadFileRow headerRow, BulkInsertMapping mapping, Integer limit) WideRowsToRecordWithExplicitFieldNameSuffixIndexBasedMapping.nextPage(FileToRowsInterface fileToRowsInterface, BulkLoadFileRow headerRow, BulkInsertMapping mapping, Integer limit) WideRowsToRecordWithSpreadMapping.nextPage(FileToRowsInterface fileToRowsInterface, BulkLoadFileRow headerRow, BulkInsertMapping mapping, Integer limit) static voidBulkLoadValueMapper.valueMapping(List<QRecord> records, BulkInsertMapping mapping, QTableMetaData table) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.model
Methods in com.kingsrook.qqq.backend.core.processes.implementations.bulk.insert.model that throw QExceptionModifier and TypeMethodDescriptionBulkInsertMapping.getFieldDefaultValues(QTableMetaData table, String associationNameChain, List<Integer> wideAssociationIndexes) get a map of default-values for fields in a given table (at the specified association chain and wide-indexes).BulkInsertMapping.getFieldIndexes(QTableMetaData table, String associationNameChain, BulkLoadFileRow headerRow) BulkInsertMapping.getFieldIndexes(QTableMetaData table, String associationNameChain, BulkLoadFileRow headerRow, List<Integer> wideAssociationIndexes) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.columnstats
Methods in com.kingsrook.qqq.backend.core.processes.implementations.columnstats that throw QExceptionModifier and TypeMethodDescriptionvoidColumnStatsStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidColumnStatsFullInstanceVerifier.verify(Collection<QTableMetaData> tables) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.etl.basic
Methods in com.kingsrook.qqq.backend.core.processes.implementations.etl.basic that throw QExceptionModifier and TypeMethodDescriptionvoidBasicETLExtractFunction.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBasicETLLoadFunction.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidBasicETLTransformFunction.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamed
Methods in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamed that throw QExceptionModifier and TypeMethodDescriptionvoidStreamedETLBackendStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend
Subclasses of QException in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontendMethods in com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend that throw QExceptionModifier and TypeMethodDescriptionAbstractExtractStep.doCount(RunBackendStepInput runBackendStepInput) ExtractViaQueryStep.doCount(RunBackendStepInput runBackendStepInput) protected voidLoadViaInsertOrUpdateStep.evaluateRecords(RunBackendStepInput runBackendStepInput) protected QQueryFilterExtractViaQueryStep.getQueryFilter(RunBackendStepInput runBackendStepInput) voidLoadViaInsertOrUpdateStep.insertAndUpdateRecords(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) AbstractLoadStep.openTransaction(RunBackendStepInput runBackendStepInput) LoadViaDeleteStep.openTransaction(RunBackendStepInput runBackendStepInput) LoadViaInsertOrUpdateStep.openTransaction(RunBackendStepInput runBackendStepInput) LoadViaInsertStep.openTransaction(RunBackendStepInput runBackendStepInput) LoadViaUpdateStep.openTransaction(RunBackendStepInput runBackendStepInput) voidAbstractLoadStep.postRun(BackendStepPostRunInput runBackendStepInput, BackendStepPostRunOutput runBackendStepOutput) Allow subclasses to do an action after the run is complete - after the last page of records is passed in.voidAbstractTransformStep.postRun(BackendStepPostRunInput runBackendStepInput, BackendStepPostRunOutput runBackendStepOutput) Allow subclasses to do an action after the run is complete - after the last page of records is passed in.voidAbstractExtractStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Allow subclasses to do an action before the run begins.voidAbstractLoadStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Allow subclasses to do an action before any pages of records are processed.voidAbstractTransformStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Allow subclasses to do an action before any pages of records are processed.voidExtractViaQueryStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidExtractViaQueryStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidStreamedETLExecuteStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidStreamedETLPreviewStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidStreamedETLValidateStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) abstract voidAbstractLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Do the load logic for one page of recordsabstract voidAbstractTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Do the transform logic for one page of recordsvoidLoadViaDeleteStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidLoadViaInsertOrUpdateStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidLoadViaInsertStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidLoadViaUpdateStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidNoopLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the backend step - using the request as input, and the result as output.voidNoopTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) run -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.garbagecollector
Methods in com.kingsrook.qqq.backend.core.processes.implementations.garbagecollector that throw QExceptionModifier and TypeMethodDescriptionprotected QQueryFilterGarbageCollectorExtractStep.getQueryFilter(RunBackendStepInput runBackendStepInput) voidGarbageCollectorTransformStep.postRun(BackendStepPostRunInput runBackendStepInput, BackendStepPostRunOutput runBackendStepOutput) voidGarbageCollectorTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) run -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.general
Methods in com.kingsrook.qqq.backend.core.processes.implementations.general that throw QExceptionModifier and TypeMethodDescriptionvoidLoadInitialRecordsStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.mergeduplicates
Subclasses of QException in com.kingsrook.qqq.backend.core.processes.implementations.mergeduplicatesModifier and TypeClassDescriptionstatic classMethods in com.kingsrook.qqq.backend.core.processes.implementations.mergeduplicates that throw QExceptionModifier and TypeMethodDescriptionabstract QRecordAbstractMergeDuplicatesTransformStep.buildRecordToKeep(RunBackendStepInput runBackendStepInput, List<QRecord> duplicateRecords) Do the main work for this process - merge a list of records.protected voidAbstractMergeDuplicatesTransformStep.preProcess(ListingHash<List<Serializable>, QRecord> duplicatesMap) Optional point where subclasses can pre-load data in-bulk on all the duplicates.voidAbstractMergeDuplicatesTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidMergeDuplicatesLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.mock
Methods in com.kingsrook.qqq.backend.core.processes.implementations.mock that throw QExceptionModifier and TypeMethodDescriptionvoidMockBackendStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.reports
Methods in com.kingsrook.qqq.backend.core.processes.implementations.reports that throw QExceptionModifier and TypeMethodDescriptionvoidExecuteReportStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidPrepareReportForRecordStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidPrepareReportStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.savedbulkloadprofiles
Methods in com.kingsrook.qqq.backend.core.processes.implementations.savedbulkloadprofiles that throw QExceptionModifier and TypeMethodDescriptionvoidDeleteSavedBulkLoadProfileProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidQuerySavedBulkLoadProfileProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidStoreSavedBulkLoadProfileProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.savedreports
Methods in com.kingsrook.qqq.backend.core.processes.implementations.savedreports that throw QExceptionModifier and TypeMethodDescriptionSavedReportToReportMetaDataAdapter.adapt(SavedReport savedReport, ReportFormat reportFormat) voidRenderSavedReportExecuteStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidRenderSavedReportPreStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidRunScheduledReportExecuteStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidReportsFullInstanceVerifier.verify(Collection<QTableMetaData> tables, String storageTableName) void -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.savedviews
Methods in com.kingsrook.qqq.backend.core.processes.implementations.savedviews that throw QExceptionModifier and TypeMethodDescriptionprotected voidQuerySavedViewProcess.lookupQuickViews(RunBackendStepInput runBackendStepInput, List<QRecord> savedViewRecords) If the qInstance has aQuickSavedViewtable, then query for quick-saved view records associated with the list of saved view records that were found.voidDeleteSavedViewProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidQuerySavedViewProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidStoreSavedViewProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.scripts
Methods in com.kingsrook.qqq.backend.core.processes.implementations.scripts that throw QExceptionModifier and TypeMethodDescriptionvoidRunRecordScriptExtractStep.preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidLoadScriptTestDetailsProcessStep.run(RunBackendStepInput input, RunBackendStepOutput output) voidStoreScriptRevisionProcessStep.run(RunBackendStepInput input, RunBackendStepOutput output) voidTestScriptProcessStep.run(RunBackendStepInput input, RunBackendStepOutput output) voidRunRecordScriptLoadStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidRunRecordScriptTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.sharing
Methods in com.kingsrook.qqq.backend.core.processes.implementations.sharing that throw QExceptionModifier and TypeMethodDescriptionvoidSharingMetaDataProvider.defineAll(QInstance instance, Consumer<QProcessMetaData> processEnricher) voidDeleteSharedRecordProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidEditSharedRecordProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidGetSharedRecordsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidInsertSharedRecordProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.implementations.tablesync
Methods in com.kingsrook.qqq.backend.core.processes.implementations.tablesync that throw QExceptionModifier and TypeMethodDescriptionprotected Map<Pair<String, Serializable>, QRecord> AbstractTableSyncTransformStep.buildExistingRecordsMap(String destinationTableForeignKeyField, List<QRecord> existingRecordList) Overridable point where you can, for example, keys in the existingRecordsMap with different fieldNames from the destinationTable.protected Map<Pair<String, Serializable>, QRecord> AbstractTableSyncTransformStep.getExistingRecordsByForeignKey(RunBackendStepInput runBackendStepInput, String destinationTableForeignKeyField, String destinationTableName, List<Serializable> sourceKeyList) Run the existingRecordQueryFilter - to look in the destinationTable for any records that may need an update (rather than an insert).protected voidAbstractTableSyncTransformStep.initializeRecordLookupHelper(RunBackendStepInput runBackendStepInput, List<QRecord> sourceRecordList) If needed, init a record lookup helper for this process.abstract QRecordAbstractTableSyncTransformStep.populateRecordToStore(RunBackendStepInput runBackendStepInput, QRecord destinationRecord, QRecord sourceRecord) Map a record from the source table to the destination table.protected voidAbstractTableSyncTransformStep.reinitializeRecordLookupHelper(RunBackendStepInput runBackendStepInput, List<QRecord> sourceRecordList) for pages after the first, possibly load more records in the lookup helper.voidAbstractTableSyncTransformStep.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.processes.locks
Subclasses of QException in com.kingsrook.qqq.backend.core.processes.locksModifier and TypeClassDescriptionclassLock thrown by ProcessLockUtils when you can't get the lock.Methods in com.kingsrook.qqq.backend.core.processes.locks that throw QExceptionModifier and TypeMethodDescriptionstatic ProcessLocktry to create a process lock, of a given key invalid input: '&' type - but immediately fail if the lock already exists.static ProcessLockProcessLockUtils.create(String key, String typeName, String details, Duration sleepBetweenTries, Duration maxWait) try to create a process lock, of a given key invalid input: '&' type - and re-try if it failed.static Map<String, ProcessLockOrException> ProcessLockUtils.createMany(List<String> keys, String typeName, String details) try to create many process locks, of list of keys invalid input: '&' a type - but immediately fail (on a one-by-one basis) if the lock already exists.static Map<String, ProcessLockOrException> ProcessLockUtils.createMany(List<String> keys, String typeName, String details, Duration sleepBetweenTries, Duration maxWait) try to create many process locks, of a given list of key invalid input: '&' a type - and re-try upon failures (e.g., wait until existing lock holder releases the lock).static ProcessLock -
Uses of QException in com.kingsrook.qqq.backend.core.processes.utils
Methods in com.kingsrook.qqq.backend.core.processes.utils that throw QExceptionModifier and TypeMethodDescriptionstatic voidGeneralProcessUtils.addForeignRecordsListToRecordList(List<QRecord> sourceRecords, String sourceTableForeignKeyFieldName, String foreignTableName, String foreignTableForeignKeyName) For a list of sourceRecords, lookup records in the foreignTableName, that have their foreignTableForeignKeyName in the sourceTableForeignKeyFieldName on the sourceRecords.static voidGeneralProcessUtils.addForeignRecordsToRecordList(List<QRecord> sourceRecords, String sourceTableForeignKeyFieldName, String foreignTableName, String foreignTablePrimaryKeyName) For a list of sourceRecords, lookup records in the foreignTableName, that have their foreignTablePrimaryKeyName in the sourceTableForeignKeyFieldName on the sourceRecords.static IntegerGeneralProcessUtils.count(String tableName, QQueryFilter filter) static <T extends QRecordEntity>
Optional<T> GeneralProcessUtils.getEntityByField(String tableName, String fieldName, Serializable fieldValue, Class<T> entityClass) Query to get one entity by a unique key value.static ListingHash<Serializable, QRecord> GeneralProcessUtils.getForeignRecordListingHashMap(List<QRecord> sourceRecords, String sourceTableForeignKeyFieldName, String foreignTableName, String foreignTableForeignKeyName) For a list of sourceRecords, lookup records in the foreignTableName, that have their foreignTableForeignKeyName in the sourceTableForeignKeyFieldName on the sourceRecords.static Map<Serializable, QRecord> GeneralProcessUtils.getForeignRecordMap(List<QRecord> sourceRecords, String sourceTableForeignKeyFieldName, String foreignTableName, String foreignTablePrimaryKeyName) For a list of sourceRecords, lookup records in the foreignTableName, that have their foreignTablePrimaryKeyName in the sourceTableForeignKeyFieldName on the sourceRecords.static Map<Serializable, QRecord> GeneralProcessUtils.getForeignRecordMap(List<QRecord> sourceRecords, String sourceTableForeignKeyFieldName, String foreignTableName, String foreignTablePrimaryKeyName, QQueryFilter additionalFilter) For a list of sourceRecords, lookup records in the foreignTableName, that have their foreignTablePrimaryKeyName in the sourceTableForeignKeyFieldName on the sourceRecords.GeneralProcessUtils.getRecordByField(String tableName, String fieldName, Serializable fieldValue) Query to get one record by a unique key value.static QRecordGeneralProcessUtils.getRecordByFieldOrElseThrow(String tableName, String fieldName, Serializable fieldValue) Query to get one record by a unique key value.RecordLookupHelper.getRecordByKey(String tableName, String keyFieldName, Serializable key) Fetch a record from a table by a key field (doesn't have to be its primary key).GeneralProcessUtils.getRecordByPrimaryKey(String tableName, Serializable value) Query to get one record by its primary key value.static QRecordGeneralProcessUtils.getRecordByPrimaryKeyOrElseThrow(String tableName, Serializable value) Query to get one record by its primary key value.RecordLookupHelper.getRecordByUniqueKey(String tableName, Map<String, Serializable> uniqueKey) Fetch a record from a table by a uniqueKey from the tableRecordLookupHelper.getRecordId(String tableName, String keyFieldName, Serializable key) Get the id (primary key) value from a record, by doing a lookup on the specified keyFieldName, for the specified key value.<T extends Serializable>
TRecordLookupHelper.getRecordId(String tableName, String keyFieldName, Serializable key, Class<T> type) Get the id (primary key) value from a record, in the requested type, by doing a lookup on the specified keyFieldName, for the specified key value.GeneralProcessUtils.getRecordListByField(String tableName, String fieldName, Serializable fieldValue) Run a query on tableName, for where fieldName equals fieldValue, and return the list of QRecords.RecordLookupHelper.getRecordValue(String tableName, String requestedField, String keyFieldName, Serializable key) Get a value from a record, by doing a lookup on the specified keyFieldName, for the specified key value.<T extends Serializable>
TRecordLookupHelper.getRecordValue(String tableName, String requestedField, String keyFieldName, Serializable key, Class<T> type) Get a value from a record, in the requested type, by doing a lookup on the specified keyFieldName, for the specified key value.Load all rows from a table.static <T extends QRecordEntity>
List<T> Load all rows from a table as a RecordEntity.static <T extends QRecordEntity>
List<T> GeneralProcessUtils.loadTable(String tableName, Class<T> entityClass, QQueryFilter filter) Load all rows from a table as a RecordEntity, takes in a filter as well Note, this is inherently unsafe, if you were to call it on a table with too many rows...static ListingHash<Serializable, QRecord> GeneralProcessUtils.loadTableToListingHash(String tableName, String keyFieldName) Load all rows from a table, into a ListingHash, keyed by the keyFieldName.static <T extends Serializable>
Map<T, QRecord> GeneralProcessUtils.loadTableToMap(String tableName, Class<T> keyType, String keyFieldName) Load all rows from a table, into a map, keyed by the keyFieldName - typed as the specified keyType.static Map<Serializable, QRecord> GeneralProcessUtils.loadTableToMap(String tableName, String keyFieldName) Load all rows from a table, into a map, keyed by the keyFieldName.static Map<Serializable, QRecord> GeneralProcessUtils.loadTableToMap(String tableName, String keyFieldName, QQueryFilter filter) Load rows from a table matching the specified filter, into a map, keyed by the keyFieldName.static <T extends QRecordEntity>
Map<Serializable, T> GeneralProcessUtils.loadTableToMap(String tableName, String keyFieldName, Class<T> entityClass) Note - null values from the key field are NOT put in the map.static <T extends QRecordEntity>
Map<Serializable, T> GeneralProcessUtils.loadTableToMap(String tableName, String keyFieldName, Class<T> entityClass, QQueryFilter filter) Load rows from a table matching the specified filter, into a map, keyed by the keyFieldName.static <T extends QRecordEntity>
Map<Serializable, T> GeneralProcessUtils.loadTableToMap(String tableName, String keyFieldName, Class<T> entityClass, Consumer<QueryInput> queryInputCustomizer) Note - null values from the key field are NOT put in the map.voidRecordLookupHelper.preloadRecords(String tableName, String keyFieldName) Optimization - to pre-load the records in a single query, which would otherwise have to be looked up one-by-one.voidRecordLookupHelper.preloadRecords(String tableName, String keyFieldName, QQueryFilter filter) Optimization - to pre-load some records in a single query, which would otherwise have to be looked up one-by-one.RecordLookupHelper.preloadRecords(String tableName, String keyFieldName, List<Serializable> inList) Optimization - to pre-load some records in a single IN-LIST query, which would otherwise have to be looked up one-by-one - where - if the records aren't found, then a null will be cached (for each element in the inList).static <T extends QRecordEntity>
List<T> GeneralProcessUtils.recordsToEntities(Class<T> recordEntityClass, List<QRecord> records) static IntegerGeneralProcessUtils.validateSingleSelectedId(RunBackendStepInput runBackendStepInput, String tableName) Ensure that a process has been initiated with a single record as input - and get that record id. -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler
Methods in com.kingsrook.qqq.backend.core.scheduler that throw QExceptionModifier and TypeMethodDescriptionstatic QScheduleManagerQScheduleManager.initInstance(QInstance qInstance, Supplier<QSession> systemUserSessionSupplier) Singleton initiator - e.g., must be called to initially initialize the singleton before anyone else calls getInstance (they'll get an error if they call that first).voidQScheduleManager.setupAllNewSchedules()voidQScheduleManager.setupAllSchedules()voidQScheduleManager.setupScheduledJob(ScheduledJob scheduledJob) voidQScheduleManager.start()voidQSchedulerInterface.unscheduleAll()voidQScheduleManager.unscheduleScheduledJob(ScheduledJob scheduledJob) -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler.processes
Methods in com.kingsrook.qqq.backend.core.scheduler.processes that throw QExceptionModifier and TypeMethodDescriptionprotected ScheduledJobAbstractRecordSyncToScheduledJobProcess.customizeScheduledJob(ScheduledJob scheduledJob, QRecord sourceRecord) protected voidAbstractRecordSyncToScheduledJobProcess.makeSureSchedulerNameIsSet(ScheduledJob scheduledJob) AbstractRecordSyncToScheduledJobProcess.populateRecordToStore(RunBackendStepInput runBackendStepInput, QRecord destinationRecord, QRecord sourceRecord) BaseSyncToScheduledJobTableCustomizer.postDelete(DeleteInput deleteInput, List<QRecord> records) BaseSyncToScheduledJobTableCustomizer.postInsertOrUpdate(AbstractActionInput input, List<QRecord> records, Optional<List<QRecord>> oldRecordList) voidRescheduleAllJobsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidScheduleAllNewJobsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidUnscheduleAllJobsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler.quartz
Methods in com.kingsrook.qqq.backend.core.scheduler.quartz that throw QException -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler.quartz.processes
Methods in com.kingsrook.qqq.backend.core.scheduler.quartz.processes that throw QExceptionModifier and TypeMethodDescriptionvoidPauseAllQuartzJobsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidResumeAllQuartzJobsProcess.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidPauseQuartzJobsProcess.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) voidResumeQuartzJobsProcess.runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler.schedulable.runner
Methods in com.kingsrook.qqq.backend.core.scheduler.schedulable.runner that throw QExceptionModifier and TypeMethodDescriptionvoidSchedulableProcessRunner.validateParams(SchedulableIdentity schedulableIdentity, Map<String, Object> paramMap) voidSchedulableRunner.validateParams(SchedulableIdentity schedulableIdentity, Map<String, Object> paramMap) voidSchedulableSQSQueueRunner.validateParams(SchedulableIdentity schedulableIdentity, Map<String, Object> paramMap) voidSchedulableTableAutomationsRunner.validateParams(SchedulableIdentity schedulableIdentity, Map<String, Object> paramMap) -
Uses of QException in com.kingsrook.qqq.backend.core.scheduler.simple
Methods in com.kingsrook.qqq.backend.core.scheduler.simple that throw QException -
Uses of QException in com.kingsrook.qqq.backend.core.utils.aggregates
Methods in com.kingsrook.qqq.backend.core.utils.aggregates that throw QExceptionModifier and TypeMethodDescriptionstatic SerializableAggregateAnalysis.applyFormatString(Serializable value, GroupBy groupBy) Legacy format-string support shared with memory aggregation.static voidAggregateAnalysis.validate(AggregateInput input) Validate extension parameters before either execution path. -
Uses of QException in com.kingsrook.qqq.backend.module.api.actions
Methods in com.kingsrook.qqq.backend.module.api.actions that throw QExceptionModifier and TypeMethodDescriptionprotected voidBaseAPIActionUtil.addApiKeyQueryParamToRequest(org.apache.http.client.methods.HttpRequestBase request) protected StringBaseAPIActionUtil.buildQueryStringForDelete(QQueryFilter filter, List<Serializable> primaryKeys) method to build up delete string based on a given QFilter objectprotected StringBaseAPIActionUtil.buildQueryStringForGet(QQueryFilter filter, Integer limit, Integer skip, Map<String, QFieldMetaData> fields) method to build up a query string based on a given QFilter objectprotected StringBaseAPIActionUtil.buildQueryStringForUpdate(QTableMetaData table, List<QRecord> recordList) method to build up a query string for updates based on a given QFilter objectBaseAPIActionUtil.buildUrlSuffixForSingleRecordGet(Serializable primaryKey) Do a default query string for a single-record GET - e.g., a query for just 1 record.BaseAPIActionUtil.buildUrlSuffixForSingleRecordGet(Map<String, Serializable> uniqueKey) protected org.apache.http.client.methods.HttpRequestBaseBaseAPIActionUtil.createOAuth2TokenRequest()For doing OAuth2 authentication, create a request for a token.BaseAPIActionUtil.doCount(QTableMetaData table, CountInput countInput) BaseAPIActionUtil.doDelete(QTableMetaData table, DeleteInput deleteInput) BaseAPIActionUtil.doGet(QTableMetaData table, GetInput getInput) BaseAPIActionUtil.doInsert(QTableMetaData table, InsertInput insertInput) BaseAPIActionUtil.doQuery(QTableMetaData table, QueryInput queryInput) OK - so - we will potentially make multiple GET calls to the backend, to fetch up to the full limit from the filter (and, if there is no limit in the filter, then we'll keep fetching until we stop getting results).BaseAPIActionUtil.doUpdate(QTableMetaData table, UpdateInput updateInput) APICountAction.execute(CountInput countInput) APIDeleteAction.execute(DeleteInput deleteInput) APIInsertAction.execute(InsertInput insertInput) APIQueryAction.execute(QueryInput queryInput) APIUpdateAction.execute(UpdateInput updateInput) APIQueryAction.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) API filter syntax is application-specific, so read all pages and match locally.protected StringBaseAPIActionUtil.getApiKey()protected org.apache.logging.log4j.LevelBaseAPIActionUtil.getAPIResponseLogLevel()BaseAPIActionUtil.getClientIdAndSecret()protected org.json.JSONObjectBaseAPIActionUtil.getJsonObject(QHttpResponse response) BaseAPIActionUtil.getOAuth2Token()BaseAPIActionUtil.getUsernameAndPassword()protected voidBaseAPIActionUtil.handleCustomAuthorization(org.apache.http.client.methods.HttpRequestBase request) protected voidBaseAPIActionUtil.handleResponseError(QTableMetaData table, org.apache.http.client.methods.HttpRequestBase request, QHttpResponse response) protected QRecordBaseAPIActionUtil.jsonObjectToRecord(org.json.JSONObject jsonObject, Map<String, QFieldMetaData> fields) protected voidBaseAPIActionUtil.logRequestDetails(QTableMetaData table, org.apache.http.client.methods.HttpRequestBase request) APIQueryAction.lookupUniqueKey(UniqueKeyLookup.Input input) Complete key visibility must be supplied by the configured provider utility.BaseAPIActionUtil.lookupUniqueKey(UniqueKeyLookup.Input input) Override only when the provider can read every stored declared-key conflict.BaseAPIActionUtil.makeRequest(QTableMetaData table, org.apache.http.client.methods.HttpRequestBase request) protected intBaseAPIActionUtil.processGetResponse(QTableMetaData table, QHttpResponse response, QueryOutput queryOutput) BaseAPIActionUtil.processGetResponseForCount(QTableMetaData table, QHttpResponse response) protected QRecordBaseAPIActionUtil.processPostResponse(QTableMetaData table, QRecord record, QHttpResponse response) BaseAPIActionUtil.processSingleRecordGetResponse(QTableMetaData table, QHttpResponse response) APIQueryAction.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) The configured provider must explicitly support complete stored parent values.BaseAPIActionUtil.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Ordinary upstream reads cannot promise complete physical relationship values.protected org.apache.http.entity.AbstractHttpEntityBaseAPIActionUtil.recordsToEntity(QTableMetaData table, List<QRecord> recordList) Build an HTTP Entity (e.g., for a PUT or POST) from a list of QRecords.voidBaseAPIActionUtil.setupAuthorizationInRequest(org.apache.http.client.methods.HttpRequestBase request) As part of making a request - set up its authorization header (not just strictly "Authorization", but whatever is needed for auth).voidBaseAPIActionUtil.validateResponse(QHttpResponse response, List<QRecord> recordList) -
Uses of QException in com.kingsrook.qqq.backend.module.api.exceptions
Subclasses of QException in com.kingsrook.qqq.backend.module.api.exceptionsModifier and TypeClassDescriptionclassException to be thrown during OAuth Token generation.classException to be thrown by a request that uses OAuth, if the current token is expired.classException thrown when an API HTTP request failed due to a bad status code.classclass -
Uses of QException in com.kingsrook.qqq.backend.module.api.model
Methods in com.kingsrook.qqq.backend.module.api.model that throw QExceptionModifier and TypeMethodDescriptionstatic voidOutboundAPILogMetaDataProvider.defineAll(QInstance qInstance, String backendName, Consumer<QTableMetaData> backendDetailEnricher) Constructors in com.kingsrook.qqq.backend.module.api.model that throw QException -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.base.actions
Methods in com.kingsrook.qqq.backend.module.filesystem.base.actions that throw QExceptionModifier and TypeMethodDescriptionAbstractBaseFilesystemAction.executeCount(CountInput countInput) protected DeleteOutputAbstractBaseFilesystemAction.executeDelete(DeleteInput deleteInput) protected InsertOutputAbstractBaseFilesystemAction.executeInsert(InsertInput insertInput) AbstractBaseFilesystemAction.executeQuery(QueryInput queryInput) Generic implementation of the execute method from the QueryInterfaceAbstractBaseFilesystemAction.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) MANY-file reads return all rows, so apply relationship criteria explicitly.AbstractBaseFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase) List the files for a table - to be implemented in module-specific subclasses.AbstractBaseFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedSingleFileName) List the files for a table - or optionally, just a single file name - to be implemented in module-specific subclasses.AbstractBaseFilesystemAction.lookupUniqueKey(UniqueKeyLookup.Input input) MANY-file readers need explicit matching; projected key contents may be heavy.voidAbstractBaseFilesystemAction.preAction(QBackendMetaData backendMetaData) Method that subclasses can override to add pre-action things (e.g., setting up s3 client).AbstractBaseFilesystemAction.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Read only exact parent keys, retaining every declared relationship component. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.base.utils
Methods in com.kingsrook.qqq.backend.module.filesystem.base.utils that throw QExceptionModifier and TypeMethodDescriptionstatic booleanSharedFilesystemBackendModuleUtils.doesFilePathMatchFilter(String filePath, QQueryFilter filter, AbstractFilesystemTableBackendDetails tableDetails) -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.exceptions
Subclasses of QException in com.kingsrook.qqq.backend.module.filesystem.exceptionsModifier and TypeClassDescriptionclassChecked exception to be thrown from actions within this module. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.local.actions
Methods in com.kingsrook.qqq.backend.module.filesystem.local.actions that throw QExceptionModifier and TypeMethodDescriptionFilesystemStorageAction.createOutputStream(StorageInput storageInput) voidFilesystemStorageAction.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.FilesystemCountAction.execute(CountInput countInput) FilesystemDeleteAction.execute(DeleteInput deleteInput) FilesystemInsertAction.execute(InsertInput insertInput) FilesystemQueryAction.execute(QueryInput queryInput) FilesystemUpdateAction.execute(UpdateInput updateInput) FilesystemStorageAction.getDownloadURL(StorageInput storageInput) FilesystemStorageAction.getInputStream(StorageInput storageInput) AbstractFilesystemAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath) List the files for this table. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.etl.basic
Methods in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.etl.basic that throw QExceptionModifier and TypeMethodDescriptionvoidBasicETLCleanupSourceFilesStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the step - using the request as input, and the result as output.voidBasicETLCollectSourceFileNamesStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the step - using the request as input, and the result as output. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.importer
Methods in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.importer that throw QExceptionModifier and TypeMethodDescriptionvoidFilesystemImporterStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the step - using the request as input, and the result as output. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.sync
Methods in com.kingsrook.qqq.backend.module.filesystem.processes.implementations.filesystem.sync that throw QExceptionModifier and TypeMethodDescriptionvoidFilesystemSyncStep.run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput) Execute the step - using the request as input, and the result as output. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.s3.actions
Methods in com.kingsrook.qqq.backend.module.filesystem.s3.actions that throw QExceptionModifier and TypeMethodDescriptionS3StorageAction.createOutputStream(StorageInput storageInput) voidS3StorageAction.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.S3CountAction.execute(CountInput countInput) S3DeleteAction.execute(DeleteInput deleteInput) S3InsertAction.execute(InsertInput insertInput) S3QueryAction.execute(QueryInput queryInput) S3UpdateAction.execute(UpdateInput updateInput) S3StorageAction.getDownloadURL(StorageInput storageInput) S3StorageAction.getInputStream(StorageInput storageInput) AbstractS3Action.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath) List the files for a table.voidS3StorageAction.makePublic(StorageInput storageInput) voidAbstractS3Action.preAction(QBackendMetaData backendMetaData) Setup the s3 utils object to be used for this action. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.s3.utils
Methods in com.kingsrook.qqq.backend.module.filesystem.s3.utils that throw QExceptionModifier and TypeMethodDescriptionS3Utils.listObjectsInBucketMatchingGlob(String bucketName, String path, String glob) List the objects in an S3 bucket matching a glob, per: https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String)S3Utils.listObjectsInBucketMatchingGlob(String bucketName, String path, String glob, String requestedPath, AbstractFilesystemTableBackendDetails tableDetails) List the objects in an S3 bucket matching a glob, per: https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileSystem.html#getPathMatcher(java.lang.String) and also - (possibly) apply a file-name filter (based on the table's details).S3Utils.listObjectsInBucketMatchingGlob(String bucketName, String path, String glob, String requestedPath, AbstractFilesystemTableBackendDetails tableDetails, Integer maxListedObjects) List the objects in an S3 bucket matching a glob, as above, failing with a FilesystemException (instead of exhausting memory) if more than maxListedObjects objects match. -
Uses of QException in com.kingsrook.qqq.backend.module.filesystem.sftp.actions
Methods in com.kingsrook.qqq.backend.module.filesystem.sftp.actions that throw QExceptionModifier and TypeMethodDescriptionSFTPStorageAction.createOutputStream(StorageInput storageInput) create an output stream in the storage backend - that can be written to, for the purpose of inserting or writing a file into storage.voidSFTPStorageAction.deleteObject(StorageInput storageInput) Delete an object, including an incomplete report output.SFTPCountAction.execute(CountInput countInput) SFTPDeleteAction.execute(DeleteInput deleteInput) SFTPInsertAction.execute(InsertInput insertInput) SFTPQueryAction.execute(QueryInput queryInput) SFTPUpdateAction.execute(UpdateInput updateInput) SFTPStorageAction.getDownloadURL(StorageInput storageInput) SFTPStorageAction.getInputStream(StorageInput storageInput) create an input stream in the storage backend - that can be read from, for the purpose of getting or reading a file from storage.protected org.apache.sshd.sftp.client.SftpClientAbstractSFTPAction.getSftpClient(QBackendMetaData backend) AbstractSFTPAction.listFiles(QTableMetaData table, QBackendMetaData backendBase, String requestedPath) voidSFTPStorageAction.makePublic(StorageInput storageInput) voidAbstractSFTPAction.preAction(QBackendMetaData backendMetaData) Set up the sftp utils object to be used for this action. -
Uses of QException in com.kingsrook.qqq.backend.module.mongodb
Methods in com.kingsrook.qqq.backend.module.mongodb that throw QExceptionModifier and TypeMethodDescriptionMongoDBBackendModule.openConsistentReadTransaction(ConsistentReadInput input) Open a session with snapshot read concern, so all reads through it see one point in time - best effort, as: - snapshot reads need a replica set (or sharded cluster). -
Uses of QException in com.kingsrook.qqq.backend.module.mongodb.actions
Methods in com.kingsrook.qqq.backend.module.mongodb.actions that throw QExceptionModifier and TypeMethodDescriptionvoidMongoDBTransaction.commit()MongoDBAggregateAction.execute(AggregateInput aggregateInput) MongoDBCountAction.execute(CountInput countInput) MongoDBDeleteAction.execute(DeleteInput deleteInput) MongoDBInsertAction.execute(InsertInput insertInput) MongoDBQueryAction.execute(QueryInput queryInput) MongoDBUpdateAction.execute(UpdateInput updateInput) MongoDBQueryAction.executeForDml(QueryInput queryInput) Reject native identities that cannot safely select a later MongoDB write.MongoDBQueryAction.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) Discover relationship membership without changing the caller's read visibility.MongoDBQueryAction.lookupUniqueKey(UniqueKeyLookup.Input input) Display locks and unrelated computed fields cannot hide stored key conflicts.protected List<org.bson.conversions.Bson> AbstractMongoDBAction.makeFilterPipeline(QTableMetaData table, MongoDBBackendMetaData backend, QQueryFilter filter) Keep computed predicates separate from stored fields, including READ locks.protected List<org.bson.conversions.Bson> AbstractMongoDBAction.makeFilterPipeline(QTableMetaData table, MongoDBBackendMetaData backend, QQueryFilter filter, MongoClientContainer client) Public keys encode ObjectIds as Strings.protected org.bson.conversions.BsonAbstractMongoDBAction.makeSearchQueryDocument(QTableMetaData table, QQueryFilter filter) Convert QQueryFilter to Bson search query document - including security for the table if needed.MongoDBQueryAction.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Stored relationship values are independent of display locks and computations.protected org.bson.DocumentAbstractMongoDBAction.recordToDocument(QTableMetaData table, QRecord record) Convert a QRecord to a mongodb document.protected MongoDBFieldFunctionAdapterInterfaceAbstractMongoDBAction.requireFieldFunctionAdapter(MongoDBBackendMetaData backend, FieldFunction fieldFunction) Native computation requires both a function and its MongoDB adapter.voidMongoDBTransaction.rollback() -
Uses of QException in com.kingsrook.qqq.backend.module.rdbms
Methods in com.kingsrook.qqq.backend.module.rdbms that throw QExceptionModifier and TypeMethodDescriptionRDBMSBackendModule.openConsistentReadTransaction(ConsistentReadInput input) Open a transaction whose reads all see one snapshot of the database - in the vendor's way (see RDBMSActionStrategyInterface.beginConsistentRead).RDBMSBackendModule.openTransaction(AbstractTableActionInput input) RDBMSBackendModule.resyncKeySequences(QBackendMetaData backend, Collection<QTableMetaData> tables) Advance each table's key sequence past its largest key, per vendor: - postgres: setval on the column's serial/identity sequence -
Uses of QException in com.kingsrook.qqq.backend.module.rdbms.actions
Methods in com.kingsrook.qqq.backend.module.rdbms.actions that throw QExceptionModifier and TypeMethodDescriptionvoidRDBMSTransaction.commit()RDBMSConditionalUpdateAction.databaseNow(QBackendMetaData backend) The database clock, read with one SELECT.voidRDBMSDeleteAction.doDeleteList(Connection connection, QTableMetaData table, List<Serializable> primaryKeys, DeleteOutput deleteOutput) RDBMSAggregateAction.execute(AggregateInput aggregateInput) intRDBMSConditionalUpdateAction.execute(ConditionalUpdateInput input) RDBMSCountAction.execute(CountInput countInput) RDBMSDeleteAction.execute(DeleteInput deleteInput) RDBMSInsertAction.execute(InsertInput insertInput) RDBMSQueryAction.execute(QueryInput queryInput) RDBMSUpdateAction.execute(UpdateInput updateInput) RDBMSQueryAction.findAssociatedPrimaryKeys(AssociatedRecordDiscovery.Input input) Structural membership ignores row locks without changing query input or context.RDBMSQueryAction.lookupUniqueKey(UniqueKeyLookup.Input input) Native declared-key lookups retain database equality and caller transactions.RDBMSQueryAction.readAssociationValues(AssociatedRecordDiscovery.StoredValuesInput input) Private parent tuples retain physical values and the caller's transaction.voidRDBMSTransaction.rollback() -
Uses of QException in com.kingsrook.qqq.backend.module.rdbms.jdbc
Methods in com.kingsrook.qqq.backend.module.rdbms.jdbc that throw QExceptionModifier and TypeMethodDescriptionstatic voidQueryManager.executeStatement(Connection connection, String sql, QueryManager.ResultSetProcessor processor, Object... params) static voidQueryManager.executeStatement(PreparedStatement statement, QueryManager.ResultSetProcessor processor, Object... params) Let the caller provide their own prepared statement (e.g., possibly with some customized settings/optimizations).static voidQueryManager.executeStatement(PreparedStatement statement, CharSequence sql, QueryManager.ResultSetProcessor processor, Object... params) Let the caller provide their own prepared statement (e.g., possibly with some customized settings/optimizations).voidC3P0PooledConnectionProvider.init(RDBMSBackendMetaData backend) voidConnectionProviderInterface.init(RDBMSBackendMetaData backend) voidQueryManager.ResultSetProcessor.processResultSet(ResultSet rs) -
Uses of QException in com.kingsrook.qqq.backend.module.rdbms.model.metadata
Methods in com.kingsrook.qqq.backend.module.rdbms.model.metadata that throw QExceptionModifier and TypeMethodDescriptionRDBMSTableMetaDataBuilder.buildTableMetaData(RDBMSBackendMetaData backendMetaData, String tableName) -
Uses of QException in com.kingsrook.qqq.backend.module.rdbms.strategy
Methods in com.kingsrook.qqq.backend.module.rdbms.strategy that throw QExceptionModifier and TypeMethodDescriptionvoidBaseRDBMSActionStrategy.executeStatement(PreparedStatement statement, CharSequence sql, RDBMSActionStrategyInterface.ResultSetProcessor processor, Object... params) voidRDBMSActionStrategyInterface.executeStatement(PreparedStatement statement, CharSequence sql, RDBMSActionStrategyInterface.ResultSetProcessor processor, Object... params) voidRDBMSActionStrategyInterface.ResultSetProcessor.processResultSet(ResultSet rs) -
Uses of QException in com.kingsrook.qqq.esb.api
Methods in com.kingsrook.qqq.esb.api that throw QExceptionModifier and TypeMethodDescriptionEsbStatusBuilder.browseDeadLetters(String triggerName, Integer offset, Integer limit) GET /deadLetters/{trigger}: a page of the trigger's dead-letter queue.EsbStatusBuilder.browseMessages(String destinationName, String triggerName, Integer offset, Integer limit) GET /messages/{destination}: a page of a queue's messages - or, for a topic, of one of its triggers' subscription queues (named by triggerName; required for a topic, ignored for a queue).EsbDeveloperPanelProvider.build(DeveloperPanelContext context) EsbStatusBuilder.buildOverview()GET /overview: the providers (name, type, connected, managementEnabled - never urls or credentials), every destination with its publishers and its triggers (on processes the user can access), and permissions.EsbStatusBuilder.buildProcess(String processName) GET /process/{process}: the process's publications and triggers, and permissions.EsbStatusBuilder.buildTable(String tableName) GET /table/{table}: the table's publications, the triggers subscribed to their destinations (on processes the user can access), and permissions.Register the extension (replacing it, however many times this runs). -
Uses of QException in com.kingsrook.qqq.esb.api.specs
Methods in com.kingsrook.qqq.esb.api.specs that throw QExceptionModifier and TypeMethodDescriptionEsbSpecSupport.BodyBuilder.build(EsbStatusBuilder builder) voidEsbSpecSupport.EsbExecutor.execute(EsbSpecSupport.EsbInput input, EsbSpecSupport.EsbOutputInterface output) -
Uses of QException in com.kingsrook.qqq.esb.connection
Methods in com.kingsrook.qqq.esb.connection that throw QExceptionModifier and TypeMethodDescriptionEsbConnectionManager.borrowPublishingSession(String providerName) Exclusively borrow a transacted publishing session.static EsbConnectionFactoryBuilderEsbConnectionFactoryBuilder.forProviderType(EsbProviderType providerType, ClassLoader classLoader) Load the builder for a provider type, through the given class loader.jakarta.jms.SessionEsbConnectionManager.openSession(String providerName, boolean transacted) Open a new session on a provider's connection - connecting first, if this is the provider's first session. -
Uses of QException in com.kingsrook.qqq.esb.envelope
Subclasses of QException in com.kingsrook.qqq.esb.envelopeModifier and TypeClassDescriptionclassThrown by EsbEventCodec when a message isn't a CloudEvents 1.0 JSON event that QQQ can read: not a JMS TextMessage, not a JSON object, missing or invalid attributes, or data that isn't a JSON object. -
Uses of QException in com.kingsrook.qqq.esb.management
Methods in com.kingsrook.qqq.esb.management that throw QExceptionModifier and TypeMethodDescriptionstatic List<EsbBrowsedMessage> Up to limit messages from a queue, skipping the first offset (counting from the head of the queue, as the broker orders it).intArtemisJolokiaAdapter.deleteMessages(String brokerQueueName, List<String> messageIds) QueueControl.removeMessages(filter), by message id.intEsbBrokerAdapter.deleteMessages(String brokerQueueName, List<String> messageIds) Remove the messages with these JMS message ids (as browsing shows them); returns how many were removed.intArtemisJolokiaAdapter.deleteMessagesOlderThan(String brokerQueueName, Instant cutoff) QueueControl.removeMessages(filter), by timestamp.intEsbBrokerAdapter.deleteMessagesOlderThan(String brokerQueueName, Instant cutoff) Remove the messages whose JMS timestamp is before the cutoff; returns how many were removed.ArtemisJolokiaAdapter.getQueueInfo(String brokerQueueName) Reads the queue MBean's MessageCount, ConsumerCount, and Paused attributes.EsbBrokerAdapter.getQueueInfo(String brokerQueueName) The queue's depth, consumer count, and paused state - or empty if the broker has no such queue.RabbitManagementAdapter.getQueueInfo(String brokerQueueName) GET /api/queues/VHOST/NAME: its messages (ready plus unacknowledged) and consumers.intArtemisJolokiaAdapter.moveMessages(String brokerQueueName, List<String> messageIds, String toBrokerQueueName) QueueControl.moveMessages(filter, otherQueueName), by message id.intEsbBrokerAdapter.moveMessages(String brokerQueueName, List<String> messageIds, String toBrokerQueueName) Move the messages with these JMS message ids to another (existing) queue; returns how many were moved.voidArtemisJolokiaAdapter.pauseQueue(String brokerQueueName) QueueControl.pause() - not persisted, so a broker restart resumes it.voidEsbBrokerAdapter.pauseQueue(String brokerQueueName) Pause delivery to all of the queue's consumers (QQQ's and any others); messages keep arriving, and wait.longArtemisJolokiaAdapter.purgeQueue(String brokerQueueName) QueueControl.removeAllMessages()longEsbBrokerAdapter.purgeQueue(String brokerQueueName) Remove all of the queue's messages; returns how many.longRabbitManagementAdapter.purgeQueue(String brokerQueueName) DELETE /api/queues/VHOST/NAME/contents.voidArtemisJolokiaAdapter.resumeQueue(String brokerQueueName) QueueControl.resume()voidEsbBrokerAdapter.resumeQueue(String brokerQueueName) Resume delivery to the queue's consumers, after pauseQueue. -
Uses of QException in com.kingsrook.qqq.esb.metadata
Methods in com.kingsrook.qqq.esb.metadata that throw QException -
Uses of QException in com.kingsrook.qqq.esb.processes
Methods in com.kingsrook.qqq.esb.processes that throw QExceptionModifier and TypeMethodDescriptionvoidEsbOperateStep.run(RunBackendStepInput input, RunBackendStepOutput output) -
Uses of QException in com.kingsrook.qqq.esb.runtime
Methods in com.kingsrook.qqq.esb.runtime that throw QExceptionModifier and TypeMethodDescriptionstatic voidPause the trigger on every node: consumers close, and messages wait on the broker.static voidRestart the trigger's consumers on every node: each builds a new session and consumer (a paused trigger stays paused).static voidResume the trigger on every node.voidStart the node's runtime (doesn't block). -
Uses of QException in com.kingsrook.qqq.lambda
Methods in com.kingsrook.qqq.lambda that throw QExceptionModifier and TypeMethodDescriptionprotected QLambdaResponseQAbstractLambdaHandler.handleJsonRequest(QLambdaRequest request, org.json.JSONObject bodyJsonObject) Meant to be overridden by subclasses, to provide functionality, if needed.protected QLambdaResponseQBaseCustomLambdaHandler.handleJsonRequest(QLambdaRequest request, org.json.JSONObject bodyJsonObject) Meant to be overridden by subclasses, to provide functionality, if needed.protected abstract QLambdaResponseQAbstractLambdaHandler.handleRequest(QLambdaRequest request) protected QLambdaResponseQBaseCustomLambdaHandler.handleRequest(QLambdaRequest request) protected QLambdaResponseQStandardLambdaHandler.handleRequest(QLambdaRequest request) -
Uses of QException in com.kingsrook.qqq.lambda.examples
Methods in com.kingsrook.qqq.lambda.examples that throw QExceptionModifier and TypeMethodDescriptionprotected QLambdaResponseExampleLambdaHandler.handleJsonRequest(QLambdaRequest request, org.json.JSONObject bodyJsonObject) -
Uses of QException in com.kingsrook.qqq.middleware.health
Methods in com.kingsrook.qqq.middleware.health that throw QExceptionModifier and TypeMethodDescriptionprotected HealthCheckMetaDataHealthMetaDataProducer.buildHealthCheckMetaData(QInstance qInstance) Build the HealthCheckMetaData configuration.Execute the health check.Produce QJavalinMetaData with health check configuration and auto-register the JavalinHealthRouteProvider.static StringPrefer live outcomes, falling back to persisted last state across pods. -
Uses of QException in com.kingsrook.qqq.middleware.health.indicators
Methods in com.kingsrook.qqq.middleware.health.indicators that throw QExceptionModifier and TypeMethodDescriptionExecute the memory health checkExecute the database health checkExecute the disk space health checkExecute the memory health check -
Uses of QException in com.kingsrook.qqq.middleware.javalin
Methods in com.kingsrook.qqq.middleware.javalin that throw QExceptionModifier and TypeMethodDescriptionstatic voidAssociatedWritePermissions.check(DeleteInput input) The caller has already authorized DELETE on the parent table.static voidAssociatedWritePermissions.check(InsertInput input) The caller has already authorized INSERT on the parent table.static voidAssociatedWritePermissions.check(UpdateInput input) The caller has already authorized EDIT on the parent table.static voidJoinedTablePermissions.checkAssociationReadPermissions(GetInput input) Get can request the complete association tree.static voidJoinedTablePermissions.checkReadPermissions(AbstractTableActionInput input, List<QueryJoin> queryJoins, QQueryFilter filter) Call after the base table's READ check.static QApplicationLauncherQApplicationLauncher.run(AbstractQQQApplication application, QApplicationLauncherConfig config) Start the application's server, schedule manager, and runtime services, returning the launcher that can stop them.static voidQJavalinImplementation.setRecordValuesForInsertOrUpdate(io.javalin.http.Context context, QTableMetaData tableMetaData, QRecord record, AbstractTableActionInput input) Read the values of a record insert or update request into a record: a JSON object body, or multipart form fields (with uploaded files for blob fields, and an `associations` field in the legacy or record-v1 format).voidQApplicationJavalinServer.start() -
Uses of QException in com.kingsrook.qqq.middleware.javalin.executors
Subclasses of QException in com.kingsrook.qqq.middleware.javalin.executorsModifier and TypeClassDescriptionstatic classInvalid state transitions are mapped to HTTP 409 by the endpoint.Methods in com.kingsrook.qqq.middleware.javalin.executors that throw QExceptionModifier and TypeMethodDescriptionstatic <T> TConvert typed domain values to the versioned wire representation.abstract voidvoidAuthenticationMetaDataExecutor.execute(AuthenticationMetaDataInput input, AuthenticationMetaDataOutputInterface output) voidBackChannelLogoutExecutor.execute(BackChannelLogoutInput input, BackChannelLogoutOutputInterface output) Invalid requests must fail before acquiring a SYSTEM session or deleting data.voidBulkLoadSuggestMappingExecutor.execute(BulkLoadSuggestMappingInput input, BulkLoadSuggestMappingOutputInterface output) Permission (the table's bulk-insert process), the upload ref's owner and the PHI rule are all checked by BulkLoadAssist, as the request's user.voidBulkLoadUploadProfileExecutor.execute(BulkLoadUploadProfileInput input, BulkLoadUploadProfileOutputInterface output) Permission (the table's bulk-insert process), the upload ref's owner and the PHI rule are all checked by BulkLoadAssist, as the request's user.voidBulkLoadValidateExecutor.execute(BulkLoadValidateInput input, BulkLoadValidateOutputInterface output) Permission (the table's bulk-insert process), the upload ref's owner and the PHI rule are all checked by BulkLoadAssist, as the request's user.voidGeneralDownloadExecutor.execute(GeneralDownloadInput input, GeneralDownloadOutputInterface output) Serve a file a process made available for download, exactly as the legacy download route does: a server file only when this session was granted it (ProcessFileDownload), a storage file only when its table and reference were registered for this session.voidHelpCoverageExecutor.execute(HelpCoverageMiddlewareInput input, HelpCoverageResponseV1 output) Execute using the authenticated request context.voidHelpSearchExecutor.execute(HelpSearchMiddlewareInput input, HelpSearchResponseV1 output) Execute using the authenticated request context.voidJobsExecutor.execute(JobsInput input, JobsOutput output) Execute one jobs operation under the current session.voidLogoutExecutor.execute(LogoutInput input, LogoutOutputInterface output) voidManageSessionExecutor.execute(ManageSessionInput input, ManageSessionOutputInterface output) voidMetaDataExecutor.execute(MetaDataInput input, MetaDataOutputInterface output) voidPossibleValuesExecutor.execute(PossibleValuesInput input, PossibleValuesOutputInterface output) voidProcessCancelExecutor.execute(ProcessCancelInput input, EmptyMiddlewareOutputInterface output) voidProcessInitOrStepExecutor.execute(ProcessInitOrStepInput input, ProcessInitOrStepOrStatusOutputInterface output) Note: implementation of the output interface here, it wants to know what type it's going to be first, so, be polite and always call .setType before any other setters.voidProcessJobLaunchExecutor.execute(ProcessJobLaunchInput input, ProcessJobLaunchOutputInterface output) voidProcessMetaDataExecutor.execute(ProcessMetaDataInput input, ProcessMetaDataOutputInterface output) voidProcessRecordsExecutor.execute(ProcessRecordsInput input, ProcessRecordsOutputInterface output) voidProcessStatusExecutor.execute(ProcessStatusInput input, ProcessInitOrStepOrStatusOutputInterface output) Note: implementation of the output interface here, it wants to know what type it's going to be first, so, be polite and always call .setType before any other setters.voidRecordAssociatedScriptLogsExecutor.execute(RecordAssociatedScriptLogsInput input, RecordAssociatedScriptLogsOutputInterface output) voidRecordAssociatedScriptStoreExecutor.execute(RecordAssociatedScriptStoreInput input, RecordAssociatedScriptStoreOutputInterface output) voidRecordDeveloperModeExecutor.execute(RecordDeveloperModeInput input, RecordDeveloperModeOutputInterface output) voidRecordDeveloperPanelsExecutor.execute(RecordDeveloperModeInput input, RecordDeveloperPanelsOutputInterface output) voidRecordFieldDownloadExecutor.execute(RecordFieldDownloadInput input, RecordFieldDownloadOutputInterface output) voidRecordSearchExecutor.execute(RecordSearchMiddlewareInput input, RecordSearchOutputInterface output) voidRelatedRecordPickerExecutor.execute(RelatedRecordPickerMiddlewareInput input, RelatedRecordPickerOutputInterface output) voidReportRunExecutor.execute(ReportRunInput input, TableExportOutputInterface output) voidTableCountExecutor.execute(TableCountInput input, TableCountOutputInterface output) voidTableDeleteExecutor.execute(TableDeleteInput input, TableDeleteOutputInterface output) voidTableExportExecutor.execute(TableExportInput input, TableExportOutputInterface output) voidTableGetExecutor.execute(TableGetInput input, TableGetOutputInterface output) voidTableInsertExecutor.execute(TableInsertInput input, TableInsertOutputInterface output) Insert the record (with any associated records), checking the insert permission and the write permissions of every association, as the legacy insert route does.voidTableMetaDataExecutor.execute(TableMetaDataInput input, TableMetaDataOutputInterface output) voidTableQueryExecutor.execute(TableQueryInput input, TableQueryOutputInterface output) voidTableRecordFeaturesExecutor.execute(TableRecordFeaturesInput input, TableRecordFeaturesOutputInterface output) voidTableUpdateExecutor.execute(TableUpdateInput input, TableUpdateOutputInterface output) Update the record (and any associated records), checking the edit permission and the write permissions of every association, as the legacy update route does.voidTableVariantsExecutor.execute(TableVariantsInput input, TableVariantsOutputInterface output) voidUploadsExecutor.execute(UploadsInput input, UploadsOutputInterface output) voidUserPreferencesExecutor.execute(UserPreferencesMiddlewareInput input, UserPreferencesOutputInterface output) Invoke the core action with the request's authenticated QContext.voidVersionExecutor.execute(VersionInput input, VersionOutputInterface output) voidWidgetExecutor.execute(WidgetInput input, WidgetOutputInterface output) -
Uses of QException in com.kingsrook.qqq.middleware.javalin.executors.io
Methods in com.kingsrook.qqq.middleware.javalin.executors.io that throw QExceptionModifier and TypeMethodDescriptionvoidBulkLoadSuggestMappingOutputInterface.setResult(BulkLoadAssistModels.Suggestion result) Fill this output from core's result.voidBulkLoadUploadProfileOutputInterface.setResult(BulkLoadAssistModels.UploadProfile result) Fill this output from core's result.voidBulkLoadValidateOutputInterface.setResult(BulkLoadAssistModels.Validation result) Fill this output from core's result. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.executors.utils
Method parameters in com.kingsrook.qqq.middleware.javalin.executors.utils with type arguments of type QExceptionModifier and TypeMethodDescriptionstatic voidRecordDeveloperModeUtils.checkRecordIsReadable(String tableName, String primaryKey, UnsafeConsumer<AbstractActionInput, QException> sessionSetup) Make sure the user can get the record that they're trying to do a related (script) action for: requires READ permission on its table, and throws not-found if there is no such record.RecordDeveloperModeUtils.getAssociatedScripts(QTableMetaData table, QRecord record, UnsafeConsumer<AbstractActionInput, QException> sessionSetup) Load the details of each of a table's associated scripts, for a record of that table: the script type, the script the record references (if any) with its revisions (newest first), and the script tester's input and output fields (if the associated script has a tester).Methods in com.kingsrook.qqq.middleware.javalin.executors.utils that throw QExceptionModifier and TypeMethodDescriptionstatic voidRecordDeveloperModeUtils.checkRecordIsReadable(String tableName, String primaryKey, UnsafeConsumer<AbstractActionInput, QException> sessionSetup) Make sure the user can get the record that they're trying to do a related (script) action for: requires READ permission on its table, and throws not-found if there is no such record.RecordDeveloperModeUtils.getAssociatedScripts(QTableMetaData table, QRecord record, UnsafeConsumer<AbstractActionInput, QException> sessionSetup) Load the details of each of a table's associated scripts, for a record of that table: the script type, the script the record references (if any) with its revisions (newest first), and the script tester's input and output fields (if the associated script has a tester).static QRecordGet the record that developer mode is for: requires READ permission on its table, generates display values and translates possible values, and throws not-found if there is no such record.RecordDeveloperModeUtils.getScriptLogRecords(QueryInput queryInput, String scriptRevisionId) Get the (newest, up to 100) logs of a script revision, each with its log lines as a list of records in its scriptLogLine value.static StoreAssociatedScriptOutputRecordDeveloperModeUtils.storeAssociatedScript(StoreAssociatedScriptInput input) Store a new revision of a record's associated script: requires EDIT permission on the record's table (checked before anything is stored). -
Uses of QException in com.kingsrook.qqq.middleware.javalin.health
Methods in com.kingsrook.qqq.middleware.javalin.health that throw QExceptionModifier and TypeMethodDescriptionprotected ObjectHealthSpecSupport.history(AbstractJsonEndpointSpec.JsonInput input) History is always bounded, newest first, with inclusive ISO-8601 bounds.protected QRecordMissing names are 404, including on-demand requests.protected voidHealthSpecSupport.requirePermission(boolean write) Require the same permissions as the health record screens.HealthSpecSupport.rows(String table, QQueryFilter filter) Read through standard actions under the caller's session.protected ObjectReuse the live runner, closing a transient one on every exit path.voidStart once; another launcher may already own this instance's runner.protected ObjectHealthSpecSupport.summary()Aggregate follows core severity semantics; pod presence is inferred from recent results, as in the System Health home. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.misc
Methods in com.kingsrook.qqq.middleware.javalin.misc that throw QExceptionModifier and TypeMethodDescriptionvoidDownloadFileSupplementalAction.run(DownloadFileSupplementalAction.DownloadFileSupplementalActionInput input, DownloadFileSupplementalAction.DownloadFileSupplementalActionOutput output) -
Uses of QException in com.kingsrook.qqq.middleware.javalin.realtime
Methods in com.kingsrook.qqq.middleware.javalin.realtime that throw QExceptionModifier and TypeMethodDescriptionvoidRealtimeExecutor.execute(RealtimeExecutor.Input input, RealtimeExecutor.Output output) Pass the stream hub to the output or apply a subscription request. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.routeproviders.authentication
Methods in com.kingsrook.qqq.middleware.javalin.routeproviders.authentication that throw QExceptionModifier and TypeMethodDescriptionbooleanRouteAuthenticatorInterface.authenticateRequest(io.javalin.http.Context context) Authenticate an HTTP request before the route is served.booleanSimpleRouteAuthenticator.authenticateRequest(io.javalin.http.Context context) Authenticate an HTTP request using QQQ's authentication system. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.routeproviders.contexthandlers
Methods in com.kingsrook.qqq.middleware.javalin.routeproviders.contexthandlers that throw QExceptionModifier and TypeMethodDescriptionbooleanDefaultRouteProviderContextHandler.handleResponse(io.javalin.http.Context context, RunProcessOutput runProcessOutput) Build HTTP response from process output.booleanRouteProviderContextHandlerInterface.handleResponse(io.javalin.http.Context context, RunProcessOutput runProcessOutput) Map process output into HTTP response.protected booleanDefaultRouteProviderContextHandler.handleResponseBody(io.javalin.http.Context context, RunProcessOutput runProcessOutput) Extract response body from process output and write to HTTP response. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.specs
Methods in com.kingsrook.qqq.middleware.javalin.specs that throw QExceptionModifier and TypeMethodDescriptionAbstractMiddlewareVersion.generateExtensionOpenAPIModel(String basePath, MiddlewareSpecExtension extension) The OpenAPI document of one extension alone (its paths and the component schemas its specs define) - what a qbit commits and contract-tests.AbstractMiddlewareVersion.generateOpenAPIModel(String basePath) voidAbstractMiddlewareVersion.preExecute(io.javalin.http.Context context) -
Uses of QException in com.kingsrook.qqq.middleware.javalin.specs.extensions
Methods in com.kingsrook.qqq.middleware.javalin.specs.extensions that throw QExceptionModifier and TypeMethodDescriptionvoidAbstractJsonEndpointSpec.JsonExecutor.execute(AbstractJsonEndpointSpec.JsonInput input, AbstractJsonEndpointSpec.JsonOutputInterface output) -
Uses of QException in com.kingsrook.qqq.middleware.javalin.specs.invoke
Methods in com.kingsrook.qqq.middleware.javalin.specs.invoke that throw QExceptionModifier and TypeMethodDescriptionUiApiAiDataGateway.count(CountInput input) UiApiInvoker.invoke(UiApiRequest request) Invoke an operation with the request's session.UiApiInvoker.invokeForStream(UiApiRequest request) Invoke with a streamed body.UiApiAiDataGateway.query(QueryInput input) UiApiAiDataGateway.renderWidget(RenderWidgetInput input) UiApiAiDataGateway.search(RecordSearchInput input) -
Uses of QException in com.kingsrook.qqq.middleware.javalin.specs.v1.responses
Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.responses that throw QExceptionModifier and TypeMethodDescriptionvoidBulkLoadSuggestMappingResponseV1.setResult(BulkLoadAssistModels.Suggestion result) Fill from core's result. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.specs.v1.utils
Methods in com.kingsrook.qqq.middleware.javalin.specs.v1.utils that throw QExceptionModifier and TypeMethodDescriptionstatic voidProcessSpecUtilsV1.addUploadedFiles(io.javalin.http.Context context, ProcessInitOrStepInput input) Read the files uploaded with a process init or step request (QRun-IO/qqq#543) the same way the legacy process routes do: every value is validated and every filename checked before anything is stored; each file is streamed to the uploaded-file archive table, and the field's process value becomes the list of StorageInputs that reference the stored files. -
Uses of QException in com.kingsrook.qqq.middleware.javalin.tools
Methods in com.kingsrook.qqq.middleware.javalin.tools that throw QExceptionModifier and TypeMethodDescriptionstatic StringUiApiContract.generateCoreYaml(AbstractMiddlewareVersion middlewareVersion) The core document of a middleware version, as PublishAPI writes it (properties sorted, for stable diffs).static StringUiApiContract.generateExtensionYaml(AbstractMiddlewareVersion middlewareVersion, MiddlewareSpecExtension extension) The document of one extension alone, as a module or qbit commits it. -
Uses of QException in com.kingsrook.qqq.slack
Methods in com.kingsrook.qqq.slack that throw QExceptionModifier and TypeMethodDescriptionstatic StringQSlackImplementation.convertWidgetDataToSlackMessage(QWidgetMetaDataInterface widgetMetaData, RenderWidgetOutput widgetOutput)