Package org.keycloak.provider

Interface EnvironmentDependentProviderFactory

All Known Subinterfaces:
ClientPolicyConditionProviderFactory, ClientPolicyExecutorProviderFactory, ClientTypeManagerFactory
All Known Implementing Classes:
AbstractClientPolicyConditionProviderFactory, RecoveryCodesWarningThresholdPasswordPolicyProviderFactory
public interface EnvironmentDependentProviderFactory
Providers that are only supported in some environments can implement this interface to be able to determine if they should be available or not.
Author:
Stian Thorgersen

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isSupported()
    Deprecated.
    Prefer overriding/using the isSupported(Config.Scope) method.
    default boolean
    isSupported(Config.Scope config)
    An alternative to isSupported() method to check if the provider is supported based on the provider configuration.

  • Method Details

    • isSupported

      @Deprecated default boolean isSupported()
      Deprecated.
      Prefer overriding/using the isSupported(Config.Scope) method.
      Returns:
      true if the provider is supported and should be available, false otherwise

    • isSupported

      default boolean isSupported(Config.Scope config)
      An alternative to isSupported() method to check if the provider is supported based on the provider configuration.
      Parameters:
      config - the provider configuration
      Returns:
      true if the provider is supported. Otherwise, false.