/*
 * Copyright (C) 2025  Tim Zimmermann <tim@aglais.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.aglais.zms.db.core;

import org.jetbrains.annotations.NotNull;

/**
 * Class providing {@link Database} instances
 */
public abstract class DatabaseProvider {

    /**
     * Get the database implementation name
     *
     * @return The user-visible implementation name
     */
    public abstract String getName();

    /**
     * Create a new {@link Database} instance
     *
     * @param host     The host to connect to
     * @param database The database to operate on
     * @param username The username to use for authentication
     * @param password The password to use for authentication
     */
    public @NotNull abstract Database newInstance(String host, String database, String username, String password);

}
