Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.subsystems.qsys.cache
Class QSYSJobCacheHandler

java.lang.Object
  extended by com.ibm.etools.iseries.subsystems.qsys.cache.AbstractCacheHandler
      extended by com.ibm.etools.iseries.subsystems.qsys.cache.QSYSJobCacheHandler

public class QSYSJobCacheHandler
extends AbstractCacheHandler

Cache handler for job subsystem.


Field Summary
static String copyright
           
static String EDITDESC_FILENAME
           
static String EDITMASKS_FILENAME
           
static String ENCODINGS_FILENAME
           
static String ENVVARS_FILENAME
           
static String SERVERJOB_FILENAME
           
static String SST_FILENAME
           
static String SYSTEM_PROPERTIES_FILENAME
           
 
Method Summary
static QSYSJobCacheHandler getInstance(QSYSJobSubSystem subsystem)
          Singleton access method.
 IISeriesEditDescriptionsInfo loadEditDescriptions()
          Load the edit descriptions from the cache.
 IISeriesEditMask loadEditMask(char editcode, char fillchar, int precision, int decimals)
          Load the edit mask from the cache.
 Integer loadEncodingScheme(int ccsid)
          Load the encoding for the specified ccsid
 String loadEnvironmentVariable(String variableName)
          Load the environment variable from the cache
 IQSYSJob loadServerJob(IQSYSJobFactory factory)
          Load the server job from the cache.
 ISeriesSortSequenceTable loadSortSequenceTable(ISubSystem subsystem, String table, String library, String langID, int ccsid)
          Save a sort sequence table.
 String loadSystemProperty(String propertyName)
          Laod the system property from the cache.
 void saveEditDescriptions(IISeriesEditDescriptionsInfo editDescInfo)
          Cache the edit description information for the remote system.
 void saveEditMask(char editcode, char fillchar, int precision, int decimals, IISeriesEditMask mask)
          Save the edit mask information.
 void saveEncodingScheme(int ccsid, int encoding)
          Save the encoding scheme.
 void saveEnvironmentVariable(String variableName, String value)
          Save the environment variable and value to the cache.
 void saveServerJob(IQSYSJob job)
          Save the server job and all it's properties.
 void saveSortSequenceTable(IISeriesSortSequenceTable table, String langID, int ccsid)
          Save a sort sequence table.
 void saveSystemProperty(String propertyName, String value)
           
static void updateCacheLocation(String newLocation)
          Updates the cache location of every handler
 
Methods inherited from class com.ibm.etools.iseries.subsystems.qsys.cache.AbstractCacheHandler
addToOutputXNumberOfLines, backupAndDeleteCacheFile, checkCacheSize, getCacheRootDirectory, getListingDetailsFileName, getReader, getWriter, isCachingDisabled, setCacheLocation, skipNumberOfLines, writeFile
 
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

SST_FILENAME

public static final String SST_FILENAME
See Also:
Constant Field Values

EDITMASKS_FILENAME

public static final String EDITMASKS_FILENAME
See Also:
Constant Field Values

EDITDESC_FILENAME

public static final String EDITDESC_FILENAME
See Also:
Constant Field Values

ENCODINGS_FILENAME

public static final String ENCODINGS_FILENAME
See Also:
Constant Field Values

ENVVARS_FILENAME

public static final String ENVVARS_FILENAME
See Also:
Constant Field Values

SYSTEM_PROPERTIES_FILENAME

public static final String SYSTEM_PROPERTIES_FILENAME
See Also:
Constant Field Values

SERVERJOB_FILENAME

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

getInstance

public static QSYSJobCacheHandler getInstance(QSYSJobSubSystem subsystem)
Singleton access method.


updateCacheLocation

public static void updateCacheLocation(String newLocation)
Updates the cache location of every handler

Parameters:
newLocation - The new location the cache should cache files to now

saveSortSequenceTable

public void saveSortSequenceTable(IISeriesSortSequenceTable table,
                                  String langID,
                                  int ccsid)
Save a sort sequence table. File format (names are fully resolved): LIBRARY/TABLE(LANGID:CCSID) table name table library table CCSID weighting has substitution variables {true | false} job SST name job SST library job language ID job country ID job CCSID bytes available bytes returned SST (byte[]}


loadSortSequenceTable

public ISeriesSortSequenceTable loadSortSequenceTable(ISubSystem subsystem,
                                                      String table,
                                                      String library,
                                                      String langID,
                                                      int ccsid)
                                               throws SystemMessageException
Save a sort sequence table. File format (names are fully resolved):

Throws:
InterruptedException
SystemMessageException

saveEditMask

public void saveEditMask(char editcode,
                         char fillchar,
                         int precision,
                         int decimals,
                         IISeriesEditMask mask)
Save the edit mask information. This is saved to file: editmasks.cache with the following format: editcode/fillchar/precision/decimals (this is the entry key) editMask length receiverLength fill character


loadEditMask

public IISeriesEditMask loadEditMask(char editcode,
                                     char fillchar,
                                     int precision,
                                     int decimals)
Load the edit mask from the cache. See the saveEditMask method for details on the file format.

See Also:
saveEditMask(char, char, int, int, IISeriesEditMask)

saveEncodingScheme

public void saveEncodingScheme(int ccsid,
                               int encoding)
Save the encoding scheme. File format is: ccsid encoding


loadEncodingScheme

public Integer loadEncodingScheme(int ccsid)
Load the encoding for the specified ccsid


saveEnvironmentVariable

public void saveEnvironmentVariable(String variableName,
                                    String value)
Save the environment variable and value to the cache.


loadEnvironmentVariable

public String loadEnvironmentVariable(String variableName)
Load the environment variable from the cache


loadSystemProperty

public String loadSystemProperty(String propertyName)
Laod the system property from the cache.


saveSystemProperty

public void saveSystemProperty(String propertyName,
                               String value)
Parameters:
propertyName -
value -

saveEditDescriptions

public void saveEditDescriptions(IISeriesEditDescriptionsInfo editDescInfo)
Cache the edit description information for the remote system. Format is: currency symbol date format decimal separator date separator time separator user ID job description job description library edit description count number integer mask decimal point character fraction mask fill character edit zero values {true | false} negative status characters positive status characters left constant characters right constant characters description floating string


loadEditDescriptions

public IISeriesEditDescriptionsInfo loadEditDescriptions()
Load the edit descriptions from the cache.


saveServerJob

public void saveServerJob(IQSYSJob job)
Save the server job and all it's properties. Format of cache file: job name job user job number type status subsystem current user date entered {true | false} (if true, then international properties are written ccsid default ccsid date format date separator time separator decimal format language ID country ID SST dbcs capable {true | false} (if true, then definition properties are written outq outq priority printer printer text print key format routing data current system pool time slice end pool product return code user return code program return code switch settings break msg handling status msg handling inquiry msg reply end severity log CL programs logging level logging severity logging text msgq max size msgq action device recovery action keep DDM connections alive accounting code {true | false} (if true, then run properties are written run priority time slice elgible for purge default wait time max CPU time CPU time used max temp storage temp storage used thread count auxiliary IO requests interactive transactions total response time {true | false} (if true, then status properties are written active status current user type subtype date entered date started subsystem system pool job description submitted job name submitted job user submitted job number controlled end


loadServerJob

public IQSYSJob loadServerJob(IQSYSJobFactory factory)
Load the server job from the cache. See saveServerJob(IQSYSJob) for file format details.

Parameters:
factory -

Rational Developer for Power Systems Software
V7.6

Copyright 2011 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.