/*
 * DBeaver - Universal Database Manager
 * Copyright (C) 2010-2022 DBeaver Corp and others
 *
 * 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.jkiss.dbeaver.model.auth;

import org.jkiss.code.Nullable;
import org.jkiss.dbeaver.model.exec.DBCException;

import java.util.Map;

/**
 * Credentials manager.
 * Keeps user credentials and provides low-level authentication mechanisms
 */
public interface DBAAuthCredentialsManager {

    /**
     * Find user with matching credentials.
     * It doesn't check credentials like passwords, just searches user id by identifying credentials.
     */
    @Nullable
    String getUserByCredentials(DBAAuthProviderDescriptor authProvider, Map<String, Object> authParameters) throws DBCException;

    /**
     * Get user credentials for specified provider
     */
    Map<String, Object> getUserCredentials(String userId, DBAAuthProviderDescriptor authProvider) throws DBCException;

}
