Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.core.subsystems
Interface ISubSystem

All Superinterfaces:
IPropertySetContainer, IRemoteObjectResolver, IRSEModelObject, IRSEPersistableContainer, ISchedulingRule, ISystemFilterPoolReferenceManagerProvider
All Known Subinterfaces:
IFileServiceSubSystem, IProcessServiceSubSystem, IRemoteCmdSubSystem, IRemoteFileSubSystem, IRemoteProcessSubSystem, IShellServiceSubSystem, ITerminalServiceSubSystem
All Known Implementing Classes:
FileServiceSubSystem, ProcessServiceSubSystem, RemoteCmdSubSystem, RemoteFileSubSystem, RemoteProcessSubSystemImpl, ShellServiceSubSystem, SubSystem, TerminalServiceSubSystem

public interface ISubSystem
extends ISystemFilterPoolReferenceManagerProvider, IRemoteObjectResolver, ISchedulingRule, IRSEModelObject

Interface implemented by SubSystem objects. While connections contain information to identify a particular remote system, it is the subsystem objects within a connection that contain information unique to a particular tool for that remote system, such as the port the tool uses and the user ID for making the connection. There are a set of default properties, but these can be extended by subsystem providers, by extending SubSystem.


Field Summary
 
Fields inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
NO_CHILDREN
 
Method Summary
 boolean canSwitchTo ( ISubSystemConfiguration configuration)
          Determine is this subsystem is compatible with this specified configuration.
 void checkIsConnected ( IProgressMonitor monitor)
          Check if the subsystem is connected, and connect if it's not.
 void clearLocalUserId ()
          Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id.
 void connect (boolean forcePrompt, IRSECallback callback)
          Asynchronously connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk.
 void connect ( IProgressMonitor monitor, boolean forcePrompt)
          Synchronously connect to the remote system.
 void deletingConnection ()
          Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to.
 void disconnect ()
          Disconnect from the remote system.
 void disconnect (boolean collapseTree)
          Disconnect from the remote system.
 boolean doesFilterListContentsOf ( ISystemFilter filter, String remoteObjectAbsoluteName)
          Return true if the given filter lists the contents of the given remote object.
 boolean doesFilterMatch ( ISystemFilter filter, String remoteObjectAbsoluteName)
          Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter.
 boolean doesFilterStringListContentsOf ( ISystemFilterString filterString, String remoteObjectAbsoluteName)
          Return true if the given filter string lists the contents of the given remote object.
 boolean doesFilterStringMatch ( String filterString, String remoteObjectAbsoluteName, boolean caseSensitive)
          Return true if the given remote object name will pass the filtering criteria for the given filter string in this filter.
 boolean forceUserIdToUpperCase ()
          Return true if userId and password should be forced to uppercase.
  ICacheManager getCacheManager ()
          Return the CacheManager for this subsystem.
  Object[] getChildren ()
          Return the children for this subsystem.
  String getConfigurationId ()
           
  IConnectorService getConnectorService ()
          Return the IConnectorService object that represents the live connection for this system.
  ISystemFilterPoolReferenceManager getFilterPoolReferenceManager ()
          Generated persistent property method
Return the object that manages the list of filter pools referenced by this subsystem.
  IHost getHost ()
          Return the connection object this subsystem is associated with.
  String getHostAliasName ()
           
  String getLocalUserId ()
          Alternative to getUserId when we don't want to resolve it from parent connection.
  String getName ()
           
  ISubSystem getPrimarySubSystem ()
          Return the primary subsystem associated with this subsystem's IConnectorService
  String[] getProperties ( Object subject, String[] keys)
          Deprecated. this shouldn't be used
  String getProperty ( Object subject, String key)
          Deprecated. this shouldn't be used
  Class getServiceType ()
          Returns the interface type (i.e. a Class object that is an Interface) of a service subsystem.
  ISubSystemConfiguration getSubSystemConfiguration ()
          Return the parent subsystem factory that owns this subsystem.
  ISystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager ()
          Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider
  ISystemProfile getSystemProfile ()
          Return the system profile object this subsystem is associated with.
  String getSystemProfileName ()
           
  Object getTargetForFilter ( ISystemFilterReference filterRef)
          Returns the parent object associated with a filter reference.
  String getUserId ()
          Returns the value of this subsystem's user id if it is not null.
  String getVendorAttribute ( String vendorName, String attributeName)
          Deprecated. Subsystems can now take named property sets. These should be used instead. See IPropertySet
 boolean hasChildren ()
          Return true if this subsystem has children objects to be displayed in the Remote System View explorer.
 void initializeSubSystem ( IProgressMonitor monitor)
          Called on each subsystem associated with a particular IConnectorService after it connects successfully.
 boolean isConnected ()
          Return true if this subsystem is currently connected to its remote system.
 boolean isConnectionError ()
          Return true if the last attempt to connect this subsystem to its remote system failed.
 boolean isHidden ()
          Generated persistent property method
