com.ibm.cics.model
Interface IConnection

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IConnection
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable CONNECT


Nested Class Summary
static class IConnection.AccessmethodValue
          Enumeration type for field ACCESSMETHOD
static class IConnection.AutostatusValue
          Enumeration type for field AUTOSTATUS
static class IConnection.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IConnection.ConntypeValue
          Enumeration type for field CONNTYPE
static class IConnection.ExittracingValue
          Enumeration type for field EXITTRACING
static class IConnection.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IConnection.PendingStatusValue
          Enumeration type for field PENDSTATUS
static class IConnection.ProtocolValue
          Enumeration type for field PROTOCOL
static class IConnection.RecovstatusValue
          Enumeration type for field RECOVSTATUS
static class IConnection.ServiceStatusValue
          Enumeration type for field SERVSTATUS
static class IConnection.StatusValue
          Enumeration type for field CONNSTATUS
static class IConnection.TypeValue
          Enumeration type for field TYPE
static class IConnection.XlnstatusValue
          Enumeration type for field XLNSTATUS
static class IConnection.ZcptracingValue
          Enumeration type for field ZCPTRACING
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IConnection> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 IConnection.AccessmethodValue getAccessmethod()
          Getter for field ACCESSMETHOD
 java.lang.Long getAids()
          Getter for field AIDS
 java.lang.Long getAllocates()
          Getter for field ALLOCATES
 java.lang.Long getAllocqlimit()
          Getter for field ALLOCQLIMIT
 java.lang.Long getAtisbpri()
          Getter for field ATISBPRI
 java.lang.Long getAtisbsec()
          Getter for field ATISBSEC
 IConnection.AutostatusValue getAutostatus()
          Getter for field AUTOSTATUS
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.Long getBidssent()
          Getter for field BIDSSENT
 IConnection.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
 IConnectionReference getCICSObjectReference()
           
 java.lang.Long getConcurbids()
          Getter for field CONCURBIDS
 java.lang.String getConncreatime()
          Getter for field CONNCREATIME
 java.lang.String getConndeletime()
          Getter for field CONNDELETIME
 IConnection.ConntypeValue getConntype()
          Getter for field CONNTYPE
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 java.lang.Long getDlifuncship()
          Getter for field DLIFUNCSHIP
 java.lang.Long getDplfuncship()
          Getter for field DPLFUNCSHIP
 java.lang.Long getEsticchnl()
          Getter for field ESTICCHNL
 java.lang.Long getEsticchnrcvd()
          Getter for field ESTICCHNRCVD
 java.lang.Long getEsticchnsent()
          Getter for field ESTICCHNSENT
 java.lang.Long getEstpcchnl()
          Getter for field ESTPCCHNL
 java.lang.Long getEstpcchnrcvd()
          Getter for field ESTPCCHNRCVD
 java.lang.Long getEstpcchnsent()
          Getter for field ESTPCCHNSENT
 java.lang.Long getEsttcchnl()
          Getter for field ESTTCCHNL
 java.lang.Long getEsttcchnrcvd()
          Getter for field ESTTCCHNRCVD
 java.lang.Long getEsttcchnsent()
          Getter for field ESTTCCHNSENT
 java.lang.Long getExit_rejallc()
          Getter for field EXIT_REJALLC
 IConnection.ExittracingValue getExittracing()
          Getter for field EXITTRACING
 java.lang.Long getFailedothers()
          Getter for field FAILEDOTHERS
 java.lang.Long getFailinkalloc()
          Getter for field FAILINKALLOC
 java.lang.Long getFcfuncship()
          Getter for field FCFUNCSHIP
 java.lang.String getGmtcreatime()
          Getter for field GMTCREATIME
 java.lang.String getGmtdeletime()
          Getter for field GMTDELETIME
 java.lang.String getGrname()
          Getter for field GRNAME
 java.lang.Long getIcfuncship()
          Getter for field ICFUNCSHIP
 IConnection.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 getLinksystem()
          Getter for field LINKSYSTEM
 java.lang.Long getMaxbids()
          Getter for field MAXBIDS
 java.lang.Long getMaxprimaries()
          Getter for field MAXPRIMARIES
 java.lang.Long getMaxqtallcprg()
          Getter for field MAXQTALLCPRG
 java.lang.Long getMaxqtime()
          Getter for field MAXQTIME
 java.lang.Long getMaxqtpurgcnt()
          Getter for field MAXQTPURGCNT
 java.lang.Long getMaxsecond()
          Getter for field MAXSECOND
 java.lang.String getMembername()
          Getter for field MEMBERNAME
 java.lang.String getName()
          Getter for field NAME
 java.lang.String getNetName()
          Getter for field NETNAME
 java.lang.Long getNonspecaids()
          Getter for field NONSPECAIDS
 java.lang.String getNqname()
          Getter for field NQNAME
 ICICSType<IConnection> getObjectType()
           
 java.lang.Long getOutsalloc()
          Getter for field OUTSALLOC
 IConnection.PendingStatusValue getPendingStatus()
          Getter for field PENDSTATUS
 java.lang.Long getPricurrused()
          Getter for field PRICURRUSED
 IConnection.ProtocolValue getProtocol()
          Getter for field PROTOCOL
 java.lang.Long getQuedallocate()
          Getter for field QUEDALLOCATE
 java.lang.Long getReceivecount()
          Getter for field RECEIVECOUNT
 IConnection.RecovstatusValue getRecovstatus()
          Getter for field RECOVSTATUS
 java.lang.String getRemotename()
          Getter for field REMOTENAME
 java.lang.String getRemotesysnet()
          Getter for field REMOTESYSNET
 java.lang.String getRemotesystem()
          Getter for field REMOTESYSTEM
 java.lang.Long getSeccurrused()
          Getter for field SECCURRUSED
 java.lang.Long getSendcount()
          Getter for field SENDCOUNT
 IConnection.ServiceStatusValue getServiceStatus()
          Getter for field SERVSTATUS
 IConnection.StatusValue getStatus()
          Getter for field CONNSTATUS
 java.lang.Long getTdfuncship()
          Getter for field TDFUNCSHIP
 java.lang.Long getTermsharereq()
          Getter for field TERMSHAREREQ
 java.lang.Long getTsfuncship()
          Getter for field TSFUNCSHIP
 IConnection.TypeValue getType()
          Getter for field TYPE
 IConnection.XlnstatusValue getXlnstatus()
          Getter for field XLNSTATUS
 java.lang.Long getXziqallcprg()
          Getter for field XZIQALLCPRG
 java.lang.Long getXziqprgcnt()
          Getter for field XZIQPRGCNT
 java.lang.Long getXziqrejs()
          Getter for field XZIQREJS
 IConnection.ZcptracingValue getZcptracing()
          Getter for field ZCPTRACING
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<IConnection> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getName

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

