org.jscsi.parser.login

Class LoginResponseParser

java.lang.Object

org.jscsi.parser.AbstractMessageParser

org.jscsi.parser.TargetMessageParser

org.jscsi.parser.login.LoginResponseParser

public final class LoginResponseParser
extends TargetMessageParser

LoginResponseParser

This is a parser for the Login Response Message of the iSCSI Protocol (RFC3720). So it parses all the field of this login message and offers it fields with its getter methods.

The Login Response indicates the progress and/or end of the Login Phase.

T (Transit) bit

The T bit is set to 1 as an indicator of the end of the stage. If the T bit is set to 1 and NSG is FullFeaturePhase, then this is also the Final Login Response (see Chapter 5). A T bit of 0 indicates a "partial" response, which means "more negotiation needed".

A Login Response with a T bit set to 1 MUST NOT contain key=value pairs that may require additional answers from the initiator within the same stage.

A Login Response with a T bit set to 1 MUST NOT contain key=value pairs that may require additional answers from the initiator within the same stage.

StatSN

For the first Login Response (the response to the first Login Request), this is the starting status Sequence Number for the connection. The next response of any kind, including the next Login Response, if any, in the same Login Phase, will carry this number + 1. This field is only valid if the Status-Class is 0.

Login Parameters

The target MUST provide some basic parameters in order to enable the initiator to determine if it is connected to the correct port and the initial text parameters for the security exchange.

All the rules specified in Section 10.11.6 Text Response Data for text responses also hold for Login Responses. Keys and their explanations are listed in Chapter 11 (security negotiation keys) and Chapter 12 (operational parameter negotiation keys). All keys in Chapter 12, except for the X extension formats, MUST be supported by iSCSI initiators and targets. Keys in Chapter 11, only need to be supported when the function to which they refer is mandatory to implement.

Author:

Volker Wildi

Field Summary

Fields inherited from class org.jscsi.parser.TargetMessageParser

expectedCommandSequenceNumber, maximumCommandSequenceNumber, statusSequenceNumber

Fields inherited from class org.jscsi.parser.AbstractMessageParser

logicalUnitNumber, protocolDataUnit

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHaveDigests() If this method returns true, then it indicates that this derived AbstractMessageParser instance can be protected by a digest.
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	deserializeBytes12to15(int line) Parse the bytes 12 till 15 in the Basic Header Segment.
protected void	deserializeBytes1to3(int line) Parse the bytes 1 till 3 in the Basic Header Segment.
protected void	deserializeBytes36to39(int line) Parse the bytes 36 till 39 in the Basic Header Segment.
int	getActiveVersion() Indicates the highest version supported by the target and initiator.
LoginStage	getCurrentStageNumber() Returns the Current Stage Number of this Login Response Message.
DataSegmentFactory.DataSegmentFormat	getDataSegmentFormat() If this method returns true, hen it indicates that the data segment data is interpreted as binary data.
ISID	getInitiatorSessionID() Returns the Initiator Session ID (ISID) of this LoginResponseParser object.
int	getMaxVersion() This is the highest version number supported by the target.
LoginStage	getNextStageNumber() Returns the Next Stage Number of this Login Response Message.
LoginStatus	getStatus() The Status returned in a Login Response indicates the execution status of the Login Phase.
short	getTargetSessionIdentifyingHandle() The TSIH is the target assigned session identifying handle.
boolean	isContinueFlag() When set to 1, indicates that the text (set of key=value pairs) in this Login Response is not complete (it will be continued on subsequent Login Responses); otherwise, it indicates that this Login Response ends a set of key=value pairs.
protected int	serializeBytes1to3() Serializes the bytes 1 till 3 in the Basic Header Segment.
protected int	serializeBytes36to39() Serializes the bytes 36 till 39 in the Basic Header Segment.
void	setContinueFlag(boolean continueFlag)
void	setCurrentStageNumber(LoginStage currentStage)
void	setInitiatorSessionID(ISID initiatorSessionID)
void	setNextStageNumber(LoginStage nextStage)
void	setStatus(LoginStatus status)
void	setTargetSessionIdentifyingHandle(short targetSessionIdentifyingHandle)
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.TargetMessageParser

deserializeBytes20to23, deserializeBytes24to27, deserializeBytes28to31, deserializeBytes32to35, deserializeBytes40to43, deserializeBytes44to47, getExpectedCommandSequenceNumber, getMaximumCommandSequenceNumber, getShortInfo, getStatusSequenceNumber, incrementSequenceNumber, serializeBytes20to23, serializeBytes24to27, serializeBytes28to31, serializeBytes32to35, serializeBytes40to43, serializeBytes44to47, setExpectedCommandSequenceNumber, setMaximumCommandSequenceNumber, setStatusSequenceNumber

