Target Explorer: Bugzilla 366374 - [TERMINALS][TELNET] Add Telnet terminal support

6 files changed, 540 insertions, 0 deletions

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/activator/UIPlugin.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/activator/UIPlugin.java
new file mode 100644
index 000000000..e062d0bf1
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/activator/UIPlugin.java
@@ -0,0 +1,112 @@
+/*******************************************************************************

+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.

+ * This program and the accompanying materials are made available under the terms

+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is

+ * available at http://www.eclipse.org/legal/epl-v10.html

+ *

+ * Contributors:

+ * Wind River Systems - initial API and implementation

+ * Max Weninger (Wind River) - [366374] [TERMINALS][TELNET] Add Telnet terminal support

+ *******************************************************************************/

+package org.eclipse.tcf.te.ui.terminals.telnet.activator;

+

+import org.eclipse.jface.resource.ImageDescriptor;

+import org.eclipse.jface.resource.ImageRegistry;

+import org.eclipse.swt.graphics.Image;

+import org.eclipse.tcf.te.runtime.tracing.TraceHandler;

+import org.eclipse.ui.plugin.AbstractUIPlugin;

+import org.osgi.framework.BundleContext;

+

+/**

+ * The activator class controls the plug-in life cycle

+ */

+public class UIPlugin extends AbstractUIPlugin {

+	// The shared instance

+	private static UIPlugin plugin;

+	// The trace handler instance

+	private static TraceHandler traceHandler;

+

+	/**

+	 * The constructor

+	 */

+	public UIPlugin() {

+	}

+

+	/**

+	 * Returns the shared instance

+	 *

+	 * @return the shared instance

+	 */

+	public static UIPlugin getDefault() {

+		return plugin;

+	}

+

+	/**

+	 * Convenience method which returns the unique identifier of this plugin.

+	 */

+	public static String getUniqueIdentifier() {

+		if (getDefault() != null && getDefault().getBundle() != null) {

+			return getDefault().getBundle().getSymbolicName();

+		}

+		return null;

+	}

+

+	/**

+	 * Returns the bundles trace handler.

+	 *

+	 * @return The bundles trace handler.

+	 */

+	public static TraceHandler getTraceHandler() {

+		if (traceHandler == null) {

+			traceHandler = new TraceHandler(getUniqueIdentifier());

+		}

+		return traceHandler;

+	}

+

+	/* (non-Javadoc)

+	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)

+	 */

+	@Override

+    public void start(BundleContext context) throws Exception {

+		super.start(context);

+		plugin = this;

+	}

+

+	/* (non-Javadoc)

+	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)

+	 */

+	@Override

+    public void stop(BundleContext context) throws Exception {

+		plugin = null;

+		super.stop(context);

+	}

+

+	/* (non-Javadoc)

+	 * @see org.eclipse.ui.plugin.AbstractUIPlugin#initializeImageRegistry(org.eclipse.jface.resource.ImageRegistry)

+	 */

+	@Override

+	protected void initializeImageRegistry(ImageRegistry registry) {

+	}

+

+	/**

+	 * Loads the image registered under the specified key from the image

+	 * registry and returns the <code>Image</code> object instance.

+	 *

+	 * @param key The key the image is registered with.

+	 * @return The <code>Image</code> object instance or <code>null</code>.

+	 */

+	public static Image getImage(String key) {

+		return getDefault().getImageRegistry().get(key);

+	}

+

+	/**

+	 * Loads the image registered under the specified key from the image

+	 * registry and returns the <code>ImageDescriptor</code> object instance.

+	 *

+	 * @param key The key the image is registered with.

+	 * @return The <code>ImageDescriptor</code> object instance or <code>null</code>.

+	 */

+	public static ImageDescriptor getImageDescriptor(String key) {

+		return getDefault().getImageRegistry().getDescriptor(key);

+	}

+}

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/controls/TelnetWizardConfigurationPanel.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/controls/TelnetWizardConfigurationPanel.java
new file mode 100644
index 000000000..96ef14d9d
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/controls/TelnetWizardConfigurationPanel.java
@@ -0,0 +1,198 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ * Max Weninger (Wind River) - [366374] [TERMINALS][TELNET] Add Telnet terminal support
+ *******************************************************************************/
+package org.eclipse.tcf.te.ui.terminals.telnet.controls;
+
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.eclipse.jface.dialogs.IDialogSettings;
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.events.TypedEvent;
+import org.eclipse.swt.layout.GridData;
+import org.eclipse.swt.layout.GridLayout;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.tcf.protocol.IPeer;
+import org.eclipse.tcf.protocol.Protocol;
+import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
+import org.eclipse.tcf.te.runtime.services.interfaces.constants.ITerminalsConnectorConstants;
+import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModel;
+import org.eclipse.tcf.te.ui.controls.BaseDialogPageControl;
+import org.eclipse.tcf.te.ui.terminals.panels.AbstractConfigurationPanel;
+import org.eclipse.tcf.te.ui.wizards.interfaces.ISharedDataWizardPage;
+import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
+import org.eclipse.tm.internal.terminal.telnet.NetworkPortMap;
+import org.eclipse.tm.internal.terminal.telnet.TelnetConnector;
+import org.eclipse.tm.internal.terminal.telnet.TelnetSettings;
+import org.eclipse.ui.forms.widgets.FormToolkit;
+
+/**
+ * telnet wizard configuration panel implementation.
+ */
+@SuppressWarnings("restriction")
+public class TelnetWizardConfigurationPanel extends AbstractConfigurationPanel implements ISharedDataWizardPage {
+
+    private TelnetSettings telnetSettings;
+	private ISettingsPage telnetSettingsPage;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param parentControl The parent control. Must not be <code>null</code>!
+	 */
+	public TelnetWizardConfigurationPanel(BaseDialogPageControl parentControl) {
+	    super(parentControl);
+    }
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.controls.interfaces.IWizardConfigurationPanel#setupPanel(org.eclipse.swt.widgets.Composite, org.eclipse.ui.forms.widgets.FormToolkit)
+	 */
+	@Override
+	public void setupPanel(Composite parent, FormToolkit toolkit) {
+		Composite panel = new Composite(parent, SWT.NONE);
+		panel.setLayout(new GridLayout());
+		GridData data = new GridData(SWT.FILL, SWT.FILL, true, true);
+		panel.setLayoutData(data);
+
+		TelnetConnector conn = new TelnetConnector();
+		telnetSettings = (TelnetSettings) conn.getTelnetSettings();
+		telnetSettings.setHost(getHost());
+		// MWE otherwise we don't get a valid default selection of the combo
+		telnetSettings.setNetworkPort(NetworkPortMap.PROP_VALUETELNET);
+		telnetSettingsPage = conn.makeSettingsPage();
+		telnetSettingsPage.createControl(panel);
+
+		setControl(panel);
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.controls.interfaces.IWizardConfigurationPanel#dataChanged(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.swt.events.TypedEvent)
+	 */
+	@Override
+	public boolean dataChanged(IPropertiesContainer data, TypedEvent e) {
+		return false;
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.wizards.interfaces.ISharedDataWizardPage#setupData(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer)
+	 */
+	@Override
+    public void setupData(IPropertiesContainer data) {
+    }
+
+	/**
+	 * Returns the host name or IP from the current selection.
+	 *
+	 * @return The host name or IP.
+	 */
+	private String getHost() {
+		ISelection selection = getSelection();
+		final AtomicReference<String> result = new AtomicReference<String>();
+		if (selection instanceof IStructuredSelection && !selection.isEmpty()) {
+			Object element = ((IStructuredSelection) selection).getFirstElement();
+			if (element instanceof IPeerModel) {
+				final IPeerModel peerModel = (IPeerModel) element;
+				if (Protocol.isDispatchThread()) {
+					result.set(peerModel.getPeer().getAttributes().get(IPeer.ATTR_IP_HOST));
+				}
+				else {
+					Protocol.invokeAndWait(new Runnable() {
+						@Override
+						public void run() {
+							result.set(peerModel.getPeer().getAttributes().get(IPeer.ATTR_IP_HOST));
+						}
+					});
+				}
+			}
+		}
+
+		return result.get();
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.wizards.interfaces.ISharedDataWizardPage#extractData(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer)
+	 */
+	@Override
+    public void extractData(IPropertiesContainer data) {
+    	// set the terminal connector id for ssh
+    	data.setProperty(ITerminalsConnectorConstants.PROP_TERMINAL_CONNECTOR_ID, "org.eclipse.tm.internal.terminal.telnet.TelnetConnector"); //$NON-NLS-1$
+
+    	// set the connector type for ssh
+    	data.setProperty(ITerminalsConnectorConstants.PROP_CONNECTOR_TYPE_ID, "org.eclipse.tcf.te.ui.terminals.type.telnet"); //$NON-NLS-1$
+
+    	telnetSettingsPage.saveSettings();
+		data.setProperty(ITerminalsConnectorConstants.PROP_IP_HOST,telnetSettings.getHost());
+		data.setProperty(ITerminalsConnectorConstants.PROP_IP_PORT, telnetSettings.getNetworkPort());
+		data.setProperty(ITerminalsConnectorConstants.PROP_TIMEOUT, telnetSettings.getTimeout());
+    }
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.wizards.interfaces.ISharedDataWizardPage#initializeData(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer)
+	 */
+	@Override
+    public void initializeData(IPropertiesContainer data) {
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.wizards.interfaces.ISharedDataWizardPage#removeData(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer)
+	 */
+	@Override
+    public void removeData(IPropertiesContainer data) {
+    }
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.controls.interfaces.IWizardConfigurationPanel#doRestoreWidgetValues(org.eclipse.jface.dialogs.IDialogSettings, java.lang.String)
+	 */
+	@Override
+	public void doRestoreWidgetValues(IDialogSettings settings, String idPrefix) {
+		String host = getHost();
+		if (settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_HOST)) != null) {
+			telnetSettings.setHost(settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_HOST)));
+		}
+		if (settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_PORT)) != null) {
+			telnetSettings.setNetworkPort(settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_PORT)));
+		}
+		if (settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_TIMEOUT)) != null) {
+			telnetSettings.setTimeout(settings.get(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_TIMEOUT)));
+		}
+		// set settings in page
+		telnetSettingsPage.loadSettings();
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.controls.interfaces.IWizardConfigurationPanel#doSaveWidgetValues(org.eclipse.jface.dialogs.IDialogSettings, java.lang.String)
+	 */
+	@Override
+	public void doSaveWidgetValues(IDialogSettings settings, String idPrefix) {
+		// make sure the values are saved
+		// actually not needed since this is done before in extractData
+		telnetSettingsPage.saveSettings();
+		String host = getHost();
+		settings.put(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_HOST), telnetSettings.getHost());
+		settings.put(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_IP_PORT), telnetSettings.getNetworkPort());
+		settings.put(getSettingsKeyWithPrefix(host, ITerminalsConnectorConstants.PROP_TIMEOUT), telnetSettings.getTimeout());
+	}
+
+	/**
+	 * Constructs the full settings key.
+	 */
+	private String getSettingsKeyWithPrefix(String host, String value) {
+		return host + "." + value; //$NON-NLS-1$
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.controls.panels.AbstractWizardConfigurationPanel#isValid()
+	 */
+	@Override
+    public boolean isValid(){
+		return telnetSettingsPage.validateSettings();
+	}
+}
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/launcher/TelnetLauncherDelegate.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/launcher/TelnetLauncherDelegate.java
new file mode 100644
index 000000000..a3373f3e5
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/launcher/TelnetLauncherDelegate.java
@@ -0,0 +1,85 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ * Max Weninger (Wind River) - [366374] [TERMINALS][TELNET] Add Telnet terminal support
+ *******************************************************************************/
+package org.eclipse.tcf.te.ui.terminals.telnet.launcher;
+
+import java.text.DateFormat;
+import java.util.Date;
+
+import org.eclipse.osgi.util.NLS;
+import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
+import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
+import org.eclipse.tcf.te.runtime.services.ServiceManager;
+import org.eclipse.tcf.te.runtime.services.interfaces.ITerminalService;
+import org.eclipse.tcf.te.runtime.services.interfaces.constants.ITerminalsConnectorConstants;
+import org.eclipse.tcf.te.ui.controls.BaseDialogPageControl;
+import org.eclipse.tcf.te.ui.terminals.interfaces.IConfigurationPanel;
+import org.eclipse.tcf.te.ui.terminals.launcher.AbstractLauncherDelegate;
+import org.eclipse.tcf.te.ui.terminals.telnet.controls.TelnetWizardConfigurationPanel;
+import org.eclipse.tcf.te.ui.terminals.telnet.nls.Messages;
+
+/**
+ * SSH launcher delegate implementation.
+ */
+public class TelnetLauncherDelegate extends AbstractLauncherDelegate {
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.terminals.interfaces.ILauncherDelegate#needsUserConfiguration()
+	 */
+	@Override
+	public boolean needsUserConfiguration() {
+		return true;
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.terminals.interfaces.ILauncherDelegate#getPanel(org.eclipse.tcf.te.ui.controls.BaseDialogPageControl)
+	 */
+	@Override
+	public IConfigurationPanel getPanel(BaseDialogPageControl parentControl) {
+		return new TelnetWizardConfigurationPanel(parentControl);
+	}
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.tcf.te.ui.terminals.interfaces.ILauncherDelegate#execute(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.tcf.te.runtime.interfaces.callback.ICallback)
+	 */
+	@Override
+	public void execute(IPropertiesContainer properties, ICallback callback) {
+		// Set the terminal tab title
+		String terminalTitle = getTerminalTitle(properties);
+		if (terminalTitle != null) {
+			properties.setProperty(ITerminalsConnectorConstants.PROP_TITLE, terminalTitle);
+		}
+
+		// Get the terminal service
+		ITerminalService terminal = ServiceManager.getInstance().getService(ITerminalService.class);
+		// If not available, we cannot fulfill this request
+		if (terminal != null) {
+			terminal.openConsole(properties, callback);
+		}
+	}
+
+	/**
+	 * Returns the terminal title string.
+	 * <p>
+	 * The default implementation constructs a title like &quot;SSH @ host (Start time) &quot;.
+	 *
+	 * @return The terminal title string or <code>null</code>.
+	 */
+	private String getTerminalTitle(IPropertiesContainer properties) {
+		String host = properties.getStringProperty(ITerminalsConnectorConstants.PROP_IP_HOST);
+
+		if (host != null) {
+			DateFormat format = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG);
+			String date = format.format(new Date(System.currentTimeMillis()));
+			return NLS.bind(Messages.TelnetLauncherDelegate_terminalTitle, new String[]{host, date});
+		}
+		return Messages.TelnetLauncherDelegate_terminalTitle_default;
+	}
+}
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.java
new file mode 100644
index 000000000..b1f817b86
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ * Max Weninger (Wind River) - [366374] [TERMINALS][TELNET] Add Telnet terminal support
+ *******************************************************************************/
+package org.eclipse.tcf.te.ui.terminals.telnet.nls;
+
+import org.eclipse.osgi.util.NLS;
+
+/**
+ * Target Explorer TCF terminals extensions UI plug-in externalized strings management.
+ */
+public class Messages extends NLS {
+
+	// The plug-in resource bundle name
+	private static final String BUNDLE_NAME = "org.eclipse.tcf.te.ui.terminals.telnet.nls.Messages"; //$NON-NLS-1$
+
+	/**
+	 * Static constructor.
+	 */
+	static {
+		// Load message values from bundle file
+		NLS.initializeMessages(BUNDLE_NAME, Messages.class);
+	}
+
+	// **** Declare externalized string id's down here *****
+
+	public static String TelnetLauncherDelegate_terminalTitle;
+	public static String TelnetLauncherDelegate_terminalTitle_default;
+}
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.properties b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.properties
new file mode 100644
index 000000000..31357b701
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/nls/Messages.properties
@@ -0,0 +1,7 @@
+#
+# org.eclipse.tcf.te.ui.terminals.telnet
+# Externalized Strings.
+#
+
+TelnetLauncherDelegate_terminalTitle=Telnet {0} ({1})
+TelnetLauncherDelegate_terminalTitle_default=Telnet Terminal
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/types/TelnetConnectorType.java b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/types/TelnetConnectorType.java
new file mode 100644
index 000000000..b27d98392
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tcf.te.ui.terminals.telnet/src/org/eclipse/tcf/te/ui/terminals/telnet/types/TelnetConnectorType.java
@@ -0,0 +1,103 @@
+/*******************************************************************************

+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.

+ * This program and the accompanying materials are made available under the terms

+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is

+ * available at http://www.eclipse.org/legal/epl-v10.html

+ *

+ * Contributors:

+ * Wind River Systems - initial API and implementation

+ * Max Weninger (Wind River) - [366374] [TERMINALS][TELNET] Add Telnet terminal support

+ *******************************************************************************/

