public interface AmphibianProviderFactory<ProviderType extends Provider> extends ProviderFactory<ProviderType>, ComponentFactory<ProviderType,ProviderType>
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.:
ProviderFactory.init(org.keycloak.Config.Scope)
method where the configuration
is taken from the component configuration, converted into a Config.Scope
. The
component configuration takes precedence over configuration of the provider factory.create(KeycloakSession)
method even for components,
since there is now a specific factory per component.ComponentFactoryProviderFactory
Modifier and Type | Method and Description |
---|---|
default void |
close()
This is called when the server shuts down.
|
ProviderType |
create(KeycloakSession session) |
default ProviderType |
create(KeycloakSession session,
ComponentModel model)
Deprecated.
|
default List<ProviderConfigProperty> |
getConfigProperties() |
default 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.
|
getCommonProviderConfigProperties, getTypeMetadata, onCreate, validateConfiguration
getId, init, order, postInit
getHelpText
ProviderType create(KeycloakSession session)
create
in interface ComponentFactory<ProviderType extends Provider,ProviderType extends Provider>
create
in interface ProviderFactory<ProviderType extends Provider>
@Deprecated default ProviderType create(KeycloakSession session, ComponentModel model)
create
in interface ComponentFactory<ProviderType extends Provider,ProviderType extends Provider>
default List<ProviderConfigProperty> getConfigProperties()
getConfigProperties
in interface ConfiguredProvider
default void onUpdate(KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
ComponentFactory
onUpdate
in interface ComponentFactory<ProviderType extends Provider,ProviderType extends Provider>
oldModel
- old saved modelnewModel
- new configurationdefault void preRemove(KeycloakSession session, RealmModel realm, ComponentModel model)
ComponentFactory
preRemove
in interface ComponentFactory<ProviderType extends Provider,ProviderType extends Provider>
model
- model of the component, which is going to be removeddefault void close()
ProviderFactory
close
in interface ProviderFactory<ProviderType extends Provider>
Copyright © 2021 JBoss by Red Hat. All rights reserved.