Package org.keycloak.provider

Interface EnvironmentDependentProviderFactory

All Known Subinterfaces:

AuthenticationChannelProviderFactory, CIBALoginUserResolverFactory, ClientPolicyConditionProviderFactory, ClientPolicyExecutorProviderFactory

All Known Implementing Classes:

AbstractClientPolicyConditionProviderFactory, AbstractMapProviderFactory, AcrProtocolMapper, AnyClientConditionFactory, CibaRootEndpoint, ClientAccessTypeConditionFactory, ClientRolesConditionFactory, ClientScopesConditionFactory, ClientSecretRotationExecutorFactory, ClientUpdaterContextConditionFactory, ClientUpdaterSourceGroupsConditionFactory, ClientUpdaterSourceHostsConditionFactory, ClientUpdaterSourceRolesConditionFactory, ConcurrentHashMapStorageProviderFactory, ConditionalLoaAuthenticatorFactory, ConfidentialClientAcceptExecutorFactory, ConsentRequiredExecutorFactory, DBLockGlobalLockProviderFactory, DefaultCIBALoginUserResolverFactory, DefaultHotRodConnectionProviderFactory, DefaultInfinispanConnectionProviderFactory, DeployedScriptAuthenticatorFactory, DeployedScriptOIDCProtocolMapper, DeployedScriptSAMLProtocolMapper, DisabledStickySessionEncoderProvider, DockerAuthV2ProtocolFactory, FileMapStorageProviderFactory, FullScopeDisabledExecutorFactory, HolderOfKeyEnforcerExecutorFactory, HotRodGlobalLockProviderFactory, HotRodMapStorageProviderFactory, HttpAuthenticationChannelProviderFactory, InfinispanCachePublicKeyProviderFactory, InfinispanClusterProviderFactory, InfinispanPublicKeyStorageProviderFactory, InfinispanStickySessionEncoderProviderFactory, InfinispanUserSessionProviderFactory, IntentClientBindCheckExecutorFactory, JpaExceptionConverter, JpaMapExceptionConverter, JpaMapStorageProviderFactory, JpaUserFederatedStorageProviderFactory, JpaUserSessionPersisterProviderFactory, KerberosFederationProviderFactory, LdapMapStorageProviderFactory, LegacyDatastoreProviderFactory, LiquibaseDBLockProviderFactory, MapAuthorizationStoreFactory, MapClientProviderFactory, MapClientScopeProviderFactory, MapDatastoreProviderFactory, MapDeploymentStateProviderFactory, MapEventStoreProviderFactory, MapGroupProviderFactory, MapPublicKeyStorageProviderFactory, MapRealmProviderFactory, MapRoleProviderFactory, MapRootAuthenticationSessionProviderFactory, MapSingleUseObjectProviderFactory, MapUserLoginFailureProviderFactory, MapUserProviderFactory, MapUserSessionProviderFactory, NoneGlobalLockProviderFactory, OpenshiftClientStorageProviderFactory, OpenShiftTokenReviewEndpoint, OpenShiftTokenReviewEndpointFactory, ParRootEndpoint, PKCEEnforcerExecutorFactory, RecoveryAuthnCodesAction, RecoveryAuthnCodesCredentialProviderFactory, RecoveryAuthnCodesFormAuthenticatorFactory, RecoveryCodesWarningThresholdPasswordPolicyProviderFactory, RegistrationAccessTokenRotationDisabledExecutorFactory, RejectRequestExecutorFactory, RejectResourceOwnerPasswordCredentialsGrantExecutorFactory, ScriptBasedAuthenticatorFactory, ScriptBasedMapper, ScriptBasedOIDCProtocolMapper, SecureCibaAuthenticationRequestSigningAlgorithmExecutorFactory, SecureCibaSessionEnforceExecutorFactory, SecureCibaSignedAuthenticationRequestExecutorFactory, SecureClientAuthenticatorExecutorFactory, SecureClientUrisExecutorFactory, SecureLogoutExecutorFactory, SecureRequestObjectExecutorFactory, SecureResponseTypeExecutorFactory, SecureSessionEnforceExecutorFactory, SecureSigningAlgorithmExecutorFactory, SecureSigningAlgorithmForSignedJwtExecutorFactory, SpnegoAuthenticatorFactory, SpnegoDisabledAuthenticatorFactory, SSSDFederationProviderFactory, SuppressRefreshTokenRotationExecutorFactory, UpdateEmail, WebAuthnAuthenticatorFactory, WebAuthnCredentialProviderFactory, WebAuthnPasswordlessAuthenticatorFactory, WebAuthnPasswordlessCredentialProviderFactory, WebAuthnPasswordlessRegisterFactory, WebAuthnRegisterFactory

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

isSupported

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.