Package org.keycloak.models.workflow

Interface WorkflowEventProviderFactory<P extends WorkflowEventProvider>

All Superinterfaces:

EnvironmentDependentProviderFactory, ProviderFactory<P>

All Known Implementing Classes:

ClientAuthenticatedWorkflowEventFactory, ClientCreatedWorkflowEventFactory, UserAuthenticatedWorkflowEventFactory, UserCreatedWorkflowEventFactory, UserFedIdentityAddedWorkflowEventFactory, UserFedIdentityRemovedWorkflowEventFactory, UserGroupMembershipAddedWorkflowEventFactory, UserGroupMembershipRemovedWorkflowEventFactory, UserRoleGrantedWorkflowEventFactory, UserRoleRevokedWorkflowEventFactory

public interface WorkflowEventProviderFactory<P extends WorkflowEventProvider>
extends ProviderFactory<P>, EnvironmentDependentProviderFactory

Method Summary

Modifier and Type	Method	Description
default void	close()	This is called when the server shuts down.
default P	create(KeycloakSession session)
P	create(KeycloakSession session, String configParameter)
default void	init(Config.Scope config)	Only called once when the factory is first created.
default boolean	isSupported(Config.Scope config)	Check if the provider is supported and should be available based on the provider configuration.
default void	postInit(KeycloakSessionFactory factory)	Called after all provider factories have been initialized

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, getId, order

Method Details

create

P create(KeycloakSession session,
 String configParameter)

create

default P create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<P extends WorkflowEventProvider>

isSupported

default boolean isSupported(Config.Scope config)

Description copied from interface: EnvironmentDependentProviderFactory

Check if the provider is supported and should be available based on the provider configuration.

Specified by:

isSupported in interface EnvironmentDependentProviderFactory

Parameters:

config - the provider configuration

Returns:

true if the provider is supported. Otherwise, false.

init

default void init(Config.Scope config)

Description copied from interface: ProviderFactory

Only called once when the factory is first created.

Specified by:

init in interface ProviderFactory<P extends WorkflowEventProvider>

postInit

default void postInit(KeycloakSessionFactory factory)

Description copied from interface: ProviderFactory

Called after all provider factories have been initialized

Specified by:

postInit in interface ProviderFactory<P extends WorkflowEventProvider>

close

default void close()

Description copied from interface: ProviderFactory

This is called when the server shuts down.

Specified by:

close in interface ProviderFactory<P extends WorkflowEventProvider>