Return true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded.
 boolean isOffline ()
          Return true if this subsystem is currently being used in "offline" mode.
 boolean isPrimarySubSystem ()
           
 void renamingConnection ( String newName)
          Private method called when the parent connection is being renamed, so the subsystem can do any cleanup it needs to.
 void renamingProfile ( String oldName, String newName)
          Private method called when the parent profile is being renamed, so the subsystem can do any cleanup it needs to.
  Object[] resolveFilterString ( Object parent, String filterString, IProgressMonitor monitor)
          Resolve a relative filter string.
  Object[] resolveFilterString ( String filterString, IProgressMonitor monitor)
          Resolve an absolute filter string.
  Object[] resolveFilterStrings ( String[] filterStrings, IProgressMonitor monitor)
          Resolve multiple absolute filter strings.
 void setConfigurationId ( String value)
           
 void setConnectionError (boolean error)
          Sets whether the last attempt to connect this subsystem to its remote system failed.
 void setConnectorService ( IConnectorService connectorService)
          Set the connector service for this subsystem
 void setFilterPoolReferenceManager ( ISystemFilterPoolReferenceManager value)
          Generated persistent property method
Set the object that manages the list of filter pools referenced by this subsystem.
 void setHidden (boolean value)
          Generated persistent property method
Specify true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded.
 void setHost ( IHost conn)
          Set the parent connection that owns this subsystem.
 void setName ( String value)
           
  Object setProperties ( Object subject, String[] keys, String[] values)
          Deprecated. this shouldn't be used
  Object setProperty ( Object subject, String key, String value)
          Deprecated. this shouldn't be used
 void setSubSystemConfiguration ( ISubSystemConfiguration ssf)
          Set the parent subsystem factory that owns this subsystem.
 void setVendorAttribute ( String vendorName, String attributeName, String attributeValue)
          Deprecated. Subsystems can now take named property sets. These should be used instead. See IPropertySet
 boolean supportsCaching ()
          Check if the SubSystem supports caching.
 void switchServiceFactory ( ISubSystemConfiguration configuration)
          Requests a service subsystem to switch to a new configuration.
 void uninitializeSubSystem ( IProgressMonitor monitor)
          Called on each subsystem associated with a particular IConnectorService after it disconnects
 
Methods inherited from interface org.eclipse.rse.core.filters. ISystemFilterPoolReferenceManagerProvider
filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool
 
Methods inherited from interface org.eclipse.rse.core.subsystems. IRemoteObjectResolver
getObjectWithAbsoluteName, getObjectWithAbsoluteName
 
Methods inherited from interface org.eclipse.core.runtime.jobs. ISchedulingRule
contains, isConflicting
 
Methods inherited from interface org.eclipse.rse.core.model. IRSEModelObject
getDescription
 
Methods inherited from interface org.eclipse.rse.core.model. IPropertySetContainer
addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet
 
Methods inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer
commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored
 

Method Detail

getSubSystemConfiguration

ISubSystemConfiguration getSubSystemConfiguration()
Return the parent subsystem factory that owns this subsystem.


setSubSystemConfiguration

void setSubSystemConfiguration(
ISubSystemConfiguration ssf)
Set the parent subsystem factory that owns this subsystem.


setHost

void setHost(
IHost conn)
Set the parent connection that owns this subsystem.


setConnectorService

void setConnectorService(
IConnectorService connectorService)
Set the connector service for this subsystem

