iSeries Remote Systems
v6.0.1

com.ibm.etools.systems.as400cmdsubsys
Interface CmdSubSystem

All Superinterfaces:
AS400SubSystem, org.eclipse.emf.ecore.EObject, IISeriesSubSystem, com.ibm.etools.systems.subsystems.IRemoteObjectResolver, org.eclipse.emf.common.notify.Notifier, com.ibm.etools.systems.subsystems.RemoteCmdSubSystem, com.ibm.etools.systems.subsystems.SubSystem, com.ibm.etools.systems.filters.SystemFilterPoolReferenceManagerProvider
All Known Implementing Classes:
CmdSubSystemImpl

public interface CmdSubSystem
extends IISeriesSubSystem, com.ibm.etools.systems.subsystems.RemoteCmdSubSystem, AS400SubSystem


Field Summary
static String copyright
           
 
Fields inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystem
Copyright
 
Method Summary
 void addLibraryListEntry(String library, String position)
          Add library list entry
 int attachInteractiveJob(String jobName, String queueName)
          Interactive command support.
 String getASPGroup()
           
 String getCODEAlias()
           
 String getCurlib()
           
 org.eclipse.emf.common.util.EList getEnvVars()
           
 String getExtraAttributes()
           
 String getInitialCommand()
           
 org.eclipse.emf.common.util.EList getInitialLibraryList()
           
 SystemLibraryListEntry[] getInitialSystemLibraryList()
          Get the initial library list as a string of SystemLibraryListEntry objects.
 String getSBMJobParms()
           
 SystemLibraryListEntry getSystemLibraryListEntry(String library)
          Given a library name, find its SystemLibraryListEntry object
 boolean isInteractiveJobAvailable()
          Interactive command support.
 boolean isRunServerRemotely()
           
 boolean isSetSBMJobParms()
          Returns whether the value of the 'SBM Job Parms' attribute is set.
 String promptCommand(String command)
          Prompt remote command Return prompted command
 boolean releaseInteractiveJob()
          Interactive command support.
 void removeLibraryListEntry(String library)
          Remove library list entry given only its library name
 void removeLibraryListEntry(SystemLibraryListEntry slle)
          Remove library list entry given its SystemLibraryListEntry object
 Object[] runCommand(String command)
          Execute remote command without a progress monitor Runs in our job, not in batch, not interactive.
 Object[] runCommand(String command, IProgressMonitor monitor)
          Execute remote command without a progress monitor Runs in our job, not in batch, not interactive.
 Object[] runCommand(String command, Shell shell, int jobEnv)
          Execute remote command, possibly in batch, interactive, or just the RSE Server
 Object[] runInteractiveCommand(String command)
          Interactive command support.
 void setASPGroup(String value)
           
 void setCODEAlias(String value)
           
 void setCurlib(String value)
           
 void setEventFileCommandDetector(ISeriesEventFileCommandDetector evfDetector)
          Sets the events file detector to the given object.
 void setExtraAttributes(String value)
           
 void setInitialCommand(String value)
           
 void setInitialSystemLibraryList(String[] libraries, String[] positions)
          Set the initial library list entries, all in one shot, using a pair of String arrays
 void setRunServerRemotely(boolean value)
           
 void setSBMJobParms(String value)
           
 void unsetSBMJobParms()
          Unsets the value of the 'SBM Job Parms' attribute.
 void useDefaultEventFileDetector()
          Set the events file detector to the default one, ISeriesEventFileCommandDetector.
 
Methods inherited from interface com.ibm.etools.iseries.core.IISeriesSubSystem
getCmdSubSystem, getCommandExecutionProperties, getISeriesSystem, getObjectSubSystem, getShell, getToolboxAS400Object, setShell
 
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
 
Methods inherited from interface com.ibm.etools.systems.subsystems.RemoteCmdSubSystem
addEnvironmentVariable, addEnvironmentVariable, cancelShell, canRunCommand, canRunShell, getCandidateCommands, getDefaultShell, getEnvironmentVariable, getEnvironmentVariableList, getEnvironmentVariableValue, getExecutedCommands, getInvalidEnvironmentVariableNameCharacters, getParentRemoteCmdSubSystemFactory, getShells, removeEnvironmentVariable, removeEnvironmentVariable, removeShell, restoreShellState, runCommand, runShell, sendCommandToShell, setEnvironmentVariableList
 

Field Detail

copyright

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

getInitialSystemLibraryList

public SystemLibraryListEntry[] getInitialSystemLibraryList()
Get the initial library list as a string of SystemLibraryListEntry objects. Array returned may be size zero but will not be null.


setInitialSystemLibraryList

public void setInitialSystemLibraryList(String[] libraries,
                                        String[] positions)
Set the initial library list entries, all in one shot, using a pair of String arrays


addLibraryListEntry

public void addLibraryListEntry(String library,
                                String position)
Add library list entry


removeLibraryListEntry

public void removeLibraryListEntry(SystemLibraryListEntry slle)
Remove library list entry given its SystemLibraryListEntry object


removeLibraryListEntry

public void removeLibraryListEntry(String library)
Remove library list entry given only its library name


