org.jscsi.parser

Class TargetMessageParser

java.lang.Object

org.jscsi.parser.AbstractMessageParser

org.jscsi.parser.TargetMessageParser

Direct Known Subclasses:

AsynchronousMessageParser, DataInParser, LoginResponseParser, LogoutResponseParser, NOPInParser, Ready2TransferParser, RejectParser, SCSIResponseParser, TaskManagementFunctionResponseParser, TextResponseParser

public abstract class TargetMessageParser
extends AbstractMessageParser

TargetMessageParser

This abstract class is the base class of all target message parsers defined in the iSCSI Protocol (RFC3720). This class defines some methods, which are common in all parsers to simplify the parsing process.

Author:

Volker Wildi

Field Summary

Fields

Modifier and Type	Field and Description
protected int	expectedCommandSequenceNumber Next Expected Commamd Sequence Number.
protected int	maximumCommandSequenceNumber Maximum Command Sequence Number.
protected int	statusSequenceNumber Status Sequence Number.

Fields inherited from class org.jscsi.parser.AbstractMessageParser

logicalUnitNumber, protocolDataUnit

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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	deserializeBytes24to27(int line) Parse the bytes 24 till 27 in the Basic Header Segment.
protected void	deserializeBytes28to31(int line) Parse the bytes 28 till 31 in the Basic Header Segment.
protected void	deserializeBytes32to35(int line) Parse the bytes 32 till 35 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.
protected void	deserializeBytes44to47(int line) Parse the bytes 44 till 47 in the Basic Header Segment.
int	getExpectedCommandSequenceNumber() Next Expected Commamd Sequence Number from this Initiator ExpCmdSN is a Sequence Number that the target iSCSI returns to the initiator to acknowledge command reception.
int	getMaximumCommandSequenceNumber() Maximum Command Sequence Number from this Initiator MaxCmdSN is a Sequence Number that the target iSCSI returns to the initiator to indicate the maximum CmdSN the initiator can send.
String	getShortInfo() Returns the short version of the used sequence numbers of this parser instance.
int	getStatusSequenceNumber() The Status Sequence Number (StatSN) is a Sequence Number that the target iSCSI layer generates per connection and that in turn, enables the initiator to acknowledge status reception.
boolean	incrementSequenceNumber() This AbstractMessageParser instance affects the incrementation of the Expected Status Sequence Number.
protected int	serializeBytes1to3() Serializes the bytes 1 till 3 in the Basic Header Segment.
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	serializeBytes28to31() Serializes the bytes 28 till 31 in the Basic Header Segment.
protected int	serializeBytes32to35() Serializes the bytes 32 till 35 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.
protected int	serializeBytes44to47() Serializes the bytes 44 till 47 in the Basic Header Segment.
void	setExpectedCommandSequenceNumber(int newExpectedCommandSequenceNumber) Sets the Expected Command Sequence Number of this TargetMessageParser object to the given value.
void	setMaximumCommandSequenceNumber(int newMaximumCommandSequenceNumber) Sets the Maximum Command Sequence Number of this TargetMessageParser object to the given value.
void	setStatusSequenceNumber(int newStatusSequenceNumber) Sets the Status Sequence Number of this TargetMessageParser object to the given value.
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.AbstractMessageParser

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

Methods inherited from class java.lang.Object

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

Field Detail

statusSequenceNumber

protected int statusSequenceNumber

Status Sequence Number.

expectedCommandSequenceNumber

protected int expectedCommandSequenceNumber

Next Expected Commamd Sequence Number.

maximumCommandSequenceNumber

protected int maximumCommandSequenceNumber

Maximum Command Sequence Number.

Constructor Detail

TargetMessageParser

public TargetMessageParser(ProtocolDataUnit initProtocolDataUnit)

Default constructor, creates a new, empty TargetMessageParser object.

Parameters:

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

Method Detail

getShortInfo

public String getShortInfo()

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

Specified by:

getShortInfo in class AbstractMessageParser

Returns:

The string with all needed sequence numbers.

toString

public String toString()

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

Overrides:

toString in class AbstractMessageParser

Returns:

The debug formatted string.

clear

public void clear()

This method sets all settings to their initial values.

Overrides:

clear in class AbstractMessageParser

incrementSequenceNumber

public boolean incrementSequenceNumber()

This AbstractMessageParser instance affects the incrementation of the Expected Status Sequence Number.

Specified by:

incrementSequenceNumber in class AbstractMessageParser

Returns:

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

getExpectedCommandSequenceNumber

public final int getExpectedCommandSequenceNumber()

Next Expected Commamd Sequence Number from this Initiator ExpCmdSN is a Sequence Number that the target iSCSI returns to the initiator to acknowledge command reception. It is used to update a local variable with the same name. An ExpCmdSN equal to MaxCmdSN+1 indicates that the target cannot accept new commands.

