From 58fb2ec9ce82bd3e3498f92f27d07b16ad0b33f6 Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Wed, 8 Nov 2006 16:43:12 +0000 Subject: [PATCH] bug 162177 - Rename additional occurrences of ISystem -> IConnectorService --- .../guide/plugin/subsystem.html | 4 ++-- .../DeveloperConnectorServiceManager.html | 2 +- .../DeveloperConnectorServiceManager.java | 2 +- .../subsystems/ISubSystemConfigurationProxy.java | 2 +- .../core/subsystems/RemoteFileSubSystem.java | 3 ++- rse/plugins/org.eclipse.rse.ui/plugin.xml | 11 ++++++----- .../subsystems/SubSystemConfigurationProxy.java | 6 +++--- .../core/subsystems/AbstractConnectorService.java | 2 +- .../eclipse/rse/core/subsystems/SubSystem.java | 15 ++++++++------- .../core/subsystems/SubSystemConfiguration.java | 2 +- 10 files changed, 26 insertions(+), 23 deletions(-) diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/plugin/subsystem.html b/rse/doc/org.eclipse.rse.doc.isv/guide/plugin/subsystem.html index 0eb6b549063..7d9d7545cc8 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/plugin/subsystem.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/plugin/subsystem.html @@ -158,9 +158,9 @@ following summarizes the minimum set of classes you will be creating in order to
  1. Creating an interface for your subsystem. It can, and often is, an empty interface.
  2. Creating a subclass of AbstractConnectorService. - The code here will interact as necessary with your subsystem to manage the live connection to the remote system.
    3. + The code here will interact as necessary with your subsystem to manage the connection lifecycle to the remote system.
  3. Creating a subclass of AbstractConnectorServiceManager. - The code here will re-use the same system object from step 2 for all subsystems that implement the interface from step 1, within the same connection.
    4. + The code here will re-use the same IConnectorService object from step 2 for all subsystems that implement the interface from step 1, within the same connection.
  4. Designing the classes to represent the remote resources (your model) that you will show from your subsystem. Each must implement the org.eclipse.core.runtime.IAdaptable interface from Eclipse. It is also very helpful if they also maintain a reference to the subsystem which created them. The base class diff --git a/rse/doc/org.eclipse.rse.doc.isv/guide/tutorial/DeveloperConnectorServiceManager.html b/rse/doc/org.eclipse.rse.doc.isv/guide/tutorial/DeveloperConnectorServiceManager.html index 7e06dadb62e..69fe7749e6d 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/guide/tutorial/DeveloperConnectorServiceManager.html +++ b/rse/doc/org.eclipse.rse.doc.isv/guide/tutorial/DeveloperConnectorServiceManager.html @@ -38,7 +38,7 @@ import org.eclipse.rse.core.model.IHost; /** * This class manages our DeveloperConnectorService objects, so that if we * ever have multiple subsystem configurations, different subsystems can share - * the same system object if they share the communication layer. + * the same IConnectorService object if they share the communication layer. */ public class DeveloperConnectorServiceManager extends AbstractConnectorServiceManager { diff --git a/rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperConnectorServiceManager.java b/rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperConnectorServiceManager.java index 5bcaec775c1..5c61f70eed0 100644 --- a/rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperConnectorServiceManager.java +++ b/rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperConnectorServiceManager.java @@ -24,7 +24,7 @@ import org.eclipse.rse.core.subsystems.ISubSystem; /** * This class manages our DeveloperConnectorService objects, so that if we * ever have multiple subsystem factories, different subsystems can share - * the same system object if they share the communication layer. + * the same IConnectorService object if they share the communication layer. */ public class DeveloperConnectorServiceManager extends AbstractConnectorServiceManager { diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfigurationProxy.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfigurationProxy.java index f7d94ea1f78..388a0df0a39 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfigurationProxy.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/ISubSystemConfigurationProxy.java @@ -75,7 +75,7 @@ public interface ISubSystemConfigurationProxy */ public ISubSystemConfiguration getSubSystemConfiguration(); // /** -// * Return an instance of the ISystem class identified by the "systemClass" attribute +// * Return an instance of the IConnectorService class identified by the "systemClass" attribute // * of this subsystemFactory extension point. Note each call to this method returns a // * new instance of the class, or null if no "systemClass" attribute was specified. // */ diff --git a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/subsystems/RemoteFileSubSystem.java b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/subsystems/RemoteFileSubSystem.java index b77acea14fa..a3e6fd1151a 100644 --- a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/subsystems/RemoteFileSubSystem.java +++ b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/subsystems/RemoteFileSubSystem.java @@ -135,7 +135,8 @@ public abstract class RemoteFileSubSystem extends SubSystem implements IRemoteFi _searchHistory = new ArrayList(); } /** - * @return true if this subsystem's properties should take precedence over other subsystems that share the same ISystem + * @return true if this subsystem's properties should take precedence + * over other subsystems that share the same {@link IConnectorService} */ public boolean isPrimarySubSystem() { diff --git a/rse/plugins/org.eclipse.rse.ui/plugin.xml b/rse/plugins/org.eclipse.rse.ui/plugin.xml index ced9cbe67c1..d65e38e86f4 100644 --- a/rse/plugins/org.eclipse.rse.ui/plugin.xml +++ b/rse/plugins/org.eclipse.rse.ui/plugin.xml @@ -54,13 +54,14 @@ Contributors: - + + - - - + + + - + diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/internal/subsystems/SubSystemConfigurationProxy.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/internal/subsystems/SubSystemConfigurationProxy.java index 27f04e11e4f..ba8794b78ff 100644 --- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/internal/subsystems/SubSystemConfigurationProxy.java +++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/internal/subsystems/SubSystemConfigurationProxy.java @@ -294,7 +294,7 @@ public class SubSystemConfigurationProxy implements ISubSystemConfigurationProxy return object; } // /** -// * Return an instance of the ISystem class identified by the "systemClass" attribute +// * Return an instance of the IConnectorService class identified by the "systemClass" attribute // * of this subsystemFactory extension point. Note each call to this method returns a // * new instance of the class, or null if no "systemClass" attribute was specified. // */ @@ -308,10 +308,10 @@ public class SubSystemConfigurationProxy implements ISubSystemConfigurationProxy // object = (IConnectorService)element.createExecutableExtension("systemClass"); // } catch (Exception exc) // { -// SystemBasePlugin.logError("Unable to instantiate ISystem class "+ systemClassName + " for extension point " + id,exc); +// SystemBasePlugin.logError("Unable to instantiate IConnectorService class "+ systemClassName + " for extension point " + id,exc); // org.eclipse.swt.widgets.MessageBox mb = new org.eclipse.swt.widgets.MessageBox(SystemBasePlugin.getActiveWorkbenchShell()); // mb.setText("Unexpected Error"); -// String errmsg = "Unable to instantiate ISystem class " + systemClassName + " for extension point " + id +": " + exc.getClass().getName()+" - " + exc.getMessage(); +// String errmsg = "Unable to instantiate IConnectorService class " + systemClassName + " for extension point " + id +": " + exc.getClass().getName()+" - " + exc.getMessage(); // mb.setMessage(errmsg); // mb.open(); // } diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/AbstractConnectorService.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/AbstractConnectorService.java index b1cfa64e69d..33635b540cd 100644 --- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/AbstractConnectorService.java +++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/AbstractConnectorService.java @@ -1028,7 +1028,7 @@ public abstract class AbstractConnectorService extends RSEModelObject implements // * You normally do not call this! Rather, your subsystem factory class will override // * {@link org.eclipse.rse.core.subsystems.SubSystemConfiguration#supportsServerLaunchType(ServerLaunchType)}. // * However, this method is needed by ISVs that re-use predefined subsystem factories, -// * and merely supply their own ISystem object via the "systemClass" attribute of the +// * and merely supply their own IConnectorService object via the "systemClass" attribute of the // * subsystemConfigurations extension point. // * // * @see org.eclipse.rse.core.subsystems.ServerLaunchType diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystem.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystem.java index 3540688415b..15e86e33ea3 100644 --- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystem.java +++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystem.java @@ -2473,7 +2473,7 @@ public abstract class SubSystem extends RSEModelObject implements IAdaptable, IS } /** - * This gets called after the corresponding ISystem connect method finishes. + * This gets called after the corresponding {@link IConnectorService} connect method finishes. * This method should be overridden if any initialization for the subsystem needs * to occur at this time */ @@ -2707,15 +2707,15 @@ public abstract class SubSystem extends RSEModelObject implements IAdaptable, IS // ---------------------------------- /** - * Return the {@link org.eclipse.rse.core.subsystems.IConnectorService ISystem} object that represents the live connection for this system. - * This must return an object that implements ISystem. A good starting point for that + * Return the {@link org.eclipse.rse.core.subsystems.IConnectorService IConnectorService} object that represents the live connection for this system. + * This must return an object that implements {@link IConnectorService}. A good starting point for that * is the base class {@link AbstractConnectorService}. *

    If you only have a single subsystem class, you may override this method to return the - * ISystem object that manages the connect/disconnect actions. If, on the other hand, - * you have multiple subsystem classes that desire to share a single ISystem connection, + * IConnectorService object that manages the connect/disconnect actions. If, on the other hand, + * you have multiple subsystem classes that desire to share a single IConnectorService connection, * (ie, share the same communications pipe) then do not override this. By default, this * calls getSystemManager() which returns an {@link AbstractConnectorServiceManager} object that manages maintaining a singleton - * ISystem object per system connection. You should subclass AbstractSystemManager, + * IConnectorService object per system connection. You should subclass AbstractSystemManager, * and override getSystemManager() to return a singleton instance of that subclass. *

    Default implementation:

    * 
    
@@ -3231,7 +3231,8 @@ public abstract class SubSystem extends RSEModelObject implements IAdaptable, IS
 
 	
 	/**
-	 * @return true if this subsystem's properties should take precedence over other subsystems that share the same ISystem
+	 * @return true if this subsystem's properties should take precedence
+	 *  over other subsystems that share the same IConnectorService
 	 */
 	public boolean isPrimarySubSystem()
 	{
diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
index afce6cc3998..2d1d6fc2c21 100644
--- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
+++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
@@ -1503,7 +1503,7 @@ public abstract class SubSystemConfiguration  implements ISubSystemConfiguration
 		// fire model change event in case any BP code is listening...
 		RSEUIPlugin.getTheSystemRegistry().fireModelChangeEvent(ISystemModelChangeEvents.SYSTEM_RESOURCE_CHANGED, ISystemModelChangeEvents.SYSTEM_RESOURCETYPE_SUBSYSTEM, subsystem, null);						
 
-		// if the updated subsystem is one of many that share a single ISystem, then 
+		// if the updated subsystem is one of many that share a single IConnectorService, then 
 		// update all of them too...
 		// DKM - now that ConnectorService is independent of subsystme, this should be unnecessary
 	/*	AbstractConnectorServiceManager systemManager = subsystem.getConnectorService();