iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core
Interface IISeriesSubSystem

All Superinterfaces:
org.eclipse.emf.ecore.EObject, com.ibm.etools.systems.subsystems.IRemoteObjectResolver, org.eclipse.emf.common.notify.Notifier, com.ibm.etools.systems.subsystems.SubSystem, com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
All Known Subinterfaces:
AS400ifsCmdSubSystem, AS400ifsFileSubSystem, CmdSubSystem, FileSubSystem, JobSubSystem
All Known Implementing Classes:
AS400ifsCmdSubSystemImpl, AS400ifsFileSubSystemImpl, AS400SubSystemImpl, CmdSubSystemImpl, FileSubSystemImpl, JobSubSystemImpl

public interface IISeriesSubSystem
extends com.ibm.etools.systems.subsystems.SubSystem

This is a common interface implemented by each of our ISeries subsystem objects. These all share a common ISeries Toolbox for Java connection to their remote system, so have some common support.

Another benefit of having a common interface for all iSeries subsystems that share a common ISystem connection is that we can easily define property pages that apply to all such subsystems, by identifying ths interface on the ObjectClass attribute of the org.eclipse.ui.propertyPages extension point.


Field Summary
static String Copyright
           
 
Fields inherited from interface com.ibm.etools.systems.subsystems.SubSystem
copyright
 
Method Summary
 CmdSubSystem getCmdSubSystem()
          Return the command subsystem ("iSeries Commands") for executing remote QSYS commands
 IISeriesSubSystemCommandExecutionProperties getCommandExecutionProperties()
          Return the Command Execution Property Page properties that are accessible from all iSeries subsystems.
 ISeriesSystemDataStore getISeriesSystem()
          Return the shared ISystem system object by all subsystems in a connection.
 FileSubSystem getObjectSubSystem()
          Return the objects subsystem ("iSeries Objects") for accessing remote QSYS libs, objs, mbrs, etc.
 Shell getShell()
          Get the shell to be used when a dialog is needed, such as when prompting for password or showing an error message.
 com.ibm.as400.access.AS400 getToolboxAS400Object()
          Return the iSeries Toolbox for Java "AS400" object for this connection.
 void setShell(Shell shell)
          Set the shell to be used when a dialog is needed, such as when prompting for password or showing an error message.
 
Methods inherited from interface com.ibm.etools.systems.subsystems.SubSystem
checkIsConnected, clearLocalUserId, connect, connect, connect, deletingConnection, disconnect, disconnect, doesFilterListContentsOf, doesFilterMatch, doesFilterStringListContentsOf, doesFilterStringMatch, forceUserIdToUpperCase, getAdditionalAttributes, getCacheManager, getChildren, getCommandSubSystem, getFactoryId, getFilterPoolReferenceManager, getIbmAttributes, getLocalUserId, getName, getParentSubSystemFactory, getPort, getPortAsInt, getPrimarySubSystem, getProperties, getProperty, getPropertyPage, getRemoteServerLauncher, getSaveFileName, getSystem, getSystemConnection, getSystemConnectionName, getSystemFilterPoolReferenceManager, getSystemManager, getSystemProfile, getSystemProfileName, getTargetForFilter, getUDActionSubsystem, getUserId, getVendorAttribute, getVendorAttributes, hasChildren, isConnected, isConnectionError, isHidden, isOffline, isSetAdditionalAttributes, isSetIbmAttributes, isSetVendorAttributes, isUseSSL, renamingConnection, renamingProfile, resolveFilterString, resolveFilterString, resolveFilterString, resolveFilterString, resolveFilterStrings, resolveFilterStrings, setAdditionalAttributes, setConnectionError, setFactoryId, setFilterPoolReferenceManager, setHidden, setIbmAttributes, setName, setParentConnection, setParentSubSystemFactory, setPort, setProperties, setProperty, setRemoteServerLauncher, setSaveFileName, setUserId, setUseSSL, setVendorAttribute, setVendorAttributes, supportsCaching, unsetAdditionalAttributes, unsetIbmAttributes, unsetVendorAttributes
 
Methods inherited from interface com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
filterEventFilterCreated, filterEventFilterPoolReferenceCreated, filterEventFilterPoolReferenceDeleted, filterEventFilterPoolReferenceRenamed, filterEventFilterPoolReferenceReset, filterEventFilterPoolReferencesRePositioned, filterEventFilterPoolReferencesReset, filterEventFilterStringCreated, getUniqueOwningSystemFilterPool
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
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

getCmdSubSystem

public CmdSubSystem getCmdSubSystem()
Return the command subsystem ("iSeries Commands") for executing remote QSYS commands


getObjectSubSystem

public FileSubSystem getObjectSubSystem()
Return the objects subsystem ("iSeries Objects") for accessing remote QSYS libs, objs, mbrs, etc. For historical reasons, this is also known as the "file subsystem".


getISeriesSystem

public ISeriesSystemDataStore getISeriesSystem()
Return the shared ISystem system object by all subsystems in a connection. You can use this to test if we are connected, or to retrieve an iSeries JDBC connection, for example.


getToolboxAS400Object

public com.ibm.as400.access.AS400 getToolboxAS400Object()
Return the iSeries Toolbox for Java "AS400" object for this connection. This may, or may not, be connected yet. To test, call SubSystem.isConnected() To connect, call SubSystem.connect() or preferably SubSystem.connect(Shell)


setShell

public void setShell(Shell shell)
Set the shell to be used when a dialog is needed, such as when prompting for password or showing an error message.


getShell

public Shell getShell()
Get the shell to be used when a dialog is needed, such as when prompting for password or showing an error message. This is as last set by calling setShell(Shell).


getCommandExecutionProperties

public IISeriesSubSystemCommandExecutionProperties getCommandExecutionProperties()
Return the Command Execution Property Page properties that are accessible from all iSeries subsystems. All our subsystems implement this method, but only the Objects SubSystem actually implements the interface and hence returns "this". All others return the objects subsystem instance.


iSeries Remote Systems
v6.0.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.