Parameters:
connectorService - connector service object to set

getSystemProfile

ISystemProfile getSystemProfile()
Return the system profile object this subsystem is associated with.

See Also:
getName()

getHost

IHost getHost()
Return the connection object this subsystem is associated with.


initializeSubSystem

void initializeSubSystem(
IProgressMonitor monitor)
                         throws 
SystemMessageException
Called on each subsystem associated with a particular IConnectorService after it connects successfully. This call is always made on a background Thread, so it's allowed to be long-running.

Parameters:
monitor - a progress monitor that can be used to show progress during long-running operation. Cancellation is typically not supported since it might leave the system in an inconsistent state.
Throws:
SystemMessageException - if an error occurs during initialization.

uninitializeSubSystem

void uninitializeSubSystem(
IProgressMonitor monitor)
Called on each subsystem associated with a particular IConnectorService after it disconnects

Parameters:
monitor - a progress monitor that can be used to show progress during long-running operation. Cancellation is typically not supported since it might leave the system in an inconsistent state.

isPrimarySubSystem

boolean isPrimarySubSystem()
Returns:
true if this subsystem's properties should take precedence over other subsystems that share the same IConnectorService

getPrimarySubSystem

ISubSystem getPrimarySubSystem()
Return the primary subsystem associated with this subsystem's IConnectorService


getHostAliasName

String getHostAliasName()
Returns:
The name of the connection that owns this. Same as getSystemConnection().getAliasName()

getSystemProfileName

String getSystemProfileName()
Returns:
The value of the profile that owns the connection that owns this subsystem. Fastpath.

renamingProfile

void renamingProfile(
String oldName,
                     
String newName)
Private method called when the parent profile is being renamed, so the subsystem can do any cleanup it needs to. Called after the profile is actually renamed.


renamingConnection

void renamingConnection(
String newName)
Private method called when the parent connection is being renamed, so the subsystem can do any cleanup it needs to.


deletingConnection

void deletingConnection()
Private method called when the parent connection is being deleted, so the subsystem can do any pre-death cleanup it needs to.


checkIsConnected

void checkIsConnected(
IProgressMonitor monitor)
                      throws 
SystemMessageException
Check if the subsystem is connected, and connect if it's not. This is a convenience method which first checks whether the subsystem is already connected. If not, it automatically checks if it's running on the dispatch thread or not, and calls the right connect() method as appropriate. It also performs some exception parsing, converting Exceptions from connect() into SystemMessageException that can be displayed to the user by using a method in it. If the subsystem is marked offline, or supports caching and is currently restoring from its memento, no connect will be performed.

Throws:
SystemMessageException - in case of an error connecting
Since:
org.eclipse.rse.core 3.0

setVendorAttribute

void setVendorAttribute(
String vendorName,
                        
String attributeName,
                        
String attributeValue)
Deprecated. Subsystems can now take named property sets. These should be used instead. See IPropertySet

For business partners defining their own subsystems. This method allows an attribute to be persisted in this subsystem, given the following information:
  • Vendor name. This name should uniquely differentiate one vendor's attributes from anothers.
  • Attribute name. The name of the attribute to set.
  • attribute value. The value to give the named attribute. It must be resolved into a string to use this. Eg, for boolean use something like "true" or "false". To clear the attribute value pass null for the value.
Warning do not use any of the following characters in any of given parameters, or it will cause problems with parsing:
  • Pound sign ('#')
  • Three underscores ("___")
  • Three equals signs ("===")
  • Three semicolons (";;;")


getVendorAttribute

String getVendorAttribute(
String vendorName,
                          
String attributeName)
Deprecated. Subsystems can now take named property sets. These should be used instead. See IPropertySet

For business partners defining their own subsystems. This method allows retrieval of a persisted attribute in this subsystem, given the following information:
  • Vendor name. This name should uniquely differentiate one vendor's attributes from anothers.
  • Attribute name. The name of the attribute whose value is being queried.

Returns:
value of the attribute being queried, or null if not found

forceUserIdToUpperCase

boolean forceUserIdToUpperCase()
Return true if userId and password should be forced to uppercase. Shortcut to calling same method in parent SubSystemConfiguration.


getLocalUserId

