Package org.keycloak.models.workflow

Interface WorkflowStepProviderFactory<P extends WorkflowStepProvider>

All Superinterfaces:
org.keycloak.component.ComponentFactory<P,WorkflowStepProvider>, org.keycloak.provider.ConfiguredProvider, EnvironmentDependentProviderFactory, org.keycloak.provider.ProviderFactory<WorkflowStepProvider>
public interface WorkflowStepProviderFactory<P extends WorkflowStepProvider> extends org.keycloak.component.ComponentFactory<P,WorkflowStepProvider>, EnvironmentDependentProviderFactory

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    close()
     
    default List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    Set<ResourceType>
    getSupportedResourceTypes()
    Supported types, usually one type but could be more (RestartStep for example)
    default void
    init(org.keycloak.Config.Scope config)
     
    default boolean
    isInternal()
     
    default boolean
    isSupported(org.keycloak.Config.Scope config)
    Check if the provider is supported and should be available based on the provider configuration.
    default void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     

    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

    • isInternal

      default boolean isInternal()
      Specified by:
      isInternal in interface org.keycloak.component.ComponentFactory<P extends WorkflowStepProvider,WorkflowStepProvider>

    • getSupportedResourceTypes

      Set<ResourceType> getSupportedResourceTypes()
      Supported types, usually one type but could be more (RestartStep for example)

    • init

      default void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<P extends WorkflowStepProvider>

    • postInit

      default void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<P extends WorkflowStepProvider>

    • close

      default void close()
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<P extends WorkflowStepProvider>

    • getConfigProperties

      default List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

    • isSupported

      default boolean isSupported(org.keycloak.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.