org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider > インタフェーステンプレート

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider > の継承関係図

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider > 連携図

公開メンバ関数
T	create (KeycloakSession session, ComponentModel model)
String	getId ()
default void	init (Config.Scope config)
default void	postInit (KeycloakSessionFactory factory)
default void	close ()
default String	getHelpText ()
default List< ProviderConfigProperty >	getConfigProperties ()
default void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)
default List< ProviderConfigProperty >	getCommonProviderConfigProperties ()
default Map< String, Object >	getTypeMetadata ()
default ProviderType	create (KeycloakSession session)
default void	onUpdate (KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
default void	preRemove (KeycloakSession session, RealmModel realm, ComponentModel model)
default int	order ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

default void org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.close ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                         {

    }

create() [1/2]

default ProviderType org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.create ( KeycloakSession  session )

inlineinherited

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {
        return null;
    }

create() [2/2]

T org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.create	(	KeycloakSession	session,
		ComponentModel	model
	)

called per Keycloak transaction.

引数

session
model

戻り値

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

getCommonProviderConfigProperties()

default List<ProviderConfigProperty> org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.getCommonProviderConfigProperties ( )

inline

configuration properties that are common across all UserStorageProvider implementations

戻り値

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

                                                                     {
        return UserStorageProviderSpi.commonConfig();
    }

getConfigProperties()

default List<ProviderConfigProperty> org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.getConfigProperties ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                               {
        return Collections.EMPTY_LIST;
    }

getHelpText()

default String org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.getHelpText ( )

inline

org.keycloak.provider.ConfiguredProviderを実装しています。

                                 {
        return "";
    }

getId()

String org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.getId

(

)

This is the name of the provider and will be showed in the admin console as an option.

戻り値

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

getTypeMetadata()

default Map<String, Object> org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.getTypeMetadata ( )

inline

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

                                          {
        Map<String, Object> metadata = new HashMap<>();
        if (this instanceof ImportSynchronization) {
            metadata.put("synchronizable", true);
        }
        return metadata;
    }

init()

default void org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.init ( Config.Scope  config )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                           {

    }

onCreate()

default void org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.onCreate ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inline

Called when UserStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add. For example, you may be introspecting a database or ldap schema to automatically create mappings.

引数

session
realm
model

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                           {

    }

onUpdate()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.onUpdate ( KeycloakSession  session, RealmModel  realm, ComponentModel  oldModel, ComponentModel  newModel  )

inlineinherited

Called after the component is updated.

引数

session
realm
oldModel	old saved model
newModel	new configuration

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                                               {

    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

default void org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.postInit ( KeycloakSessionFactory  factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                          {

    }

preRemove()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.preRemove ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inlineinherited

Called before the component is removed.

引数

session
realm
model	model of the component, which is going to be removed

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                    {

    }

validateConfiguration()

default void org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inline

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

org.keycloak.storage.ldap.LDAPStorageProviderFactoryで実装されています。

                                                                                                                                             {

    }

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/UserStorageProviderFactory.java