Package org.keycloak.models.workflow

Interface WorkflowStepProviderFactory<P extends WorkflowStepProvider>

All Superinterfaces:

ComponentFactory<P,WorkflowStepProvider>, ConfiguredProvider, EnvironmentDependentProviderFactory, ProviderFactory<WorkflowStepProvider>

All Known Implementing Classes:

AddRequiredActionStepProviderFactory, DeleteClientStepProviderFactory, DeleteUserStepProviderFactory, DisableClientStepProviderFactory, DisableUserStepProviderFactory, GrantRoleStepProviderFactory, JoinGroupStepProviderFactory, LeaveGroupStepProviderFactory, NotifyUserStepProviderFactory, RemoveRequiredActionStepProviderFactory, RemoveUserAttributeStepProviderFactory, RestartWorkflowStepProviderFactory, RevokeRoleStepProviderFactory, SetUserAttributeStepProviderFactory

public interface WorkflowStepProviderFactory<P extends WorkflowStepProvider>
extends ComponentFactory<P,WorkflowStepProvider>, EnvironmentDependentProviderFactory

Method Summary

Modifier and Type	Method	Description
default void	close()	This is called when the server shuts down.
default List<ProviderConfigProperty>	getConfigProperties()
Set<ResourceType>	getTypes()	Supported types, usually one type but could be more (RestartStep for example)
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.component.ComponentFactory

create, create, getCommonProviderConfigProperties, getTypeMetadata, onCreate, onUpdate, preRemove, validateConfiguration

Methods inherited from interface org.keycloak.provider.ConfiguredProvider

getConfig, getHelpText

Methods inherited from interface org.keycloak.provider.ProviderFactory

dependsOn, getConfigMetadata, getId, order

Method Details

getTypes

Set<ResourceType> getTypes()

Supported types, usually one type but could be more (RestartStep for example)

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 WorkflowStepProvider>

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 WorkflowStepProvider>

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 WorkflowStepProvider>

getConfigProperties

default List<ProviderConfigProperty> getConfigProperties()

Specified by:

getConfigProperties in interface ConfiguredProvider

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.