org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper > インタフェーステンプレート

org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper > の継承関係図

org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper > 連携図

公開メンバ関数
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	onParentUpdate (RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel)
default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)
default List< ProviderConfigProperty >	getConfigProperties (RealmModel realm, ComponentModel parent)
default Map< String, Object >	getTypeMetadata (RealmModel realm, ComponentModel parent)
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 List< ProviderConfigProperty >	getCommonProviderConfigProperties ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.close ( )

inline

                         {

    }

create() [1/2]

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

inlineinherited

                                                         {
        return null;
    }

create() [2/2]

T org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.create	(	KeycloakSession	session,
		ComponentModel	model
	)

called per Keycloak transaction.

引数

session
model

戻り値

getCommonProviderConfigProperties()

default List<ProviderConfigProperty> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getCommonProviderConfigProperties ( )

inlineinherited

These are config properties that are common across all implementation of this component type

戻り値

                                                                     {
        return Collections.EMPTY_LIST;
    }

getConfigProperties() [1/2]

default List<ProviderConfigProperty> org.keycloak.component.SubComponentFactory< CreatedType, ProviderType extends Provider >.getConfigProperties ( RealmModel  realm, ComponentModel  parent  )

inlineinherited

                                                                                              {
        return getConfigProperties();
    }

getConfigProperties() [2/2]

default List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getConfigProperties ( )

inline

                                                               {
        return Collections.EMPTY_LIST;
    }

getHelpText()

default String org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getHelpText ( )

inline

                                 {
        return "";
    }

getId()

String org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.getId

(

)

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

戻り値

getTypeMetadata() [1/2]

default Map<String, Object> org.keycloak.component.SubComponentFactory< CreatedType, ProviderType extends Provider >.getTypeMetadata ( RealmModel  realm, ComponentModel  parent  )

inlineinherited

This is metadata about this component type. Its really configuration information about the component type and not an individual instance

戻り値

                                                                                         {
        return getTypeMetadata();

    }

getTypeMetadata() [2/2]

default Map<String, Object> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getTypeMetadata ( )

inlineinherited

This is metadata about this component type. Its really configuration information about the component type and not an individual instance

戻り値

                                          {
        return Collections.EMPTY_MAP;

    }

init()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.init ( Config.Scope  config )

inline

                                           {

    }

onCreate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.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

                                                                                           {

    }

onParentUpdate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.onParentUpdate ( RealmModel  realm, UserStorageProviderModel  oldParent, UserStorageProviderModel  newParent, ComponentModel  mapperModel  )

inline

                                                                                                                                                      {

    }

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

                                                                                                               {

    }

postInit()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.postInit ( KeycloakSessionFactory  factory )

inline

                                                          {

    }

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

                                                                                    {

    }

validateConfiguration()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inline

                                                                                                                                             {

    }

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/ldap/mappers/LDAPStorageMapperFactory.java