[yocto] [PATCH 06/12] Move RSEHelper to a separate plugin
Ioana Grigoropol
ioanax.grigoropol at intel.com
Thu May 9 00:53:25 PDT 2013
- move RSEHelper to newly created separate plugin org.yocto.remote.utils
- clean-up RSEHelper code by removing all unused methods
- moved message strings that are relevant for this plugin to the corresponding class
- modify remotetools plugin to use RSEHelper from org.yocto.remote.utils
Signed-off-by: Ioana Grigoropol <ioanax.grigoropol at intel.com>
---
.../org.yocto.remote.utils/META-INF/MANIFEST.MF | 10 ++
.../src/org/yocto/remote/utils/Activator.java | 4 +-
.../src/org/yocto/remote/utils/Messages.java | 35 +++++
.../src/org/yocto/remote/utils}/RSEHelper.java | 163 ++++++--------------
.../org.yocto.sdk.remotetools/META-INF/MANIFEST.MF | 3 +-
.../yocto/sdk/remotetools/actions/BaseModel.java | 2 +-
.../sdk/remotetools/actions/BaseSettingDialog.java | 2 +-
.../sdk/remotetools/actions/TerminalHandler.java | 2 +-
.../sdk/remotetools/remote/RemoteShellExec.java | 2 +-
9 files changed, 98 insertions(+), 125 deletions(-)
create mode 100644 plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Messages.java
rename plugins/{org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools => org.yocto.remote.utils/src/org/yocto/remote/utils}/RSEHelper.java (78%)
diff --git a/plugins/org.yocto.remote.utils/META-INF/MANIFEST.MF b/plugins/org.yocto.remote.utils/META-INF/MANIFEST.MF
index eff0356..9616484 100644
--- a/plugins/org.yocto.remote.utils/META-INF/MANIFEST.MF
+++ b/plugins/org.yocto.remote.utils/META-INF/MANIFEST.MF
@@ -8,3 +8,13 @@ Require-Bundle: org.eclipse.ui,
org.eclipse.core.runtime
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-1.7
+Import-Package: org.eclipse.rse.core,
+ org.eclipse.rse.core.model,
+ org.eclipse.rse.core.subsystems,
+ org.eclipse.rse.services,
+ org.eclipse.rse.services.files,
+ org.eclipse.rse.services.shells,
+ org.eclipse.rse.subsystems.files.core.servicesubsystem,
+ org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem,
+ org.eclipse.rse.subsystems.terminals.core
+Export-Package: org.yocto.remote.utils
diff --git a/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Activator.java b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Activator.java
index 047d900..da66a3e 100644
--- a/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Activator.java
+++ b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Activator.java
@@ -23,7 +23,7 @@ public class Activator extends AbstractUIPlugin {
// The shared instance
private static Activator plugin;
-
+
/**
* The constructor
*/
@@ -34,6 +34,7 @@ public class Activator extends AbstractUIPlugin {
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
*/
+ @Override
public void start(BundleContext context) throws Exception {
super.start(context);
plugin = this;
@@ -43,6 +44,7 @@ public class Activator extends AbstractUIPlugin {
* (non-Javadoc)
* @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
*/
+ @Override
public void stop(BundleContext context) throws Exception {
plugin = null;
super.stop(context);
diff --git a/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Messages.java b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Messages.java
new file mode 100644
index 0000000..fc696d6
--- /dev/null
+++ b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/Messages.java
@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright (c) 2013 Intel Corporation.
+ * 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:
+ * Intel - initial API and implementation
+ *******************************************************************************/
+package org.yocto.remote.utils;
+
+import org.eclipse.osgi.util.NLS;
+
+public class Messages extends NLS {
+
+ private static final String BUNDLE_NAME = "org.yocto.remote.utils.messages"; //$NON-NLS-1$
+
+ public static String ErrorNoSubsystem;
+ public static String ErrorConnectSubsystem;
+
+ public static String InfoDownload;
+ public static String InfoUpload;
+
+ public static String RemoteShellExec_1;
+ public static String RemoteShellExec_2;
+
+ static {
+ // initialize resource bundle
+ NLS.initializeMessages(BUNDLE_NAME, Messages.class);
+ }
+
+ private Messages() {
+ }
+}
diff --git a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/RSEHelper.java b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/RSEHelper.java
similarity index 78%
rename from plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/RSEHelper.java
rename to plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/RSEHelper.java
index 569b00d..201c944 100644
--- a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/RSEHelper.java
+++ b/plugins/org.yocto.remote.utils/src/org/yocto/remote/utils/RSEHelper.java
@@ -1,5 +1,5 @@
/********************************************************************************
- * Copyright (c) 2009, 2010 MontaVista Software, Inc and Others.
+ * Copyright (c) 2013 MontaVista Software, Inc and Others.
* 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
@@ -7,8 +7,9 @@
* Contributors:
* Anna Dushistova (MontaVista) - initial API and implementation
* Lianhao Lu (Intel) - Modified to add other file operations.
+ * Ioana Grigoropol (Intel) - Separated remote functionality
********************************************************************************/
-package org.yocto.sdk.remotetools;
+package org.yocto.remote.utils;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
@@ -20,32 +21,34 @@ import java.util.Arrays;
import java.util.Iterator;
import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.FileLocator;
+import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.OperationCanceledException;
-import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
-import org.eclipse.core.runtime.FileLocator;
import org.eclipse.osgi.util.NLS;
import org.eclipse.rse.core.IRSECoreStatusCodes;
+import org.eclipse.rse.core.IRSESystemType;
import org.eclipse.rse.core.RSECorePlugin;
import org.eclipse.rse.core.model.IHost;
import org.eclipse.rse.core.model.ISubSystemConfigurationCategories;
import org.eclipse.rse.core.model.ISystemRegistry;
import org.eclipse.rse.core.subsystems.ISubSystem;
-import org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem.IShellServiceSubSystem;
import org.eclipse.rse.services.IService;
import org.eclipse.rse.services.files.IFileService;
import org.eclipse.rse.services.shells.HostShellProcessAdapter;
import org.eclipse.rse.services.shells.IHostShell;
import org.eclipse.rse.services.shells.IShellService;
import org.eclipse.rse.subsystems.files.core.servicesubsystem.IFileServiceSubSystem;
+import org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem.IShellServiceSubSystem;
import org.eclipse.rse.subsystems.terminals.core.ITerminalServiceSubSystem;
-import org.eclipse.rse.core.IRSESystemType;
public class RSEHelper {
+ private final static String EXIT_CMD = "exit"; //$NON-NLS-1$
+ private final static String CMD_DELIMITER = ";"; //$NON-NLS-1$
public static IHost getRemoteConnectionByName(String remoteConnection) {
if (remoteConnection == null)
@@ -58,15 +61,6 @@ public class RSEHelper {
// somehow, throw the exception?
}
-
- public static String getRemoteHostName(String remoteConnection)
- {
- final IHost host=getRemoteConnectionByName(remoteConnection);
- if(host == null)
- return null;
- else
- return host.getHostName();
- }
public static IService getConnectedRemoteFileService(
IHost currentConnection, IProgressMonitor monitor) throws Exception {
@@ -99,7 +93,7 @@ public class RSEHelper {
}
return null;
}
-
+
public static IService getConnectedShellService(
IHost currentConnection, IProgressMonitor monitor) throws Exception {
final ISubSystem subsystem = getShellSubsystem(currentConnection);
@@ -120,7 +114,7 @@ public class RSEHelper {
return ((IShellServiceSubSystem) subsystem).getShellService();
}
-
+
public static ISubSystem getShellSubsystem(IHost host) {
if (host == null)
return null;
@@ -133,15 +127,15 @@ public class RSEHelper {
}
public static IHost[] getSuitableConnections() {
-
+
//we only get RSE connections with files&cmds subsystem
ArrayList <IHost> filConnections = new ArrayList <IHost>(Arrays.asList(RSECorePlugin.getTheSystemRegistry()
.getHostsBySubSystemConfigurationCategory(ISubSystemConfigurationCategories.SUBSYSTEM_CATEGORY_FILES))); //$NON-NLS-1$
-
+
ArrayList <IHost> terminalConnections = new ArrayList <IHost>(Arrays.asList(RSECorePlugin.getTheSystemRegistry()
.getHostsBySubSystemConfigurationCategory("terminal")));//$NON-NLS-1$
-
- ArrayList shellConnections = new ArrayList(Arrays.asList(RSECorePlugin.getTheSystemRegistry()
+
+ ArrayList <IHost> shellConnections = new ArrayList <IHost>(Arrays.asList(RSECorePlugin.getTheSystemRegistry()
.getHostsBySubSystemConfigurationCategory("shells"))); //$NON-NLS-1$
Iterator <IHost>iter = filConnections.iterator();
@@ -155,79 +149,16 @@ public class RSEHelper {
iter.remove();
}
}
-
- return (IHost[]) filConnections.toArray(new IHost[filConnections.size()]);
- }
-
- public static void deleteRemoteFile(IHost connection, String remoteExePath,
- IProgressMonitor monitor) throws Exception {
-
- assert(connection!=null);
- monitor.beginTask(Messages.InfoUpload, 100);
-
- IFileService fileService;
- try {
- fileService = (IFileService) getConnectedRemoteFileService(
- connection,
- new SubProgressMonitor(monitor, 5));
-
- Path remotePath = new Path(remoteExePath);
- if(fileService.getFile(remotePath.removeLastSegments(1).toString(),
- remotePath.lastSegment(),
- new SubProgressMonitor(monitor, 5)).exists()) {
- fileService.delete(remotePath.removeLastSegments(1).toString(),
- remotePath.lastSegment(),
- new SubProgressMonitor(monitor, 10));
- }
- } finally {
- monitor.done();
- }
- return;
- }
-
- public static void putRemoteFile(IHost connection, String localExePath, String remoteExePath,
- IProgressMonitor monitor) throws Exception {
-
- assert(connection!=null);
- monitor.beginTask(Messages.InfoUpload, 100);
-
- IFileService fileService;
- try {
- fileService = (IFileService) getConnectedRemoteFileService(
- connection,
- new SubProgressMonitor(monitor, 5));
- File file = new File(localExePath);
- Path remotePath = new Path(remoteExePath);
- if(fileService.getFile(remotePath.removeLastSegments(1).toString(),
- remotePath.lastSegment(),
- new SubProgressMonitor(monitor, 5)).exists()) {
- fileService.delete(remotePath.removeLastSegments(1).toString(),
- remotePath.lastSegment(),
- new SubProgressMonitor(monitor, 10));
- }
- fileService.upload(file, remotePath.removeLastSegments(1)
- .toString(), remotePath.lastSegment(), true, null, null,
- new SubProgressMonitor(monitor, 80));
- // Need to change the permissions to match the original file
- // permissions because of a bug in upload
- //RemoteApplication p = remoteShellExec(
- // config,
- // "", "chmod", "+x " + spaceEscapify(remotePath.toString()), new SubProgressMonitor(monitor, 5)); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
- //Thread.sleep(500);
- //p.destroy();
-
- } finally {
- monitor.done();
- }
- return;
+
+ return filConnections.toArray(new IHost[filConnections.size()]);
}
-
+
public static void putRemoteFileInPlugin(IHost connection, String locaPathInPlugin, String remoteExePath,
IProgressMonitor monitor) throws Exception {
-
- assert(connection!=null);
+
+ assert(connection != null);
monitor.beginTask(Messages.InfoUpload, 100);
-
+
IFileService fileService;
try {
fileService = (IFileService) getConnectedRemoteFileService(
@@ -236,17 +167,7 @@ public class RSEHelper {
InputStream inputStream = FileLocator.openStream(
Activator.getDefault().getBundle(), new Path(locaPathInPlugin), false);
Path remotePath = new Path(remoteExePath);
- /*
- if(!fileService.getFile(remotePath.removeLastSegments(1).toString(),
- remotePath.lastSegment(),
- new SubProgressMonitor(monitor, 5)).exists()) {
- }
- */
- /*
- fileService.upload(inputStream, remotePath.removeLastSegments(1)
- .toString(), remotePath.lastSegment(), true, null,
- new SubProgressMonitor(monitor, 80));
- */
+
//TODO workaround for now
//in case the underlying scp file service doesn't support inputStream upload
BufferedInputStream bis = new BufferedInputStream(inputStream);
@@ -268,19 +189,19 @@ public class RSEHelper {
remoteShellExec(
connection,
"", "chmod", "+x " + spaceEscapify(remotePath.toString()), new SubProgressMonitor(monitor, 5)); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
-
+
} finally {
monitor.done();
}
return;
}
-
+
public static void getRemoteFile(IHost connection, String localExePath, String remoteExePath,
IProgressMonitor monitor) throws Exception {
-
+
assert(connection!=null);
monitor.beginTask(Messages.InfoDownload, 100);
-
+
IFileService fileService;
try {
fileService = (IFileService) getConnectedRemoteFileService(
@@ -290,7 +211,7 @@ public class RSEHelper {
file.deleteOnExit();
monitor.worked(5);
Path remotePath = new Path(remoteExePath);
- fileService.download(remotePath.removeLastSegments(1).toString(),
+ fileService.download(remotePath.removeLastSegments(1).toString(),
remotePath.lastSegment(),file,true, null,
new SubProgressMonitor(monitor, 85));
// Need to change the permissions to match the original file
@@ -300,13 +221,13 @@ public class RSEHelper {
// "", "chmod", "+x " + spaceEscapify(remotePath.toString()), new SubProgressMonitor(monitor, 5)); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
//Thread.sleep(500);
//p.destroy();
-
+
} finally {
monitor.done();
}
return;
}
-
+
public static ITerminalServiceSubSystem getTerminalSubSystem(
IHost connection) {
ISystemRegistry systemRegistry = RSECorePlugin.getTheSystemRegistry();
@@ -319,21 +240,18 @@ public class RSEHelper {
}
return null;
}
-
+
public static String spaceEscapify(String inputString) {
if (inputString == null)
return null;
return inputString.replaceAll(" ", "\\\\ "); //$NON-NLS-1$ //$NON-NLS-2$
}
-
- private final static String EXIT_CMD = "exit"; //$NON-NLS-1$
- private final static String CMD_DELIMITER = ";"; //$NON-NLS-1$
-
+
public static Process remoteShellExec(IHost connection,
String prelaunchCmd, String remoteCommandPath, String arguments,
IProgressMonitor monitor) throws CoreException {
-
+
monitor.beginTask(NLS.bind(Messages.RemoteShellExec_1,
remoteCommandPath, arguments), 10);
String realRemoteCommand = arguments == null ? spaceEscapify(remoteCommandPath)
@@ -376,11 +294,11 @@ public class RSEHelper {
monitor.done();
return p;
}
-
+
/**
* Throws a core exception with an error status object built from the given
* message, lower level exception, and error code.
- *
+ *
* @param message
* the status message
* @param exception
@@ -394,13 +312,17 @@ public class RSEHelper {
if (exception != null) {
MultiStatus multiStatus = new MultiStatus(Activator.PLUGIN_ID, code, message, exception);
multiStatus.add(new Status(IStatus.ERROR, Activator.PLUGIN_ID, code, exception.getLocalizedMessage(), exception));
- status= multiStatus;
+ status = multiStatus;
} else {
- status= new Status(IStatus.ERROR, Activator.PLUGIN_ID, code, message, null);
+ status = new Status(IStatus.ERROR, Activator.PLUGIN_ID, code, message, null);
}
throw new CoreException(status);
}
-
+ /**
+ * Checks whether a IHost associated system's is enabled and not a local one
+ * @param host
+ * @return
+ */
public static boolean isHostViable(IHost host) {
IRSESystemType sysType = host.getSystemType();
if (sysType != null && sysType.isEnabled() && !sysType.isLocal())
@@ -408,6 +330,9 @@ public class RSEHelper {
return false;
}
+ /**
+ * Ensures that RSECorePlugin is initialized before performing any actions
+ */
public static void waitForRSEInitCompletition() {
if (!RSECorePlugin.isInitComplete(RSECorePlugin.INIT_MODEL))
try {
diff --git a/plugins/org.yocto.sdk.remotetools/META-INF/MANIFEST.MF b/plugins/org.yocto.sdk.remotetools/META-INF/MANIFEST.MF
index d10a56e..c34ad9e 100644
--- a/plugins/org.yocto.sdk.remotetools/META-INF/MANIFEST.MF
+++ b/plugins/org.yocto.sdk.remotetools/META-INF/MANIFEST.MF
@@ -24,7 +24,8 @@ Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: org.eclipse.core.resources,
org.eclipse.debug.internal.ui,
org.eclipse.rse.shells.ui,
- org.eclipse.ui.forms.widgets
+ org.eclipse.ui.forms.widgets,
+ org.yocto.remote.utils
Bundle-Vendor: %Bundle-Vendor
Bundle-ClassPath: lib/json-simple-1.1.1.jar,
.
diff --git a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseModel.java b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseModel.java
index 2e15e48..08cb873 100644
--- a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseModel.java
+++ b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseModel.java
@@ -18,7 +18,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.rse.core.model.IHost;
-import org.yocto.sdk.remotetools.RSEHelper;
+import org.yocto.remote.utils.RSEHelper;
import org.yocto.sdk.remotetools.remote.RemoteShellExec;
abstract public class BaseModel implements IRunnableWithProgress {
diff --git a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseSettingDialog.java b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseSettingDialog.java
index 962a20a..7845959 100644
--- a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseSettingDialog.java
+++ b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/BaseSettingDialog.java
@@ -21,9 +21,9 @@
package org.yocto.sdk.remotetools.actions;
+import org.yocto.remote.utils.RSEHelper;
import org.yocto.sdk.remotetools.Messages;
import org.yocto.sdk.remotetools.SWTFactory;
-import org.yocto.sdk.remotetools.RSEHelper;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.rse.core.model.IHost;
diff --git a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/TerminalHandler.java b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/TerminalHandler.java
index 9e7c169..4ad8688 100644
--- a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/TerminalHandler.java
+++ b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/actions/TerminalHandler.java
@@ -33,8 +33,8 @@ import org.eclipse.swt.events.DisposeListener;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.tm.internal.terminal.control.ITerminalViewControl;
import org.eclipse.tm.internal.terminal.provisional.api.ITerminalConnector;
+import org.yocto.remote.utils.RSEHelper;
import org.yocto.sdk.remotetools.CommonHelper;
-import org.yocto.sdk.remotetools.RSEHelper;
abstract public class TerminalHandler extends AbstractHandler {
diff --git a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/remote/RemoteShellExec.java b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/remote/RemoteShellExec.java
index bb4859d..bfcbbfc 100644
--- a/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/remote/RemoteShellExec.java
+++ b/plugins/org.yocto.sdk.remotetools/src/org/yocto/sdk/remotetools/remote/RemoteShellExec.java
@@ -22,7 +22,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
//import org.eclipse.tcf.services.IProcesses;
//import org.eclipse.tcf.util.TCFTask;
import org.eclipse.rse.core.model.IHost;
-import org.yocto.sdk.remotetools.RSEHelper;
+import org.yocto.remote.utils.RSEHelper;
public class RemoteShellExec {
--
1.7.9.5
More information about the yocto
mailing list