com.ibm.cics.model
Interface IDB2Connection

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource
All Known Subinterfaces:
IMutableDB2Connection

public interface IDB2Connection
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable DB2CONN


Nested Class Summary
static class IDB2Connection.AccountrecValue
          Enumeration type for field ACCOUNTREC
static class IDB2Connection.AuthtypeValue
          Enumeration type for field AUTHTYPE
static class IDB2Connection.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IDB2Connection.ComauthtypeValue
          Enumeration type for field COMAUTHTYPE
static class IDB2Connection.ConnecterrorValue
          Enumeration type for field CONNECTERROR
static class IDB2Connection.DrollbackValue
          Enumeration type for field DROLLBACK
static class IDB2Connection.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IDB2Connection.NontermrelValue
          Enumeration type for field NONTERMREL
static class IDB2Connection.PriorityValue
          Enumeration type for field PRIORITY
static class IDB2Connection.ResyncmemberValue
          Enumeration type for field RESYNCMEMBER
static class IDB2Connection.StandbymodeValue
          Enumeration type for field STANDBYMODE
static class IDB2Connection.StatusValue
          Enumeration type for field CONNECTST
static class IDB2Connection.ThreaderrorValue
          Enumeration type for field THREADERROR
static class IDB2Connection.ThreadwaitValue
          Enumeration type for field THREADWAIT
 
Method Summary
 IDB2Connection.AccountrecValue getAccountrec()
          Getter for field ACCOUNTREC
 java.lang.String getAuthid()
          Getter for field AUTHID
 IDB2Connection.AuthtypeValue getAuthtype()
          Getter for field AUTHTYPE
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.Long getCcalls()
          Getter for field CCALLS
 IDB2Connection.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 java.lang.String getComauthid()
          Getter for field COMAUTHID
 IDB2Connection.ComauthtypeValue getComauthtype()
          Getter for field COMAUTHTYPE
 java.lang.Long getComthreadlim()
          Getter for field COMTHREADLIM
 java.lang.Long getComthreads()
          Getter for field COMTHREADS
 IDB2Connection.ConnecterrorValue getConnecterror()
          Getter for field CONNECTERROR
 java.lang.Long getCsignons()
          Getter for field CSIGNONS
 java.lang.Long getCtcurr()
          Getter for field CTCURR
 java.lang.Long getCthwm()
          Getter for field CTHWM
 java.lang.String getCtimegmt()
          Getter for field CTIMEGMT
 java.lang.String getCtimeloc()
          Getter for field CTIMELOC
 java.lang.Long getCtlimit()
          Getter for field CTLIMIT
 java.lang.Long getCtoverf()
          Getter for field CTOVERF
 java.lang.Long getCtterm()
          Getter for field CTTERM
 java.lang.Long getCurrentTCBs()
          Getter for field TCBS
 java.lang.String getDataSharingGroupID()
          Getter for field DB2GROUPID
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 IDB2Connection.DrollbackValue getDrollback()
          Getter for field DROLLBACK
 java.lang.String getDtimegmt()
          Getter for field DTIMEGMT
 java.lang.String getDtimeloc()
          Getter for field DTIMELOC
 IDB2Connection.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.String getMsgqueue1()
          Getter for field MSGQUEUE1
 java.lang.String getMsgqueue2()
          Getter for field MSGQUEUE2
 java.lang.String getMsgqueue3()
          Getter for field MSGQUEUE3
 java.lang.String getName()
          Getter for field NAME
 IDB2Connection.NontermrelValue getNontermrel()
          Getter for field NONTERMREL
 java.lang.Long getPaborts()
          Getter for field PABORTS
 java.lang.Long getPcalls()
          Getter for field PCALLS
 java.lang.Long getPcommits()
          Getter for field PCOMMITS
 java.lang.String getPlan()
          Getter for field PLAN
 java.lang.String getPlanexitname()
          Getter for field PLANEXITNAME
 IDB2Connection.PriorityValue getPriority()
          Getter for field PRIORITY
 java.lang.Long getPrqcur()
          Getter for field PRQCUR
 java.lang.Long getPrqhwm()
          Getter for field PRQHWM
 java.lang.Long getPsignons()
          Getter for field PSIGNONS
 java.lang.Long getPsphase()
          Getter for field PSPHASE
 java.lang.Long getPtcurr()
          Getter for field PTCURR
 java.lang.Long getPthwm()
          Getter for field PTHWM
 java.lang.Long getPtlimit()
          Getter for field PTLIMIT
 java.lang.Long getPtreuse()
          Getter for field PTREUSE
 java.lang.Long getPtterm()
          Getter for field PTTERM
 java.lang.Long getPtwait()
          Getter for field PTWAIT
 java.lang.Long getPurgecyclem()
          Getter for field PURGECYCLEM
 java.lang.Long getPurgecycles()
          Getter for field PURGECYCLES
 java.lang.Long getPxcurr()
          Getter for field PXCURR
 java.lang.Long getPxhwm()
          Getter for field PXHWM
 java.lang.Long getPxtotal()
          Getter for field PXTOTAL
 java.lang.String getRelease()
          Getter for field DB2RELEASE
 IDB2Connection.ResyncmemberValue getResyncmember()
          Getter for field RESYNCMEMBER
 java.lang.String getSignid()
          Getter for field SIGNID
 IDB2Connection.StandbymodeValue getStandbymode()
          Getter for field STANDBYMODE
 java.lang.String getStatsqueue()
          Getter for field STATSQUEUE
 IDB2Connection.StatusValue getStatus()
          Getter for field CONNECTST
 java.lang.String getSubsystemID()
          Getter for field DB2ID
 java.lang.Long getTcbfree()
          Getter for field TCBFREE
 java.lang.Long getTCBLimit()
          Getter for field TCBLIMIT
 java.lang.Long getTcbrdyqcurr()
          Getter for field TCBRDYQCURR
 java.lang.Long getTcbrdyqhwm()
          Getter for field TCBRDYQHWM
 java.lang.Long getTcurr()
          Getter for field TCURR
 IDB2Connection.ThreaderrorValue getThreaderror()
          Getter for field THREADERROR
 java.lang.Long getThreadlimit()
          Getter for field THREADLIMIT
 java.lang.Long getThreads()
          Getter for field THREADS
 IDB2Connection.ThreadwaitValue getThreadwait()
          Getter for field THREADWAIT
 java.lang.Long getThwm()
          Getter for field THWM
 java.lang.Long getTlimit()
          Getter for field TLIMIT
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 

