com.ibm.cics.model
Interface IDB2ConnectionDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface IDB2ConnectionDefinition
extends ICICSDefinition

generated from CICS resourcetable DB2CDEF


Nested Class Summary
static class IDB2ConnectionDefinition.AccountrecValue
          Enumeration type for field ACCOUNTREC
static class IDB2ConnectionDefinition.AuthtypeValue
          Enumeration type for field AUTHTYPE
static class IDB2ConnectionDefinition.ComauthtypeValue
          Enumeration type for field COMAUTHTYPE
static class IDB2ConnectionDefinition.ConnecterrorValue
          Enumeration type for field CONNECTERROR
static class IDB2ConnectionDefinition.PriorityValue
          Enumeration type for field PRIORITY
static class IDB2ConnectionDefinition.StandbymodeValue
          Enumeration type for field STANDBYMODE
static class IDB2ConnectionDefinition.ThreaderrorValue
          Enumeration type for field THREADERROR
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 IDB2ConnectionDefinition.AccountrecValue getAccountrec()
          Getter for field ACCOUNTREC
 java.lang.String getAuthid()
          Getter for field AUTHID
 IDB2ConnectionDefinition.AuthtypeValue getAuthtype()
          Getter for field AUTHTYPE
 java.lang.String getComauthid()
          Getter for field COMAUTHID
 IDB2ConnectionDefinition.ComauthtypeValue getComauthtype()
          Getter for field COMAUTHTYPE
 java.lang.Long getComthreadlim()
          Getter for field COMTHREADLIM
 IDB2ConnectionDefinition.ConnecterrorValue getConnecterror()
          Getter for field CONNECTERROR
 java.lang.String getDb2groupid()
          Getter for field DB2GROUPID
 java.lang.String getDb2id()
          Getter for field DB2ID
 ICICSEnums.YesNoValue getDrollback()
          Getter for field DROLLBACK
 java.lang.String getMsgqueue1()
          Getter for field MSGQUEUE1
 java.lang.String getMsgqueue2()
          Getter for field MSGQUEUE2
 java.lang.String getMsgqueue3()
          Getter for field MSGQUEUE3
 ICICSEnums.YesNoValue getNontermrel()
          Getter for field NONTERMREL
 java.lang.String getPlan()
          Getter for field PLAN
 java.lang.String getPlanexitname()
          Getter for field PLANEXITNAME
 IDB2ConnectionDefinition.PriorityValue getPriority()
          Getter for field PRIORITY
 java.lang.Long getPurgecyclem()
          Getter for field PURGECYCLEM
 java.lang.Long getPurgecycles()
          Getter for field PURGECYCLES
 ICICSEnums.YesNoValue getResyncmember()
          Getter for field RESYNCMEMBER
 java.lang.Long getReuselimit()
          Getter for field REUSELIMIT
 java.lang.String getSignid()
          Getter for field SIGNID
 IDB2ConnectionDefinition.StandbymodeValue getStandbymode()
          Getter for field STANDBYMODE
 java.lang.String getStatsqueue()
          Getter for field STATSQUEUE
 java.lang.Long getTcblimit()
          Getter for field TCBLIMIT
 IDB2ConnectionDefinition.ThreaderrorValue getThreaderror()
          Getter for field THREADERROR
 java.lang.Long getThreadlimit()
          Getter for field THREADLIMIT
 ICICSEnums.YesNoValue getThreadwait()
          Getter for field THREADWAIT
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getConnecterror

IDB2ConnectionDefinition.ConnecterrorValue getConnecterror()
Getter for field CONNECTERROR

Connection error processing option

Specifies the way that the information, that CICS is not connected to DB2 because the attachment facility is in 'standby mode', is reported back to an application that has issued an SQL request:


getDb2id

java.lang.String getDb2id()
Getter for field DB2ID

DB2 subsystem ID

Specifies the name of the DB2 subsystem to which the CICS DB2 attachment facility is to connect. By default this field is blank. If you want to use group attach, specify a DB2GROUPID in the DB2CONN definition, instead of a DB2ID. The DB2ID set in the installed DB2CONN definition can be overridden by a DB2 subsystem ID specified on a DSNC STRT command, or by a DB2ID specified in a SET DB2CONN command. If the DB2ID in the installed DB2CONN definition is left blank, and the DB2GROUPID is also left blank,you can specify a DB2 subsystem ID on the INITPARM system initialization parameter. If no DB2 subsystem ID is specified by any of these means, and no DB2GROUPID is specified, the default DB2ID of blanks is replaced by DSN when the connection is attempted.


