Package org.keycloak.authentication

Interface RequiredActionFactory

All Superinterfaces:
org.keycloak.provider.ProviderFactory<RequiredActionProvider>
public interface RequiredActionFactory extends org.keycloak.provider.ProviderFactory<RequiredActionProvider>
Factory interface for RequiredActionProvider's.
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<org.keycloak.provider.ProviderConfigProperty>
    MAX_AUTH_AGE_CONFIG_PROPERTIES
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<org.keycloak.provider.ProviderConfigProperty>
    getConfigMetadata()
     
    String
    getDisplayText()
    Display text used in admin console to reference this required action
    static List<org.keycloak.provider.ProviderConfigProperty>
    getMaxAuthAgePropertyConfig()
     
    default boolean
    isConfigurable()
    Indicates whether this required action can be configured via the admin ui.
    default boolean
    isOneTimeAction()
    Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.
    static int
    parseMaxAuthAge(org.keycloak.models.RequiredActionConfigModel model)
     
    default void
    validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.RequiredActionConfigModel model)
    Allows users to validate the provided configuration for this required action.

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    close, create, dependsOn, getId, init, order, postInit

  • Field Details

    • MAX_AUTH_AGE_CONFIG_PROPERTIES

      static final List<org.keycloak.provider.ProviderConfigProperty> MAX_AUTH_AGE_CONFIG_PROPERTIES

  • Method Details

    • getMaxAuthAgePropertyConfig

      static List<org.keycloak.provider.ProviderConfigProperty> getMaxAuthAgePropertyConfig()

    • getDisplayText

      String getDisplayText()
      Display text used in admin console to reference this required action
      Returns:

    • isOneTimeAction

      default boolean isOneTimeAction()
      Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.
      Returns:

    • isConfigurable

      default boolean isConfigurable()
      Indicates whether this required action can be configured via the admin ui.
      Returns:

    • getConfigMetadata

      default List<org.keycloak.provider.ProviderConfigProperty> getConfigMetadata()
      Specified by:
      getConfigMetadata in interface org.keycloak.provider.ProviderFactory<RequiredActionProvider>

    • validateConfig

      default void validateConfig(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.RequiredActionConfigModel model)
      Allows users to validate the provided configuration for this required action. Users can throw a ModelValidationException to indicate that the configuration is invalid. Defaults validating max_auth_age value.
      Parameters:
      session -
      realm -
      model -

    • parseMaxAuthAge

      static int parseMaxAuthAge(org.keycloak.models.RequiredActionConfigModel model) throws NumberFormatException
      Throws:
      NumberFormatException