es.ree.eemws.kit.config.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eemws-kit Show documentation
Client implementation of IEC 62325-504 technical specification. eemws-kit includes command line utilities to invoke the eem web services, as well as several GUI applications (browser, editor, ...)
The newest version!
/*
 * Copyright 2024 Redeia.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 *  by the Free Software Foundation, version 3 of the license.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTIBIILTY or FITNESS FOR A PARTICULAR PURPOSE. See GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program. If not, see
 * http://www.gnu.org/licenses/.
 *
 * Any redistribution and/or modification of this program has to make
 * reference to Redeia as the copyright owner of the program.
 */
package es.ree.eemws.kit.config;

import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.logging.Level;
import java.util.logging.Logger;

import es.ree.eemws.core.utils.config.ConfigException;
import es.ree.eemws.core.utils.config.ConfigManager;
import es.ree.eemws.core.utils.file.FileUtil;
import es.ree.eemws.kit.gui.applications.configuration.MessageCatalog;

/**
 * Class for settings management.
 *
 * @author Redeia.
 * @version 2.1 01/01/2024
 */
public class Configuration {

	/** Mapping key to {@link #url}. */
	public static final String WEBSERVICE_URL_KEY = "WEBSERVICES.URL"; //$NON-NLS-1$

	/** Mapping key to {@link #keyStoreFile}. */
	private static final String KEY_STORE_FILE_KEY = "javax.net.ssl.keyStore"; //$NON-NLS-1$

	/** Mapping key to {@link #keyStorePassword}. */
	private static final String KEY_STORE_PASSWORD_KEY = "javax.net.ssl.keyStorePassword"; //$NON-NLS-1$

	/** Mapping key to {@link #proxyHost}. */
	private static final String PROXY_HOST_KEY = "https.proxyHost"; //$NON-NLS-1$

	/** Mapping key to {@link #proxyPort}. */
	private static final String PROXY_PORT_KEY = "https.proxyPort"; //$NON-NLS-1$

	/** Mapping key to {@link #proxyUser}. */
	private static final String PROXY_USER_KEY = "https.proxyUser"; //$NON-NLS-1$

	/** Mapping key to {@link #proxyPassword}. */
	private static final String PROXY_PASSWORD_KEY = "https.proxyPassword"; //$NON-NLS-1$

	/** URL for the end point. */
	private String url = null;

	/** Path to Key store file. */
	private String keyStoreFile;

	/** Path to Access Key store. */
	private String keyStorePassword;

	/** Host name for proxy server. */
	private String proxyHost;

	/** Listening port for proxy server. */
	private String proxyPort;

	/** User name for proxy server. */
	private String proxyUser;

	/** User password for proxy server. */
	private String proxyPassword;

	/** Path to configuration file. */
	public static final String CONFIG_FILE = "config.properties"; //$NON-NLS-1$

	/**
	 * Reads system settings.
	 *
	 * @throws ConfigException If cannot load settings.
	 */
	public void readConfiguration() throws ConfigException {

		var cm = new ConfigManager();
		cm.readConfigFile(CONFIG_FILE);

		url = cm.getValue(WEBSERVICE_URL_KEY);

		keyStoreFile = cm.getValue(KEY_STORE_FILE_KEY);
		keyStorePassword = cm.getValue(KEY_STORE_PASSWORD_KEY);

		proxyHost = cm.getValue(PROXY_HOST_KEY);
		proxyPort = cm.getValue(PROXY_PORT_KEY);
		proxyUser = cm.getValue(PROXY_USER_KEY);
		proxyPassword = cm.getValue(PROXY_PASSWORD_KEY);

		if (!hasMinimumConfiguration()) {
			throw new ConfigException(MessageCatalog.SETTINGS_MISS_CONFIGURED.getMessage());
		}

	}