String getLocalUserId()
Alternative to getUserId when we don't want to resolve it from parent connection. This is used when showing the properties.

Unlike getUserId() this one does not defer to the connection's default user Id if the subsystem's userId attribute is null.

To set the local user Id, simply call setUserId(String id). To clear it, call clearLocalUserId().

See Also:
IHost.getDefaultUserId(), clearLocalUserId(), getUserId()

clearLocalUserId

void clearLocalUserId()
Called to clear the local user Id such that subsequent requests to getUserId() will return the parent connection's default user Id. Sets the user Id attribute for this subsystem to null.

See Also:
IHost.getDefaultUserId(), getUserId(), getLocalUserId()

getChildren

Object[] getChildren()
Return the children for this subsystem. This is used to populate the Remote System View explorer.

By default, if the parent subsystem factory supports filters, then we return getSystemFilterPoolReferencesArray. If filters are not supported (supportsFilters() returns false from factory) then we return null. In this case you should override this.


hasChildren

boolean hasChildren()
Return true if this subsystem has children objects to be displayed in the Remote System View explorer.


doesFilterListContentsOf

boolean doesFilterListContentsOf(
ISystemFilter filter,
                                 
String remoteObjectAbsoluteName)
Return true if the given filter lists the contents of the given remote object. For example, if given a folder, return true if any of the filter strings in this filter lists the contents of that folder. Used in impact analysis when a remote object is created, deleted, renamed, copied or moved, so as to establish which filters need to be refreshed or collapsed (if the folder is deleted, say).

The default algorithm calls doesFilterStringListContentsOf for each filter string.


doesFilterStringListContentsOf

boolean doesFilterStringListContentsOf(
ISystemFilterString filterString,
                                       
String remoteObjectAbsoluteName)
Return true if the given filter string lists the contents of the given remote object. For example, if given a folder, return true if the given filter string lists the contents of that folder. Used in impact analysis when a remote object is created, deleted, renamed, copied or moved, so as to establish which filters need to be refreshed or collapsed (if the folder is deleted, say).


doesFilterMatch

boolean doesFilterMatch(
ISystemFilter filter,
                        
String remoteObjectAbsoluteName)
Return true if the given remote object name will pass the filtering criteria for any of the filter strings in this filter.


doesFilterStringMatch

boolean doesFilterStringMatch(
String filterString,
                              
String remoteObjectAbsoluteName,
                              boolean caseSensitive)
Return true if the given remote object name will pass the filtering criteria for the given filter string in this filter.


getSystemFilterPoolReferenceManager

ISystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager()
Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider

Specified by:
getSystemFilterPoolReferenceManager in interface ISystemFilterPoolReferenceManagerProvider

getName

String getName()
Specified by:
getName in interface IRSEModelObject
Returns:
The value of the Name attribute

setName

void setName(
String value)
Parameters:
value - The new value of the Name attribute

getUserId

String getUserId()
Returns the value of this subsystem's user id if it is not null. If it is null, it returns the parent connection object's default user Id.

In fact, we now don't store the user Id in the subsystem object itself, but rather store it in the user preferences, so that such things are not shared among the team on a synchronize operation. This is transparent to callers of this method however, as this method resolves from the preferences.

Returns:
The value of the UserId attribute
See Also:
IHost.getDefaultUserId(), getLocalUserId(), clearLocalUserId()

getConfigurationId

String getConfigurationId()
Returns:
The value of the ConfigurationId attribute Ties this subsystem to its owning subsystem configuration, via the id key string of the configuration.

setConfigurationId

void setConfigurationId(
String value)
Parameters:
value - The new value of the ConfigurationId attribute

getConnectorService

IConnectorService getConnectorService()
Return the IConnectorService object that represents the live connection for this system.


supportsCaching

boolean supportsCaching()
Check if the SubSystem supports caching.


getCacheManager

ICacheManager getCacheManager()
Return the CacheManager for this subsystem. If the SubSystem returns true for supportsCaching() then it must return a valid CacheManager, otherwise it is free to return null.

See Also:
supportsCaching()

isConnected

boolean isConnected()
Return true if this subsystem is currently connected to its remote system.


isConnectionError

