Target Explorer: Add method to check is the simulator is configured for a given connection

2 files changed, 249 insertions, 226 deletions

diff --git a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/internal/SimulatorPropertyTester.java b/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/internal/SimulatorPropertyTester.java
index f5c1a2343..75cfbfb82 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/internal/SimulatorPropertyTester.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/internal/SimulatorPropertyTester.java
@@ -1,48 +1,48 @@
-/**

- * PropertyTester.java

- * Created on Mar 12, 2013

- *

- * Copyright (c) 2013 Wind River Systems, Inc.

- *

- * The right to copy, distribute, modify, or otherwise make use

- * of this software may be licensed only pursuant to the terms

- * of an applicable Wind River license agreement.

- */

-package org.eclipse.tcf.te.tcf.locator.internal;

-

-import org.eclipse.tcf.te.runtime.services.interfaces.ISimulatorService.State;

-import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModel;

-import org.eclipse.tcf.te.tcf.locator.utils.SimulatorUtils;

-import org.eclipse.tcf.te.tcf.locator.utils.SimulatorUtils.Result;

-

-/**

- * Property tester implementation.

- */

-public class SimulatorPropertyTester extends org.eclipse.core.expressions.PropertyTester {

-

-	/*

-	 * (non-Javadoc)

-	 * @see org.eclipse.core.expressions.IPropertyTester#test(java.lang.Object, java.lang.String,

-	 * java.lang.Object[], java.lang.Object)

-	 */

-	@Override

-	public boolean test(final Object receiver, String property, Object[] args, Object expectedValue) {

-		if (receiver instanceof IPeerModel) {

-			final IPeerModel peerModel = (IPeerModel) receiver;

-			Result result = SimulatorUtils.getSimulatorService(peerModel);

-

-			if (result.service != null) {

-				if ("isSimulatorState".equals(property) && expectedValue instanceof String) { //$NON-NLS-1$

-					State state = result.service.getState(receiver, result.settings);

-					return state.toString().equalsIgnoreCase((String) expectedValue);

-				}

-				if ("canStartSimulator".equals(property) && expectedValue instanceof Boolean) { //$NON-NLS-1$

-					State state = result.service.getState(receiver, result.settings);

-					return state.equals(State.Stopped);

-				}

-			}

-		}

-

-		return false;

-	}

-}

+/**
+ * PropertyTester.java
+ * Created on Mar 12, 2013
+ *
+ * Copyright (c) 2013 Wind River Systems, Inc.
+ *
+ * The right to copy, distribute, modify, or otherwise make use
+ * of this software may be licensed only pursuant to the terms
+ * of an applicable Wind River license agreement.
+ */
+package org.eclipse.tcf.te.tcf.locator.internal;
+
+import org.eclipse.tcf.te.runtime.services.interfaces.ISimulatorService.State;
+import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModel;
+import org.eclipse.tcf.te.tcf.locator.utils.SimulatorUtils;
+import org.eclipse.tcf.te.tcf.locator.utils.SimulatorUtils.Result;
+
+/**
+ * Property tester implementation.
+ */
+public class SimulatorPropertyTester extends org.eclipse.core.expressions.PropertyTester {
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.eclipse.core.expressions.IPropertyTester#test(java.lang.Object, java.lang.String,
+	 * java.lang.Object[], java.lang.Object)
+	 */
+	@Override
+	public boolean test(final Object receiver, String property, Object[] args, Object expectedValue) {
+		if (receiver instanceof IPeerModel) {
+			final IPeerModel peerModel = (IPeerModel) receiver;
+			Result result = SimulatorUtils.getSimulatorService(peerModel);
+
+			if (result.service != null) {
+				if ("isSimulatorState".equals(property) && expectedValue instanceof String) { //$NON-NLS-1$
+					State state = result.service.getState(receiver, result.settings);
+					return state.toString().equalsIgnoreCase((String) expectedValue);
+				}
+				if ("canStartSimulator".equals(property) && expectedValue instanceof Boolean) { //$NON-NLS-1$
+					State state = result.service.getState(receiver, result.settings);
+					return state.equals(State.Stopped);
+				}
+			}
+		}
+
+		return false;
+	}
+}
diff --git a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/utils/SimulatorUtils.java b/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/utils/SimulatorUtils.java
index 4aa36a2ec..4ccf46eb4 100644
--- a/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/utils/SimulatorUtils.java
+++ b/target_explorer/plugins/org.eclipse.tcf.te.tcf.locator/src/org/eclipse/tcf/te/tcf/locator/utils/SimulatorUtils.java
@@ -1,178 +1,201 @@
-/**

- * SimulatorUtils.java

- * Created on Jan 22, 2013

- *

- * Copyright (c) 2013 Wind River Systems, Inc.

- *

- * The right to copy, distribute, modify, or otherwise make use

- * of this software may be licensed only pursuant to the terms

- * of an applicable Wind River license agreement.

- */