getSystemLibraryListEntry

public SystemLibraryListEntry getSystemLibraryListEntry(String library)
Given a library name, find its SystemLibraryListEntry object


promptCommand

public String promptCommand(String command)
Prompt remote command Return prompted command


isInteractiveJobAvailable

public boolean isInteractiveJobAvailable()
Interactive command support.

Returns true if the user has started this communication session via the STRRSESERVER iSeries command, enabling use of interactive commands.


attachInteractiveJob

public int attachInteractiveJob(String jobName,
                                String queueName)
Interactive command support.

Attach to an iSeries interactive job. This requires there to be an interactive job started via the STRRSESERVER iSeries command.

See Also:
isInteractiveJobAvailable()

runInteractiveCommand

public Object[] runInteractiveCommand(String command)
Interactive command support.

Run an interactive iSeries QSYS command (vs QSHELL). This requires there to be an interactive job started via the STRRSESERVER iSeries command.

See Also:
isInteractiveJobAvailable()

runCommand

public Object[] runCommand(String command,
                           Shell shell,
                           int jobEnv)
                    throws Exception
Execute remote command, possibly in batch, interactive, or just the RSE Server

Parameters:
command - - iSeries CL command string to run
shell - - the shell to host the error message dialog, or password prompt, if needed. Can be null.
jobEnv - - one of IISeriesConstants.RUN_IN_BATCH, RUN_IN_INTERACTIVE or RUN_IN_RSESERVER
Returns:
array of ISeriesMessage objects, for each host message issued by the remote iSeries command analyzer
Throws:
Exception

runCommand

public Object[] runCommand(String command)
                    throws Exception
Execute remote command without a progress monitor Runs in our job, not in batch, not interactive.

Throws:
Exception

runCommand

public Object[] runCommand(String command,
                           IProgressMonitor monitor)
                    throws Exception
Execute remote command without a progress monitor Runs in our job, not in batch, not interactive.

Throws:
Exception

releaseInteractiveJob

public boolean releaseInteractiveJob()
Interactive command support.

Release the interactive job. If no interactive job is available, no harm done.


getInitialCommand

public String getInitialCommand()
Returns:
The value of the InitialCommand attribute Initial command to call at connect time

setInitialCommand

public void setInitialCommand(String value)
Parameters:
value - The new value of the InitialCommand attribute

getCurlib

public String getCurlib()
Returns:
The value of the Curlib attribute

setCurlib

public void setCurlib(String value)
Parameters:
value - The new value of the Curlib attribute

getCODEAlias

public String getCODEAlias()
Returns:
The value of the CODEAlias attribute

setCODEAlias

public void setCODEAlias(String value)
Parameters:
value - The new value of the CODEAlias attribute

getSBMJobParms

public String getSBMJobParms()
Returns:
The value of the SBMJobParms attribute This is now deprecated. Use SBMJOBParms attribute in FileSubSystem.

setSBMJobParms

public void setSBMJobParms(String value)
Parameters:
value - The new value of the SBMJobParms attribute

unsetSBMJobParms

public void unsetSBMJobParms()
Unsets the value of the 'SBM Job Parms' attribute.

See Also:
isSetSBMJobParms(), getSBMJobParms(), setSBMJobParms(String)

isSetSBMJobParms

public boolean isSetSBMJobParms()
Returns whether the value of the 'SBM Job Parms' attribute is set.

Returns:
whether the value of the 'SBM Job Parms' attribute is set.
See Also:
unsetSBMJobParms(), getSBMJobParms(), setSBMJobParms(String)

getExtraAttributes

public String getExtraAttributes()
Returns:
The value of the ExtraAttributes attribute

setExtraAttributes

public void setExtraAttributes(String value)
Parameters:
value - The new value of the ExtraAttributes attribute

getInitialLibraryList

public org.eclipse.emf.common.util.EList getInitialLibraryList()
Returns:
The list of InitialLibraryList references

isRunServerRemotely

public boolean isRunServerRemotely()
Returns:
The value of the RunServerRemotely attribute Set to true to run the server on the remote iSeries system, versus locally

setRunServerRemotely

public void setRunServerRemotely(boolean value)
Parameters:
value - The new value of the RunServerRemotely attribute

getASPGroup

public String getASPGroup()
Returns:
The value of the ASPGroup attribute For IASP support. The name of the ASP group

setASPGroup

public void setASPGroup(String value)
Parameters:
value - The new value of the ASPGroup attribute

getEnvVars

public org.eclipse.emf.common.util.EList getEnvVars()
Specified by:
getEnvVars in interface com.ibm.etools.systems.subsystems.RemoteCmdSubSystem
Returns:
The list of EnvVars references

setEventFileCommandDetector

public void setEventFileCommandDetector(ISeriesEventFileCommandDetector evfDetector)
Sets the events file detector to the given object. An events file detector determines if a command generates events files and has a utility method for determining the name of the events file member.

Parameters:
evfDetector - the events file detector.

useDefaultEventFileDetector

public void useDefaultEventFileDetector()
Set the events file detector to the default one, ISeriesEventFileCommandDetector.


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.