Eclipse RSE Development Guide (Galileo) - IRSESystemType (RSE API Specification)

Field Summary

static String PROPERTY_IS_CASE_SENSITIVE
          System type Property Key (value: "isCaseSensitive") indicating whether a given system type is in general case sensitive.

static String PROPERTY_IS_LOCAL
          System type Property Key (value: "isLocal") indicating whether a system type is declared in plugin.xml to refers to the local system.

static String PROPERTY_IS_WINDOWS
          System type Property Key (value: "isWindows") indicating whether a system type is declared in plugin.xml to refers to a Windows system.

static String PROPERTY_SUPPORTS_ENCODING
          System type Property Key (value: "supportsEncoding") indicating whether a given system type supports the user specifying an encoding to use for translating binary data to Java Unicode Strings when working on subsystems.

static String SYSTEMTYPE_AIX
          Deprecated. Use SYSTEMTYPE_AIX_ID.

static String SYSTEMTYPE_AIX_ID
          AIX system type, "org.eclipse.rse.systemtype.aix".

static String SYSTEMTYPE_DISCOVERY_ID
          Discovery system type, "org.eclipse.rse.systemtype.discovery".

static String SYSTEMTYPE_FTP_ONLY_ID
          FTP Only system type, "org.eclipse.rse.systemtype.ftp".

static String SYSTEMTYPE_ISERIES
          Deprecated. Use SYSTEMTYPE_ISERIES_ID.

static String SYSTEMTYPE_ISERIES_ID
          iSeries system type, "org.eclipse.rse.systemtype.iseries".

static String SYSTEMTYPE_LINUX
          Deprecated. Use SYSTEMTYPE_LINUX_ID.

static String SYSTEMTYPE_LINUX_ID
          Linux system type, "org.eclipse.rse.systemtype.linux".

static String SYSTEMTYPE_LOCAL
          Deprecated. Use SYSTEMTYPE_LOCAL_ID.

static String SYSTEMTYPE_LOCAL_ID
          Local system type, "org.eclipse.rse.systemtype.local".

static String SYSTEMTYPE_PASE
          Deprecated. Use SYSTEMTYPE_PASE_ID.

static String SYSTEMTYPE_PASE_ID
          PASE system type, "org.eclipse.rse.systemtype.PASE".

static String SYSTEMTYPE_POWER_LINUX
          Deprecated. Use SYSTEMTYPE_POWER_LINUX_ID.

static String SYSTEMTYPE_POWER_LINUX_ID
          Power Linux type, "org.eclipse.rse.systemtype.linux.power".

static String SYSTEMTYPE_SSH_ONLY_ID
          SSH Only system type, "org.eclipse.rse.systemtype.ssh".

static String SYSTEMTYPE_TELNET_ONLY_ID
          Telnet Only system type, "org.eclipse.rse.systemtype.telnet".

static String SYSTEMTYPE_UNIX
          Deprecated. Use SYSTEMTYPE_UNIX_ID.

static String SYSTEMTYPE_UNIX_ID
          Unix system type, "org.eclipse.rse.systemtype.unix".

static String SYSTEMTYPE_WINDOWS
          Deprecated. Use SYSTEMTYPE_WINDOWS_ID.

static String SYSTEMTYPE_WINDOWS_ID
          Windows system type, "org.eclipse.rse.systemtype.windows".

static String SYSTEMTYPE_ZSERIES
          Deprecated. Use SYSTEMTYPE_ZSERIES_ID.

static String SYSTEMTYPE_ZSERIES_ID
          z/OS system type, "org.eclipse.rse.systemtype.zseries".

static String SYSTEMTYPE_ZSERIES_LINUX
          Deprecated. Use SYSTEMTYPE_ZSERIES_LINUX_ID.

static String SYSTEMTYPE_ZSERIES_LINUX_ID
          Power Linux type, "org.eclipse.rse.systemtype.linux.zseries".

Method Summary

IHost createNewHostInstance ( ISystemProfile profile)
          Creates a new IHost object instance.

