AaaTcb (Java API Reference for Oracle WebLogic Server)

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

All Implemented Interfaces:

java.io.Serializable
```
public final class AaaTcb
extends tcb
```
See Also:

Serialized Form

Excluded in public API Reference.

This class represents the Authentication, Authorization and Auditing TCB.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) byte[]`	`Aaa`
`static int`	`AAA_MAJOR_VERSION`
`static int`	`AAA_MINOR_VERSION`
`static int`	`ATZ`
`private int`	`atz_appkey`
`private java.lang.String`	`atz_group`
`private java.lang.String`	`atz_name`
`private java.lang.String`	`atz_provider`
`private byte[]`	`atz_token`
`static int`	`AUD`
`private int`	`aud_appkey`
`private java.lang.String`	`aud_group`
`private java.lang.String`	`aud_name`
`private java.lang.String`	`aud_provider`
`private byte[]`	`aud_token`
`static int`	`TOKENVERSION71`
`static int`	`TOKENVERSION80`
`static int[]`	`tuxnat_mech_objid`

Fields inherited from class weblogic.wtc.jatmi.tcb
AAA_TCM, CALLOUT, CODESET_TCM, COMPOS_FML, COMPOS_HDR, MAXDEF_TCM, META_TCM, PKCS7_TCM, PROP_TCM, QS_TCM, ROUTE, TDOM, TDOM_SEC, TDOM_TRAN, TDOM_VALS, TEST_TCM, TM, TRAN, type, UNSOL, USER, WS

Constructor Summary

Constructors
Constructor and Description

AaaTcb()

Constructors
Constructor and Description
`AaaTcb()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`_tmpostrecv(java.io.DataInputStream decoder, int recv_size, int hint_index)`
`void`	`_tmpresend(java.io.DataOutputStream encoder, tch myheader)`
`int`	`decodeATZ(byte[] buf, int offset)`
`int`	`decodeAUD(byte[] buf, int offset)`
`int`	`encodeATZ(byte[] buf, int offset)`
`int`	`encodeAUD(byte[] buf, int offset)`
`int`	`getATZAppKey()`
`java.lang.String`	`getATZGroupName()`
`java.lang.String`	`getATZProvider()`
`java.lang.String`	`getATZUserName()`
`int`	`getAUDAppKey()`
`java.lang.String`	`getAUDGroupName()`
`java.lang.String`	`getAUDProvider()`
`java.lang.String`	`getAUDUserName()`
`boolean`	`prepareForCache()`
`void`	`setATZAppKey(int key)`
`void`	`setATZGroupName(java.lang.String grp)`
`void`	`setATZProvider(java.lang.String prov)`
`void`	`setATZUserName(java.lang.String usr)`
`void`	`setAUDAppKey(int key)`
`void`	`setAUDGroupName(java.lang.String grp)`
`void`	`setAUDProvider(java.lang.String prov)`
`void`	`setAUDUserName(java.lang.String usr)`

Methods inherited from class weblogic.wtc.jatmi.tcb
getType, toString

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

- Field Detail
  - Aaa
```
byte[] Aaa
```
  - atz_appkey
```
private int atz_appkey
```
  - aud_appkey
```
private int aud_appkey
```
  - atz_token
```
private byte[] atz_token
```
  - aud_token
```
private byte[] aud_token
```
  - atz_name
```
private java.lang.String atz_name
```
  - atz_group
```
private java.lang.String atz_group
```
  - aud_name
```
private java.lang.String aud_name
```
  - aud_group
```
private java.lang.String aud_group
```
  - atz_provider
```
private java.lang.String atz_provider
```
  - aud_provider
```
private java.lang.String aud_provider
```
  - ATZ
```
public static final int ATZ
```
    See Also:
    
    Constant Field Values
  - AUD
```
public static final int AUD
```
    See Also:
    
    Constant Field Values
  - TOKENVERSION80
```
public static final int TOKENVERSION80
```
    See Also:
    
    Constant Field Values
  - TOKENVERSION71
```
public static final int TOKENVERSION71
```
    See Also:
    
    Constant Field Values
  - AAA_MINOR_VERSION
```
public static final int AAA_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - AAA_MAJOR_VERSION
```
public static final int AAA_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - tuxnat_mech_objid
```
public static final int[] tuxnat_mech_objid
```
- Constructor Detail
  - AaaTcb
```
public AaaTcb()
```
- Method Detail
  - prepareForCache
```
public boolean prepareForCache()
```
    Specified by:
    
    prepareForCache in class tcb
    
    Returns:
    
    true if the TCB can be used in a cache
    
    Excluded in public API Reference.
    
    The user TCB cannot be cached, so this always returns false
  - _tmpresend
```
public void _tmpresend(java.io.DataOutputStream encoder,
                       tch myheader)
                throws TPException,
                       java.io.IOException
```
    Specified by:
    
    _tmpresend in class tcb
    
    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 UserTcb
  - _tmpostrecv
```
public final int _tmpostrecv(java.io.DataInputStream decoder,
                             int recv_size,
                             int hint_index)
                      throws java.io.IOException
```
    Specified by:
    
    _tmpostrecv in class tcb
    
    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
  - setATZUserName
```
public void setATZUserName(java.lang.String usr)
```
    Parameters:
    
    usr - The name of the user.
    
    Excluded in public API Reference.
    
    Set the ATZ user name.
  - getATZUserName
```
public java.lang.String getATZUserName()
```
    Returns:
    
    user name
    
    Excluded in public API Reference.
    
    Get the ATZ user name. This information is retrieved from input AAA TCM.
  - setATZGroupName
