org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider > インタフェーステンプレート

org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider > の継承関係図

org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider > 連携図

公開メンバ関数
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 ()

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

default void org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.close ( )

inline

                         {

    }

create()

T org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.create	(	KeycloakSession	session,
		ComponentModel	model
	)

called per Keycloak transaction.

引数

session
model

戻り値

getCommonProviderConfigProperties()

default List<ProviderConfigProperty> org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.getCommonProviderConfigProperties ( )

inline

configuration properties that are common across all UserStorageProvider implementations

戻り値

                                                                     {
        return ClientStorageProviderSpi.commonConfig();
    }

getConfigProperties()

default List<ProviderConfigProperty> org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.getConfigProperties ( )

inline

                                                               {
        return Collections.EMPTY_LIST;
    }

getHelpText()

default String org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.getHelpText ( )

inline

                                 {
        return "";
    }

getId()

String org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.getId

(

)

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

戻り値

getTypeMetadata()

default Map<String, Object> org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.getTypeMetadata ( )

inline

                                          {
        Map<String, Object> metadata = new HashMap<>();
        return metadata;
    }

init()

default void org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.init ( Config.Scope  config )

inline

                                           {

    }

onCreate()

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

inline

Called when ClientStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add.

引数

session
realm
model

                                                                                           {

    }

postInit()

default void org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >.postInit ( KeycloakSessionFactory  factory )

inline

                                                          {

    }

validateConfiguration()

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

inline

                                                                                                                                             {

    }

---

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

• D:/AppData/doxygen/keycloak/spi-private/src/server-spi-private/src/main/java/org/keycloak/storage/client/ClientStorageProviderFactory.java