/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.storage.core;

import com.redhat.thermostat.shared.config.SSLConfiguration;
import com.redhat.thermostat.storage.config.StartupConfiguration;

/**
 * Factory for creating a new {@link Storage} instance.
 * 
 */
public interface StorageProvider {

    /**
     * Creates a new {@link Storage}.
     * 
     * @return The new instance.
     */
    Storage createStorage();

    /**
     * Sets the to-be-used configuration of this StorageProvider. Called prior
     * {@link StorageProvider#canHandleProtocol()}.
     * 
     * @param config
     * @param sslConf
     */
    void setConfig(String url, StorageCredentials creds, SSLConfiguration sslConf);

    /**
     * Method which determines if this StorageProvider can handle the given
     * protocol as set via
     * {@link StorageProvider#setConfig(StartupConfiguration)}.
     * 
     * <br/>
     * <br/>
     * <strong>Pre:</strong> Configuration has been set via
     * {@link StorageProvider#setConfig(StartupConfiguration)}.
     * 
     * @return true if this StorageProvider can handle the protocol prefix of
     *         the given StartupConfiguration. I.e.
     *         {@link StorageProvider#createStorage()} can be safely called
     *         given this config. false otherwise.
     */
    boolean canHandleProtocol();

}