Package org.keycloak.models.workflow

Interface WorkflowStepProvider

All Superinterfaces:
Provider
All Known Implementing Classes:
AddRequiredActionStepProvider, DeleteClientStepProvider, DeleteUserStepProvider, DisableClientStepProvider, DisableUserStepProvider, GrantRoleStepProvider, GroupBasedStepProvider, JoinGroupStepProvider, LeaveGroupStepProvider, NotifyUserStepProvider, RemoveRequiredActionStepProvider, RemoveUserAttributeStepProvider, RestartWorkflowStepProvider, RevokeRoleStepProvider, RoleBasedStepProvider, SetUserAttributeStepProvider, UnlinkUserStepProvider
public interface WorkflowStepProvider extends Provider
Defines a provider interface for executing workflow steps.

Implementations of this interface represent individual steps that can be executed as part of a workflow. Each step can perform specific actions and optionally provide custom notification messages when users need to be informed about the step's execution.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getNotificationMessage()
    Returns the message or the text that should be used as the body of the email when notifying the user about this step.
    default String
    getNotificationSubject()
    Returns the message or the text that should be used as the subject of the email when notifying the user about this step.
    void
    run(WorkflowExecutionContext context)
    Runs this workflow step.

    Methods inherited from interface org.keycloak.provider.Provider

    close

  • Method Details

    • run

      void run(WorkflowExecutionContext context)
      Runs this workflow step.
      Parameters:
      context - the workflow execution context

    • getNotificationSubject

      default String getNotificationSubject()
      Returns the message or the text that should be used as the subject of the email when notifying the user about this step.
      Returns:
      the notification subject, or null if the default subject should be used

    • getNotificationMessage

      default String getNotificationMessage()
      Returns the message or the text that should be used as the body of the email when notifying the user about this step.
      Returns:
      the notification body, or null if the default subject should be used