Eclipse RSE Development Guide
Previous Page	Home	Next Page

---

RSE System Types

Identifier:

org.eclipse.rse.core.systemTypes

Description:

This extension point is used in combination with the "org.eclipse.rse.core.subsystemConfigurations" extension point for defining new subsystems, which appear under a connection when it is expanded in the Remote Systems view. The systemTypes extension point allows subsystem providers to define a new system type that appears in the list of valid system types in the New Connection wizard, used by users when defining a new connection to a remote system. The system type is simply a string identifying the operating system type, such as Solaris, and an pair of icons used to identify connections to systems of this type. One icon is used when the connection is not connected, while the other is used when there is a live connection.

Configuration Markup:

<!ELEMENT extension ( systemType+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>

(no description available)

<!ELEMENT systemType ( property)*>

<!ATTLIST systemType

id                        CDATA #REQUIRED

name                      CDATA #REQUIRED

label                     CDATA #REQUIRED

description               CDATA #IMPLIED

icon                      CDATA #IMPLIED

iconLive                  CDATA #IMPLIED

enableOffline             (true | false)

subsystemConfigurationIds CDATA #IMPLIED

>

This element defines a remote system type like "Linux", against which subsystem configurations can be registered.

• id - A unique identifier for this extension.
• name - The display name for the system type, such as "Solaris". This name is also currently used as internal identifier when referencing the system type in filters, subsystem configurations and similar, therefore it is not translatable. Future versions of RSE may change this and reference the systemType id instead of the name.

  Deprecated: Use system type id to specify a unique identifier and system type label to specify a translatable UI label.

  RSE pre-defines a number of system types, although they may not appear unless a subsystem configuration is registered against that type. These are the supplied system types:

  • Local
  • Unix
  • Linux

• label - A label used in the UI to identify the system type besides the system type icon.
• description - A short description of the system type. Shows up in preferences for system type.
• icon - A relative path to an icon that will be used when displaying connections to systems of this type. If not specified, a default icon will be used by RSE.
• iconLive - A relative path to an icon that will be used when displaying connections to systems of this type, when there is a live connection to the remote system. This is usually a derivation of the icon attribute, adorned with a bright green arrow. If not specified, a default icon will be used by RSE.
• enableOffline - Whether this system type can be put in offline mode. This decides whether to show the Work Offline action for connections of this type. This is an optional attribute, the default value is false.
• subsystemConfigurationIds - A semicolon separated list of fully qualified subsystem configuration ids this system type wants to get registered against.

  Note: The list specified here does not imply that the corresponding subsystem configurations exist. The list contains only possibilites, not requirements.

<!ELEMENT property EMPTY>

<!ATTLIST property

name  CDATA #REQUIRED

value CDATA #REQUIRED

>

On optional property for the system type. The following property keys are already used internally, and are thus reserved:

• "icon" to store the value of the icon attribute
• "iconLive" to store the value of the iconLive attribute
• "enableOffline" to store the value of the enableOffline attribute
• "isCaseSensitive" for system types with a case sensitive file system
• "isLocal" for system types that refer to the local system
• "isWindows" for system types that refer to a Windows kind of system (case insensitive file system with drive letters)

In general, clients can use any own properties with system types, but should use reverse DNS notation to qualify their property keys (e.g. com.acme.isFoobarSystem. Property keys without qualifying namespace are reserved for RSE internal use. See also class IRSESystemType, methods getProperty() and testProperty().

• name -
• value -

Examples:

The following is an example of the extension point schema:

  <extension point=
"org.eclipse.rse.core.systemTypes"
>
      <systemType id=
"com.acme.systemtype.Solaris"

            name=
"Solaris"

            description=
"Connects to Solaris systems."

      icon=
"icons/solaris.gif"

      iconLive=
"icons/solarisLive.gif"
>
   </systemType>
  </extension>

Supplied Implementation:

See the plugin.xml file for plugin org.eclipse.rse.ui for examples of using this extension point.

Copyright (c) 2002, 2007 IBM Corporation 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 https://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation Martin Oberhuber (Wind River) - [186523] Move subsystemConfigurations from UI to core