uk.nhs.ciao.configuration.impl.PropertyStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ciao-configuration Show documentation

Library for managing configuration of CIAO CIPs

The newest version!

package uk.nhs.ciao.configuration.impl;

import java.util.Properties;

import uk.nhs.ciao.exceptions.CIAOConfigurationException;

/**
 * Implementations of the Ciao PropertyStore should be accessed
 * through the CIAOConfig class.
 * 
 * This interface provides methods to check and load versioned CIP
 * properties.
 * 
 * The property store implementations handles the specifics of how/where
 * properties are stored (e.g. file system, etcd) and can load
 * multiple versions of CipProperties. In contrast, CipProperties provides
 * access to a specific set of versioned properties.
 * 
 * @see uk.nhs.ciao.configuration.CIAOConfig
 * @author Adam Hatherly
 */
public interface PropertyStore {
	/**
	 * Checks whether the specified versioned properties exists in the store.
	 * @param cip_name Name of CIP
	 * @param version Version of CIP
	 * @param classifier Classifier where multiple variations of the same CIP are required
	 * @return true if the version exists and has values in it, false otherwise
	 * @throws CIAOConfigurationException 
	 */
	public boolean versionExists(String cip_name, String version, String classifier) throws CIAOConfigurationException;
	
	/**
	 * Load all the configuration keys at the specified path
	 * @param cip_name Name of CIP
	 * @param version Version of CIP
	 * @param classifier Classifier where multiple variations of the same CIP are required
	 * @return A loaded CipProperties instance matching the specified name and version
	 * @throws CIAOConfigurationException 
	 */
	public CipProperties loadConfig(String cip_name, String version, String classifier) throws CIAOConfigurationException;
	
	/**
	 * Populate the property store with the provided default values
	 * @param cip_name Name of CIP
	 * @param version Version of CIP
	 * @param classifier Classifier where multiple variations of the same CIP are required
	 * @param defaultConfig Java properties object with default values to set
	 * @return A CipProperties instance matching the specified name and version and configured with the specified defaults
	 * @throws CIAOConfigurationException If unable to set default config values
	 */
	public CipProperties setDefaults(String cip_name, String version, String classifier, Properties defaultConfig) throws CIAOConfigurationException;
}