+package org.eclipse.tcf.te.ui.terminals.telnet.types;

+

+import org.eclipse.core.runtime.Assert;

+import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;

+import org.eclipse.tcf.te.runtime.services.interfaces.constants.ITerminalsConnectorConstants;

+import org.eclipse.tcf.te.ui.terminals.internal.SettingsStore;

+import org.eclipse.tcf.te.ui.terminals.types.AbstractConnectorType;

+import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;

+import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;

+import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;

+import org.eclipse.tm.internal.terminal.telnet.TelnetSettings;

+

+/**

+ * Telnet terminal connector type implementation.

+ */

+@SuppressWarnings("restriction")

+public class TelnetConnectorType extends AbstractConnectorType {

+

+	/* (non-Javadoc)

+	 * @see org.eclipse.tcf.te.ui.terminals.interfaces.IConnectorType#createTerminalConnector(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer)

+	 */

+    @Override

+	public ITerminalConnector createTerminalConnector(IPropertiesContainer properties) {

+    	Assert.isNotNull(properties);

+

+    	// Check for the terminal connector id

+    	String connectorId = properties.getStringProperty(ITerminalsConnectorConstants.PROP_TERMINAL_CONNECTOR_ID);

+

+		// Extract the telnet properties

+		String host = properties.getStringProperty(ITerminalsConnectorConstants.PROP_IP_HOST);

+		String port = properties.getStringProperty(ITerminalsConnectorConstants.PROP_IP_PORT);

+		String timeout = properties.getStringProperty(ITerminalsConnectorConstants.PROP_TIMEOUT);

+

+		int portOffset = 0;

+		if (properties.getProperty(ITerminalsConnectorConstants.PROP_IP_PORT_OFFSET) != null) {

+			portOffset = properties.getIntProperty(ITerminalsConnectorConstants.PROP_IP_PORT_OFFSET);

+			if (portOffset < 0) portOffset = 0;

+		}

+

+		return host != null && port != null ? createTelnetConnector(connectorId, new String[] { host, port, timeout }, portOffset) : null;

+	}

+

+	/**

+	 * Creates a terminal connector object based on the given telnet server attributes.

+	 * <p>

+	 * The telnet server attributes must contain at least 2 elements:

+	 * <ul>

+	 * <li>attributes[0] --> telnet server host name</li>

+	 * <li>attributes[1] --> telnet port</li>

+	 * <li>attributes[2] --> timeout (optional)</li>

+	 * </ul>

+	 *

+	 * @param connectorId The terminal connector id or <code>null</code>.

+	 * @param attributes The telnet server attributes. Must not be <code>null</code> and must have at least two elements.

+	 * @param portOffset Offset to add to the port.

+	 *

+	 * @return The terminal connector object instance or <code>null</code>.

+	 */

+	protected ITerminalConnector createTelnetConnector(String connectorId, String[] attributes, int portOffset) {

+		Assert.isNotNull(attributes);

+		Assert.isTrue(attributes.length >= 2);

+

+		if (connectorId == null) connectorId = "org.eclipse.tm.internal.terminal.telnet.TelnetConnector"; //$NON-NLS-1$

+

+		final String serverName = attributes[0];

+		final String serverPort = Integer.toString(Integer.decode(attributes[1]).intValue() + portOffset);

+		final String timeout = attributes.length >= 3 ? attributes[2] : null;

+

+		// Construct the terminal settings store

+		ISettingsStore store = new SettingsStore();

+

+		// Construct the telnet settings

+		TelnetSettings telnetSettings = new TelnetSettings();

+		telnetSettings.setHost(serverName);

+		telnetSettings.setNetworkPort(serverPort);

+		if (timeout != null) {

+			telnetSettings.setTimeout(timeout);

+		}

+		// And save the settings to the store

+		telnetSettings.save(store);

+

+		// Construct the terminal connector instance

+		ITerminalConnector connector = TerminalConnectorExtension.makeTerminalConnector(connectorId);

+		if (connector != null) {

+			// Apply default settings

+			connector.makeSettingsPage();

+			// And load the real settings

+			connector.load(store);

+		}

+

+		return connector;

+	}

+}