Configuration.java

// This software is released into the Public Domain.  See copying.txt for details.
package org.openstreetmap.osmosis.extract.apidb.common;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Properties;

import org.openstreetmap.osmosis.core.OsmosisRuntimeException;
import org.openstreetmap.osmosis.core.database.DatabaseLoginCredentials;
import org.openstreetmap.osmosis.core.database.DatabasePreferences;
import org.openstreetmap.osmosis.core.database.DatabaseType;


/**
 * Loads and exposes the extraction configuration properties.
 * 
 * @author Brett Henderson
 */
public class Configuration {

	private static final String KEY_HOST = "host";
	private static final String KEY_DATABASE = "database";
	private static final String KEY_USER = "user";
	private static final String KEY_PASSWORD = "password";
	private static final String KEY_DB_TYPE = "dbType";
	private static final String KEY_INTERVAL_LENGTH = "intervalLength";
	private static final String KEY_LAG_LENGTH = "lagLength";
	private static final String KEY_CHANGE_FILE_BEGIN_FORMAT = "changeFileBeginFormat";
	private static final String KEY_CHANGE_FILE_END_FORMAT = "changeFileEndFormat";
	private static final String KEY_READ_FULL_HISTORY = "readFullHistory";
	private static final String KEY_VALIDATE_SCHEMA_VERSION = "validateSchemaVersion";
	private static final String KEY_ALLOW_INCORRECT_SCHEMA_VERSION = "allowIncorrectSchemaVersion";

	private Properties properties;


	/**
	 * Creates a new instance.
	 * 
	 * @param configFile
	 *            The configuration file to read from.
	 */
	public Configuration(File configFile) {
		properties = loadProperties(configFile);
	}


	private Properties loadProperties(File configFile) {
		properties = new Properties();

		try (FileInputStream fileInputStream = new FileInputStream(configFile)) {
			properties.load(fileInputStream);

		} catch (IOException e) {
			throw new OsmosisRuntimeException("Unable to load properties from config file " + configFile);
		}

		return properties;
	}


	private String getProperty(String propertyName) {
		String value;

		value = properties.getProperty(propertyName);

		if (value == null) {
			throw new OsmosisRuntimeException("Property " + propertyName + " cannot be found.");
		}

		return value;
	}


	/**
	 * Returns the database host.
	 * 
	 * @return The database host.
	 */
	public String getHost() {
		return getProperty(KEY_HOST);
	}


	/**
	 * Returns the database instance.
	 * 
	 * @return The database instance.
	 */
	public String getDatabase() {
		return getProperty(KEY_DATABASE);
	}


	/**
	 * Returns the database user.
	 * 
	 * @return The database user.
	 */
	public String getUser() {
		return getProperty(KEY_USER);
	}


	/**
	 * Returns the database password.
	 * 
	 * @return The database password.
	 */
	public String getPassword() {
		// Call the properties object directly because we allow nulls for a password.
		return properties.getProperty(KEY_PASSWORD);
	}


	/**
	 * Returns the database type.
	 * 
	 * @return The database type
	 */
	public DatabaseType getDbType() {
		return DatabaseType.fromString(getProperty(KEY_DB_TYPE));
	}


	/**
	 * Returns the duration of each changeset interval.
	 * 
	 * @return The interval length in milliseconds.
	 */
	public int getIntervalLength() {
		return Integer.parseInt(getProperty(KEY_INTERVAL_LENGTH)) * 1000;
	}


	/**
	 * Returns the amount of time the extraction process lags the current time to allow the database
	 * to stabilise to ensure consistent queries.
	 * 
	 * @return The lag length in milliseconds.
	 */
	public int getLagLength() {
		return Integer.parseInt(getProperty(KEY_LAG_LENGTH)) * 1000;
	}


	/**
	 * Returns the begin time portion of the changeset filename.
	 * 
	 * @return The format.
	 */
	public String getChangeFileBeginFormat() {
		return getProperty(KEY_CHANGE_FILE_BEGIN_FORMAT);
	}


	/**
	 * Returns the end time portion of the changeset filename.
	 * 
	 * @return The format.
	 */
	public String getChangeFileEndFormat() {
		return getProperty(KEY_CHANGE_FILE_END_FORMAT);
	}


	/**
	 * Returns the full history flag.
	 * 
	 * @return The full history flag.
	 */
	public boolean getReadFullHistory() {
		return Boolean.valueOf(getProperty(KEY_READ_FULL_HISTORY));
	}


	/**
	 * Returns the validate schema version flag.
	 * 
	 * @return The validate schema version flag.
	 */
	public boolean getValidateSchemaVersion() {
		return Boolean.valueOf(getProperty(KEY_VALIDATE_SCHEMA_VERSION));
	}


	/**
	 * Returns the validate schema version flag.
	 * 
	 * @return The validate schema version flag.
	 */
	public boolean getAllowIncorrectSchemaVersion() {
		return Boolean.valueOf(getProperty(KEY_ALLOW_INCORRECT_SCHEMA_VERSION));
	}


	/**
	 * Provides a fully configured set of database login credentials based on the configuration.
	 * 
	 * @return The database login credentials.
	 */
	public DatabaseLoginCredentials getDatabaseLoginCredentials() {
		return new DatabaseLoginCredentials(getHost(), getDatabase(), getUser(), getPassword(), false, false,
				getDbType());
	}
	
	
	/**
	 * Provides a fully configured set of database preferences based on the configuration.
	 * 
	 * @return The database preferences.
	 */
	public DatabasePreferences getDatabasePreferences() {
		return new DatabasePreferences(getValidateSchemaVersion(), getAllowIncorrectSchemaVersion());
	}
}