Attachment #94807 for bug #200541

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.





import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
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.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

import com.jcraft.jsch.ChannelShell;
import com.jcraft.jsch.JSch;

public class SshConnector extends TerminalConnectorImpl {
	private OutputStream fOutputStream;
	private InputStream fInputStream;
	private ITerminalControl fControl;

Lines 22-25 Link Here

(-)src/org/eclipse/tm/internal/terminal/control/impl/TerminalMessages.java (+1 lines)
22	public static String SocketError;	22	public static String SocketError;
23	public static String IOError;	23	public static String IOError;
24	public static String CannotConnectTo;	24	public static String CannotConnectTo;
		25	public static String NotInitialized;
25	}	26	}

Lines 17-20 Link Here

(-)src/org/eclipse/tm/internal/terminal/control/impl/TerminalMessages.properties (-1 / +2 lines)
17	TerminalError = Terminal Error	17	TerminalError = Terminal Error
18	SocketError = Socket Error	18	SocketError = Socket Error
19	IOError = IO Error	19	IOError = IO Error
20	CannotConnectTo = Cannot initialize {0}:\n{1}	20	CannotConnectTo = Cannot initialize {0}:\n{1}
		21	NotInitialized = Not Initialized

Lines 13-19 Link Here

(-)src/org/eclipse/tm/internal/terminal/control/impl/ITerminalControlForText.java (-2 / +2 lines)
13		13
14	import java.io.OutputStream;	14	import java.io.OutputStream;
15		15
16	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;	16	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
17	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;	17	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
18		18
19	/**	19	/**
Lines 27-33 Link Here
27	void setState(TerminalState state);	27	void setState(TerminalState state);
28	void setTerminalTitle(String title);	28	void setTerminalTitle(String title);
29		29
30	ITerminalConnectorInfo getTerminalConnectorInfo();	30	ITerminalConnector getTerminalConnector();
31		31
32	void disconnectTerminal();	32	void disconnectTerminal();
33		33




/*******************************************************************************
 * Copyright (c) 2006, 2007 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: 
 * Michael Scharf (Wind River) - initial API and implementation
 *******************************************************************************/
package org.eclipse.tm.internal.terminal.provisional.api;

/**
 * This class is a handle to a {@link ITerminalConnector connector} that comes from an
 * extension. It maintains a proxy to the connector to allow lazy initialization of the
 * real {@link ITerminalConnector connector} that comes from an extension.
 *
 * <p>
 * <strong>EXPERIMENTAL</strong>. This class or interface has been added as
 * part of a work in progress. There is no guarantee that this API will
 * work or that it will remain the same. Please do not use this API without
 * consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
 * </p>
 */
public interface ITerminalConnectorInfo {
	/**
	 * @return an ID of this connector. The id from the plugin.xml.
	 * <p>Note: return <code>null</code> because the framework takes 
	 * care to get the value from the plugin.xml
	 */
	String getId();

	/**
	 * @return <code>null</code> the name (as specified in the plugin.xml)
	 * <p>Note: return <code>null</code> because the framework takes 
	 * care to get the value from the plugin.xml
	 */
	String getName();

	/**
	 * @return true if the ITerminalConnector has been initialized.
	 * If there was an initialization error, {@link #getInitializationErrorMessage()}
	 * returns the error message.
	 */
	boolean isInitialized();
	
	/**
	 * This method initializes the connector if it is not initialized!
	 * If the connector was initialized successfully, <code>null</code> is
	 * returned. Otherwise an error message describing the problem is returned.
	 * @return <code>null</code> or a localized error message.
	 */
	String getInitializationErrorMessage();
	
	/**
	 * Returns a proxy to the connector that is lazily initialized.
	 * The following methods can be called without initializing
	 * the contributed class: 
	 * {@link ITerminalConnector#getSettingsSummary()}, {@link ITerminalConnector#load(ISettingsStore)},
	 * {@link ITerminalConnector#save(ISettingsStore)}, {@link ITerminalConnector#setTerminalSize(int, int)}
	 * @return a proxy of the real connector. Some calls initialize the the connection.
	 */
	ITerminalConnector getConnector();
}

Lines 56-62 Link Here

(-)src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java (-1 / +2 lines)
56	/**	56	/**
57	* @return a stream used to write to the terminal. Any bytes written to this	57	* @return a stream used to write to the terminal. Any bytes written to this
58	* stream appear in the terminal or are interpreted by the emulator as	58	* stream appear in the terminal or are interpreted by the emulator as
59	* control sequences.	59	* control sequences. The stream in the opposite direction, terminal
		60	* to remote is in {@link ITerminalConnector#getTerminalToRemoteStream()}.
60	*/	61	*/
61	OutputStream getRemoteToTerminalOutputStream();	62	OutputStream getRemoteToTerminalOutputStream();
62		63




 *******************************************************************************/
package org.eclipse.tm.internal.terminal.provisional.api;

import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.RegistryFactory;
import org.eclipse.tm.internal.terminal.connector.TerminalConnector;

/**
 * A factory to get {@link ITerminalConnector} instances.

 * </p>
 */
public class TerminalConnectorExtension {
	static private ITerminalConnector makeConnector(final IConfigurationElement config) {
		String id = config.getAttribute("id"); //$NON-NLS-1$
		if(id==null || id.length()==0)
			id=config.getAttribute("class"); //$NON-NLS-1$
		String name= config.getAttribute("name"); //$NON-NLS-1$
		if(name==null || name.length()==0) {
			name=id;
		}
		TerminalConnector.Factory factory=new TerminalConnector.Factory(){
			public TerminalConnectorImpl makeConnector() throws Exception {
				return (TerminalConnectorImpl)config.createExecutableExtension("class"); //$NON-NLS-1$
			}};
		return new TerminalConnector(factory,id,name);
		}
		public String getInitializationErrorMessage() {
			return fProxy.getLocalizedErrorMessage();
		}
		public boolean isInitialized() {
			return fProxy.isInitialized();
		}

	}

	/**
	 * @param id the id of the terminal connector in the
	 * <code>org.eclipse.tm.terminal.terminalConnector</code> extension point
	 * @return a new ITerminalConnector with id or <code>null</code> if there is no
	 * extension with that id.
	 * {@link #getSettingsSummary()},{@link #load(ISettingsStore)},
	 * {@link #setTerminalSize(int, int)}, {@link #save(ISettingsStore)}
	 *
	 */
	public static ITerminalConnector makeTerminalConnector(String id) {
		IConfigurationElement[] config=RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnector"); //$NON-NLS-1$
		for (int i = 0; i < config.length; i++) {
			if(id.equals(config[i].getAttribute("id"))) { //$NON-NLS-1$
				return makeConnector(config[i]);
		/**
		 * The plugin contribution, needed for lazy initialization
		 * of {@link #fConnector}
		 */
		private final IConfigurationElement fConfig;
		/**
		 * If the initialization of the class specified in the extension fails,
		 * this variable contains the error
		 */
		private Exception fException;
		/**
		 * The store might be set before the real connector is initialized.
		 * This keeps the value until the connector is created.
		 */
		private ISettingsStore fStore;

		TerminalConnectorProxy(IConfigurationElement config) {
			fConfig=config;
		}
		public String getLocalizedErrorMessage() {
			getConnector();
			if(fException!=null)
				return fException.getLocalizedMessage();
			return null;
		}
		public String getId() {
			String id = fConfig.getAttribute("id"); //$NON-NLS-1$
			if(id==null || id.length()==0)
				id=fConfig.getAttribute("class"); //$NON-NLS-1$
			return id;
		}
		public String getName() {
			String name= fConfig.getAttribute("name"); //$NON-NLS-1$
			if(name==null || name.length()==0) {
				name=getId();
			}
			return name;
		}
		private ITerminalConnector getConnector() {
			if(!isInitialized()) {
				try {
					fConnector=createConnector(fConfig);
					fConnector.initialize();
				} catch (Exception e) {
					fConnector=null;
					fException=e;
					// that's the place where we log the exception
					Logger.logException(e);
				}
				if(fConnector!=null && fStore!=null)
					fConnector.load(fStore);
			}
			return fConnector;
		}
		private boolean isInitialized() {
			return fConnector!=null || fException!=null;
		}
		public void connect(ITerminalControl control) {
			getConnector().connect(control);
		}
		public void disconnect() {
			getConnector().disconnect();
		}
		public OutputStream getOutputStream() {
			return getConnector().getOutputStream();
		}
		public String getSettingsSummary() {
			if(fConnector!=null)
				return getConnector().getSettingsSummary();
			else
				// TODO: see TerminalView.getSettingsSummary
				return "?"; //$NON-NLS-1$
		}
		public boolean isLocalEcho() {
			return getConnector().isLocalEcho();
		}
		public void load(ISettingsStore store) {
			if(fConnector==null) {
				fStore=store;
			} else {
				getConnector().load(store);
			}
		}
		public ISettingsPage makeSettingsPage() {
			return getConnector().makeSettingsPage();
		}
		public void save(ISettingsStore store) {
			// no need to save the settings: it cannot have changed
			// because we are not initialized....
			if(fConnector!=null)
				getConnector().save(store);
		}
		public void setTerminalSize(int newWidth, int newHeight) {
			// we assume that setTerminalSize is called also after
			// the terminal has been initialized. Else we would have to cache
			// the values....
			if(fConnector!=null) {
				fConnector.setTerminalSize(newWidth, newHeight);
			}
		}
		return null;	
			throw new IllegalStateException("Connector already initialized!"); //$NON-NLS-1$
		}
	}
	/**
	 * @return null or a new connector created from the extension
	 */
	static private ITerminalConnector createConnector(IConfigurationElement config) throws Exception {
		return (ITerminalConnector)config.createExecutableExtension("class"); //$NON-NLS-1$
	}
	/**
	 * @return a new list of {@link ITerminalConnector} instances defined in 
	 * the <code>org.eclipse.tm.terminal.terminalConnector</code> extension point
	 */
	public static ITerminalConnector[] makeTerminalConnectors() {
		IConfigurationElement[] config=RegistryFactory.getRegistry().getConfigurationElementsFor("org.eclipse.tm.terminal.terminalConnector"); //$NON-NLS-1$
		List result=new ArrayList();
		for (int i = 0; i < config.length; i++) {
			result.add(makeConnector(config[i]));
		}
		return (ITerminalConnector[]) result.toArray(new ITerminalConnector[result.size()]);
	}

}

