tfmh (Java API Reference for Oracle WebLogic Server)

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

All Implemented Interfaces:

java.io.Serializable
```
public final class tfmh
extends java.lang.Object
implements java.io.Serializable
```
See Also:

Serialized Form

Excluded in public API Reference.

This class represents a complete Tuxedo Flexible Message Header, in other words, a complete Tuxedo style message.

Field Summary

Fields
Modifier and Type	Field and Description
`tcm`	`AAA`
`private tcm`	`AAA_cache`
`tcm`	`callout`
`protected byte[]`	`challenge`
`private byte[]`	`challenge_rp`
`static int`	`CHLG_LEN`
`tcm`	`codeset`
`tcm`	`compos_fml`
`private tcm`	`compos_fml_cache`
`tcm`	`compos_hdr`
`private tcm`	`compos_hdr_cache`
`private byte[]`	`dom65_fillin`
`private boolean`	`dumpUData`
`protected static int`	`FMH_EDIT`
`protected static int`	`FMH_IN_USE`
`protected static int`	`FMH_NO_USER`
`protected static int`	`FMH_STORAGE`
`private boolean`	`isThisWS`
`private int`	`ltype_idx`
`private int`	`magic`
`static int`	`MAXDOMAIN_LEN`
`protected static int`	`MAXMTYPELEN`
`protected static int`	`MAXTSTRING`
`tcm`	`meta`
`private tcm`	`meta_cache`
`private metahdr`	`mhdr`
`private java.io.DataOutputStream`	`myEncoder`
`private byte[]`	`myScratch`
`private TuxedoArrayOutputStream`	`myWriteStream`
`tcm`	`route`
`private tcm`	`route_cache`
`private static long`	`serialVersionUID`
`private tch`	`tch_cache`
`tcm`	`tdom`
`private tcm`	`tdom_cache`
`tcm`	`tdom_vals`
`tcm`	`tdomtran`
`private tcm`	`tdomtran_cache`
`private tcm`	`tdomvals_cache`
`static int`	`TFMH_DOM_TYPE`
`protected static int`	`TFMH_SIZE`
`static int`	`TFMH_WS_TYPE`
`static int`	`TM_MAGIC`
`static int`	`TM_SMAGIC`
`private int`	`tmfmh_flag`
`static int`	`TMSEC_KEYLEN`
`static int`	`TMSEC_TICKETLEN`
`protected static int`	`TMSTYPELEN`
`protected static int`	`TMTYPELEN`
`tcm`	`tran`
`private tcm`	`tran_cache`
`private int`	`tstamp`
`tcm`	`unsol`
`private tcm`	`unsol_cache`
`private boolean`	`use64BitsLong`
`tcm`	`user`
`private int`	`userDataSize`
`tcm`	`ws`
`private tcm`	`ws_cache`
`private byte[]`	`ws65_challenge`
`private byte[]`	`ws65_session_key`
`private byte[]`	`ws65_ticket`
`private int`	`wsh_protocol`
`protected static int`	`WSMAXNETADDR`

Constructor Summary

Constructors
Constructor and Description

tfmh()

tfmh(int type)

tfmh(int ltype_idx, tcm udata)

tfmh(int ltype_idx, tcm udata, int type)