-package org.eclipse.tcf.te.tcf.locator.utils;

-

-import java.util.concurrent.atomic.AtomicBoolean;

-import java.util.concurrent.atomic.AtomicReference;

-

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

-import org.eclipse.core.runtime.IProgressMonitor;

-import org.eclipse.core.runtime.IStatus;

-import org.eclipse.core.runtime.Status;

-import org.eclipse.tcf.protocol.Protocol;

-import org.eclipse.tcf.te.runtime.callback.Callback;

-import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;

-import org.eclipse.tcf.te.runtime.services.ServiceManager;

-import org.eclipse.tcf.te.runtime.services.interfaces.IService;

-import org.eclipse.tcf.te.runtime.services.interfaces.ISimulatorService;

-import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModel;

-import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModelProperties;

-

-/**

- * Simulator related utilities.

- */

-public final class SimulatorUtils {

-

-	/**

-	 * Result of getSimulatorService.

-	 */

-	public static class Result {

-		public ISimulatorService service;

-		public String id;

-		public String settings;

-	}

-

-	/**

-	 * Returns the simulator service and the settings for the simulator launch.

-	 * If no simulator service is configured in the peer

-	 * or the configured service is not available, <code>null</code> will be returned.

-	 *

-	 * @param peerModel The peer model node. Must not be <code>null</code>.

-	 * @return The {@link Result} containing the simulator service and the settings or <code>null</code>.

-	 */

-	public static Result getSimulatorService(final IPeerModel peerModel) {

-		Assert.isNotNull(peerModel);

-

-		final AtomicBoolean isEnabled = new AtomicBoolean(false);

-		final AtomicReference<String> type = new AtomicReference<String>();

-		final AtomicReference<String> properties = new AtomicReference<String>();

-

-		Runnable runnable = new Runnable() {

-			@Override

-			public void run() {

-				String value = peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_ENABLED);

-				if (value != null) {

-					isEnabled.set(Boolean.parseBoolean(value));

-				}

-

-				type.set(peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_TYPE));

-				properties.set(peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_PROPERTIES));

-			}

-		};

-

-		if (Protocol.isDispatchThread()) {

-			runnable.run();

-		}

-		else {

-			Protocol.invokeAndWait(runnable);

-		}

-

-		Result result = null;

-

-		if (isEnabled.get()) {

-			IService[] services = ServiceManager.getInstance().getServices(peerModel, ISimulatorService.class, false);

-			for (IService service : services) {

-				Assert.isTrue(service instanceof ISimulatorService);

-				// Get the UI service which is associated with the simulator service

-				String id = service.getId();

-				if (id != null && id.equals(type.get())) {

-					result = new Result();

-					result.service = (ISimulatorService)service;

-					result.id = id;

-					result.settings = properties.get();

-					break;

-				}

-			}

-		}

-		return result;

-	}

-

-	/**

-	 * Starts the simulator if the simulator launch is enabled for the given peer

-	 * model node and the configured simulator service type is available. In any

-	 * other cases, the given callback is invoked immediately.

-	 *

-	 * @param peerModel The peer model node. Must not be <code>null</code>.

-	 * @param monitor The progress monitor.

-	 * @param callback The callback to invoke if finished. Must not be <code>null</code>.

-	 */

-	public static void start(final IPeerModel peerModel, final IProgressMonitor monitor, final ICallback callback) {

-		Assert.isNotNull(peerModel);

-		Assert.isNotNull(callback);

-

-		// Determine if we have to start a simulator first

-		final Result result = getSimulatorService(peerModel);

-		if (result != null && result.service != null) {

-			// Check if the simulator is already running

-			result.service.isRunning(peerModel, result.settings, new Callback() {

-				@Override

-				protected void internalDone(Object caller, IStatus status) {

-					Object cbResult = getResult();

-					if (cbResult instanceof Boolean && !((Boolean)cbResult).booleanValue()) {

-						// Start the simulator

-						result.service.start(peerModel, result.settings, new Callback() {

-							@Override

-							protected void internalDone(Object caller, IStatus status) {

-								callback.setResult(new Boolean(status.isOK()));

-								callback.done(caller, status);

-							}

-						}, monitor);

-					} else {

-						callback.setResult(Boolean.FALSE);

-						callback.done(this, Status.OK_STATUS);

-					}

-				}

-			});

-		} else {

-			callback.setResult(Boolean.FALSE);

-			callback.done(null, Status.OK_STATUS);

-		}

-	}