```
public void setATZGroupName(java.lang.String grp)
```
    Parameters:
    
    grp - The group name.
    
    Excluded in public API Reference.
    
    Set the ATZ Group Name, this information will be used to build AAA TCM.
  - getATZGroupName
```
public java.lang.String getATZGroupName()
```
    Returns:
    
    the ATZ group name.
    
    Excluded in public API Reference.
    
    Get the ATZ group name. The information is retrieved from the receiving AAA TCM.
  - setATZProvider
```
public void setATZProvider(java.lang.String prov)
```
    Parameters:
    
    prov - The Provider name.
    
    Excluded in public API Reference.
    
    Set the ATZ Provider Name, this information will be used to build AAA TCM.
  - getATZProvider
```
public java.lang.String getATZProvider()
```
    Returns:
    
    the ATZ provider name.
    
    Excluded in public API Reference.
    
    Get the ATZ provider name. The information is retrieved from the receiving AAA TCM.
  - setATZAppKey
```
public void setATZAppKey(int key)
```
    Parameters:
    
    key - The user appkey.
    
    Excluded in public API Reference.
    
    Set the ATZ user appkey, this information will be used to build AAA TCM.
  - getATZAppKey
```
public int getATZAppKey()
```
    Returns:
    
    the ATZ user appkey.
    
    Excluded in public API Reference.
    
    Get the ATZ appkey name. The information is retrieved from the receiving AAA TCM.
  - setAUDUserName
```
public void setAUDUserName(java.lang.String usr)
```
    Parameters:
    
    usr - The user name.
    
    Excluded in public API Reference.
    
    Set the AUD user Name, this information will be used to build AAA TCM.
  - getAUDUserName
```
public java.lang.String getAUDUserName()
```
    Returns:
    
    the AUD user name.
    
    Excluded in public API Reference.
    
    Get the AUD user name. The information is retrieved from the receiving AAA TCM.
  - setAUDGroupName
```
public void setAUDGroupName(java.lang.String grp)
```
    Parameters:
    
    grp - The group name.
    
    Excluded in public API Reference.
    
    Set the AUD group Name, this information will be used to build AAA TCM.
  - getAUDGroupName
```
public java.lang.String getAUDGroupName()
```
    Returns:
    
    the AUD group name.
    
    Excluded in public API Reference.
    
    Get the AUD group name. The information is retrieved from the receiving AAA TCM.
  - setAUDProvider
```
public void setAUDProvider(java.lang.String prov)
```
    Parameters:
    
    prov - The provider name.
    
    Excluded in public API Reference.
    
    Set the AUD provider Name, this information will be used to build AAA TCM.
  - getAUDProvider
```
public java.lang.String getAUDProvider()
```
    Returns:
    
    the AUD provider name.
    
    Excluded in public API Reference.
    
    Get the AUD provider name. The information is retrieved from the receiving AAA TCM.
  - setAUDAppKey
```
public void setAUDAppKey(int key)
```
    Parameters:
    
    key - The user appkey.
    
    Excluded in public API Reference.
    
    Set the AUD user appkey, this information will be used to build AAA TCM.
  - getAUDAppKey
```
public int getAUDAppKey()
```
    Returns:
    
    the AUD user appkey.
    
    Excluded in public API Reference.
    
    Get the AUD user appkey. The information is retrieved from the receiving AAA TCM.
  - encodeATZ
```
public int encodeATZ(byte[] buf,
                     int offset)
```
    Parameters:
    
    buf - the Output buffer
    
    offset - The offset where the encoding should start
    
    Excluded in public API Reference.
    
    encode the ATZ CARRAY data buffer using existing information.
  - decodeATZ
```
public int decodeATZ(byte[] buf,
                     int offset)
```
    Returns:
    
    length of data being decoded in bytes, if error, then negative value
    
    Excluded in public API Reference.
    
    Decode a just received ATZ buffer.
  - encodeAUD
```
public int encodeAUD(byte[] buf,
                     int offset)
```
    Parameters:
    
    buf - The buffer to store the out put AUD CARRAY.
    
    offset - The offset in the return buffer where encoding should start at.
    
    Excluded in public API Reference.
    
    Encode an AUD CARRAY data buffer that will be used in creating AAA TCM.
  - decodeAUD
```
public int decodeAUD(byte[] buf,
                     int offset)
```
    Parameters:
    
    buf - The input buffer
    
    offset - The offset that the decoding should start at.
    
    Excluded in public API Reference.
    
    Decode the received AUD CARRAY buffer, and extract all the important information.

Class AaaTcb

Field Summary

Fields inherited from class weblogic.wtc.jatmi.tcb

Constructor Summary

Method Summary

Methods inherited from class weblogic.wtc.jatmi.tcb

Methods inherited from class java.lang.Object

Field Detail

Aaa

atz_appkey

aud_appkey

atz_token

aud_token

atz_name

atz_group

aud_name

aud_group

atz_provider

aud_provider

ATZ

AUD

TOKENVERSION80

TOKENVERSION71

AAA_MINOR_VERSION

AAA_MAJOR_VERSION

tuxnat_mech_objid

Constructor Detail

AaaTcb

Method Detail

prepareForCache

_tmpresend

_tmpostrecv

setATZUserName

getATZUserName

setATZGroupName

getATZGroupName

setATZProvider

getATZProvider

setATZAppKey

getATZAppKey

setAUDUserName

getAUDUserName

setAUDGroupName

getAUDGroupName

setAUDProvider

getAUDProvider

setAUDAppKey

getAUDAppKey

encodeATZ

decodeATZ

encodeAUD

decodeAUD