Interface IDB2Entry
-
- All Superinterfaces:
ICICSObject,ICICSResource,IInstalledCICSResource,com.ibm.cics.model.meta.ITypedObject
public interface IDB2Entry extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIDB2Entry.AccountrecValueEnumeration type for field ACCOUNTRECstatic classIDB2Entry.AuthtypeValueEnumeration type for field AUTHTYPEstatic classIDB2Entry.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIDB2Entry.DisabledactValueEnumeration type for field DISABLEDACTstatic classIDB2Entry.DrollbackValueEnumeration type for field DROLLBACKstatic classIDB2Entry.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classIDB2Entry.PriorityValueEnumeration type for field PRIORITYstatic classIDB2Entry.ShareLocksValueEnumeration type for field SHARELOCKSstatic classIDB2Entry.StatusValueEnumeration type for field ENABLESTATUSstatic classIDB2Entry.ThreadWaitValueEnumeration type for field THREADWAIT
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.LonggetAborts()Getter for field ABORTSIDB2Entry.AccountrecValuegetAccountrec()Getter for field ACCOUNTRECjava.lang.LonggetActiveThreads()Getter for field THREADSjava.lang.StringgetAuthid()Getter for field AUTHIDIDB2Entry.AuthtypeValuegetAuthtype()Getter for field AUTHTYPEjava.lang.LonggetBasdefinever()Getter for field BASDEFINEVERjava.lang.LonggetCalls()Getter for field CALLSIDB2Entry.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDIDB2EntryReferencegetCICSObjectReference()java.lang.LonggetCommits()Getter for field COMMITSjava.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEIDB2Entry.DisabledactValuegetDisabledact()Getter for field DISABLEDACTIDB2Entry.DrollbackValuegetDrollback()Getter for field DROLLBACKIDB2Entry.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.LonggetMaxThreads()Getter for field THREADLIMITjava.lang.StringgetName()Getter for field NAMEICICSType<IDB2Entry>getObjectType()java.lang.StringgetPlan()Getter for field PLANjava.lang.StringgetPlanexitname()Getter for field PLANEXITNAMEIDB2Entry.PriorityValuegetPriority()Getter for field PRIORITYjava.lang.LonggetProtectnum()Getter for field PROTECTNUMjava.lang.LonggetPsignons()Getter for field PSIGNONSjava.lang.LonggetPtcurr()Getter for field PTCURRjava.lang.LonggetPthreads()Getter for field PTHREADSjava.lang.LonggetPthwm()Getter for field PTHWMjava.lang.LonggetPtlim()Getter for field PTLIMjava.lang.LonggetReuselimct()Getter for field REUSELIMCTjava.lang.LonggetRqcur()Getter for field RQCURjava.lang.LonggetRqhwm()Getter for field RQHWMIDB2Entry.ShareLocksValuegetShareLocks()Getter for field SHARELOCKSjava.lang.LonggetSignons()Getter for field SIGNONSjava.lang.LonggetSphase()Getter for field SPHASEIDB2Entry.StatusValuegetStatus()Getter for field ENABLESTATUSjava.lang.LonggetTcreate()Getter for field TCREATEjava.lang.LonggetTcurr()Getter for field TCURRIDB2Entry.ThreadWaitValuegetThreadWait()Getter for field THREADWAITjava.lang.LonggetThwm()Getter for field THWMjava.lang.LonggetTlimit()Getter for field TLIMITjava.lang.LonggetTreuse()Getter for field TREUSEjava.lang.LonggetTterm()Getter for field TTERMjava.lang.LonggetTworo()Getter for field TWOROjava.lang.LonggetXcurr()Getter for field XCURRjava.lang.LonggetXhwm()Getter for field XHWMjava.lang.LonggetXtotal()Getter for field XTOTAL-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IDB2Entry> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEDB2 entry name
This is the name of the DB2 entry which defines the resources to be used by a specific transaction or by a group of transactions when accessing DB2.
- Specified by:
getNamein interfaceICICSObject
-
getAccountrec
IDB2Entry.AccountrecValue getAccountrec()
Getter for field ACCOUNTRECAccounting record option
This defines whether the CICS DB2 attachment will produce a DB2 accounting record per unit of work (UOW), transaction, transid or not at all for transactions using this DB2 entry.
- UOW - The CICS DB2 attachment facility causes an accounting record to be produced by DB2 for each UOW, assuming that the thread is released at the end of the UOW.
- TASK - The CICS DB2 attachment facility causes a minimum of one accounting record to be produced by DB2 for each CICS task.
- TXID - The CICS DB2 attachment facility causes an accounting record to be produced by DB2 when the transid using the thread changes.
- NONE - No accounting records are required for transactions using threads from this DB2 entry.
-
getDisabledact
IDB2Entry.DisabledactValue getDisabledact()
Getter for field DISABLEDACTDisabled action
This defines what CICS is to do with new transactions accessing DB2 entry when it has been disabled or is disabling. If this is not specified and DB2 entry is disabled, new requests are routed to the pool by default.
- POOL - The CICS DB2 attachment facility routes the request to the pool. Message DFHDB2072 is sent to the transient data destination specified by MSGQUEUEn on the DB2CONN for each transaction routed to the pool.
- ABEND - The CICS DB2 attachment facility abends the transaction.The abend code is AD26.
- SQLCODE - An SQLCODE is returned to the application indicating that the DB2ENTRY is disabled.
-
getPthreads
java.lang.Long getPthreads()
Getter for field PTHREADSNumber of protected threads
This field indicates the current number of protected threads.
-
getActiveThreads
java.lang.Long getActiveThreads()
Getter for field THREADSNumber of active threads
This field indicates the current number of threads active for this DB2 entry.
-
getAuthid
java.lang.String getAuthid()
Getter for field AUTHIDThread authorization ID
This defines the user identifier to be used for security checking for threads on this DB2 entry. If Thread authorization ID is specified, then Authorization type is not applicable
-
getAuthtype
IDB2Entry.AuthtypeValue getAuthtype()
Getter for field AUTHTYPEAuthorization type
This indicates the type of user identifier to be used for security checking for threads on this DB2 entry. If Authorization type is specified then Thread authorization ID is set to blanks.
- GROUP - Eight character ID and the connected group name are used as the authorization ID
- SIGN - The SIGNID parameter of DB2 connection is used as the authorization ID
- TERM - The terminal identification is used as the authorization ID
- TX - The transaction identification is used as the authorization ID
- OPID - The user operator identification is used as the authorization ID
- USERID - The eight character user ID associated with the CICS transaction is used as the authorization ID
-
getDrollback
IDB2Entry.DrollbackValue getDrollback()
Getter for field DROLLBACKDeadlock rollback option
This field indicates whether or not the CICS DB2 attachment will initiate a syncpoint rollback in the event of transaction being selected as a victim of a deadlock resolution.
- ROLLBACK - The attachment facility will issue a syncpoint rollback before returning control to the application. An SQL code of -911 will be returned to the application indicating the current UOW has been rolled back.
- NOROLLBACK - The attachment facility will NOT initiate a rollback for a transaction. An SQL code of -913 will be returned to the application indicating an unsuccessful execution caused by deadlock or timeout.
-
getStatus
IDB2Entry.StatusValue getStatus()
Getter for field ENABLESTATUSEnabled status
This indicates whether the DB2 entry can be accessed by application programs.
- ENABLED - The DB2 entry can be accessed by applications. DB2 entry is installed in an enabled state.
- DISABLED - The DB2 entry cannot be accessed by applications.
- DISABLING - The DB2 entry is in the process of being disabled. New transactions cannot access the entry. However, existing transactions using the entry will be allowed to complete unless the DB2 entry is being disabled using the FORCE option.
-
getPlan
java.lang.String getPlan()
Getter for field PLANPlan name
This indicates the name of the plan to be used for this entry. If a plan name is specified then the Dynamic plan exit name field is set to blank.
-
getPlanexitname
java.lang.String getPlanexitname()
Getter for field PLANEXITNAMEDynamic plan exit name
This indicates the name of the dynamic plan exit used for this entry. If a Dynamic plan exit name is specified then the Plan name field is set to blank.
-
getPriority
IDB2Entry.PriorityValue getPriority()
Getter for field PRIORITYTCB priority
This field indicates the priority of the DB2 entry TCBs relative to the CICS main task.
- HIGH - The TCB will attain a higher priority than the CICS (QR TCB) task.
- EQUAL - The TCB will have an equal priority to the CICS (QR TCB) task.
- LOW - The TCB will have a lower priority to the CICS (QR TCB) task.
-
getThreadWait
IDB2Entry.ThreadWaitValue getThreadWait()
Getter for field THREADWAITThread wait option
This field indicates whether or not transactions should wait for a pool thread or be abended if the number of active pool threads reaches the threadlimit number.
- TWAIT - If all threads are busy, a transaction will wait until one becomes available.
- NOTWAIT - If all threads are busy, a transaction will be terminated with abend code AD2P.
- TPOOL - If all threads are busy a transaction will be diverted to use a pool thread. If the pool is also busy and NOTWAIT has been specified for the threadwait parameter on DB2 connection, the transaction is terminated with abend code AD3T.
-
getMaxThreads
java.lang.Long getMaxThreads()
Getter for field THREADLIMITMaximum number of active threads
This field indicates the current maximum number of pool threads the CICS DB2 attachment allows to be active before requests are made to wait, overflow to the pool, or are rejected.
-
getProtectnum
java.lang.Long getProtectnum()
Getter for field PROTECTNUMMaximum number of protected threads
This field indicates the current maximum number of protected threads allowed for this DB2 entry.
-
getCalls
java.lang.Long getCalls()
Getter for field CALLSNumber of calls
This field indicates the number of SQL calls made using this DB2 entry.
-
getSignons
java.lang.Long getSignons()
Getter for field SIGNONSNumber of signons
This field indicates the number of DB2 signons performed for this DB2 entry.
-
getCommits
java.lang.Long getCommits()
Getter for field COMMITSNumber of commits
This field indicates the number of two phase commits performed for units of work using this DB2 entry.
-
getAborts
java.lang.Long getAborts()
Getter for field ABORTSNumber of aborts
This field indicates the number of units of work using this DB2 entry that were rolled back.
-
getSphase
java.lang.Long getSphase()
Getter for field SPHASENumber of UOWs with single phase commit
This field indicates the number of units of work using the DB2 entry that used single phase commit, either because they were read-only UOWs, or because DB2 was the only recoverable resource updated in the UOW.
-
getTreuse
java.lang.Long getTreuse()
Getter for field TREUSENumber of times threads reused
This field indicates the number of times CICS transactions using the DB2 entry were able to reuse an already created DB2 thread.
-
getTterm
java.lang.Long getTterm()
Getter for field TTERMNumber of times threads terminated
This field indicates the number of terminate thread requests made to DB2 for threads of this DB2 entry.
-
getTworo
java.lang.Long getTworo()
Getter for field TWORONumber of thread waits or overflows
This field indicates the number of times all available threads in the DB2 entry were busy and a transaction had to wait for a thread to become available, or overflow to the pool and use a pool thread instead.
-
getTlimit
java.lang.Long getTlimit()
Getter for field TLIMITMaximum number of threads
This field indicates the current maximum number of threads allowed for the DB2 entry.
-
getTcurr
java.lang.Long getTcurr()
Getter for field TCURRCurrent number of threads
This field indicates the current number of active threads for this DB2 entry.
-
getThwm
java.lang.Long getThwm()
Getter for field THWMPeak number of active threads
This field indicates the peak number of active threads for this DB2 entry
-
getPtlim
java.lang.Long getPtlim()
Getter for field PTLIMMaximum number of protected threads
This field indicates the current maximum number of protected threads allowed for this DB2 entry.
-
getPtcurr
java.lang.Long getPtcurr()
Getter for field PTCURRCurrent number of protected threads
This field indicates the current number of protected threads for this DB2 entry.
-
getPthwm
java.lang.Long getPthwm()
Getter for field PTHWMPeak number of protected threads
This field indicates the peak number of protected threads for this DB2 entry.
-
getXcurr
java.lang.Long getXcurr()
Getter for field XCURRCurrent number of tasks
This field indicates the current number of CICS tasks that are using this DB2 entry.
-
getXhwm
java.lang.Long getXhwm()
Getter for field XHWMPeak number of tasks
This field indicates the peak number of CICS tasks that have used this DB2 entry.
-
getXtotal
java.lang.Long getXtotal()
Getter for field XTOTALTotal number of tasks
This field indicates the total number of completed tasks that have used this DB2 entry.
-
getRqcur
java.lang.Long getRqcur()
Getter for field RQCURCurrent number of tasks waiting for thread
This field indicates the current number of CICS tasks waiting for a thread to become available on this DB2 entry.
-
getRqhwm
java.lang.Long getRqhwm()
Getter for field RQHWMPeak number of tasks waiting for thread
This field indicates the peak number of CICS tasks that waited for a thread to become available on this DB2 entry.
-
getChangeAgent
IDB2Entry.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.
- 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.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
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.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
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
IDB2Entry.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.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getReuselimct
java.lang.Long getReuselimct()
Getter for field REUSELIMCTNumber of times a DB2ENTRY thread reached REUSELIMIT
This field indicates the number of times a DB2ENTRY thread reached reuselimit and had to be terminated.
-
getPsignons
java.lang.Long getPsignons()
Getter for field PSIGNONSNumber of partial signons
This field indicates the number of DB2 partial signons performed for this DB2 entry.
-
getTcreate
java.lang.Long getTcreate()
Getter for field TCREATENumber of times threads created
This field indicates the number of create thread requests made to DB2 for threads of this DB2 entry.
-
getShareLocks
IDB2Entry.ShareLocksValue getShareLocks()
Getter for field SHARELOCKSSharelocks option
This field indicates whether or not we have told DB2 to share locks between multiple threads in multiple regions involved in the same distributed unit of work.
- SHARED - DB2 will share locks.
- NOTSHARED - DB2 will not share locks.
-
getCICSObjectReference
IDB2EntryReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-