|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IIPICConnection
generated from CICS resourcetable IPCONN
Nested Class Summary | |
---|---|
static class |
IIPICConnection.AutoconnectValue
Enumeration type for field AUTOCONNECT |
static class |
IIPICConnection.ChangeAgentValue
Enumeration type for field CHANGEAGENT |
static class |
IIPICConnection.ConnectionStatusValue
Enumeration type for field CONNSTATUS |
static class |
IIPICConnection.HosttypeValue
Enumeration type for field HOSTTYPE |
static class |
IIPICConnection.IdpropValue
Enumeration type for field IDPROP |
static class |
IIPICConnection.InstallAgentValue
Enumeration type for field INSTALLAGENT |
static class |
IIPICConnection.IpfamilyValue
Enumeration type for field IPFAMILY |
static class |
IIPICConnection.LinkauthValue
Enumeration type for field LINKAUTH |
static class |
IIPICConnection.MirrorlifeValue
Enumeration type for field MIRRORLIFE |
static class |
IIPICConnection.PendstatusValue
Enumeration type for field PENDSTATUS |
static class |
IIPICConnection.PurgetypeValue
Enumeration type for field PURGETYPE |
static class |
IIPICConnection.RecovstatusValue
Enumeration type for field RECOVSTATUS |
static class |
IIPICConnection.ServiceStatusValue
Enumeration type for field SERVSTATUS |
static class |
IIPICConnection.SsltypeValue
Enumeration type for field SSLTYPE |
static class |
IIPICConnection.UowactionValue
Enumeration type for field UOWACTION |
static class |
IIPICConnection.UserauthValue
Enumeration type for field USERAUTH |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
java.lang.Long |
getAllcfaillink()
Getter for field ALLCFAILLINK |
java.lang.Long |
getAllcfailoth()
Getter for field ALLCFAILOTH |
java.lang.String |
getApplID()
Getter for field APPLID |
IIPICConnection.AutoconnectValue |
getAutoconnect()
Getter for field AUTOCONNECT |
java.lang.Long |
getBasdefinever()
Getter for field BASDEFINEVER |
java.lang.String |
getCertificate()
Getter for field CERTIFICATE |
IIPICConnection.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 |
getCiphers()
Getter for field CIPHERS |
java.lang.String |
getClientloc()
Getter for field CLIENTLOC |
IIPICConnection.ConnectionStatusValue |
getConnectionStatus()
Getter for field CONNSTATUS |
java.lang.Long |
getCrecvsess()
Getter for field CRECVSESS |
java.lang.Long |
getCsendsess()
Getter for field CSENDSESS |
java.lang.Long |
getCurrqueued()
Getter for field CURRQUEUED |
java.lang.String |
getDefineSource()
Getter for field DEFINESOURCE |
java.util.Date |
getDefineTime()
Getter for field DEFINETIME |
java.lang.Long |
getExitallcpur()
Getter for field EXITALLCPUR |
java.lang.Long |
getExitallcqpur()
Getter for field EXITALLCQPUR |
java.lang.Long |
getExitallcrej()
Getter for field EXITALLCREJ |
java.lang.Long |
getFsfcbyterecd()
Getter for field FSFCBYTERECD |
java.lang.Long |
getFsfcbytesent()
Getter for field FSFCBYTESENT |
java.lang.Long |
getFsfcreqs()
Getter for field FSFCREQS |
java.lang.Long |
getFsicbyterecd()
Getter for field FSICBYTERECD |
java.lang.Long |
getFsicbytesent()
Getter for field FSICBYTESENT |
java.lang.Long |
getFsicreqs()
Getter for field FSICREQS |
java.lang.Long |
getFspcbyterecd()
Getter for field FSPCBYTERECD |
java.lang.Long |
getFspcbytesent()
Getter for field FSPCBYTESENT |
java.lang.Long |
getFspgreqs()
Getter for field FSPGREQS |
java.lang.Long |
getFstdbyterecd()
Getter for field FSTDBYTERECD |
java.lang.Long |
getFstdbytesent()
Getter for field FSTDBYTESENT |
java.lang.Long |
getFstdreqs()
Getter for field FSTDREQS |
java.lang.Long |
getFstsbyterecd()
Getter for field FSTSBYTERECD |
java.lang.Long |
getFstsbytesent()
Getter for field FSTSBYTESENT |
java.lang.Long |
getFstsreqs()
Getter for field FSTSREQS |
java.lang.String |
getGmtctime()
Getter for field GMTCTIME |
java.lang.String |
getGmtdtime()
Getter for field GMTDTIME |
java.lang.String |
getHost()
Getter for field HOST |
IIPICConnection.HosttypeValue |
getHosttype()
Getter for field HOSTTYPE |
IIPICConnection.IdpropValue |
getIdprop()
Getter for field IDPROP |
IIPICConnection.InstallAgentValue |
getInstallAgent()
Getter for field INSTALLAGENT |
java.util.Date |
getInstallTime()
Getter for field INSTALLTIME |
java.lang.String |
getInstallUserID()
Getter for field INSTALLUSRID |
IIPICConnection.IpfamilyValue |
getIpfamily()
Getter for field IPFAMILY |
java.lang.String |
getIpresolved()
Getter for field IPRESOLVED |
IIPICConnection.LinkauthValue |
getLinkauth()
Getter for field LINKAUTH |
java.lang.String |
getLocctime()
Getter for field LOCCTIME |
java.lang.String |
getLocdtime()
Getter for field LOCDTIME |
java.lang.Long |
getMaxqtime()
Getter for field MAXQTIME |
IIPICConnection.MirrorlifeValue |
getMirrorlife()
Getter for field MIRRORLIFE |
java.lang.Long |
getMqtallpurg()
Getter for field MQTALLPURG |
java.lang.Long |
getMqtallqpurg()
Getter for field MQTALLQPURG |
java.lang.String |
getName()
Getter for field NAME |
java.lang.String |
getNetworkid()
Getter for field NETWORKID |
java.lang.Long |
getNumciphers()
Getter for field NUMCIPHERS |
java.lang.String |
getPartner()
Getter for field PARTNER |
java.lang.Long |
getPeakqueued()
Getter for field PEAKQUEUED |
IIPICConnection.PendstatusValue |
getPendstatus()
Getter for field PENDSTATUS |
java.lang.Long |
getPort()
Getter for field PORT |
java.lang.Long |
getPrecvsess()
Getter for field PRECVSESS |
java.lang.Long |
getPsendsess()
Getter for field PSENDSESS |
IIPICConnection.PurgetypeValue |
getPurgetype()
Getter for field PURGETYPE |
java.lang.Long |
getQlimallocrej()
Getter for field QLIMALLOCREJ |
java.lang.Long |
getQueuelimit()
Getter for field QUEUELIMIT |
java.lang.Long |
getReceivecount()
Getter for field RECEIVECOUNT |
IIPICConnection.RecovstatusValue |
getRecovstatus()
Getter for field RECOVSTATUS |
java.lang.Long |
getRemtrmstrt()
Getter for field REMTRMSTRT |
java.lang.String |
getSecurityname()
Getter for field SECURITYNAME |
java.lang.Long |
getSendcount()
Getter for field SENDCOUNT |
IIPICConnection.ServiceStatusValue |
getServiceStatus()
Getter for field SERVSTATUS |
IIPICConnection.SsltypeValue |
getSsltype()
Getter for field SSLTYPE |
java.lang.String |
getTcpipService()
Getter for field TCPIPSERVICE |
java.lang.Long |
getTotalloc()
Getter for field TOTALLOC |
java.lang.Long |
getTransattch()
Getter for field TRANSATTCH |
java.lang.Long |
getTrbyterecd()
Getter for field TRBYTERECD |
java.lang.Long |
getTrbytesent()
Getter for field TRBYTESENT |
java.lang.Long |
getTrreqs()
Getter for field TRREQS |
java.lang.Long |
getUnsupreqs()
Getter for field UNSUPREQS |
IIPICConnection.UowactionValue |
getUowaction()
Getter for field UOWACTION |
IIPICConnection.UserauthValue |
getUserauth()
Getter for field USERAUTH |
Methods inherited from interface com.ibm.cics.model.ICICSResource |
---|
getCICSRelease, getRegionName |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType, getObjectType |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
java.lang.String getName()
IPIC connection ID
The 8-character identifier of the remote system or region (that is, the name assigned to its IPCONN definition).
getName
in interface ICICSObject
java.lang.String getApplID()
Remote application ID
The name by which the remote system is known to the network (taken from the APPLID option of the IPCONN definition). This is the application identifier ( applid ) of the remote system, as specified on the APPLID option of its system initialization table. For XRF systems it is the generic applid.
IIPICConnection.AutoconnectValue getAutoconnect()
Autoconnect option
Identifies which AUTOCONNECT option has been specified in the IPCONN definition:
IIPICConnection.ConnectionStatusValue getConnectionStatus()
Connection status
The state of the IPIC connection between CICS and the remote system:
java.lang.String getHost()
Remote host name
The host name or IP address of the remote system. The HOSTTYPE option gives the format of this value as either a name, an IPv4 address or an IPv6 address.
java.lang.Long getMaxqtime()
Maximum queue time
The maximum time, in seconds, for which allocate requests may be queued. The value is in the range 0-9999, or will have the standard null value of -1 if MAXQTIME(NO) is specified on the IPCONN definition.
IIPICConnection.PendstatusValue getPendstatus()
Pending status
Identifies whether there are any pending units of work for this IPIC connection:
No new syncpoint work (that is, work involving sync level 2 protocols) can be transmitted across the connection until a SET IPCONN NOTPENDING command has been issued.
If you are not concerned by the loss of synchronization caused by the initial (or cold) start of the partner, you can cause the SET IPCONN NOTPENDING command to be issued automatically by specifying XLNACTION(FORCE) on the IPCONN definition.
java.lang.Long getPort()
Port number
The port number used for outbound requests on this IPIC connection; that is, the number of the port on which the remote system is listening. If the IPCONN is defined with PORT(NO), the value is -1.
java.lang.Long getQueuelimit()
Queue limit
The maximum number of allocate requests that can be queued for this IPIC connection. The value is in the range 0-9999, or will have the standard null value of -1 if QUEUELIMIT(NO) is specified on the IPCONN definition.
java.lang.Long getReceivecount()
Receive count
The number of RECEIVE sessions defined for this IPIC connection.
IIPICConnection.RecovstatusValue getRecovstatus()
Recovery status
Identifies whether there is resynchronization work outstanding for the IPIC connection. The connection may never have been connected, have been quiesced and all resynchronization work completed, or disrupted without quiescence, in which case resynchronization may be necessary.
java.lang.Long getSendcount()
Send count
The number of SEND sessions defined for this IPIC connection. If a value of 0 is shown, then this IPIC connection may only receive data.
IIPICConnection.ServiceStatusValue getServiceStatus()
Service status
Identifies whether data can be sent and received on the IPIC connection:
java.lang.String getTcpipService()
TCP/IP service
The 8-character name of a PROTOCOL(IPIC) TCPIPSERVICE definition that defines the attributes of the inbound processing for this IPCONN.
java.lang.String getNetworkid()
Remote network ID
The network ID of the remote system. This is the value of the NETWORKID option of the IPCONN definition. If NETWORKID is not specified on the IPCONN definition, the value returned is the VTAM NETID or, for VTAM=NO systems, the value of the UOWNETQL system initialization parameter, of this CICS (that is, the CICS on which the IPCONN definition is installed).
NETWORKID is used in combination with the APPLID option to ensure unique naming for connecting systems.
IIPICConnection.LinkauthValue getLinkauth()
Link security
Specifies how the user ID for link security is established in a CICS system with security initialized (SEC=YES).
IIPICConnection.PurgetypeValue getPurgetype()
Purge type
How associated transactions are purged:
In some extreme cases (for example, if an error occurs during backout processing), CICS might terminate abnormally.
For in-doubt and shunted UOWs, FORCEPURGE has no effect.
Note: To force shunted UOWs, the operator must issue SET IPCONN COMMIT, BACKOUT, or FORCE following a FORCEPURGE. This can lead to unpredictable results and should be used only in exceptional circumstances.
IIPICConnection.UowactionValue getUowaction()
UOW Action
The action taken for units of work (UOWs) that are shunted because of the failure of this IPIC connection:
java.lang.Long getFspcbytesent()
Number of PC function shipped bytes sent
The number of bytes sent on LINK requests.
java.lang.Long getFspcbyterecd()
Number of PC function shipped bytes received
The number of bytes received on LINK requests.
java.lang.String getLocctime()
Local connection create time
The local time when the connection was created.
java.lang.String getLocdtime()
Local connection delete time
The local time when the connection was deleted.
java.lang.String getGmtctime()
GMT connection create time
The time when the connection was created in Greenwich Mean Time (GMT) format.
java.lang.String getGmtdtime()
GMT connection delete time
The time when the connection was deleted in Greenwich Mean Time (GMT) format
java.lang.Long getCsendsess()
Number of send sessions in use
The number of send sessions in use on this connection.
java.lang.Long getPsendsess()
Maximum number of send sessions used
The maximum number of send sessions in use on this connection at any one time.
java.lang.Long getCrecvsess()
Number of receive sessions in use
The number of receive sessions in use on this connection.
java.lang.Long getPrecvsess()
Maximum number of receive sessions used
The maximum number of receive sessions in use on this connection at any one time.
java.lang.Long getTotalloc()
Total number of session allocations
The total number of sessions that have been used on this connection.
java.lang.Long getCurrqueued()
Current number of allocates queued
The number of session allocations currently queued on this connection.
java.lang.Long getPeakqueued()
Number of peak queued session allocations
The maximum number of session allocations queued on this connection at any one time.
java.lang.Long getAllcfaillink()
Number of allocations failed on link
The number of session allocations that have failed on the link for this connection.
java.lang.Long getAllcfailoth()
Number of allocations failed for other reasons
The number of session allocations that have failed on this connection for non-link related reasons.
java.lang.Long getQlimallocrej()
Number of queue limit allocate rejections
The number of session allocations that have failed on this connection because the queue limit value has been reached.
java.lang.Long getMqtallqpurg()
Number of queue time allocation queue purges
The number of session allocations that have failed on this connection because the queue time value has been exceeded.
java.lang.Long getMqtallpurg()
Number of queue time allocates purged
The number of session allocations that have been purged on this connection because the queue time value has been exceeded.
java.lang.Long getExitallcrej()
Number of XISQUE allocate rejections
The number of session allocations on this connection that have been rejected by the XISQUE exit module.
java.lang.Long getExitallcqpur()
Number of XISQUE allocation queue purges
The number of session allocations on this connection that have been purged by the XISQUE exit module.
java.lang.Long getExitallcpur()
Number of XISQUE allocates purged
The number of sessions on this connection that have been purged by the XISQUE exit module.
java.lang.Long getTransattch()
Number of transactions attached
The number of transactions that have been attached on this connection.
java.lang.Long getFspgreqs()
Number of PC function shipped requests
The number of program control LINK requests for function shipping on this connection.
IIPICConnection.SsltypeValue getSsltype()
Secure sockets layer (SSL) type
Whether the service uses secure sockets layer.
IIPICConnection.UserauthValue getUserauth()
Attach-time user security level
The level of attach-time user security required for the connection:
java.lang.String getCertificate()
Certificate
The name of a certificate within the key ring file that is to be used as a client certificate in the SSL handshake for outbound IPCONN connections.
java.lang.Long getNumciphers()
Number of SSL cipher suite codes
The count of cipher suite codes, which are specified as hexadecimal pairs.
java.lang.String getCiphers()
SSL cipher suite codes
A value specifying up to 28 cipher suites, in the form of hexadecimal pairs.
java.lang.String getSecurityname()
Security name of the remote system
This is the security name of the remote system and is applicable to PROTOCOL(IPIC) only. In a CICS system with security initialized (SEC=YES), the security name is used to establish the authority of the remote system. The security name must be a valid RACF user ID on your system. The default value for the security name is the default user ID.
IIPICConnection.ChangeAgentValue getChangeAgent()
Last modification agent
The change agent identifier that made the last modification.
java.lang.String getChangeUserID()
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 IPIC connection definition.
java.lang.String getChangeAgentRelease()
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 IPIC connection definition.
java.util.Date getChangeTime()
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 IPIC connection definition was last changed.
java.lang.String getDefineSource()
Source of the resource definition
The source of the definition, depending on which agent made the last change.
java.util.Date getDefineTime()
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 IPIC connection definition record was created on DFHCSD or EYUDREP.
java.lang.String getInstallUserID()
Installation user ID
The user ID that installed the resource definition.
java.util.Date getInstallTime()
Installation time
The local date and time when the definition was installed.
IIPICConnection.InstallAgentValue getInstallAgent()
Installation agent
The install agent identifier that made the installation.
java.lang.Long getBasdefinever()
BAS resource definition version
The BAS version number of this definition.
java.lang.String getClientloc()
Most diverse route to partner system
An IPCONN may use a number of sockets to provide different paths to its partner system. The SO_CLUSTERCONNTYPE options returned by z/OS Communications Server for all the sockets used by the IPCONN are evaluated, and the options representing the most diverse route are returned here.
The binary format of SO_CLUSTERCONNTYPE is converted to characters and displayed here as either zeros or ones. See the z/OS 1.9 Communications Server IP Sockets Application Programming Interface Guide in the z/OS 1.9 Information Center for a description of SO_CLUSTERCONNTYPE and an explanation of the bit settings.
java.lang.String getPartner()
Product token of partner system
The product token of the partner system, for instance IBM_CICS_Transaction_Server/4.1.0(zOS) for a CICS TS 4.1 partner. The field is blank when the connection is not acquired or if the partner system has not indicated a product type when the connection is established.
java.lang.String getIpresolved()
Remote host's IP address
The resolved IPv4 or IPv6 address of the HOST to which this IPCONN applies, or 0.0.0.0 if it is unavailable or unknown. The format of this IP address is given by the IPFAMILY option.
IIPICConnection.IpfamilyValue getIpfamily()
The format of the resolved IP address
The format of the resolved IP address, IPRESOLVED. These are the possible values:
IIPICConnection.HosttypeValue getHosttype()
Host name's address format
The format of the host's address. These are the possible values:
java.lang.Long getTrreqs()
Number of TR function shipped requests
The number of transaction routing requests over this connection.
java.lang.Long getTrbytesent()
Number of TR function shipped bytes sent
The number of bytes sent for transaction routing on this connection.
java.lang.Long getTrbyterecd()
Number of TR function shipped bytes received
The number of bytes received for transaction routing on this connection.
java.lang.Long getFsicreqs()
Number of IC function shipped requests
The number of interval control requests for function shipping on this connection.
java.lang.Long getFsicbytesent()
Number of IC function shipped bytes sent
The number of bytes sent on interval control requests.
java.lang.Long getFsicbyterecd()
Number of IC function shipped bytes received
The number of bytes received on interval control requests.
IIPICConnection.IdpropValue getIdprop()
Identity propagation
Specifies whether the Distributed ID will be transmitted to the connected system by the sender. The IDPROP attribute is meaningful only if a connection extends outside a sysplex and is used primarily to prevent distributed identities being distributed between enterprises. If the connection is between systems in the same sysplex, the connection operates as if IDPROP(OPTIONAL) is specified and ignores any other setting.
java.lang.Long getRemtrmstrt()
Remote terminal starts
The number of remote terminal starts over this connection.
IIPICConnection.MirrorlifeValue getMirrorlife()
Minimum mirror lifetime
Indicates the minimum lifetime of the mirror task for function shipped requests received by this region. This parameter only takes affect when specified on the IPCONN on the resource-owning region and is not to be honored for function shipping interval control or linkrequests.
java.lang.Long getFsfcreqs()
Number of FC function shipped requests
The number of file control requests for function shipping on this connection.
java.lang.Long getFsfcbytesent()
Number of FC function shipped bytes sent
The number of bytes sent by file control requests.
java.lang.Long getFsfcbyterecd()
Number of FC function shipped bytes received
The number of bytes received by file control requests.
java.lang.Long getFstdreqs()
Number of TD function shipped requests
The number of transient data requests for function shipping on this connection.
java.lang.Long getFstdbytesent()
Number of TD function shipped bytes sent
The number of bytes sent on transient data requests.
java.lang.Long getFstdbyterecd()
Number of TD function shipped bytes received
The number of bytes received on transient data requests.
java.lang.Long getFstsreqs()
Number of TS function shipped requests
The number of temporary storage requests for function shipping on this connection.
java.lang.Long getFstsbytesent()
Number of TS function shipped bytes sent
The number of bytes sent on temporary storage requests.
java.lang.Long getFstsbyterecd()
Number of TS function shipped bytes received
The number of bytes received on temporary storage requests.
java.lang.Long getUnsupreqs()
Number of unsupported requests
The number of attempts to function ship unsupported requests across this connection.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |