SenseKey (Target 2.4 API)

java.lang.Object
- java.lang.Enum<SenseKey>
- - org.jscsi.target.scsi.sense.SenseKey

All Implemented Interfaces:

Serializable, Comparable<SenseKey>
```
public enum SenseKey
extends Enum<SenseKey>
```
The SENSE KEY field indicates generic information describing an error or exception condition. The field's length is 4 bits.

Author:

Andreas Ergenzinger

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABORTED_COMMAND` Indicates that the device server aborted the command.
`BLANK_CHECK` Indicates that a write-once device or a sequential-access device encountered blank medium or format-defined end-of-data indication while reading or that a write-once device encountered a non-blank medium while writing.
`COPY_ABORTED` Indicates an EXTENDED COPY command was aborted due to an error condition on the source device, the destination device, or both (see "errors detected during processing of segment descriptors").
`DATA_PROTECT` Indicates that a command that reads or writes the medium was attempted on a block that is protected.
`HARDWARE_ERROR` Indicates that the device server detected a non-recoverable hardware failure (e.g., controller failure, device failure, or parity error) while performing the command or during a self test.
`ILLEGAL_REQUEST` Indicates that: a) The command was addressed to an incorrect logical unit number (see SAM-3); b) The command had an invalid task attribute (see SAM-3); c) The command was addressed to a logical unit whose current configuration prohibits processing the command; d) There was an illegal parameter in the CDB; or e) There was an illegal parameter in the additional parameters supplied as data for some commands (e.g., PERSISTENT RESERVE OUT).
`MEDIUM_ERROR` Indicates that the command terminated with a non-recovered error condition that may have been caused by a flaw in the medium or an error in the recorded data.
`MISCOMPARE` Indicates that the source data did not match the data read from the medium.
`NO_SENSE` Indicates that there is no specific sense key information to be reported.
`NOT_READY` Indicates that the logical unit is not accessible.
`RECOVERED_ERROR` Indicates that the command completed successfully, with some recovery action performed by the device server.
`UNIT_ATTENTION` Indicates that a unit attention condition has been established (e.g., the removable medium may have been changed, a logical unit reset occurred).
`VENDOR_SPECIFIC` This sense key is available for reporting vendor specific conditions.
`VOLUME_OVERFLOW` Indicates that a buffered SCSI device has reached the end-of-partition and data may remain in the buffer that has not been written to the medium.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getValue()` The serialized value of the instance.
`static SenseKey`	`valueOf(int value)` Returns the `SenseKey` instance representing the passed value.
`static SenseKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SenseKey[]`	`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
  - NO_SENSE
```
public static final SenseKey NO_SENSE
```
    Indicates that there is no specific sense key information to be reported. This may occur for a successful command or for a command that receives CHECK CONDITION status because one of the FILEMARK, EOM, or ILI bits is set to one.
  - RECOVERED_ERROR
```
public static final SenseKey RECOVERED_ERROR
```
    Indicates that the command completed successfully, with some recovery action performed by the device server. Details may be determined by examining the additional sense bytes and the INFORMATION field. When multiple recovered errors occur during one command, the choice of which error to report (e.g., first, last, most severe) is vendor specific.
  - NOT_READY
```
public static final SenseKey NOT_READY
```
    Indicates that the logical unit is not accessible. Operator intervention may be required to correct this condition.
  - MEDIUM_ERROR
```
public static final SenseKey MEDIUM_ERROR
```
    Indicates that the command terminated with a non-recovered error condition that may have been caused by a flaw in the medium or an error in the recorded data. This sense key may also be returned if the device server is unable to distinguish between a flaw in the medium and a specific hardware failure (i.e., sense key 4h HARDWARE_ERROR).
  - HARDWARE_ERROR
```
public static final SenseKey HARDWARE_ERROR
```
    Indicates that the device server detected a non-recoverable hardware failure (e.g., controller failure, device failure, or parity error) while performing the command or during a self test.
  - ILLEGAL_REQUEST
```
public static final SenseKey ILLEGAL_REQUEST
```
    Indicates that: a) The command was addressed to an incorrect logical unit number (see SAM-3); b) The command had an invalid task attribute (see SAM-3); c) The command was addressed to a logical unit whose current configuration prohibits processing the command; d) There was an illegal parameter in the CDB; or e) There was an illegal parameter in the additional parameters supplied as data for some commands (e.g., PERSISTENT RESERVE OUT). If the device server detects an invalid parameter in the CDB, it shall terminate the command without altering the medium. If the device server detects an invalid parameter in the additional parameters supplied as data, the device server may have already altered the medium.
  - UNIT_ATTENTION
```
public static final SenseKey UNIT_ATTENTION
```
    Indicates that a unit attention condition has been established (e.g., the removable medium may have been changed, a logical unit reset occurred). See SAM-3.
  - DATA_PROTECT
```
public static final SenseKey DATA_PROTECT
```
    Indicates that a command that reads or writes the medium was attempted on a block that is protected. The read or write operation is not performed.
  - BLANK_CHECK
```
public static final SenseKey BLANK_CHECK
```
    Indicates that a write-once device or a sequential-access device encountered blank medium or format-defined end-of-data indication while reading or that a write-once device encountered a non-blank medium while writing.
  - VENDOR_SPECIFIC
```
public static final SenseKey VENDOR_SPECIFIC
```
    This sense key is available for reporting vendor specific conditions.
  - COPY_ABORTED
```
public static final SenseKey COPY_ABORTED
```
    Indicates an EXTENDED COPY command was aborted due to an error condition on the source device, the destination device, or both (see "errors detected during processing of segment descriptors").
  - ABORTED_COMMAND
```
public static final SenseKey ABORTED_COMMAND
```
    Indicates that the device server aborted the command. The application client may be able to recover by trying the command again.
  - VOLUME_OVERFLOW
```
public static final SenseKey VOLUME_OVERFLOW
```
    Indicates that a buffered SCSI device has reached the end-of-partition and data may remain in the buffer that has not been written to the medium. One or more RECOVER BUFFERED DATA command(s) may be issued to read the unwritten data from the buffer. (See SSC-2.)
  - MISCOMPARE
```
public static final SenseKey MISCOMPARE
```
    Indicates that the source data did not match the data read from the medium.
- Method Detail
  - values
```
public static SenseKey[] 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 (SenseKey c : SenseKey.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SenseKey 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
  - valueOf
```
public static SenseKey valueOf(int value)
```
    Returns the SenseKey instance representing the passed value.
    
    Parameters:
    value - a sense key value
    
    Returns:
    the SenseKey instance representing the passed value
  - getValue
```
public int getValue()
```
    The serialized value of the instance.
    
    Returns:
    serialized value of the instance

Enum SenseKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NO_SENSE

RECOVERED_ERROR

NOT_READY

MEDIUM_ERROR

HARDWARE_ERROR

ILLEGAL_REQUEST

UNIT_ATTENTION

DATA_PROTECT

BLANK_CHECK

VENDOR_SPECIFIC

COPY_ABORTED

ABORTED_COMMAND

VOLUME_OVERFLOW

MISCOMPARE

Method Detail

values

valueOf

valueOf

getValue