-

-	/**

-	 * Stops the simulator if the simulator launch is enabled for the given peer

-	 * model node and the configured simulator service type is available. In any

-	 * other cases, the given callback is invoked immediately.

-	 *

-	 * @param peerModel The peer model node. Must not be <code>null</code>.

-	 * @param monitor The progress monitor.

-	 * @param callback The callback to invoke if finished. Must not be <code>null</code>.

-	 */

-	public static void stop(final IPeerModel peerModel, final IProgressMonitor monitor, final ICallback callback) {

-		Assert.isNotNull(peerModel);

-		Assert.isNotNull(callback);

-

-		// Get the associated simulator service

-		final Result result = getSimulatorService(peerModel);

-		if (result != null && result.service != null) {

-			// Determine if the simulator is at all running

-			result.service.isRunning(peerModel, result.settings, new Callback() {

-				@Override

-				protected void internalDone(Object caller, IStatus status) {

-					Object cbResult = getResult();

-					if (cbResult instanceof Boolean && ((Boolean)cbResult).booleanValue()) {

-						// Stop the simulator

-						result.service.stop(peerModel, result.settings, new Callback(callback) {

-							@Override

-							protected void internalDone(Object caller, IStatus status) {

-								callback.done(caller, status);

-							}

-						}, monitor);

-					} else {

-						callback.done(null, Status.OK_STATUS);

-					}

-				}

-			});

-		} else {

-			callback.done(null, Status.OK_STATUS);

-		}

-	}

-}

