es.ree.eemws.kit.gui.applications.configuration.ProxyPanel 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.gui.applications.configuration;

import java.awt.Color;
import java.awt.Rectangle;

import javax.swing.ButtonGroup;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JPasswordField;
import javax.swing.JRadioButton;
import javax.swing.JTextField;
import javax.swing.SwingConstants;
import javax.swing.border.EtchedBorder;
import javax.swing.border.TitledBorder;

import es.ree.eemws.core.utils.config.ConfigException;
import es.ree.eemws.kit.common.Messages;
import es.ree.eemws.kit.config.Configuration;

/**
 * Configuration's proxy settings.
 *
 * @author Redeia.
 * @version 2.1 01/01/2024
 */
public final class ProxyPanel extends JPanel {

	/** Class ID. */
	private static final long serialVersionUID = -7977245963580041940L;

	/** Default proxy port value. */
	private static final String DEFAULT_PROXY_PORT = "8080"; //$NON-NLS-1$

	/** Label for {@link #proxyUser}. */
	private JLabel proxyUserLbl;

	/** Proxy user name. */
	private JTextField proxyUser;

	/** Label for {@link #proxyPassword1}. */
	private JLabel proxyPasswordLbl;

	/** Password for the proxy user. */
	private JPasswordField proxyPassword1;

	/** Confirm password for the proxy user. */
	private JPasswordField proxyPassword2;

	/** Label for {@link #proxyHost}. */
	private JLabel proxyHostLbl;

	/** Hostname for the proxy server. */
	private JTextField proxyHost;

	/** Listening port for the proxy server. */
	private JTextField proxyPort;

	/** Label for {@link #proxyPort}. */
	private JLabel proxyPortLbl;

	/** Button to indicate the connection will NOT be done through a proxy. */
	private JRadioButton proxyDontUseProxyChoice;

	/** Button to indicate the connection will be done through a proxy. */
	private JRadioButton proxyUseProxyChoice;

	/** Label for {@link #proxyPassword2}. */
	private JLabel proxyPasswdConfirmLbl;

