com.ibm.etools.iseries.subsystems.qsys.commands
Class QSYSCommandSubSystem

java.lang.Object
  SubSystem
      com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem
          com.ibm.etools.iseries.subsystems.qsys.commands.QSYSCommandSubSystem

All Implemented Interfaces:

IQSYSCommandSubSystem, IISeriesSubSystem, IQSYSSubSystemCommandExecutionProperties

public class QSYSCommandSubSystem
extends QSYSAbstractSubSystem
implements IQSYSCommandSubSystem, IQSYSSubSystemCommandExecutionProperties

Field Summary

boolean	eventFileTrace
static String[]	INTERACTIVE_CMD_PREFIXES
static int	RUN_IN_BATCH
static String	RUN_IN_BATCH_CMD_PREFIX
static int	RUN_IN_INTERACTIVE
static String	RUN_IN_INTERACTIVE_CMD_PREFIX
static int	RUN_IN_RSESERVER
static String	RUN_IN_RSESERVER_CMD_PREFIX
static int	RUN_IN_RSESERVERMULTITHREADED
static String	RUN_IN_RSESERVERMULTITHREADED_CMD_PREFIX
static String	SBM_JOB_PARMS_EDEFAULT

Fields inherited from class com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem

copyright

Fields inherited from interface com.ibm.etools.iseries.subsystems.qsys.commands.IQSYSCommandSubSystem

copyright

Fields inherited from interface com.ibm.etools.iseries.subsystems.qsys.objects.IQSYSSubSystemCommandExecutionProperties

Copyright

Constructor Summary

QSYSCommandSubSystem(IHost host, IConnectorService connectorService)

Method Summary