Connection ID

The name of the installed connection.

Specified by:
getName in interface ICICSObject

getProtocol

IConnection.ProtocolValue getProtocol()
Getter for field PROTOCOL

Connection protocol

For connections with an access method of VTAM, indicates which SNA protocol is in use, either LU61 or APPC. A value of EXCI means this connection uses the External CICS Interface. A value of NOTAPPLIC means this connection is not a VTAM connection.


getType

IConnection.TypeValue getType()
Getter for field TYPE

Connection type

The connection type. Values are: LU61, LU62, INDIRECT, MRO, NETBIOS, or TCPIP


getAccessmethod

IConnection.AccessmethodValue getAccessmethod()
Getter for field ACCESSMETHOD

Access method

The access method in use for this connection (VTAM, IRC, INDIRECT, XCF, XM, NETBIOS, or TCPIP).


getStatus

IConnection.StatusValue getStatus()
Getter for field CONNSTATUS

Connection status

For connections using either the APPC or MRO protocol, the status of the connection as one of the following:

Input Values: ACQUIRED, RELEASED


getAutostatus

IConnection.AutostatusValue getAutostatus()
Getter for field AUTOSTATUS

Autoconnect option

Indicates whether sessions with this connection are to be bound when CICS is initialized or whenever communication with VTAM is started:


getExittracing

IConnection.ExittracingValue getExittracing()
Getter for field EXITTRACING

Exit Tracing status

Controls the terminal exit program's tracing activity for the sessions associated with this connection. A value of NOTAPPLIC means this connection is either not an LU6.1 or APPC connection, or it is a remote connection.

Input Values: EXITTRACE, NOEXITTRACE


getNetName

