iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core.cache
Class JobSubSystemCacheHandler

java.lang.Object
  extended bycom.ibm.etools.iseries.core.cache.AbstractCacheHandler
      extended bycom.ibm.etools.iseries.core.cache.JobSubSystemCacheHandler
All Implemented Interfaces:
ISeriesDataStoreConstants

public class JobSubSystemCacheHandler
extends AbstractCacheHandler
implements ISeriesDataStoreConstants

This class handles all caching for the native file system DataElements. It uses the caching manager to handle the reading and writing of the DataStore tree. Job Miner structure for relevant cached information: _minerData | ---------------------------------------------------------------------- | | | | | systemInfo commServerInfo sortSeqTableInfo editMaskInfo CRDAInfo | | -------------------- | | editCodes | ...


Field Summary
static String copyright
           
 
Fields inherited from class com.ibm.etools.iseries.core.cache.AbstractCacheHandler
CACHE_DEPTH, cacheMgr, minerRoot
 
Fields inherited from interface com.ibm.etools.iseries.core.dstore.common.ISeriesDataStoreConstants
ABSTRACT_FILTER_DESCRIPTOR, ABSTRACT_NATIVE_FSO_DESCRIPTOR, API_ERROR, API_ERROR_DESCRIPTOR, API_OK, API_PTF_MISSING, API_RESULT_DESCRIPTOR, API_RETURN_CODE, AUTHORITY_LIST_NODE, AUTHORITY_NODE, BATCHCOMMAND_DESCRIPTOR, C_GET_EDIT_CCSID, C_LDA_READ, C_LDA_WRITE, C_USER_PREFERENCES_DIRECTORY, CCSID_DESCRIPTOR, CDRA_INFO, CHECK_AUTHORITY_COMMAND, CLEAR_LOCAL_CACHE, CMD_DEBUG_RELEASE_APPLICATION, CMD_DEBUG_SPAWN_AND_HOLD, CMD_GET_DEBUG_ROUTER_PORT, CMD_IJOB_ASSOCIATE, CMD_IJOB_RELEASE, CMD_IJOB_RUNPGM, CMD_MULTI_SPAWNFAIL, CMD_MULTI_SPAWNSUCC, CMD_RUNBATCHCOMMAND, CMD_RUNBATCHCOMMAND_NOHELP, CMD_RUNCOMMAND, CMD_RUNCOMMAND_MULTITHREADED, CMD_RUNCOMMAND_MULTITHREADED_NOHELP, CMD_RUNCOMMAND_NOHELP, COMM_SERVER_INFORMATION, COMMAND_DESCRIPTOR, COMMAND_FILTER_DESCRIPTOR, COMMAND_MINER, COMMAND_MINER_ROOT_ELEMENT, COMMAND_QUERY_DB_FIELDS, COMMAND_QUERY_DB_KEYS, COMMAND_QUERY_DSPF_ALL, COMMAND_QUERY_MODULE_LIST, COMMAND_QUERY_PROCEDURE_LIST, CREATE_EDIT_MASK, CURRENT_WORKING_DIR, CURRENT_WORKING_DIR_DESCRIPTOR, DBFIELD_ALIAS, DBFIELD_ALLOC_LENGTH, DBFIELD_ALWNUL, DBFIELD_CCSID_SPECIFIED, DBFIELD_COLHEAD1, DBFIELD_COLHEAD2, DBFIELD_COLHEAD3, DBFIELD_DATA_CCSID, DBFIELD_DATTIMFMT, DBFIELD_DATTIMSEP, DBFIELD_DBCS_ALTTYPE, DBFIELD_DBCS_COLHEAD, DBFIELD_DBCS_TEXTDESC, DBFIELD_DBCS_VALCHECK, DBFIELD_DECPOS, DBFIELD_DESCRIPTION, DBFIELD_DIGITS, DBFIELD_DISPLAY_LEN_FLAG, DBFIELD_DISPLAY_LENGTH, DBFIELD_DTFLAGS, DBFIELD_EDITCODE, DBFIELD_EDITCODE_SYMBOL, DBFIELD_EDITWORD, DBFIELD_ENCODING_SCHEME, DBFIELD_GENERIC_KEY_COUNT, DBFIELD_INBUF, DBFIELD_INTNAME, DBFIELD_KEYFIELD_ATTRS, DBFIELD_LENGTH, DBFIELD_MAXKEYLEN, DBFIELD_MIN_DISPLAY_LEN_FLAG, DBFIELD_NUMDBCS, DBFIELD_OPERATOR, DBFIELD_OUTBUF, DBFIELD_REF_FIELD, DBFIELD_REFSHIFT, DBFIELD_SST_END, DBFIELD_SST_START, DBFIELD_TYPE, DBFIELD_UCS2_CONVERT_FLAG, DBFIELD_USAGE, DBFIELD_VARLENGTH, DEBUG_HELD_JOB_DESCRIPTOR, DOWNLOAD_RESULT_AS400_SECURITY_EXCEPTION, DSPFFD_INBUF, DSPFFD_OUTBUF, EDCODE_CURSYM, EDCODE_DATESEP, EDCODE_DECSEP, EDCODE_JOBDESC, EDCODE_JOBDESCLIB, EDCODE_SYSDATE, EDCODE_TIMESEP, EDCODE_USERID, EDIT_CODE_DESCRIPTOR, EDIT_CODE_INFORMATION, EDIT_CODE_QUERY, EDIT_DESCRIPTION, EDIT_MASK_DESCRIPTOR, EDIT_MASK_INFO, EDTD_DECCHAR, EDTD_FILLCHAR, EDTD_FLOATSTR, EDTD_FRACTION_MASK, EDTD_INTMASK, EDTD_LEFTCHAR, EDTD_NEGCHAR, EDTD_POSCHAR, EDTD_RIGHTCHAR, EDTD_ZEROVAL, EDTM_RECLEN, ENVVAR_DESCRIPTOR, ENVVAR_INFO, ERROR_DESCRIPTOR, EVENTSFILE_DESCRIPTOR, FIELD_DESCRIPTOR, FIELD_LIST_NODE, FIELD_PROPERTIES_NODE, FILE_ACCPATHTYPE, FILE_ALTSEQ, FILE_BASEDONCOUNT, FILE_BASEDONFILES, FILE_DESCRIPTOR, FILE_DYNSEL, FILE_IGCFIELD, FILE_IGCLITERAL, FILE_JFILE, FILE_KEYACCESS, FILE_LANGID, FILE_OVERRIDE_INFO, FILE_OVERRIDE_SOURCE_DESCRIPTOR, FILE_OVERRIDE_TARGET_DESCRIPTOR, FILE_PROPERTIES_NODE, FILE_SELECTOMITLF, FILE_SRCFILE, IFS_FILE_FILTER_OBJECT, IFS_FILESYSTEM_MINER, IFS_FILTER_DESCRIPTOR, IFS_FOLDER_FILTER_OBJECT, IJOB_DATAQ_DESCRIPTOR, ISERIES_PROGRAM_DESCRIPTOR, JOB_DESCRIPTOR, JOB_FILTER_DESCRIPTOR, JOB_MINER, JOB_MINER_LOG_ELEMENT, JOB_MINER_ROOT_ELEMENT, JOB_PROPERTY_DESCRIPTOR, JOB_PROPERTY1_ELEMENT, JOB_PROPERTY2_ELEMENT, JOB_PROPERTY3_ELEMENT, JOB_PROPERTYINT_ELEMENT, JOBCMD_CHGJOB, JOBCMD_DSPJOBLOG, JOBCMD_ENDJOB, JOBCMD_ENDJOB_IMMED, JOBCMD_HOLDJOB, JOBCMD_QRYJOB_ALL_PROPERTIES, JOBCMD_QRYJOB_PROPERTY, JOBCMD_QRYJOB_PROPERTYP2, JOBCMD_QRYJOB_PROPERTYP3, JOBCMD_QRYJOB_PROPERTYPINT, JOBCMD_RELEASEJOB, JOBFILTERCMD_QUERY, JOBNAME_DESCRIPTOR, JOBPROP_ACCTCODE, JOBPROP_ACTIVESTATUS, JOBPROP_AUXIO, JOBPROP_BREAKMSGHDL, JOBPROP_CCSID, JOBPROP_CNTRYID, JOBPROP_CTLDENDREQ, JOBPROP_CURRSYSPOOL, JOBPROP_CURRUSER, JOBPROP_DATE_ENTERED, JOBPROP_DATE_STARTED, JOBPROP_DATEFMT, JOBPROP_DATESEP, JOBPROP_DBCSCAP, JOBPROP_DECFMT, JOBPROP_DESCRIPTION, JOBPROP_DEVRCYACT, JOBPROP_DFTCCSID, JOBPROP_ENDSEV, JOBPROP_INQMSGRPLY, JOBPROP_ITRANS, JOBPROP_KEEPDDMACT, JOBPROP_LANGID, JOBPROP_LOGCLP, JOBPROP_LOGLVL, JOBPROP_LOGSEV, JOBPROP_LOGTXT, JOBPROP_MAXCPU, JOBPROP_MAXTMPSTOR, JOBPROP_MSGQACT, JOBPROP_MSGQMAX, JOBPROP_OUTQ, JOBPROP_OUTQ_PTY, JOBPROP_PGMRC, JOBPROP_PRODRC, JOBPROP_PRTDEV, JOBPROP_PRTKEYFMT, JOBPROP_PRTTXT, JOBPROP_PURGE, JOBPROP_ROUTING, JOBPROP_RUNPTY, JOBPROP_SORTTAB, JOBPROP_SPECENV, JOBPROP_STATUSMSGHDL, JOBPROP_SUBMITNAME, JOBPROP_SUBMITNUMBER, JOBPROP_SUBMITUSER, JOBPROP_SUBSYSTEM, JOBPROP_SUBTYPE, JOBPROP_SWITCHES, JOBPROP_SYSPOOL, JOBPROP_THREADS, JOBPROP_TIMESEP, JOBPROP_TIMESLICE, JOBPROP_TIMESLICEPOOL, JOBPROP_TOTRESPTIME, JOBPROP_TYPE, JOBPROP_USEDCPU, JOBPROP_USEDTMPSTOR, JOBPROP_USERRC, JOBPROP_WAITTIME, KEYFIELD_LIST_NODE, KEYWORD_DESCRIPTOR, LDA_READ_EXCEPTION_DESCRIPTOR, LDA_READ_LIBRARY_NAME_DESCRIPTOR, LDA_READ_MEMBER_NAME_DESCRIPTOR, LDA_READ_NO_OUTPUT_DESCRIPTOR, LDA_WRITE_CCSID_DESCRIPTOR, LDA_WRITE_EXCEPTION_DESCRIPTOR, LDA_WRITE_LENGTH_DESCRIPTOR, LIB_FILTER_DESCRIPTOR, LIB_FILTER_STR_DESCRIPTOR, LIBRARY_DESCRIPTOR, LIBRARY_PROPERTIES_NODE, LIST_OBJ_LOCKS_COMMAND, MBR_FILTER_DESCRIPTOR, MBR_FILTER_STR_DESCRIPTOR, MEMBER_CHANGE_TIMESTAMP, MEMBER_CREATION_TIMESTAMP, MEMBER_DESCRIPTOR, MEMBER_NUMBER_OF_DELETED, MEMBER_NUMBER_OF_RECORDS, MEMBER_PROPERTIES_NODE, MEMBER_RESTOTE_TIMESTAMP, MEMBER_SAVE_TIMESTAMP, MESSAGE_DESCRIPTOR, MESSAGE_FILE_DESCRIPTOR, MESSAGED_DESCRIPTOR, MINER_VERSION, MODULE_DESCRIPTOR, MODULE_INTERNAL_DESCRIPTOR, MODULE_LANGID, MODULE_LIST_NODE, MODULE_PROPERTIES_NODE, MSGD_STRUCTURE_NODE, NATIVE_FILESYSTEM_MINER, NETINT_DESCRIPTOR, NETINT_LIST_NODE, NETINT_QUERY, NETWORK_ERROR_DESCRIPTOR, OBJ_FILTER_DESCRIPTOR, OBJ_FILTER_STR_DESCRIPTOR, OBJECT_DESCRIPTOR, OBJECT_PROPERTIES_NODE, PGM_DEBUGGABLE, PGM_OPM, PROCEDURE_DESCRIPTOR, PROCEDURE_LIST_NODE, PROGRAM_DESCRIPTOR, PROPERTY_DESCRIPTOR, QSYS_DESCRIPTOR, QUERY_CURRENT_WORKING_DIR, QUERY_DEVICE_RECORDS, QUERY_ENCODING_SCHEME, QUERY_ENV_VAR, QUERY_FIELD_LIST, QUERY_FILE_PROPERTIES, QUERY_MEMBER_PROPERTIES, QUERY_MESSAGE_DESCRIPTORS_COMMAND, QUERY_RECORD_LIST, QUERY_RECORD_PROPERTIES, RECORD_BUFFER_SIZE, RECORD_CCSID, RECORD_DESC, RECORD_DESCRIPTOR, RECORD_DEVICE_PROPERTIES, RECORD_FLDCNT, RECORD_HAS_SEP_IND_AREA, RECORD_HAS_START_LINE_NUM, RECORD_ISDBCS, RECORD_LEVELID, RECORD_LIST_NODE, RECORD_LOWEST_RESP_IND, RECORD_PROPERTIES_NODE, RECORD_RECLEN, RECORD_STANDARD_PROPERTIES, RECORD_TYPE, RELATIVE_FILTER_DESCRIPTOR, RESULT_MESSAGES_ELEMENT, RETRIEVE_FILE_OVERRIDE_COMMAND, SERVICE_PROGRAM_DESCRIPTOR, SORT_SEQ_TABLE, SORT_SEQ_TABLE_INFO, SPECIAL_FILTER_DESCRIPTOR, SQL_COLERROR, SQL_COLFIRSTBYTE, SQL_COLLASTBYTE, SQL_DESCRIPTOR, SQL_MSGFILE, SQL_MSGID, SQL_MSGLIB, SQL_MSGREPLACELEN, SQL_MSGREPLACETEXT, SQL_NUMSTMT, SQL_RECERORR, SQL_RECFIRSTBYTE, SQL_RECLASTBYTE, SQL_RETINFOLEN, SQL_STATE, SQL_SYNTAX_CHECK, SQL_SYNTAX_CHECK_INFO, SST_BYTESAVAIL, SST_BYTESRETURN, SST_COUNTRYID, SST_JOBCCSID, SST_LANGID, SST_QUERY, SST_SSTLIB, SST_SSTNAME, SST_SUBSITUTION, SST_TABLE, SST_TABLECCSID, SST_TABLELIB, SST_TABLENAME, SST_WEIGHT, STRUCTURE_NODE_DESCRIPTOR, SYSTEM_INFORMATION, SYSTEM_PROPERTY_DESCRIPTOR, SYSTEM_QIGC, SYSTEM_VRM, TABLE_DESCRIPTOR
 
