Package org.keycloak.component
Interface ComponentFactory<CreatedType,ProviderType extends Provider>
-
- All Superinterfaces:
ConfiguredProvider
,ProviderFactory<ProviderType>
- All Known Subinterfaces:
AmphibianProviderFactory<ProviderType>
,ClientRegistrationPolicyFactory
,ClientScopeStorageProviderFactory<T>
,ClientStorageProviderFactory<T>
,GroupStorageProviderFactory<T>
,KeyProviderFactory<T>
,LDAPStorageMapperFactory<T>
,MapStorageProviderFactory
,RoleStorageProviderFactory<T>
,SubComponentFactory<CreatedType,ProviderType>
,UserStorageProviderFactory<T>
- All Known Implementing Classes:
AbstractClientRegistrationPolicyFactory
,AbstractEcdsaKeyProviderFactory
,AbstractGeneratedRsaKeyProviderFactory
,AbstractGeneratedSecretKeyProviderFactory
,AbstractImportedRsaKeyProviderFactory
,AbstractLDAPStorageMapperFactory
,AbstractMapProviderFactory
,AbstractRsaKeyProviderFactory
,CertificateLDAPStorageMapperFactory
,ClientDisabledClientRegistrationPolicyFactory
,ClientScopesClientRegistrationPolicyFactory
,ConcurrentHashMapStorageProviderFactory
,ConsentRequiredClientRegistrationPolicyFactory
,DeclarativeUserProfileProvider
,FileMapStorageProviderFactory
,FullNameLDAPStorageMapperFactory
,GeneratedAesKeyProviderFactory
,GeneratedEcdsaKeyProviderFactory
,GeneratedHmacKeyProviderFactory
,GeneratedRsaEncKeyProviderFactory
,GeneratedRsaKeyProviderFactory
,GroupLDAPStorageMapperFactory
,HardcodedAttributeMapperFactory
,HardcodedLDAPAttributeMapperFactory
,HardcodedLDAPGroupStorageMapperFactory
,HardcodedLDAPRoleStorageMapperFactory
,HotRodMapStorageProviderFactory
,ImportedRsaEncKeyProviderFactory
,ImportedRsaKeyProviderFactory
,JavaKeystoreKeyProviderFactory
,JpaMapStorageProviderFactory
,KerberosFederationProviderFactory
,LdapMapStorageProviderFactory
,LDAPStorageProviderFactory
,MapAuthorizationStoreFactory
,MapClientProviderFactory
,MapClientScopeProviderFactory
,MapEventStoreProviderFactory
,MapGlobalLockProviderFactory
,MapGroupProviderFactory
,MapPublicKeyStorageProviderFactory
,MapRealmProviderFactory
,MapRoleProviderFactory
,MapRootAuthenticationSessionProviderFactory
,MapSingleUseObjectProviderFactory
,MapUserLoginFailureProviderFactory
,MapUserProviderFactory
,MapUserSessionProviderFactory
,MaxClientsClientRegistrationPolicyFactory
,MSADLDSUserAccountControlStorageMapperFactory
,MSADUserAccountControlStorageMapperFactory
,OpenshiftClientStorageProviderFactory
,ProtocolMappersClientRegistrationPolicyFactory
,RoleLDAPStorageMapperFactory
,ScopeClientRegistrationPolicyFactory
,SSSDFederationProviderFactory
,TrustedHostClientRegistrationPolicyFactory
,UserAttributeLDAPStorageMapperFactory
public interface ComponentFactory<CreatedType,ProviderType extends Provider> extends ProviderFactory<ProviderType>, ConfiguredProvider
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ProviderType
create(KeycloakSession session)
CreatedType
create(KeycloakSession session, ComponentModel model)
default List<ProviderConfigProperty>
getCommonProviderConfigProperties()
These are config properties that are common across all implementation of this component typedefault Map<String,Object>
getTypeMetadata()
This is metadata about this component type.default void
onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)
Called after a component is createddefault void
onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
Called after the component is updated.default void
preRemove(KeycloakSession session, RealmModel realm, ComponentModel model)
Called before the component is removed.default void
validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model)
Called before a component is created or updated.-
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getConfigProperties, getHelpText
-
Methods inherited from interface org.keycloak.provider.ProviderFactory
close, getConfigMetadata, getId, init, order, postInit
-
-
-
-
Method Detail
-
create
CreatedType create(KeycloakSession session, ComponentModel model)
-
create
default ProviderType create(KeycloakSession session)
- Specified by:
create
in interfaceProviderFactory<CreatedType>
-
validateConfiguration
default void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) throws ComponentValidationException
Called before a component is created or updated. Allows you to validate the configuration- Parameters:
session
-realm
-model
-- Throws:
ComponentValidationException
-
onCreate
default void onCreate(KeycloakSession session, RealmModel realm, ComponentModel model)
Called after a component is created- Parameters:
session
-realm
-model
-
-
onUpdate
default void onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
Called after the component is updated.- Parameters:
session
-realm
-oldModel
- old saved modelnewModel
- new configuration
-
preRemove
default void preRemove(KeycloakSession session, RealmModel realm, ComponentModel model)
Called before the component is removed.- Parameters:
session
-realm
-model
- model of the component, which is going to be removed
-
getCommonProviderConfigProperties
default List<ProviderConfigProperty> getCommonProviderConfigProperties()
These are config properties that are common across all implementation of this component type- Returns:
-
-