org.jscsi.target.connection.stage.login

Class TargetLoginStage

java.lang.Object

org.jscsi.target.connection.stage.TargetStage

org.jscsi.target.connection.stage.login.TargetLoginStage

Direct Known Subclasses:

LoginOperationalParameterNegotiationStage, SecurityNegotiationStage

public abstract class TargetLoginStage
extends TargetStage

This class is an abstract super-class for stages of the TargetLoginPhase (see TargetConnection for a description of the relationship between sessions, connections, phases and sessions), namely the LoginOperationalParameterNegotiationStage and the SecurityNegotiationStage.

The stage is started by calling the TargetStage.execute(ProtocolDataUnit) method with the first ProtocolDataUnit to be processed as part of the stage.

Of equal importance is the getNextStageNumber() method, which must be used to find out which stage or phase will follow this one.

Author:

Andreas Ergenzinger

Field Summary

Fields

Modifier and Type	Field and Description
protected int	initiatorTaskTag An identifier used by the initiator to identify the login task.
protected ConnectionSettingsNegotiator	negotiator Manages the text parameter negotiation.
protected LoginStage	nextStageNumber A stage number describing which stage must follow this stage.
protected LoginStage	requestedNextStageNumber A stage number describing which stage the initiator wants to transition to.
protected LoginStage	stageNumber The stage number used for describing this stage in Login Request PDUs.

Fields inherited from class org.jscsi.target.connection.stage.TargetStage

connection, session, settings, targetPhase

Constructor Summary

Constructors

Constructor and Description
TargetLoginStage(TargetLoginPhase targetLoginPhase, LoginStage stageNumber) The abstract constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkPdu(ProtocolDataUnit pdu) Returns true, if and only if the specified PDU is a Login Request PDU and the CSN and InitiatorTaskTag fields check out.
LoginStage	getNextStageNumber() Returns a stage number describing which stage of phase must follow this stage, or null if the initiator is not allowed to transition any further.
protected String	receivePduSequence() Receives a sequence of Login Request PDUs (as indicated by the LoginRequestParser.isContinueFlag() and returns the concatenated content of the text data segments.
protected String	receivePduSequence(ProtocolDataUnit pdu) Receives a sequence of Login Request PDUs (as indicated by the LoginRequestParser.isContinueFlag() and returns the concatenated content of the text data segments.
protected void	sendPduSequence(String keyValuePairs, LoginStage nextStage) Sends a Login Response PDU sequence containing the specified key-value pairs.
protected void	sendRejectPdu(LoginStatus errorStatus) Sends a Login Response PDU informing the initiator that an error has occurred and that the connection must be closed.

Methods inherited from class org.jscsi.target.connection.stage.TargetStage

execute, getConnection

Methods inherited from class java.lang.Object

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

Field Detail

negotiator

protected final ConnectionSettingsNegotiator negotiator

Manages the text parameter negotiation.

stageNumber

protected final LoginStage stageNumber

The stage number used for describing this stage in Login Request PDUs.

See Also:

LoginRequestParser.getCurrentStageNumber(), LoginRequestParser.getNextStageNumber()

initiatorTaskTag

protected int initiatorTaskTag

An identifier used by the initiator to identify the login task. Sent with the first Login Request PDU.

requestedNextStageNumber

protected LoginStage requestedNextStageNumber

A stage number describing which stage the initiator wants to transition to. This value will be updated with every received PDU.

See Also:

stageNumber

nextStageNumber

protected LoginStage nextStageNumber

A stage number describing which stage must follow this stage.

This value is initialized with null, and will be changed in TargetStage.execute(ProtocolDataUnit), if the stage was finished successfully.

See Also:

stageNumber

Constructor Detail

TargetLoginStage

public TargetLoginStage(TargetLoginPhase targetLoginPhase,
                LoginStage stageNumber)

The abstract constructor.

Parameters:

targetLoginPhase - the phase this stage is a part of

stageNumber - the stage number used for describing this stage in Login Request PDUs

Method Detail

checkPdu

protected boolean checkPdu(ProtocolDataUnit pdu)

Returns true, if and only if the specified PDU is a Login Request PDU and the CSN and InitiatorTaskTag fields check out.

Parameters:

pdu - the PDU to check

Returns:

true if the PDU checks out

receivePduSequence

protected final String receivePduSequence()
                                   throws DigestException,
                                          InternetSCSIException,
                                          IOException,
                                          SettingsException,
                                          InterruptedException

Receives a sequence of Login Request PDUs (as indicated by the LoginRequestParser.isContinueFlag() and returns the concatenated content of the text data segments.

Returns:

the concatenated content of the text data segments

Throws:

DigestException

InternetSCSIException

IOException

SettingsException

InterruptedException

receivePduSequence

protected final String receivePduSequence(ProtocolDataUnit pdu)
                                   throws InternetSCSIException,
                                          InterruptedException,
                                          IOException,
                                          DigestException,
                                          SettingsException

Receives a sequence of Login Request PDUs (as indicated by the LoginRequestParser.isContinueFlag() and returns the concatenated content of the text data segments.

Parameters:

pdu - the first PDU of the sequence

Returns:

the concatenated content of the text data segments

Throws:

InternetSCSIException

InterruptedException

IOException

DigestException

SettingsException

sendPduSequence

protected final void sendPduSequence(String keyValuePairs,
                   LoginStage nextStage)
                              throws SettingsException,
                                     InterruptedException,
                                     IOException,
                                     InternetSCSIException,
                                     DigestException

Sends a Login Response PDU sequence containing the specified key-value pairs.

Parameters:

keyValuePairs - contains key-value pairs to send

nextStage - indicates if the target is willing to transition to a different stage

Throws:

SettingsException

InterruptedException

IOException

InternetSCSIException

DigestException

sendRejectPdu

protected final void sendRejectPdu(LoginStatus errorStatus)
                            throws InterruptedException,
                                   IOException,
                                   InternetSCSIException

Sends a Login Response PDU informing the initiator that an error has occurred and that the connection must be closed.

Parameters:

errorStatus - hints to the cause of the error

Throws:

InterruptedException

IOException

InternetSCSIException

getNextStageNumber

public final LoginStage getNextStageNumber()

Returns a stage number describing which stage of phase must follow this stage, or null if the initiator is not allowed to transition any further.

Returns:

an identifier of the next stage/phase or null