tcb (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.wtc.jatmi.tcb

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AaaTcb, CalloutTcb, CodesetTcb, ComposFmlTcb, ComposHdrTcb, MetaTcb, RouteTcb, TdomTcb, TdomTranTcb, TdomValsTcb, TranTcb, UnsolTcb, UserTcb, WsTcb
```
public abstract class tcb
extends java.lang.Object
implements java.io.Serializable
```
See Also:

Serialized Form

Excluded in public API Reference.

This interface represents all possible user data portions of the TCH.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`AAA_TCM`
`private static java.lang.String`	`AAA_TCM_STRING`
`static short`	`CALLOUT`
`private static java.lang.String`	`CALLOUT_STRING`
`static short`	`CODESET_TCM`
`private static java.lang.String`	`CODESET_TCM_STRING`
`static short`	`COMPOS_FML`
`private static java.lang.String`	`COMPOS_FML_STRING`
`static short`	`COMPOS_HDR`
`private static java.lang.String`	`COMPOS_HDR_STRING`
`static short`	`MAXDEF_TCM`
`private static java.lang.String`	`MAXDEF_TCM_STRING`
`static short`	`META_TCM`
`private static java.lang.String`	`META_TCM_STRING`
`static short`	`PKCS7_TCM`
`private static java.lang.String`	`PKCS7_TCM_STRING`
`static short`	`PROP_TCM`
`private static java.lang.String`	`PROP_TCM_STRING`
`static short`	`QS_TCM`
`private static java.lang.String`	`QS_TCM_STRING`
`static short`	`ROUTE`
`private static java.lang.String`	`ROUTE_STRING`
`private static long`	`serialVersionUID`
`static short`	`TDOM`
`static short`	`TDOM_SEC`
`private static java.lang.String`	`TDOM_SEC_STRING`
`private static java.lang.String`	`TDOM_STRING`
`static short`	`TDOM_TRAN`
`private static java.lang.String`	`TDOM_TRAN_STRING`
`static short`	`TDOM_VALS`
`private static java.lang.String`	`TDOM_VALS_STRING`
`static short`	`TEST_TCM`
`private static java.lang.String`	`TEST_TCM_STRING`
`static short`	`TM`
`private static java.lang.String`	`TM_STRING`
`static short`	`TRAN`
`private static java.lang.String`	`TRAN_STRING`
`protected short`	`type`
`static short`	`UNSOL`
`private static java.lang.String`	`UNSOL_STRING`
`static short`	`USER`
`private static java.lang.String`	`USER_STRING`
`static short`	`WS`
`private static java.lang.String`	`WS_STRING`

Constructor Summary

Constructors
Constructor and Description

tcb(short type)

Constructors
Constructor and Description
`tcb(short type)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) abstract int`	`_tmpostrecv(java.io.DataInputStream decoder, int recv_size, int hint_index)`
`(package private) abstract void`	`_tmpresend(java.io.DataOutputStream encoder, tch myheader)`
`short`	`getType()`
`(package private) abstract boolean`	`prepareForCache()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - type
```
protected short type
```
  - USER
```
public static final short USER
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    The USER TCB
  - TM
```
public static final short TM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    The standard TM TCB
  - TRAN
```
public static final short TRAN
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    The mainline Transaction TCB
  - WS
```
public static final short WS
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    The workstation TCB
  - UNSOL
```
public static final short UNSOL
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB used in unsolicited messages
  - COMPOS_HDR
```
public static final short COMPOS_HDR
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB used in composite messages (e.g., queue messages)
  - COMPOS_FML
```
public static final short COMPOS_FML
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB used in composite messages (e.g., queue messages)
  - TDOM
```
public static final short TDOM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A tdomains TCB
  - TDOM_SEC
```
public static final short TDOM_SEC
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A tdomains security TCB
  - ROUTE
```
public static final short ROUTE
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB used for routing
  - TDOM_TRAN
```
public static final short TDOM_TRAN
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A tdomains transaction TCB
  - TEST_TCM
```
public static final short TEST_TCM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB reserved for test purposes
  - PKCS7_TCM
```
public static final short PKCS7_TCM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB that contains PKCS7 information
  - QS_TCM
```
public static final short QS_TCM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB for queuing
  - PROP_TCM
```
public static final short PROP_TCM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A properties TCB
  - AAA_TCM
```
public static final short AAA_TCM
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB containing security credentials
  - CALLOUT
```
public static final short CALLOUT
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    A TCB For callouts
  - TDOM_VALS
```
public static final short TDOM_VALS
```
    See Also:
    
    Constant Field Values
  - CODESET_TCM
```
public static final short CODESET_TCM
```
    See Also:
    
    Constant Field Values
  - META_TCM
```
public static final short META_TCM
```
    See Also:
    
    Constant Field Values
  - MAXDEF_TCM
```
public static final short MAXDEF_TCM
```
    See Also:
    
    Constant Field Values
  - USER_STRING
```
private static final java.lang.String USER_STRING
```
    See Also:
    
    Constant Field Values
  - TM_STRING
```
private static final java.lang.String TM_STRING
```
    See Also:
    
    Constant Field Values
  - TRAN_STRING
```
private static final java.lang.String TRAN_STRING
```
    See Also:
    
    Constant Field Values
  - WS_STRING
```
private static final java.lang.String WS_STRING
```
    See Also:
    
    Constant Field Values
  - UNSOL_STRING
```
private static final java.lang.String UNSOL_STRING
```
    See Also:
    
    Constant Field Values
  - COMPOS_HDR_STRING
```
private static final java.lang.String COMPOS_HDR_STRING
```
    See Also:
    
    Constant Field Values
  - COMPOS_FML_STRING
```
private static final java.lang.String COMPOS_FML_STRING
```
    See Also:
    
    Constant Field Values
  - TDOM_STRING
```
private static final java.lang.String TDOM_STRING
```
    See Also:
    
    Constant Field Values
  - TDOM_SEC_STRING
```
private static final java.lang.String TDOM_SEC_STRING
```
    See Also:
    
    Constant Field Values
  - ROUTE_STRING
```
private static final java.lang.String ROUTE_STRING
```
    See Also:
    
    Constant Field Values
  - TDOM_TRAN_STRING
```
private static final java.lang.String TDOM_TRAN_STRING
```
    See Also:
    
    Constant Field Values
  - TEST_TCM_STRING
```
private static final java.lang.String TEST_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - PKCS7_TCM_STRING
```
private static final java.lang.String PKCS7_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - QS_TCM_STRING
```
private static final java.lang.String QS_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - PROP_TCM_STRING
```
private static final java.lang.String PROP_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - AAA_TCM_STRING
```
private static final java.lang.String AAA_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - CALLOUT_STRING
```
private static final java.lang.String CALLOUT_STRING
```
    See Also:
    
    Constant Field Values
  - TDOM_VALS_STRING
```
private static final java.lang.String TDOM_VALS_STRING
```
    See Also:
    
    Constant Field Values
  - CODESET_TCM_STRING
```
private static final java.lang.String CODESET_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - META_TCM_STRING
```
private static final java.lang.String META_TCM_STRING
```
    See Also:
    
    Constant Field Values
  - MAXDEF_TCM_STRING
```
private static final java.lang.String MAXDEF_TCM_STRING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - tcb
```
public tcb(short type)
```
- Method Detail
  - getType
```
public short getType()
```
  - prepareForCache
```
abstract boolean prepareForCache()
```
    Returns:
    
    true if the TCB can be used in a cache
    
    Excluded in public API Reference.
    
    This function prepares the TCB to be used as as a read cache. The internal state of the TCB should be set such that it can be read into. If the TCB is such that it cannot be cached, or caching of the TCB failed this routing should return false.
  - _tmpresend
```
abstract void _tmpresend(java.io.DataOutputStream encoder,
                         tch myheader)
                  throws TPException,
                         java.io.IOException
```
    Parameters:
    
    encoder - The stream object to use to encode this TCB
    
    Throws:
    
    TPException - If there was a Tuxedo error while encoding
    
    java.io.IOException - if there was an error using the encoder
    
    Excluded in public API Reference.
    
    This function presends and encodes the given TCB
  - _tmpostrecv
```
abstract int _tmpostrecv(java.io.DataInputStream decoder,
                         int recv_size,
                         int hint_index)
                  throws java.io.IOException
```
    Parameters:
    
    decoder - The input stream pointing to the start of the TCB
    
    recv_size - The total size of this TCB, unpadded
    
    Returns:
    
    Throws:
    
    java.io.IOException - if there was an error reading the input stream
    0 Success
    -1 Fatal error - truly could not read the stream
    -2 Non-fatal error - was able to read the bytes, but the TCB is unknown
    
    Excluded in public API Reference.
    
    This function decodes the TCB, filling in the TCB object from the input stream. Note that this method should read at least recv_size bytes, and should also read the pad bytes, always reading a multiple of four bytes (i.e., this function will read 0, 1, 2 or 3 extra bytes)
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class tcb

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

type

USER

TM

TRAN

WS

UNSOL

COMPOS_HDR

COMPOS_FML

TDOM

TDOM_SEC

ROUTE

TDOM_TRAN

TEST_TCM

PKCS7_TCM

QS_TCM

PROP_TCM

AAA_TCM

CALLOUT

TDOM_VALS

CODESET_TCM

META_TCM

MAXDEF_TCM

USER_STRING

TM_STRING

TRAN_STRING

WS_STRING

UNSOL_STRING

COMPOS_HDR_STRING

COMPOS_FML_STRING

TDOM_STRING

TDOM_SEC_STRING

ROUTE_STRING

TDOM_TRAN_STRING

TEST_TCM_STRING

PKCS7_TCM_STRING

QS_TCM_STRING

PROP_TCM_STRING

AAA_TCM_STRING

CALLOUT_STRING

TDOM_VALS_STRING

CODESET_TCM_STRING

META_TCM_STRING

MAXDEF_TCM_STRING

Constructor Detail

tcb

Method Detail

getType

prepareForCache

_tmpresend

_tmpostrecv

toString