Subsystem Configurations

org.eclipse.rse.ui.subsystemConfigurations

This extension point allows tool-writers to extend the capability of the Remote System Explorer, by identifying a subsystem configuration that produces a subsystem whenever a new connection is created. This subsystem appears under the connection when it is expanded in the Remote Systems view of the Remote System Explorer perspective. The subsystem configuration is called by the Remote System framework when the user creates a new connection, when the connection's system type is one of the types identified as supported by this subsystem configuration extension.

There is one subsystem object per connection, and the role of a subsystem is to allow users to work with remote resources for the remote system identified by the containing connection. Defining a subsystem configuration involves more than the single subsystem configuration class. There must also be a subsystem class defined, and a system class defined. There may also be other classes defined, such as classes for the content area of wizards for defining filters, user actions and compile commands, if the subsystem configuration wishes to support these. See the developer documentation for the Remote System Explorer for documentation details on defining subsystems.

<!ELEMENT extension (configuration+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

(no description available)

<!ELEMENT configuration EMPTY>

<!ATTLIST configuration

id CDATA #REQUIRED

vendor CDATA #REQUIRED

icon CDATA #REQUIRED

iconlive CDATA #REQUIRED

class CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #REQUIRED

systemTypes CDATA #IMPLIED

category CDATA #IMPLIED

priority CDATA #IMPLIED>

This element defines a subsystem configuration to the Remote System Explorer framework.

id - A unique ID for this subsystem configuration. This will be used by persistency as a folder name for information contained by the subsystem configuration, or by any of its subsystems.
vendor - Name of the vendor supplying this subsystem configuration.
icon - The icon to dipslay for subsystems of this configuration, when not connected. Specify the path of the .gif file, relative to your plugin directory.
iconlive - The icon to display for subsystems of this configuration, when there is a live connection. This is usually derived from the normal icon, but adorned with a bright green arrow. Specify a path to the icon's .gif file, relative to your plugin directory.
class - A class that implements org.eclipse.rse.core.subsystems.ISubSystemConfiguration. It is recommended to extend org.eclipse.rse.core.subsystems.SubSystemConfiguration or org.eclipse.rse.core.servicesubsystem.ServiceSubSystemConfiguration.
name - Translatable name for subsystems created by this configuration. These appear immediately under a connection when the connection is expanded in the Remote Systems view of the Remote System Explorer perspective.
description - Translatable description for subsystems created by this configuration. These appear in configuration and properties pages for subsystems.
systemTypes - A semicolon separated list of system type names that subsystems from this configuration support. For example, "Unix;Linux". If not specified, defaults to all system types.
category - This optional attribute allows subsystem providers to classify the type of remote resources that are listed by this subsystem configuration. It is possible for multiple subsystem factories to support the same remote resource category. This category is used in the popupMenus and propertyPages extension points, to scope actions and property pages to only remote resources of a particular category, via their subsystemconfigurationCategory attribute. For example, if listing database resources you might specify a category of "database".
priority - This optional attribute determines the order in which subsystems appear in the New Connection wizard and RSE views. Integer values are allowed. Subsystems with lower number will appear first in the RSE tree. Subsystems that do not define the priority attribute will be appended last to the list of subsystems. Note that ServiceSubSystems that share the same service should always use the same priority, since their service implementation can change at runtime. The following priorities are used by the predefined subsystems: files=100, processes=200, shells=300.

Example of using this extension point:

   <extension 
      point=
"org.eclipse.rse.ui.subsystemConfigurations"
>
      <configuration
         systemTypes=
"Unix;Linux;Local"
 
         name=
"Databases"

         icon=
"icons/dbsubsys.gif"
 
         iconlive=
"icons/dbsubsyslive.gif"

         id=
"com.acme.tools.mypkg.myconfiguration"

         class=
"com.acme.tools.db.DBSubSystemFactory"

         category=
"databases"

         vendor=
"ACME"

      >
     </configuration>
   </extension>

Defining the xml for the extension point is easy. There is a fair amount to know about creating the classes needed for a subsystem configuration, however. For this information, consult the Remote System Explorer developer documention, including the JavaDoc for the supplied classes and interfaces for this task.

The provider of subsystem factories must implement the interface org.eclipse.rse.core.subsystems.ISubSystemConfiguration, although it is not recommended to create a new class from scratch. Rather, it is highly recommended to use the supplied base class org.eclipse.rse.core.subsystems.SubSystemConfiguration. This base class pre-supplies much functionality, including support for persisting properties and metadata, and support for filters.

All supplied subsystems are implemented via use of this extension point. See the plugin.xml files for plugins org.eclipse.rse.subsystems.files.dstore and org.eclipse.rse.subsystems.processes.dstore for examples.

Copyright (c) 2002, 2006 IBM 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: IBM Corporation - initial API and implementation

Subsystem Configurations

Identifier:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: