Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

7.7. 添加/删除用户和查询功能接口

我们使用我们的示例的一个操作是允许它添加和删除用户或更改密码。在我们示例中定义的用户也可在管理门户中查询或查看。要添加这些改进，我们的示例供应商必须实现 UserQueryMethodsProvider （或 UserQueryProvider）和 UserRegistrationProvider 接口。

7.7.1. Implementing UserRegistrationProvider
复制链接

使用此流程实施从特定存储中添加和删除用户，我们必须首先可以将属性文件保存到磁盘中。

PropertyFileUserStorageProvider

    public void save() {
        String path = model.getConfig().getFirst("path");
        path = EnvUtil.replace(path);
        try {
            FileOutputStream fos = new FileOutputStream(path);
            properties.store(fos, "");
            fos.close();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

然后，addUser （） 和 removeUser （） 方法的实现变得很简单。

PropertyFileUserStorageProvider

    public static final String UNSET_PASSWORD="#$!-UNSET-PASSWORD";

    @Override
    public UserModel addUser(RealmModel realm, String username) {
        synchronized (properties) {
            properties.setProperty(username, UNSET_PASSWORD);
            save();
        }
        return createAdapter(realm, username);
    }

    @Override
    public boolean removeUser(RealmModel realm, UserModel user) {
        synchronized (properties) {
            if (properties.remove(user.getUsername()) == null) return false;
            save();
            return true;
        }
    }

请注意，在添加用户时，我们将属性映射的 password 值设置为 UNSET_PASSWORD。我们这样做是无法对属性值中的属性有 null 值。我们还必须修改 CredentialInputValidator 方法来反映这一点。

如果供应商实现 UserRegistrationProvider 接口，则会调用 addUser （） 方法。如果您的提供程序有一个配置开关来关闭添加用户，则从此方法返回 null 将跳过提供程序并调用下一个用户。

PropertyFileUserStorageProvider

    @Override
    public boolean isValid(RealmModel realm, UserModel user, CredentialInput input) {
        if (!supportsCredentialType(input.getType()) || !(input instanceof UserCredentialModel)) return false;

        UserCredentialModel cred = (UserCredentialModel)input;
        String password = properties.getProperty(user.getUsername());
        if (password == null || UNSET_PASSWORD.equals(password)) return false;
        return password.equals(cred.getValue());
    }

由于我们现在可以保存属性文件，因此允许密码更新也很有意义。

PropertyFileUserStorageProvider

    @Override
    public boolean updateCredential(RealmModel realm, UserModel user, CredentialInput input) {
        if (!(input instanceof UserCredentialModel)) return false;
        if (!input.getType().equals(PasswordCredentialModel.TYPE)) return false;
        UserCredentialModel cred = (UserCredentialModel)input;
        synchronized (properties) {
            properties.setProperty(user.getUsername(), cred.getValue());
            save();
        }
        return true;
    }

现在，我们可以实施禁用密码。

PropertyFileUserStorageProvider

    @Override
    public void disableCredentialType(RealmModel realm, UserModel user, String credentialType) {
        if (!credentialType.equals(PasswordCredentialModel.TYPE)) return;
        synchronized (properties) {
            properties.setProperty(user.getUsername(), UNSET_PASSWORD);
            save();
        }

    }

    private static final Set<String> disableableTypes = new HashSet<>();

    static {
        disableableTypes.add(PasswordCredentialModel.TYPE);
    }

    @Override
    public Stream<String> getDisableableCredentialTypes(RealmModel realm, UserModel user) {

        return disableableTypes.stream();
    }

通过实现这些方法，您现在可以在管理控制台中更改和禁用用户的密码。

7.7.2. 实现 UserQueryProvider
复制链接

UserQueryProvider 是 UserQueryMethodsProvider 和 UserCountMethodsProvider 的组合。如果没有实施 UserQueryMethodsProvider，Admin 控制台将无法查看和管理由我们的示例供应商载入的用户。让我们来看看实施此接口。

PropertyFileUserStorageProvider

    @Override
    public int getUsersCount(RealmModel realm) {
        return properties.size();
    }

    @Override
    public Stream<UserModel> searchForUserStream(RealmModel realm, String search, Integer firstResult, Integer maxResults) {
        Predicate<String> predicate = "*".equals(search) ? username -> true : username -> username.contains(search);
        return properties.keySet().stream()
                .map(String.class::cast)
                .filter(predicate)
                .skip(firstResult)
                .map(username -> getUserByUsername(realm, username))
                .limit(maxResults);
    }

searchForUserStream （） 的第一个声明采用 String 参数。在本例中，参数表示您要搜索的用户名。这个字符串可以是子字符串，它解释了在执行搜索时的 String.contains （） 方法的选择。请注意，使用 * 表示请求所有用户的列表。该方法迭代属性文件的密钥集，委派至 getUserByUsername （） 以加载用户。请注意，我们会根据 firstResult 和 maxResults 参数对这个调用进行索引。如果您的外部存储不支持分页，则必须执行类似的逻辑。

PropertyFileUserStorageProvider

    @Override
    public Stream<UserModel> searchForUserStream(RealmModel realm, Map<String, String> params, Integer firstResult, Integer maxResults) {
        // only support searching by username
        String usernameSearchString = params.get("username");
        if (usernameSearchString != null)
            return searchForUserStream(realm, usernameSearchString, firstResult, maxResults);

        // if we are not searching by username, return all users
        return searchForUserStream(realm, "*", firstResult, maxResults);
    }

采用 Map 参数的 searchForUserStream （） 方法可以根据名字、姓氏、用户名和电子邮件搜索用户。仅存储用户名，因此搜索仅基于用户名，当 Map 参数不包含 username 属性时除外。在这种情况下，所有用户都会被返回。在这种情况下，使用 searchForUserStream (realm, search, firstResult, maxResults)。

PropertyFileUserStorageProvider

    @Override
    public Stream<UserModel> getGroupMembersStream(RealmModel realm, GroupModel group, Integer firstResult, Integer maxResults) {
        return Stream.empty();
    }

    @Override
    public Stream<UserModel> searchForUserByUserAttributeStream(RealmModel realm, String attrName, String attrValue) {
        return Stream.empty();
    }

组或属性不会存储，因此其他方法会返回一个空流。

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2026 Red Hat返回顶部