Package org.keycloak.models.workflow

Interface WorkflowStateProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
JpaWorkflowStateProvider
public interface WorkflowStateProvider extends Provider
Interface serves as state check for workflow actions.

  • Method Details

    • removeByResource

      void removeByResource(String resourceId)
      Deletes the state records associated with the given resourceId.
      Parameters:
      resourceId - the id of the resource.

    • removeByWorkflowAndResource

      void removeByWorkflowAndResource(String workflowId, String resourceId)
      Deletes the state records associated with the given resourceId of the given workflowId.
      Parameters:
      workflowId - the id of the workflow.
      resourceId - the id of the resource.

    • removeByWorkflow

      void removeByWorkflow(String workflowId)
      Removes any record identified by the specified workflowId.
      Parameters:
      workflowId - the id of the workflow.

    • remove

      void remove(String executionId)
      Removes the record identified by the specified executionId.

    • removeAll

      void removeAll()
      Deletes all state records associated with the current realm bound to the session.

    • hasScheduledSteps

      boolean hasScheduledSteps(String workflowId)
      Checks whether there are any scheduled steps for the given workflowId.
      Parameters:
      workflowId - the id of the workflow.
      Returns:
      true if there are scheduled steps, false otherwise.

    • scheduleStep

      void scheduleStep(Workflow workflow, WorkflowStep step, String resourceId, String executionId)

    • getScheduledStep

      WorkflowStateProvider.ScheduledStep getScheduledStep(String workflowId, String resourceId)

    • getScheduledStepsByResource

      Stream<WorkflowStateProvider.ScheduledStep> getScheduledStepsByResource(String resourceId)

    • getScheduledStepsByWorkflow

      Stream<WorkflowStateProvider.ScheduledStep> getScheduledStepsByWorkflow(String workflowId)

    • getScheduledStepsByWorkflow

      default Stream<WorkflowStateProvider.ScheduledStep> getScheduledStepsByWorkflow(Workflow workflow)

    • getDueScheduledSteps

      Stream<WorkflowStateProvider.ScheduledStep> getDueScheduledSteps(Workflow workflow)