com.ibm.etools.iseries.services.qsys.jobs
Class QSYSJobService

java.lang.Object
  AbstractService
      com.ibm.etools.iseries.services.qsys.QSYSAbstractService
          com.ibm.etools.iseries.services.qsys.jobs.QSYSJobService

All Implemented Interfaces:

IQSYSJobService

public class QSYSJobService
extends QSYSAbstractService
implements IQSYSJobService

RSE service for access to IBM i operating system jobs and system related properties

Field Summary

static String

copyright

Fields inherited from class com.ibm.etools.iseries.services.qsys.QSYSAbstractService

sessionProvider

Constructor Summary

QSYSJobService(IToolboxSessionProvider toolboxProvider)
Constructor

Method Summary

IISeriesEditDescriptionsInfo	getEditDescriptions() Query the edit descriptions for the remote iSeries.
IISeriesEditMask	getEditMask(char editcode, char fillchar, int precision, int decimals) Create an edit mask from an edit code
int	getEncodingScheme(int ccsid) Query the encoding scheme for the CCSID
String	getEnvironmentVaraible(String variableName) Retrieve environment variable
IQSYSJob	getServerJob(IQSYSJobFactory factory, IProgressMonitor monitor) Get the server job for this service layer
IISeriesSortSequenceTable	getSortSequenceTable(String table, String library, String langID, int ccsid) Retrieve a sort sequence table from the iSeries
String	getSystemInfoProperty(String propertyName) Retrieve the value of a property which is contained in the environment miners system info child.
List<String>	handleDisplayJobLog(String jobName, String userName, String jobNumber, IProgressMonitor monitor) Query the job log of a particular job.
boolean	handleEndJob(String jobName, boolean immediately) End the specified job.
List<ISeriesTCPIPNetworkInterface>	handleQueryNetworkInterfaces() Query the network interfaces for this system.
IQSYSJob[]	listJobs(ISeriesJobFilterString filter, IProgressMonitor monitor) List the jobs that match the job filter string.
IQSYSJob[]	listJobs(ISeriesJobFilterString filter, IQSYSJobFactory factory, IProgressMonitor monitor) List the jobs that match the job filter string.
void	setAllJobProperties(IQSYSJob targetJob, IProgressMonitor monitor) Set the properties for this job

Methods inherited from class com.ibm.etools.iseries.services.qsys.QSYSAbstractService

handleError

Methods inherited from class java.lang.Object

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

Field Detail

copyright

public static String copyright

Constructor Detail

QSYSJobService

public QSYSJobService(IToolboxSessionProvider toolboxProvider)

Constructor

Parameters:

toolboxProvider -

Method Detail

listJobs

public IQSYSJob[] listJobs(ISeriesJobFilterString filter,
                           IProgressMonitor monitor)
                    throws SystemMessageException,
                           InterruptedException

List the jobs that match the job filter string.

Throws:

SystemMessageException

InterruptedException

listJobs

public IQSYSJob[] listJobs(ISeriesJobFilterString filter,
                           IQSYSJobFactory factory,
                           IProgressMonitor monitor)
                    throws SystemMessageException,
                           InterruptedException

List the jobs that match the job filter string.

Throws:

SystemMessageException

InterruptedException

handleQueryNetworkInterfaces

public List<ISeriesTCPIPNetworkInterface> handleQueryNetworkInterfaces()
                                                                throws SystemMessageException

Query the network interfaces for this system. This was added because each system can have multiple IP addresses and we need to check if the system where STRRSESVR is run is the same system that the associated RSE connection is defined for. We cannot do a simple compare of the two addresses because the address the RSE connection's hostname resolves to might be a different address than the STRRSESVR uses to "callback".

Throws:

SystemMessageException

getServerJob

public IQSYSJob getServerJob(IQSYSJobFactory factory,
                             IProgressMonitor monitor)
                      throws SystemMessageException

Get the server job for this service layer

Throws:

SystemMessageException

setAllJobProperties

public void setAllJobProperties(IQSYSJob targetJob,
                                IProgressMonitor monitor)
                         throws SystemMessageException

Set the properties for this job

Throws:

SystemMessageException

handleDisplayJobLog

public List<String> handleDisplayJobLog(String jobName,
                                        String userName,
                                        String jobNumber,
                                        IProgressMonitor monitor)
                                 throws SystemMessageException

Query the job log of a particular job.

Parameters:

jobName - name of the job

userName - user id of the job

jobNumber - job numberb

Returns:

List of the message strings in the job log.

Throws:

SystemMessageException

getEnvironmentVaraible

public String getEnvironmentVaraible(String variableName)
                              throws SystemMessageException

Retrieve environment variable

Throws:

SystemMessageException

getSystemInfoProperty

public String getSystemInfoProperty(String propertyName)
                             throws SystemMessageException

Retrieve the value of a property which is contained in the environment miners system info child. Constants from @link IQSYSSystemValueConstants

Returns:

The String value of the property or "" if the property was not found.

Throws:

SystemMessageException

getSortSequenceTable

public IISeriesSortSequenceTable getSortSequenceTable(String table,
                                                      String library,
                                                      String langID,
                                                      int ccsid)
                                               throws SystemMessageException

Retrieve a sort sequence table from the iSeries

Parameters:

table - The name of the sort sequence table

library - The library where the table resides

langID - The language identifier of the sort sequence table to be used

ccsid - The CCSID in which the table is to be returned

Throws:

SystemMessageException

getEditDescriptions

public IISeriesEditDescriptionsInfo getEditDescriptions()
                                                 throws SystemMessageException

Query the edit descriptions for the remote iSeries.

Returns:

The edit descriptions info instance which contains system values for processing edit codes and the user defined edit codes (edit descriptions) on the iSeries.

Throws:

SystemMessageException

getEditMask

public IISeriesEditMask getEditMask(char editcode,
                                    char fillchar,
                                    int precision,
                                    int decimals)
                             throws SystemMessageException

Create an edit mask from an edit code

Parameters:

table - The name of the sort sequence table

library - The library where the table resides

langID - The language identifier of the sort sequence table to be used

ccsid - The CCSID in which the table is to be returned

Throws:

SystemMessageException

getEncodingScheme

public int getEncodingScheme(int ccsid)
                      throws SystemMessageException

Query the encoding scheme for the CCSID

Parameters:

ccsid - The CCSID to query

Returns:

The encoding scheme for the CCSID

Throws:

SystemMessageException

handleEndJob

public boolean handleEndJob(String jobName,
                            boolean immediately)
                     throws SystemMessageException

End the specified job.

Parameters:

jobName - full job name in the format: jobNumber/userName/jobName

immediately - if true is specified, the job will be ended immediately. if false is specified, the job will be ended controlled

Throws:

SystemMessageException