Interface ITaskAssociation
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface ITaskAssociation extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ITaskAssociation.ClientIPFormatValue
Enumeration type for field CLNTIPFAMILYstatic class
ITaskAssociation.FacilityTypeValue
Enumeration type for field FACILTYPEstatic class
ITaskAssociation.OriginFacilityTypeValue
Enumeration type for field ODFACILTYPEstatic class
ITaskAssociation.OriginIPAddressFormatValue
Enumeration type for field ODIPFAMILYstatic class
ITaskAssociation.ServerIPFormatValue
Enumeration type for field IPFAMILY
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getApplData()
Getter for field APPLDATAjava.lang.Long
getApplicationMajorVersion()
Getter for field ACMAJORVERjava.lang.Long
getApplicationMicroVersion()
Getter for field ACMICROVERjava.lang.Long
getApplicationMinorVersion()
Getter for field ACMINORVERjava.lang.String
getApplicationName()
Getter for field ACAPPLNAMEjava.lang.String
getApplicationOperationName()
Getter for field ACOPERNAMEjava.lang.String
getApplicationPlatformName()
Getter for field ACPLATNAMEjava.lang.String
getApplID()
Getter for field APPLIDITaskAssociationReference
getCICSObjectReference()
java.lang.String
getClientIPAddress()
Getter for field CLIENTIPADDRITaskAssociation.ClientIPFormatValue
getClientIPFormat()
Getter for field CLNTIPFAMILYjava.lang.Long
getClientPort()
Getter for field CLIENTPORTjava.lang.String
getClusterConnType()
Getter for field CLIENTLOCjava.lang.String
getDistinguishedName()
Getter for field DNAMEjava.lang.String
getFacilityName()
Getter for field FACILNAMEITaskAssociation.FacilityTypeValue
getFacilityType()
Getter for field FACILTYPEjava.lang.String
getInitiatingUserID()
Getter for field INITUSERIDjava.lang.String
getIPCONNResource()
Getter for field IPCONNjava.lang.String
getMVSImage()
Getter for field MVSIMAGEjava.lang.String
getNetID()
Getter for field NETIDICICSType<ITaskAssociation>
getObjectType()
java.lang.String
getOriginAdapterData1()
Getter for field ODAPTRDATA1java.lang.String
getOriginAdapterData2()
Getter for field ODAPTRDATA2java.lang.String
getOriginAdapterData3()
Getter for field ODAPTRDATA3java.lang.String
getOriginAdapterID()
Getter for field ODAPTRIDjava.lang.String
getOriginApplID()
Getter for field ODAPPLIDjava.lang.String
getOriginApplIDNetID()
Getter for field ODNETWORKIDjava.lang.String
getOriginFacilityName()
Getter for field ODFACILNAMEITaskAssociation.OriginFacilityTypeValue
getOriginFacilityType()
Getter for field ODFACILTYPEjava.lang.String
getOriginIPAddress()
Getter for field ODCLNTIPADDRITaskAssociation.OriginIPAddressFormatValue
getOriginIPAddressFormat()
Getter for field ODIPFAMILYjava.lang.String
getOriginNetID()
Getter for field ODNETIDjava.lang.Long
getOriginPort()
Getter for field ODCLNTPORTjava.lang.Long
getOriginServerPort()
Getter for field ODSERVERPORTjava.lang.String
getOriginTask()
Getter for field ODTASKIDjava.lang.String
getOriginTaskStartDate()
Getter for field ODSTARTTMjava.util.Date
getOriginTaskStartTime()
Getter for field ODSTARTTIMEjava.lang.String
getOriginTCPIPService()
Getter for field ODTCPIPSjava.lang.String
getOriginTransactionID()
Getter for field ODTRANSIDjava.lang.String
getOriginUserID()
Getter for field ODUSERIDjava.lang.String
getOriginVTAMLUName()
Getter for field ODLUNAMEjava.lang.String
getPrevHopApplId()
Getter for field PHAPPLIDjava.lang.Long
getPrevHopCount()
Getter for field PHCOUNTjava.lang.String
getPrevHopNetID()
Getter for field PHNETWORKIDjava.lang.String
getPrevHopStartDate()
Getter for field PHSTARTTMjava.util.Date
getPrevHopStartTime()
Getter for field PHSTARTTIMEjava.lang.String
getPrevHopTaskID()
Getter for field PHTASKIDjava.lang.String
getPrevHopTransID()
Getter for field PHTRANSIDjava.lang.Long
getPrevTransactionCount()
Getter for field PTCOUNTjava.lang.String
getPrevTransactionStartDate()
Getter for field PTSTARTTMjava.util.Date
getPrevTransactionStartTime()
Getter for field PTSTARTTIMEjava.lang.String
getPrevTransactionTaskID()
Getter for field PTTASKIDjava.lang.String
getPrevTransactionTransID()
Getter for field PTTRANSIDjava.lang.String
getProgram()
Getter for field PROGRAMjava.lang.String
getRealm()
Getter for field REALMjava.lang.String
getServerIPAddress()
Getter for field SERVERIPADDRITaskAssociation.ServerIPFormatValue
getServerIPFormat()
Getter for field IPFAMILYjava.lang.Long
getServerPort()
Getter for field SERVERPORTjava.lang.String
getStartDate()
Getter for field STARTTMjava.util.Date
getStartTime()
Getter for field STARTTIMEjava.lang.String
getTaskID()
Getter for field TASKIDjava.lang.String
getTCPIPJob()
Getter for field TCPIPJOBjava.lang.String
getTCPIPSecurityZone()
Getter for field TCPIPZONEjava.lang.String
getTCPIPService()
Getter for field TCPIPSERVICEjava.lang.String
getTransGroupID()
Getter for field TRNGRPIDjava.lang.String
getTransID()
Getter for field TRANSACTIONjava.lang.String
getUserCorrelationData()
Getter for field USERCORRDATAjava.lang.String
getUserID()
Getter for field USERIDjava.lang.String
getVTAMLUName()
Getter for field LUNAME-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ITaskAssociation> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getTaskID
java.lang.String getTaskID()
Getter for field TASKIDTask ID
The Task association information (TASKASSC) views show information associated to active tasks.
-
getTransGroupID
java.lang.String getTransGroupID()
Getter for field TRNGRPIDTransaction group ID
The transaction group ID of the origin transaction.
-
getOriginPort
java.lang.Long getOriginPort()
Getter for field ODCLNTPORTOriginating portnumber
The number of the port used by the TCP/IP client that requested the originating task to start. If the originating task was not started in this way ODCLNTPORT returns zero.
-
getOriginFacilityType
ITaskAssociation.OriginFacilityTypeValue getOriginFacilityType()
Getter for field ODFACILTYPEOriginating facility type
The type of facility that initiated the originating task that is associated with this task.
-
getFacilityType
ITaskAssociation.FacilityTypeValue getFacilityType()
Getter for field FACILTYPEFacility type
The type of facility that initiated this task.
-
getServerIPFormat
ITaskAssociation.ServerIPFormatValue getServerIPFormat()
Getter for field IPFAMILYServer IP address format
A value indicating the format of the IP address in the SERVERIPADDR field. 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.
- NOTAPPLIC - 0.0.0.0 is specified for the address.
-
getOriginIPAddressFormat
ITaskAssociation.OriginIPAddressFormatValue getOriginIPAddressFormat()
Getter for field ODIPFAMILYOriginating client IP address format
A value indicating the format of the IP address in the ODCLNTIPADDR field. 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.
- NOTAPPLIC - 0.0.0.0 is specified for the address.
-
getServerPort
java.lang.Long getServerPort()
Getter for field SERVERPORTServer listening port
The number of the port on which the IP service that received the request that resulted in this task being attached, is listening. The service can be a TCPIPSERVICE resource or a Liberty JVM server. If the task was not started in this way, SERVERPORT contains zero.
-
getStartTime
java.util.Date getStartTime()
Getter for field STARTTIMETask start time
The time when this task was started. The time is expressed in GMT.
-
getOriginTaskStartTime
java.util.Date getOriginTaskStartTime()
Getter for field ODSTARTTIMEOriginating task start time
The time when the originating task was started. The time is expressed in GMT.
-
getApplData
java.lang.String getApplData()
Getter for field APPLDATASocket application data
The application data associated by CICS with the socket that received the request that started this task. If the task was not started through a socket then APPLDATA is blank.
-
getApplID
java.lang.String getApplID()
Getter for field APPLIDApplication ID
The CICS region this task is running in.
-
getClientPort
java.lang.Long getClientPort()
Getter for field CLIENTPORTTCP/IP stack port number
The number of the port that the TCP/IP stack used to send the request that resulted in this task being attached. If the task was not started in this way, CLIENTPORT contains zero.
-
getInitiatingUserID
java.lang.String getInitiatingUserID()
Getter for field INITUSERIDUser ID of initiating task
The user ID of the initiating task (the task that caused this one to be attached).
-
getIPCONNResource
java.lang.String getIPCONNResource()
Getter for field IPCONNIPCONN resource
The name of any IP connection (IPCONN) that was used to receive a request that resulted in this task starting. If the task was not started in this way, IPCONN contains blanks. This field contains a non-blank value only when the FACILTYPE is IPCONN.
-
getVTAMLUName
java.lang.String getVTAMLUName()
Getter for field LUNAMEVTAM LU name
The fully-qualified network name of the terminal from which this task was started. If the task was started from an IP interconnectivity (IPCONN), ISC over SNA (APPC), or MRO session, LUNAME contains the network name of the remote region. If the task was not started from a terminal, nor from an IPCONN, APPC, or MRO session, LUNAME contains blanks. For OTS transactions, LUNAME contains blanks.
-
getFacilityName
java.lang.String getFacilityName()
Getter for field FACILNAMEFacility name
The facility associated with the initiation of this task. If the task was started by an unnamed facility, this attribute contains blanks.
-
getMVSImage
java.lang.String getMVSImage()
Getter for field MVSIMAGEMVS image
The name of the MVS image associated with the TCPIPSERVICE used to receive a request that resulted in this task starting. If the task was not started in this way, MVSIMAGE contains blanks. Note: This function is dependent on Communication Server TCP/IP Network Access Control support being activated and the CLIENTIPADDRESS being configured into a network security zone.
-
getOriginApplID
java.lang.String getOriginApplID()
Getter for field ODAPPLIDOriginating Application ID
The application ID taken from the Origin Descriptor associated with this task.
-
getOriginFacilityName
java.lang.String getOriginFacilityName()
Getter for field ODFACILNAMEOriginating facility name
If the facility associated with the initiation of the originating task is a transient data queue, a terminal, or a system, this attribute contains the name of the facility. If the originating task was not started in any of these ways, this attribute contains blanks.
-
getOriginVTAMLUName
java.lang.String getOriginVTAMLUName()
Getter for field ODLUNAMEOriginating VTAM LU name
The fully-qualified network name of the terminal from which the originating task was started. If the originating task was started from an IP interconnectivity (IPCONN), ISC over SNA (APPC), or MRO session, this attribute contains the network name of the remote region. If the originating task was not started from a terminal, nor from an IPCONN, APPC, or MRO session, this attribute contains blanks. For OTS transactions, this attribute contains blanks.
-
getOriginTask
java.lang.String getOriginTask()
Getter for field ODTASKIDOriginating task ID
The task ID of the originating task.
-
getOriginTransactionID
java.lang.String getOriginTransactionID()
Getter for field ODTRANSIDOriginating transaction ID
The name of the transaction under which the originating task ran.
-
getOriginUserID
java.lang.String getOriginUserID()
Getter for field ODUSERIDOriginating user ID
The user ID under which the originating task ran.
-
getProgram
java.lang.String getProgram()
Getter for field PROGRAMFirst program
The name of the first program invoked by a task executing this transaction.
-
getTCPIPJob
java.lang.String getTCPIPJob()
Getter for field TCPIPJOBTCP/IP job
The name of the TCP/IP job associated with the IP connection (IPCONN) that received the request that resulted in this task starting. If the task was not started in this way, TCPIPJOB contains blanks. Note: This function is dependent on Communication Server TCP/IP Network Access Control support being activated and the CLIENTIPADDRESS being configured into a network security zone
-
getTCPIPService
java.lang.String getTCPIPService()
Getter for field TCPIPSERVICETCP/IP service name
The name of the TCPIPSERVICE associated with the IP connection (IPCONN) that received the request that resulted in this task starting. If the task was not started in this way, this attribute contains blanks.
-
getTCPIPSecurityZone
java.lang.String getTCPIPSecurityZone()
Getter for field TCPIPZONETCP/IP network security zone
The name of the TCP/IP network security zone, if any, associated with the IPCONN that received the request that resulted in this task starting. If there is no TCP/IP network security zone, or the task was not started in this way, this attribute contains blanks. Note: This function is dependent on Communication Server TCP/IP Network Access Control support being activated and the CLIENTIPADDRESS being configured into a network security zone.
-
getTransID
java.lang.String getTransID()
Getter for field TRANSACTIONTransaction ID
The name of the transaction that this task is executing.
-
getUserCorrelationData
java.lang.String getUserCorrelationData()
Getter for field USERCORRDATAUser correlation data
The user correlator data that was added to the associated data origin descriptor by means of an XAPADMGR global user exit program. This field is created when the originating task is started. If the global user exit program is not driven at that point, this attribute contains blanks.
-
getUserID
java.lang.String getUserID()
Getter for field USERIDUser ID
The user ID associated with this task.
-
getOriginApplIDNetID
java.lang.String getOriginApplIDNetID()
Getter for field ODNETWORKIDOriginating network ID
The network qualifier for the origin region APPLID that the task ran on.
-
getNetID
java.lang.String getNetID()
Getter for field NETIDNetwork ID
The network ID of the terminal from which this task was started.
-
getOriginNetID
java.lang.String getOriginNetID()
Getter for field ODNETIDOriginating network ID
The network qualifier for the LUNAME that caused the task to run.
-
getClientIPAddress
java.lang.String getClientIPAddress()
Getter for field CLIENTIPADDRClient IP address
The IPv4 or IPv6 address of the TCP/IP client that requested this task to start. The format of this IP address is given in the IPFAMILY field. If this task was not started from a TCP/IP client or the source of this task has not yet been determined, this field will contain 0.0.0.0
-
getOriginIPAddress
java.lang.String getOriginIPAddress()
Getter for field ODCLNTIPADDROriginating client IP address
The IPv4 or IPv6 address of the TCP/IP client that requested the originating task to start. The format of this IP address is given in the ODIPFAMILY field. If the originating task was not started from a TCP/IP client or the source of the originating task has not yet been determined, this field will contain 0.0.0.0
-
getServerIPAddress
java.lang.String getServerIPAddress()
Getter for field SERVERIPADDRScheduling IP server
The IPv4 or IPv6 address of the IP service that scheduled this task. The format of this IP address is given in the IPFAMILY field. If this task was not started from a IP service or the source of this task has not yet been determined, this field will contain 0.0.0.0.
-
getStartDate
java.lang.String getStartDate()
Getter for field STARTTMTask start time
A 21-character representation of the time when this task was started. The time is in the form yyyymmddhhmmss.ssssss.
-
getOriginTaskStartDate
java.lang.String getOriginTaskStartDate()
Getter for field ODSTARTTMOriginating task start time
A 21-character representation of the time when the originating task was started. The time is in the form yyyymmddhhmmss.ssssss.
-
getClusterConnType
java.lang.String getClusterConnType()
Getter for field CLIENTLOCCluster connection type
The SO_CLUSTERCONNTYPE options returned by z/OS Communications Server for the facility in FACILNAME, unless the value in FACILTYPE is IPIC in which case the CLIENTLOC value for the IPCONN is 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.
-
getClientIPFormat
ITaskAssociation.ClientIPFormatValue getClientIPFormat()
Getter for field CLNTIPFAMILYClient IP address format
A value indicating the format of the IP address in the CLIENTIPADDR field. 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.
- NOTAPPLIC - 0.0.0.0 is specified for the address.
-
getDistinguishedName
java.lang.String getDistinguishedName()
Getter for field DNAMEDistinguished name
This is the distinguished name for the specified realm. The name can be up to 246 UTF-8 characters long, which are displayed in hexadecimal format.
-
getRealm
java.lang.String getRealm()
Getter for field REALMBasic authentication realm name
This is the realm name. The realm can be up to 255 UTF-8 characters long, which are displayed in hexadecimal format.
-
getPrevHopApplId
java.lang.String getPrevHopApplId()
Getter for field PHAPPLIDPrevious hop applid
The VTAM application ID of the CICS system of a previous task in another CICS system with which this task is associated, or blanks if the CICS system on which this command is executed is a point of origin.
-
getPrevHopNetID
java.lang.String getPrevHopNetID()
Getter for field PHNETWORKIDPrevious hop network qualifier
The network qualifier for the CICS system VTAM application ID of an immediately previous task with which this task is associated, or blanks if the CICS system on which this command is executed is a point of origin.
-
getPrevHopTransID
java.lang.String getPrevHopTransID()
Getter for field PHTRANSIDPrevious hop transaction ID
The transaction ID of an immediately previous task in another CICS region with which this task is associated, or blanks if the CICS system on which this command is executed is a point of origin.
-
getPrevHopStartDate
java.lang.String getPrevHopStartDate()
Getter for field PHSTARTTMPrevious hop task start time
This is the time the task on the previous hop started.
-
getPrevHopTaskID
java.lang.String getPrevHopTaskID()
Getter for field PHTASKIDPrevious hop task ID
The task ID of an immediately previous task in another CICS region with which this task is associated, or blanks if the CICS system on which this command is executed is a point of origin.
-
getPrevHopStartTime
java.util.Date getPrevHopStartTime()
Getter for field PHSTARTTIMEPrevious hop task start time
The start time of an immediately previous task in another CICS region with which this task is associated. The time is in the form yyyymmddhhmmss.ssssss. This option is set as blanks if the CICS system on which this command is executed is a point of origin.
-
getPrevHopCount
java.lang.Long getPrevHopCount()
Getter for field PHCOUNTPrevious hop count
The number of times there has been a request from one CICS system to another to initiate a task with which this task is associated, or zero if the CICS system on which this command is executed is a point of origin.
-
getOriginAdapterID
java.lang.String getOriginAdapterID()
Getter for field ODAPTRIDOriginating adapter ID
The adapter identifier added to the origin data by the adapter. This field is blank if the task was not started via an adapter, or if it was and the adapter did not set this value.
-
getOriginAdapterData1
java.lang.String getOriginAdapterData1()
Getter for field ODAPTRDATA1Originating adapter data 1
The first section of the data that was added to the origin data by the adapter.
-
getOriginAdapterData2
java.lang.String getOriginAdapterData2()
Getter for field ODAPTRDATA2Originating adapter data 2
The second section of the data that was added to the origin data by the adapter.
-
getOriginAdapterData3
java.lang.String getOriginAdapterData3()
Getter for field ODAPTRDATA3Originating adapter data 3
The third section of the data that was added to the origin data by the adapter.
-
getApplicationName
java.lang.String getApplicationName()
Getter for field ACAPPLNAMECurrent Application Name
The name of the current application associated with this task.
-
getApplicationPlatformName
java.lang.String getApplicationPlatformName()
Getter for field ACPLATNAMECurrent Platform
The name of the current platform associated with this task.
-
getApplicationOperationName
java.lang.String getApplicationOperationName()
Getter for field ACOPERNAMECurrent Application Operation
The operation being performed by the current application associated with this task.
-
getApplicationMajorVersion
java.lang.Long getApplicationMajorVersion()
Getter for field ACMAJORVERCurrent Application Major Version
The major version of the current application associated with this task.
-
getApplicationMinorVersion
java.lang.Long getApplicationMinorVersion()
Getter for field ACMINORVERCurrent Application Minor Version
The minor version of the current application associated with this task.
-
getApplicationMicroVersion
java.lang.Long getApplicationMicroVersion()
Getter for field ACMICROVERCurrent Application Micro Version
The micro version of the current application associated with this task.
-
getOriginServerPort
java.lang.Long getOriginServerPort()
Getter for field ODSERVERPORTOriginating server port
The listening IP port number that was used when the originating task received the request. If the originating task was not started in this way, this attribute is zero.
-
getOriginTCPIPService
java.lang.String getOriginTCPIPService()
Getter for field ODTCPIPSOriginating TCP/IP service name
The name of the TCPIPSERVICE or Liberty JVM server IP listener associated with the request that resulted in the originating task starting. If the originating task was not started in this way, this attribute contains blanks.
-
getPrevTransactionCount
java.lang.Long getPrevTransactionCount()
Getter for field PTCOUNTPrevious transaction count
The number of times there has been a request from a task in the local CICS region to initiate a task in the same CICS region by either a RUN TRANSID or START command without the TERMID option with which this task is associated, or zero if there have been no such requests.
-
getPrevTransactionStartTime
java.util.Date getPrevTransactionStartTime()
Getter for field PTSTARTTIMEPrevious transaction task start time
The start time of an immediately previous, or parent, task in the same CICS region with which this task is associated. The time is in the form yyyymmddhhmmss.ssssss. This option is set as blanks if the task has no immediate parent task or is the point of origin for this request.
-
getPrevTransactionStartDate
java.lang.String getPrevTransactionStartDate()
Getter for field PTSTARTTMPrevious transaction task start time
The start time of an immediately previous, or parent, task in the same CICS region with which this task is associated. The time is in the form yyyymmddhhmmss.ssssss. This option is set as blanks if the task has no immediate parent task or is the point of origin for this request.
-
getPrevTransactionTaskID
java.lang.String getPrevTransactionTaskID()
Getter for field PTTASKIDPrevious transaction task ID
The task ID of an immediately previous, or parent, task in the same CICS region with which this task is associated, or zero if the task has no immediate parent task or is the point of origin for this request.
-
getPrevTransactionTransID
java.lang.String getPrevTransactionTransID()
Getter for field PTTRANSIDPrevious transaction transaction ID
The transaction ID of an immediately previous, or parent, task in the same CICS region with which this task is associated, or blanks if the task has no immediate parent task or is the point of origin for this request.
-
getCICSObjectReference
ITaskAssociationReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-