Interface IDB2EntryDefinition

    • Method Detail

      • getChangeAgent

        IDB2EntryDefinition.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 - Resource was last changed by a CICSPlex SM API command.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getTransid

        java.lang.String getTransid()
        Getter for field TRANSID

        Transaction ID

        The transaction ID associated with the entry. Only one transaction can be specified here. However, the use of one or more wildcard characters allows a group of transactions to be represented. Additional transactions can be defined for this entry by defining a DB2 transaction that refers to this DB2 entry. This field is optional on a DB2 entry. All transactions can be associated with a DB2 entry means of DB2 transactions instead. However, if only one transaction is associated with a DB2 entry it is easier to specify it on the DB2 entry. Note: Specifying a transaction ID here causes a 'ghost' DB2 transaction object to be created when the DB2 entry definition is installed, and such DB2 transaction objects may appear on SYSRES and RDSCPROC views.

      • getAccountrec

        IDB2EntryDefinition.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), transid, transaction or not at all for transactions using pool threads.

        • NONE - No accounting records to be cut.
        • TXID - The CICS attachment facility will cut an accounting record only when the transid using the thread changes.
        • TASK - The CICS attachment facility will cut a minimum of one accounting record per task.
        • UOW - The CICS attachment facility will cut an accounting record per UOW provided the thread has been released at syncpoint.

      • getThreadlimit

        java.lang.Long getThreadlimit()
        Getter for field THREADLIMIT

        Maximum number of active threads

        The current maximum number of pool threads that the CICS DB2 attachment facility allows to be active before requests are made to wait or are rejected (subject to the THREADWAIT attribute). The default threadlimit (3) is also the minimum you can specify. The maximum value must not be greater than the value specified for TCBLIMIT.

      • getAuthid

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

        Thread authorization ID

        The user identifier to be used for security checking when using pool threads. If Thread authorization ID is specified, then Authorization type is not applicable.

      • getAuthtype

        IDB2EntryDefinition.AuthtypeValue getAuthtype()
        Getter for field AUTHTYPE

        Authorization type

        This indicates the type of user identifier to be used for security checking when using pool threads. 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 Thread authorization ID.
        • SIGN - The SIGNID parameter of DB2 connection is used as the Thread authorization ID.
        • TERM - The terminal identification is used as the Thread authorization ID.
        • TX - The transaction identification is used as the Thread authorization ID.
        • OPID - The user operator identification is used as the Thread authorization ID.
        • ID - The eight character user ID associated with the CICS transaction is used as the Thread authorization ID.
      • getDrollback

        ICICSEnums.YesNoValue getDrollback()
        Getter for field DROLLBACK

        Deadlock rollback option

        Indicates whether or not the CICS DB2 attachment will initiate a syncpoint rollback in the event of a transaction being selected as a victim of a deadlock resolution.

        • YES - 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.
        • NO - 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.

      • getPlan

        java.lang.String getPlan()
        Getter for field PLAN

        Plan name

        The name of the plan to be used for all pool threads. If a Plan name is specified, the Dynamic plan exit name field is set to blank. If neither PLAN nor PLANEXITNAME is specified, then CICS will set PLANEXITNAME to 'DSNCUEXT' at installation time.

      • getPlanexitname

        java.lang.String getPlanexitname()
        Getter for field PLANEXITNAME

        Dynamic plan exit name

        The name of the dynamic plan exit used for pool threads. If a Dynamic plan exit name is specified, the Plan name field is set to blank. If neither PLAN nor PLANEXITNAME is specified, then CICS will set PLANEXITNAME to 'DSNCUEXT' at installation time.

      • getPriority

        IDB2EntryDefinition.PriorityValue getPriority()
        Getter for field PRIORITY

        TCB priority

        The priority of the db2 entry TCBs relative to the CICS main task.

        • HIGH - The TCB will attain a higher priority then the CICS (QR TCB)
        • EQUAL - The TCB will have an equal priority to the CICS (QR TCB)
        • LOW - The TCB will have a lower priority to the CICS (QR TCB)
      • getProtectnum

        java.lang.Long getProtectnum()
        Getter for field PROTECTNUM

        Maximum number of protected threads

        The current maximum number of protected threads allowed for this DB2 entry.

      • getThreadwait

        IDB2EntryDefinition.ThreadwaitValue getThreadwait()
        Getter for field THREADWAIT

        Thread wait option

        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.

        • YES - If all threads are busy, a transaction will wait until one becomes available.
        • NO - If all threads are busy, a transaction will be terminated with abend code AD2P.
        • POOL - 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.
      • getUserdata1

        java.lang.String getUserdata1()
        Getter for field USERDATA1

        User data area 1

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getUserdata2

        java.lang.String getUserdata2()
        Getter for field USERDATA2

        User data area 2

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getUserdata3

        java.lang.String getUserdata3()
        Getter for field USERDATA3

        User data area 3

        Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.

      • getShareLocks

        IDB2EntryDefinition.ShareLocksValue getShareLocks()
        Getter for field SHARELOCKS

        Sharelocks option

        Indicates whether or not the DB2 should share locks between multiple threads in multiple regions involved in the same distributed unit of work.

        • YES - DB2 should share locks.
        • NO - DB2 should not share locks.