Bundle getDefiningBundle ()
          Returns the bundle which is responsible for the definition of this system type.

String getDescription ()
          Returns the description of the system type.

String getId ()
          Returns the id of the system type.

String getLabel ()
          Returns the translatable label for use in the UI.

String getName ()
          Deprecated. Use getId() for accessing the unique id or getLabel() for the UI label.

String getProperty ( String key)
          Returns the property of this system type with the given key.

String[] getSubsystemConfigurationIds ()
          Returns a list of fully qualified known subsystem configuration id's that this system type wants to be registered against.

boolean isEnabled ()
          Tests whether the system type is currently enabled.

boolean isLocal ()
          Tests whether the system type refers to the local system.

boolean isWindows ()
          Tests whether the system type refers to the Windows system.

boolean testProperty ( String key, boolean expectedValue)
          Tests whether the given boolean property matches the expected value for this system type.

Methods inherited from interface org.eclipse.core.runtime. IAdaptable

getAdapter

Field Detail

SYSTEMTYPE_LINUX

static final 
String SYSTEMTYPE_LINUX

Deprecated. Use SYSTEMTYPE_LINUX_ID.

Linux system type, "Linux".

See Also:: Constant Field Values

SYSTEMTYPE_LINUX_ID

static final 
String SYSTEMTYPE_LINUX_ID

Linux system type, "org.eclipse.rse.systemtype.linux".

See Also:: Constant Field Values

SYSTEMTYPE_POWER_LINUX

static final 
String SYSTEMTYPE_POWER_LINUX

Deprecated. Use SYSTEMTYPE_POWER_LINUX_ID.

Power Linux type, "Power Linux".

See Also:: Constant Field Values

SYSTEMTYPE_POWER_LINUX_ID

static final 
String SYSTEMTYPE_POWER_LINUX_ID

Power Linux type, "org.eclipse.rse.systemtype.linux.power".

See Also:: Constant Field Values

SYSTEMTYPE_ZSERIES_LINUX

static final 
String SYSTEMTYPE_ZSERIES_LINUX

Deprecated. Use SYSTEMTYPE_ZSERIES_LINUX_ID.

Power Linux type, "zSeries Linux".

See Also:: Constant Field Values

SYSTEMTYPE_ZSERIES_LINUX_ID

static final 
String SYSTEMTYPE_ZSERIES_LINUX_ID

Power Linux type, "org.eclipse.rse.systemtype.linux.zseries".

See Also:: Constant Field Values

SYSTEMTYPE_UNIX

static final 
String SYSTEMTYPE_UNIX

Deprecated. Use SYSTEMTYPE_UNIX_ID.

Unix system type, "Unix".

See Also:: Constant Field Values

SYSTEMTYPE_UNIX_ID

static final 
String SYSTEMTYPE_UNIX_ID

Unix system type, "org.eclipse.rse.systemtype.unix".

See Also:: Constant Field Values

SYSTEMTYPE_AIX

static final 
String SYSTEMTYPE_AIX

Deprecated. Use SYSTEMTYPE_AIX_ID.

AIX system type, "AIX".

See Also:: Constant Field Values

SYSTEMTYPE_AIX_ID

static final 
String SYSTEMTYPE_AIX_ID

AIX system type, "org.eclipse.rse.systemtype.aix".

See Also:: Constant Field Values

SYSTEMTYPE_PASE

static final 
String SYSTEMTYPE_PASE

Deprecated. Use SYSTEMTYPE_PASE_ID.

PASE system type, "PASE".

See Also:: Constant Field Values

SYSTEMTYPE_PASE_ID

static final 
String SYSTEMTYPE_PASE_ID

PASE system type, "org.eclipse.rse.systemtype.PASE".

See Also:: Constant Field Values

SYSTEMTYPE_ISERIES

static final 
String SYSTEMTYPE_ISERIES

Deprecated. Use SYSTEMTYPE_ISERIES_ID.

iSeries system type, "iSeries".