	/**
	 * Constructor. Creates a panel to configure proxy settings.
	 */
	public ProxyPanel() {

		proxyPassword1 = new JPasswordField();
		proxyPassword1.setEnabled(false);
		proxyPassword1.setText(""); //$NON-NLS-1$
		proxyPassword1.setBounds(new Rectangle(114, 79, 158, 19));

		proxyHost = new JTextField();
		proxyHost.setEnabled(false);
		proxyHost.setText(""); //$NON-NLS-1$
		proxyHost.setBounds(new Rectangle(115, 24, 156, 19));

		proxyHostLbl = new JLabel();
		proxyHostLbl.setEnabled(false);
		proxyHostLbl.setText(MessageCatalog.SETTINGS_PROXY_HOST.getMessage());
		proxyHostLbl.setDisplayedMnemonic(MessageCatalog.SETTINGS_PROXY_HOST_HK.getChar());
		proxyHostLbl.setHorizontalAlignment(SwingConstants.RIGHT);
		proxyHostLbl.setLabelFor(proxyHost);
		proxyHostLbl.setBounds(new Rectangle(10, 27, 101, 16));

		proxyPort = new JTextField();
		proxyPort.setEnabled(false);
		proxyPort.setText(""); //$NON-NLS-1$
		proxyPort.setBounds(new Rectangle(332, 25, 43, 19));

		proxyPortLbl = new JLabel();
		proxyPortLbl.setEnabled(false);
		proxyPortLbl.setText(MessageCatalog.SETTINGS_PROXY_PORT.getMessage());
		proxyPortLbl.setDisplayedMnemonic(MessageCatalog.SETTINGS_PROXY_PORT.getChar());
		proxyPortLbl.setLabelFor(proxyPort);
		proxyPortLbl.setBounds(new Rectangle(284, 25, 50, 22));

		proxyPasswdConfirmLbl = new JLabel();
		proxyPasswdConfirmLbl.setEnabled(false);
		proxyPasswdConfirmLbl.setText(MessageCatalog.SETTINGS_PROXY_PASSWORD2.getMessage());
		proxyPasswdConfirmLbl.setDisplayedMnemonic(MessageCatalog.SETTINGS_PROXY_PASSWORD2.getChar());
		proxyPasswdConfirmLbl.setHorizontalAlignment(SwingConstants.RIGHT);
		proxyPasswdConfirmLbl.setLabelFor(proxyPassword2);
		proxyPasswdConfirmLbl.setBounds(new Rectangle(10, 106, 101, 16));

		proxyPassword2 = new JPasswordField();
		proxyPassword2.setEnabled(false);
		proxyPassword2.setText(""); //$NON-NLS-1$
		proxyPassword2.setBounds(new Rectangle(115, 107, 158, 19));

		proxyUser = new JTextField();
		proxyUser.setEnabled(false);
		proxyUser.setText(""); //$NON-NLS-1$
		proxyUser.setBounds(new Rectangle(115, 52, 156, 19));

		proxyUserLbl = new JLabel();
		proxyUserLbl.setEnabled(false);
		proxyUserLbl.setText(MessageCatalog.SETTINGS_PROXY_USER.getMessage());
		proxyUserLbl.setDisplayedMnemonic(MessageCatalog.SETTINGS_PROXY_USER.getChar());
		proxyUserLbl.setHorizontalAlignment(SwingConstants.RIGHT);
		proxyUserLbl.setLabelFor(proxyUser);
		proxyUserLbl.setBounds(new Rectangle(10, 53, 101, 16));

		proxyPasswordLbl = new JLabel();
		proxyPasswordLbl.setEnabled(false);
		proxyPasswordLbl.setText(MessageCatalog.SETTINGS_PROXY_PASSWORD.getMessage());
		proxyPasswordLbl.setDisplayedMnemonic(MessageCatalog.SETTINGS_PROXY_PASSWORD_HK.getChar());
		proxyPasswordLbl.setHorizontalAlignment(SwingConstants.RIGHT);
		proxyPasswordLbl.setLabelFor(proxyPassword1);
		proxyPasswordLbl.setBounds(new Rectangle(10, 80, 101, 16));

		var proxyPanel = new JPanel();
		TitledBorder bordeProxy;
		bordeProxy = new TitledBorder(new EtchedBorder(EtchedBorder.RAISED, Color.white, new Color(142, 142, 142)),
		        " " + MessageCatalog.SETTINGS_PROXY_PARAMETERS.getMessage() + " "); //$NON-NLS-1$ //$NON-NLS-2$
		proxyPanel.setBorder(bordeProxy);
		proxyPanel.setBounds(new Rectangle(47, 89, 396, 139));
		proxyPanel.setLayout(null);
		proxyPanel.add(proxyPassword1, null);
		proxyPanel.add(proxyPassword2, null);
		proxyPanel.add(proxyPort, null);
		proxyPanel.add(proxyPortLbl, null);
		proxyPanel.add(proxyUser, null);
		proxyPanel.add(proxyHost, null);
		proxyPanel.add(proxyPasswdConfirmLbl, null);
		proxyPanel.add(proxyHostLbl, null);
		proxyPanel.add(proxyUserLbl, null);
		proxyPanel.add(proxyPasswordLbl, null);

		proxyDontUseProxyChoice = new JRadioButton();
		proxyDontUseProxyChoice.setEnabled(true);
		proxyDontUseProxyChoice.setText(MessageCatalog.SETTINGS_PROXY_DIRECT_CONNECTION.getMessage());
		proxyDontUseProxyChoice.setMnemonic(MessageCatalog.SETTINGS_PROXY_DIRECT_CONNECTION_HK.getChar());
		proxyDontUseProxyChoice.setSelected(true);
		proxyDontUseProxyChoice.setBounds(new Rectangle(43, 34, 215, 24));
		proxyDontUseProxyChoice.addActionListener(e -> enableProxyElements(false));

		proxyUseProxyChoice = new JRadioButton();
		proxyUseProxyChoice.setText(MessageCatalog.SETTINGS_PROXY_USE_PROXY.getMessage());
		proxyUseProxyChoice.setMnemonic(MessageCatalog.SETTINGS_PROXY_USE_PROXY_HK.getChar());
		proxyUseProxyChoice.setBounds(new Rectangle(43, 59, 213, 24));
		proxyUseProxyChoice.addActionListener(e -> enableProxyElements(true));

		var grupoProxy = new ButtonGroup();
		grupoProxy.add(proxyDontUseProxyChoice);
		grupoProxy.add(proxyUseProxyChoice);

		var proLbl = new JLabel();
		proLbl.setRequestFocusEnabled(true);
		proLbl.setText(MessageCatalog.SETTINGS_PROXY_SETTINGS.getMessage());
		proLbl.setBounds(new Rectangle(43, 11, 420, 24));

		setAlignmentX((float) 0.5);
		setLayout(null);
		add(proLbl, null);
		add(proxyDontUseProxyChoice, null);
		add(proxyUseProxyChoice, null);
		add(proxyPanel, null);
	}