Constructor Summary
JobSubSystemCacheHandler(com.ibm.etools.systems.dstore.core.model.DataElement minerRoot, com.ibm.etools.systems.subsystems.ISystem system)
          Constructor for JobSubSystemCacheHandler.
 
Method Summary
protected  StringBuffer getKeyForObject(com.ibm.etools.systems.dstore.core.model.DataElement object)
          Builds the cache key for the specified DataElement.
 com.ibm.etools.systems.dstore.core.model.DataElement loadCRDAInfo(String ccsid)
          Load the CRDA info node and children from cache
 com.ibm.etools.systems.dstore.core.model.DataElement loadEditDescriptions()
          Method loadEditDescriptions.
 com.ibm.etools.systems.dstore.core.model.DataElement loadEditMaskInfo()
          Write the edit mask information to the cache
 com.ibm.etools.systems.dstore.core.model.DataElement loadEnvironmentVariable(String variableName)
          Method loadEnvironmentVariable.
 void loadJobProperties(com.ibm.etools.systems.dstore.core.model.DataElement job)
          Method loadJobProperties Note: This is currently only supported for the comm server job!!!
 com.ibm.etools.systems.dstore.core.model.DataElement loadServerJob()
          Method loadServerJob.
 com.ibm.etools.systems.dstore.core.model.DataElement loadSortSequenceTables(String name)
          Load the sort sequence table from the cache
 com.ibm.etools.systems.dstore.core.model.DataElement loadSystemInfoProperties()
          Load the system info properties from the cache
 void saveCRDAInfo(com.ibm.etools.systems.dstore.core.model.DataElement ccsidNode)
          Write single CCSID node which contains CRDA info to the cache
 void saveEditDescriptions(com.ibm.etools.systems.dstore.core.model.DataElement editCodeInfo)
          Method saveEditDescriptions.
 void saveEditMaskInfo(com.ibm.etools.systems.dstore.core.model.DataElement editMaskInfo)
          Write the edit mask information to the cache
 void saveEnvironmentVariable(com.ibm.etools.systems.dstore.core.model.DataElement envvar)
          Method saveEnvironmentVariable.
 void saveJobProperties(com.ibm.etools.systems.dstore.core.model.DataElement job)
          Method saveJobProperties.
 void saveServerJob(com.ibm.etools.systems.dstore.core.model.DataElement serverJob)
          Method saveServerJob.
 void saveSortSequenceTable(com.ibm.etools.systems.dstore.core.model.DataElement sst)
          Save the specified DataElement to the cache along with depth children.
 void saveSystemInfoProperties(com.ibm.etools.systems.dstore.core.model.DataElement sysInfo)
          Write the system info properties to the cache
 
