CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.util
Class OriginData

java.lang.Object
  extended by com.ibm.ctg.util.OriginData

public class OriginData
extends java.lang.Object

Represents IPIC origin data which can be used to associate the flow from a Java application through to a CICS region.


Constructor Summary
OriginData(java.lang.String applid, java.lang.String applidQualifier, java.lang.String transId, java.lang.String userId, java.net.InetAddress ipAddr, int port)
          Builds a new OriginData based on the information provided and the time that his object was created.
 
Method Summary
 java.lang.String getApplid()
          Returns the APPLID of the Java client application from which the transaction was started.
 java.lang.String getApplidQualifier()
          Returns the APPLID qualifier of the Java client application from which the transaction was started.
 java.net.InetAddress getClientIpaddr()
          Returns the IP address from which the transaction was started.
 int getClientPort()
          Returns the TCP/IP port from which the transaction was started.
 java.lang.String getIpAddrFamily()
          Returns the IP address family associated with the client IP address.
 byte[] getPrincipalFacilityType()
          Returns the principal facility type of the origin data.
 long getStartStck()
          Returns a store clock value representing the time when the origin data was created.
 byte[] getTransGroupId()
          Returns the transaction group ID associated with the origin data.
 java.lang.String getTransId()
          Returns the CICS mirror transaction under which the transaction was started.
 java.lang.String getUserid()
          Returns the CICS user ID under which the transaction was started.
 java.lang.String toString()
          Returns a string representation of the origin data.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OriginData

public OriginData(java.lang.String applid,
                  java.lang.String applidQualifier,
                  java.lang.String transId,
                  java.lang.String userId,
                  java.net.InetAddress ipAddr,
                  int port)
Builds a new OriginData based on the information provided and the time that his object was created.

Parameters:
applid - The applid of the process starting the transaction
applidQualifier - The applid qualifier of the process starting the transaction
transId - The mirror transaction to be used in CICS
userId - The user id that has been set for this request
ipAddr - The IP address of the process starting the transaction
port - The port of the process starting the transaction
Method Detail

toString

public java.lang.String toString()
Returns a string representation of the origin data.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of the origin data

getApplid

public java.lang.String getApplid()
Returns the APPLID of the Java client application from which the transaction was started.

Returns:
The APPLID from which the transaction was started

getClientIpaddr

public java.net.InetAddress getClientIpaddr()
Returns the IP address from which the transaction was started.

Returns:
The IP address from which the transaction was started

getClientPort

public int getClientPort()
Returns the TCP/IP port from which the transaction was started.

Returns:
The TCP/IP port from which the transaction was started

getIpAddrFamily

public java.lang.String getIpAddrFamily()
Returns the IP address family associated with the client IP address.

Returns:
The IP address family

getApplidQualifier

public java.lang.String getApplidQualifier()
Returns the APPLID qualifier of the Java client application from which the transaction was started.

Returns:
The APPLID qualifier from which the transaction was started

getPrincipalFacilityType

public byte[] getPrincipalFacilityType()
Returns the principal facility type of the origin data.

Returns:
The principal facility type of the origin data

getStartStck

public long getStartStck()
Returns a store clock value representing the time when the origin data was created.

Returns:
The store clock value

getTransGroupId

public byte[] getTransGroupId()
Returns the transaction group ID associated with the origin data.

Returns:
The transaction group ID of the origin data.

getTransId

public java.lang.String getTransId()
Returns the CICS mirror transaction under which the transaction was started.

Returns:
The CICS mirror transaction

getUserid

public java.lang.String getUserid()
Returns the CICS user ID under which the transaction was started.

Returns:
The CICS user ID

©Copyright IBM Corp. 1994, 2014
Legal