java.lang.String getNetName()
Getter for field NETNAME

Net name

The name by which the remote system is known to the network.


getServiceStatus

IConnection.ServiceStatusValue getServiceStatus()
Getter for field SERVSTATUS

Service status

Indicates whether the system can receive and send data as follows:


getPendingStatus

IConnection.PendingStatusValue getPendingStatus()
Getter for field PENDSTATUS

Pending status

For connections using the APPC and MRO protocol, indicates whether there are any units of work that require resynchronization after a session failure (PENDING or NOTPENDING).


getXlnstatus

IConnection.XlnstatusValue getXlnstatus()
Getter for field XLNSTATUS

Exchange lognames (XLN) status

The status of the exchange lognames (XLN) process. A value of NOTAPPLIC means that the link is released, the link is MRO, LU6.1, or single-session APPC, or the link does not support synchronization level 2 conversations.


getZcptracing

IConnection.ZcptracingValue getZcptracing()
Getter for field ZCPTRACING

ZCP tracing

Indicates the status of the ZCP trace facility. A value of NOTAPPLIC means this connection is not LU6.1 or APPC.

Input Values: ZPTRACE, NOZPTRACE


getAids

java.lang.Long getAids()
Getter for field AIDS

Number of automatic initiator descriptors (AIDs)

The current number of automatic initiator descriptors (AIDs) in the AID chain.


getNonspecaids

java.lang.Long getNonspecaids()
Getter for field NONSPECAIDS

Number of AIDs waiting for a session

The current number of automatic initiator descriptors (AIDs) that are waiting for a session to become available.


getConcurbids

java.lang.Long getConcurbids()
Getter for field CONCURBIDS

Number of bids currently in progress

The number of bids currently in progress.


getMaxsecond

java.lang.Long getMaxsecond()
Getter for field MAXSECOND

Peak number of secondaries in use at one time

The maximum number of secondary (contention winner) sessions in use at any one time.


getMaxbids

java.lang.Long getMaxbids()
Getter for field MAXBIDS

Maximum number of concurrent bids

The maximum number of bids in progress at any one time.


getOutsalloc

java.lang.Long getOutsalloc()
Getter for field OUTSALLOC

Peak number of outstanding allocate requests

The maximum number of allocate requests that were queued for this system.


getAtisbpri

java.lang.Long getAtisbpri()
Getter for field ATISBPRI

Number of ATIs satisfied by primary sessions

The number of ATI requests satisfied by primary (contention loser) sessions.


getAtisbsec

java.lang.Long getAtisbsec()
Getter for field ATISBSEC

Number of ATIs satisfied by secondary sessions

The number of ATI requests satisfied by secondary (contention winner) sessions.


getBidssent

java.lang.Long getBidssent()
Getter for field BIDSSENT

Total number of bids sent

The total number of bids that were sent.


getAllocates

java.lang.Long getAllocates()
Getter for field ALLOCATES

Total number of allocate requests

The total number of allocate requests against this system.


getQuedallocate

java.lang.Long getQuedallocate()
Getter for field QUEDALLOCATE

Number of queued allocate requests

The current number of queued allocate requests against this system.


getFailinkalloc

java.lang.Long getFailinkalloc()
Getter for field FAILINKALLOC

Number of allocate requests with link failure

The number of allocate requests that failed due to the connection being released, out of service, or with a closed mode group.


getFailedothers

java.lang.Long getFailedothers()
Getter for field FAILEDOTHERS

Number of allocate requests with other failure

The number of allocate requests that failed due to a session not being currently available for use.


getFcfuncship

java.lang.Long getFcfuncship()
Getter for field FCFUNCSHIP

Number of File Control function ships

The number of file control requests for function shipping.


getIcfuncship

java.lang.Long getIcfuncship()
Getter for field ICFUNCSHIP

Number of Interval Control function ships

The number of interval control requests for function shipping.


getTdfuncship

java.lang.Long getTdfuncship()
Getter for field TDFUNCSHIP

Number of Transient Data function ships

The number of transient data requests for function shipping.


getTsfuncship

java.lang.Long getTsfuncship()
Getter for field TSFUNCSHIP

Number of Temporary Storage function ships

The number of temporary storage requests for function shipping.


getDlifuncship

java.lang.Long getDlifuncship()
Getter for field DLIFUNCSHIP