	/**
	 * Updates configuration file with the current values.
	 *
	 * @throws ConfigException If cannot modify settings file (Error accessing
	 *                         file).
	 */
	public void writeConfiguration() throws ConfigException {

		var cm = new ConfigManager();

		try {
			cm.readConfigFile(CONFIG_FILE);
		} catch (ConfigException ex) {

			/* Ignore config exception if the configuration is not valid. */
			/* Ignore errors on load. */
			Logger.getLogger(getClass().getName()).log(Level.FINE, "", ex); //$NON-NLS-1$
		}

		try {

			var fullConfigPath = FileUtil.getFullPathOfResoruce(CONFIG_FILE);

			var fileContent = new StringBuilder(FileUtil.read(fullConfigPath));
			writeValue(url, cm.getValue(WEBSERVICE_URL_KEY), WEBSERVICE_URL_KEY, fileContent);

			writeValue(proxyHost, cm.getValue(PROXY_HOST_KEY), PROXY_HOST_KEY, fileContent);
			writeValue(proxyPort, cm.getValue(PROXY_PORT_KEY), PROXY_PORT_KEY, fileContent);
			writeValue(proxyUser, cm.getValue(PROXY_USER_KEY), PROXY_USER_KEY, fileContent);
			writeValue(proxyPassword, cm.getValue(PROXY_PASSWORD_KEY), PROXY_PASSWORD_KEY, fileContent);

			writeValue(keyStoreFile, cm.getValue(KEY_STORE_FILE_KEY), KEY_STORE_FILE_KEY, fileContent);
			writeValue(keyStorePassword, cm.getValue(KEY_STORE_PASSWORD_KEY), KEY_STORE_PASSWORD_KEY, fileContent);

			FileUtil.createBackup(fullConfigPath);
			FileUtil.write(fullConfigPath, fileContent.toString());

		} catch (IOException ex) {

			throw new ConfigException(ex);
		}
	}

	/**
	 * Updates contents of settings file, modifying value mapped to key providing
	 * this new value is different from existing value.
	 *
	 * @param newValue New configuration value.
	 * @param current  Current configuration value.
	 * @param key      Mapping key for this value.
	 * @param settings Full content of the settings file as a string.
	 */
	protected final void writeValue(final String newValue, final String current, final String key,
	        final StringBuilder settings) {

		var content = settings.toString();

		if ((newValue != null && current != null && !newValue.equals(current)) || (newValue == null && current != null)
		        || (newValue != null && current == null)) {

			var pos = content.indexOf(key);
			int pos4;
			int pos2;
			var hasChanged = false;

			while (pos != -1 && !hasChanged) {

				var pos3 = pos;
				pos4 = pos + 1;

				/* Position of the character previous to key. */
				while (content.charAt(pos3) != '\n' && pos3 != 0) {

					pos3--;
				}

				if (pos3 != 0) {
					pos3++;
				}

				/* Position of symbol '=' for current key. */
				pos = content.indexOf('=', pos);

				/* Last position for the line of current key. */
				pos2 = content.indexOf('\n', pos);

				/* Case 1: Content is an uncommented key. */
				if (content.charAt(pos3) != '#') {

					if (newValue != null) {

						content = content.substring(0, pos + 1) + newValue + content.substring(pos2);

					} else {

						content = content.substring(0, pos3) + "#" + key + content.substring(pos2); //$NON-NLS-1$
					}

					hasChanged = true;

				} else /* Case 2: Content is a commented key. */
				if (content.charAt(pos3) == '#' && content.charAt(pos3 + 1) != '#') {

					if (newValue != null) {

						content = content.substring(0, pos3) + key + "=" + newValue //$NON-NLS-1$
						        + content.substring(pos2);
					}

					hasChanged = true;
				}

				pos = content.indexOf(key, pos4);
			}

			/* If file does not contain the key is added at the end of the file */
			if (!hasChanged) {

				content = content + "\n" + key + "=" + newValue + "\n"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
			}
		}

		settings.setLength(0);
		settings.append(content);
	}

	/**
	 * Returns host name for the proxy server.
	 *
	 * @return host name for the proxy server
	 */
	public final String getProxyHost() {

		return proxyHost;
	}