Methods inherited from class com.ibm.etools.iseries.core.cache.AbstractCacheHandler
cacheNotAvailable, loadChild, save, save, save
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

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

JobSubSystemCacheHandler

public JobSubSystemCacheHandler(com.ibm.etools.systems.dstore.core.model.DataElement minerRoot,
                                com.ibm.etools.systems.subsystems.ISystem system)
Constructor for JobSubSystemCacheHandler.

Method Detail

saveSortSequenceTable

public void saveSortSequenceTable(com.ibm.etools.systems.dstore.core.model.DataElement sst)
Save the specified DataElement to the cache along with depth children.


loadSortSequenceTables

public com.ibm.etools.systems.dstore.core.model.DataElement loadSortSequenceTables(String name)
Load the sort sequence table from the cache


saveEditMaskInfo

public void saveEditMaskInfo(com.ibm.etools.systems.dstore.core.model.DataElement editMaskInfo)
Write the edit mask information to the cache


loadEditMaskInfo

public com.ibm.etools.systems.dstore.core.model.DataElement loadEditMaskInfo()
Write the edit mask information to the cache

Returns:
DataElement The edit mask info node for the JobMiner

saveSystemInfoProperties

public void saveSystemInfoProperties(com.ibm.etools.systems.dstore.core.model.DataElement sysInfo)
Write the system info properties to the cache


loadSystemInfoProperties

public com.ibm.etools.systems.dstore.core.model.DataElement loadSystemInfoProperties()
Load the system info properties from the cache

Returns:
The system information datastore node.

getKeyForObject

protected StringBuffer getKeyForObject(com.ibm.etools.systems.dstore.core.model.DataElement object)
Description copied from class: AbstractCacheHandler
Builds the cache key for the specified DataElement. Returns null if the cache key could not be built correctly (the other reason this would happen is if the object is not in the proper datastore tree structure.)

Specified by:
getKeyForObject in class AbstractCacheHandler
See Also:
This method not currently used for Job cache handler

saveCRDAInfo

public void saveCRDAInfo(com.ibm.etools.systems.dstore.core.model.DataElement ccsidNode)
Write single CCSID node which contains CRDA info to the cache


loadCRDAInfo

public com.ibm.etools.systems.dstore.core.model.DataElement loadCRDAInfo(String ccsid)
Load the CRDA info node and children from cache


saveEditDescriptions

public void saveEditDescriptions(com.ibm.etools.systems.dstore.core.model.DataElement editCodeInfo)
Method saveEditDescriptions.

Parameters:
editCodeInfo -

loadEditDescriptions

public com.ibm.etools.systems.dstore.core.model.DataElement loadEditDescriptions()
Method loadEditDescriptions.


loadEnvironmentVariable

public com.ibm.etools.systems.dstore.core.model.DataElement loadEnvironmentVariable(String variableName)
Method loadEnvironmentVariable.

Parameters:
variableName -
Returns:
DataElement

saveEnvironmentVariable

public void saveEnvironmentVariable(com.ibm.etools.systems.dstore.core.model.DataElement envvar)
Method saveEnvironmentVariable.

Parameters:
envvar -

saveServerJob

public void saveServerJob(com.ibm.etools.systems.dstore.core.model.DataElement serverJob)
Method saveServerJob.

Parameters:
serverJob -

loadServerJob

public com.ibm.etools.systems.dstore.core.model.DataElement loadServerJob()
Method loadServerJob.


saveJobProperties

public void saveJobProperties(com.ibm.etools.systems.dstore.core.model.DataElement job)
Method saveJobProperties.

Parameters:
job -

loadJobProperties

public void loadJobProperties(com.ibm.etools.systems.dstore.core.model.DataElement job)
Method loadJobProperties Note: This is currently only supported for the comm server job!!!

Parameters:
job -
Returns:
true if the Job's properties could be loaded from the cache, false if they could not be loaded from the cache.

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.