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

静的公開変数類
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

                        {
    }

create()

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

inline

                                                                                          {
        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());
        }
    }

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

                                                              {
        return getConfigProperties(null);
    }

getHelpText()

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

inline

                                {
        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

                          {
        return PROVIDER_ID;
    }

init()

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

inlineinherited

                                          {
    }

postInit()

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

inlineinherited

                                                         {
        this.sessionFactory = factory;
    }

validateConfiguration()

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

inlineinherited

                                                                                                                                            {
    }

メンバ詳解

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/rest-service/src/services/src/main/java/org/keycloak/services/clientregistration/policy/impl/ClientScopesClientRegistrationPolicyFactory.java