int	attachInteractiveJob(String jobName, String queueName) Attach to an iSeries interactive job.
void	clearCommandLog() Clear log of executed commands on subsystem.
void	communicationsStateChange(CommunicationsEvent commEvent)
protected void	fireEvent(ISystemResourceChangeEvent event)
ISubSystem	getCmdSubSystem() Return the command subsystem ("iSeries Commands") for executing remote QSYS commands
String	getCommandLogAsString() Provide log of executed commands on subsystem.
boolean	getCompileInBatch() Command Execution property (like PDM's F18).
int	getDebugRouterListeningPortNumber() Start the program in a separate job that allows threads.
IRemoteSystemEnvVar	getEnvironmentVariable(String name) Given an environment variable name, find its RemoteSystemEnvVar object.
IRemoteSystemEnvVar[]	getEnvironmentVariableList() Get the initial environment variable list as a string of RemoteSystemEnvVar objects.
String	getEnvironmentVariableValue(String name) Given an environment variable name, find its RemoteSystemEnvVar object.
IPropertySet	getEnvVars()
String[]	getEnvVarsAsStringArray()
String[]	getExecutedCommands() Provide list of executed commands on subsystem.
String	getInitialCommand() Get the command that will be run at connect
String	getInitialCurlib() Get the initial current library property
IInitialLibraryListEntry[]	getInitialSystemLibraryList()
String	getInteractiveJobName() Get the job name of the associated interactive job.
String	getInternalJobDescription()
String	getInternalObjectLibrary()
String	getInternalSBMJOBParms()
String	getInvalidEnvironmentVariableNameCharacters() Default implementation of getInvalidEnvironmentVariableNameCharacters.
String	getJobDescription() Command Execution property (like PDM's F18).
SystemRemoteCommand	getLastCommand()
String	getObjectLibrary() Command Execution property (like PDM's F18).
ISubSystem	getObjectSubSystem() Return the objects subsystem ("iSeries Objects") for accessing remote QSYS libs, objs, mbrs, etc.
String	getOldCODEAlias() Get the old CODE Alias property
IQSYSObjectSubSystem	getQSYSObjectSubSystem() Return QSYSObjectSubsystem.
boolean	getReplaceObject() Command Execution property (like PDM's F18).
boolean	getRunInBatch() Command Execution property (like PDM's F18).
String	getSBMJOBParms() Command Execution property (like PDM's F18).
String	getUserPreferencesIFSDirectory() getUserPreferencesIFSDirectory() - returns directory on IFS where to store user settings
void	initializeSubSystem(IProgressMonitor monitor)
protected Object[]	internalResolveFilterString(String filterString, IProgressMonitor monitor) Actually resolve an absolute filter string.
Object[]	internalRunCommand(String cmd, Object context, boolean interpretOutput, IProgressMonitor monitor) Actually run a remote command.
Object[]	internalRunCommand(String cmd, Object context, IProgressMonitor monitor) Actually run a remote command.
static boolean	isInteractiveCommand(String commandString) Analyzes a given command to see if it appears to be interactive or not.
boolean	isInteractiveJobAvailable() Method from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties.
boolean	isInteractiveJobBusy() Check if the interactive job is currently busy processing a command.
boolean	isInternalCompileInBatch()
boolean	isInternalReplaceObject()
boolean	isInternalRunInBatch()
boolean	isPassiveCommunicationsListener()
boolean	isSetInternalCompileInBatch()
boolean	isSetInternalJobDescription()
boolean	isSetInternalObjectLibrary()
boolean	isSetInternalReplaceObject()
boolean	isSetInternalRunInBatch()
boolean	isSetInternalSBMJOBParms()
boolean	isShowEventsFile() Returns whether events file should be shown when a command that generates an events file is run.
protected void	logCommand(String cmd, Object[] msgs)
void	processBatchCommandResults(String cmd, IQSYSBatchCommandMonitor commandMonitor, boolean isBatch) processBatchCommandResults
String	promptCommand(String command) Prompt remote command Return prompted command
String	promptCommand(String command, boolean usePromptOverrideProgram)
String	promptCommand(String command, boolean usePromptOverrideProgram, boolean execute) Prompt remote command, specifying if the prompt override program for the command should be used (pass true if the command will prompted and then immediately executed).
boolean	releaseInteractiveJob(boolean writeToDataQ) Method from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties.
int	releaseThreadedApplication(String qualifiedJobName, String messageQueue, String messageKey) Release the job that was started with the runThreadedApplication api.
void	removeCheckBatchCommandThreads()
Object[]	runCommand(String command) Execute remote command without a progress monitor Runs in our job, not in batch, not interactive.
Object[]	runCommand(String command, int jobEnv) Execute remote command without a progress monitor, possibly in batch, interactive, or just the RSE Server
Object[]	runCommand(String command, Object context, boolean interpretOutput, IProgressMonitor monitor) overridden so that for universal we don't need to do in modal thread
Object[]	runCommand(String command, Object context, IProgressMonitor monitor) Execute a remote command.
void	runInitialCurrentDirectoy(IProgressMonitor monitor) Used to set the initial current directory when signing on.
Object[]	runInitialLibraryList(IProgressMonitor monitor) Setup the initial library list for connection time
Object[]	runInteractiveCommand(String command) Run an interactive iSeries QSYS command (vs QSHELL).
Object[]	runInteractiveCommand(String command, boolean queueCommand) Run an interactive iSeries QSYS command (vs QSHELL).
com.ibm.etools.iseries.services.qsys.internal.QSYSDebugHoldJobInfo	runThreadedApplication(String destinationName, String programName, String programParameters) Start the program in a separate job that allows threads.
void	setCurlib(String newCurlib)
void	setEnvironmentVariableList(String[] envVarNames, String[] envVarValues) Set the initial environment variable list entries, all in one shot, using a pair of String arrays: the first is the environment variable names, the second is the corresponding environment variable values.
void	setInitialCommand(String cmd) Set the command that will be run at connect time.
void	setInitialSystemLibraryList(String[] libraries, String[] positions) Set the initial library list entries, all in one shot, using a pair of String arrays
void	setInternalCompileInBatch(boolean newInternalCompileInBatch)
void	setInternalJobDescription(String newInternalJobDescription)
void	setInternalObjectLibrary(String newInternalObjectLibrary)
void	setInternalReplaceObject(boolean newInternalReplaceObject)
void	setInternalRunInBatch(boolean newInternalRunInBatch) Setter for internalRunInBatch flag.
void	setInternalSBMJOBParms(String newInternalSBMJOBParms)
void	setOldCODEAlias(String alias) Get the old CODE Alias property
void	setShowEventsFile(boolean showEventsFile) Sets whether events file should be shown when a command that generates an events file is run.
void	uninitializeSubSystem(IProgressMonitor monitor) Uninitialize this subsystem just after disconnect.
void	unsetInternalCompileInBatch()
void	unsetInternalJobDescription()
void	unsetInternalObjectLibrary()
void	unsetInternalReplaceObject()
void	unsetInternalRunInBatch()
void	unsetInternalSBMJOBParms()

Methods inherited from class com.ibm.etools.iseries.subsystems.qsys.QSYSAbstractSubSystem

checkIsConnected, checkIsConnected, checkIsConnected, processListRetrieveError, verifyConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RUN_IN_BATCH

public static final int RUN_IN_BATCH

See Also:

Constant Field Values

RUN_IN_INTERACTIVE

public static final int RUN_IN_INTERACTIVE

See Also:

Constant Field Values

RUN_IN_RSESERVER

public static final int RUN_IN_RSESERVER

See Also:

Constant Field Values

RUN_IN_RSESERVERMULTITHREADED

public static final int RUN_IN_RSESERVERMULTITHREADED

See Also:

Constant Field Values

RUN_IN_BATCH_CMD_PREFIX

public static final String RUN_IN_BATCH_CMD_PREFIX

See Also:

Constant Field Values

RUN_IN_INTERACTIVE_CMD_PREFIX

public static final String RUN_IN_INTERACTIVE_CMD_PREFIX

See Also:

Constant Field Values

RUN_IN_RSESERVER_CMD_PREFIX

public static final String RUN_IN_RSESERVER_CMD_PREFIX

See Also:

Constant Field Values

RUN_IN_RSESERVERMULTITHREADED_CMD_PREFIX

public static final String RUN_IN_RSESERVERMULTITHREADED_CMD_PREFIX

See Also:

Constant Field Values

SBM_JOB_PARMS_EDEFAULT

public static final String SBM_JOB_PARMS_EDEFAULT

eventFileTrace

public boolean eventFileTrace

INTERACTIVE_CMD_PREFIXES

public static final String[] INTERACTIVE_CMD_PREFIXES

Constructor Detail

QSYSCommandSubSystem

public QSYSCommandSubSystem(IHost host,
                            IConnectorService connectorService)

Method Detail

isInteractiveCommand

public static boolean isInteractiveCommand(String commandString)

Analyzes a given command to see if it appears to be interactive or not. Tests for obvious interactive command name patterns, such as starts with "STR", "WRK" or "CHG", or starts with "DSP" and there is no OUTFILE parameter.

internalResolveFilterString

protected Object[] internalResolveFilterString(String filterString,
                                               IProgressMonitor monitor)
                                        throws InvocationTargetException,
                                               InterruptedException

Actually resolve an absolute filter string. This is called by the run(IProgressMonitor monitor) method, which in turn is called by resolveFilterString.

Throws:

InvocationTargetException

InterruptedException

See Also:

org.eclipse.rse.core.subsystems.SubSystem#internalResolveFilterString(String,IProgressMonitor)

internalRunCommand

public Object[] internalRunCommand(String cmd,
                                   Object context,
                                   IProgressMonitor monitor)
                            throws InvocationTargetException,
                                   InterruptedException

Actually run a remote command. This is called by the run(IProgressMonitor monitor) method, which in turn is called by runCommand(...).

Throws:

InvocationTargetException

InterruptedException

internalRunCommand

public Object[] internalRunCommand(String cmd,
                                   Object context,
                                   boolean interpretOutput,
                                   IProgressMonitor monitor)
                            throws InvocationTargetException,
                                   InterruptedException

Actually run a remote command. This is called by the run(IProgressMonitor monitor) method, which in turn is called by runCommand(...). Note: we ignore the interpretOutput parameter

Throws:

InvocationTargetException

InterruptedException

getCommandLogAsString

public String getCommandLogAsString()

Provide log of executed commands on subsystem.

getLastCommand

public SystemRemoteCommand getLastCommand()

clearCommandLog

public void clearCommandLog()

Clear log of executed commands on subsystem.

promptCommand

public String promptCommand(String command)

Prompt remote command Return prompted command

promptCommand

public String promptCommand(String command,
                            boolean usePromptOverrideProgram)

promptCommand

public String promptCommand(String command,
                            boolean usePromptOverrideProgram,
                            boolean execute)

Prompt remote command, specifying if the prompt override program for the command should be used (pass true if the command will prompted and then immediately executed). PMR # 45563.122/45567.122 Return prompted command

fireEvent

protected void fireEvent(ISystemResourceChangeEvent event)

logCommand

protected void logCommand(String cmd,
                          Object[] msgs)

runInteractiveCommand

public Object[] runInteractiveCommand(String command)

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

Parameters:

command - The command to be run in the interactive job.

Returns:

An array of SystemMessageObject instances, each representing a message from the command.

See Also:

isInteractiveJobAvailable()

runInteractiveCommand

public Object[] runInteractiveCommand(String command,
                                      boolean queueCommand)

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

Parameters:

command - The command to be run in the interactive job.

queueCommand - Add the command to the queue if the interactive job is currently busy.

Returns:

An array of SystemMessageObject instances, each representing a message from the command.

See Also:

isInteractiveJobAvailable()

runCommand

public Object[] runCommand(String command,
                           Object context,
                           boolean interpretOutput,
                           IProgressMonitor monitor)
                    throws Exception

overridden so that for universal we don't need to do in modal thread

Throws:

Exception

runCommand

public Object[] runCommand(String command,
                           Object context,
                           IProgressMonitor monitor)
                    throws Exception

Execute a remote command. This is only applicable if the subsystem factory reports true for supportsCommands().

Parameters:

command - Command to be executed remotely.

context - context of a command (i.e. working directory). null is valid and means to use the default context.

Returns:

Array of objects that are the result of running this command. Typically, these are messages logged by the command.

Throws:

Exception

runCommand

public Object[] runCommand(String command,
                           int jobEnv)
                    throws Exception

Execute remote command without a progress monitor, possibly in batch, interactive, or just the RSE Server

Parameters:

command - - iSeries CL command string to run

jobEnv - - one of IISeriesConstants.RUN_IN_BATCH, RUN_IN_INTERACTIVE, RUN_IN_RSESERVER, RUN_IN_RSESERVERMULTITHREADED

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

getQSYSObjectSubSystem

public IQSYSObjectSubSystem getQSYSObjectSubSystem()

Return QSYSObjectSubsystem.

Specified by:

getQSYSObjectSubSystem in interface IQSYSCommandSubSystem

processBatchCommandResults

public void processBatchCommandResults(String cmd,
                                       IQSYSBatchCommandMonitor commandMonitor,
                                       boolean isBatch)

processBatchCommandResults

getCmdSubSystem

public ISubSystem getCmdSubSystem()

Description copied from interface: IISeriesSubSystem

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

Specified by:

getCmdSubSystem in interface IISeriesSubSystem

Overrides:

getCmdSubSystem in class QSYSAbstractSubSystem

getObjectSubSystem

public ISubSystem getObjectSubSystem()

Description copied from interface: IISeriesSubSystem

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".

Specified by:

getObjectSubSystem in interface IISeriesSubSystem

Overrides:

getObjectSubSystem in class QSYSAbstractSubSystem

getExecutedCommands

public String[] getExecutedCommands()

Provide list of executed commands on subsystem.

uninitializeSubSystem

public void uninitializeSubSystem(IProgressMonitor monitor)

Uninitialize this subsystem just after disconnect. The default implementation currently does nothing. Overriding methods should call super after doing their own work.

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.

getJobDescription

public String getJobDescription()

Command Execution property (like PDM's F18). Return the job description, which is used in batch compiles and commands. This is a library-qualified name. PDM User Action &J. If not set in this subsystem, value is returned from preferences page

Specified by:

getJobDescription in interface IQSYSSubSystemCommandExecutionProperties

Returns:

Qualified job description as specified in subsystem properties, or preferences. Will not be null, but might be an empty string. "*LIBL/USRPRF" is resolved to just "*USRPRF".

unsetInternalJobDescription

public void unsetInternalJobDescription()

isSetInternalJobDescription

public boolean isSetInternalJobDescription()

setInternalJobDescription

public void setInternalJobDescription(String newInternalJobDescription)

getInternalJobDescription

public String getInternalJobDescription()

getSBMJOBParms

public String getSBMJOBParms()

Command Execution property (like PDM's F18). Return additional parameters to SBMJOB RSE-Unique User Action Variable &ISJ. If not set in this subsystem, value is returned from preferences page.

Specified by:

getSBMJOBParms in interface IQSYSSubSystemCommandExecutionProperties

Returns:

Parameter string as specified in subsystem properties, or preferences. Will not be null, but might be an empty string.

isSetInternalRunInBatch

public boolean isSetInternalRunInBatch()

getRunInBatch

public boolean getRunInBatch()

Command Execution property (like PDM's F18). Return whether to run commands in batch. PDM User Action &E. If not set in this subsystem, value is returned from preferences page

Specified by:

getRunInBatch in interface IQSYSSubSystemCommandExecutionProperties

isInternalRunInBatch

public boolean isInternalRunInBatch()

getCompileInBatch

public boolean getCompileInBatch()

Command Execution property (like PDM's F18). Return whether to compile in batch. PDM User Action &P. If not set in this subsystem, value is returned from preferences page

Specified by:

getCompileInBatch in interface IQSYSSubSystemCommandExecutionProperties

isInternalCompileInBatch

public boolean isInternalCompileInBatch()

unsetInternalCompileInBatch

public void unsetInternalCompileInBatch()

isSetInternalCompileInBatch

public boolean isSetInternalCompileInBatch()

getReplaceObject

public boolean getReplaceObject()

Command Execution property (like PDM's F18). Return whether to replace the target object on a compile. PDM User Action &R. If not set in this subsystem, value is returned from preferences page

Specified by:

getReplaceObject in interface IQSYSSubSystemCommandExecutionProperties

isInternalReplaceObject

public boolean isInternalReplaceObject()

setInternalReplaceObject

public void setInternalReplaceObject(boolean newInternalReplaceObject)

unsetInternalReplaceObject

public void unsetInternalReplaceObject()

isSetInternalReplaceObject

public boolean isSetInternalReplaceObject()

getObjectLibrary

public String getObjectLibrary()

Command Execution property (like PDM's F18). Return the object library, which is used as the target on a compile. PDM User Action &O. If not set in this subsystem, value is returned from preferences page

Specified by:

getObjectLibrary in interface IQSYSSubSystemCommandExecutionProperties

Returns:

Object library as specified in subsystem properties, or preferences. Will not be null, but might be an empty string.

getInternalObjectLibrary

public String getInternalObjectLibrary()

setInternalObjectLibrary

public void setInternalObjectLibrary(String newInternalObjectLibrary)

unsetInternalObjectLibrary

public void unsetInternalObjectLibrary()

isSetInternalObjectLibrary

public boolean isSetInternalObjectLibrary()

getInternalSBMJOBParms

public String getInternalSBMJOBParms()

setInternalSBMJOBParms

public void setInternalSBMJOBParms(String newInternalSBMJOBParms)

unsetInternalSBMJOBParms

public void unsetInternalSBMJOBParms()

isSetInternalSBMJOBParms

public boolean isSetInternalSBMJOBParms()

setInternalRunInBatch

public void setInternalRunInBatch(boolean newInternalRunInBatch)

Setter for internalRunInBatch flag.

unsetInternalRunInBatch

public void unsetInternalRunInBatch()

setInternalCompileInBatch

public void setInternalCompileInBatch(boolean newInternalCompileInBatch)

getInvalidEnvironmentVariableNameCharacters

public String getInvalidEnvironmentVariableNameCharacters()

Default implementation of getInvalidEnvironmentVariableNameCharacters. This default implementation just returns "=" (the only invalid character is the = sign.) Subclasses can override this to provide a more comprehensive list.

See Also:

com.ibm.etools.systems.subsystems.RemoteCmdSubSystem#getInvalidEnvironmentVariableNameCharacters()

getEnvironmentVariableList

public IRemoteSystemEnvVar[] getEnvironmentVariableList()

Get the initial environment variable list as a string of RemoteSystemEnvVar objects. Array returned may be size zero but will not be null.

getEnvironmentVariable

public IRemoteSystemEnvVar getEnvironmentVariable(String name)

Given an environment variable name, find its RemoteSystemEnvVar object. Returns null if not found!

getEnvironmentVariableValue

public String getEnvironmentVariableValue(String name)

Given an environment variable name, find its RemoteSystemEnvVar object. Returns null if not found!

getEnvVarsAsStringArray

public String[] getEnvVarsAsStringArray()

getEnvVars

public IPropertySet getEnvVars()

setEnvironmentVariableList

public void setEnvironmentVariableList(String[] envVarNames,
                                       String[] envVarValues)

Set the initial environment variable list entries, all in one shot, using a pair of String arrays: the first is the environment variable names, the second is the corresponding environment variable values.

isInteractiveJobBusy

public boolean isInteractiveJobBusy()

Check if the interactive job is currently busy processing a command.

isInteractiveJobAvailable

public boolean isInteractiveJobAvailable()

Method from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties.

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

releaseInteractiveJob

public boolean releaseInteractiveJob(boolean writeToDataQ)

Method from interface com.ibm.etools.iseries.core.IISeriesSubSystemCommandExecutionProperties.

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

attachInteractiveJob

public int attachInteractiveJob(String jobName,
                                String queueName)

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

See Also:

isInteractiveJobAvailable()

getInitialCommand

public String getInitialCommand()

Get the command that will be run at connect

getInitialCurlib

public String getInitialCurlib()

Get the initial current library property

getInitialSystemLibraryList

public IInitialLibraryListEntry[] getInitialSystemLibraryList()

setCurlib

public void setCurlib(String newCurlib)

setInitialCommand

public void setInitialCommand(String cmd)

Set the command that will be run at connect time. This is the initial command, as set by the Communications Properties Page. This method will save the subsystem to disk.

setInitialSystemLibraryList

public void setInitialSystemLibraryList(String[] libraries,
                                        String[] positions)

Set the initial library list entries, all in one shot, using a pair of String arrays

runInitialLibraryList

public Object[] runInitialLibraryList(IProgressMonitor monitor)
                               throws InvocationTargetException,
                                      InterruptedException

Setup the initial library list for connection time

Throws:

InvocationTargetException

InterruptedException

initializeSubSystem

public void initializeSubSystem(IProgressMonitor monitor)

runInitialCurrentDirectoy

public void runInitialCurrentDirectoy(IProgressMonitor monitor)
                               throws InvocationTargetException,
                                      InterruptedException

Used to set the initial current directory when signing on.

Throws:

InvocationTargetException

InterruptedException

Since:

6.0 @V1A

getOldCODEAlias

public String getOldCODEAlias()

Get the old CODE Alias property

setOldCODEAlias

public void setOldCODEAlias(String alias)

Get the old CODE Alias property

communicationsStateChange

public void communicationsStateChange(CommunicationsEvent commEvent)

See Also:

com.ibm.etools.systems.subsystems.ICommunicationsListener#communicationsStateChange(CommunicationsEvent)

isPassiveCommunicationsListener

public boolean isPassiveCommunicationsListener()

See Also:

com.ibm.etools.systems.subsystems.ICommunicationsListener#isPassiveCommunicationsListener()

isShowEventsFile

public boolean isShowEventsFile()

Returns whether events file should be shown when a command that generates an events file is run.

Returns:

true if the events file should be shown, false otherwise.

setShowEventsFile

public void setShowEventsFile(boolean showEventsFile)

Sets whether events file should be shown when a command that generates an events file is run.

Parameters:

showEventsFile - true if the events file should be shown, false otherwise.

getDebugRouterListeningPortNumber

public int getDebugRouterListeningPortNumber()
                                      throws SystemMessageException

Start the program in a separate job that allows threads. This api is currently used by the iSeries debugger to start a user's program in a new (thread enabled) job and have the program hold until the debugger can attach to the job.

Throws:

SystemMessageException

getInteractiveJobName

public String getInteractiveJobName()

Get the job name of the associated interactive job.

Returns:

The job name for the associated interactive job or null if no interactive job is associated.

runThreadedApplication

public com.ibm.etools.iseries.services.qsys.internal.QSYSDebugHoldJobInfo runThreadedApplication(String destinationName,
                                                                                                 String programName,
                                                                                                 String programParameters)
                                                                                          throws SystemMessageException

Start the program in a separate job that allows threads. This api is currently used by the iSeries debugger to start a user's program in a new (thread enabled) job and have the program hold until the debugger can attach to the job.

Throws:

SystemMessageException

releaseThreadedApplication

public int releaseThreadedApplication(String qualifiedJobName,
                                      String messageQueue,
                                      String messageKey)
                               throws SystemMessageException

Release the job that was started with the runThreadedApplication api. Although this method is really job specific (and should therefore likely be in the Job subsystem) it is kept here because of it's close relationship with runThreadedApplication.

Returns:

The return code from the releaseThreadedApplication api or -1 if there was a problem calling the api.

Throws:

SystemMessageException

removeCheckBatchCommandThreads

public void removeCheckBatchCommandThreads()

getUserPreferencesIFSDirectory

public String getUserPreferencesIFSDirectory()

getUserPreferencesIFSDirectory() - returns directory on IFS where to store user settings