com.ibm.cics.model

Interface ITaskAssociation

    • Method Detail

      • getTaskID

        java.lang.String getTaskID()
        Getter for field TASKID

        Task ID

        The Task association information (TASKASSC) views show information associated to active tasks.

      • getTransGroupID

        java.lang.String getTransGroupID()
        Getter for field TRNGRPID

        Transaction group ID

        The transaction group ID of the origin transaction.

      • getOriginPort

        java.lang.Long getOriginPort()
        Getter for field ODCLNTPORT

        Originating 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 ODFACILTYPE

        Originating facility type

        The type of facility that initiated the originating task that is associated with this task.

      • getServerIPFormat

        ITaskAssociation.ServerIPFormatValue getServerIPFormat()
        Getter for field IPFAMILY

        Server 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 ODIPFAMILY

        Originating 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 SERVERPORT

        Server 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.lang.String getStartTime()
        Getter for field STARTTIME

        Task start time

        The time when this task was started. The time is expressed in GMT.

      • getOriginTaskStartTime

        java.lang.String getOriginTaskStartTime()
        Getter for field ODSTARTTIME

        Originating 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 APPLDATA

        Socket 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 APPLID

        Application ID

        The CICS region this task is running in.

      • getClientPort

        java.lang.Long getClientPort()
        Getter for field CLIENTPORT

        TCP/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 INITUSERID

        User 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 IPCONN

        IPCONN 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 LUNAME

        VTAM 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 FACILNAME

        Facility 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 MVSIMAGE

        MVS 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 ODAPPLID

        Originating Application ID

        The application ID taken from the Origin Descriptor associated with this task.

      • getOriginFacilityName

        java.lang.String getOriginFacilityName()
        Getter for field ODFACILNAME

        Originating 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 ODLUNAME

        Originating 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 ODTASKID

        Originating task ID

        The task ID of the originating task.

      • getOriginTransactionID

        java.lang.String getOriginTransactionID()
        Getter for field ODTRANSID

        Originating transaction ID

        The name of the transaction under which the originating task ran.

      • getOriginUserID

        java.lang.String getOriginUserID()
        Getter for field ODUSERID

        Originating user ID

        The user ID under which the originating task ran.

      • getProgram

        java.lang.String getProgram()
        Getter for field PROGRAM

        First program

        The name of the first program invoked by a task executing this transaction.

      • getTCPIPJob

        java.lang.String getTCPIPJob()
        Getter for field TCPIPJOB

        TCP/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 TCPIPSERVICE

        TCP/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 TCPIPZONE

        TCP/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 TRANSACTION

        Transaction ID

        The name of the transaction that this task is executing.

      • getUserCorrelationData

        java.lang.String getUserCorrelationData()
        Getter for field USERCORRDATA

        User 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 USERID

        User ID

        The user ID associated with this task.

      • getOriginApplIDNetID

        java.lang.String getOriginApplIDNetID()
        Getter for field ODNETWORKID

        Originating network ID

        The network qualifier for the origin region APPLID that the task ran on.

      • getNetID

        java.lang.String getNetID()
        Getter for field NETID

        Network ID

        The network ID of the terminal from which this task was started.

      • getOriginNetID

        java.lang.String getOriginNetID()
        Getter for field ODNETID

        Originating network ID

        The network qualifier for the LUNAME that caused the task to run.

      • getClientIPAddress

        java.lang.String getClientIPAddress()
        Getter for field CLIENTIPADDR

        Client 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 ODCLNTIPADDR

        Originating 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 SERVERIPADDR

        Scheduling 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 STARTTM

        Task 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 ODSTARTTM

        Originating 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 CLIENTLOC

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

      • getClientIPFormat

        ITaskAssociation.ClientIPFormatValue getClientIPFormat()
        Getter for field CLNTIPFAMILY

        Client 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 DNAME

        Distinguished 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 REALM

        Basic 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 PHAPPLID

        Previous 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 PHNETWORKID

        Previous 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 PHTRANSID

        Previous 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 PHSTARTTM

        Previous hop task start time

        This is the time the task on the previous hop started.

      • getPrevHopTaskID

        java.lang.String getPrevHopTaskID()
        Getter for field PHTASKID

        Previous 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.lang.String getPrevHopStartTime()
        Getter for field PHSTARTTIME

        Previous 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 PHCOUNT

        Previous 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 ODAPTRID

        Originating 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 ODAPTRDATA1

        Originating 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 ODAPTRDATA2

        Originating 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 ODAPTRDATA3

        Originating 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 ACAPPLNAME

        Current Application Name

        The name of the current application associated with this task.

      • getApplicationPlatformName

        java.lang.String getApplicationPlatformName()
        Getter for field ACPLATNAME

        Current Platform

        The name of the current platform associated with this task.

      • getApplicationOperationName

        java.lang.String getApplicationOperationName()
        Getter for field ACOPERNAME

        Current Application Operation

        The operation being performed by the current application associated with this task.

      • getApplicationMajorVersion

        java.lang.Long getApplicationMajorVersion()
        Getter for field ACMAJORVER

        Current Application Major Version

        The major version of the current application associated with this task.

      • getApplicationMinorVersion

        java.lang.String getApplicationMinorVersion()
        Getter for field ACMINORVER

        Current Application Minor Version

        The minor version of the current application associated with this task.

      • getApplicationMicroVersion

        java.lang.String getApplicationMicroVersion()
        Getter for field ACMICROVER

        Current Application Micro Version

        The micro version of the current application associated with this task.

      • getOriginServerPort

        java.lang.Long getOriginServerPort()
        Getter for field ODSERVERPORT

        Originating 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 ODTCPIPS

        Originating 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 PTCOUNT

        Previous 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.lang.String getPrevTransactionStartTime()
        Getter for field PTSTARTTIME

        Previous 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 PTSTARTTM

        Previous 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 PTTASKID

        Previous 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 PTTRANSID

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

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.