Package org.keycloak.component
Interface AmphibianProviderFactory<ProviderType extends Provider>
- All Superinterfaces:
ComponentFactory<ProviderType,
,ProviderType> ConfiguredProvider
,ProviderFactory<ProviderType>
public interface AmphibianProviderFactory<ProviderType extends Provider>
extends ProviderFactory<ProviderType>, ComponentFactory<ProviderType,ProviderType>
Ancestor for a provider factory for both a standalone
ProviderFactory
and a ComponentFactory
. It
behaves as usual for a standalone provider, and for a component creates a factory customized according to
configuration of this component. The component creation then behaves in the same way as if it was
a standalone component, i.e.:
- The component-specific factory is initialized via
ProviderFactory.init(org.keycloak.Config.Scope)
method where the configuration is taken from the component configuration, converted into aConfig.Scope
. The component configuration takes precedence over configuration of the provider factory. - Creation of the instances is done via standard
create(KeycloakSession)
method even for components, since there is now a specific factory per component. - Component-specific factories are cached inside the provider factory similarly to how provider factories are cached in the session factory.
- Author:
- hmlnarik
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
create
(KeycloakSession session) default ProviderType
create
(KeycloakSession session, ComponentModel model) Deprecated.default List<ProviderConfigProperty>
default void
onUpdate
(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) default void
preRemove
(KeycloakSession session, RealmModel realm, ComponentModel model) Methods inherited from interface org.keycloak.component.ComponentFactory
getCommonProviderConfigProperties, getTypeMetadata, onCreate, validateConfiguration
Methods inherited from interface org.keycloak.provider.ConfiguredProvider
getConfig, getHelpText
Methods inherited from interface org.keycloak.provider.ProviderFactory
getConfigMetadata, getId, init, order, postInit
-
Method Details
-
create
- Specified by:
create
in interfaceComponentFactory<ProviderType extends Provider,
ProviderType extends Provider> - Specified by:
create
in interfaceProviderFactory<ProviderType extends Provider>
-
create
Deprecated.- Specified by:
create
in interfaceComponentFactory<ProviderType extends Provider,
ProviderType extends Provider>
-
getConfigProperties
- Specified by:
getConfigProperties
in interfaceConfiguredProvider
-
onUpdate
default void onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel) - Specified by:
onUpdate
in interfaceComponentFactory<ProviderType extends Provider,
ProviderType extends Provider>
-
preRemove
- Specified by:
preRemove
in interfaceComponentFactory<ProviderType extends Provider,
ProviderType extends Provider>
-
close
default void close()- Specified by:
close
in interfaceProviderFactory<ProviderType extends Provider>
-