	/**
	 * Sets host name for the proxy server.
	 *
	 * @param host Host name
	 */
	public final void setProxyHost(final String host) {

		proxyHost = host;
	}

	/**
	 * Returns listen port for proxy server. If port is not set or incorrect (not a
	 * number) returns -1.
	 *
	 * @return Listening port for proxy server. -1 if is not set or in a non-numeric
	 *         value.
	 */
	public final int getProxyPort() {

		int port;
		try {

			port = Integer.parseInt(proxyPort);

		} catch (NumberFormatException ex) {

			port = -1;
		}

		return port;
	}

	/**
	 * Sets value for proxy listen port.
	 *
	 * @param port Proxy port number.
	 * @see #setProxyPort(int)
	 */
	public final void setProxyPort(final String port) {

		proxyPort = port;
	}

	/**
	 * Sets value for proxy listen port.
	 *
	 * @param port Proxy port number.
	 * @see #setProxyPort(String)
	 */
	public final void setProxyPort(final int port) {

		if (port != -1) {

			proxyPort = String.valueOf(port);

		} else {

			proxyPort = null;
		}
	}

	/**
	 * Returns user name for proxy server.
	 *
	 * @return User name for proxy server.
	 */
	public final String getProxyUser() {

		return proxyUser;
	}

	/**
	 * Sets user name for proxy server.
	 *
	 * @param user user name for proxy server.
	 */
	public final void setProxyUser(final String user) {

		proxyUser = user;
	}

	/**
	 * Returns password for proxy server.
	 *
	 * @return Password for proxy server.
	 */
	public final String getProxyPassword() {

		return proxyPassword;
	}

	/**
	 * Sets password for proxy server.
	 *
	 * @param passwd Password for proxy server.
	 */
	public final void setProxyPassword(final String passwd) {

		proxyPassword = passwd;
	}

	/**
	 * Returns password for key store.
	 *
	 * @return Key store password.
	 */
	public final String getKeyStorePassword() {

		return keyStorePassword;
	}

	/**
	 * Sets password for key store.
	 *
	 * @param passwd Password for key store.
	 */
	public final void setKeyStorePassword(final String passwd) {

		keyStorePassword = passwd;
	}

	/**
	 * Absolute path to keystore file. null null if is not correctly
	 * set.
	 *
	 * @return Absolute path to keystore file.
	 */
	public final String getKeyStoreFile() {

		return keyStoreFile;
	}

	/**
	 * Sets Absolute path to keystore file.
	 *
	 * @param keyFile Absolute path to keystore file.
	 */
	public final void setKeyStoreFile(final String keyFile) {

		keyStoreFile = keyFile;
	}

	/**
	 * Returns web service URL.
	 *
	 * @return Web service URL. null If is not correctly entered or is
	 *         not a valid URL.
	 */
	public final URL getUrlEndPoint() {

		URL urlEndPoint;

		try {

			urlEndPoint = new URL(url);

		} catch (MalformedURLException e) {

			urlEndPoint = null;
		}

		return urlEndPoint;
	}

	/**
	 * Sets URL to which System will connect.
	 *
	 * @param aUrl to which System will connect.
	 */
	public final void setUrl(final String aUrl) {

		url = aUrl;
	}

	/**
	 * Ensure a minimum set of parameters is set before allow start.
	 *
	 * @return true if a minimum set of parameters is set to run GUI applications.
	 */
	public final boolean hasMinimumConfiguration() {

		return isNotNullAndNotEmpty(url) && isNotNullAndNotEmpty(keyStoreFile)
		        && isNotNullAndNotEmpty(keyStorePassword);
	}

	/**
	 * Returns true if the provided value is not null and not empty.
	 *
	 * @param value Value to be checked.
	 * @return true if the provided value is not null and not empty.
	 */
	protected boolean isNotNullAndNotEmpty(final String value) {
		return value != null && !value.trim().isEmpty();
	}

}