TPMA_SESSION._N (TSS.Java 0.2.0 API)

java.lang.Object
- java.lang.Enum<TPMA_SESSION._N>
- - tss.tpm.TPMA_SESSION._N

All Implemented Interfaces:

Serializable, Comparable<TPMA_SESSION._N>

Enclosing class:

TPMA_SESSION
```
public static enum TPMA_SESSION._N
extends Enum<TPMA_SESSION._N>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`audit` SET (1): In a command or response, this setting indicates that the session is for audit and that auditExclusive and auditReset have meaning.
`auditExclusive` SET (1): In a command, this setting indicates that the command should only be executed if the session is exclusive at the start of the command.
`auditReset` SET (1): In a command, this setting indicates that the audit digest of the session should be initialized and the exclusive status of the session SET.
`continueSession` SET (1): In a command, this setting indicates that the session is to remain active after successful completion of the command.
`decrypt` SET (1): In a command, this setting indicates that the first parameter in the command is symmetrically encrypted using the parameter encryption scheme described in TPM 2.0 Part 1.
`encrypt` SET (1): In a command, this setting indicates that the TPM should use this session to encrypt the first parameter in the response.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TPMA_SESSION._N`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TPMA_SESSION._N[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - continueSession
```
public static final TPMA_SESSION._N continueSession
```
    SET (1): In a command, this setting indicates that the session is to remain active after successful completion of the command. In a response, it indicates that the session is still active. If SET in the command, this attribute shall be SET in the response. CLEAR (0): In a command, this setting indicates that the TPM should close the session and flush any related context when the command completes successfully. In a response, it indicates that the session is closed and the context is no longer active. This attribute has no meaning for a password authorization and the TPM will allow any setting of the attribute in the command and SET the attribute in the response. This attribute will only be CLEAR in one response for a logical session. If the attribute is CLEAR, the context associated with the session is no longer in use and the space is available. A session created after another session is ended may have the same handle but logically is not the same session. This attribute has no effect if the command does not complete successfully.
  - auditExclusive
```
public static final TPMA_SESSION._N auditExclusive
```
    SET (1): In a command, this setting indicates that the command should only be executed if the session is exclusive at the start of the command. In a response, it indicates that the session is exclusive. This setting is only allowed if the audit attribute is SET (TPM_RC_ATTRIBUTES). CLEAR (0): In a command, indicates that the session need not be exclusive at the start of the command. In a response, indicates that the session is not exclusive. In this revision, if audit is CLEAR, auditExclusive must be CLEAR in the command and will be CLEAR in the response. In a future, revision, this bit may have a different meaning if audit is CLEAR. See "Exclusive Audit Session" clause in TPM 2.0 Part 1.
  - auditReset
```
public static final TPMA_SESSION._N auditReset
```
    SET (1): In a command, this setting indicates that the audit digest of the session should be initialized and the exclusive status of the session SET. This setting is only allowed if the audit attribute is SET (TPM_RC_ATTRIBUTES). CLEAR (0): In a command, indicates that the audit digest should not be initialized. This bit is always CLEAR in a response. In this revision, if audit is CLEAR, auditReset must be clear in the command and will be CLEAR in the response. In a future, revision, this bit may have a different meaning if audit is CLEAR.
  - decrypt
```
public static final TPMA_SESSION._N decrypt
```
    SET (1): In a command, this setting indicates that the first parameter in the command is symmetrically encrypted using the parameter encryption scheme described in TPM 2.0 Part 1. The TPM will decrypt the parameter after performing any HMAC computations and before unmarshaling the parameter. In a response, the attribute is copied from the request but has no effect on the response. CLEAR (0): Session not used for encryption. For a password authorization, this attribute will be CLEAR in both the command and response. This attribute may only be SET in one session per command. This attribute may be SET in a session that is not associated with a command handle. Such a session is provided for purposes of encrypting a parameter and not for authorization. This attribute may be SET in combination with any other session attributes. This attribute may only be SET if the first parameter of the command is a sized buffer (TPM2B_).
  - encrypt
```
public static final TPMA_SESSION._N encrypt
```
    SET (1): In a command, this setting indicates that the TPM should use this session to encrypt the first parameter in the response. In a response, it indicates that the attribute was set in the command and that the TPM used the session to encrypt the first parameter in the response using the parameter encryption scheme described in TPM 2.0 Part 1. CLEAR (0): Session not used for encryption. For a password authorization, this attribute will be CLEAR in both the command and response. This attribute may only be SET in one session per command. This attribute may be SET in a session that is not associated with a command handle. Such a session is provided for purposes of encrypting a parameter and not for authorization. This attribute may only be SET if the first parameter of a response is a sized buffer (TPM2B_).
  - audit
```
public static final TPMA_SESSION._N audit
```
    SET (1): In a command or response, this setting indicates that the session is for audit and that auditExclusive and auditReset have meaning. This session may also be used for authorization, encryption, or decryption. The encrypted and encrypt fields may be SET or CLEAR. CLEAR (0): Session is not used for audit. This attribute may only be SET in one session per command or response. If SET in the command, then this attribute will be SET in the response.
- Method Detail
  - values
```
public static TPMA_SESSION._N[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TPMA_SESSION._N c : TPMA_SESSION._N.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TPMA_SESSION._N valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum TPMA_SESSION._N

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

continueSession

auditExclusive

auditReset

decrypt

encrypt

audit

Method Detail

values

valueOf