com.ibm.cics.model

Interface IDB2Entry

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        DB2 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:
        getName in interface ICICSObject
      • getAccountrec

        IDB2Entry.AccountrecValue getAccountrec()
        Getter for field ACCOUNTREC

        Accounting 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 DISABLEDACT

        Disabled 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 PTHREADS

        Number of protected threads

        This field indicates the current number of protected threads.

      • getActiveThreads

        java.lang.Long getActiveThreads()
        Getter for field THREADS

        Number of active threads

        This field indicates the current number of threads active for this DB2 entry.

      • getAuthid

        java.lang.String getAuthid()
        Getter for field AUTHID

        Thread 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 AUTHTYPE

        Authorization 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 DROLLBACK

        Deadlock 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 ENABLESTATUS

        Enabled 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 PLAN

        Plan 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 PLANEXITNAME

        Dynamic 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 PRIORITY

        TCB 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 THREADWAIT

        Thread 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 THREADLIMIT

        Maximum 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 PROTECTNUM

        Maximum 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 CALLS

        Number of calls

        This field indicates the number of SQL calls made using this DB2 entry.

      • getSignons

        java.lang.Long getSignons()
        Getter for field SIGNONS

        Number of signons

        This field indicates the number of DB2 signons performed for this DB2 entry.

      • getCommits

        java.lang.Long getCommits()
        Getter for field COMMITS

        Number 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 ABORTS

        Number 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 SPHASE

        Number 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 TREUSE

        Number 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 TTERM

        Number 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 TWORO

        Number 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 TLIMIT

        Maximum 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 TCURR

        Current number of threads

        This field indicates the current number of active threads for this DB2 entry.

      • getThwm

        java.lang.Long getThwm()
        Getter for field THWM

        Peak 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 PTLIM

        Maximum 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 PTCURR

        Current 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 PTHWM

        Peak 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 XCURR

        Current 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 XHWM

        Peak 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 XTOTAL

        Total 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 RQCUR

        Current 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 RQHWM

        Peak 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 CHANGEAGENT

        Last 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.
      • getChangeUserID

        java.lang.String getChangeUserID()
        Getter for field CHANGEUSRID

        Last modification user ID

        The user ID that made the last modification to the resource definition.

      • getChangeAgentRelease

        java.lang.String getChangeAgentRelease()
        Getter for field CHANGEAGREL

        Last 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 CHANGETIME

        Last modification time

        The local date and time when the definition was last changed.

      • getDefineSource

        java.lang.String getDefineSource()
        Getter for field DEFINESOURCE

        Source 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 DEFINETIME

        Creation 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 INSTALLUSRID

        Installation user ID

        The user ID that installed the resource definition.

      • getInstallTime

        java.util.Date getInstallTime()
        Getter for field INSTALLTIME

        Installation time

        The local date and time when the definition was installed.

      • getInstallAgent

        IDB2Entry.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation 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 BASDEFINEVER

        BAS resource definition version

        The BAS version number of this definition.

      • getReuselimct

        java.lang.Long getReuselimct()
        Getter for field REUSELIMCT

        Number 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 PSIGNONS

        Number 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 TCREATE

        Number of times threads created

        This field indicates the number of create thread requests made to DB2 for threads of this DB2 entry.

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.