Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems
Interface SubSystem

All Superinterfaces:
IRemoteObjectResolver, SystemFilterPoolReferenceManagerProvider
All Known Subinterfaces:
DefaultCmdSubSystem, DefaultFileSubSystem, DefaultJobSubSystem, DefaultSubSystem, LocalCmdSubSystem, LocalFileSubSystem, RemoteCmdSubSystem, RemoteFileSubSystem, RemoteJobSubSystem, UniversalCmdSubSystem, UniversalFileSubSystem, UniversalJobSubSystem
All Known Implementing Classes:
DefaultCmdSubSystemImpl, DefaultFileSubSystemImpl, DefaultJobSubSystemImpl, DefaultSubSystemImpl, LocalCmdSubSystemImpl, LocalFileSubSystemImpl, RemoteCmdSubSystemImpl, RemoteFileSubSystemImpl, RemoteJobSubSystemImpl, SubSystemImpl, UniversalCmdSubSystemImpl, UniversalFileSubSystemImpl, UniversalJobSubSystemImpl

public interface SubSystem
extends SystemFilterPoolReferenceManagerProvider, IRemoteObjectResolver


Field Summary
static String copyright
           
 
Fields inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver
Copyright
 
Method Summary
 void checkIsConnected()
          This is a helper method you can call when performing actions that must be certain there is a connection.
 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()
          Connect to the remote system.
 void connect(Shell shell)
          Connect to the remote system.
 void connect(Shell shell, boolean forcePrompt)
          Connect to the remote system, optionally forcing a signon prompt even if the password is cached in memory or on disk.
 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(Shell shell)
          Disconnect from the remote system.
 void disconnect(Shell shell, boolean collapseTree)
          Disconnect from the remote system.
 boolean doesFilterListContentsOf(SystemFilter filter, String remoteObjectAbsoluteName)
          Return true if the given filter lists the contents of the given remote object.
 boolean doesFilterMatch(SystemFilter 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(SystemFilterString 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.
 String getAdditionalAttributes()
          Private.
 ICacheManager getCacheManager()
          Return the CacheManager for this subsystem.
 Object[] getChildren()
          Return the children for this subsystem.
 RemoteCmdSubSystem getCommandSubSystem()
          Return the associated command subsystem.
 String getFactoryId()
           
 SystemFilterPoolReferenceManager getFilterPoolReferenceManager()
          Generated persistent property method
Return the object that manages the list of filter pools referenced by this subsystem.
 String getIbmAttributes()
          Private.
 String getLocalUserId()
          Alternative to getUserId when we don't want to resolve it from parent connection.
 String getName()
           
 SubSystemFactory getParentSubSystemFactory()
          Return the parent subsystem factory that owns this subsystem.
 Integer getPort()
           
 int getPortAsInt()
          Return the port for this subsystem, as an integer.
 SubSystem getPrimarySubSystem()
          Return the primary subsystem associated with this subsystem's ISystem
 String[] getProperties(Object subject, String[] keys, Shell shell)
          Get a remote property.
 String getProperty(Object subject, String key, Shell shell)
          Get a remote property.
 PropertyPage getPropertyPage(Composite parent)
          Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection.
 ServerLauncher getRemoteServerLauncher()
          Returns the value of the 'Remote Server Launcher' containment reference.
 String getSaveFileName()
          Return the unqualified file name to save this subsystem to.
 ISystem getSystem()
          Return the ISystem object that represents the live connection for this system.
 SystemConnection getSystemConnection()
          Return the connection object this subsystem is associated with.
 String getSystemConnectionName()
           
 SystemFilterPoolReferenceManager getSystemFilterPoolReferenceManager()
          Return the system filter pool reference manager, as per the interface SystemFilterPoolReferenceManagerProvider
 AbstractSystemManager getSystemManager()
          Return a singleton instance of an AbstractSystemManager subclass that manages a pool of ISystem objects, one per system connection.
 SystemProfile getSystemProfile()
          Return the system profile object this subsystem is associated with.
 String getSystemProfileName()
           
 Object getTargetForFilter(SystemFilterReference filterRef)
          Returns the parent object associated with a filter reference.
 SystemUDActionSubsystem getUDActionSubsystem()
          Return the User Actions and Types manager for the parent subsystem factory of this subsystem
 String getUserId()
          Returns the value of this subsystem's user id if it is not null.
 String getVendorAttribute(String vendorName, String attributeName)
          For business partners defining their own subsystems.
 String getVendorAttributes()
          Private.
 boolean hasChildren()
          Return true if this subsystem has children objects to be displayed in the Remote System View explorer.
 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 isSetAdditionalAttributes()
          Private.
 boolean isSetIbmAttributes()
          Private.
 boolean isSetVendorAttributes()
          Private.
 boolean isUseSSL()
          Generated persistent property method
Return true if this connection is to use SSL.
 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(IProgressMonitor monitor, Object parent, String filterString)
          Modal thread version of resolve filter strings Resolve an absolute filter string.
 Object[] resolveFilterString(IProgressMonitor monitor, String filterString)
          Modal thread version of resolve filter strings Resolve an absolute filter string.
 Object[] resolveFilterString(Object parent, String filterString, Shell shell)
          Resolve an relative filter string.
 Object[] resolveFilterString(String filterString, Shell shell)
          Resolve an absolute filter string.
 Object[] resolveFilterStrings(IProgressMonitor monitor, String[] filterStrings)
          Modal thread version of resolve filter strings Resolve an absolute filter string.
 Object[] resolveFilterStrings(String[] filterStrings, Shell shell)
          Resolve multiple absolute filter strings.
 void setAdditionalAttributes(String value)
          Private.
 void setConnectionError(boolean error)
          Sets whether the last attempt to connect this subsystem to its remote system failed.
 void setFactoryId(String value)
           
 void setFilterPoolReferenceManager(SystemFilterPoolReferenceManager 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 setIbmAttributes(String value)
          Private.
 void setName(String value)
           
 void setParentConnection(SystemConnection conn)
          Set the parent connection that owns this subsystem.
 void setParentSubSystemFactory(SubSystemFactory ssf)
          Set the parent subsystem factory that owns this subsystem.
 void setPort(Integer value)
           
 Object setProperties(Object subject, String[] keys, String[] values, Shell shell)
          Set multiple remote properties.
 Object setProperty(Object subject, String key, String value, Shell shell)
          Set a remote property.
 void setRemoteServerLauncher(ServerLauncher value)
          Sets the value of the 'Remote Server Launcher' containment reference
 void setSaveFileName(String name)
          Set the unqualified file name to save this subsystem to.
 void setUserId(String value)
          Sets the local userId for this subsystem.
 void setUseSSL(boolean value)
          Generated persistent property method
Specify true if this connection is to use SSL.
 void setVendorAttribute(String vendorName, String attributeName, String attributeValue)
          For business partners defining their own subsystems.
 void setVendorAttributes(String value)
          Private.
 boolean supportsCaching()
          Check if the SubSystem supports caching.
 void unsetAdditionalAttributes()
          Private.
 void unsetIbmAttributes()
          Private.
 void unsetVendorAttributes()
          Private.
 
Methods inherited from interface com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool
 
Methods inherited from interface com.ibm.etools.systems.subsystems.IRemoteObjectResolver
getObjectWithAbsoluteName
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getCommandSubSystem

public RemoteCmdSubSystem getCommandSubSystem()
Return the associated command subsystem. By default, returns the first command subsystem found for this connection, but can be refined by each subsystem implementation. For command subsystems, returns "this".


getParentSubSystemFactory

public SubSystemFactory getParentSubSystemFactory()
Return the parent subsystem factory that owns this subsystem.


setParentSubSystemFactory

public void setParentSubSystemFactory(SubSystemFactory ssf)
Set the parent subsystem factory that owns this subsystem.


setParentConnection

public void setParentConnection(SystemConnection conn)
Set the parent connection that owns this subsystem.


getSystemProfile

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

See Also:
getName()

getSystemConnection

public SystemConnection getSystemConnection()
Return the connection object this subsystem is associated with.


getPrimarySubSystem

public SubSystem getPrimarySubSystem()
Return the primary subsystem associated with this subsystem's ISystem


getSystemConnectionName

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

getSystemProfileName

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

renamingProfile

public 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

public 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

public 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

public void checkIsConnected()
                      throws SystemMessageException
This is a helper method you can call when performing actions that must be certain there is a connection. If there is no connection it will attempt to connect, and if that fails will throw a SystemMessageException you can easily display to the user by using a method in it.

Throws:
SystemMessageException

getPropertyPage

public PropertyPage getPropertyPage(Composite parent)
Return the single property page to show in the tabbed notebook for the for SubSystem property of the parent Connection. Return null if no page is to be contributed for this. You are limited to a single page, so you may have to compress. It is recommended you prompt for the port if applicable since the common base subsystem property page is not shown To help with this you can use the SystemPortPrompt widget.


setVendorAttribute

public void setVendorAttribute(String vendorName,
                               String attributeName,
                               String attributeValue)
For business partners defining their own subsystems. This method allows an attribute to be persisted in this subsystem, given the following information: Warning do not use any of the following characters in any of given parameters, or it will cause problems with parsing:


getVendorAttribute

public String getVendorAttribute(String vendorName,
                                 String attributeName)
For business partners defining their own subsystems. This method allows retrieval of a persisted attribute in this subsystem, given the following information:

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

forceUserIdToUpperCase

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


getLocalUserId

public 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:
SystemConnection.getDefaultUserId(), clearLocalUserId(), getUserId(), setUserId(String)

clearLocalUserId

public 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:
SystemConnection.getDefaultUserId(), getUserId(), getLocalUserId(), setUserId(String)

getChildren

public 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

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


setSaveFileName

public void setSaveFileName(String name)
Set the unqualified file name to save this subsystem to. If you don't call this, the default is to use the parent subsystem's factory ID.

It is important the name end with "_subsystem", so we can deduce it is a subsystem file, so this will be appended if not found.


getSaveFileName

public String getSaveFileName()
Return the unqualified file name to save this subsystem to. It does not have the ".xmi" extension, that is added by the caller.

In release 1.0, returned getName(). However, this is a translated name hence caused problems in a multi-linqual team environment.

As of release 2.0, this now returns the last part of the id of the parent factory, plus "_subsystem". For example, for "ibm.filesLocal" it returns "filesLocal_subsystem".

This can be overridden by calling setSaveFileName.


doesFilterListContentsOf

public boolean doesFilterListContentsOf(SystemFilter 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

public boolean doesFilterStringListContentsOf(SystemFilterString 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

public boolean doesFilterMatch(SystemFilter 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

public 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

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

Specified by:
getSystemFilterPoolReferenceManager in interface SystemFilterPoolReferenceManagerProvider

getName

public String getName()
Returns:
The value of the Name attribute

setName

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

getUserId

public 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:
SystemConnection.getDefaultUserId(), setUserId(String), getLocalUserId(), clearLocalUserId()

setUserId

public void setUserId(String value)
Sets the local userId for this subsystem. This causes the local password cache to be cleared.

Behind the scenes, the user Id is in fact not stored in this subsystem object. Rather, it is stored in the user's preferences and the key value for that preference value is stored in the subsystem object. The methods getUserId() and getLocalUserId() will take care of resolving from the user preferences and returning the resolved value.

We store the userId in the user preferences to they are not shared among the team when the remote systems project is synchronized with a repository.

Parameters:
value - The new value of the UserId attribute. If it is null, then this is the same as calling clearLocalUserId().

getPort

public Integer getPort()
Returns:
The value of the Port attribute

getPortAsInt

public int getPortAsInt()
Return the port for this subsystem, as an integer. If the Integer is null (not set) then 0 is returned.


setPort

public void setPort(Integer value)
Parameters:
value - The new value of the Port attribute

getFactoryId

public String getFactoryId()
Returns:
The value of the FactoryId attribute Ties this subsystem to its owning subsystemfactory, via the id key string of the factory

setFactoryId

public void setFactoryId(String value)
Parameters:
value - The new value of the FactoryId attribute

getSystem

public ISystem getSystem()
Return the ISystem object that represents the live connection for this system.


getSystemManager

public AbstractSystemManager getSystemManager()
Return a singleton instance of an AbstractSystemManager subclass that manages a pool of ISystem objects, one per system connection. By default, getSystem() calls this, unless you override getSystem().


supportsCaching

public boolean supportsCaching()
Check if the SubSystem supports caching.


getCacheManager

public 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

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


isConnectionError

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


setConnectionError

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


isOffline

public 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

public void connect(Shell shell)
             throws Exception
Connect to the remote system. In addition to calling getSystem().connect(),this might fire events.

Throws:
Exception

connect

public void connect()
             throws Exception
Connect to the remote system. This uses Display.syncExec to get an active Shell and then calls connect(Shell)

Throws:
Exception

connect

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

Parameters:
forcePrompt - forces the prompt dialog to be displayed even if the password is currently in memory.
Throws:
Exception

disconnect

public void disconnect(Shell shell)
                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

public void disconnect(Shell shell,
                       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

public Object[] resolveFilterString(IProgressMonitor monitor,
                                    String filterString)
                             throws Exception
Modal thread version of resolve filter strings 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:
monitor - the process monitor associated with this operation
filterString - filter pattern for objects to return.
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterStrings

public Object[] resolveFilterStrings(IProgressMonitor monitor,
                                     String[] filterStrings)
                              throws Exception
Modal thread version of resolve filter strings 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:
monitor - the process monitor associated with this operation
filterStrings - filter patterns for objects to return.
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterString

public Object[] resolveFilterString(IProgressMonitor monitor,
                                    Object parent,
                                    String filterString)
                             throws Exception
Modal thread version of resolve filter strings 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:
monitor - the process monitor associated with this operation
parent - the parent object to query
filterString - filter pattern for objects to return.
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterString

public Object[] resolveFilterString(String filterString,
                                    Shell shell)
                             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.
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

resolveFilterStrings

public Object[] resolveFilterStrings(String[] filterStrings,
                                     Shell shell)
                              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,Shell) but takes an array of filter strings versus a single filter string.

Parameters:
filterStrings - array of filter patterns for objects to return.
Returns:
Array of objects that are the result of resolving all the filter strings
Throws:
Exception

resolveFilterString

public Object[] resolveFilterString(Object parent,
                                    String filterString,
                                    Shell shell)
                             throws Exception
Resolve an 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.
Returns:
Array of objects that are the result of this filter string
Throws:
Exception

setProperty

public Object setProperty(Object subject,
                          String key,
                          String value,
                          Shell shell)
                   throws Exception
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

public String getProperty(Object subject,
                          String key,
                          Shell shell)
                   throws Exception
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

public Object setProperties(Object subject,
                            String[] keys,
                            String[] values,
                            Shell shell)
                     throws Exception
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
Returns:
Object interpretable by subsystem. Might be a Boolean, or the might be new values for confirmation.
Throws:
Exception

getProperties

public String[] getProperties(Object subject,
                              String[] keys,
                              Shell shell)
                       throws Exception
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
Returns:
Object The values of the requested keys.
Throws:
Exception

getUDActionSubsystem

public SystemUDActionSubsystem getUDActionSubsystem()
Return the User Actions and Types manager for the parent subsystem factory of this subsystem


isHidden

public 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

public 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

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

Returns:
The FilterPoolReferenceManager reference

setFilterPoolReferenceManager

public void setFilterPoolReferenceManager(SystemFilterPoolReferenceManager 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.


getVendorAttributes

public String getVendorAttributes()
Private. Do not call or use.
See instead getVendorAttribute(String,String)

Returns:
The value of the VendorAttributes attribute Used to store vendor-supplied attributes via vendor___attr=value values, each semicolon separated. Vendors should not call this directly, but rather call setVendorAttribute and getVendorAttribute

setVendorAttributes

public void setVendorAttributes(String value)
Private. Do not call or use.
See instead setVendorAttribute(String,String,String)

Parameters:
value - The new value of the VendorAttributes attribute

unsetVendorAttributes

public void unsetVendorAttributes()
Private. Do not call or use.


isSetVendorAttributes

public boolean isSetVendorAttributes()
Private. Do not call or use.

Returns:
true if the VendorAttributes attribute has been set

getAdditionalAttributes

public String getAdditionalAttributes()
Private. Do not call or use.

Returns:
The value of the AdditionalAttributes attribute

setAdditionalAttributes

public void setAdditionalAttributes(String value)
Private. Do not call or use.

Parameters:
value - The new value of the AdditionalAttributes attribute

unsetAdditionalAttributes

public void unsetAdditionalAttributes()
Private. Do not call or use.


isSetAdditionalAttributes

public boolean isSetAdditionalAttributes()
Private. Do not call or use.

Returns:
true if the AdditionalAttributes attribute has been set

isUseSSL

public boolean isUseSSL()
Generated persistent property method
Return true if this connection is to use SSL.

Returns:
The value of the UseSSL attribute Use secure socket layer when making connection

setUseSSL

public void setUseSSL(boolean value)
Generated persistent property method
Specify true if this connection is to use SSL.

Parameters:
value - The new value of the UseSSL attribute

getIbmAttributes

public String getIbmAttributes()
Private. Do not call or use.
See instead com.ibm.etools.systems.subsystems.impl.SubSystemImpl.#getIBMAttribute(String)

Returns:
The value of the IbmAttributes attribute These are reserved for IBM, for subclasses that do not use MOF. Special methods are used to set and get attributes by key, all of which are stuffed into this one string

setIbmAttributes

public void setIbmAttributes(String value)
Private. Do not call or use.
See instead com.ibm.etools.systems.subsystems.impl.SubSystemImpl.#setIBMAttribute(String,String)

Parameters:
value - The new value of the IbmAttributes attribute

unsetIbmAttributes

public void unsetIbmAttributes()
Private. Do not call or use.


isSetIbmAttributes

public boolean isSetIbmAttributes()
Private. Do not call or use.

Returns:
true if the IbmAttributes attribute has been set

getRemoteServerLauncher

public ServerLauncher getRemoteServerLauncher()
Returns the value of the 'Remote Server Launcher' containment reference. It is bidirectional and its opposite is 'Parent Sub System'.

Get the remote server launcher, which may be null. This an optional object containing properties used to launch the remote server that communicates with this subsystem.

Returns:
the value of the 'Remote Server Launcher' containment reference.
See Also:
setRemoteServerLauncher(ServerLauncher), SubsystemsPackage.getSubSystem_RemoteServerLauncher(), ServerLauncher.getParentSubSystem()

setRemoteServerLauncher

public void setRemoteServerLauncher(ServerLauncher value)
Sets the value of the 'Remote Server Launcher' containment reference. Set the remote server launcher, which is an optional object containing properties used to launch the remote server that communicates with this subsystem.

Parameters:
value - the new value of the 'Remote Server Launcher' containment reference.
See Also:
getRemoteServerLauncher()

getTargetForFilter

public Object getTargetForFilter(SystemFilterReference 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:

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.