Package org.keycloak.models.workflow

Class JpaWorkflowStateProvider

java.lang.Object

org.keycloak.models.workflow.JpaWorkflowStateProvider

All Implemented Interfaces:

WorkflowStateProvider, Provider

public class JpaWorkflowStateProvider
extends Object
implements WorkflowStateProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.workflow.WorkflowStateProvider

WorkflowStateProvider.ScheduledStep

Constructor Summary

Constructors

Constructor	Description
JpaWorkflowStateProvider(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
void	close()
Stream<WorkflowStateProvider.ScheduledStep>	getDueScheduledSteps(Workflow workflow)
WorkflowStateProvider.ScheduledStep	getScheduledStep(String workflowId, String resourceId)
Stream<WorkflowStateProvider.ScheduledStep>	getScheduledStepsByResource(String resourceId)
Stream<WorkflowStateProvider.ScheduledStep>	getScheduledStepsByWorkflow(String workflowId)
boolean	hasScheduledSteps(String workflowId)	Checks whether there are any scheduled steps for the given workflowId.
void	remove(String executionId)	Removes the record identified by the specified executionId.
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	removeByWorkflow(String workflowId)	Removes any record identified by the specified workflowId.
void	removeByWorkflowAndResource(String workflowId, String resourceId)	Deletes the state records associated with the given resourceId of the given workflowId.
void	scheduleStep(Workflow workflow, WorkflowStep step, String resourceId, String executionId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.workflow.WorkflowStateProvider

getScheduledStepsByWorkflow

Constructor Details

JpaWorkflowStateProvider

public JpaWorkflowStateProvider(KeycloakSession session)

Method Details

getScheduledStep

public WorkflowStateProvider.ScheduledStep getScheduledStep(String workflowId,
 String resourceId)

Specified by:

getScheduledStep in interface WorkflowStateProvider

scheduleStep

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

Specified by:

scheduleStep in interface WorkflowStateProvider

getDueScheduledSteps

public Stream<WorkflowStateProvider.ScheduledStep> getDueScheduledSteps(Workflow workflow)

Specified by:

getDueScheduledSteps in interface WorkflowStateProvider

getScheduledStepsByWorkflow

public Stream<WorkflowStateProvider.ScheduledStep> getScheduledStepsByWorkflow(String workflowId)

Specified by:

getScheduledStepsByWorkflow in interface WorkflowStateProvider

getScheduledStepsByResource

public Stream<WorkflowStateProvider.ScheduledStep> getScheduledStepsByResource(String resourceId)

Specified by:

getScheduledStepsByResource in interface WorkflowStateProvider

removeByResource

public void removeByResource(String resourceId)

Description copied from interface: WorkflowStateProvider

Deletes the state records associated with the given resourceId.

Specified by:

removeByResource in interface WorkflowStateProvider

Parameters:

resourceId - the id of the resource.

removeByWorkflowAndResource

public void removeByWorkflowAndResource(String workflowId,
 String resourceId)

Description copied from interface: WorkflowStateProvider

Deletes the state records associated with the given resourceId of the given workflowId.

Specified by:

removeByWorkflowAndResource in interface WorkflowStateProvider

Parameters:

workflowId - the id of the workflow.

resourceId - the id of the resource.

removeByWorkflow

public void removeByWorkflow(String workflowId)

Description copied from interface: WorkflowStateProvider

Removes any record identified by the specified workflowId.

Specified by:

removeByWorkflow in interface WorkflowStateProvider

Parameters:

workflowId - the id of the workflow.

remove

public void remove(String executionId)

Description copied from interface: WorkflowStateProvider

Removes the record identified by the specified executionId.

Specified by:

remove in interface WorkflowStateProvider

removeAll

public void removeAll()

Description copied from interface: WorkflowStateProvider

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

Specified by:

removeAll in interface WorkflowStateProvider

hasScheduledSteps

public boolean hasScheduledSteps(String workflowId)

Description copied from interface: WorkflowStateProvider

Checks whether there are any scheduled steps for the given workflowId.

Specified by:

hasScheduledSteps in interface WorkflowStateProvider

Parameters:

workflowId - the id of the workflow.

Returns:

true if there are scheduled steps, false otherwise.

close

public void close()

Specified by:

close in interface Provider