Method Detail

getName

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

DB2 connection name

The name of the DB2 connection definition.

Specified by:
getName in interface ICICSObject

getAccountrec

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

This defines 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

IDB2Connection.AuthtypeValue getAuthtype()
Getter for field AUTHTYPE

Pool thread authorization type

This indicates 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.


getComthreads

java.lang.Long getComthreads()
Getter for field COMTHREADS

Number of active command threads

This indicates the current number of active command threads.


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.


getComauthid

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

Command thread authorization ID

This defines 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

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


getConnecterror

IDB2Connection.ConnecterrorValue getConnecterror()
Getter for field CONNECTERROR

Connection error processing option

This 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:


getStatus

IDB2Connection.StatusValue getStatus()
Getter for field CONNECTST

Connection status

This indicates the status of the CICS DB2 connection:


getSubsystemID

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

DB2 subsystem ID

This indicates the name of the DB2 subsystem to which CICS is connected or connecting. DB2 ID can only be changed when the CICS-DB2 Attachment Facility is not active. If you are using group attach and the CICS DB2 attachment is not connected and is not in the process of connecting, this field is blank.


getRelease

java.lang.String getRelease()
Getter for field DB2RELEASE

DB2 version and release

This indicates the version and release level of the DB2 subsystem to which CICS is connected. When CICS is not connected this field is set to blanks.


getDrollback

IDB2Connection.DrollbackValue getDrollback()
Getter for field DROLLBACK

Deadlock resolution 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.


getMsgqueue1

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

Unsolicited error message TDQ name 1

This field indicates the name of the first transient data queue to which unsolicited messages from the CICS DB2 attachment facility are sent. This first transient data queue name cannot be blank.


getMsgqueue2

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

Unsolicited error message TDQ name 2

This field indicates the name of the second transient data queue 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

This field indicates the name of the third transient data queue to which unsolicited messages from the CICS DB2 attachment facility are sent.