Lines 13-23 Link Here

(-)src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnector.java (-9 / +33 lines)
13		13
14	import java.io.OutputStream;	14	import java.io.OutputStream;
15		15
		16	import org.eclipse.core.runtime.IAdaptable;
		17
16		18
17	/**	19	/**
18	* Manage a single connection. Implementations of this class are contributed	20	* Manage a single connection. Implementations of this class are contributed
19	* via <code>org.eclipse.tm.terminal.terminalConnector</code> extension point.	21	* via <code>org.eclipse.tm.terminal.terminalConnector</code> extension point.
20	*	22	* This class is a handle to a {@link ITerminalConnector connector} that comes from an
		23	* extension. It maintains {@link TerminalConnectorImpl} to the connector to allow lazy initialization of the
		24	* real {@link ITerminalConnector connector} that comes from an extension.
		25
21	* @author Michael Scharf	26	* @author Michael Scharf
22	* <p>	27	* <p>
23	* <strong>EXPERIMENTAL</strong>. This class or interface has been added as	28	* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
Lines 26-39 Link Here
26	* consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.	31	* consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
27	* </p>	32	* </p>
28	*/	33	*/
29	public interface ITerminalConnector {	34	public interface ITerminalConnector extends IAdaptable {
		35	/**
		36	* @return an ID of this connector. The id from the plugin.xml.
		37	*/
		38	String getId();
		39
		40	/**
		41	* @return <code>null</code> the name (as specified in the plugin.xml)
		42	*/
		43	String getName();
		44
		45	/**
		46	* @return true if the {@link TerminalConnectorImpl} has been initialized.
		47	* If there was an initialization error, {@link #getInitializationErrorMessage()}
		48	* returns the error message.
		49	*/
		50	boolean isInitialized();
		51
30	/**	52	/**
31	* Initializes the Connector. Some connector depend on external libraries that	53	* This method initializes the connector if it is not initialized!
32	* might not be installed.	54	* If the connector was initialized successfully, <code>null</code> is
33	* @throws Exception The exception should have a useful	55	* returned. Otherwise an error message describing the problem is returned.
34	* {@link Exception#getLocalizedMessage()} that explains the problem to the user.	56	* @return <code>null</code> or a localized error message.
35	*/	57	*/
36	void initialize() throws Exception;	58	String getInitializationErrorMessage();
37		59
38	/**	60	/**
39	* Connect using the current state of the settings.	61	* Connect using the current state of the settings.
Lines 60-68 Link Here
60	void setTerminalSize(int newWidth, int newHeight);	82	void setTerminalSize(int newWidth, int newHeight);
61		83
62	/**	84	/**
63	* @return a stream with data coming from the remote site.	85	* @return the terminal to remote stream (bytes written to this stream will
		86	* be sent to the remote site). For the stream in the other direction (remote to
		87	* terminal see {@link ITerminalControl#getRemoteToTerminalOutputStream()}
64	*/	88	*/
65	OutputStream getOutputStream();	89	OutputStream getTerminalToRemoteStream();
66		90
67	/**	91	/**
68	* Load the state of this connection. Is typically called before	92	* Load the state of this connection. Is typically called before




import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.widgets.Control;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

/**

    void disconnectTerminal();
    void disposeTerminal();
    String getSettingsSummary();
    ITerminalConnector[] getConnectors();
    void setFocus();
    ITerminalConnector getTerminalConnector();
    void setConnector(ITerminalConnector connector);
    void connectTerminal();
    /**
     * @param write a single character to terminal

Lines 13-22 Link Here

(-)src/org/eclipse/tm/internal/terminal/control/TerminalViewControlFactory.java (-2 / +2 lines)
13		13
14	import org.eclipse.swt.widgets.Composite;	14	import org.eclipse.swt.widgets.Composite;
15	import org.eclipse.tm.internal.terminal.emulator.VT100TerminalControl;	15	import org.eclipse.tm.internal.terminal.emulator.VT100TerminalControl;
16	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;	16	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
17		17
18	public class TerminalViewControlFactory {	18	public class TerminalViewControlFactory {
19	public static ITerminalViewControl makeControl(ITerminalListener target, Composite wndParent, ITerminalConnectorInfo[] connectors) {	19	public static ITerminalViewControl makeControl(ITerminalListener target, Composite wndParent, ITerminalConnector[] connectors) {
20	return new VT100TerminalControl(target, wndParent, connectors);	20	return new VT100TerminalControl(target, wndParent, connectors);
21	}	21	}
22	}	22	}

Lines 12-21 Link Here

(-)META-INF/MANIFEST.MF (-2 / +8 lines)
12	Eclipse-LazyStart: true	12	Eclipse-LazyStart: true
13	Bundle-RequiredExecutionEnvironment: J2SE-1.4	13	Bundle-RequiredExecutionEnvironment: J2SE-1.4
14	Bundle-ClassPath: .	14	Bundle-ClassPath: .
15	Export-Package: org.eclipse.tm.internal.terminal.control;x-friends:="org.eclipse.tm.terminal.view",	15	Export-Package: org.eclipse.tm.internal.terminal.connector;x-friends:="org.eclipse.tm.terminal.test",
		16	org.eclipse.tm.internal.terminal.control;x-friends:="org.eclipse.tm.terminal.view",
16	org.eclipse.tm.internal.terminal.control.impl;x-friends:="org.eclipse.tm.terminal.test",	17	org.eclipse.tm.internal.terminal.control.impl;x-friends:="org.eclipse.tm.terminal.test",
17	org.eclipse.tm.internal.terminal.emulator;x-friends:="org.eclipse.tm.terminal.test",	18	org.eclipse.tm.internal.terminal.emulator;x-friends:="org.eclipse.tm.terminal.test",
18	org.eclipse.tm.internal.terminal.model;x-friends:="org.eclipse.tm.terminal.test",	19	org.eclipse.tm.internal.terminal.model;x-friends:="org.eclipse.tm.terminal.test",
19	org.eclipse.tm.internal.terminal.provisional.api;x-friends:="org.eclipse.tm.terminal.serial,org.eclipse.tm.terminal.ssh,org.eclipse.tm.terminal.telnet,org.eclipse.tm.terminal.view,org.eclipse.tm.terminal.test",	20	org.eclipse.tm.internal.terminal.provisional.api;
		21	x-friends:="org.eclipse.tm.terminal.serial,
		22	org.eclipse.tm.terminal.ssh,
		23	org.eclipse.tm.terminal.telnet,
		24	org.eclipse.tm.terminal.view,
		25	org.eclipse.tm.terminal.test",
20	org.eclipse.tm.internal.terminal.textcanvas;x-friends:="org.eclipse.tm.terminal.test",	26	org.eclipse.tm.internal.terminal.textcanvas;x-friends:="org.eclipse.tm.terminal.test",
21	org.eclipse.tm.terminal.model	27	org.eclipse.tm.terminal.model

Lines 1046-1053 Link Here

(-)src/org/eclipse/tm/internal/terminal/emulator/VT100Emulator.java (-2 / +2 lines)
1046	}	1046	}
1047		1047
1048	private ITerminalConnector getConnector() {	1048	private ITerminalConnector getConnector() {
1049	if(terminal.getTerminalConnectorInfo()!=null)	1049	if(terminal.getTerminalConnector()!=null)
1050	return terminal.getTerminalConnectorInfo().getConnector();	1050	return terminal.getTerminalConnector();
1051	return null;	1051	return null;
1052	}	1052	}
1053		1053




import org.eclipse.tm.internal.terminal.control.impl.TerminalMessages;
import org.eclipse.tm.internal.terminal.control.impl.TerminalPlugin;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

    private final ITerminalListener         fTerminalListener;
    private String                    fMsg = ""; //$NON-NLS-1$
    private FocusListener             fFocusListener;
    private ITerminalConnector		  fConnector;
    private final ITerminalConnector[]      fConnectors;
    PipedInputStream fInputStream;

	private ICommandInputField fCommandInputField;

	 */
	volatile private Job fJob;

	public VT100TerminalControl(ITerminalListener target, Composite wndParent, ITerminalConnector[] connectors) {
		fConnectors=connectors;
		fTerminalListener=target;
		fTerminalModel=TerminalTextDataFactory.makeTerminalTextData();

		setupTerminal(wndParent);
	}

	public ITerminalConnector[] getConnectors() {
		return fConnectors;
	}


		if(getTerminalConnector()==null)
			return;
		fTerminalText.resetState();
		if(fConnector.getInitializationErrorMessage()!=null) {
			showErrorMessage(NLS.bind(
					TerminalMessages.CannotConnectTo,
					fConnector.getName(),
					fConnector.getInitializationErrorMessage()));
			// we cannot connect because the connector was not initialized
			return;
		}

		waitForConnect();
	}

	public ITerminalConnector getTerminalConnector() {
		return fConnector;
			return null;
		return fConnectorInfo.getConnector();
	}
	/* (non-Javadoc)
	 * @see org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl#disconnectTerminal()


	public OutputStream getOutputStream() {
		if(getTerminalConnector()!=null)
			return getTerminalConnector().getTerminalToRemoteStream();
		return null;
	}


	public VT100Emulator getTerminalText() {
		return fTerminalText;
	}

	/**
	 */
	public ITerminalConnectorInfo getTerminalConnectorInfo() {
		return fConnectorInfo;
	}

	protected class TerminalFocusListener implements FocusListener {
		private IContextActivation contextActivation = null;


			// locally, send a LF after sending a CR.
			// ISSUE: Is this absolutely required?

			if (character == '\r' && getTerminalConnector() != null
					&& isConnected()
					&& getTerminalConnector().isLocalEcho()) {
				sendChar('\n', false);
			}


			//
			// o The character is the DELETE character.

			if (getTerminalConnector() == null
					|| getTerminalConnector().isLocalEcho() == false || altKeyPressed
					|| (character >= '\u0001' && character < '\t')
					|| (character > '\t' && character < '\r')
					|| (character > '\r' && character <= '\u001f')

		return ""; //$NON-NLS-1$
	}

	public void setConnector(ITerminalConnector connector) {
		fConnector=connector;

	}
	public ICommandInputField getCommandInputField() {




<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.tm.terminal" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
      <appinfo>
         <meta.schema plugin="org.eclipse.tm.terminal" id="terminalConnector" name="TerminalConnector"/>
      </appinfo>
      <documentation>
         
      </documentation>

               <documentation>
                  
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>

               <documentation>
                  A class implementing ITerminalConnector
               </documentation>
               <appinfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl:"/>
               </appinfo>
            </annotation>
         </attribute>
         <attribute name="id" type="string" use="required">

               <documentation>
                  The name of the connection (used in the UI)
               </documentation>
               <appinfo>
                  <meta.attribute translatable="true"/>
               </appinfo>
            </annotation>
         </attribute>
      </complexType>





   <annotation>
      <appinfo>
         <meta.section type="copyright"/>
      </appinfo>
      <documentation>
         Copyright (c) 2006 Wind River Systems, Inc. and others.
All rights reserved. This program and the accompanying materials 




/*******************************************************************************
 * Copyright (c) 2007 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: 
 * Michael Scharf (Wind River) - initial API and implementation
 *******************************************************************************/
package org.eclipse.tm.internal.terminal.provisional.api;

import java.io.OutputStream;

public abstract class TerminalConnectorImpl {
	/**
	 * Called once after the constructor
	 * @throws Exception
	 */
	public void initialize() throws Exception {
	}
	/**
	 * Connect using the current state of the settings.
	 * @param control Used to inform the UI about state changes and messages from the connection.
	 */
	abstract public void connect(ITerminalControl control);

	/**
	 * Disconnect if connected. Else do nothing.
	 * Has to set the state of the {@link ITerminalControl}
	 */
	abstract public void disconnect();

    /**
     * @return the terminal to remote stream (bytes written to this stream will
     * be sent to the remote site). For the stream in the other direction (remote to
     * terminal see {@link ITerminalControl#getRemoteToTerminalOutputStream()}
     */
	abstract public OutputStream getOutputStream();

	/**
	 * @return A string that represents the settings of the connection. This representation
	 * may be shown in the status line of the terminal view. 
	 */
	abstract public String getSettingsSummary();
	
	/**
	 * @return true if a local echo is needed.
	 * TODO:Michael Scharf: this should be handed within the connection....
	 */
	public boolean isLocalEcho() {
		return false;
	}

	/**
	 * @return a new page that can be used in a dialog to setup this connection.
	 * The dialog should persist its settings with the {@link #load(ISettingsStore)}
	 * and {@link #save(ISettingsStore)} methods.
	 *  
	 */
	abstract public ISettingsPage makeSettingsPage();

	/**
	 * Load the state of this connection. Is typically called before 
	 * {@link #connect(ITerminalControl)}.
	 * 
	 * @param store a string based data store. Short keys like "foo" can be used to 
	 * store the state of the connection.
	 */
	abstract public void load(ISettingsStore store);
	/**
	 * When the view or dialog containing the terminal is closed, 
	 * the state of the connection is saved into the settings store <code>store</code>
	 * @param store
	 */
	abstract public void save(ISettingsStore store);

    /**
     * Notify the remote site that the size of the terminal has changed.
     * @param newWidth
     * @param newHeight
     */
	public void setTerminalSize(int newWidth, int newHeight) {
	}
}




package org.eclipse.tm.internal.terminal.connector;

import java.io.OutputStream;

import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.Platform;
import org.eclipse.tm.internal.terminal.control.impl.TerminalMessages;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
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.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

/**
 * A placeholder for the ITerminalConnector. It gets initialized when
 * the real connector is needed. 
 * The following methods can be called without initializing
 * the contributed class: {@link #getId()}, {@link #getName()},
 * {@link #getSettingsSummary()},{@link #load(ISettingsStore)},
 * {@link #setTerminalSize(int, int)}, {@link #save(ISettingsStore)},
 * {@link #getAdapter(Class)}
 *
 */
public class TerminalConnector implements ITerminalConnector {
	/**
	 * Creates an instance of TerminalConnectorImpl. This is
	 * used to lazily load classed defined in extensions.
	 */
	public interface Factory {
		/**
		 * @return an Connector
		 * @throws Exception
		 */
		TerminalConnectorImpl makeConnector() throws Exception;
	}
	/**
	 * 
	 */
	private final TerminalConnector.Factory fTerminalConnectorFactory;
	/**
	 * The (display) name of the TerminalConnector
	 */
	private final String fName;
	/**
	 * The unique id the connector
	 */
	private final String fId;
	/**
	 * The connector
	 */
	private TerminalConnectorImpl fConnector;
	/**
	 * If the initialization of the class specified in the extension fails,
	 * this variable contains the error
	 */
	private Exception fException;
	/**
	 * The store might be set before the real connector is initialized.
	 * This keeps the value until the connector is created.
	 */
	private ISettingsStore fStore;
	/**
	 * @param terminalConnectorFactory
	 * @param id
	 * @param name
	 */
	public TerminalConnector(TerminalConnector.Factory terminalConnectorFactory, String id, String name) {
		fTerminalConnectorFactory = terminalConnectorFactory;
		fId = id;
		fName = name;
	}
	public String getInitializationErrorMessage() {
		getConnectorImpl();
		if(fException!=null)
			return fException.getLocalizedMessage();
		return null;
	}
	public String getId() {
		return fId;
	}
	public String getName() {
		return fName;
	}
	private TerminalConnectorImpl getConnectorImpl() {
		if(!isInitialized()) {
			try {
				fConnector=fTerminalConnectorFactory.makeConnector();
				fConnector.initialize();
			} catch (Exception e) {
				fException=e;
				fConnector=new TerminalConnectorImpl(){
					public void connect(ITerminalControl control) {
						control.setState(TerminalState.CLOSED);
						control.setMsg(getInitializationErrorMessage());
					}
					public void disconnect() {
					}
					public OutputStream getOutputStream() {
						return null;
					}
					public String getSettingsSummary() {
						return null;
					}
					public void load(ISettingsStore store) {
					}
					public ISettingsPage makeSettingsPage() {
						return null;
					}
					public void save(ISettingsStore store) {
					}};
				// that's the place where we log the exception
				Logger.logException(e);
			}
			if(fConnector!=null && fStore!=null)
				fConnector.load(fStore);
		}
		return fConnector;
	}
	
	public boolean isInitialized() {
		return fConnector!=null || fException!=null;
	}
	public void connect(ITerminalControl control) {
		getConnectorImpl().connect(control);
	}
	public void disconnect() {
		getConnectorImpl().disconnect();
	}
	public OutputStream getTerminalToRemoteStream() {
		return getConnectorImpl().getOutputStream();
	}
	public String getSettingsSummary() {
		if(fConnector!=null)
			return getConnectorImpl().getSettingsSummary();
		else
			return TerminalMessages.NotInitialized; 
	}
	public boolean isLocalEcho() {
		return getConnectorImpl().isLocalEcho();
	}
	public void load(ISettingsStore store) {
		if(fConnector==null) {
			fStore=store;
		} else {
			getConnectorImpl().load(store);
		}
	}
	public ISettingsPage makeSettingsPage() {
		return getConnectorImpl().makeSettingsPage();
	}
	public void save(ISettingsStore store) {
		// no need to save the settings: it cannot have changed
		// because we are not initialized....
		if(fConnector!=null)
			getConnectorImpl().save(store);
	}
	public void setTerminalSize(int newWidth, int newHeight) {
		// we assume that setTerminalSize is called also after
		// the terminal has been initialized. Else we would have to cache
		// the values....
		if(fConnector!=null) {
			fConnector.setTerminalSize(newWidth, newHeight);
		}
	}
	public Object getAdapter(Class adapter) {
		TerminalConnectorImpl connector=null;
		if(isInitialized())
			connector=getConnectorImpl();
		// if we cannot create the connector then we cannot adapt...
		if(connector!=null) {
			// maybe the connector is adaptable
			if(connector instanceof IAdaptable) {
				Object result =((IAdaptable)connector).getAdapter(adapter);
				// Not sure if the next block is needed....
				if(result==null)
					//defer to the platform
					result= Platform.getAdapterManager().getAdapter(connector, adapter);
				if(result!=null)
					return result;
			}
			// maybe the real adapter is what we need....
			if(adapter.isInstance(connector))
				return connector;
		}
		// maybe we have to be adapted....
		return Platform.getAdapterManager().getAdapter(this, adapter);
	}
}





import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
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.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

public class TelnetConnector extends TerminalConnectorImpl {
	private OutputStream fOutputStream;
	private InputStream fInputStream;
	private Socket fSocket;




import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
import org.eclipse.tm.internal.terminal.control.TerminalViewControlFactory;
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.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

		//if (isConnected())
		if (fCtlTerminal.getState()!=TerminalState.CLOSED)
			return;
		if(fCtlTerminal.getTerminalConnector()==null)
			setConnector(showSettingsDialog());
		fCtlTerminal.connectTerminal();
	}

	}

	public void onTerminalSettings() {
		ITerminalConnector c=showSettingsDialog();
		if(c!=null) {
			setConnector(c);


		}
	}

	private ITerminalConnector showSettingsDialog() {
		// When the settings dialog is opened, load the Terminal settings from the
		// persistent settings.

		TerminalSettingsDlg dlgTerminalSettings = new TerminalSettingsDlg(getViewSite().getShell(),fCtlTerminal.getConnectors(),fCtlTerminal.getTerminalConnector());
		dlgTerminalSettings.setTerminalTitle(getPartName());
		Logger.log("opening Settings dialog."); //$NON-NLS-1$


		return dlgTerminalSettings.getConnector();
	}

	private void setConnector(ITerminalConnector connector) {
		fCtlTerminal.setConnector(connector);
	}


			// display in the view's content description line.  This is used by class
			// TerminalText when it processes an ANSI OSC escape sequence that commands
			// the terminal to display text in its title bar.
		} else if(fCtlTerminal.getTerminalConnector()==null){
			strTitle=ViewMessages.NO_CONNECTION_SELECTED;
		} else {
			// When parameter 'data' is null, we construct a descriptive string to

			//In order to make the logic of assembling, and the separators, better adapt to foreign languages
			if(summary.length()>0)
				summary=summary+" - ";  //$NON-NLS-1$
			String name=fCtlTerminal.getTerminalConnector().getName();
			if(name.length()>0) {
				name+=": "; //$NON-NLS-1$
			}

		// TODO: use another mechanism than "?" for the magic non initialized state
		// see TerminalConnectorProxy.getSettingsSummary
		String summary="?"; //$NON-NLS-1$
		if(fCtlTerminal.getTerminalConnector()!=null)
			summary=fCtlTerminal.getSettingsSummary();
		if("?".equals(summary)) { //$NON-NLS-1$
			summary=fStore.get(STORE_SETTING_SUMMARY, ""); //$NON-NLS-1$

	 * This method creates the top-level control for the Terminal view.
	 */
	protected void setupControls(Composite wndParent) {
		ITerminalConnector[] connectors = makeConnectors();
		fCtlTerminal = TerminalViewControlFactory.makeControl(this, wndParent, connectors);
		String connectionType=fStore.get(STORE_CONNECTION_TYPE);
		for (int i = 0; i < connectors.length; i++) {
			connectors[i].load(getStore(connectors[i]));
			if(connectors[i].getId().equals(connectionType))
				fCtlTerminal.setConnector(connectors[i]);
		}

			setPartName(title);
	}

	/**
	 * @return a list of connectors this view can use
	 */
	protected ITerminalConnector[] makeConnectors() {
		ITerminalConnector[] connectors=TerminalConnectorExtension.makeTerminalConnectors();
		return connectors;
	}

	private void saveSettings(ITerminalConnector connector) {
		ITerminalConnector[] connectors=fCtlTerminal.getConnectors();
		for (int i = 0; i < connectors.length; i++) {
			connectors[i].save(getStore(connectors[i]));
		}
		if(connector!=null) {
			fStore.put(STORE_CONNECTION_TYPE,connector.getId());

		fStore.put(STORE_TITLE,getPartName());
		fStore.saveState(memento);
	}
	private ISettingsStore getStore(ITerminalConnector connector) {
		return new SettingStorePrefixDecorator(fStore,connector.getId()+"."); //$NON-NLS-1$
	}





import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;

class TerminalSettingsDlg extends Dialog {
	private Combo fCtlConnTypeCombo;
	private Text fTerminalTitleText;
	private final ITerminalConnector[] fConnectors;
	private final ISettingsPage[] fPages;
	/**
	 * Maps the fConnectors index to the fPages index

	private IDialogSettings fDialogSettings;
	private String fTerminalTitle;

	public TerminalSettingsDlg(Shell shell, ITerminalConnector[] connectors, ITerminalConnector connector) {
		super(shell);
		fConnectors=getValidConnectors(connectors);
		fPages=new ISettingsPage[fConnectors.length];

	 * @param connectors
	 * @return connectors excluding connectors with errors
	 */
	private ITerminalConnector[] getValidConnectors(ITerminalConnector[] connectors) {
		List list=new ArrayList(Arrays.asList(connectors));
		for (Iterator iterator = list.iterator(); iterator.hasNext();) {
			ITerminalConnector info = (ITerminalConnector) iterator.next();
			if(info.isInitialized() && info.getInitializationErrorMessage()!=null)
				iterator.remove();
		}
		connectors=(ITerminalConnector[]) list.toArray(new ITerminalConnector[list.size()]);
		return connectors;
	}
	ISettingsPage getPage(int i) {
		if(fPages[i]==null) {
			if(fConnectors[i].getInitializationErrorMessage()!=null) {
				// create a error message
				final ITerminalConnector conn=fConnectors[i];
				fPages[i]=new ISettingsPage(){
					public void createControl(Composite parent) {
						Label l=new Label(parent,SWT.WRAP);

					public boolean validateSettings() {return false;}
				};
			} else {
				fPages[i]=fConnectors[i].makeSettingsPage();
			}
			// TODO: what happens if an error occurs while
			// the control is partly created?

			}
		});
	}
	public ITerminalConnector getConnector() {
		if(fSelectedConnector>=0)
			return fConnectors[fSelectedConnector];
		return null;




import org.eclipse.core.runtime.Status;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
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.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.Logger;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

public class SerialConnector extends TerminalConnectorImpl {
	private OutputStream fOutputStream;
	private InputStream fInputStream;
	private ITerminalControl fControl;

Lines 8-14 Link Here

(-)META-INF/MANIFEST.MF (-1 / +2 lines)
8	Require-Bundle: org.junit,	8	Require-Bundle: org.junit,
9	org.eclipse.tm.terminal,	9	org.eclipse.tm.terminal,
10	org.eclipse.swt,	10	org.eclipse.swt,
11	org.eclipse.jface	11	org.eclipse.jface,
		12	org.eclipse.core.runtime
12	Bundle-RequiredExecutionEnvironment: J2SE-1.4	13	Bundle-RequiredExecutionEnvironment: J2SE-1.4
13	Export-Package: org.eclipse.tm.internal.terminal.emulator;x-internal:=true,	14	Export-Package: org.eclipse.tm.internal.terminal.emulator;x-internal:=true,
14	org.eclipse.tm.internal.terminal.model;x-internal:=true,	15	org.eclipse.tm.internal.terminal.model;x-internal:=true,




/*******************************************************************************
 * Copyright (c) 2007 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: 
 * Michael Scharf (Wind River) - initial API and implementation
 *******************************************************************************/
package org.eclipse.tm.internal.terminal.connector;

import java.io.OutputStream;

import junit.framework.TestCase;

import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tm.internal.terminal.connector.TerminalConnector.Factory;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;

public class TerminalConnectorTest extends TestCase {
	public class SettingsMock implements ISettingsStore {

		public String get(String key) {
			return null;
		}

		public String get(String key, String defaultValue) {
			return null;
		}

		public void put(String key, String value) {
		}
	
	}
	public static class TerminalControlMock implements ITerminalControl {

		public void displayTextInTerminal(String text) {
		}

		public OutputStream getRemoteToTerminalOutputStream() {
			return null;
		}

		public Shell getShell() {
			return null;
		}

		public TerminalState getState() {
			return null;
		}

		public void setMsg(String msg) {
		}

		public void setState(TerminalState state) {
		}

		public void setTerminalTitle(String title) {
		}

	}
	static class ConnectorMock extends TerminalConnectorImpl {

		public boolean fEcho;
		public int fWidth;
		public int fHeight;
		public ITerminalControl fControl;
		public ISettingsStore fSaveStore;
		public ISettingsStore fLoadStore;
		public boolean fDisconnect;

		public boolean isLocalEcho() {
			return fEcho;
		}
		public void setTerminalSize(int newWidth, int newHeight) {
			fWidth=newWidth;
			fHeight=newHeight;
		}
		public void connect(ITerminalControl control) {
			fControl=control;
		}
		public void disconnect() {
			fDisconnect=true;
		}

		public OutputStream getOutputStream() {
			return null;
		}

		public String getSettingsSummary() {
			return "Summary";
		}

		public void load(ISettingsStore store) {
			fLoadStore=store;
		}

		public ISettingsPage makeSettingsPage() {
			return new ISettingsPage(){
				public void createControl(Composite parent) {
				}
				public void loadSettings() {
				}
				public void saveSettings() {
				}
				public boolean validateSettings() {
					return false;
				}};
		}

		public void save(ISettingsStore store) {
			fSaveStore=store;
		}
	}
	static class SimpleFactory implements Factory {
		final TerminalConnectorImpl fConnector;
		public SimpleFactory(TerminalConnectorImpl connector) {
			fConnector = connector;
		}
		public TerminalConnectorImpl makeConnector() throws Exception {
			// TODO Auto-generated method stub
			return fConnector;
		}		
	}
	public void testGetInitializationErrorMessage() {
		TerminalConnector c=new TerminalConnector(new SimpleFactory(new ConnectorMock()),"xID","xName");
		c.connect(new TerminalControlMock());
		assertNull(c.getInitializationErrorMessage());

		c=new TerminalConnector(new SimpleFactory(new ConnectorMock(){
			public void initialize() throws Exception {
				throw new Exception("FAILED");
			}}),"xID","xName");
		c.connect(new TerminalControlMock());
		assertEquals("FAILED",c.getInitializationErrorMessage());
		
	}

	public void testGetIdAndName() {
		TerminalConnector c=new TerminalConnector(new SimpleFactory(new ConnectorMock()),"xID","xName");
		assertEquals("xID", c.getId());
		assertEquals("xName", c.getName());
	}

	public void testIsInitialized() {
		TerminalConnector c=new TerminalConnector(new SimpleFactory(new ConnectorMock()),"xID","xName");
		assertFalse(c.isInitialized());
		c.getId();
		assertFalse(c.isInitialized());
		c.getName();
		assertFalse(c.isInitialized());
		c.getSettingsSummary();
		assertFalse(c.isInitialized());
		c.setTerminalSize(10,10);
		assertFalse(c.isInitialized());
		c.load(null);
		assertFalse(c.isInitialized());
		c.save(null);
		assertFalse(c.isInitialized());
		c.getAdapter(ConnectorMock.class);
		assertFalse(c.isInitialized());
	}

	public void testConnect() {
		TerminalConnector c=new TerminalConnector(new SimpleFactory(new ConnectorMock()),"xID","xName");
		assertFalse(c.isInitialized());
		c.connect(new TerminalControlMock());
		assertTrue(c.isInitialized());
		
	}

	public void testDisconnect() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		TerminalControlMock control=new TerminalControlMock();
		c.connect(control);
		c.disconnect();
		assertTrue(mock.fDisconnect);
	}

	public void testGetTerminalToRemoteStream() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		TerminalControlMock control=new TerminalControlMock();
		c.connect(control);
		assertSame(mock.fControl,control);
	}

	public void testGetSettingsSummary() {
		TerminalConnector c=new TerminalConnector(new SimpleFactory(new ConnectorMock()),"xID","xName");
		assertEquals("Not Initialized", c.getSettingsSummary());
		c.connect(new TerminalControlMock());
		assertEquals("Summary", c.getSettingsSummary());
	}

	public void testIsLocalEcho() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		assertFalse(c.isLocalEcho());
		mock.fEcho=true;
		assertTrue(c.isLocalEcho());
	}

	public void testLoad() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		ISettingsStore s=new SettingsMock();
		c.load(s);
		// the load is called after the connect...
		assertNull(mock.fLoadStore);
		c.connect(new TerminalControlMock());
		assertSame(s,mock.fLoadStore);
	}

	public void testSave() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		ISettingsStore s=new SettingsMock();
		c.save(s);
		assertNull(mock.fSaveStore);
		c.connect(new TerminalControlMock());
		c.save(s);
		assertSame(s,mock.fSaveStore);		
	}

	public void testMakeSettingsPage() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		assertNotNull(c.makeSettingsPage());
	}

	public void testSetTerminalSize() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		c.setTerminalSize(100, 200);
		
	}

	public void testGetAdapter() {
		ConnectorMock mock=new ConnectorMock();
		TerminalConnector c=new TerminalConnector(new SimpleFactory(mock),"xID","xName");
		assertNull(c.getAdapter(ConnectorMock.class));
		// the load is called after the connect...
		c.connect(new TerminalControlMock());

		assertSame(mock, c.getAdapter(ConnectorMock.class));
	}

}




