org.jscsi.parser.data

Class DataOutParser

java.lang.Object

org.jscsi.parser.AbstractMessageParser

org.jscsi.parser.InitiatorMessageParser

org.jscsi.parser.data.DataOutParser

public final class DataOutParser
extends InitiatorMessageParser

This class parses a Data-Out message defined in the iSCSI Standard (RFC3720).

Author:

Volker Wildi

Field Summary

Fields inherited from class org.jscsi.parser.InitiatorMessageParser

commandSequenceNumber, expectedStatusSequenceNumber

Fields inherited from class org.jscsi.parser.AbstractMessageParser

logicalUnitNumber, protocolDataUnit

Constructor Summary

Constructors

Constructor and Description
DataOutParser(ProtocolDataUnit initProtocolDataUnit) Default constructor, creates a new, empty DataOutParser object.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkIntegrity() This method checks, if all parsed fields are valid.
void	clear() This method sets all settings to their initial values.
protected void	deserializeBytes1to3(int line) Parse the bytes 1 till 3 in the Basic Header Segment.
protected void	deserializeBytes20to23(int line) Parse the bytes 20 till 23 in the Basic Header Segment.
protected void	deserializeBytes36to39(int line) Parse the bytes 36 till 39 in the Basic Header Segment.
protected void	deserializeBytes40to43(int line) Parse the bytes 40 till 43 in the Basic Header Segment.
int	getBufferOffset() The Buffer Offset field contains the offset of this PDU payload data within the complete data transfer.
DataSegmentFactory.DataSegmentFormat	getDataSegmentFormat() If this method returns true, hen it indicates that the data segment data is interpreted as binary data.
int	getDataSequenceNumber() For input (read) or bidirectional Data-In PDUs, the DataSN is the input PDU number within the data transfer for the command identified by the Initiator Task Tag.
String	getShortInfo() Returns the short version of the used sequence numbers of this parser instance.
int	getTargetTransferTag() On outgoing data, the Target Transfer Tag is provided to the target if the transfer is honoring an R2T.
boolean	incrementSequenceNumber() This AbstractMessageParser instance affects the incrementation of the Command Sequence Number.
protected int	serializeBytes20to23() Serializes the bytes 20 till 23 in the Basic Header Segment.
protected int	serializeBytes24to27() Serializes the bytes 24 till 27 in the Basic Header Segment.
protected int	serializeBytes36to39() Serializes the bytes 36 till 39 in the Basic Header Segment.
protected int	serializeBytes40to43() Serializes the bytes 40 till 43 in the Basic Header Segment.
void	setBufferOffset(int newBufferOffset) Sets the Buffer Offset to a new one.
void	setCommandSequenceNumber(int newCommandSequenceNumber) Returns the Command Sequence Number of this InitiatorMessageParser object.
void	setDataSequenceNumber(int newDataSequenceNumber) Sets the Data Sequence Number to a new one.
void	setTargetTransferTag(int newTargetTransferTag) Sets the Target Transfer Tag to a new one.
String	toString() This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.

Methods inherited from class org.jscsi.parser.InitiatorMessageParser

deserializeBytes24to27, deserializeBytes28to31, deserializeBytes32to35, deserializeBytes44to47, getCommandSequenceNumber, getExpectedStatusSequenceNumber, serializeBytes1to3, serializeBytes28to31, serializeBytes32to35, serializeBytes44to47, setExpectedStatusSequenceNumber

Methods inherited from class org.jscsi.parser.AbstractMessageParser

canContainAdditionalHeaderSegments, canHaveDigests, deserializeBytes12to15, deserializeBytes8to11, getLogicalUnitNumber, serializeBytes12to15, serializeBytes8to11, setLogicalUnitNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

DataOutParser

public DataOutParser(ProtocolDataUnit initProtocolDataUnit)

Default constructor, creates a new, empty DataOutParser object.

Parameters:

initProtocolDataUnit - The reference ProtocolDataUnit instance, which contains this DataOutParser subclass object.

Method Detail

setCommandSequenceNumber

public final void setCommandSequenceNumber(int newCommandSequenceNumber)

Returns the Command Sequence Number of this InitiatorMessageParser object.

This field does not have a Command Sequence Number unequal 0.

Overrides:

setCommandSequenceNumber in class InitiatorMessageParser

Parameters:

newCommandSequenceNumber - This number is ignored.

getBufferOffset

public final int getBufferOffset()

The Buffer Offset field contains the offset of this PDU payload data within the complete data transfer. The sum of the buffer offset and length should not exceed the expected transfer length for the command.
The order of data PDUs within a sequence is determined by DataPDUInOrder. When set to Yes, it means that PDUs have to be in increasing Buffer Offset order and overlays are forbidden.
The ordering between sequences is determined by DataSequenceInOrder. When set to Yes, it means that sequences have to be in increasing Buffer Offset order and overlays are forbidden.

Returns:

The Buffer Offset of this DataOutParser object.

getDataSequenceNumber

public final int getDataSequenceNumber()

For input (read) or bidirectional Data-In PDUs, the DataSN is the input PDU number within the data transfer for the command identified by the Initiator Task Tag.

R2T and Data-In PDUs, in the context of bidirectional commands, share the numbering sequence (see Section 3.2.2.3 Data Sequencing).