Constructors
Constructor and Description
`tfmh()`
`tfmh(int type)`
`tfmh(int ltype_idx, tcm udata)`
`tfmh(int ltype_idx, tcm udata, int type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private int`	`calDom65Acall1()`
`private int`	`calDom65Acall1Rply()`
`private int`	`calDom65LLE()`
`private int`	`calDom65LLERply()`
`void`	`dumpUData(boolean b)`
`boolean`	`equals(java.lang.Object obj)`
`byte[]`	`get_challenge_rp()`
`byte[]`	`get_ws_challenge()`
`byte[]`	`get_ws65_session_key()`
`byte[]`	`get_ws65_ticket()`
`metahdr`	`getMetahdr()`
`int`	`getProtocol()`
`int`	`getUserDataSize()`
`int`	`hashCode()`
`boolean`	`prepareForCache()` /**
`int`	`read_challenge(java.lang.String passwd)`
`int`	`read_dom_65_tfmh(java.io.DataInputStream decoder, int protocol)`
`int`	`read_tfmh(java.io.DataInputStream decoder)`
`int`	`read_ws_65_tfmh(java.io.DataInputStream decoder, boolean estcon_65)`
`private boolean`	`recvDom65Acall1(java.io.DataInputStream decoder, TdomTcb msg)`
`private boolean`	`recvDom65Acall1Rply(java.io.DataInputStream decoder, TdomTcb msg)`
`private boolean`	`recvDom65LLE(java.io.DataInputStream decoder, TdomTcb msg)`
`private boolean`	`recvDom65LLERply(java.io.DataInputStream decoder, TdomTcb msg)`
`private void`	`resetWrite()`
`private boolean`	`sendDom65Acall1(java.io.DataOutputStream encoder, TdomTcb msg)`
`private boolean`	`sendDom65Acall1Rply(java.io.DataOutputStream encoder, TdomTcb msg)`
`private boolean`	`sendDom65LLE(java.io.DataOutputStream encoder, TdomTcb msg)`
`private boolean`	`sendDom65LLERply(java.io.DataOutputStream encoder, TdomTcb msg)`
`void`	`set_timestamp(int timestamp)`
`void`	`set_TPENQUEUE(boolean to_enqueue)`
`void`	`set_ws65_session_key(byte[] session_key)`
`void`	`set_ws65_ticket(byte[] ticket)`
`void`	`setTMREPLY(boolean reply)`
`private int`	`write_challenge_val(java.io.DataOutputStream encoder, java.lang.String password)`
`int`	`write_dom_65_tfmh(java.io.DataOutputStream encoder, java.lang.String sending_dom, int protocol, int cmplimit)`
`int`	`write_tfmh(java.io.DataOutputStream encoder, int cmplimit)`
`int`	`write_ws_65_tfmh(java.io.DataOutputStream encoder, int cmplimit, int authlev, TPINIT tpinfo)`

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

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - mhdr
```
private metahdr mhdr
```
  - magic
```
private int magic
```
  - ltype_idx
```
private int ltype_idx
```
  - tmfmh_flag
```
private int tmfmh_flag
```
  - isThisWS
```
private boolean isThisWS
```
  - wsh_protocol
```
private int wsh_protocol
```
  - ws65_challenge
```
private byte[] ws65_challenge
```
  - challenge_rp
```
private byte[] challenge_rp
```
  - ws65_ticket
```
private byte[] ws65_ticket
```
  - ws65_session_key
```
private byte[] ws65_session_key
```
  - challenge
```
protected byte[] challenge
```
  - tstamp
```
private int tstamp
```
  - user
```
public tcm user
```
    Excluded in public API Reference.
    
    The user tcm of this message
  - ws
```
public tcm ws
```
    Excluded in public API Reference.
    
    The ws tcm of this message
  - tran
```
public tcm tran
```
    Excluded in public API Reference.
    
    The tuxedo transaction tcm of this message
  - unsol
```
public tcm unsol
```
    Excluded in public API Reference.
    
    The unsolicited message tcm of this message
  - compos_hdr
```
public tcm compos_hdr
```
    Excluded in public API Reference.
    
    The composite header tcm of this message
  - compos_fml
```
public tcm compos_fml
```
    Excluded in public API Reference.
    
    The composite fml tcm of this message
  - tdom
```
public tcm tdom
```
    Excluded in public API Reference.
    
    The /T domain tcm of this message
  - tdomtran
```
public tcm tdomtran
```
    Excluded in public API Reference.
    
    The /T domain transaction tcm of this message
  - route
```
public tcm route
```
    Excluded in public API Reference.
    
    The CORBA routing tcm of this message
  - tdom_vals
```
public tcm tdom_vals
```
    Excluded in public API Reference.
    
    The inter-domain CORBA routing tcm of this message
  - callout
```
public tcm callout
```
    Excluded in public API Reference.
    
    The CORBA Callout tcm of this message
  - AAA
```
public tcm AAA
```
    Excluded in public API Reference.
    
    The AAA security token
  - meta
```
public tcm meta
```
    Excluded in public API Reference.
    
    The meta tcm of this message
  - codeset
```
public tcm codeset
```
    Excluded in public API Reference.
    
    The codeset name for MBSTRING
  - ws_cache
```
private transient tcm ws_cache
```
  - tran_cache
```
private transient tcm tran_cache
```
  - unsol_cache
```
private transient tcm unsol_cache
```
  - compos_hdr_cache
```
private transient tcm compos_hdr_cache
```
  - compos_fml_cache
```
private transient tcm compos_fml_cache
```
  - tdom_cache
```
private transient tcm tdom_cache
```
  - tdomtran_cache
```
private transient tcm tdomtran_cache
```
  - tdomvals_cache
```
private transient tcm tdomvals_cache
```
  - route_cache
```
private transient tcm route_cache
```
  - AAA_cache
```
private transient tcm AAA_cache
```
  - meta_cache
```
private transient tcm meta_cache
```
  - tch_cache
```
private transient tch tch_cache
```
  - dom65_fillin
```
private transient byte[] dom65_fillin
```
  - myWriteStream
```
private transient TuxedoArrayOutputStream myWriteStream
```
  - myEncoder
```
private transient java.io.DataOutputStream myEncoder
```
  - myScratch
```
private transient byte[] myScratch
```
  - dumpUData
```
private boolean dumpUData
```
  - userDataSize
```
private int userDataSize
```
  - use64BitsLong
```
private boolean use64BitsLong
```
  - TFMH_SIZE
```
protected static final int TFMH_SIZE
```
    See Also:
    
    Constant Field Values
    
    Excluded in public API Reference.
    
    Now my protected values
  - TM_MAGIC
```
public static final int TM_MAGIC
```
    See Also:
    
    Constant Field Values
  - TM_SMAGIC
```
public static final int TM_SMAGIC
```
    See Also:
    
    Constant Field Values
  - FMH_IN_USE
```
protected static final int FMH_IN_USE
```
    See Also:
    
    Constant Field Values
  - FMH_EDIT
```
protected static final int FMH_EDIT
```
    See Also:
    
    Constant Field Values
  - FMH_STORAGE
```
protected static final int FMH_STORAGE
```
    See Also:
    
    Constant Field Values
  - FMH_NO_USER
```
protected static final int FMH_NO_USER
```
    See Also:
    
    Constant Field Values
  - TFMH_WS_TYPE
```
public static final int TFMH_WS_TYPE
```
    See Also:
    
    Constant Field Values
  - TFMH_DOM_TYPE
```
public static final int TFMH_DOM_TYPE
```
    See Also:
    
    Constant Field Values
  - TMTYPELEN
```
protected static final int TMTYPELEN
```
    See Also:
    
    Constant Field Values
  - TMSTYPELEN
```
protected static final int TMSTYPELEN
```
    See Also:
    
    Constant Field Values
  - MAXTSTRING
```
protected static final int MAXTSTRING
```
    See Also:
    
    Constant Field Values
  - WSMAXNETADDR
```
protected static final int WSMAXNETADDR
```
    See Also:
    
    Constant Field Values
  - MAXMTYPELEN
```
protected static final int MAXMTYPELEN
```
    See Also:
    
    Constant Field Values
  - TMSEC_TICKETLEN
```
public static final int TMSEC_TICKETLEN
```
    See Also:
    
    Constant Field Values
  - TMSEC_KEYLEN
```
public static final int TMSEC_KEYLEN
```
    See Also:
    
    Constant Field Values
  - MAXDOMAIN_LEN
```
public static final int MAXDOMAIN_LEN
```
    See Also:
    
    Constant Field Values
  - CHLG_LEN
```
public static final int CHLG_LEN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - tfmh
```
public tfmh()
```
    Parameters:
    
    cl - The compression threshold for this message
    
    Excluded in public API Reference.
    
    Creates a new workstation tfmh message with no user data
  - tfmh
```
public tfmh(int type)
```
    Parameters:
    
    cl - The compression threshold for this message
    type -
    
    TFMH_WS_TYPE This is a workstation message
    TFMH_DOM_TYPE This is a domain message
    Excluded in public API Reference.
    
    Creates a new tfmh message with no user data
  - tfmh
```
public tfmh(int ltype_idx,
            tcm udata)
```
    Parameters:
    
    ltype_idx - The ltypeidx of this message type
    
    udata - The user data tcm
    
    cl - The compression threshold for this message
    
    Excluded in public API Reference.
    
    Creates a new workstation tfmh message with user data
  - tfmh
```
public tfmh(int ltype_idx,
            tcm udata,
            int type)
```
    Parameters:
    
    ltype_idx - The ltypeidx of this message type
    
    udata - The user data tcm
    type -
    
    TFMH_WS_TYPE This is a workstation message
    TFMH_DOM_TYPE This is a domain message
    Excluded in public API Reference.
    
    Creates a new tfmh message with user data
- Method Detail
  - get_ws_challenge
```
public byte[] get_ws_challenge()
```
  - get_challenge_rp
```
public byte[] get_challenge_rp()
```
  - get_ws65_ticket
```
public byte[] get_ws65_ticket()
```
  - get_ws65_session_key
```
public byte[] get_ws65_session_key()
```
  - set_ws65_ticket
```
public void set_ws65_ticket(byte[] ticket)
```
  - set_ws65_session_key
```
public void set_ws65_session_key(byte[] session_key)
```
  - set_timestamp
```
public void set_timestamp(int timestamp)
```
  - getUserDataSize
```
public int getUserDataSize()
```
    Excluded in public API Reference.
  - prepareForCache
```
public boolean prepareForCache()
```
    /**
    
    Returns:
    
    true if the tfmh was successfully prepared for a cache, false otherwise
    
    Excluded in public API Reference.
    
    prepares this tfmh to be used in a read cache. It should set the state of the tfmh back to the null-constructor case
  - setTMREPLY
```
public void setTMREPLY(boolean reply)
```
    Parameters:
    
    reply - true if this is a reply
    
    Excluded in public API Reference.
    
    This function marks this tfmh as a reply message
  - set_TPENQUEUE
```
public void set_TPENQUEUE(boolean to_enqueue)
```
    Parameters:
    
    to_enqueue - if true this message will be used for tpenqueue, if false, this message will not be used for tpenqueue
    
    Excluded in public API Reference.
    
    This function sets this message as a tpenqueue message. There is a special bit set in the messages metaheader on enqueue.
  - getMetahdr
```
public metahdr getMetahdr()
```
    Excluded in public API Reference.
    
    Gets the metahdr associated with this message
  - getProtocol
```
public int getProtocol()
```
    Excluded in public API Reference.
    
    Gets the protocol associated with this message
  - resetWrite
```
private void resetWrite()
```
    Excluded in public API Reference.
    
    Resets this tfmh to be used again for writing.
  - write_tfmh
```
public int write_tfmh(java.io.DataOutputStream encoder,
                      int cmplimit)
               throws java.io.IOException
```
    Parameters:
    
    encoder - The output stream to which the message should be written
    
    Returns:
    0 - Success
    -1 - Failure
    Throws:
    
    java.io.IOException
    
    Excluded in public API Reference.
    
    write_tfmh Writes the given message (without interpretation) to the data output stream. It will compress the message first if the size of the message is larger than the compression threshold.
  - write_dom_65_tfmh
```
public int write_dom_65_tfmh(java.io.DataOutputStream encoder,
                             java.lang.String sending_dom,
                             int protocol,
                             int cmplimit)
                      throws java.io.IOException
```
    Parameters:
    
    encoder - The output stream to which the message should be written
    
    sending_dom - The name of the sending domain (i.e., me)
    
    protocol - The protocol number to speak. Must be metahdr.DOM65PROTOCOL or lower
    
    cmplimit - The compression threshold
    
    Returns:
    0 - Success
    -1 - Failure
    Throws:
    
    java.io.IOException - if there is an error writing to the output stream
    
    Excluded in public API Reference.
    
    write_dom_65_tfmh Writes this message, but in domains 6.5 protocol format. Should be used when the upper layer has determined that the protocol for the remote domain is release 6.5
  - read_tfmh
```
public int read_tfmh(java.io.DataInputStream decoder)
              throws java.io.IOException
```
    Parameters:
    
    decoder - The object to read the tfmh message from
    
    Returns:
    0 Success
    -1 Failure
    -2 This tfmh is malformed in some way, but the stream is still OK
    Throws:
    
    java.io.IOException - if there was an error reading the input stream
    
    Excluded in public API Reference.
    
    This function reads a tfmh buffer from the decoder object. This function blocks until an entire tfmh buffer has been read from the stream.
  - read_dom_65_tfmh
```
public int read_dom_65_tfmh(java.io.DataInputStream decoder,
                            int protocol)
                     throws java.io.IOException
```
    Parameters:
    
    decoder - The object to read the tfmh message from
    
    protocol - The protocol number to speak. Must be metahdr.DOM65PROTOCOL or lower
    
    Returns:
    0 Success
    -1 Failure
    Throws:
    
    java.io.IOException - if there was an error reading the input stream
    
    Excluded in public API Reference.
    
    This function reads a tfmh buffer from the decoder object. However, this version of the function reads domains 6.5 protocol, converting it into a tfmh object. blocks until an entire tfmh buffer has been read from the stream.
  - calDom65Acall1
```
private int calDom65Acall1()
```
  - calDom65Acall1Rply
```
private int calDom65Acall1Rply()
```
  - calDom65LLE
```
private int calDom65LLE()
```
  - calDom65LLERply
```
private int calDom65LLERply()
```
  - sendDom65Acall1
```
private boolean sendDom65Acall1(java.io.DataOutputStream encoder,
                                TdomTcb msg)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - sendDom65Acall1Rply
```
private boolean sendDom65Acall1Rply(java.io.DataOutputStream encoder,
                                    TdomTcb msg)
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - sendDom65LLE
```
private boolean sendDom65LLE(java.io.DataOutputStream encoder,
                             TdomTcb msg)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - sendDom65LLERply
```
private boolean sendDom65LLERply(java.io.DataOutputStream encoder,
                                 TdomTcb msg)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - recvDom65Acall1
```
private boolean recvDom65Acall1(java.io.DataInputStream decoder,
                                TdomTcb msg)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - recvDom65Acall1Rply
```
private boolean recvDom65Acall1Rply(java.io.DataInputStream decoder,
                                    TdomTcb msg)
                             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - recvDom65LLE
```
private boolean recvDom65LLE(java.io.DataInputStream decoder,
                             TdomTcb msg)
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - recvDom65LLERply
```
private boolean recvDom65LLERply(java.io.DataInputStream decoder,
                                 TdomTcb msg)
                          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - read_ws_65_tfmh
```
public int read_ws_65_tfmh(java.io.DataInputStream decoder,
                           boolean estcon_65)
                    throws java.io.IOException
```
    Parameters:
    
    decoder - The object to read the tfmh message from
    
    Returns:
    0 Success
    -1 Failure
    -2 This tfmh is malformed in some way, but the stream is still OK
    Throws:
    
    java.io.IOException - if there was an error reading the input stream
    
    Excluded in public API Reference.
    
    This function reads a tfmh buffer from the decoder object. This function blocks until an entire tfmh buffer has been read from the stream.
  - write_ws_65_tfmh
```
public int write_ws_65_tfmh(java.io.DataOutputStream encoder,
                            int cmplimit,
                            int authlev,
                            TPINIT tpinfo)
                     throws java.io.IOException
```
    Parameters:
    
    encoder - The output stream to which the message should be written
    
    Returns:
    0 - Success
    -1 - Failure
    Throws:
    
    java.io.IOException
    
    Excluded in public API Reference.
    
    write_ws_65_tfmh Writes the given message (without interpretation) to the data output stream. It will compress the message first if the size of the message is larger than the compression threshold.
  - write_challenge_val
```
private int write_challenge_val(java.io.DataOutputStream encoder,
                                java.lang.String password)
```
  - read_challenge
```
public int read_challenge(java.lang.String passwd)
```
  - dumpUData
```
public void dumpUData(boolean b)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class tfmh

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

mhdr

magic

ltype_idx

tmfmh_flag

isThisWS

wsh_protocol

ws65_challenge

challenge_rp

ws65_ticket

ws65_session_key

challenge

tstamp

user

ws

tran

unsol

compos_hdr

compos_fml

tdom

tdomtran

route

tdom_vals

callout

AAA

meta

codeset

ws_cache

tran_cache

unsol_cache

compos_hdr_cache

compos_fml_cache

tdom_cache

tdomtran_cache

tdomvals_cache

route_cache

AAA_cache

meta_cache

tch_cache

dom65_fillin

myWriteStream

myEncoder

myScratch

dumpUData

userDataSize

use64BitsLong

TFMH_SIZE

TM_MAGIC

TM_SMAGIC

FMH_IN_USE

FMH_EDIT

FMH_STORAGE

FMH_NO_USER

TFMH_WS_TYPE

TFMH_DOM_TYPE

TMTYPELEN

TMSTYPELEN

MAXTSTRING

WSMAXNETADDR

MAXMTYPELEN

TMSEC_TICKETLEN

TMSEC_KEYLEN

MAXDOMAIN_LEN

CHLG_LEN

Constructor Detail

tfmh

tfmh

tfmh

tfmh

Method Detail

get_ws_challenge

get_challenge_rp

get_ws65_ticket

get_ws65_session_key