org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider > インタフェーステンプレート

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider > の継承関係図

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider > 連携図

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

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

void org.keycloak.provider.ProviderFactory< T extends Provider >.close ( )

inherited

This is called when the server shuts down.

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.urls.HostnameProviderFactoryで実装されています。

create() [1/2]

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

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

create() [2/2]

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

inline

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

                                                         {
        return null;
    }

getCommonProviderConfigProperties()

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

inline

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

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

                                                                     {
        return Collections.EMPTY_LIST;
    }

getConfigProperties()

List<ProviderConfigProperty> org.keycloak.provider.ConfiguredProvider.getConfigProperties ( )

inherited

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

getHelpText()

String org.keycloak.provider.ConfiguredProvider.getHelpText ( )

inherited

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

getId()

String org.keycloak.provider.ProviderFactory< T extends Provider >.getId ( )

inherited

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

getTypeMetadata()

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

inline

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

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

                                          {
        return Collections.EMPTY_MAP;

    }

init()

void org.keycloak.provider.ProviderFactory< T extends Provider >.init ( Config.Scope  config )

inherited

Only called once when the factory is first created. This config is pulled from keycloak_server.json

引数

config

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.urls.HostnameProviderFactoryで実装されています。

onCreate()

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

inline

Called after a component is created

引数

session
realm
model

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

                                                                                   {

    }

onUpdate()

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

inline

Called after the component is updated.

引数

session
realm
oldModel	old saved model
newModel	new configuration

                                                                                                               {

    }

order()

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

inlineinherited

org.keycloak.urls.HostnameProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.provider.ProviderFactory< T extends Provider >.postInit ( KeycloakSessionFactory  factory )

inherited

Called after all provider factories have been initialized

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.urls.HostnameProviderFactoryで実装されています。

preRemove()

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

inline

Called before the component is removed.

引数

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

                                                                                    {

    }

validateConfiguration()

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

inline

Called before a component is created or updated. Allows you to validate the configuration

引数

session
realm
model

例外

ComponentValidationException

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >で実装されています。

    {

    }

---

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

• D:/AppData/doxygen/keycloak/spi/src/server-spi/src/main/java/org/keycloak/component/ComponentFactory.java