For output (write) data PDUs, the DataSN is the Data-Out PDU number within the current output sequence. The current output sequence is either identified by the Initiator Task Tag (for unsolicited data) or is a data sequence generated for one R2T (for data solicited through R2T).

Returns:

The Data Sequence Number of this DataOutParser object.

getTargetTransferTag

public final int getTargetTransferTag()

On outgoing data, the Target Transfer Tag is provided to the target if the transfer is honoring an R2T. In this case, the Target Transfer Tag field is a replica of the Target Transfer Tag provided with the R2T.

On incoming data, the Target Transfer Tag and LUN MUST be provided by the target if the A bit is set to 1; otherwise they are reserved. The Target Transfer Tag and LUN are copied by the initiator into the SNACK of type DataACK that it issues as a result of receiving a SCSI Data-In PDU with the A bit set to 1.

The Target Transfer Tag values are not specified by this protocol except that the value 0xffffffff is reserved and means that the Target Transfer Tag is not supplied. If the Target Transfer Tag is provided, then the LUN field MUST hold a valid value and be consistent with whatever was specified with the command; otherwise, the LUN field is reserved.

Returns:

The Target Transfer Tag of this DataOutParser object.

setBufferOffset

public final void setBufferOffset(int newBufferOffset)

Sets the Buffer Offset to a new one.

Parameters:

newBufferOffset - The new Buffer Offset.

See Also:

getBufferOffset()

setDataSequenceNumber

public final void setDataSequenceNumber(int newDataSequenceNumber)

Sets the Data Sequence Number to a new one.

Parameters:

newDataSequenceNumber - The new Data Sequence Number.

See Also:

getDataSequenceNumber()()

setTargetTransferTag

public final void setTargetTransferTag(int newTargetTransferTag)

Sets the Target Transfer Tag to a new one.

Parameters:

newTargetTransferTag - The new Target Transfer Tag.

See Also:

getTargetTransferTag()

getShortInfo

public String getShortInfo()

Returns the short version of the used sequence numbers of this parser instance.

Overrides:

getShortInfo in class InitiatorMessageParser

Returns:

The string with all needed sequence numbers.

toString

public final String toString()

This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.

Overrides:

toString in class InitiatorMessageParser

Returns:

The debug formatted string.

getDataSegmentFormat

public final DataSegmentFactory.DataSegmentFormat getDataSegmentFormat()

If this method returns true, hen it indicates that the data segment data is interpreted as binary data. Else the data segment data must be interpreted as Text Format.

Specified by:

getDataSegmentFormat in class AbstractMessageParser

Returns:

Returns a format defined by the DataSegmentFormat enumeration.

See Also:

DataSegmentFactory.DataSegmentFormat

clear

public final void clear()

This method sets all settings to their initial values.

Overrides:

clear in class InitiatorMessageParser

incrementSequenceNumber

public boolean incrementSequenceNumber()

This AbstractMessageParser instance affects the incrementation of the Command Sequence Number.

Overrides:

incrementSequenceNumber in class InitiatorMessageParser

Returns:

true, if the counter has to be incremented. Else false.

deserializeBytes1to3

protected final void deserializeBytes1to3(int line)
                                   throws InternetSCSIException

Parse the bytes 1 till 3 in the Basic Header Segment.

Overrides:

deserializeBytes1to3 in class InitiatorMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes20to23

protected final void deserializeBytes20to23(int line)
                                     throws InternetSCSIException

Parse the bytes 20 till 23 in the Basic Header Segment.

Overrides:

deserializeBytes20to23 in class InitiatorMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes36to39

protected final void deserializeBytes36to39(int line)
                                     throws InternetSCSIException

Parse the bytes 36 till 39 in the Basic Header Segment.

Overrides:

deserializeBytes36to39 in class InitiatorMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes40to43

protected final void deserializeBytes40to43(int line)
                                     throws InternetSCSIException

Parse the bytes 40 till 43 in the Basic Header Segment.

Overrides:

deserializeBytes40to43 in class InitiatorMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

checkIntegrity

protected final void checkIntegrity()
                             throws InternetSCSIException

This method checks, if all parsed fields are valid. Because there are several fields, which are reserved for future versions, and these must be zero. Is this the case an exception will be thrown.

Specified by:

checkIntegrity in class AbstractMessageParser

Throws:

InternetSCSIException - If the integrity is violated.

serializeBytes20to23

protected final int serializeBytes20to23()

Serializes the bytes 20 till 23 in the Basic Header Segment.

Overrides:

serializeBytes20to23 in class InitiatorMessageParser

Returns:

The serialized byte representation.

serializeBytes24to27

protected final int serializeBytes24to27()

Serializes the bytes 24 till 27 in the Basic Header Segment.

Overrides:

serializeBytes24to27 in class InitiatorMessageParser

Returns:

The serialized byte representation.

serializeBytes36to39

protected final int serializeBytes36to39()

Serializes the bytes 36 till 39 in the Basic Header Segment.

Overrides:

serializeBytes36to39 in class InitiatorMessageParser

Returns:

The serialized byte representation.

serializeBytes40to43

protected final int serializeBytes40to43()

Serializes the bytes 40 till 43 in the Basic Header Segment.

Overrides:

serializeBytes40to43 in class InitiatorMessageParser

Returns:

The serialized byte representation.