Package org.keycloak.models.workflow

Class DefaultWorkflowProvider

java.lang.Object

org.keycloak.models.workflow.DefaultWorkflowProvider

All Implemented Interfaces:

WorkflowProvider, Provider

public class DefaultWorkflowProvider
extends Object
implements WorkflowProvider

Method Summary

Modifier and Type	Method	Description
void	activate(Workflow workflow, ResourceType type, String resourceId)
void	activateForAllEligibleResources(Workflow workflow)
void	close()
void	deactivate(Workflow workflow, String resourceId)
ResourceTypeSelector	getResourceTypeSelector(ResourceType type)	Returns a ResourceTypeSelector for the specified resource type.
Stream<WorkflowRepresentation>	getScheduledWorkflowsByResource(String resourceId)
Workflow	getWorkflow(String id)
Stream<Workflow>	getWorkflows()
void	migrateScheduledResources(String stepIdFrom, String stepIdTo)	Migrates scheduled resources from one workflow step to another.
void	removeWorkflow(Workflow workflow)
void	runScheduledSteps()
void	submit(WorkflowEvent event)
Workflow	toModel(WorkflowRepresentation rep)
WorkflowRepresentation	toRepresentation(Workflow workflow)
void	updateWorkflow(Workflow workflow, WorkflowRepresentation representation)

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.WorkflowProvider

getWorkflows

Method Details

getResourceTypeSelector

public ResourceTypeSelector getResourceTypeSelector(ResourceType type)

Description copied from interface: WorkflowProvider

Returns a ResourceTypeSelector for the specified resource type.

Specified by:

getResourceTypeSelector in interface WorkflowProvider

Parameters:

type - the resource type.

Returns:

the corresponding ResourceTypeSelector.

updateWorkflow

public void updateWorkflow(Workflow workflow,
 WorkflowRepresentation representation)

Specified by:

updateWorkflow in interface WorkflowProvider

removeWorkflow

public void removeWorkflow(Workflow workflow)

Specified by:

removeWorkflow in interface WorkflowProvider

getWorkflow

public Workflow getWorkflow(String id)

Specified by:

getWorkflow in interface WorkflowProvider

getWorkflows

public Stream<Workflow> getWorkflows()

Specified by:

getWorkflows in interface WorkflowProvider

getScheduledWorkflowsByResource

public Stream<WorkflowRepresentation> getScheduledWorkflowsByResource(String resourceId)

Specified by:

getScheduledWorkflowsByResource in interface WorkflowProvider

submit

public void submit(WorkflowEvent event)

Specified by:

submit in interface WorkflowProvider

runScheduledSteps

public void runScheduledSteps()

Specified by:

runScheduledSteps in interface WorkflowProvider

migrateScheduledResources

public void migrateScheduledResources(String stepIdFrom,
 String stepIdTo)

Description copied from interface: WorkflowProvider

Migrates scheduled resources from one workflow step to another. The destination step might be a step in the same workflow or a step in a different workflow.
If the resources are being migrated to a different workflow, the following conditions must be met:

• the source and destination workflows must support the same resource type;
• all resources must satisfy the activation conditions of the destination workflow.

The process behaves exactly as if the resources were being activated for the first time in the destination workflow, except that the first step to be processed is the specified destination step. So, if the step is a scheduled step, the resources will be scheduled accordingly. If the step is not a scheduled step, it will run immediately.

Specified by:

migrateScheduledResources in interface WorkflowProvider

Parameters:

stepIdFrom - the id of the step to migrate from.

stepIdTo - the id of the step to migrate to.

activate

public void activate(Workflow workflow,
 ResourceType type,
 String resourceId)

Specified by:

activate in interface WorkflowProvider

deactivate

public void deactivate(Workflow workflow,
 String resourceId)

Specified by:

deactivate in interface WorkflowProvider

activateForAllEligibleResources

public void activateForAllEligibleResources(Workflow workflow)

Specified by:

activateForAllEligibleResources in interface WorkflowProvider

toRepresentation

public WorkflowRepresentation toRepresentation(Workflow workflow)

Specified by:

toRepresentation in interface WorkflowProvider

toModel

public Workflow toModel(WorkflowRepresentation rep)

Specified by:

toModel in interface WorkflowProvider

close

public void close()

Specified by:

close in interface Provider