boolean isConnectionError()
Return true if the last attempt to connect this subsystem to its remote system failed.


setConnectionError

void setConnectionError(boolean error)
Sets whether the last attempt to connect this subsystem to its remote system failed.


isOffline

boolean isOffline()
Return true if this subsystem is currently being used in "offline" mode. Not necessarily supported by all subsystems in which case this will always return false.


connect

void connect(
IProgressMonitor monitor,
             boolean forcePrompt)
             throws 
Exception
Synchronously connect to the remote system. Clients are expected to call this method on a background thread with an existing progress monitor. A signon prompt may optionally be forced even if the password is cached in memory or on disk. The framework will take care of switching to the UI thread for requesting a password from the user if necessary.

Parameters:
monitor - the progress monitor. Must not be null.
forcePrompt - forces the prompt dialog to be displayed even if the password is currently in memory.
Throws:
Exception - an exception if there is a failure to connect. Typically, this will be a SystemMessageException. An OperationCanceledException will be thrown if the user cancels the connect.

connect

void connect(boolean forcePrompt,
             
IRSECallback callback)
             throws 
Exception
Asynchronously connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk.

This method must be called on the UI Thread! An Eclipse background job with a progress monitor will be created automatically. If the optional callback is given, it will be called when the connect is complete. You do not need to override this, as it does the progress monitor reporting for you.

Override internalConnect if you want, but by default it calls getConnectorService().connect(IProgressMonitor).

Parameters:
forcePrompt - forces the prompt dialog even if the password is in mem
callback - to call after connect is complete. May be null.
Throws:
Exception - an exception if there is a failure to connect. Typically, this will be a SystemMessageException. An OperationCanceledException will be thrown if the user cancels the connect.

disconnect

void disconnect()
                throws 
Exception
Disconnect from the remote system. In addition to calling getSystem().disconnect(),this must fire an event to collapse the expanded nodes in the tree under this node.

Throws:
Exception

disconnect

void disconnect(boolean collapseTree)
                throws 
Exception
Disconnect from the remote system. In addition to calling getSystem().disconnect(),this may fire an event to collapse the expanded nodes in the tree under this node depending on the value of collapseTree.

Throws:
Exception

resolveFilterString

Object[] resolveFilterString(
String filterString,
                             
IProgressMonitor monitor)
                             throws 
Exception
Resolve an absolute filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands a filter containing filter strings, this method is invoked for each filter string.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:
filterString - filter pattern for objects to return.
monitor - the process monitor associated with this operation
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterStrings

Object[] resolveFilterStrings(
String[] filterStrings,
                              
IProgressMonitor monitor)
                              throws 
Exception
Resolve multiple absolute filter strings. This is only applicable if the subsystem factory reports true for supportsFilters().

This is the same as resolveFilterString(String, IProgressMonitor) but takes an array of filter strings versus a single filter string.

Parameters:
filterStrings - array of filter patterns for objects to return.
monitor - the process monitor associated with this operation
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterString

Object[] resolveFilterString(
Object parent,
                             
String filterString,
                             
IProgressMonitor monitor)
                             throws 
Exception
Resolve a relative filter string. This is only applicable if the subsystem factory reports true for supportsFilters().

When a user expands an object that came from a previous filter string expansion, (such as expanding a folder), this method is invoked to get the children of that object. The user can choose to expand all, or choose a pre-defined relative filter string to subset/filter the children. In either case, the relative filter string is passed in as well as the to-be-expanded parent object.

The resulting objects are displayed in the remote system view tree. They can be anything, but at a minimum must support IAdaptable in order to drive the property sheet. You can just defer the getAdapter request to the platform's Adapter manager if desired.

You should supply an adapter class for the returned object's class, to render objects in the Remote System Explorer view. It will uses a label and content provider that defers all requests to the adapter, which it gets by querying the platform's adapter manager for the object type. Be sure to register your adapter factory.

Parameters:
parent - Object that is being expanded.
filterString - filter pattern for children of parent.
monitor - the process monitor associated with this operation
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

setProperty

Object setProperty(
Object subject,
                   
String key,
                   
String value)
                   throws 
Exception
Deprecated. this shouldn't be used