+/**
+ * SimulatorUtils.java
+ * Created on Jan 22, 2013
+ *
+ * Copyright (c) 2013 Wind River Systems, Inc.
+ *
+ * The right to copy, distribute, modify, or otherwise make use
+ * of this software may be licensed only pursuant to the terms
+ * of an applicable Wind River license agreement.
+ */
+package org.eclipse.tcf.te.tcf.locator.utils;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.eclipse.core.runtime.Assert;
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
+import org.eclipse.tcf.protocol.Protocol;
+import org.eclipse.tcf.te.runtime.callback.Callback;
+import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
+import org.eclipse.tcf.te.runtime.services.ServiceManager;
+import org.eclipse.tcf.te.runtime.services.interfaces.IService;
+import org.eclipse.tcf.te.runtime.services.interfaces.ISimulatorService;
+import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModel;
+import org.eclipse.tcf.te.tcf.locator.interfaces.nodes.IPeerModelProperties;
+
+/**
+ * Simulator related utilities.
+ */
+public final class SimulatorUtils {
+
+	/**
+	 * Result of getSimulatorService.
+	 */
+	public static class Result {
+		public ISimulatorService service;
+		public String id;
+		public String settings;
+	}
+
+	/**
+	 * Returns if or if the given peer model has the simulator enabled or not.
+	 *
+	 * @param peerModel The peer model node. Must not be <code>null</code>.
+	 * @return <code>True</code> if the simulator is enabled, <code>false</code> otherwise.
+	 */
+	public static boolean isSimulatorEnabled(final IPeerModel peerModel) {
+		Assert.isNotNull(peerModel);
+
+		final AtomicBoolean isEnabled = new AtomicBoolean(false);
+
+		Runnable runnable = new Runnable() {
+			@Override
+			public void run() {
+				String value = peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_ENABLED);
+				if (value != null) {
+					isEnabled.set(Boolean.parseBoolean(value));
+				}
+			}
+		};
+
+		if (Protocol.isDispatchThread()) runnable.run();
+		else Protocol.invokeAndWait(runnable);
+
+		return isEnabled.get();
+	}
+
+	/**
+	 * Returns the simulator service and the settings for the simulator launch.
+	 * If no simulator service is configured in the peer
+	 * or the configured service is not available, <code>null</code> will be returned.
+	 *
+	 * @param peerModel The peer model node. Must not be <code>null</code>.
+	 * @return The {@link Result} containing the simulator service and the settings or <code>null</code>.
+	 */
+	public static Result getSimulatorService(final IPeerModel peerModel) {
+		Assert.isNotNull(peerModel);
+
+		final AtomicBoolean isEnabled = new AtomicBoolean(false);
+		final AtomicReference<String> type = new AtomicReference<String>();
+		final AtomicReference<String> properties = new AtomicReference<String>();
+
+		Runnable runnable = new Runnable() {
+			@Override
+			public void run() {
+				String value = peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_ENABLED);
+				if (value != null) {
+					isEnabled.set(Boolean.parseBoolean(value));
+				}
+
+				type.set(peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_TYPE));
+				properties.set(peerModel.getPeer().getAttributes().get(IPeerModelProperties.PROP_SIM_PROPERTIES));
+			}
+		};
+
+		if (Protocol.isDispatchThread()) runnable.run();
+		else Protocol.invokeAndWait(runnable);
+
+		Result result = null;
+
+		if (isEnabled.get()) {
+			IService[] services = ServiceManager.getInstance().getServices(peerModel, ISimulatorService.class, false);
+			for (IService service : services) {
+				Assert.isTrue(service instanceof ISimulatorService);
+				// Get the UI service which is associated with the simulator service
+				String id = service.getId();
+				if (id != null && id.equals(type.get())) {
+					result = new Result();
+					result.service = (ISimulatorService)service;
+					result.id = id;
+					result.settings = properties.get();
+					break;
+				}
+			}
+		}
+		return result;
+	}
+
+	/**
+	 * Starts the simulator if the simulator launch is enabled for the given peer
+	 * model node and the configured simulator service type is available. In any
+	 * other cases, the given callback is invoked immediately.
+	 *
+	 * @param peerModel The peer model node. Must not be <code>null</code>.
+	 * @param monitor The progress monitor.
+	 * @param callback The callback to invoke if finished. Must not be <code>null</code>.
+	 */
+	public static void start(final IPeerModel peerModel, final IProgressMonitor monitor, final ICallback callback) {
+		Assert.isNotNull(peerModel);
+		Assert.isNotNull(callback);
+
+		// Determine if we have to start a simulator first
+		final Result result = getSimulatorService(peerModel);
+		if (result != null && result.service != null) {
+			// Check if the simulator is already running
+			result.service.isRunning(peerModel, result.settings, new Callback() {
+				@Override
+				protected void internalDone(Object caller, IStatus status) {
+					Object cbResult = getResult();
+					if (cbResult instanceof Boolean && !((Boolean)cbResult).booleanValue()) {
+						// Start the simulator
+						result.service.start(peerModel, result.settings, new Callback() {
+							@Override
+							protected void internalDone(Object caller, IStatus status) {
+								callback.setResult(new Boolean(status.isOK()));
+								callback.done(caller, status);
+							}
+						}, monitor);
+					} else {
+						callback.setResult(Boolean.FALSE);
+						callback.done(this, Status.OK_STATUS);
+					}
+				}
+			});
+		} else {
+			callback.setResult(Boolean.FALSE);
+			callback.done(null, Status.OK_STATUS);
+		}
+	}
+
+	/**
+	 * Stops the simulator if the simulator launch is enabled for the given peer
+	 * model node and the configured simulator service type is available. In any
+	 * other cases, the given callback is invoked immediately.
+	 *
+	 * @param peerModel The peer model node. Must not be <code>null</code>.
+	 * @param monitor The progress monitor.
+	 * @param callback The callback to invoke if finished. Must not be <code>null</code>.
+	 */
+	public static void stop(final IPeerModel peerModel, final IProgressMonitor monitor, final ICallback callback) {
+		Assert.isNotNull(peerModel);
+		Assert.isNotNull(callback);
+
+		// Get the associated simulator service
+		final Result result = getSimulatorService(peerModel);
+		if (result != null && result.service != null) {
+			// Determine if the simulator is at all running
+			result.service.isRunning(peerModel, result.settings, new Callback() {
+				@Override
+				protected void internalDone(Object caller, IStatus status) {
+					Object cbResult = getResult();
+					if (cbResult instanceof Boolean && ((Boolean)cbResult).booleanValue()) {
+						// Stop the simulator
+						result.service.stop(peerModel, result.settings, new Callback(callback) {
+							@Override
+							protected void internalDone(Object caller, IStatus status) {
+								callback.done(caller, status);
+							}
+						}, monitor);
+					} else {
+						callback.done(null, Status.OK_STATUS);
+					}
+				}
+			});
+		} else {
+			callback.done(null, Status.OK_STATUS);
+		}
+	}
+}