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

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

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

公開メンバ関数
default List< ProviderConfigProperty >	getConfigProperties (RealmModel realm, ComponentModel parent)
default Map< String, Object >	getTypeMetadata (RealmModel realm, ComponentModel parent)
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 ()

詳解

Useful when you want to describe config properties that are effected by the parent ComponentModel

著者

Bill Burke

バージョン

Revision

1

関数詳解

create() [1/2]

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

inherited

create() [2/2]

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

inlineinherited

                                                         {
        return null;
    }

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()

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

inline

                                                                                              {
        return getConfigProperties();
    }

getTypeMetadata() [1/2]

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

inline

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;

    }

onCreate()

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

inlineinherited

Called after a component is created

引数

session
realm
model

                                                                                   {

    }

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

                                                                                                               {

    }

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.component.ComponentFactory< CreatedType, ProviderType extends Provider >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  ) throws ComponentValidationException

inlineinherited

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

引数

session
realm
model

例外

ComponentValidationException

    {

    }

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/component/SubComponentFactory.java