	/**
	 * Loads proxy settings into form.
	 *
	 * @param cm Configuration object from which values are read.
	 */
	public void loadValues(final Configuration cm) {

		var value = cm.getProxyHost();
		if (value != null) {
			enableProxyElements(true);
			proxyUseProxyChoice.setSelected(true);
			proxyHost.setText(cm.getProxyHost());
			proxyUser.setText(cm.getProxyUser());
			proxyPort.setText(String.valueOf(cm.getProxyPort()));
			proxyPassword1.setText(cm.getProxyPassword());
			proxyPassword2.setText(cm.getProxyPassword());
		} else {
			proxyDontUseProxyChoice.setSelected(true);
			enableProxyElements(false);
		}
	}

	/**
	 * Disables proxy form fields when direct Internet connection is enabled.
	 *
	 * @param useProxy true user selects use proxy. false
	 *                 otherwise.
	 */
	private void enableProxyElements(final boolean useProxy) {

		proxyHostLbl.setEnabled(useProxy);
		proxyUserLbl.setEnabled(useProxy);
		proxyPasswordLbl.setEnabled(useProxy);
		proxyPortLbl.setEnabled(useProxy);
		proxyHost.setEnabled(useProxy);
		proxyUser.setEnabled(useProxy);
		proxyPassword1.setEnabled(useProxy);
		proxyPassword2.setEnabled(useProxy);
		proxyPort.setEnabled(useProxy);
		proxyHost.setEditable(useProxy);
		proxyUser.setEditable(useProxy);
		proxyPassword1.setEditable(useProxy);
		proxyPassword2.setEditable(useProxy);
		proxyPort.setEditable(useProxy);
		proxyPasswdConfirmLbl.setEnabled(useProxy);
	}

	/**
	 * Sets proxy settings.
	 *
	 * @param config Object containing proxy settings.
	 */
	public void setValues(final Configuration config) {

		if (proxyUseProxyChoice.isSelected()) {

			config.setProxyHost(proxyHost.getText());
			config.setProxyPort(proxyPort.getText());
			config.setProxyPassword(new String(proxyPassword1.getPassword()));
			config.setProxyUser(proxyUser.getText());

		} else {

			config.setProxyHost(null);
			config.setProxyPort(null);
			config.setProxyPassword(null);
			config.setProxyUser(null);
		}
	}

	/**
	 * Validates proxy settings.
	 *
	 * @throws ConfigException If any incorrect value is found.
	 */
	public void validateConfig() throws ConfigException {

		if (proxyUseProxyChoice.isSelected()) {

			var value = proxyHost.getText().trim();
			if (value.length() == 0) {
				throw new ConfigException(getPanelName() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PANEL_SAYS.getMessage() + " " //$NON-NLS-1$
				        + Messages.getString("SETTINGS_PROXY_NO_HOST")); //$NON-NLS-1$
			}

			proxyHost.setText(value);

			value = proxyPort.getText().trim();
			if (value.length() == 0) {
				value = DEFAULT_PROXY_PORT;
			}

			try {
				var val = Integer.parseInt(value);
				if (val < 0 || val > 65535) {
					throw new ConfigException(getPanelName() + " " //$NON-NLS-1$
					        + MessageCatalog.SETTINGS_PANEL_SAYS.getMessage() + " " //$NON-NLS-1$
					        + MessageCatalog.SETTINGS_PROXY_INVALID_PORT.getMessage());
				}

			} catch (NumberFormatException ex) {
				throw new ConfigException(getPanelName() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PANEL_SAYS.getMessage() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PROXY_INVALID_PORT_NO_NUMERIC.getMessage());
			}

			proxyPort.setText(value);

			var pass1 = new String(proxyPassword1.getPassword());
			var pass2 = new String(proxyPassword2.getPassword());

			if (!pass1.equals(pass2)) {
				throw new ConfigException(getPanelName() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PANEL_SAYS.getMessage() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PROXY_PASSWORD_MATCH.getMessage());
			}
			var prUser = proxyUser.getText().trim();
			if (prUser.length() == 0 && pass1.length() != 0) {
				throw new ConfigException(getPanelName() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PANEL_SAYS.getMessage() + " " //$NON-NLS-1$
				        + MessageCatalog.SETTINGS_PROXY_NO_USER.getMessage());
			}
		}
	}

	/**
	 * Returns Panel name.
	 *
	 * @return Panel name.
	 */
	public String getPanelName() {

		return MessageCatalog.SETTINGS_PROXY_TAB.getMessage();

	}
}