Number of DL/I function ships

The number of DL/I requests for function shipping.


getTermsharereq

java.lang.Long getTermsharereq()
Getter for field TERMSHAREREQ

Number of terminal sharing requests

The number of transaction routing commands.


getMaxprimaries

java.lang.Long getMaxprimaries()
Getter for field MAXPRIMARIES

Peak number of primary sessions in use

The maximum number of primary (contention loser) sessions in use at any one time.


getMaxqtpurgcnt

java.lang.Long getMaxqtpurgcnt()
Getter for field MAXQTPURGCNT

Number of allocates purged due to MAXQTIME value

The number of times an allocate queue has been purged because its processing time would have exceeded the maximum queue time value.


getExit_rejallc

java.lang.Long getExit_rejallc()
Getter for field EXIT_REJALLC

Allocates rejected because QUEUELIMIT reached

The total number of allocates rejected due to the QUEUELIMIT value being reached.


getConntype

IConnection.ConntypeValue getConntype()
Getter for field CONNTYPE

External CICS interface type

Indicates whether this connection is:


getReceivecount

java.lang.Long getReceivecount()
Getter for field RECEIVECOUNT

Number of defined receive sessions

For MRO connections, the number of receive sessions defined in the SESSIONS definition.


getSendcount

java.lang.Long getSendcount()
Getter for field SENDCOUNT

Number of defined send sessions

For MRO connections, the number of send sessions defined in the SESSIONS definition.


getMaxqtime

java.lang.Long getMaxqtime()
Getter for field MAXQTIME

Maximum queue time

The maximum amount of time, in seconds, provided to process an allocate queue once the QUEUELIMIT value for the connection has been reached. If an allocate queue would take longer than this to process, the queue is purged.


getAllocqlimit

java.lang.Long getAllocqlimit()
Getter for field ALLOCQLIMIT

Allocate queue limit (QUEUELIMIT)

The value of the QUEUELIMIT parameter as specified on the CONNECTION definition. If this value is reached, then allocate queue requests are rejected. If the CONNECTION is defined with a QUEUELIMIT of NO, N/A will be displayed.


getXziqrejs

java.lang.Long getXziqrejs()
Getter for field XZIQREJS

Number of allocates rejected by XZIQUE exit

The number of allocates rejected by the XZIQUE exit.


getXziqprgcnt

java.lang.Long getXziqprgcnt()
Getter for field XZIQPRGCNT

Number of queue purges requested by XZIQUE exit

The number of allocate queue purges requested by the XZIQUE exit.


getXziqallcprg

java.lang.Long getXziqallcprg()
Getter for field XZIQALLCPRG

Number of allocates purged by XZIQUE exit

The number of allocates purged as a result of the XZIQUE exit requesting that queues be purged.


getMaxqtallcprg

java.lang.Long getMaxqtallcprg()
Getter for field MAXQTALLCPRG

Number of allocates purged when MAXQTIME exceeded

The number of allocates purged because the queue processing time would have exceeded the maximum queue time value.


getRecovstatus

IConnection.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUS

Recovery status

Indicates whether there is recovery information outstanding for the connection:


getRemotesystem

java.lang.String getRemotesystem()
Getter for field REMOTESYSTEM

Remote connection name

The name of the remotely connected system


getRemotesysnet

java.lang.String getRemotesysnet()
Getter for field REMOTESYSNET

Net name of the owning TOR

The system ID of the owning TOR


getRemotename

java.lang.String getRemotename()
Getter for field REMOTENAME

Connection name in remote system

The name by which this connection is known in a remote system.


getLinksystem

java.lang.String getLinksystem()
Getter for field LINKSYSTEM

Name of real link towards TOR

The 4-character name of the connection that is the real link towards the TOR for a remote or indirect system entry, if it is available. It is not set if some connection definitions in the chain from the remote or indirect entry to the link system are missing.


getGmtcreatime

java.lang.String getGmtcreatime()
Getter for field GMTCREATIME

GMT connection create time

The time when the connection was created in Greenwich Mean Time (GMT) format


getConncreatime

java.lang.String getConncreatime()
Getter for field CONNCREATIME

Local connection create time

The local time when the connection was created


getGmtdeletime

java.lang.String getGmtdeletime()
Getter for field GMTDELETIME