See Also:: Constant Field Values

SYSTEMTYPE_ISERIES_ID

static final 
String SYSTEMTYPE_ISERIES_ID

iSeries system type, "org.eclipse.rse.systemtype.iseries".

See Also:: Constant Field Values

SYSTEMTYPE_LOCAL

static final 
String SYSTEMTYPE_LOCAL

Deprecated. Use SYSTEMTYPE_LOCAL_ID.

Local system type, "Local".

See Also:: Constant Field Values

SYSTEMTYPE_LOCAL_ID

static final 
String SYSTEMTYPE_LOCAL_ID

Local system type, "org.eclipse.rse.systemtype.local".

See Also:: Constant Field Values

SYSTEMTYPE_ZSERIES

static final 
String SYSTEMTYPE_ZSERIES

Deprecated. Use SYSTEMTYPE_ZSERIES_ID.

z/OS system type, "z/OS".

See Also:: Constant Field Values

SYSTEMTYPE_ZSERIES_ID

static final 
String SYSTEMTYPE_ZSERIES_ID

z/OS system type, "org.eclipse.rse.systemtype.zseries".

See Also:: Constant Field Values

SYSTEMTYPE_WINDOWS

static final 
String SYSTEMTYPE_WINDOWS

Deprecated. Use SYSTEMTYPE_WINDOWS_ID.

Windows system type, "Windows".

See Also:: Constant Field Values

SYSTEMTYPE_WINDOWS_ID

static final 
String SYSTEMTYPE_WINDOWS_ID

Windows system type, "org.eclipse.rse.systemtype.windows".

See Also:: Constant Field Values

SYSTEMTYPE_DISCOVERY_ID

static final 
String SYSTEMTYPE_DISCOVERY_ID

Discovery system type, "org.eclipse.rse.systemtype.discovery".

See Also:: Constant Field Values

SYSTEMTYPE_FTP_ONLY_ID

static final 
String SYSTEMTYPE_FTP_ONLY_ID

FTP Only system type, "org.eclipse.rse.systemtype.ftp".

See Also:: Constant Field Values

SYSTEMTYPE_SSH_ONLY_ID

static final 
String SYSTEMTYPE_SSH_ONLY_ID

SSH Only system type, "org.eclipse.rse.systemtype.ssh".

See Also:: Constant Field Values

SYSTEMTYPE_TELNET_ONLY_ID

static final 
String SYSTEMTYPE_TELNET_ONLY_ID

Telnet Only system type, "org.eclipse.rse.systemtype.telnet".

See Also:: Constant Field Values

PROPERTY_IS_LOCAL

static final 
String PROPERTY_IS_LOCAL

System type Property Key (value: "isLocal") indicating whether a system type is declared in plugin.xml to refers to the local system. On a the local system, the following properties are expected:

Subsystem Queries are fast and safe.
Files in the file system can be converted to java.io.File.

See Also:: testProperty(String, boolean), Constant Field Values

PROPERTY_IS_WINDOWS

static final 
String PROPERTY_IS_WINDOWS

System type Property Key (value: "isWindows") indicating whether a system type is declared in plugin.xml to refers to a Windows system.

This is an "aggregate" property consisting of several smaller properties like isCaseSensitive. In the future, we'll want more fine granular properties to check against. On a Windows system, the following properties are expected:

File system is not case sensitive
File system has root drives
Symbolic links are not supported
"cmd" is used as the default shell, meaning that %envVar% refers to environment variables
Path separator is backslash (\)
Line end character is CRLF
Valid characters in file names and paths as known on Windows

See Also:: testProperty(String, boolean), Constant Field Values

PROPERTY_IS_CASE_SENSITIVE

static final 
String PROPERTY_IS_CASE_SENSITIVE

System type Property Key (value: "isCaseSensitive") indicating whether a given system type is in general case sensitive.

See Also:: testProperty(String, boolean), Constant Field Values

PROPERTY_SUPPORTS_ENCODING

static final 
String PROPERTY_SUPPORTS_ENCODING

