org.keycloak.provider.ConfigurationValidationHelper クラス

org.keycloak.provider.ConfigurationValidationHelper 連携図

公開メンバ関数
ConfigurationValidationHelper	checkInt (ProviderConfigProperty property, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkList (ProviderConfigProperty property, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkInt (String key, String label, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkLong (ProviderConfigProperty property, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkLong (String key, String label, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkSingle (ProviderConfigProperty property, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkSingle (String key, String label, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkRequired (ProviderConfigProperty property) throws ComponentValidationException
ConfigurationValidationHelper	checkRequired (String key, String label) throws ComponentValidationException
ConfigurationValidationHelper	checkBoolean (ProviderConfigProperty property, boolean required) throws ComponentValidationException
ConfigurationValidationHelper	checkBoolean (String key, String label, boolean required)

静的公開メンバ関数
static ConfigurationValidationHelper	check (ComponentModel model)

非公開メンバ関数
	ConfigurationValidationHelper (ComponentModel model)

非公開変数類
ComponentModel	model

詳解

著者

Stian Thorgersen

構築子と解体子

ConfigurationValidationHelper()

org.keycloak.provider.ConfigurationValidationHelper.ConfigurationValidationHelper ( ComponentModel  model )

inlineprivate

                                                                {
        this.model = model;
    }

関数詳解

check()

static ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.check ( ComponentModel  model )

inlinestatic

                                                                            {
        return new ConfigurationValidationHelper(model);
    }

checkBoolean() [1/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkBoolean ( ProviderConfigProperty  property, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                             {
        return checkBoolean(property.getName(), property.getLabel(), required);
    }

checkBoolean() [2/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkBoolean ( String  key, String  label, boolean  required  )

inline

                                                                                                  {
        checkSingle(key, label, required);

        String val = model.getConfig().getFirst(key);
        if (val != null && !(val.equals("true") || val.equals("false"))) {
            throw new ComponentValidationException("''{0}'' should be ''true'' or ''false''", label);
        }

        return this;
    }

checkInt() [1/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkInt ( ProviderConfigProperty  property, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                         {
        return checkInt(property.getName(), property.getLabel(), required);
    }

checkInt() [2/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkInt ( String  key, String  label, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                  {
        checkSingle(key, label, required);

        String val = model.getConfig().getFirst(key);
        if (val != null) {
            try {
                Integer.parseInt(val);
            } catch (NumberFormatException e) {
                throw new ComponentValidationException("''{0}'' should be a number", label);
            }
        }

        return this;
    }

checkList()

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkList ( ProviderConfigProperty  property, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                          {
        checkSingle(property.getName(), property.getLabel(), required);

        String value = model.getConfig().getFirst(property.getName());
        if (value != null && !property.getOptions().contains(value)) {
            StringBuilder options = new StringBuilder();
            int i = 1;
            for (String o : property.getOptions()) {
                if (i == property.getOptions().size()) {
                    options.append(" or ");
                } else if (i > 1) {
                    options.append(", ");
                }
                options.append(o);
                i++;
            }
            throw new ComponentValidationException("''{0}'' should be {1}", property.getLabel(), options.toString());
        }

        return this;
    }

checkLong() [1/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkLong ( ProviderConfigProperty  property, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                          {
        return checkLong(property.getName(), property.getLabel(), required);
    }

checkLong() [2/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkLong ( String  key, String  label, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                   {
        checkSingle(key, label, required);

        String val = model.getConfig().getFirst(key);
        if (val != null) {
            try {
                Long.parseLong(val);
            } catch (NumberFormatException e) {
                throw new ComponentValidationException("''{0}'' should be a number", label);
            }
        }

        return this;
    }

checkRequired() [1/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkRequired ( ProviderConfigProperty  property ) throws ComponentValidationException

inline

                                                                                                                            {
        return checkRequired(property.getName(), property.getLabel());
    }

checkRequired() [2/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkRequired ( String  key, String  label  ) throws ComponentValidationException

inline

                                                                                                                     {
        List<String> values = model.getConfig().get(key);
        if (values == null) {
            throw new ComponentValidationException("''{0}'' is required", label);
        }

        return this;
    }

checkSingle() [1/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkSingle ( ProviderConfigProperty  property, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                            {
        return checkSingle(property.getName(), property.getLabel(), required);
    }

checkSingle() [2/2]

ConfigurationValidationHelper org.keycloak.provider.ConfigurationValidationHelper.checkSingle ( String  key, String  label, boolean  required  ) throws ComponentValidationException

inline

                                                                                                                                     {
        if (model.getConfig().containsKey(key) && model.getConfig().get(key).size() > 1) {
            throw new ComponentValidationException("''{0}'' should be a single entry", label);
        }

        if (required) {
            checkRequired(key, label);
        }

        return this;
    }

メンバ詳解

model

ComponentModel org.keycloak.provider.ConfigurationValidationHelper.model

private

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/provider/ConfigurationValidationHelper.java