Interface IIPICConnection
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,IInstalledCICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IIPICConnection extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IIPICConnection.AutoconnectValue
Enumeration type for field AUTOCONNECTstatic class
IIPICConnection.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IIPICConnection.ConnectionStatusValue
Enumeration type for field CONNSTATUSstatic class
IIPICConnection.HighAvailabilityStatusValue
Enumeration type for field HAstatic class
IIPICConnection.HosttypeValue
Enumeration type for field HOSTTYPEstatic class
IIPICConnection.IdpropValue
Enumeration type for field IDPROPstatic class
IIPICConnection.InstallAgentValue
Enumeration type for field INSTALLAGENTstatic class
IIPICConnection.IpfamilyValue
Enumeration type for field IPFAMILYstatic class
IIPICConnection.LinkauthValue
Enumeration type for field LINKAUTHstatic class
IIPICConnection.MirrorlifeValue
Enumeration type for field MIRRORLIFEstatic class
IIPICConnection.PendstatusValue
Enumeration type for field PENDSTATUSstatic class
IIPICConnection.PurgetypeValue
Enumeration type for field PURGETYPEstatic class
IIPICConnection.RecovstatusValue
Enumeration type for field RECOVSTATUSstatic class
IIPICConnection.ServiceStatusValue
Enumeration type for field SERVSTATUSstatic class
IIPICConnection.SsltypeValue
Enumeration type for field SSLTYPEstatic class
IIPICConnection.UowactionValue
Enumeration type for field UOWACTIONstatic class
IIPICConnection.UserauthValue
Enumeration type for field USERAUTH
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Long
getAllcfaillink()
Getter for field ALLCFAILLINKjava.lang.Long
getAllcfailoth()
Getter for field ALLCFAILOTHjava.lang.String
getApplID()
Getter for field APPLIDIIPICConnection.AutoconnectValue
getAutoconnect()
Getter for field AUTOCONNECTjava.lang.Long
getBasdefinever()
Getter for field BASDEFINEVERjava.lang.String
getCertificate()
Getter for field CERTIFICATEIIPICConnection.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTjava.lang.String
getChangeAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getChangeTime()
Getter for field CHANGETIMEjava.lang.String
getChangeUserID()
Getter for field CHANGEUSRIDIIPICConnectionReference
getCICSObjectReference()
java.lang.String
getCiphers()
Getter for field CIPHERSjava.lang.String
getClientloc()
Getter for field CLIENTLOCIIPICConnection.ConnectionStatusValue
getConnectionStatus()
Getter for field CONNSTATUSjava.lang.Long
getCrecvsess()
Getter for field CRECVSESSjava.lang.Long
getCsendsess()
Getter for field CSENDSESSjava.lang.Long
getCurrqueued()
Getter for field CURRQUEUEDjava.lang.String
getDefineSource()
Getter for field DEFINESOURCEjava.util.Date
getDefineTime()
Getter for field DEFINETIMEjava.lang.Long
getExitallcpur()
Getter for field EXITALLCPURjava.lang.Long
getExitallcqpur()
Getter for field EXITALLCQPURjava.lang.Long
getExitallcrej()
Getter for field EXITALLCREJjava.lang.Long
getFsfcbyterecd()
Getter for field FSFCBYTERECDjava.lang.Long
getFsfcbytesent()
Getter for field FSFCBYTESENTjava.lang.Long
getFsfcreqs()
Getter for field FSFCREQSjava.lang.Long
getFsicbyterecd()
Getter for field FSICBYTERECDjava.lang.Long
getFsicbytesent()
Getter for field FSICBYTESENTjava.lang.Long
getFsicreqs()
Getter for field FSICREQSjava.lang.Long
getFspcbyterecd()
Getter for field FSPCBYTERECDjava.lang.Long
getFspcbytesent()
Getter for field FSPCBYTESENTjava.lang.Long
getFspgreqs()
Getter for field FSPGREQSjava.lang.Long
getFstdbyterecd()
Getter for field FSTDBYTERECDjava.lang.Long
getFstdbytesent()
Getter for field FSTDBYTESENTjava.lang.Long
getFstdreqs()
Getter for field FSTDREQSjava.lang.Long
getFstsbyterecd()
Getter for field FSTSBYTERECDjava.lang.Long
getFstsbytesent()
Getter for field FSTSBYTESENTjava.lang.Long
getFstsreqs()
Getter for field FSTSREQSjava.util.Date
getGmtctime()
Getter for field GMTCTIMEjava.util.Date
getGmtdtime()
Getter for field GMTDTIMEIIPICConnection.HighAvailabilityStatusValue
getHighAvailabilityStatus()
Getter for field HAjava.lang.String
getHost()
Getter for field HOSTIIPICConnection.HosttypeValue
getHosttype()
Getter for field HOSTTYPEIIPICConnection.IdpropValue
getIdprop()
Getter for field IDPROPIIPICConnection.InstallAgentValue
getInstallAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallUserID()
Getter for field INSTALLUSRIDIIPICConnection.IpfamilyValue
getIpfamily()
Getter for field IPFAMILYjava.lang.String
getIpresolved()
Getter for field IPRESOLVEDIIPICConnection.LinkauthValue
getLinkauth()
Getter for field LINKAUTHjava.util.Date
getLocctime()
Getter for field LOCCTIMEjava.util.Date
getLocdtime()
Getter for field LOCDTIMEjava.lang.Long
getMaxqtime()
Getter for field MAXQTIMEIIPICConnection.MirrorlifeValue
getMirrorlife()
Getter for field MIRRORLIFEjava.lang.Long
getMqtallpurg()
Getter for field MQTALLPURGjava.lang.Long
getMqtallqpurg()
Getter for field MQTALLQPURGjava.lang.String
getName()
Getter for field NAMEjava.lang.String
getNetworkid()
Getter for field NETWORKIDjava.lang.Long
getNumciphers()
Getter for field NUMCIPHERSICICSType<IIPICConnection>
getObjectType()
java.lang.String
getPartner()
Getter for field PARTNERjava.lang.Long
getPeakqueued()
Getter for field PEAKQUEUEDIIPICConnection.PendstatusValue
getPendstatus()
Getter for field PENDSTATUSjava.lang.Long
getPort()
Getter for field PORTjava.lang.Long
getPrecvsess()
Getter for field PRECVSESSjava.lang.Long
getPsendsess()
Getter for field PSENDSESSIIPICConnection.PurgetypeValue
getPurgetype()
Getter for field PURGETYPEjava.lang.Long
getQlimallocrej()
Getter for field QLIMALLOCREJjava.lang.Long
getQueuelimit()
Getter for field QUEUELIMITjava.lang.Long
getReceivecount()
Getter for field RECEIVECOUNTIIPICConnection.RecovstatusValue
getRecovstatus()
Getter for field RECOVSTATUSjava.lang.Long
getRemtrmstrt()
Getter for field REMTRMSTRTjava.lang.String
getSecurityname()
Getter for field SECURITYNAMEjava.lang.Long
getSendcount()
Getter for field SENDCOUNTIIPICConnection.ServiceStatusValue
getServiceStatus()
Getter for field SERVSTATUSIIPICConnection.SsltypeValue
getSsltype()
Getter for field SSLTYPEjava.lang.String
getTcpipService()
Getter for field TCPIPSERVICEjava.lang.Long
getTotalloc()
Getter for field TOTALLOCjava.lang.Long
getTransattch()
Getter for field TRANSATTCHjava.lang.Long
getTrbyterecd()
Getter for field TRBYTERECDjava.lang.Long
getTrbytesent()
Getter for field TRBYTESENTjava.lang.Long
getTrreqs()
Getter for field TRREQSjava.lang.Long
getUnsupreqs()
Getter for field UNSUPREQSIIPICConnection.UowactionValue
getUowaction()
Getter for field UOWACTIONIIPICConnection.UserauthValue
getUserauth()
Getter for field USERAUTH-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IIPICConnection> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEIPIC connection ID
The 8-character identifier of the remote system or region (that is, the name assigned to its IPCONN definition).
- Specified by:
getName
in interfaceICICSObject
-
getApplID
java.lang.String getApplID()
Getter for field APPLIDRemote 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.
-
getAutoconnect
IIPICConnection.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECTAutoconnect option
Identifies which AUTOCONNECT option has been specified in the IPCONN definition:
- NOAUTOCONN
- CICS does not try to establish sessions when the IPIC connection is installed.
- AUTOCONN
- CICS tries to establish sessions when the IPIC connection is installed.
-
getConnectionStatus
IIPICConnection.ConnectionStatusValue getConnectionStatus()
Getter for field CONNSTATUSConnection status
The state of the IPIC connection between CICS and the remote system:
- ACQUIRED
- The IPIC connection is acquired. The criterion for ACQUIRED is that the capabilities exchange is complete. (The capabilities exchange is how two connected CICS regions discover the levels of service that they can collectively support; for example, the syncpoint level, and security protocols such as SSL.)
- FREEING
- The IPIC connection is being released.
- OBTAINING
- The IPIC connection is being acquired. The connection remains in the OBTAINING state until all the criteria for ACQUIRED have been met.
- RELEASED
- The IPIC connection is RELEASED. Although it may also be in INSERVICE status, it is not usable.
-
getHost
java.lang.String getHost()
Getter for field HOSTRemote 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.
-
getMaxqtime
java.lang.Long getMaxqtime()
Getter for field MAXQTIMEMaximum 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.
-
getPendstatus
IIPICConnection.PendstatusValue getPendstatus()
Getter for field PENDSTATUSPending status
Identifies whether there are any pending units of work for this IPIC connection:
- NOTPENDING
- There has been no mismatch of lognames with the partner.
- PENDING
- There is resynchronization work outstanding for the IPIC connection but the partner
system has performed an initial start, preventing completion of the resynchronization
process. You can use the SET IPCONN NOTPENDING command to unilaterally commit or back out the
units of work associated with the connection, according to their associated transaction
definitions. You can also investigate the units of work individually and force them to commit
or back out, in which case you must also complete the recovery activity by using a SET IPCONN
NOTPENDING command to clear the PENDING condition.
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.
-
getPort
java.lang.Long getPort()
Getter for field PORTPort 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.
-
getQueuelimit
java.lang.Long getQueuelimit()
Getter for field QUEUELIMITQueue 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.
-
getReceivecount
java.lang.Long getReceivecount()
Getter for field RECEIVECOUNTReceive count
The number of RECEIVE sessions defined for this IPIC connection.
-
getRecovstatus
IIPICConnection.RecovstatusValue getRecovstatus()
Getter for field RECOVSTATUSRecovery 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.
- NORECOVDATA
- Neither side has recovery information outstanding.
- NRS
- CICS does not have recovery outstanding for the connection, but the partner may have.
- RECOVDATA
- There are in-doubt units of work associated with the IPIC connection, or there are outstanding resynchronization tasks awaiting FORGET on the connection. Resynchronization takes place when the connection next becomes active, or when the UOW is unshunted.
-
getSendcount
java.lang.Long getSendcount()
Getter for field SENDCOUNTSend 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.
-
getServiceStatus
IIPICConnection.ServiceStatusValue getServiceStatus()
Getter for field SERVSTATUSService status
Identifies whether data can be sent and received on the IPIC connection:
- INSERVICE
- Data can be sent and received.
- OUTSERVICE
- Data cannot be sent or received.
-
getTcpipService
java.lang.String getTcpipService()
Getter for field TCPIPSERVICETCP/IP service
The 8-character name of a PROTOCOL(IPIC) TCPIPSERVICE definition that defines the attributes of the inbound processing for this IPCONN.
-
getNetworkid
java.lang.String getNetworkid()
Getter for field NETWORKIDRemote 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.
-
getLinkauth
IIPICConnection.LinkauthValue getLinkauth()
Getter for field LINKAUTHLink security
Specifies how the user ID for link security is established in a CICS system with security initialized (SEC=YES).
- CERTUSER - TCP/IP communication with the partner system must be configured for SSL and a certificate must be received from the partner system during SSL handshake. For example, the TCPIPSERVICE in the partner CICS system should be defined with SSL(YES) or SSL(CLIENTAUTH) In addition, this received certificate must be defined to the external security manager so that it is associated with a user ID. This user ID is used to establish link security.
- SECUSER - The user ID specified in SECURITYNAME is used to establish link security. This is the default value.
-
getPurgetype
IIPICConnection.PurgetypeValue getPurgetype()
Getter for field PURGETYPEPurge type
How associated transactions are purged:
- CANCEL
- AIDs queuing for the specified IPCONN are canceled.
- FORCECANCEL
- All AIDs, including system AIDs, queuing for the IPCONN are canceled. Note: FORCECANCEL does not remove transient data AIDs with an associated triggered task. You can remove these AIDs by purging the associated task.
- FORCEPURGE
- All transactions running on sessions on the connected system are immediately terminated
abnormally. This can lead to unpredictable results and should be used only in exceptional
circumstances.
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. - KILL
- The task allocated to the IPCONN session is terminated. System and data integrity is not guaranteed. The KILL option extends the PURGE and FORCEPURGE options. It should be used only after an attempt has been made to PURGE or FORCEPURGE a task. The KILL option does not guarantee integrity of any kind but in some situations it allows you to free up a stalled region, enabling the region to continue processing. In some cases, for example, if a task is killed during backout processing, CICS terminates abnormally.
- PURGE
- Transactions running on the connected system are abnormally terminated. Transactions are terminated only if system and data integrity can be maintained. A transaction is not purged if its definition specifies SPURGE=NO, or if the UOW is shunted.
-
getUowaction
IIPICConnection.UowactionValue getUowaction()
Getter for field UOWACTIONUOW Action
The action taken for units of work (UOWs) that are shunted because of the failure of this IPIC connection:
- BACKOUT
- All UOWs shunted because of the failure of this IPIC connection are backed out.
- COMMIT
- All UOWs shunted because of the failure of this IPIC connection are committed.
- FORCEUOW
- All UOWs shunted because of the failure of this IPIC connection are forced to BACKOUT or COMMIT, as specified on the ACTION option of the TRANSACTION definition.
- RESYNC
- Any UOWs shunted because of the failure of this IPIC connection are retried (that is, exchange lognames resynchronization for this connection is attempted). This process should normally be started automatically when a connection is acquired or when a UOW is unshunted.
-
getFspcbytesent
java.lang.Long getFspcbytesent()
Getter for field FSPCBYTESENTNumber of PC function shipped bytes sent
The number of bytes sent on LINK requests.
-
getFspcbyterecd
java.lang.Long getFspcbyterecd()
Getter for field FSPCBYTERECDNumber of PC function shipped bytes received
The number of bytes received on LINK requests.
-
getLocctime
java.util.Date getLocctime()
Getter for field LOCCTIMELocal connection create time
The local time when the connection was created.
-
getLocdtime
java.util.Date getLocdtime()
Getter for field LOCDTIMELocal connection delete time
The local time when the connection was deleted.
-
getGmtctime
java.util.Date getGmtctime()
Getter for field GMTCTIMEGMT connection create time
The time when the connection was created in Greenwich Mean Time (GMT) format.
-
getGmtdtime
java.util.Date getGmtdtime()
Getter for field GMTDTIMEGMT connection delete time
The time when the connection was deleted in Greenwich Mean Time (GMT) format
-
getCsendsess
java.lang.Long getCsendsess()
Getter for field CSENDSESSNumber of send sessions in use
The number of send sessions in use on this connection.
-
getPsendsess
java.lang.Long getPsendsess()
Getter for field PSENDSESSMaximum number of send sessions used
The maximum number of send sessions in use on this connection at any one time.
-
getCrecvsess
java.lang.Long getCrecvsess()
Getter for field CRECVSESSNumber of receive sessions in use
The number of receive sessions in use on this connection.
-
getPrecvsess
java.lang.Long getPrecvsess()
Getter for field PRECVSESSMaximum number of receive sessions used
The maximum number of receive sessions in use on this connection at any one time.
-
getTotalloc
java.lang.Long getTotalloc()
Getter for field TOTALLOCTotal number of session allocations
The total number of sessions that have been used on this connection.
-
getCurrqueued
java.lang.Long getCurrqueued()
Getter for field CURRQUEUEDCurrent number of allocates queued
The number of session allocations currently queued on this connection.
-
getPeakqueued
java.lang.Long getPeakqueued()
Getter for field PEAKQUEUEDNumber of peak queued session allocations
The maximum number of session allocations queued on this connection at any one time.
-
getAllcfaillink
java.lang.Long getAllcfaillink()
Getter for field ALLCFAILLINKNumber of allocations failed on link
The number of session allocations that have failed on the link for this connection.
-
getAllcfailoth
java.lang.Long getAllcfailoth()
Getter for field ALLCFAILOTHNumber of allocations failed for other reasons
The number of session allocations that have failed on this connection for non-link related reasons.
-
getQlimallocrej
java.lang.Long getQlimallocrej()
Getter for field QLIMALLOCREJNumber of queue limit allocate rejections
The number of session allocations that have failed on this connection because the queue limit value has been reached.
-
getMqtallqpurg
java.lang.Long getMqtallqpurg()
Getter for field MQTALLQPURGNumber 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.
-
getMqtallpurg
java.lang.Long getMqtallpurg()
Getter for field MQTALLPURGNumber 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.
-
getExitallcrej
java.lang.Long getExitallcrej()
Getter for field EXITALLCREJNumber of XISQUE allocate rejections
The number of session allocations on this connection that have been rejected by the XISQUE exit module.
-
getExitallcqpur
java.lang.Long getExitallcqpur()
Getter for field EXITALLCQPURNumber of XISQUE allocation queue purges
The number of session allocations on this connection that have been purged by the XISQUE exit module.
-
getExitallcpur
java.lang.Long getExitallcpur()
Getter for field EXITALLCPURNumber of XISQUE allocates purged
The number of sessions on this connection that have been purged by the XISQUE exit module.
-
getTransattch
java.lang.Long getTransattch()
Getter for field TRANSATTCHNumber of transactions attached
The number of transactions that have been attached on this connection.
-
getFspgreqs
java.lang.Long getFspgreqs()
Getter for field FSPGREQSNumber of PC function shipped requests
The number of program control LINK requests for function shipping on this connection.
-
getSsltype
IIPICConnection.SsltypeValue getSsltype()
Getter for field SSLTYPESecure sockets layer (SSL) type
Whether the service uses secure sockets layer.
- NOSSL - The service does not use secure sockets layer.
- SSL - Secure sockets layer is used by this service except for client authentication.
-
getUserauth
IIPICConnection.UserauthValue getUserauth()
Getter for field USERAUTHAttach-time user security level
The level of attach-time user security required for the connection:
- DEFAULTUSER - CICS will not accept a user ID and password from the partner system. All requests run under the default user ID.
- LOCAL - CICS will not accept a user ID and password from the partner system. All requests will run under the user ID determined for link security.
- VERIFY - Incoming attach requests must specify a user identifier and a user password.
- IDENTIFY - Incoming attach requests must specify a user identifier.
-
getCertificate
java.lang.String getCertificate()
Getter for field CERTIFICATECertificate
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.
-
getNumciphers
java.lang.Long getNumciphers()
Getter for field NUMCIPHERSNumber of SSL cipher suite codes
The count of cipher suite codes, which are specified as hexadecimal pairs. A value of 0 could indicate the use of an XML cipher file.
-
getCiphers
java.lang.String getCiphers()
Getter for field CIPHERSSSL cipher suite codes
A value specifying up to 28 cipher suites, in the form of hexadecimal pairs. From CICS Transaction Server Version 5 this field can alternatively specify the name of an XML file residing on zFS which contains a list of ciphers. An XML file can be up to 28 characters.
-
getSecurityname
java.lang.String getSecurityname()
Getter for field SECURITYNAMESecurity 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.
-
getChangeAgent
IIPICConnection.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast 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 - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- AUTOINSTALL - The resource was last autoinstalled.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast 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.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast 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.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast 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.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource 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 DEFINETIMECreation 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.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getInstallAgent
IIPICConnection.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- AUTOINSTALL - The resource was autoinstalled.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getClientloc
java.lang.String getClientloc()
Getter for field CLIENTLOCMost 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 Communications Server IP Sockets Application Programming Interface Guide in the z/OS documentation for a description of SO_CLUSTERCONNTYPE and an explanation of the bit settings.
-
getPartner
java.lang.String getPartner()
Getter for field PARTNERProduct token of partner system
The product token of the partner system, unless the partner system is CICS TS 5.3 or later and is making use of the HTTPUSRAGENTHDR system initialization parameter. The field is blank when the connection is not acquired or if the partner system has not indicated a product token when the connection is established.
-
getIpresolved
java.lang.String getIpresolved()
Getter for field IPRESOLVEDRemote 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.
-
getIpfamily
IIPICConnection.IpfamilyValue getIpfamily()
Getter for field IPFAMILYThe format of the resolved IP address
The format of the resolved IP address, IPRESOLVED. These are the possible values:
- IPV4 - The address is specified in IPv4 dotted decimal address format.
- IPV6 - The address is specified in IPv6 colon hexadecimal address format.
- UNKNOWN - IPRESOLVED is not yet in use, or the address cannot be resolved. This is the default when IPRESOLVED is 0.0.0.0
-
getHosttype
IIPICConnection.HosttypeValue getHosttype()
Getter for field HOSTTYPEHost name's address format
The format of the host's address. These are the possible values:
- HOSTNAME - HOST contains a character host name. The IP address that corresponds to the host name is looked up using DNS.
- IPV4 - HOST contains an IPv4 address specified in dotted decimal address format.
- IPV6 - HOST contains an IPv6 address specified in colon hexadecimal address format.
- NOTAPPLIC - The HOST name or address is incorrect (HOST=0.0.0.0 or HOST=*).
-
getTrreqs
java.lang.Long getTrreqs()
Getter for field TRREQSNumber of TR function shipped requests
The number of transaction routing requests over this connection.
-
getTrbytesent
java.lang.Long getTrbytesent()
Getter for field TRBYTESENTNumber of TR function shipped bytes sent
The number of bytes sent for transaction routing on this connection.
-
getTrbyterecd
java.lang.Long getTrbyterecd()
Getter for field TRBYTERECDNumber of TR function shipped bytes received
The number of bytes received for transaction routing on this connection.
-
getFsicreqs
java.lang.Long getFsicreqs()
Getter for field FSICREQSNumber of IC function shipped requests
The number of interval control requests for function shipping on this connection.
-
getFsicbytesent
java.lang.Long getFsicbytesent()
Getter for field FSICBYTESENTNumber of IC function shipped bytes sent
The number of bytes sent on interval control requests.
-
getFsicbyterecd
java.lang.Long getFsicbyterecd()
Getter for field FSICBYTERECDNumber of IC function shipped bytes received
The number of bytes received on interval control requests.
-
getIdprop
IIPICConnection.IdpropValue getIdprop()
Getter for field IDPROPIdentity 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.
- NOTALLOWED: A user ID associated with the sending transaction is sent for requests using this connection. NOTALLOWED is the default value.
- OPTIONAL: A distributed identity is sent, if available. The user ID associated with the sending transaction is also sent.
- REQUIRED: A distributed identity is required for requests using this connection. If REQUIRED is specified, the receiving system must support distributed identities. The user ID associated with the sending transaction is not sent. If you specify IDPROP(REQUIRED), a task using the IPIC connection must have an associated distributed identity, otherwise the request fails with a security error.
-
getRemtrmstrt
java.lang.Long getRemtrmstrt()
Getter for field REMTRMSTRTRemote terminal starts
The number of remote terminal starts over this connection.
-
getMirrorlife
IIPICConnection.MirrorlifeValue getMirrorlife()
Getter for field MIRRORLIFEMinimum 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.
- REQUEST: The mirror task will terminate as soon as possible.
- TASK: The mirror task remains available to the application issuing the remote request the until the end of this application's task.
- UOW: The mirror transaction remains available to the application issuing the remote request until the next syncpoint is issued.
-
getFsfcreqs
java.lang.Long getFsfcreqs()
Getter for field FSFCREQSNumber of FC function shipped requests
The number of file control requests for function shipping on this connection.
-
getFsfcbytesent
java.lang.Long getFsfcbytesent()
Getter for field FSFCBYTESENTNumber of FC function shipped bytes sent
The number of bytes sent by file control requests.
-
getFsfcbyterecd
java.lang.Long getFsfcbyterecd()
Getter for field FSFCBYTERECDNumber of FC function shipped bytes received
The number of bytes received by file control requests.
-
getFstdreqs
java.lang.Long getFstdreqs()
Getter for field FSTDREQSNumber of TD function shipped requests
The number of transient data requests for function shipping on this connection.
-
getFstdbytesent
java.lang.Long getFstdbytesent()
Getter for field FSTDBYTESENTNumber of TD function shipped bytes sent
The number of bytes sent on transient data requests.
-
getFstdbyterecd
java.lang.Long getFstdbyterecd()
Getter for field FSTDBYTERECDNumber of TD function shipped bytes received
The number of bytes received on transient data requests.
-
getFstsreqs
java.lang.Long getFstsreqs()
Getter for field FSTSREQSNumber of TS function shipped requests
The number of temporary storage requests for function shipping on this connection.
-
getFstsbytesent
java.lang.Long getFstsbytesent()
Getter for field FSTSBYTESENTNumber of TS function shipped bytes sent
The number of bytes sent on temporary storage requests.
-
getFstsbyterecd
java.lang.Long getFstsbyterecd()
Getter for field FSTSBYTERECDNumber of TS function shipped bytes received
The number of bytes received on temporary storage requests.
-
getUnsupreqs
java.lang.Long getUnsupreqs()
Getter for field UNSUPREQSNumber of unsupported requests
The number of attempts to function ship unsupported requests across this connection.
-
getHighAvailabilityStatus
IIPICConnection.HighAvailabilityStatusValue getHighAvailabilityStatus()
Getter for field HAHigh availability status
Indicate whether the IPIC connection requires high availability.
- REQUIRED
- The IPIC connection requires high availability.
- NOTREQUIRED
- The IPIC connection does not require high availability.
-
getCICSObjectReference
IIPICConnectionReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-