org.jscsi.target.scsi.sense

Class SenseData

java.lang.Object

org.jscsi.target.scsi.sense.SenseData

All Implemented Interfaces:

ISerializable

Direct Known Subclasses:

DescriptorFormatSenseData, FixedFormatSenseData

public abstract class SenseData
extends Object
implements ISerializable

Sense data shall be returned in the same I_T_L_Q nexus transaction as a CHECK CONDITION status and as parameter data in response to the REQUEST SENSE command.

Sense data returned in the same I_T_L_Q nexus transaction as a CHECK CONDITION status shall be either fixed or descriptor format sense data format based on the value of the D_SENSE bit in the Control mode page.

The REQUEST SENSE command may be used to request either the fixed format sense data or the descriptor format sense data.

Author:

Andreas Ergenzinger

Field Summary

Fields

Modifier and Type	Field and Description
protected AdditionalSenseCodeAndQualifier	additionalSenseCodeAndQualifier The senseKey and additionalSenseCodeAndQualifier fields provide a hierarchy of information.
protected ErrorType	errorType The error type of the sense data as determined by the responseCode variable.
protected int	responseCode The first byte of all sense data contains the RESPONSE CODE field that indicates the error type and format of the sense data.
protected SenseDataFormat	senseDataFormat The format of the sense data as determined by the responseCode variable.
protected SenseKey	senseKey The senseKey and additionalSenseCodeAndQualifier fields provide a hierarchy of information.

Constructor Summary

Constructors

Constructor and Description
SenseData(ErrorType errorType, SenseDataFormat senseDataFormat, SenseKey senseKey, AdditionalSenseCodeAndQualifier additionalSenseCodeAndQualifier) The sense data constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static int	getReponseCodeFor(ErrorType errorType, SenseDataFormat senseDataFormat) Returns the proper response code for the given error type and sense data format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jscsi.target.scsi.ISerializable

serialize, size

Field Detail

responseCode

protected final int responseCode

The first byte of all sense data contains the RESPONSE CODE field that indicates the error type and format of the sense data.

See Also:

errorType, senseDataFormat

errorType

protected final ErrorType errorType

The error type of the sense data as determined by the responseCode variable.

senseDataFormat

protected final SenseDataFormat senseDataFormat

The format of the sense data as determined by the responseCode variable.

senseKey

protected final SenseKey senseKey

The senseKey and additionalSenseCodeAndQualifier fields provide a hierarchy of information. The hierarchy provides a top-down approach for an application client to determine information relating to the error and exception conditions.

additionalSenseCodeAndQualifier

protected final AdditionalSenseCodeAndQualifier additionalSenseCodeAndQualifier

The senseKey and additionalSenseCodeAndQualifier fields provide a hierarchy of information. The hierarchy provides a top-down approach for an application client to determine information relating to the error and exception conditions.

Constructor Detail

SenseData

public SenseData(ErrorType errorType,
         SenseDataFormat senseDataFormat,
         SenseKey senseKey,
         AdditionalSenseCodeAndQualifier additionalSenseCodeAndQualifier)

The sense data constructor.

Parameters:

errorType - the error type of the sense data

senseDataFormat - the format of the sense data

senseKey - describes the general category of the error requiring the sending of sense data

additionalSenseCodeAndQualifier - a more specific description of the error

Method Detail

getReponseCodeFor

public static final int getReponseCodeFor(ErrorType errorType,
                    SenseDataFormat senseDataFormat)

Returns the proper response code for the given error type and sense data format.

Parameters:

errorType - a sense data error type

senseDataFormat - a sense data format

Returns:

the proper response code