System type Property Key (value: "supportsEncoding") indicating whether a given system type supports the user specifying an encoding to use for translating binary data to Java Unicode Strings when working on subsystems. It is up to the subsystems registered against a given system type whether they observe the system type's setting or not; the default implementations do observe it. Given that all subsystem configurations registered against a given system type do not support encodings, the corresponding RSE controls for allowing the user to change encodings will be disabled. Expected default value of this Property is "true" if not set.

Since:: org.eclipse.rse.core 3.0
See Also:: ISubSystemConfiguration.supportsEncoding(IHost), Constant Field Values

Method Detail

getId


String getId()

Returns the id of the system type.

Returns:: the id of the system type

getLabel


String getLabel()

Returns the translatable label for use in the UI.

Returns:: The UI label or null if not set.

getName


String getName()

Deprecated. Use getId() for accessing the unique id or getLabel() for the UI label.

Returns the name of the system type.

Returns:: the name of the system type

getDescription


String getDescription()

Returns the description of the system type.

Returns:: the description of the system type

getProperty


String getProperty(
String key)

Returns the property of this system type with the given key. null is returned if there is no such key/value pair.

Parameters:: key - the name of the property to return
Returns:: the value associated with the given key or null if none

testProperty

boolean testProperty(
String key,
                     boolean expectedValue)

Tests whether the given boolean property matches the expected value for this system type. Clients can use their 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.

Parameters:: key - the name of the property to return; expectedValue - the expected boolean value of the property.
Returns:: true if the Property is set on the system type and matches the expected value. Returns false if the property is not set or does not match.

isEnabled

boolean isEnabled()

Tests whether the system type is currently enabled. The enabled state is a dynamic property of a system type, compared to the static configuration by plugin markup. Enablement is a non-UI property, which can be set by a Product in the Preferences or modified by a user to hide certain system types.

Implementers of custom system types (which are registered by a SystemTypeProvider) can override this method to provide more advanced enabled checks e.g. based on license availability.

Returns:: true if the system type is currently enabled, or false otherwise.
Since:: org.eclipse.rse.core 3.0

isLocal

boolean isLocal()

Tests whether the system type refers to the local system. This is a shortcut for

   getId().equals(SYSTEMTYPE_LOCAL_ID) ||
   || testProperty(PROPERTY_IS_LOCAL, true)

See PROPERTY_IS_LOCAL for properties expected on a Local system. Extenders (contributors of custom system types) may override.

Returns:: true if the system type refers to the local system.

isWindows

boolean isWindows()

Tests whether the system type refers to the Windows system. This is a shortcut for

   getId().equals(SYSTEMTYPE_WINDOWS_ID)
   || isLocal() && System.getProperty("os.name").toLowerCase().startsWith("win")
   || testProperty(PROPERTY_IS_WINDOWS, true)

See PROPERTY_IS_WINDOWS for properties expected on a Windows system. This is an "aggregate" property consisting of several smaller properties like isCaseSensitive. In the future, we'll want more fine granular properties to check against. Extenders (contributors of custom system types) may override.

Returns:: true if the system type refers to a Windows system.

getDefiningBundle


Bundle getDefiningBundle()

Returns the bundle which is responsible for the definition of this system type. Typically this is used as a base for searching for images and other files that are needed in presenting the system type.

Returns:: the bundle which defines this system type or null if none

getSubsystemConfigurationIds


String[] getSubsystemConfigurationIds()

Returns a list of fully qualified known subsystem configuration id's that this system type wants to be registered against. More subsystem configurations can be added through the subsystemConfigurations extension point.

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

Returns:: The list of subsystem configuration id's. May be empty, but never null.

createNewHostInstance


IHost createNewHostInstance(
ISystemProfile profile)

Creates a new IHost object instance. This method is called from SystemHostPool.createHost(IRSESystemType, String, String, String, String, int).

Parameters:: profile - The system profile to associate with the host.
Returns:: A new IHost object instance.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core Interface IRSESystemType