Set a remote property. Subsystems interpret as they wish. Eg, this might be to set a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:
subject - Identifies which object to get the properties of
key - Identifies property to set
value - Value to set property to
Returns:
Object interpretable by subsystem. Might be a Boolean, or the might be new value for confirmation.
Throws:
Exception

getProperty

String getProperty(
Object subject,
                   
String key)
                   throws 
Exception
Deprecated. this shouldn't be used

Get a remote property. Subsystems interpret as they wish. Eg, this might be to get a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:
subject - Identifies which object to get the properties of
key - Identifies property to get value of
Returns:
String The value of the requested key.
Throws:
Exception

setProperties

Object setProperties(
Object subject,
                     
String[] keys,
                     
String[] values)
                     throws 
Exception
Deprecated. this shouldn't be used

Set multiple remote properties. Subsystems interpret as they wish. Eg, this might be to set a number of remote environment variables. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:
subject - Identifies which object to get the properties of
keys - Identifies the properties to set
values - Values to set properties to. One to one mapping to keys by index number
Returns:
Object interpretable by subsystem. Might be a Boolean, or the might be new values for confirmation.
Throws:
Exception

getProperties

String[] getProperties(
Object subject,
                       
String[] keys)
                       throws 
Exception
Deprecated. this shouldn't be used

Get a remote property. Subsystems interpret as they wish. Eg, this might be to get a remote environment variable. This is only applicable if the subsystem factory reports true for supportsProperties().

Parameters:
subject - Identifies which object to get the properties of
keys - Identifies properties to get value of
Returns:
The values of the requested keys.
Throws:
Exception

isHidden

boolean isHidden()
Generated persistent property method
Return true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. If so, this subsystem is for programmatic use only, or is exposed in alternative view. Such is the case for command subsystems, for example.

Returns:
The value of the Hidden attribute

setHidden

void setHidden(boolean value)
Generated persistent property method
Specify true if this subsystem is to be hidden so it doesn't show in the Remote Systems view when a connection is expanded. If so, this subsystem is for programmatic use only, or is exposed in alternative view. Such is the case for command subsystems, for example.

Parameters:
value - The new value of the Hidden attribute

getFilterPoolReferenceManager

ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()
Generated persistent property method
Return the object that manages the list of filter pools referenced by this subsystem.

Returns:
The FilterPoolReferenceManager reference

setFilterPoolReferenceManager

void setFilterPoolReferenceManager(
ISystemFilterPoolReferenceManager value)
Generated persistent property method
Set the object that manages the list of filter pools referenced by this subsystem. This is called by the subsystem factory when creating or restoring subsystems.

Parameters:
l - The new value of the FilterPoolReferenceManager reference

getTargetForFilter

Object getTargetForFilter(
ISystemFilterReference filterRef)
Returns the parent object associated with a filter reference. It's up to the subsystem implementation to decide what "parent object" means for a filter reference.

Parameters:
filterRef - the filter reference to determine a target object from.
Returns:
An object representing the parent

getServiceType

Class getServiceType()
Returns the interface type (i.e. a Class object that is an Interface) of a service subsystem.

Returns:
the service interface on which this service subsystem is implemented. If this subsystem is not a service subsystem it must return null.
Since:
org.eclipse.rse.core 3.0

switchServiceFactory

void switchServiceFactory(
ISubSystemConfiguration configuration)
Requests a service subsystem to switch to a new configuration. If the configuration is compatible with this subsystem then it must disconnect, possibly reset its filter pool references, and request new services and parameters from its new configuration. It must also answer true to canSwitchTo(ISubSystemConfiguration). If the configuration is not compatible with this subsystem then this must do nothing and must answer false to canSwitchTo(ISubSystemConfiguration).

Parameters:
configuration - the configuration to which to switch.
Since:
org.eclipse.rse.core 3.0

canSwitchTo

boolean canSwitchTo(
ISubSystemConfiguration configuration)
Determine is this subsystem is compatible with this specified configuration.

Parameters:
configuration - the configuration which may be switched to
Returns:
true if the subsystem can switch to this configuration, false otherwise. Subsystems which are not service subsystems must return false.
Since:
org.eclipse.rse.core 3.0

RSE
Release 3.0

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire