Interface IUnitOfWorkLink
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IUnitOfWorkLink extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IUnitOfWorkLink.ProtocolValue
Enumeration type for field PROTOCOLstatic class
IUnitOfWorkLink.ResynchronizationStatusValue
Enumeration type for field RESYNCSTATUSstatic class
IUnitOfWorkLink.RoleValue
Enumeration type for field ROLEstatic class
IUnitOfWorkLink.TypeValue
Enumeration type for field TYPE
-
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 IUnitOfWorkLinkReference
getCICSObjectReference()
java.lang.String
getHostAddress()
Getter for field HOSTjava.lang.String
getLinkName()
Getter for field LINKNAMEjava.lang.String
getLinkToken()
Getter for field LINKjava.lang.String
getNetworkWideUnitOfWorkName()
Getter for field NETUOWIDICICSType<IUnitOfWorkLink>
getObjectType()
java.lang.Long
getPort()
Getter for field PORTIUnitOfWorkLink.ProtocolValue
getProtocol()
Getter for field PROTOCOLjava.lang.String
getRemoteSystemName()
Getter for field SYSIDIUnitOfWorkLink.ResynchronizationStatusValue
getResynchronizationStatus()
Getter for field RESYNCSTATUSIUnitOfWorkLink.RoleValue
getRole()
Getter for field ROLEjava.lang.String
getRrmsUnitOfRecoverableWorkID()
Getter for field RRMSURIDjava.lang.String
getTaskRelatedUserExitQualifier()
Getter for field RMIQFYIUnitOfWorkLink.TypeValue
getType()
Getter for field TYPEjava.lang.String
getUnitOfWorkID()
Getter for field UOWIDjava.lang.String
getXIDBranchQualifier()
Getter for field BRANCHQUALjava.lang.String
getXIDGlobalTransactionIdentifier()
Getter for field XID-
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<IUnitOfWorkLink> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getLinkToken
java.lang.String getLinkToken()
Getter for field LINKLink token
Indicates, for a TYPE value of CONNECTION, the 8-character netname of the remote system.
For a TYPE value of RMI, LINK returns the entry name of the task-related user exit.
For a TYPE value of CFTABLE, LINK displays the 8-character name of the coupling facility data table pool.
For a type value of IIOP, LINK displays blanks; the equivalent information for IIOP UOWLINKs is displayed by the HOST attribute.
For a TYPE value of IPCONN, LINK displays the 8-character APPLID of the remote system.
-
getUnitOfWorkID
java.lang.String getUnitOfWorkID()
Getter for field UOWIDUnit of work (UOW) ID
The local identifier for this unit of work.
-
getLinkName
java.lang.String getLinkName()
Getter for field LINKNAMENetname of remote system, global user exit name or JVM server name
When the Type field contains a value of CONNECTION, this field identifies the connection for which link data is being returned. When the Type field contains a value of RMI, this field identifies the entry name of the task-related user exit for which the link data is being returned. When the Type field contains a value of JVMSERVER, this field contains the name of the JVM server.
-
getType
IUnitOfWorkLink.TypeValue getType()
Getter for field TYPEResource type
Identifies the type of connection.
- CFTABLE - A connection to a CFDT server.
- CONNECTION - A connection defined in a CONNECTION resource definition.
- IPCONN - A connection defined in an IPCONN resource definition.
- JVMSERVER - A connection to a WebSphere Liberty Profile using JTA.
- RMI - A connection to an external resource manager using the resource manager interface (RMI).
-
getRemoteSystemName
java.lang.String getRemoteSystemName()
Getter for field SYSIDName of remote system
When the TYPE field contains a value of CONNECTION, this field identifies the remote system for which link data is being returned.
-
getTaskRelatedUserExitQualifier
java.lang.String getTaskRelatedUserExitQualifier()
Getter for field RMIQFYEntry qualifier of task related user exit
When the Type field contains a value of RMI, this field provides the RMI entry qualifier.
-
getRole
IUnitOfWorkLink.RoleValue getRole()
Getter for field ROLERole of connection
Indicates the role of the connection. The valid values are:
- COORDINATOR - This connection is to the syncpoint coordinator for the unit of work.
- SUBORDINATE - This connection is to a syncpoint subordinate for the unit of work.
- UNKNOWN - The syncpoint role of this connection has not been determined.
-
getResynchronizationStatus
IUnitOfWorkLink.ResynchronizationStatusValue getResynchronizationStatus()
Getter for field RESYNCSTATUSResynchronization status
Indicates the resynchronization status of the link. The valid values are:
- COLD - The link was cold started by the partner
- OK - The link is operating normally.
- STARTING - The link is in the process of starting.
- UNAVAILABLE - The link is not currently available
- UNCONNECTED - There is no associated connection.
- NOTAPPLIC - The connection was not created using recovery protocols. It could be an RMI, an APPC single-session, an APPC synclevel 1 connection, an IPCONN, or a CFDT server.
-
getProtocol
IUnitOfWorkLink.ProtocolValue getProtocol()
Getter for field PROTOCOLLink protocol
Indicates the communications protocol being used by the connection. The valid values are:
- APPC - Advanced Program to Program Communications.
- IRC - InterRegion Communications.
- LU61 - LUTYPE 6.1
- RRMS - Unit of Work is being coordinated by RRMS/MVS
- IPIC - IP Interconnectivity, relating to IPCONN connections
- OTS - An Object transaction service (OTS) link.
- NOTAPPLIC - This is an RMI connection
-
getNetworkWideUnitOfWorkName
java.lang.String getNetworkWideUnitOfWorkName()
Getter for field NETUOWIDNetwork-wide LU 6.2 name of UOW
The network-wide LU6.2 ID of the unit of work for which link data is being returned.
-
getRrmsUnitOfRecoverableWorkID
java.lang.String getRrmsUnitOfRecoverableWorkID()
Getter for field RRMSURIDRRMS Unit of recoverable work ID
The Unit of Recovery ID/token given to CICS by RRMS.
-
getHostAddress
java.lang.String getHostAddress()
Getter for field HOSTTCP/IP host address
The host name.
-
getXIDGlobalTransactionIdentifier
java.lang.String getXIDGlobalTransactionIdentifier()
Getter for field XIDXID Global Transaction Identifier
A 64-character area containing the global transaction identifier portion of the X/Open transaction identifier associated with this link's unit of work.
-
getPort
java.lang.Long getPort()
Getter for field PORTTCP/IP port number
The port number on which the host is listening. It is only set if the protocol is IPIC and the remote host is an CICS region.
-
getXIDBranchQualifier
java.lang.String getXIDBranchQualifier()
Getter for field BRANCHQUALXID Branch Qualifier
A 64-character area containing the branch qualifier identifier portion of the X/Open transaction identifier associated with this link's unit of work.
-
getCICSObjectReference
IUnitOfWorkLinkReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-