Class AbstractActionInput

java.lang.Object
com.kingsrook.qqq.backend.core.model.actions.AbstractActionInput
Direct Known Subclasses:
AbstractTableActionInput, AuditInput, ConsistentReadInput, ConvertHtmlToPdfInput, DMLAuditInput, EsbPublishInput, ExecuteCodeInput, GenerateOpenApiSpecInput, HelpCoverageInput, HelpSearchInput, MetaDataInput, ProcessMetaDataInput, RecordSearchInput, RenderTemplateInput, RenderWidgetInput, RunBackendStepInput, RunProcessInput, SearchPossibleValueSourceInput, SendMessageInput
public class AbstractActionInput extends Object
Base input class for all Q actions.

  • Constructor Details

    • AbstractActionInput

      public AbstractActionInput()

  • Method Details

    • getActionIdentity

      public String getActionIdentity()

    • getAsyncJobCallback

      public AsyncJobCallback getAsyncJobCallback()
      Getter for asyncJobCallback

    • setAsyncJobCallback

      public void setAsyncJobCallback(AsyncJobCallback asyncJobCallback)
      Setter for asyncJobCallback

    • getPermissionEnforcement

      public PermissionEnforcement getPermissionEnforcement()
      Getter for permissionEnforcement - how core actions should treat permissions for this input. See PermissionEnforcement and CorePermissionEnforcer.

    • setPermissionEnforcement

      public void setPermissionEnforcement(PermissionEnforcement permissionEnforcement)
      Setter for permissionEnforcement. Accepts DEFAULT or ENFORCE. SKIP must be requested through withPermissionBypass(reason), so that every bypass of permission checks carries an explicit justification.

    • withPermissionEnforcement

      public AbstractActionInput withPermissionEnforcement(PermissionEnforcement permissionEnforcement)
      Fluent setter for permissionEnforcement (DEFAULT or ENFORCE).

    • withPermissionBypass

      public AbstractActionInput withPermissionBypass(String reason)
      Mark this input as a trusted, framework- or system-internal call, which the core actions will not subject to table/process permission checks or field security locks - regardless of the instance setting. The reason is required, is logged when the bypass is applied, and makes bypasses easy to audit (grep for withPermissionBypass). Record security locks are NOT affected by this.

    • getPermissionBypassReason

      public String getPermissionBypassReason()
      Getter for permissionBypassReason (only set when permissionEnforcement is SKIP)