Package org.keycloak.models.workflow

Interface WorkflowProvider

All Superinterfaces:

Provider

All Known Implementing Classes:

DefaultWorkflowProvider

public interface WorkflowProvider
extends Provider

Method Summary

Modifier and Type	Method	Description
void	activate(Workflow workflow, ResourceType type, String resourceId)
void	activateForAllEligibleResources(Workflow workflow)
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()
default Stream<Workflow>	getWorkflows(String search, Boolean exact, Integer first, Integer max)
void	removeWorkflow(Workflow workflow)
void	runScheduledSteps()
void	submit(WorkflowEvent event)
Workflow	toModel(WorkflowRepresentation representation)
WorkflowRepresentation	toRepresentation(Workflow workflow)
void	updateWorkflow(Workflow workflow, WorkflowRepresentation rep)

Methods inherited from interface org.keycloak.provider.Provider

close

Method Details

getResourceTypeSelector

ResourceTypeSelector getResourceTypeSelector(ResourceType type)

Returns a ResourceTypeSelector for the specified resource type.

Parameters:

type - the resource type.

Returns:

the corresponding ResourceTypeSelector.

toModel

Workflow toModel(WorkflowRepresentation representation)

getWorkflow

Workflow getWorkflow(String id)

removeWorkflow

void removeWorkflow(Workflow workflow)

getWorkflows

Stream<Workflow> getWorkflows()

getWorkflows

default Stream<Workflow> getWorkflows(String search,
 Boolean exact,
 Integer first,
 Integer max)

getScheduledWorkflowsByResource

Stream<WorkflowRepresentation> getScheduledWorkflowsByResource(String resourceId)

toRepresentation

WorkflowRepresentation toRepresentation(Workflow workflow)

updateWorkflow

void updateWorkflow(Workflow workflow,
 WorkflowRepresentation rep)

activate

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

deactivate

void deactivate(Workflow workflow,
 String resourceId)

submit

void submit(WorkflowEvent event)

runScheduledSteps

void runScheduledSteps()

activateForAllEligibleResources

void activateForAllEligibleResources(Workflow workflow)