TPM_HANDLE (TSS.Java 0.2.0 API)

java.lang.Object
- tss.TpmStructure
- - tss.tpm.TPM_HANDLE

All Implemented Interfaces:

TpmMarshaller
```
public class TPM_HANDLE
extends TpmStructure
```
TPM object handle (and related data)

Field Summary

Fields
Modifier and Type	Field and Description
`byte[]`	`AuthValue` Authorization value associated with this handle object.
`int`	`handle` TPM entity handle represented by this object.
`byte[]`	`Name` Name of the TPM entity represented by this handle object.
`static TPM_HANDLE`	`NULL` Represents TPM_RH.NULL handle constant

Constructor Summary

Constructors
Constructor and Description

TPM_HANDLE()
TPM object handle (and related data)

TPM_HANDLE(int _handle)
TPM object handle (and related data)

Constructors
Constructor and Description
`TPM_HANDLE()` TPM object handle (and related data)
`TPM_HANDLE(int _handle)` TPM object handle (and related data)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TPM_HANDLE`	`from(int val)` Creates a TPM handle from an arbitrary int value
`static TPM_HANDLE`	`from(TPM_RH _handle)` Creates a TPM handle from a reserved handle constant
`static TPM_HANDLE`	`fromTpm(byte[] x)`
`static TPM_HANDLE`	`fromTpm(InByteBuf buf)`
`byte[]`	`getName()` Gets the TPM-name associated with this handle
`TPM_HT`	`getType()` Gets the handle type
`void`	`initFromTpm(InByteBuf buf)` Populate this object from the TPM representation in the input byte buffer object
`static TPM_HANDLE`	`NV(int NvSlot)` Creates a TPM_HANDLE for an NV slot
`static TPM_HANDLE`	`pcr(int PcrIndex)` Creates a TPM_HANDLE for a PCR
`static TPM_HANDLE`	`persistent(int handleOffset)` Creates a TPM_HANDLE from an offset into the reserved handle space
`static TPM_HANDLE`	`pwSession(byte[] authValue)` Creates a password session handle with the associated authorization value
`String`	`toString()`
`void`	`toStringInternal(TpmStructurePrinter _p, int d)` Serialize this object to the structure printer
`byte[]`	`toTpm()` Convert this object to its TPM representation and return it as a byte array
`void`	`toTpm(OutByteBuf buf)` Convert this object to its TPM representation and store in the output byte buffer object

Methods inherited from class tss.TpmStructure
equals, hashCode

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

- Field Detail
  - NULL
```
public static final TPM_HANDLE NULL
```
    Represents TPM_RH.NULL handle constant
  - handle
```
public int handle
```
    TPM entity handle represented by this object.
  - AuthValue
```
public byte[] AuthValue
```
    Authorization value associated with this handle object. NOTE: It is tracked by the framework whenever possible but in some cases may be left uninitialized.
  - Name
```
public byte[] Name
```
    Name of the TPM entity represented by this handle object. NOTE: It is tracked by the framework whenever possible but in some cases may be left uninitialized.
- Constructor Detail
  - TPM_HANDLE
```
public TPM_HANDLE(int _handle)
```
    TPM object handle (and related data)
    
    Parameters:
    
    _handle - TPM key handle
  - TPM_HANDLE
```
public TPM_HANDLE()
```
    TPM object handle (and related data)
- Method Detail
  - toTpm
```
public void toTpm(OutByteBuf buf)
```
    Description copied from interface: TpmMarshaller
    
    Convert this object to its TPM representation and store in the output byte buffer object
    
    Parameters:
    
    buf - An output byte buffer
  - initFromTpm
```
public void initFromTpm(InByteBuf buf)
```
    Description copied from interface: TpmMarshaller
    
    Populate this object from the TPM representation in the input byte buffer object
    
    Parameters:
    
    buf - An input byte buffer
  - toTpm
```
public byte[] toTpm()
```
    Description copied from interface: TpmMarshaller
    
    Convert this object to its TPM representation and return it as a byte array
    
    Returns:
    
    Byte buffer with the TPM 2.0 compatible wire representation of the object
  - fromTpm
```
public static TPM_HANDLE fromTpm(byte[] x)
```
  - fromTpm
```
public static TPM_HANDLE fromTpm(InByteBuf buf)
```
  - from
```
public static TPM_HANDLE from(int val)
```
    Creates a TPM handle from an arbitrary int value
    
    Parameters:
    
    val - An int value to be used as a TPM handle
    
    Returns:
    
    New TPM_HANDLE object
  - from
```
public static TPM_HANDLE from(TPM_RH _handle)
```
    Creates a TPM handle from a reserved handle constant
    
    Parameters:
    
    _handle - The reserved handle constant
    
    Returns:
    
    New TPM_HANDLE object
  - persistent
```
public static TPM_HANDLE persistent(int handleOffset)
```
    Creates a TPM_HANDLE from an offset into the reserved handle space
    
    Parameters:
    
    handleOffset - The reserved handle offset
    
    Returns:
    
    The new TPM_HANDLE
  - pcr
```
public static TPM_HANDLE pcr(int PcrIndex)
```
    Creates a TPM_HANDLE for a PCR
    
    Parameters:
    
    PcrIndex - The PCR index
    
    Returns:
    
    The new TPM_HANDLE
  - getType
```
public TPM_HT getType()
```
    Gets the handle type
    
    Returns:
    
    The handle type
  - NV
```
public static TPM_HANDLE NV(int NvSlot)
```
    Creates a TPM_HANDLE for an NV slot
    
    Parameters:
    
    NvSlot - The NV index
    
    Returns:
    
    The new TPM_HANDLE
  - pwSession
```
public static TPM_HANDLE pwSession(byte[] authValue)
```
    Creates a password session handle with the associated authorization value
    
    Parameters:
    
    authValue - The authorization value
    
    Returns:
    
    The new TPM_HANDLE
  - getName
```
public byte[] getName()
```
    Gets the TPM-name associated with this handle
    
    Returns:
    
    The name
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringInternal
```
public void toStringInternal(TpmStructurePrinter _p,
                             int d)
```
    Description copied from class: TpmStructure
    
    Serialize this object to the structure printer
    
    Specified by:
    
    toStringInternal in class TpmStructure
    
    Parameters:
    
    _p - The structure accumulator
    
    d - The data to serialize

Class TPM_HANDLE

Field Summary

Constructor Summary

Method Summary

Methods inherited from class tss.TpmStructure

Methods inherited from class java.lang.Object

Field Detail

NULL

handle

AuthValue

Name

Constructor Detail

TPM_HANDLE

TPM_HANDLE

Method Detail

toTpm

initFromTpm

toTpm

fromTpm

fromTpm

from

from

persistent

pcr

getType

NV

pwSession

getName

toString

toStringInternal