getMsgqueue1

java.lang.String getMsgqueue1()
Getter for field MSGQUEUE1

Unsolicited error message TDQ name 1

The first transient data destination to which unsolicited messages from the CICS DB2 attachment facility are sent. This first destination cannot be blank.


getMsgqueue2

java.lang.String getMsgqueue2()
Getter for field MSGQUEUE2

Unsolicited error message TDQ name 2

A second transient data destination to which unsolicited messages from the CICS DB2 attachment facility are sent.


getMsgqueue3

java.lang.String getMsgqueue3()
Getter for field MSGQUEUE3

Unsolicited error message TDQ name 3

A third transient data destination to which unsolicited messages from the CICS DB2 attachment facility are sent.


getNontermrel

ICICSEnums.YesNoValue getNontermrel()
Getter for field NONTERMREL

Non-terminal transaction thread-release option

Specifies whether or not a non-terminal transaction releases threads for reuse at intermediate syncpoints:


getPurgecyclem

java.lang.Long getPurgecyclem()
Getter for field PURGECYCLEM

Protected thread purge cycle (minutes)

The length in minutes of the protected thread purge cycle. The range for PURGECYCLEM is 0-59.

A protected thread is not terminated immediately when it is released. It is terminated only after two completed purge cycles, if it has not been reused in the meantime. Hence if the purge cycle is set to 30 seconds after it is released, a protected thread is purged 30 - 60 seconds after it is released. An unprotected thread is terminated when it is released (at syncpoint or end of task) if there are no other transactions waiting for a thread on that DB2ENTRY.


getPurgecycles

java.lang.Long getPurgecycles()
Getter for field PURGECYCLES

Protected thread purge cycle (seconds)

The length in seconds of the protected thread purge cycle. The range is 0-59. If PURGECYCLEM is zero then the minimum value for PURGECYCLES is 5 seconds.

A protected thread is not terminated immediately when it is released. It is terminated only after two completed purge cycles, if it has not been reused in the meantime. Hence if the purge cycle is set to 30 seconds after it is released, a protected thread is purged 30 - 60 seconds after it is released. An unprotected thread is terminated when it is released (at syncpoint or end of task) if there are no other transactions waiting for a thread on that DB2ENTRY.


getSignid

java.lang.String getSignid()
Getter for field SIGNID

Authorization ID used by CICS-DB2 attach

The authorization ID to be used by the CICS DB2 attachment facility when signing on to DB2 for pool and DB2ENTRY threads that specify AUTHTYPE(SIGN) and command threads specifying COMAUTHTPYE(CSIGN). The default is blanks which are replaced by the applid of the CICS system when the DB2CONN is installed. Note: If you specify a user ID on the SIGNID attribute, CICS performs a surrogate user check against the user ID performing the installation. Similarly, the CICS region user ID is subject to a surrogate user check during group list installation on a CICS cold or initial start.


getStandbymode

IDB2ConnectionDefinition.StandbymodeValue getStandbymode()
Getter for field STANDBYMODE

Standby mode

The action to be taken by the CICS DB2 attachment if DB2 is not active when an attempt is made to start the connection from CICS to DB2. CVDA values are:


getStatsqueue

java.lang.String getStatsqueue()
Getter for field STATSQUEUE

Attachment statistics TDQ name

This indicates the name of the transient data queue to which statistics will be sent when the CICS DB2 attachment is shut down.


getTcblimit

java.lang.Long getTcblimit()
Getter for field TCBLIMIT

Maximum number of connections into DB2

The maximum number of TCBs that can be used to process DB2 requests. The default is 12. The minimum number is 4 and the maximum is 2000. When connected to DB2 Version 5 or earlier, the CICS DB2 attachment facility creates the TCBs in the form of subtasks up to the limit specified by TCBLIMIT. Each of these subtasks identifies to DB2 and creates a connection into DB2. When connected to DB2 Version 6 or later, CICS creates open TCBs (up to the limit specified by the system initialization parameter MAXOPENTCBS). The TCBLIMIT attribute of the DB2CONN definition governs how many of the open TCBs can be used to access DB2 - that is, how many of them can identify to DB2 and create a connection into DB2.


