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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	WorkflowStateProvider.ScheduledStep

Method Summary

Modifier and Type	Method	Description
List<WorkflowStateProvider.ScheduledStep>	getDueScheduledSteps(Workflow workflow)
WorkflowStateProvider.ScheduledStep	getScheduledStep(String workflowId, String resourceId)
List<WorkflowStateProvider.ScheduledStep>	getScheduledStepsByResource(String resourceId)
List<WorkflowStateProvider.ScheduledStep>	getScheduledStepsByWorkflow(String workflowId)
default List<WorkflowStateProvider.ScheduledStep>	getScheduledStepsByWorkflow(Workflow workflow)
void	remove(String workflowId)	Removes any record identified by the specified workflowId.
void	remove(String workflowId, String resourceId)	Removes the record identified by the specified workflowId and resourceId.
void	removeAll()	Deletes all state records associated with the current realm bound to the session.
void	removeByResource(String resourceId)	Deletes the state records associated with the given resourceId.
void	scheduleStep(Workflow workflow, WorkflowStep step, String resourceId)

Methods inherited from interface org.keycloak.provider.Provider

close

Method Details

removeByResource

void removeByResource(String resourceId)

Deletes the state records associated with the given resourceId.

Parameters:

resourceId - the id of the resource.

remove

void remove(String workflowId,
 String resourceId)

Removes the record identified by the specified workflowId and resourceId.

Parameters:

workflowId - the id of the workflow.

resourceId - the id of the resource.

remove

void remove(String workflowId)

Removes any record identified by the specified workflowId.

Parameters:

workflowId - the id of the workflow.

removeAll

void removeAll()

Deletes all state records associated with the current realm bound to the session.

scheduleStep

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

getScheduledStep

WorkflowStateProvider.ScheduledStep getScheduledStep(String workflowId,
 String resourceId)

getScheduledStepsByResource

List<WorkflowStateProvider.ScheduledStep> getScheduledStepsByResource(String resourceId)

getScheduledStepsByWorkflow

List<WorkflowStateProvider.ScheduledStep> getScheduledStepsByWorkflow(String workflowId)

getScheduledStepsByWorkflow

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

getDueScheduledSteps

List<WorkflowStateProvider.ScheduledStep> getDueScheduledSteps(Workflow workflow)