Returns:

Expected Command Sequence Number.

getMaximumCommandSequenceNumber

public final int getMaximumCommandSequenceNumber()

Maximum Command Sequence Number from this Initiator MaxCmdSN is a Sequence Number that the target iSCSI returns to the initiator to indicate the maximum CmdSN the initiator can send. It is used to update a local variable with the same name. If MaxCmdSN is equal to ExpCmdSN-1, this indicates to the initiator that the target cannot receive any additional commands. When MaxCmdSN changes at the target while the target has no pending PDUs to convey this information to the initiator, it MUST generate a NOP-IN to carry the new MaxCmdSN.

Returns:

Maximum Command Sequence Number.

getStatusSequenceNumber

public final int getStatusSequenceNumber()

The Status Sequence Number (StatSN) is a Sequence Number that the target iSCSI layer generates per connection and that in turn, enables the initiator to acknowledge status reception. StatSN is incremented by 1 for every response/status sent on a connection except for responses sent as a result of a retry or SNACK. In the case of responses sent due to a retransmission request, the StatSN MUST be the same as the first time the PDU was sent unless the connection has since been restarted.

Returns:

Status Sequence Number.

setExpectedCommandSequenceNumber

public final void setExpectedCommandSequenceNumber(int newExpectedCommandSequenceNumber)

Sets the Expected Command Sequence Number of this TargetMessageParser object to the given value.

Parameters:

newExpectedCommandSequenceNumber - The new Expected Command Sequence Number.

setMaximumCommandSequenceNumber

public final void setMaximumCommandSequenceNumber(int newMaximumCommandSequenceNumber)

Sets the Maximum Command Sequence Number of this TargetMessageParser object to the given value.

Parameters:

newMaximumCommandSequenceNumber - The new Maximum Command Sequence Number.

setStatusSequenceNumber

public final void setStatusSequenceNumber(int newStatusSequenceNumber)

Sets the Status Sequence Number of this TargetMessageParser object to the given value.

Parameters:

newStatusSequenceNumber - The new Status Sequence Number.

deserializeBytes1to3

protected void deserializeBytes1to3(int line)
                             throws InternetSCSIException

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

Specified by:

deserializeBytes1to3 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes20to23

protected void deserializeBytes20to23(int line)
                               throws InternetSCSIException

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

Specified by:

deserializeBytes20to23 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes24to27

protected final void deserializeBytes24to27(int line)
                                     throws InternetSCSIException

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

Specified by:

deserializeBytes24to27 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes28to31

protected final void deserializeBytes28to31(int line)
                                     throws InternetSCSIException

Parse the bytes 28 till 31 in the Basic Header Segment.

Specified by:

deserializeBytes28to31 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes32to35

protected final void deserializeBytes32to35(int line)
                                     throws InternetSCSIException

Parse the bytes 32 till 35 in the Basic Header Segment.

Specified by:

deserializeBytes32to35 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes36to39

protected void deserializeBytes36to39(int line)
                               throws InternetSCSIException

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

Specified by:

deserializeBytes36to39 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes40to43

protected void deserializeBytes40to43(int line)
                               throws InternetSCSIException

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

Specified by:

deserializeBytes40to43 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes44to47

protected void deserializeBytes44to47(int line)
                               throws InternetSCSIException

Parse the bytes 44 till 47 in the Basic Header Segment.

Specified by:

deserializeBytes44to47 in class AbstractMessageParser

Parameters:

line - The actual line

Throws:

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

serializeBytes1to3

protected int serializeBytes1to3()

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

Specified by:

serializeBytes1to3 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes20to23

protected int serializeBytes20to23()

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

Specified by:

serializeBytes20to23 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes24to27

protected int serializeBytes24to27()

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

Specified by:

serializeBytes24to27 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes28to31

protected int serializeBytes28to31()

Serializes the bytes 28 till 31 in the Basic Header Segment.

Specified by:

serializeBytes28to31 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes32to35

protected int serializeBytes32to35()

Serializes the bytes 32 till 35 in the Basic Header Segment.

Specified by:

serializeBytes32to35 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes36to39

protected int serializeBytes36to39()

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

Specified by:

serializeBytes36to39 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes40to43

protected int serializeBytes40to43()

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

Specified by:

serializeBytes40to43 in class AbstractMessageParser

Returns:

The serialized byte representation.

serializeBytes44to47

protected int serializeBytes44to47()

Serializes the bytes 44 till 47 in the Basic Header Segment.

Specified by:

serializeBytes44to47 in class AbstractMessageParser

Returns:

The serialized byte representation.