org.jscsi.target.scsi.sense.senseDataDescriptor.senseKeySpecific

Class SenseKeySpecificData

java.lang.Object

org.jscsi.target.scsi.sense.senseDataDescriptor.senseKeySpecific.SenseKeySpecificData

All Implemented Interfaces:

ISerializable

Direct Known Subclasses:

ActualRetryCountSenseKeySpecificData, FieldPointerSenseKeySpecificData, InvalidSenseKeySpecificData, ProgressIndicationSenseKeySpecificData, SegmentPointerSenseKeySpecificData

public abstract class SenseKeySpecificData
extends Object
implements ISerializable

SENSE-KEY-SPECIFIC DATA further defines the reason for a CHECK CONDITION SCSI response status.

The definition of the SENSE KEY SPECIFIC field is determined by the value of the enclosing sense data's SenseData.senseKey field.

Sense Key	Sense Key Specific Field Definition
SenseKey.ILLEGAL_REQUEST	Field Pointer (see FieldPointerSenseKeySpecificData)
SenseKey.HARDWARE_ERROR, SenseKey.MEDIUM_ERROR, or SenseKey.RECOVERED_ERROR	Actual Retry Count (see ActualRetryCountSenseKeySpecificData)
SenseKey.NO_SENSE or SenseKey.NOT_READY	Progress Indication (see ProgressIndicationSenseKeySpecificData)
SenseKey.COPY_ABORTED	Segment Pointer (see SegmentPointerSenseKeySpecificData)
All other Sense Keys	The sense key specific sense data descriptor shall not appear in the descriptor format sense data and the SKSV (Sense Key Specific Field Valid) bit shall be set to zero in the fixed format sense data.

Author:

Andreas Ergenzinger

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	senseKeySpecificDataValid true if and only if the information fields of this data object are valid.
static int	SIZE The serialized length in bytes of SENSE-KEY-SPECIFIC DATA.

Constructor Summary

Constructors

Constructor and Description
SenseKeySpecificData(boolean senseKeySpecificDataValid) The absctract constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	serialize(ByteBuffer byteBuffer, int index) Inserts a serialized representation of the object into the specified ByteBuffer.
protected abstract void	serializeSpecificFields(ByteBuffer byteBuffer, int index) Serializes all fields which are not common to all sense-key-specific data, which means those that are sub-type-specific.
int	size() Returns the size in bytes of the object's serialized representation.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The serialized length in bytes of SENSE-KEY-SPECIFIC DATA.

See Also:

Constant Field Values

senseKeySpecificDataValid

protected final boolean senseKeySpecificDataValid

true if and only if the information fields of this data object are valid.

Constructor Detail

SenseKeySpecificData

public SenseKeySpecificData(boolean senseKeySpecificDataValid)

The absctract constructor.

Parameters:

senseKeySpecificDataValid - true if and only if the information fields of this data object are valid

Method Detail

serializeSpecificFields

protected abstract void serializeSpecificFields(ByteBuffer byteBuffer,
                           int index)

Serializes all fields which are not common to all sense-key-specific data, which means those that are sub-type-specific.

Parameters:

byteBuffer - where the serialized fields will be stored

index - the position of the first byte of the sense data descriptor in the ByteBuffer

serialize

public void serialize(ByteBuffer byteBuffer,
             int index)

Description copied from interface: ISerializable

Inserts a serialized representation of the object into the specified ByteBuffer. The serialized object will occupy the byte positions from index to index + ISerializable.size() - 1.

Specified by:

serialize in interface ISerializable

Parameters:

byteBuffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

size

public int size()

Description copied from interface: ISerializable

Returns the size in bytes of the object's serialized representation.

Specified by:

size in interface ISerializable

Returns:

the size in bytes of the object's serialized representation