getThreaderror

IDB2ConnectionDefinition.ThreaderrorValue getThreaderror()
Getter for field THREADERROR

Action following thread error

Specifies the processing that is to occur following a create thread error:


getAccountrec

IDB2ConnectionDefinition.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.


getAuthid

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

Pool thread authorization ID

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


getAuthtype

IDB2ConnectionDefinition.AuthtypeValue getAuthtype()
Getter for field AUTHTYPE

Pool thread authorization type

The type of user identifier to be used for security checking when using pool threads. If Pool thread authorization type is specified, authorization ID is set to blanks.


getDrollback

ICICSEnums.YesNoValue getDrollback()
Getter for field DROLLBACK

Deadlock resoultion rollback option

Specifies whether or not the CICS DB2 attachment facility should initiate a SYNCPOINT ROLLBACK if a transaction is selected as the victim of a deadlock resolution:


getPlan

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

Name of plan used for pool

The name of the plan to be used for all pool threads. If PLAN is specified, PLANEXITNAME must not be specified. 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

Name of dynamic plan exit used for pool threads

The name of the dynamic plan exit to be used for pool threads. If you change the PLAN and PLANEXITNAME while there are active transactions for the pool, the next time the transaction releases the thread the plan/exit is determined using the new rules. If PLANEXITNAME is specified, PLAN must not be specified. If neither PLAN nor PLANEXITNAME is specified, then CICS will set PLANEXITNAME to 'DSNCUEXT' at installation time.


getPriority

IDB2ConnectionDefinition.PriorityValue getPriority()
Getter for field PRIORITY

TCB priority

The priority of the pool thread subtasks relative to the CICS main task.


getThreadwait

ICICSEnums.YesNoValue getThreadwait()
Getter for field THREADWAIT

Thread wait option

Specifies whether or not transactions should wait for a pool thread, or be abended if the number of active pool threads reaches the thread limit. The CICS DB2 attachment issues a unique abend code AD3T, message DFHDB2011, when THREADWAIT=NO is coded and the number of pool threads is exceeded:


getThreadlimit

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

Maximum number of pool 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.


getComthreadlim

java.lang.Long getComthreadlim()
Getter for field COMTHREADLIM

Maximum number of command threads

The current maximum number of command threads the CICS DB2 attachment facility allows active before requests overflow to the pool. The valid range is 0-2000.


getComauthid

java.lang.String getComauthid()
Getter for field COMAUTHID

Command thread authorization ID

The user identifier to be used for security checking when using command threads. If COMAUTHID is specified then COMAUTHTYPE is set to not applicable.


getComauthtype

IDB2ConnectionDefinition.ComauthtypeValue getComauthtype()
Getter for field COMAUTHTYPE

Command thread authorization type

This indicates the type of user identifier to be used for security checking when using command threads. If COMAUTHTYPE is specified then COMAUTHID is set to blanks.


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.


getDb2groupid

java.lang.String getDb2groupid()
Getter for field DB2GROUPID

DB2 data sharing group ID

Specifies the group ID (up to four characters) of a data sharing group of DB2 subsystems. The group attach facility connects CICS to any active member of this data sharing group. The group ID should match the group attachment name defined in DB2. With DB2 V10 the group ID can match a subgroup attachment name identifying a subset of the data sharing group. If the DB2GROUPID attribute is left blank, group attach is not used. You cannot specify both DB2GROUP ID and DB2ID.


getResyncmember

ICICSEnums.YesNoValue getResyncmember()
Getter for field RESYNCMEMBER

Resynchronization member

This applies only if you are using group attach, and specifies the strategy that CICS adopts if outstanding units of work are being held for the last DB2 data sharing group member to which CICS was connected. (Units of work which are shunted indoubt are not included in this process, because CICS itself is unable to resolve those units of work at this time. Resynchronization for those UOWs will occur when CICS has resynchronized with its remote coordinator.)


getReuselimit

java.lang.Long getReuselimit()
Getter for field REUSELIMIT

Thread reuse limit

This applies to pool threads and DB2ENTRY threads (both protected and unprotected). It specifies the maximum number of times a thread can be reused before it is terminated, even if work is waiting. It can specify a value in the range 0-10,000 inclusive, the default is 1000. A value of 0 specifies there is no limit to the number of times a thread can be reused.



Copyright © 2008-2012 IBM Corp. All Rights Reserved.