GMT connection delete time

The time when the connection was deleted in Greenwich Mean Time (GMT) format


getConndeletime

java.lang.String getConndeletime()
Getter for field CONNDELETIME

Local connection delete time

The local time when the connection was deleted


getPricurrused

java.lang.Long getPricurrused()
Getter for field PRICURRUSED

Number of primaries currently in use

The number of primary (contention loser) sessions currently in use


getSeccurrused

java.lang.Long getSeccurrused()
Getter for field SECCURRUSED

Number of secondaries currently in use

The number of secondary (contention winner) sessions currently in use.


getGrname

java.lang.String getGrname()
Getter for field GRNAME

APPC generic resource

For an APPC connection to a generic resource when this system is also a generic resource, this field contains the 8-character generic resource name of the connected LU. Otherwise, the field is blank.


getMembername

java.lang.String getMembername()
Getter for field MEMBERNAME

Member name of connected LU

For an APPC connection to a generic resource when this system is also a generic resource, this field contains the 8-character member name (applid) of the connected LU. Otherwise, the field is blank.


getDplfuncship

java.lang.Long getDplfuncship()
Getter for field DPLFUNCSHIP

Number of Distributed Program Link function ships

The number of Distributed Program Link (DPL) requests that have been function shipped across this connection.


getNqname

java.lang.String getNqname()
Getter for field NQNAME

Network qualified name

The network qualified name if one was sent by VTAM at logon time.


getEstpcchnl

java.lang.Long getEstpcchnl()
Getter for field ESTPCCHNL

Program Control FS LINK requests with channels

Number of program control FS LINK requests with channels


getEstpcchnsent

java.lang.Long getEstpcchnsent()
Getter for field ESTPCCHNSENT

Bytes sent on LINK channel requests

Number of bytes sent on LINK channel requests


getEstpcchnrcvd

java.lang.Long getEstpcchnrcvd()
Getter for field ESTPCCHNRCVD

Bytes received on LINK channel requests

Number of bytes received on LINK channel requests


getEsticchnl

java.lang.Long getEsticchnl()
Getter for field ESTICCHNL

Interval Control FS start requests with channels

Number of Interval Control FS start requests with channels


getEsticchnsent

java.lang.Long getEsticchnsent()
Getter for field ESTICCHNSENT

Number of bytes sent on START channel requests

The number of bytes sent on START channel requests


getEsticchnrcvd

java.lang.Long getEsticchnrcvd()
Getter for field ESTICCHNRCVD

Number of bytes received on START channel requests

The number of bytes received on START channel requests


getEsttcchnl

java.lang.Long getEsttcchnl()
Getter for field ESTTCCHNL

Number of terminal sharing channel requests

The number of terminal sharing channel requests.


getEsttcchnsent

java.lang.Long getEsttcchnsent()
Getter for field ESTTCCHNSENT

Bytes sent on terminal sharing channel requests

Number of bytes sent on terminal sharing channel requests


getEsttcchnrcvd

java.lang.Long getEsttcchnrcvd()
Getter for field ESTTCCHNRCVD

Bytes received on terminal sharing channel requests

Number of bytes received on terminal sharing channel requests


getChangeAgent

IConnection.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeUserID

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

Last modification user ID

If the connection was installed using a CICSPlex SM SYSLINK definition, this is the user ID that requested the install. For connections not installed using SYSLINK this is the user ID that made the last modification to the connection definition.


getChangeAgentRelease

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

Last modification agent release

If the connection was installed using a CICSPlex SM SYSLINK definition, this is the CICS release level of the CICS system where the connection is installed. For connections not installed using SYSLINK this is the CICS release level of the agent that made the last modification to the connection definition.


getChangeTime

java.util.Date getChangeTime()
Getter for field CHANGETIME

Last modification time

If the connection was installed using a CICSPlex SM SYSLINK definition, this is the local date and time of the install. For connections not installed using SYSLINK this is the local date and time when the connection 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

If the connection was installed using a CICSPlex SM SYSLINK definition, this is the local date and time of the install. For connections not installed using SYSLINK this is the local date and time when the connection 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

IConnection.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The install agent identifier that made the installation.


getBasdefinever

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

BAS resource definition version

The BAS version number of this definition.


getCICSObjectReference

IConnectionReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IConnection> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



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