Package org.keycloak.models.workflow

Interface WorkflowProviderEvent

All Superinterfaces:

ProviderEvent

All Known Subinterfaces:

WorkflowProviderEvent.WorkflowActivatedEvent, WorkflowProviderEvent.WorkflowCompletedEvent, WorkflowProviderEvent.WorkflowDeactivatedEvent, WorkflowProviderEvent.WorkflowResourceMigratedEvent, WorkflowProviderEvent.WorkflowRestartedEvent, WorkflowProviderEvent.WorkflowStepExecutedEvent, WorkflowProviderEvent.WorkflowStepFailedEvent, WorkflowProviderEvent.WorkflowStepScheduledEvent

public interface WorkflowProviderEvent
extends ProviderEvent

Base interface for workflow-related provider events.

Author:

Stefan Guilhen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WorkflowProviderEvent.WorkflowActivatedEvent	Event fired when a workflow is activated for a resource.
static interface	WorkflowProviderEvent.WorkflowCompletedEvent	Event fired when a workflow completes successfully.
static interface	WorkflowProviderEvent.WorkflowDeactivatedEvent	Event fired when a workflow is deactivated for a resource.
static interface	WorkflowProviderEvent.WorkflowResourceMigratedEvent	Event fired when workflow resources are migrated from one step/workflow to another.
static interface	WorkflowProviderEvent.WorkflowRestartedEvent	Event fired when a workflow is restarted for a resource.
static interface	WorkflowProviderEvent.WorkflowStepExecutedEvent	Event fired when a workflow step is executed successfully.
static interface	WorkflowProviderEvent.WorkflowStepFailedEvent	Event fired when a workflow step execution fails.
static interface	WorkflowProviderEvent.WorkflowStepScheduledEvent	Event fired when a workflow step is scheduled.

Method Summary

Modifier and Type	Method	Description
String	getExecutionId()	Gets the execution ID for this workflow activation.
KeycloakSession	getKeycloakSession()	Gets the Keycloak session associated with this event.
RealmModel	getRealm()	Gets the realm where the workflow event occurred.
String	getResourceId()	Gets the resource ID associated with this workflow event.
ResourceType	getResourceType()	Gets the resource type associated with this workflow event.
String	getWorkflowId()	Gets the workflow ID.
String	getWorkflowName()	Gets the workflow name.

Method Details

getKeycloakSession

KeycloakSession getKeycloakSession()

Gets the Keycloak session associated with this event.

Specified by:

getKeycloakSession in interface ProviderEvent

Returns:

the KeycloakSession

getRealm

RealmModel getRealm()

Gets the realm where the workflow event occurred.

Returns:

the RealmModel

getWorkflowId

String getWorkflowId()

Gets the workflow ID.

Returns:

the workflow ID

getWorkflowName

String getWorkflowName()

Gets the workflow name.

Returns:

the workflow name

getResourceId

String getResourceId()

Gets the resource ID associated with this workflow event.

Returns:

the resource ID

getResourceType

ResourceType getResourceType()

Gets the resource type associated with this workflow event.

Returns:

the ResourceType

getExecutionId

String getExecutionId()

Gets the execution ID for this workflow activation.

Returns:

the execution ID