org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory クラス

org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory の継承関係図

org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory 連携図

公開メンバ関数
ClientRegistrationPolicy	create (KeycloakSession session, ComponentModel model)
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties (KeycloakSession session)
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
void	close ()
void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
default ProviderType	create (KeycloakSession session)
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 ()
default int	order ()

静的公開変数類
static final String	PROVIDER_ID = "allowed-client-templates"
static final String	ALLOWED_CLIENT_SCOPES = "allowed-client-scopes"
static final String	ALLOW_DEFAULT_SCOPES = "allow-default-scopes"

限定公開変数類
KeycloakSessionFactory	sessionFactory

非公開メンバ関数
List< String >	getClientScopes (KeycloakSession session)

非公開変数類
List< ProviderConfigProperty >	configProperties

詳解

著者

Marek Posolda

関数詳解

close()

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.close ( )

inlineinherited

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

                        {
    }

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]

ClientRegistrationPolicy org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.create ( KeycloakSession  session, ComponentModel  model  )

inline

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

                                                                                          {
        return new ClientScopesClientRegistrationPolicy(session, model);
    }

getClientScopes()

List<String> org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.getClientScopes ( KeycloakSession  session )

inlineprivate

                                                                  {
        RealmModel realm = session.getContext().getRealm();
        if (realm == null) {
            return Collections.emptyList();
        } else {
            List<ClientScopeModel> clientScopes = realm.getClientScopes();

            return clientScopes.stream().map((ClientScopeModel clientScope) -> {

                return clientScope.getName();

            }).collect(Collectors.toList());
        }
    }

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

戻り値

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

                                                                     {
        return Collections.EMPTY_LIST;
    }

getConfigProperties() [1/2]

List<ProviderConfigProperty> org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.getConfigProperties ( KeycloakSession  session )

inline

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyFactoryを実装しています。

                                                                                     {
        List<ProviderConfigProperty> configProps = new LinkedList<>();

        ProviderConfigProperty property;
        property = new ProviderConfigProperty();
        property.setName(ALLOWED_CLIENT_SCOPES);
        property.setLabel("allowed-client-scopes.label");
        property.setHelpText("allowed-client-scopes.tooltip");
        property.setType(ProviderConfigProperty.MULTIVALUED_LIST_TYPE);

        if (session != null) {
            property.setOptions(getClientScopes(session));
        }
        configProps.add(property);

        property = new ProviderConfigProperty();
        property.setName(ALLOW_DEFAULT_SCOPES);
        property.setLabel("allow-default-scopes.label");
        property.setHelpText("allow-default-scopes.tooltip");
        property.setType(ProviderConfigProperty.BOOLEAN_TYPE);
        property.setDefaultValue(true);
        configProps.add(property);

        configProperties = configProps;
        return configProperties;
    }

getConfigProperties() [2/2]

List<ProviderConfigProperty> org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.getConfigProperties ( )

inline

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

                                                              {
        return getConfigProperties(null);
    }

getHelpText()

String org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.getHelpText ( )

inline

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

                                {
        return "When present, it allows to specify whitelist of client scopes, which will be allowed in representation of registered (or updated) client";
    }

getId()

String org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.getId ( )

inline

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

                          {
        return PROVIDER_ID;
    }

getTypeMetadata()

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

戻り値

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

                                          {
        return Collections.EMPTY_MAP;

    }

init()

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.init ( Config.Scope  config )

inlineinherited

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

                                          {
    }

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

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                                                                   {

    }

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

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.postInit ( KeycloakSessionFactory  factory )

inlineinherited

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

                                                         {
        this.sessionFactory = factory;
    }

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

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inlineinherited

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

                                                                                                                                            {
    }

メンバ詳解

ALLOW_DEFAULT_SCOPES

final String org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.ALLOW_DEFAULT_SCOPES = "allow-default-scopes"

static

ALLOWED_CLIENT_SCOPES

final String org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.ALLOWED_CLIENT_SCOPES = "allowed-client-scopes"

static

configProperties

List<ProviderConfigProperty> org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.configProperties

private

PROVIDER_ID

final String org.keycloak.services.clientregistration.policy.impl.ClientScopesClientRegistrationPolicyFactory.PROVIDER_ID = "allowed-client-templates"

static

sessionFactory

KeycloakSessionFactory org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.sessionFactory

protectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/services/clientregistration/policy/impl/ClientScopesClientRegistrationPolicyFactory.java