Methods inherited from class org.jscsi.parser.AbstractMessageParser

canContainAdditionalHeaderSegments, deserializeBytes8to11, getLogicalUnitNumber, serializeBytes12to15, serializeBytes8to11, setLogicalUnitNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginResponseParser

public LoginResponseParser(ProtocolDataUnit initProtocolDataUnit)

Default constructor, creates a new, empty LoginResponseParser object.

Parameters:

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

Method Detail

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 TargetMessageParser

Returns:

The debug formatted string.

clear

public final void clear()

This method sets all settings to their initial values.

Overrides:

clear in class TargetMessageParser

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

canHaveDigests

public final boolean canHaveDigests()

If this method returns true, then it indicates that this derived AbstractMessageParser instance can be protected by a digest.

Overrides:

canHaveDigests in class AbstractMessageParser

Returns:

true, if the ProtocolDataUnit can be protected by a header and/or a data digest. Else false.

getStatus

public final LoginStatus getStatus()

The Status returned in a Login Response indicates the execution status of the Login Phase. The status includes:

• Status-Class
• Status-Detail

0 Status-Class indicates success.

A non-zero Status-Class indicates an exception. In this case, Status-Class is sufficient for a simple initiator to use when handling exceptions, without having to look at the Status-Detail. The Status-Detail allows finer-grained exception handling for more sophisticated initiators and for better information for logging.

Returns:

The status of this LoginResponseParser object.

isContinueFlag

public final boolean isContinueFlag()

When set to 1, indicates that the text (set of key=value pairs) in this Login Response is not complete (it will be continued on subsequent Login Responses); otherwise, it indicates that this Login Response ends a set of key=value pairs. A Login Response with the C bit set to 1 MUST have the T bit set to 0.

Returns:

The status of the Continue Flag of this LoginResponseParser object.

getCurrentStageNumber

public final LoginStage getCurrentStageNumber()

Returns the Current Stage Number of this Login Response Message.

Returns:

Number of the Current Stage.

See Also:

LoginStage

getInitiatorSessionID

public final ISID getInitiatorSessionID()

Returns the Initiator Session ID (ISID) of this LoginResponseParser object.

Returns:

Returns the Initiator Session ID (ISID) of this LoginResponseParser object.

See Also:

ISID

getMaxVersion

public final int getMaxVersion()

This is the highest version number supported by the target.

All Login Responses within the Login Phase MUST carry the same Version-max.

The initiator MUST use the value presented as a response to the first Login Request.

Returns:

The maximum version of this login request message.

getActiveVersion

public final int getActiveVersion()

Indicates the highest version supported by the target and initiator.

If the target does not support a version within the range specified by the initiator, the target rejects the login and this field indicates the lowest version supported by the target.

All Login Responses within the Login Phase MUST carry the same Version-active.

The initiator MUST use the value presented as a response to the first Login Request.

Returns:

The active version of this LoginResponseParser object.

getNextStageNumber

public final LoginStage getNextStageNumber()

Returns the Next Stage Number of this Login Response Message.

Returns:

The Number of the Next Stage.

See Also:

LoginStage

getTargetSessionIdentifyingHandle

public final short getTargetSessionIdentifyingHandle()

The TSIH is the target assigned session identifying handle. Its internal format and content are not defined by this protocol except for the value 0 that is reserved. With the exception of the Login Final-Response in a new session, this field should be set to the TSIH provided by the initiator in the Login Request. For a new session, the target MUST generate a non-zero TSIH and ONLY return it in the Login Final-Response (see Section 5.3 Login Phase).

Returns:

Returns the Target Session Identifying Handle of this LoginResponseParser object.

setStatus

public void setStatus(LoginStatus status)

setContinueFlag

public void setContinueFlag(boolean continueFlag)

setCurrentStageNumber

public void setCurrentStageNumber(LoginStage currentStage)

setNextStageNumber

public void setNextStageNumber(LoginStage nextStage)

setInitiatorSessionID

public void setInitiatorSessionID(ISID initiatorSessionID)

setTargetSessionIdentifyingHandle

public void setTargetSessionIdentifyingHandle(short targetSessionIdentifyingHandle)

deserializeBytes1to3

protected final void deserializeBytes1to3(int line)
                                   throws InternetSCSIException

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

Overrides:

deserializeBytes1to3 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

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

deserializeBytes12to15

protected final void deserializeBytes12to15(int line)
                                     throws InternetSCSIException

Parse the bytes 12 till 15 in the Basic Header Segment.

Overrides:

deserializeBytes12to15 in class AbstractMessageParser

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 TargetMessageParser

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.

serializeBytes1to3

protected final int serializeBytes1to3()

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

Overrides:

serializeBytes1to3 in class TargetMessageParser

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 TargetMessageParser

Returns:

The serialized byte representation.