dev.galasa.framework.internal.cps.FpfConfigurationPropertyRegistration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.framework Show documentation

A Galasa project

There is a newer version: 0.37.0

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.framework.internal.cps;

import java.io.File;
import java.net.URI;

import javax.validation.constraints.NotNull;

import org.osgi.service.component.annotations.Component;

import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.IConfigurationPropertyStoreRegistration;
import dev.galasa.framework.spi.IFrameworkInitialisation;

/**
 * 
 * 
 *  
 */
@Component(service = { IConfigurationPropertyStoreRegistration.class })
public class FpfConfigurationPropertyRegistration implements IConfigurationPropertyStoreRegistration {

    /**
     * 
     * This method checks that the CPS is a local file, and if true registers this
     * file as the ONLY CPS.
     * 
     * 
     * @param frameworkInitialisation
     * @throws ConfigurationPropertyStoreException
     */
    @Override
    public void initialise(@NotNull IFrameworkInitialisation frameworkInitialisation)
            throws ConfigurationPropertyStoreException {
        URI cps = frameworkInitialisation.getBootstrapConfigurationPropertyStore();

        if (!cps.getScheme().equals("file")) {
            return;
        }

        File file = new File(cps);

        if ((!file.exists())) {
            throw new ConfigurationPropertyStoreException("CPS file does not exist");
        }
        if (isFileUri(cps)) {
            frameworkInitialisation.registerConfigurationPropertyStore(new FpfConfigurationPropertyStore(cps));
        }
    }

    /**
     * 
     * A simple method thta checks the provided URI to the CPS is a local file or
     * not.
     * 
     * 
     * @param uri - URI to the CPS
     * @return - boolean if File or not.
     */
    public static boolean isFileUri(URI uri) {
        return "file".equals(uri.getScheme());
    }
}