StorageClientFactory.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.storage.engine.client;

import java.io.IOException;
import java.net.URI;

import fr.gouv.vitam.common.ParametersChecker;
import fr.gouv.vitam.common.PropertiesUtils;
import fr.gouv.vitam.common.client.VitamClientFactory;
import fr.gouv.vitam.common.client.configuration.ClientConfiguration;
import fr.gouv.vitam.common.client.configuration.ClientConfigurationImpl;
import fr.gouv.vitam.common.error.VitamCode;
import fr.gouv.vitam.common.error.VitamCodeHelper;
import fr.gouv.vitam.common.logging.VitamLogger;
import fr.gouv.vitam.common.logging.VitamLoggerFactory;

/**
 * <p>
 * StorageClient factory
 * </p>
 * <p>
 * Use to get a storage client in function of its type.
 *
 * Example :
 * </p>
 *
 * <pre>
 * {
 *     @code
 *     // Retrieve default storage client
 *     StorageClient client = StorageClientFactory.getInstance().getStorageClient();
 *
 *     // Exists
 *     client.exists(tenantId, strategyId);
 * }
 * </pre>
 *
 * You can change the type of the client to get. The types are define into the
 * enum {@link StorageClientType}. Use the changeDefaultClientType method to
 * change the client type.
 *
 */
public class StorageClientFactory extends VitamClientFactory<StorageClient> {
    private static final VitamLogger LOGGER = VitamLoggerFactory.getInstance(StorageClientFactory.class);
    private static final String CONFIGURATION_FILENAME = "storage-client.conf";
    private static final StorageClientFactory STORAGE_CLIENT_FACTORY = new StorageClientFactory();

    /**
     * Default path
     */
    public static final String RESOURCE_PATH = "/storage/v1";

    private StorageClientFactory() {
        super(changeConfigurationFile(CONFIGURATION_FILENAME), RESOURCE_PATH);
    }

    /**
     * Get the StorageClientFactory instance
     *
     * @return the instance
     */
    public static StorageClientFactory getInstance() {
        return STORAGE_CLIENT_FACTORY;
    }

    /**
     * Get the default storage client
     *
     * @return the default storage client
     */
    @Override
    public StorageClient getClient() {
        StorageClient client;
        switch (getVitamClientType()) {
            case MOCK:
                client = new StorageClientMock();
                break;
            case PRODUCTION:
                client = new StorageClientRest(this);
                break;
            default:
                throw new IllegalArgumentException(VitamCodeHelper.getLogMessage(VitamCode.STORAGE_CLIENT_UNKNOWN));
        }
        return client;
    }

    /**
     * Change client configuration from a Yaml files
     *
     * @param configurationPath
     *            the path to the configuration file
     */
    static final ClientConfiguration changeConfigurationFile(String configurationPath) {
        ClientConfiguration configuration = null;
        try {
            configuration = PropertiesUtils.readYaml(PropertiesUtils.findFile(configurationPath), ClientConfigurationImpl.class);
        } catch (final IOException fnf) {
            LOGGER.debug("Error when retrieving configuration file {}, using mock", configurationPath, fnf);
        }
        if (configuration == null) {
            LOGGER.error("Error when retrieving configuration file {}, using mock", configurationPath);
        }
        return configuration;
    }

    static final void changeMode(ClientConfiguration configuration) {
        getInstance().initialisation(configuration, getInstance().getResourcePath());
    }

    /**
     * change mode client by server url For test purpose
     *
     * @param serviceUrl
     *            as String
     */
    static final void changeMode(String serviceUrl) {
        ParametersChecker.checkParameter("Server Url can not be null", serviceUrl);
        final URI uri = URI.create(serviceUrl);
        final ClientConfiguration configuration = new ClientConfigurationImpl(uri.getHost(), uri.getPort());
        changeMode(configuration);
    }
}