package test;

import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;
import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;

public class Main {

	 * @param args
	 */
	public static void main(String[] args) {
		// TODO Auto-generated method stub
		new ITerminalConnectorInfo(){

			public ITerminalConnector getConnector() {
				return null;
			}

			public String getId() {
				return "com.yourdomain.ssh";
			}

			public String getInitializationErrorMessage() {
				return null;
			}
			public String getName() {
				return "SSH";
			}
			public boolean isInitialized() {
				return true;
			}};
	}

	ITerminalConnector getSsh() {
		ITerminalConnector[] c = TerminalConnectorExtension.makeTerminalConnectors();
		for (int i = 0; i < c.length; i++) {
			if("org.eclipse.tm.internal.terminal.ssh.SshConnector".equals(c[i]))
				return c[i];

Return to bug 200541

Lines 58-64 Link Here

(-)src/org/eclipse/tm/internal/terminal/emulator/VT100TerminalControl.java (-26 / +16 lines)
58	import org.eclipse.tm.internal.terminal.control.impl.TerminalMessages;	58	import org.eclipse.tm.internal.terminal.control.impl.TerminalMessages;
59	import org.eclipse.tm.internal.terminal.control.impl.TerminalPlugin;	59	import org.eclipse.tm.internal.terminal.control.impl.TerminalPlugin;
60	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;	60	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
61	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;
62	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;	61	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
63	import org.eclipse.tm.internal.terminal.provisional.api.Logger;	62	import org.eclipse.tm.internal.terminal.provisional.api.Logger;
64	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;	63	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
Lines 103-110 Link Here
103	private final ITerminalListener fTerminalListener;	102	private final ITerminalListener fTerminalListener;
104	private String fMsg = ""; //$NON-NLS-1$	103	private String fMsg = ""; //$NON-NLS-1$
105	private FocusListener fFocusListener;	104	private FocusListener fFocusListener;
106	private ITerminalConnectorInfo fConnectorInfo;	105	private ITerminalConnector fConnector;
107	private final ITerminalConnectorInfo[] fConnectors;	106	private final ITerminalConnector[] fConnectors;
108	PipedInputStream fInputStream;	107	PipedInputStream fInputStream;
109		108
110	private ICommandInputField fCommandInputField;	109	private ICommandInputField fCommandInputField;
Lines 118-124 Link Here
118	*/	117	*/
119	volatile private Job fJob;	118	volatile private Job fJob;
120		119
121	public VT100TerminalControl(ITerminalListener target, Composite wndParent, ITerminalConnectorInfo[] connectors) {	120	public VT100TerminalControl(ITerminalListener target, Composite wndParent, ITerminalConnector[] connectors) {
122	fConnectors=connectors;	121	fConnectors=connectors;
123	fTerminalListener=target;	122	fTerminalListener=target;
124	fTerminalModel=TerminalTextDataFactory.makeTerminalTextData();	123	fTerminalModel=TerminalTextDataFactory.makeTerminalTextData();
Lines 129-135 Link Here
129	setupTerminal(wndParent);	128	setupTerminal(wndParent);
130	}	129	}
131		130
132	public ITerminalConnectorInfo[] getConnectors() {	131	public ITerminalConnector[] getConnectors() {
133	return fConnectors;	132	return fConnectors;
134	}	133	}
135		134
Lines 266-276 Link Here
266	if(getTerminalConnector()==null)	265	if(getTerminalConnector()==null)
267	return;	266	return;
268	fTerminalText.resetState();	267	fTerminalText.resetState();
269	if(fConnectorInfo.getInitializationErrorMessage()!=null) {	268	if(fConnector.getInitializationErrorMessage()!=null) {
270	showErrorMessage(NLS.bind(	269	showErrorMessage(NLS.bind(
271	TerminalMessages.CannotConnectTo,	270	TerminalMessages.CannotConnectTo,
272	fConnectorInfo.getName(),	271	fConnector.getName(),
273	fConnectorInfo.getInitializationErrorMessage()));	272	fConnector.getInitializationErrorMessage()));
274	// we cannot connect because the connector was not initialized	273	// we cannot connect because the connector was not initialized
275	return;	274	return;
276	}	275	}
Lines 280-289 Link Here
280	waitForConnect();	279	waitForConnect();
281	}	280	}
282		281
283	private ITerminalConnector getTerminalConnector() {	282	public ITerminalConnector getTerminalConnector() {
284	if(fConnectorInfo==null)	283	return fConnector;
285	return null;
286	return fConnectorInfo.getConnector();
287	}	284	}
288	/* (non-Javadoc)	285	/* (non-Javadoc)
289	* @see org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl#disconnectTerminal()	286	* @see org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl#disconnectTerminal()
Lines 605-611 Link Here
605		602
606	public OutputStream getOutputStream() {	603	public OutputStream getOutputStream() {
607	if(getTerminalConnector()!=null)	604	if(getTerminalConnector()!=null)
608	return getTerminalConnector().getOutputStream();	605	return getTerminalConnector().getTerminalToRemoteStream();
609	return null;	606	return null;
610	}	607	}
611		608
Lines 633-645 Link Here
633	public VT100Emulator getTerminalText() {	630	public VT100Emulator getTerminalText() {
634	return fTerminalText;	631	return fTerminalText;
635	}	632	}
636
637	/**
638	*/
639	public ITerminalConnectorInfo getTerminalConnectorInfo() {
640	return fConnectorInfo;
641	}
642
643	protected class TerminalFocusListener implements FocusListener {	633	protected class TerminalFocusListener implements FocusListener {
644	private IContextActivation contextActivation = null;	634	private IContextActivation contextActivation = null;
645		635
Lines 844-852 Link Here
844	// locally, send a LF after sending a CR.	834	// locally, send a LF after sending a CR.
845	// ISSUE: Is this absolutely required?	835	// ISSUE: Is this absolutely required?
846		836
847	if (character == '\r' && getTerminalConnectorInfo() != null	837	if (character == '\r' && getTerminalConnector() != null
848	&& isConnected()	838	&& isConnected()
849	&& getTerminalConnectorInfo().getConnector().isLocalEcho()) {	839	&& getTerminalConnector().isLocalEcho()) {
850	sendChar('\n', false);	840	sendChar('\n', false);
851	}	841	}
852		842
Lines 865-872 Link Here
865	//	855	//
866	// o The character is the DELETE character.	856	// o The character is the DELETE character.
867		857
868	if (getTerminalConnectorInfo() == null	858	if (getTerminalConnector() == null
869	\|\| getTerminalConnectorInfo().getConnector().isLocalEcho() == false \|\| altKeyPressed	859	\|\| getTerminalConnector().isLocalEcho() == false \|\| altKeyPressed
870	\|\| (character >= '\u0001' && character < '\t')	860	\|\| (character >= '\u0001' && character < '\t')
871	\|\| (character > '\t' && character < '\r')	861	\|\| (character > '\t' && character < '\r')
872	\|\| (character > '\r' && character <= '\u001f')	862	\|\| (character > '\r' && character <= '\u001f')
Lines 912-919 Link Here
912	return ""; //$NON-NLS-1$	902	return ""; //$NON-NLS-1$
913	}	903	}
914		904
915	public void setConnector(ITerminalConnectorInfo connector) {	905	public void setConnector(ITerminalConnector connector) {
916	fConnectorInfo=connector;	906	fConnector=connector;
917		907
918	}	908	}
919	public ICommandInputField getCommandInputField() {	909	public ICommandInputField getCommandInputField() {

Lines 56-62 Link Here

(-)src/org/eclipse/tm/internal/terminal/view/TerminalView.java (-15 / +23 lines)
56	import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;	56	import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
57	import org.eclipse.tm.internal.terminal.control.TerminalViewControlFactory;	57	import org.eclipse.tm.internal.terminal.control.TerminalViewControlFactory;
58	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;	58	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
59	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;	59	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
60	import org.eclipse.tm.internal.terminal.provisional.api.Logger;	60	import org.eclipse.tm.internal.terminal.provisional.api.Logger;
61	import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;	61	import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;
62	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;	62	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
Lines 211-217 Link Here
211	//if (isConnected())	211	//if (isConnected())
212	if (fCtlTerminal.getState()!=TerminalState.CLOSED)	212	if (fCtlTerminal.getState()!=TerminalState.CLOSED)
213	return;	213	return;
214	if(fCtlTerminal.getTerminalConnectorInfo()==null)	214	if(fCtlTerminal.getTerminalConnector()==null)
215	setConnector(showSettingsDialog());	215	setConnector(showSettingsDialog());
216	fCtlTerminal.connectTerminal();	216	fCtlTerminal.connectTerminal();
217	}	217	}
Lines 246-252 Link Here
246	}	246	}
247		247
248	public void onTerminalSettings() {	248	public void onTerminalSettings() {
249	ITerminalConnectorInfo c=showSettingsDialog();	249	ITerminalConnector c=showSettingsDialog();
250	if(c!=null) {	250	if(c!=null) {
251	setConnector(c);	251	setConnector(c);
252		252
Lines 254-264 Link Here
254	}	254	}
255	}	255	}
256		256
257	private ITerminalConnectorInfo showSettingsDialog() {	257	private ITerminalConnector showSettingsDialog() {
258	// When the settings dialog is opened, load the Terminal settings from the	258	// When the settings dialog is opened, load the Terminal settings from the
259	// persistent settings.	259	// persistent settings.
260		260
261	TerminalSettingsDlg dlgTerminalSettings = new TerminalSettingsDlg(getViewSite().getShell(),fCtlTerminal.getConnectors(),fCtlTerminal.getTerminalConnectorInfo());	261	TerminalSettingsDlg dlgTerminalSettings = new TerminalSettingsDlg(getViewSite().getShell(),fCtlTerminal.getConnectors(),fCtlTerminal.getTerminalConnector());
262	dlgTerminalSettings.setTerminalTitle(getPartName());	262	dlgTerminalSettings.setTerminalTitle(getPartName());
263	Logger.log("opening Settings dialog."); //$NON-NLS-1$	263	Logger.log("opening Settings dialog."); //$NON-NLS-1$
264		264
Lines 276-282 Link Here
276	return dlgTerminalSettings.getConnector();	276	return dlgTerminalSettings.getConnector();
277	}	277	}
278		278
279	private void setConnector(ITerminalConnectorInfo connector) {	279	private void setConnector(ITerminalConnector connector) {
280	fCtlTerminal.setConnector(connector);	280	fCtlTerminal.setConnector(connector);
281	}	281	}
282		282
Lines 296-302 Link Here
296	// display in the view's content description line. This is used by class	296	// display in the view's content description line. This is used by class
297	// TerminalText when it processes an ANSI OSC escape sequence that commands	297	// TerminalText when it processes an ANSI OSC escape sequence that commands
298	// the terminal to display text in its title bar.	298	// the terminal to display text in its title bar.
299	} else if(fCtlTerminal.getTerminalConnectorInfo()==null){	299	} else if(fCtlTerminal.getTerminalConnector()==null){
300	strTitle=ViewMessages.NO_CONNECTION_SELECTED;	300	strTitle=ViewMessages.NO_CONNECTION_SELECTED;
301	} else {	301	} else {
302	// When parameter 'data' is null, we construct a descriptive string to	302	// When parameter 'data' is null, we construct a descriptive string to
Lines 307-313 Link Here
307	//In order to make the logic of assembling, and the separators, better adapt to foreign languages	307	//In order to make the logic of assembling, and the separators, better adapt to foreign languages
308	if(summary.length()>0)	308	if(summary.length()>0)
309	summary=summary+" - "; //$NON-NLS-1$	309	summary=summary+" - "; //$NON-NLS-1$
310	String name=fCtlTerminal.getTerminalConnectorInfo().getName();	310	String name=fCtlTerminal.getTerminalConnector().getName();
311	if(name.length()>0) {	311	if(name.length()>0) {
312	name+=": "; //$NON-NLS-1$	312	name+=": "; //$NON-NLS-1$
313	}	313	}
Lines 327-333 Link Here
327	// TODO: use another mechanism than "?" for the magic non initialized state	327	// TODO: use another mechanism than "?" for the magic non initialized state
328	// see TerminalConnectorProxy.getSettingsSummary	328	// see TerminalConnectorProxy.getSettingsSummary
329	String summary="?"; //$NON-NLS-1$	329	String summary="?"; //$NON-NLS-1$
330	if(fCtlTerminal.getTerminalConnectorInfo()!=null)	330	if(fCtlTerminal.getTerminalConnector()!=null)
331	summary=fCtlTerminal.getSettingsSummary();	331	summary=fCtlTerminal.getSettingsSummary();
332	if("?".equals(summary)) { //$NON-NLS-1$	332	if("?".equals(summary)) { //$NON-NLS-1$
333	summary=fStore.get(STORE_SETTING_SUMMARY, ""); //$NON-NLS-1$	333	summary=fStore.get(STORE_SETTING_SUMMARY, ""); //$NON-NLS-1$
Lines 451-461 Link Here
451	* This method creates the top-level control for the Terminal view.	451	* This method creates the top-level control for the Terminal view.
452	*/	452	*/
453	protected void setupControls(Composite wndParent) {	453	protected void setupControls(Composite wndParent) {
454	ITerminalConnectorInfo[] connectors=TerminalConnectorExtension.getTerminalConnectors();	454	ITerminalConnector[] connectors = makeConnectors();
455	fCtlTerminal = TerminalViewControlFactory.makeControl(this, wndParent, connectors);	455	fCtlTerminal = TerminalViewControlFactory.makeControl(this, wndParent, connectors);
456	String connectionType=fStore.get(STORE_CONNECTION_TYPE);	456	String connectionType=fStore.get(STORE_CONNECTION_TYPE);
457	for (int i = 0; i < connectors.length; i++) {	457	for (int i = 0; i < connectors.length; i++) {
458	connectors[i].getConnector().load(getStore(connectors[i]));	458	connectors[i].load(getStore(connectors[i]));
459	if(connectors[i].getId().equals(connectionType))	459	if(connectors[i].getId().equals(connectionType))
460	fCtlTerminal.setConnector(connectors[i]);	460	fCtlTerminal.setConnector(connectors[i]);
461	}	461	}
Lines 469-478 Link Here
469	setPartName(title);	469	setPartName(title);
470	}	470	}
471		471
472	private void saveSettings(ITerminalConnectorInfo connector) {	472	/**
473	ITerminalConnectorInfo[] connectors=fCtlTerminal.getConnectors();	473	* @return a list of connectors this view can use
		474	*/
		475	protected ITerminalConnector[] makeConnectors() {
		476	ITerminalConnector[] connectors=TerminalConnectorExtension.makeTerminalConnectors();
		477	return connectors;
		478	}
		479
		480	private void saveSettings(ITerminalConnector connector) {
		481	ITerminalConnector[] connectors=fCtlTerminal.getConnectors();
474	for (int i = 0; i < connectors.length; i++) {	482	for (int i = 0; i < connectors.length; i++) {
475	connectors[i].getConnector().save(getStore(connectors[i]));	483	connectors[i].save(getStore(connectors[i]));
476	}	484	}
477	if(connector!=null) {	485	if(connector!=null) {
478	fStore.put(STORE_CONNECTION_TYPE,connector.getId());	486	fStore.put(STORE_CONNECTION_TYPE,connector.getId());
Lines 493-499 Link Here
493	fStore.put(STORE_TITLE,getPartName());	501	fStore.put(STORE_TITLE,getPartName());
494	fStore.saveState(memento);	502	fStore.saveState(memento);
495	}	503	}
496	private ISettingsStore getStore(ITerminalConnectorInfo connector) {	504	private ISettingsStore getStore(ITerminalConnector connector) {
497	return new SettingStorePrefixDecorator(fStore,connector.getId()+"."); //$NON-NLS-1$	505	return new SettingStorePrefixDecorator(fStore,connector.getId()+"."); //$NON-NLS-1$
498	}	506	}
499		507

Removed Link Here

(-)src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalConnectorInfo.java (-64 lines)
1	/*******************************************************************************
2	* Copyright (c) 2006, 2007 Wind River Systems, Inc. and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Michael Scharf (Wind River) - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tm.internal.terminal.provisional.api;
12
13	/**
14	* This class is a handle to a {@link ITerminalConnector connector} that comes from an
15	* extension. It maintains a proxy to the connector to allow lazy initialization of the
16	* real {@link ITerminalConnector connector} that comes from an extension.
17	*
18	* <p>
19	* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
20	* part of a work in progress. There is no guarantee that this API will
21	* work or that it will remain the same. Please do not use this API without
22	* consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team.
23	* </p>
24	*/
25	public interface ITerminalConnectorInfo {
26	/**
27	* @return an ID of this connector. The id from the plugin.xml.
28	* <p>Note: return <code>null</code> because the framework takes
29	* care to get the value from the plugin.xml
30	*/
31	String getId();
32
33	/**
34	* @return <code>null</code> the name (as specified in the plugin.xml)
35	* <p>Note: return <code>null</code> because the framework takes
36	* care to get the value from the plugin.xml
37	*/
38	String getName();
39
40	/**
41	* @return true if the ITerminalConnector has been initialized.
42	* If there was an initialization error, {@link #getInitializationErrorMessage()}
43	* returns the error message.
44	*/
45	boolean isInitialized();
46
47	/**
48	* This method initializes the connector if it is not initialized!
49	* If the connector was initialized successfully, <code>null</code> is
50	* returned. Otherwise an error message describing the problem is returned.
51	* @return <code>null</code> or a localized error message.
52	*/
53	String getInitializationErrorMessage();
54
55	/**
56	* Returns a proxy to the connector that is lazily initialized.
57	* The following methods can be called without initializing
58	* the contributed class:
59	* {@link ITerminalConnector#getSettingsSummary()}, {@link ITerminalConnector#load(ISettingsStore)},
60	* {@link ITerminalConnector#save(ISettingsStore)}, {@link ITerminalConnector#setTerminalSize(int, int)}
61	* @return a proxy of the real connector. Some calls initialize the the connection.
62	*/
63	ITerminalConnector getConnector();
64	}

Lines 14-20 Link Here

(-)src/org/eclipse/tm/internal/terminal/control/ITerminalViewControl.java (-4 / +4 lines)
14	import org.eclipse.swt.dnd.Clipboard;	14	import org.eclipse.swt.dnd.Clipboard;
15	import org.eclipse.swt.graphics.Font;	15	import org.eclipse.swt.graphics.Font;
16	import org.eclipse.swt.widgets.Control;	16	import org.eclipse.swt.widgets.Control;
17	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;	17	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
18	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;	18	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
19		19
20	/**	20	/**
Lines 38-47 Link Here
38	void disconnectTerminal();	38	void disconnectTerminal();
39	void disposeTerminal();	39	void disposeTerminal();
40	String getSettingsSummary();	40	String getSettingsSummary();
41	ITerminalConnectorInfo[] getConnectors();	41	ITerminalConnector[] getConnectors();
42	void setFocus();	42	void setFocus();
43	ITerminalConnectorInfo getTerminalConnectorInfo();	43	ITerminalConnector getTerminalConnector();
44	void setConnector(ITerminalConnectorInfo connector);	44	void setConnector(ITerminalConnector connector);
45	void connectTerminal();	45	void connectTerminal();
46	/**	46	/**
47	* @param write a single character to terminal	47	* @param write a single character to terminal

Lines 2-10 Link Here

(-)schema/terminalConnector.exsd (-12 / +11 lines)
2	<!-- Schema file written by PDE -->	2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.tm.terminal" xmlns="http://www.w3.org/2001/XMLSchema">	3	<schema targetNamespace="org.eclipse.tm.terminal" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>	4	<annotation>
5	<appInfo>	5	<appinfo>
6	<meta.schema plugin="org.eclipse.tm.terminal" id="terminalConnector" name="TerminalConnector"/>	6	<meta.schema plugin="org.eclipse.tm.terminal" id="terminalConnector" name="TerminalConnector"/>
7	</appInfo>	7	</appinfo>
8	<documentation>	8	<documentation>
9		9
10	</documentation>	10	</documentation>
Lines 34-42 Link Here
34	<documentation>	34	<documentation>
35		35
36	</documentation>	36	</documentation>
37	<appInfo>	37	<appinfo>
38	<meta.attribute translatable="true"/>	38	<meta.attribute translatable="true"/>
39	</appInfo>	39	</appinfo>
40	</annotation>	40	</annotation>
41	</attribute>	41	</attribute>
42	</complexType>	42	</complexType>
Lines 49-57 Link Here
49	<documentation>	49	<documentation>
50	A class implementing ITerminalConnector	50	A class implementing ITerminalConnector
51	</documentation>	51	</documentation>
52	<appInfo>	52	<appinfo>
53	<meta.attribute kind="java" basedOn="org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector"/>	53	<meta.attribute kind="java" basedOn="org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl:"/>
54	</appInfo>	54	</appinfo>
55	</annotation>	55	</annotation>
56	</attribute>	56	</attribute>
57	<attribute name="id" type="string" use="required">	57	<attribute name="id" type="string" use="required">
Lines 66-74 Link Here
66	<documentation>	66	<documentation>
67	The name of the connection (used in the UI)	67	The name of the connection (used in the UI)
68	</documentation>	68	</documentation>
69	<appInfo>	69	<appinfo>
70	<meta.attribute translatable="true"/>	70	<meta.attribute translatable="true"/>
71	</appInfo>	71	</appinfo>
72	</annotation>	72	</annotation>
73	</attribute>	73	</attribute>
74	</complexType>	74	</complexType>
Lines 78-88 Link Here
78		78
79		79
80		80
81
82	<annotation>	81	<annotation>
83	<appInfo>	82	<appinfo>
84	<meta.section type="copyright"/>	83	<meta.section type="copyright"/>
85	</appInfo>	84	</appinfo>
86	<documentation>	85	<documentation>
87	Copyright (c) 2006 Wind River Systems, Inc. and others.	86	Copyright (c) 2006 Wind River Systems, Inc. and others.
88	All rights reserved. This program and the accompanying materials	87	All rights reserved. This program and the accompanying materials

Added Link Here

(-)src/org/eclipse/tm/internal/terminal/provisional/api/TerminalConnectorImpl.java (+85 lines)
1	/*******************************************************************************
2	* Copyright (c) 2007 Wind River Systems, Inc. and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Michael Scharf (Wind River) - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.tm.internal.terminal.provisional.api;
12
13	import java.io.OutputStream;
14
15	public abstract class TerminalConnectorImpl {
16	/**
17	* Called once after the constructor
18	* @throws Exception
19	*/
20	public void initialize() throws Exception {
21	}
22	/**
23	* Connect using the current state of the settings.
24	* @param control Used to inform the UI about state changes and messages from the connection.
25	*/
26	abstract public void connect(ITerminalControl control);
27
28	/**
29	* Disconnect if connected. Else do nothing.
30	* Has to set the state of the {@link ITerminalControl}
31	*/
32	abstract public void disconnect();
33
34	/**
35	* @return the terminal to remote stream (bytes written to this stream will
36	* be sent to the remote site). For the stream in the other direction (remote to
37	* terminal see {@link ITerminalControl#getRemoteToTerminalOutputStream()}
38	*/
39	abstract public OutputStream getOutputStream();
40
41	/**
42	* @return A string that represents the settings of the connection. This representation
43	* may be shown in the status line of the terminal view.
44	*/
45	abstract public String getSettingsSummary();
46
47	/**
48	* @return true if a local echo is needed.
49	* TODO:Michael Scharf: this should be handed within the connection....
50	*/
51	public boolean isLocalEcho() {
52	return false;
53	}
54
55	/**
56	* @return a new page that can be used in a dialog to setup this connection.
57	* The dialog should persist its settings with the {@link #load(ISettingsStore)}
58	* and {@link #save(ISettingsStore)} methods.
59	*
60	*/
61	abstract public ISettingsPage makeSettingsPage();
62
63	/**
64	* Load the state of this connection. Is typically called before
65	* {@link #connect(ITerminalControl)}.
66	*
67	* @param store a string based data store. Short keys like "foo" can be used to
68	* store the state of the connection.
69	*/
70	abstract public void load(ISettingsStore store);
71	/**
72	* When the view or dialog containing the terminal is closed,
73	* the state of the connection is saved into the settings store <code>store</code>
74	* @param store
75	*/
76	abstract public void save(ISettingsStore store);
77
78	/**
79	* Notify the remote site that the size of the terminal has changed.
80	* @param newWidth
81	* @param newHeight
82	*/
83	public void setTerminalSize(int newWidth, int newHeight) {
84	}
85	}

Lines 41-52 Link Here

(-)src/org/eclipse/tm/internal/terminal/view/TerminalSettingsDlg.java (-9 / +9 lines)
41	import org.eclipse.swt.widgets.Shell;	41	import org.eclipse.swt.widgets.Shell;
42	import org.eclipse.swt.widgets.Text;	42	import org.eclipse.swt.widgets.Text;
43	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;	43	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
44	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;	44	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
45		45
46	class TerminalSettingsDlg extends Dialog {	46	class TerminalSettingsDlg extends Dialog {
47	private Combo fCtlConnTypeCombo;	47	private Combo fCtlConnTypeCombo;
48	private Text fTerminalTitleText;	48	private Text fTerminalTitleText;
49	private final ITerminalConnectorInfo[] fConnectors;	49	private final ITerminalConnector[] fConnectors;
50	private final ISettingsPage[] fPages;	50	private final ISettingsPage[] fPages;
51	/**	51	/**
52	* Maps the fConnectors index to the fPages index	52	* Maps the fConnectors index to the fPages index
Lines 58-64 Link Here
58	private IDialogSettings fDialogSettings;	58	private IDialogSettings fDialogSettings;
59	private String fTerminalTitle;	59	private String fTerminalTitle;
60		60
61	public TerminalSettingsDlg(Shell shell, ITerminalConnectorInfo[] connectors, ITerminalConnectorInfo connector) {	61	public TerminalSettingsDlg(Shell shell, ITerminalConnector[] connectors, ITerminalConnector connector) {
62	super(shell);	62	super(shell);
63	fConnectors=getValidConnectors(connectors);	63	fConnectors=getValidConnectors(connectors);
64	fPages=new ISettingsPage[fConnectors.length];	64	fPages=new ISettingsPage[fConnectors.length];
Lines 73-93 Link Here
73	* @param connectors	73	* @param connectors
74	* @return connectors excluding connectors with errors	74	* @return connectors excluding connectors with errors
75	*/	75	*/
76	private ITerminalConnectorInfo[] getValidConnectors(ITerminalConnectorInfo[] connectors) {	76	private ITerminalConnector[] getValidConnectors(ITerminalConnector[] connectors) {
77	List list=new ArrayList(Arrays.asList(connectors));	77	List list=new ArrayList(Arrays.asList(connectors));
78	for (Iterator iterator = list.iterator(); iterator.hasNext();) {	78	for (Iterator iterator = list.iterator(); iterator.hasNext();) {
79	ITerminalConnectorInfo info = (ITerminalConnectorInfo) iterator.next();	79	ITerminalConnector info = (ITerminalConnector) iterator.next();
80	if(info.isInitialized() && info.getInitializationErrorMessage()!=null)	80	if(info.isInitialized() && info.getInitializationErrorMessage()!=null)
81	iterator.remove();	81	iterator.remove();
82	}	82	}
83	connectors=(ITerminalConnectorInfo[]) list.toArray(new ITerminalConnectorInfo[list.size()]);	83	connectors=(ITerminalConnector[]) list.toArray(new ITerminalConnector[list.size()]);
84	return connectors;	84	return connectors;
85	}	85	}
86	ISettingsPage getPage(int i) {	86	ISettingsPage getPage(int i) {
87	if(fPages[i]==null) {	87	if(fPages[i]==null) {
88	if(fConnectors[i].getInitializationErrorMessage()!=null) {	88	if(fConnectors[i].getInitializationErrorMessage()!=null) {
89	// create a error message	89	// create a error message
90	final ITerminalConnectorInfo conn=fConnectors[i];	90	final ITerminalConnector conn=fConnectors[i];
91	fPages[i]=new ISettingsPage(){	91	fPages[i]=new ISettingsPage(){
92	public void createControl(Composite parent) {	92	public void createControl(Composite parent) {
93	Label l=new Label(parent,SWT.WRAP);	93	Label l=new Label(parent,SWT.WRAP);
Lines 105-111 Link Here
105	public boolean validateSettings() {return false;}	105	public boolean validateSettings() {return false;}
106	};	106	};
107	} else {	107	} else {
108	fPages[i]=fConnectors[i].getConnector().makeSettingsPage();	108	fPages[i]=fConnectors[i].makeSettingsPage();
109	}	109	}
110	// TODO: what happens if an error occurs while	110	// TODO: what happens if an error occurs while
111	// the control is partly created?	111	// the control is partly created?
Lines 245-251 Link Here
245	}	245	}
246	});	246	});
247	}	247	}
248	public ITerminalConnectorInfo getConnector() {	248	public ITerminalConnector getConnector() {
249	if(fSelectedConnector>=0)	249	if(fSelectedConnector>=0)
250	return fConnectors[fSelectedConnector];	250	return fConnectors[fSelectedConnector];
251	return null;	251	return null;

Lines 30-41 Link Here

(-)src/org/eclipse/tm/internal/terminal/serial/SerialConnector.java (-2 / +2 lines)
30	import org.eclipse.core.runtime.Status;	30	import org.eclipse.core.runtime.Status;
31	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;	31	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsPage;
32	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;	32	import org.eclipse.tm.internal.terminal.provisional.api.ISettingsStore;
33	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
34	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;	33	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalControl;
35	import org.eclipse.tm.internal.terminal.provisional.api.Logger;	34	import org.eclipse.tm.internal.terminal.provisional.api.Logger;
		35	import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorImpl;
36	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;	36	import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
37		37
38	public class SerialConnector implements ITerminalConnector {	38	public class SerialConnector extends TerminalConnectorImpl {
39	private OutputStream fOutputStream;	39	private OutputStream fOutputStream;
40	private InputStream fInputStream;	40	private InputStream fInputStream;
41	private ITerminalControl fControl;	41	private ITerminalControl fControl;

Lines 1-7 Link Here

(-)src/test/Main.java (-23 / +2 lines)
1	package test;	1	package test;
2		2
3	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;	3	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
4	import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnectorInfo;
5	import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;	4	import org.eclipse.tm.internal.terminal.provisional.api.TerminalConnectorExtension;
6		5
7	public class Main {	6	public class Main {
Lines 10-39 Link Here
10	* @param args	9	* @param args
11	*/	10	*/
12	public static void main(String[] args) {	11	public static void main(String[] args) {
13	// TODO Auto-generated method stub
14	new ITerminalConnectorInfo(){
15
16	public ITerminalConnector getConnector() {
17	return null;
18	}
19
20	public String getId() {
21	return "com.yourdomain.ssh";
22	}
23
24	public String getInitializationErrorMessage() {
25	return null;
26	}
27	public String getName() {
28	return "SSH";
29	}
30	public boolean isInitialized() {
31	return true;
32	}};
33	}	12	}
34		13
35	ITerminalConnectorInfo getSsh() {	14	ITerminalConnector getSsh() {
36	ITerminalConnectorInfo[] c = TerminalConnectorExtension.getTerminalConnectors();	15	ITerminalConnector[] c = TerminalConnectorExtension.makeTerminalConnectors();
37	for (int i = 0; i < c.length; i++) {	16	for (int i = 0; i < c.length; i++) {
38	if("org.eclipse.tm.internal.terminal.ssh.SshConnector".equals(c[i]))	17	if("org.eclipse.tm.internal.terminal.ssh.SshConnector".equals(c[i]))
39	return c[i];	18	return c[i];