getNontermrel

IDB2Connection.NontermrelValue getNontermrel()
Getter for field NONTERMREL

Non-terminal transaction thread-release option

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


getPlan

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

Name of plan used for pool

This indicates the name of the plan to be used for the pool. If a plan name is specified then the PLANEXITNAME field is set to blank.


getPlanexitname

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

Name of dynamic plan exit used for pool threads

This indicates the name of the dynamic plan exit used for pool threads. If a planexit name is specified then the PLAN field is set to blank.


getPriority

IDB2Connection.PriorityValue getPriority()
Getter for field PRIORITY

TCB priority

This field indicates the priority of the pool thread TCBs relative to the CICS main task.


getPurgecyclem

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

Protected thread purge cycle (minutes)

This field defines the length in minutes of the protected thread purge cycle. The range 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)

This field defines the length in seconds of the protected thread purge cycle. The range is 30 - 59. See PURGECYCLEM for more information.


getSignid

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

Authorization ID used by CICS-DB2 attach

This field defines 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 COMAUTHTYPE(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 CICS cold or initial start.


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.


getCurrentTCBs

java.lang.Long getCurrentTCBs()
Getter for field TCBS

Current number of connections with a TCB

This field indicates the current number of TCBs used by the CICS-DB2 attachment facility.


getTCBLimit

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

Maximum number of connections (TCBLIMIT)

This field indicates the maximum number of connections (identified TCBs) that can be used to process DB2 requests.


getThreaderror

IDB2Connection.ThreaderrorValue getThreaderror()
Getter for field THREADERROR

Action following thread error

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


getThreadwait

IDB2Connection.ThreadwaitValue getThreadwait()
Getter for field THREADWAIT

Thread wait option

This field 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

This field indicates 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.


getThreads

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

Number of active pool threads

This field indicates the current number of pool threads.


getStandbymode

IDB2Connection.StandbymodeValue getStandbymode()
Getter for field STANDBYMODE

Standby mode action

This field indicates action to be taken by the CICS DB2 attachment if DB2 is not active when an attempt to start a connection is made.


getCtimegmt

java.lang.String getCtimegmt()
Getter for field CTIMEGMT

GMT connect time

This indicates the last connection time - with respect to GMT - at which this connection definition was connected.


getCtimeloc

java.lang.String getCtimeloc()
Getter for field CTIMELOC

Local connect time

This indicates the last connection time - with respect to local time - at which this connection definition was connected.


getDtimegmt

java.lang.String getDtimegmt()
Getter for field DTIMEGMT

GMT disconnect time

This indicates the last disconnection time - with respect to GMT - at which this connection definition was disconnected.


getDtimeloc

java.lang.String getDtimeloc()
Getter for field DTIMELOC

Local disconnect time

This indicates the last disconnection time - with respect to local time - at which this connection definition was disconnected.


getTlimit

java.lang.Long getTlimit()
Getter for field TLIMIT

Current maximum number of connections into DB2

This field indicates the maximum number of connections (identified TCBs) that can be used to process DB2 requests.


getThwm

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

Peak number of connections with a TCB

This field indicates the peak number of connections associated with a TCB


getTcurr

java.lang.Long getTcurr()
Getter for field TCURR

Current number of connections with a TCB

This field indicates the current number connections that are associated with a TCB.


getPcalls

java.lang.Long getPcalls()
Getter for field PCALLS

Number of calls using pool threads

This field indicates the number of SQL calls made using pool threads.


getPsignons

java.lang.Long getPsignons()
Getter for field PSIGNONS

Number of pool thread signons

This field indicates the number of DB2 signons performed for pool threads.


getPcommits

java.lang.Long getPcommits()
Getter for field PCOMMITS

Number of pool thread commits

This field indicates the number of two phase commits performed for units of work using pool threads.


getPaborts

java.lang.Long getPaborts()
Getter for field PABORTS

Number of pool thread aborts

This field indicates the number of units of work using pool threads that were rolled back.


getPsphase

java.lang.Long getPsphase()
Getter for field PSPHASE

Number of units of work with single phase commit

This field indicates the number of units of work using pool threads that used single phase commit, either because they were read-only UOWs, or because DB2 was the only recoverable resource updated in the UOW.


getPtreuse

java.lang.Long getPtreuse()
Getter for field PTREUSE

Number of times transactions reused pool threads

This field indicates the number of times CICS transactions using the pool were able to reuse an already created DB2 thread.


getPtterm

java.lang.Long getPtterm()
Getter for field PTTERM

Number of times threads terminated

This field indicates the number of terminate thread requests made to DB2 for pool threads.


getPtwait

java.lang.Long getPtwait()
Getter for field PTWAIT

Number of pool thread waits

This field indicates the number of times all available threads in the pool were busy and a transaction had to wait for a thread to become available.


getPtlimit

java.lang.Long getPtlimit()
Getter for field PTLIMIT

Maximum number of pool threads

This field indicates the current maximum number of pool threads allowed.


getPtcurr

java.lang.Long getPtcurr()
Getter for field PTCURR

Current number of active pool 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 active pool threads

This field indicates the peak number of CICS tasks that have used a pool thread.


getPxcurr

java.lang.Long getPxcurr()
Getter for field PXCURR

Current number of tasks using a pool thread

This field indicates the current number of CICS tasks that are using a pool thread.


getPxhwm

java.lang.Long getPxhwm()
Getter for field PXHWM

Peak number of tasks using a pool thread

This field indicates the peak number of active pool threads.


getPxtotal

java.lang.Long getPxtotal()
Getter for field PXTOTAL

Total number of tasks that used a pool thread

This field indicates the total number of completed tasks that have used a pool thread.


getPrqcur

java.lang.Long getPrqcur()
Getter for field PRQCUR

Current number of tasks waiting for pool thread

This field indicates the current number of CICS tasks waiting for a pool thread to become available.


getPrqhwm

java.lang.Long getPrqhwm()
Getter for field PRQHWM

Peak number of tasks waiting for pool thread

This field indicates the peak number of CICS tasks that waited for a pool thread to become available.


getCcalls

java.lang.Long getCcalls()
Getter for field CCALLS

Number of calls using command threads

This field indicates the number of DB2 commands issued using the DSNC transaction.


getCsignons

java.lang.Long getCsignons()
Getter for field CSIGNONS

Number of command thread signons

This field indicates the number of DB2 signons performed for command threads.


getCtterm

java.lang.Long getCtterm()
Getter for field CTTERM

Number of command thread terminations

This field indicates the number of terminate thread requests made to DB2 for command threads.


getCtoverf

java.lang.Long getCtoverf()
Getter for field CTOVERF

Number of command thread overflows to pool

This field indicates the number of times a DSNC DB2 command resulted in a pool thread being used because the number of active command threads exceeded the command thread limit.


getCtlimit

java.lang.Long getCtlimit()
Getter for field CTLIMIT

Maximum number of command threads

This field indicates the current maximum number of command threads the CICS DB2 attachment allows to be active before requests overflow into the pool.


getCtcurr

java.lang.Long getCtcurr()
Getter for field CTCURR

Current number of command threads

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


getTcbfree

java.lang.Long getTcbfree()
Getter for field TCBFREE

Current number of connections without a TCB

This field indicates the current number of connections currently not associated with a TCB.


getCthwm

java.lang.Long getCthwm()
Getter for field CTHWM

Peak number of command threads

This field indicates the peak number of active command threads.


getTcbrdyqcurr

java.lang.Long getTcbrdyqcurr()
Getter for field TCBRDYQCURR

Current number of tasks waiting for a connection

This field indicates the current number of CICS tasks queued waiting for a DB2 connection to become available.


getTcbrdyqhwm

java.lang.Long getTcbrdyqhwm()
Getter for field TCBRDYQHWM

Peak number of tasks waiting for a connection

This field indicates the peak number of CICS tasks queued waiting for a DB2 connection to become available.


getDataSharingGroupID

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

DB2 data sharing group ID

This indicates the name of the DB2 data sharing group to which CICS is connected or connecting. This can only be changed when the CICS-DB2 Attachment Facility is not active.


getResyncmember

IDB2Connection.ResyncmemberValue 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.


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.


getChangeAgent

IDB2Connection.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


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.


getInstallAgent

IDB2Connection.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The change agent identifier that made the installation.


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.


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of this definition.



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