1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*******************************************************************************
* Copyright (c) 2011, 2012 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
*******************************************************************************/
package org.eclipse.tcf.te.ui.terminals.services;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.Status;
import org.eclipse.swt.custom.CTabItem;
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.AbstractService;
import org.eclipse.tcf.te.runtime.services.interfaces.ITerminalService;
import org.eclipse.tcf.te.runtime.services.interfaces.constants.ITerminalsConnectorConstants;
import org.eclipse.tcf.te.runtime.utils.StatusHelper;
import org.eclipse.tcf.te.ui.swt.DisplayUtil;
import org.eclipse.tcf.te.ui.terminals.interfaces.IConnectorType;
import org.eclipse.tcf.te.ui.terminals.interfaces.IUIConstants;
import org.eclipse.tcf.te.ui.terminals.manager.ConsoleManager;
import org.eclipse.tcf.te.ui.terminals.nls.Messages;
import org.eclipse.tcf.te.ui.terminals.types.ConnectorManager;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
/**
* Terminal service implementation.
*/
@SuppressWarnings("restriction")
public class TerminalService extends AbstractService implements ITerminalService {
/**
* Common terminal service runnable implementation.
*/
protected static abstract class TerminalServiceRunnable {
/**
* Invoked to execute the terminal service runnable.
*
* @param id The terminals view id or <code>null</code>.
* @param secondaryId The terminals view secondary id or <code>null</code>.
* @param title The terminal tab title. Must not be <code>null</code>.
* @param connector The terminal connector. Must not be <code>null</code>.
* @param data The custom terminal data node or <code>null</code>.
* @param callback The target callback to invoke if the operation finished or <code>null</code>.
*/
public abstract void run(String id, String secondaryId, String title, ITerminalConnector connector, Object data, ICallback callback);
/**
* Returns if or if not to execute the runnable asynchronously.
* <p>
* The method returns per default <code>true</code>. Overwrite to
* modify the behavior.
*
* @return <code>True</code> to execute the runnable asynchronously, <code>false</code> otherwise.
*/
public boolean isExecuteAsync() { return true; }
}
/**
* Executes the given runnable operation and invokes the given callback, if any,
* after the operation finished.
*
* @param properties The terminal properties. Must not be <code>null</code>.
* @param runnable The terminal service runnable. Must not be <code>null</code>.
* @param callback The target callback to invoke if the operation has been finished or <code>null</code>.
*/
protected final void executeServiceOperation(final IPropertiesContainer properties, final TerminalServiceRunnable runnable, final ICallback callback) {
Assert.isNotNull(properties);
Assert.isNotNull(runnable);
// Extract the properties
String id = properties.getStringProperty(ITerminalsConnectorConstants.PROP_ID);
String secondaryId = properties.getStringProperty(ITerminalsConnectorConstants.PROP_SECONDARY_ID);
String title = properties.getStringProperty(ITerminalsConnectorConstants.PROP_TITLE);
Object data = properties.getProperty(ITerminalsConnectorConstants.PROP_DATA);
// Normalize the terminals console view id
id = normalizeId(id, data);
// Normalize the terminal console tab title
title = normalizeTitle(title, data);
// Create the terminal connector instance
final ITerminalConnector connector = createTerminalConnector(properties);
if (connector == null) {
// Properties contain invalid connector arguments
if (callback != null) {
callback.done(this, StatusHelper.getStatus(new IllegalArgumentException(Messages.TerminalService_error_cannotCreateConnector)));
}
return;
}
// Finalize the used variables
final String finId = id;
final String finSecondaryId = secondaryId;
final String finTitle = title;
final Object finData = data;
// Execute the operation
if (!runnable.isExecuteAsync()) {
runnable.run(finId, finSecondaryId, finTitle, connector, finData, callback);
}
else {
DisplayUtil.safeAsyncExec(new Runnable() {
@Override
public void run() {
runnable.run(finId, finSecondaryId, finTitle, connector, finData, callback);
}
});
}
}
/**
* Normalize the terminals view id.
*
* @param id The terminals view id or <code>null</code>.
* @param data The custom data object or <code>null</code>.
*
* @return The normalized terminals console view id.
*/
protected String normalizeId(String id, Object data) {
return id != null ? id : IUIConstants.ID;
}
/**
* Normalize the terminal tab title.
*
* @param title The terminal tab title or <code>null</code>.
* @param data The custom data object or <code>null</code>.
*
* @return The normalized terminal tab title.
*/
protected String normalizeTitle(String title, Object data) {
// If the title is explicitly specified, return as is
if (title != null) return title;
// Return the default console title in all other cases
return Messages.TerminalService_defaultTitle;
}
/**
* Creates the terminal connector configured within the given properties.
*
* @param properties The terminal console properties. Must not be <code>null</code>.
* @return The terminal connector or <code>null</code>.
*/
protected ITerminalConnector createTerminalConnector(IPropertiesContainer properties) {
Assert.isNotNull(properties);
// The terminal connector result object
ITerminalConnector connector = null;
// Get the connector type id from the properties
String connectorTypeId = properties.getStringProperty(ITerminalsConnectorConstants.PROP_CONNECTOR_TYPE_ID);
if (connectorTypeId != null) {
// Get the connector type
IConnectorType connectorType = ConnectorManager.getInstance().getConnectorType(connectorTypeId, false);
if (connectorType != null) {
// Create the connector
connector = connectorType.createTerminalConnector(properties);
}
}
return connector;
}
/* (non-Javadoc)
* @see org.eclipse.tcf.te.runtime.services.interfaces.ITerminalService#openConsole(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.tcf.te.runtime.interfaces.callback.ICallback)
*/
@Override
public void openConsole(final IPropertiesContainer properties, final ICallback callback) {
Assert.isNotNull(properties);
executeServiceOperation(properties, new TerminalServiceRunnable() {
@Override
public void run(String id, String secondaryId, String title, ITerminalConnector connector, Object data, ICallback callback) {
// Determine if a new terminal tab shall be enforced
boolean forceNew = properties.getBooleanProperty(ITerminalsConnectorConstants.PROP_FORCE_NEW);
// Determine the terminal encoding
String encoding = properties.getStringProperty(ITerminalsConnectorConstants.PROP_ENCODING);
// Open the new console
CTabItem item = ConsoleManager.getInstance().openConsole(id, secondaryId, title, encoding, connector, data, true, forceNew);
// Associate the original terminal properties with the tab item.
// This makes it easier to persist the connection data within the memento handler
if (item != null) item.setData("properties", properties); //$NON-NLS-1$
// Invoke the callback
if (callback != null) callback.done(this, Status.OK_STATUS);
}
}, callback);
}
/* (non-Javadoc)
* @see org.eclipse.tcf.te.runtime.services.interfaces.ITerminalService#closeConsole(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.tcf.te.runtime.interfaces.callback.ICallback)
*/
@Override
public void closeConsole(final IPropertiesContainer properties, final ICallback callback) {
Assert.isNotNull(properties);
executeServiceOperation(properties, new TerminalServiceRunnable() {
@Override
public void run(String id, String secondaryId, String title, ITerminalConnector connector, Object data, ICallback callback) {
// Close the console
ConsoleManager.getInstance().closeConsole(id, title, connector, data);
// Invoke the callback
if (callback != null) callback.done(this, Status.OK_STATUS);
}
}, callback);
}
/* (non-Javadoc)
* @see org.eclipse.tcf.te.runtime.services.interfaces.ITerminalService#terminateConsole(org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer, org.eclipse.tcf.te.runtime.interfaces.callback.ICallback)
*/
@Override
public void terminateConsole(IPropertiesContainer properties, ICallback callback) {
Assert.isNotNull(properties);
executeServiceOperation(properties, new TerminalServiceRunnable() {
@Override
public void run(String id, String secondaryId, String title, ITerminalConnector connector, Object data, ICallback callback) {
// Close the console
ConsoleManager.getInstance().terminateConsole(id, title, connector, data);
// Invoke the callback
if (callback != null) callback.done(this, Status.OK_STATUS);
}
}, callback);
}
}
|
