DeployedConfigurationsManager.java

/*
 * Copyright 2023 Red Hat, Inc. and/or its affiliates
 *  and other contributors as indicated by the @author tags.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.keycloak.deployment;

import org.jboss.logging.Logger;
import org.keycloak.models.AuthenticatorConfigModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;

/**
 * Allows to CRUD for configurations (like Authenticator configs). Those are typically saved in the store (realm), but can be also
 * deployed and hence not saved in the DB
 *
 * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
 */
public class DeployedConfigurationsManager {

    private static final Logger log = Logger.getLogger(DeployedConfigurationsManager.class);

    private final KeycloakSession session;

    public DeployedConfigurationsManager(KeycloakSession session) {
        this.session = session;
    }

    public void registerDeployedAuthenticatorConfig(AuthenticatorConfigModel model) {
        log.debugf("Register deployed authenticator config: %s", model.getId());
        session.getProvider(DeployedConfigurationsProvider.class).registerDeployedAuthenticatorConfig(model);
    }

    public AuthenticatorConfigModel getDeployedAuthenticatorConfig(String configId) {
        return session.getProvider(DeployedConfigurationsProvider.class).getDeployedAuthenticatorConfigs()
                .filter(config -> configId.equals(config.getId()))
                .findFirst().orElse(null);
    }

    public AuthenticatorConfigModel getAuthenticatorConfig(RealmModel realm, String configId) {
        AuthenticatorConfigModel cfgModel = getDeployedAuthenticatorConfig(configId);
        if (cfgModel != null) {
            log.tracef("Found deployed configuration by id: %s", configId);
            return cfgModel;
        } else {
            return realm.getAuthenticatorConfigById(configId);
        }
    }


    public AuthenticatorConfigModel getAuthenticatorConfigByAlias(RealmModel realm, String alias) {
        if (alias == null) return null;
        AuthenticatorConfigModel cfgModel = session.getProvider(DeployedConfigurationsProvider.class).getDeployedAuthenticatorConfigs()
                .filter(config -> alias.equals(config.getAlias()))
                .findFirst().orElse(null);
        if (cfgModel != null) {
            log.debugf("Found deployed configuration by alias: %s", alias);
            return cfgModel;
        } else {
            return realm.getAuthenticatorConfigByAlias(alias);
        }
    }

}