dev.galasa.framework.spi.IConfigurationPropertyStoreRegistration 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.spi;

import javax.validation.constraints.NotNull;

/**
 *
 */
public interface IConfigurationPropertyStoreRegistration {

    /**
     * 
     * This method is called to selectively initialise the CPS. If this CPS is to be
     * initialise, it should register the CPS with @{link
     * {@link dev.galasa.framework.spi.IFrameworkInitialisation#registerConfigurationPropertyStore(IConfigurationPropertyStore)}
     * 
     * 
     * 
     * If there is any problem initialising the sole CPS, then an exception will be
     * thrown that will effectively terminate the Framework
     * 
     * 
     * @param frameworkInitialisation - Initialisation object containing access to
     *                                various initialisation methods
     * @throws ConfigurationPropertyStoreException - If there is a problem
     *                                             initialising the underlying store
     */
    void initialise(@NotNull IFrameworkInitialisation frameworkInitialisation)
            throws ConfigurationPropertyStoreException;

}