|
Lines 1-11
Link Here
|
| 1 |
/******************************************************************************* |
1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2006, 2007 Wind River Systems, Inc. and others. |
2 |
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. |
| 3 |
* All rights reserved. This program and the accompanying materials |
3 |
* All rights reserved. This program and the accompanying materials |
| 4 |
* are made available under the terms of the Eclipse Public License v1.0 |
4 |
* are made available under the terms of the Eclipse Public License v1.0 |
| 5 |
* which accompanies this distribution, and is available at |
5 |
* which accompanies this distribution, and is available at |
| 6 |
* http://www.eclipse.org/legal/epl-v10.html |
6 |
* http://www.eclipse.org/legal/epl-v10.html |
| 7 |
* |
7 |
* |
| 8 |
* Contributors: |
8 |
* Contributors: |
| 9 |
* Michael Scharf (Wind River) - initial API and implementation |
9 |
* Michael Scharf (Wind River) - initial API and implementation |
| 10 |
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified |
10 |
* Martin Oberhuber (Wind River) - fixed copyright headers and beautified |
| 11 |
*******************************************************************************/ |
11 |
*******************************************************************************/ |
|
Lines 17-35
Link Here
|
| 17 |
|
17 |
|
| 18 |
|
18 |
|
| 19 |
/** |
19 |
/** |
| 20 |
* Manage a single connection. Implementations of this class are contributed |
20 |
* Manage a single connection. Implementations of this class are contributed via |
| 21 |
* via <code>org.eclipse.tm.terminal.terminalConnector</code> extension point. |
21 |
* <code>org.eclipse.tm.terminal.terminalConnectors</code> extension point. |
| 22 |
* This class is a handle to a {@link ITerminalConnector connector} that comes from an |
22 |
* This class is a handle to a {@link ITerminalConnector connector} that comes |
| 23 |
* extension. It maintains {@link TerminalConnectorImpl} to the connector to allow lazy initialization of the |
23 |
* from an extension. It maintains {@link TerminalConnectorImpl} to the |
| 24 |
* real {@link ITerminalConnector connector} that comes from an extension. |
24 |
* connector to allow lazy initialization of the real |
| 25 |
|
25 |
* {@link ITerminalConnector connector} that comes from an extension. |
|
|
26 |
* |
| 26 |
* @author Michael Scharf |
27 |
* @author Michael Scharf |
| 27 |
* <p> |
28 |
* <p> |
| 28 |
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as |
29 |
* <strong>EXPERIMENTAL</strong>. This class or interface has been |
| 29 |
* part of a work in progress. There is no guarantee that this API will |
30 |
* added as part of a work in progress. There is no guarantee that this |
| 30 |
* work or that it will remain the same. Please do not use this API without |
31 |
* API will work or that it will remain the same. Please do not use this |
| 31 |
* consulting with the <a href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team. |
32 |
* API without consulting with the <a |
| 32 |
* </p> |
33 |
* href="http://www.eclipse.org/dsdp/tm/">Target Management</a> team. |
|
|
34 |
* </p> |
| 33 |
*/ |
35 |
*/ |
| 34 |
public interface ITerminalConnector extends IAdaptable { |
36 |
public interface ITerminalConnector extends IAdaptable { |
| 35 |
/** |
37 |
/** |
|
Lines 48-54
Link Here
|
| 48 |
* returns the error message. |
50 |
* returns the error message. |
| 49 |
*/ |
51 |
*/ |
| 50 |
boolean isInitialized(); |
52 |
boolean isInitialized(); |
| 51 |
|
53 |
|
| 52 |
/** |
54 |
/** |
| 53 |
* This method initializes the connector if it is not initialized! |
55 |
* This method initializes the connector if it is not initialized! |
| 54 |
* If the connector was initialized successfully, <code>null</code> is |
56 |
* If the connector was initialized successfully, <code>null</code> is |
|
Lines 89-104
Link Here
|
| 89 |
OutputStream getTerminalToRemoteStream(); |
91 |
OutputStream getTerminalToRemoteStream(); |
| 90 |
|
92 |
|
| 91 |
/** |
93 |
/** |
| 92 |
* Load the state of this connection. Is typically called before |
94 |
* Load the state of this connection. Is typically called before |
| 93 |
* {@link #connect(ITerminalControl)}. |
95 |
* {@link #connect(ITerminalControl)}. |
| 94 |
* |
96 |
* |
| 95 |
* @param store a string based data store. Short keys like "foo" can be used to |
97 |
* @param store a string based data store. Short keys like "foo" can be used to |
| 96 |
* store the state of the connection. |
98 |
* store the state of the connection. |
| 97 |
*/ |
99 |
*/ |
| 98 |
void load(ISettingsStore store); |
100 |
void load(ISettingsStore store); |
| 99 |
|
101 |
|
| 100 |
/** |
102 |
/** |
| 101 |
* When the view or dialog containing the terminal is closed, |
103 |
* When the view or dialog containing the terminal is closed, |
| 102 |
* the state of the connection is saved into the settings store <code>store</code> |
104 |
* the state of the connection is saved into the settings store <code>store</code> |
| 103 |
* @param store |
105 |
* @param store |
| 104 |
*/ |
106 |
*/ |
|
Lines 108-120
Link Here
|
| 108 |
* @return a new page that can be used in a dialog to setup this connection. |
110 |
* @return a new page that can be used in a dialog to setup this connection. |
| 109 |
* The dialog should persist its settings with the {@link #load(ISettingsStore)} |
111 |
* The dialog should persist its settings with the {@link #load(ISettingsStore)} |
| 110 |
* and {@link #save(ISettingsStore)} methods. |
112 |
* and {@link #save(ISettingsStore)} methods. |
| 111 |
* |
113 |
* |
| 112 |
*/ |
114 |
*/ |
| 113 |
ISettingsPage makeSettingsPage(); |
115 |
ISettingsPage makeSettingsPage(); |
| 114 |
|
116 |
|
| 115 |
/** |
117 |
/** |
| 116 |
* @return A string that represents the settings of the connection. This representation |
118 |
* @return A string that represents the settings of the connection. This representation |
| 117 |
* may be shown in the status line of the terminal view. |
119 |
* may be shown in the status line of the terminal view. |
| 118 |
*/ |
120 |
*/ |
| 119 |
String getSettingsSummary(); |
121 |
String getSettingsSummary(); |
| 120 |
|
122 |
|