|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRSESystemType
Interface for a system type. Constants are defined for various system types. These constants are kept in sync with definitions in plugin.xml.
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 |
---|
static final String SYSTEMTYPE_LINUX
SYSTEMTYPE_LINUX_ID
.
static final String SYSTEMTYPE_LINUX_ID
static final String SYSTEMTYPE_POWER_LINUX
SYSTEMTYPE_POWER_LINUX_ID
.
static final String SYSTEMTYPE_POWER_LINUX_ID
static final String SYSTEMTYPE_ZSERIES_LINUX
SYSTEMTYPE_ZSERIES_LINUX_ID
.
static final String SYSTEMTYPE_ZSERIES_LINUX_ID
static final String SYSTEMTYPE_UNIX
SYSTEMTYPE_UNIX_ID
.
static final String SYSTEMTYPE_UNIX_ID
static final String SYSTEMTYPE_AIX
SYSTEMTYPE_AIX_ID
.
static final String SYSTEMTYPE_AIX_ID
static final String SYSTEMTYPE_PASE
SYSTEMTYPE_PASE_ID
.
static final String SYSTEMTYPE_PASE_ID
static final String SYSTEMTYPE_ISERIES
SYSTEMTYPE_ISERIES_ID
.
static final String SYSTEMTYPE_ISERIES_ID
static final String SYSTEMTYPE_LOCAL
SYSTEMTYPE_LOCAL_ID
.
static final String SYSTEMTYPE_LOCAL_ID
static final String SYSTEMTYPE_ZSERIES
SYSTEMTYPE_ZSERIES_ID
.
static final String SYSTEMTYPE_ZSERIES_ID
static final String SYSTEMTYPE_WINDOWS
SYSTEMTYPE_WINDOWS_ID
.
static final String SYSTEMTYPE_WINDOWS_ID
static final String SYSTEMTYPE_DISCOVERY_ID
static final String SYSTEMTYPE_FTP_ONLY_ID
static final String SYSTEMTYPE_SSH_ONLY_ID
static final String SYSTEMTYPE_TELNET_ONLY_ID
static final String PROPERTY_IS_LOCAL
testProperty(String, boolean)
,
Constant Field Valuesstatic final String PROPERTY_IS_WINDOWS
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:
testProperty(String, boolean)
,
Constant Field Valuesstatic final String PROPERTY_IS_CASE_SENSITIVE
testProperty(String, boolean)
,
Constant Field Valuesstatic final String PROPERTY_SUPPORTS_ENCODING
ISubSystemConfiguration.supportsEncoding(IHost)
,
Constant Field ValuesMethod Detail |
---|
String getId()
String getLabel()
null
if not set.String getName()
getId()
for accessing the unique id or getLabel()
for the UI label.
String getDescription()
String getProperty(String key)
null
is returned if there is no such key/value pair.
key
- the name of the property to return
null
if noneboolean testProperty(String key, boolean expectedValue)
com.acme.isFoobarSystem
. Property keys without qualifying
namespace are reserved for RSE internal use.
key
- the name of the property to returnexpectedValue
- the expected boolean value of the property.
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.boolean isEnabled()
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.
true
if the system type is currently enabled, or
false
otherwise.boolean isLocal()
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.
boolean isWindows()
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.
Bundle getDefiningBundle()
null
if noneString[] getSubsystemConfigurationIds()
Note: The list returned here does not imply that the corresponding subsystem configurations exist. The list contains only possibilites not, requirements.
null
.IHost createNewHostInstance(ISystemProfile profile)
IHost
object instance. This method is
called from SystemHostPool.createHost(IRSESystemType, String, String, String, String, int)
.
profile
- The system profile to associate with the host.
IHost
object instance.
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |