Interface ISystemDump
-
- All Superinterfaces:
ICICSObject,ICICSResource,com.ibm.cics.model.meta.ITypedObject
public interface ISystemDump extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classISystemDump.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classISystemDump.DAEOptionValueEnumeration type for field DAEOPTIONstatic classISystemDump.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classISystemDump.ShutdownOptionValueEnumeration type for field SHUTOPTIONstatic classISystemDump.SystemDumpOptionValueEnumeration type for field SYSDUMPINGstatic classISystemDump.SystemDumpScopeValueEnumeration type for field SDUMPSCOPE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ISystemDump.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDISystemDumpReferencegetCICSObjectReference()ISystemDump.DAEOptionValuegetDAEOption()Getter for field DAEOPTIONjava.lang.StringgetDataSpaceNameList()Getter for field DSPLISTjava.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEISystemDump.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.StringgetJobNameList()Getter for field JOBLISTjava.lang.LonggetMaximumSystemDumps()Getter for field MAXIMUMICICSType<ISystemDump>getObjectType()ISystemDump.ShutdownOptionValuegetShutdownOption()Getter for field SHUTOPTIONjava.lang.StringgetSystemDumpCode()Getter for field SYSDUMPCODEISystemDump.SystemDumpOptionValuegetSystemDumpOption()Getter for field SYSDUMPINGISystemDump.SystemDumpScopeValuegetSystemDumpScope()Getter for field SDUMPSCOPEjava.lang.LonggetSystemDumpsSinceReset()Getter for field CURRENTjava.lang.LonggetSystemDumpsSuppressed()Getter for field SDMPSUPPjava.lang.LonggetSystemDumpsTaken()Getter for field SDMPTOTL-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ISystemDump> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getSystemDumpCode
java.lang.String getSystemDumpCode()
Getter for field SYSDUMPCODESystem dump code
Specifies the 8-character system dump code for which the system dump table entry is to be modified. A valid system dump code contains no leading or imbedded blanks.
-
getSystemDumpsSinceReset
java.lang.Long getSystemDumpsSinceReset()
Getter for field CURRENTNumber of dump calls since last reset
The number of dump calls that have been made for this system dump code since the value was last reset to 0. This value can be reset using the INITIALIZE action command.
Note that it is possible for this value to be higher than the value in the System Dumps Taken field, which is reset by CICS end-of-day. If this value was initialized shortly before the end-of-day statistics reset, the number of current dumps could exceed the total number of dumps taken.
-
getMaximumSystemDumps
java.lang.Long getMaximumSystemDumps()
Getter for field MAXIMUMMaximum number of dumps with this code
The maximum number of dump calls for this system dump code that result in a system dump being taken.
Input Values: 0 - 999 (SYSDUMP only)
-
getShutdownOption
ISystemDump.ShutdownOptionValue getShutdownOption()
Getter for field SHUTOPTIONShutdown option
Indicates whether the CICS system is to be shut down after a call to this system dump code.
Input Values: SHUTDOWN, NOSHUTDOWN
-
getSystemDumpOption
ISystemDump.SystemDumpOptionValue getSystemDumpOption()
Getter for field SYSDUMPINGSystem dump option
Specifies whether a system dump request with this code should produce a dump. CVDA values are:
- NOSYSDUMP - A dump is not to be taken.
- SYSDUMP - A dump is to be taken.
-
getSystemDumpsTaken
java.lang.Long getSystemDumpsTaken()
Getter for field SDMPTOTLNumber of system dumps taken
The number of system dumps taken for this system dump code since the last CICS end-of-day statistics reset. This number does not include suppressed dumps.
-
getSystemDumpsSuppressed
java.lang.Long getSystemDumpsSuppressed()
Getter for field SDMPSUPPNumber of system dumps suppressed
The number of system dumps requested for this system dump code (by CICS or a user) that were suppressed by one of the following:
- a user exit
- the dump table
- a global system dump suppression
-
getSystemDumpScope
ISystemDump.SystemDumpScopeValue getSystemDumpScope()
Getter for field SDUMPSCOPESystem dump scope type
Indicates whether SDUMP requests with this system dump code are sent to other MVS images in the sysplex. The MVS images would be those that are running XCF/MRO connected CICS systems related to the CICS system that initiated the dump request:
- LOCAL - SDUMP requests are not sent to related CICS systems.
- RELATED - SDUMP requests are sent to related CICS systems. The CICS systems must be running under MVS/ESA 5.1 or later with the MVS workload manager.
-
getDAEOption
ISystemDump.DAEOptionValue getDAEOption()
Getter for field DAEOPTIONDump analysis and elimination (DAE) option
Indicates whether a dump produced for this system dump code is eligible for suppression by the MVS dump analysis and elimination (DAE) component:
- DAE - The dump is eligible for DAE suppression.
- NODAE - The dump is not eligible for DAE suppression. If CICS determines a dump should be written, MVS will not suppress it.
-
getJobNameList
java.lang.String getJobNameList()
Getter for field JOBLISTJob name list
Specifies a comma separated list of address space names that will be dumped when a dump with this dumpcode is performed. This attribute can only be modified through CEMT or the CICS System Programming Interface.
-
getDataSpaceNameList
java.lang.String getDataSpaceNameList()
Getter for field DSPLISTData space name list
Specifies a comma separated list of data space names that will be dumped when a dump with this dumpcode is performed. This attribute can only be modified through CEMT or the CICS System Programming Interface.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getChangeAgent
ISystemDump.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- DYNAMIC - The resource was last changed dynamically.
- SYSTEM - The resource was last changed by CICS.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource of the resource definition
The source of the definition, depending on which agent made the last change.
-
getDefineTime
java.util.Date getDefineTime()
Getter for field DEFINETIMECreation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getInstallAgent
ISystemDump.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- DYNAMIC - The resource was installed dynamically.
- SYSTEM - The resource was installed by CICS.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
-
getCICSObjectReference
ISystemDumpReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-