org.jscsi.initiator.connection

Class Connection

java.lang.Object

org.jscsi.initiator.connection.Connection

public final class Connection
extends Object

AbsConnection

This abstract class represents a connection, which is used in the iSCSI Standard (RFC3720). Such a connection is directed from the initiator to the target. It is used in Sessions.

Author:

Volker Wildi, University of Konstanz, Patrice Matthias Brend'amour, University of Konstanz, Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
Connection(Session session, Configuration initConfiguration, InetSocketAddress inetAddress, short initConnectionID) Method to create and return a new, empty Connection object with the configured layer of threading.

Method Summary

Modifier and Type	Method and Description
void	close() This method does all the necessary steps, which are needed when a connection should be closed.
short	getConnectionID() Returns the ID of this Connection object.
SerialArithmeticNumber	getExpectedStatusSequenceNumber() Returns the Expected Status Sequence Number of this Connection object.
Session	getSession() Returns the session, which contains this connection instance.
String	getSetting(OperationalTextKey textKey) Returns the value of the given parameter as String.
boolean	getSettingAsBoolean(OperationalTextKey textKey) Returns the value of the given parameter, which is parsed to an boolean.
int	getSettingAsInt(OperationalTextKey textKey) Returns the value of the given parameter, which is parsed to an integer.
SettingsMap	getSettings() Returns the settings of the given session and connection.
IState	getState() Returns the current state of this connection.
void	incrementExpectedStatusSequenceNumber() Increments the Expected Status Sequence Number as defined in RFC1982 where SERIAL_BITS = 32.
void	nextState(IState newState) Switch to the new state.
ProtocolDataUnit	receive() Reads one ProtocolDataUnit instance from the receivingQueue.
void	send(ProtocolDataUnit protocolDataUnit) Enqueue this protocol data unit to the end of the sending queue.
void	send(Queue<ProtocolDataUnit> protocolDataUnits) Enqueue all protocol data units to the end of the sending queue.
void	setExpectedStatusSequenceNumber(int newExpectedStatusSequenceNumber) Sets the expected Status Sequence Number to the given one from the leading Login Response.
void	update(SettingsMap response) Updates all entries of the given response key-values with the stored settings of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Connection

public Connection(Session session,
                  Configuration initConfiguration,
                  InetSocketAddress inetAddress,
                  short initConnectionID)
           throws Exception

Method to create and return a new, empty Connection object with the configured layer of threading.

Parameters:

session - Reference to the AbsSession object, which contains this connection.

initConfiguration - The configuration to use within this connection.

inetAddress - The InetSocketAddress to which this connection should established.

initConnectionID - The ID of this connection.

Throws:

Exception - If any error occurs.

Method Detail

update

public final void update(SettingsMap response)
                  throws NoSuchSessionException

Updates all entries of the given response key-values with the stored settings of this instance.

Parameters:

response - The settings of the response.

Throws:

NoSuchSessionException - if a session with this target name is not open.

getSettingAsBoolean

public final boolean getSettingAsBoolean(OperationalTextKey textKey)
                                  throws OperationalTextKeyException

Returns the value of the given parameter, which is parsed to an boolean.

Parameters:

textKey - The name of the parameter.

Returns:

The boolean value of this parameter. So if the value is equal to Yes, then true will be returned. Else false is returned.

Throws:

OperationalTextKeyException - If the given parameter cannot be found.

getSettingAsInt

public final int getSettingAsInt(OperationalTextKey textKey)
                          throws OperationalTextKeyException

Returns the value of the given parameter, which is parsed to an integer.

Parameters:

textKey - The name of the parameter.

Returns:

The integer value of this parameter.

Throws:

OperationalTextKeyException - If the given parameter cannot be found.

getSetting

public final String getSetting(OperationalTextKey textKey)
                        throws OperationalTextKeyException

Returns the value of the given parameter as String.

Parameters:

textKey - The name of the parameter.

Returns:

The value of this parameter.

Throws:

OperationalTextKeyException - If the given parameter cannot be found.

getSettings

public final SettingsMap getSettings()

Returns the settings of the given session and connection.

Returns:

The settings of this specific connection.

incrementExpectedStatusSequenceNumber

public final void incrementExpectedStatusSequenceNumber()

Increments the Expected Status Sequence Number as defined in RFC1982 where SERIAL_BITS = 32.

getExpectedStatusSequenceNumber

public final SerialArithmeticNumber getExpectedStatusSequenceNumber()

Returns the Expected Status Sequence Number of this Connection object.

Returns:

The current Expected Status Sequence Number.

setExpectedStatusSequenceNumber

public final void setExpectedStatusSequenceNumber(int newExpectedStatusSequenceNumber)

Sets the expected Status Sequence Number to the given one from the leading Login Response.

Parameters:

newExpectedStatusSequenceNumber - The new value.

nextState

public final void nextState(IState newState)
                     throws InternetSCSIException

Switch to the new state. Start point of the state pattern. All states are computed one after another.

Parameters:

newState - The new state.

Throws:

InternetSCSIException - of any kind

getState

public final IState getState()

Returns the current state of this connection.

Returns:

The current IState instance of this Connection instance.

getSession

public final Session getSession()

Returns the session, which contains this connection instance.

Returns:

The parent session instance.

getConnectionID

public final short getConnectionID()

Returns the ID of this Connection object.

Returns:

The connection ID.

close

public final void close()
                 throws IOException

This method does all the necessary steps, which are needed when a connection should be closed.

Throws:

IOException - if an I/O error occurs.

send

public final void send(ProtocolDataUnit protocolDataUnit)
                throws InternetSCSIException

Enqueue this protocol data unit to the end of the sending queue.

Parameters:

protocolDataUnit - The protocol data unit to add.

Throws:

InternetSCSIException - for nearly everything

send

public final void send(Queue<ProtocolDataUnit> protocolDataUnits)
                throws InternetSCSIException

Enqueue all protocol data units to the end of the sending queue.

Parameters:

protocolDataUnits - The list with all protocol data units to add.

Throws:

InternetSCSIException - for nearly everything

receive

public final ProtocolDataUnit receive()
                               throws InternetSCSIException

Reads one ProtocolDataUnit instance from the receivingQueue.

Returns:

An instance of a ProtocolDataUnit.

Throws:

InternetSCSIException - for nearly everything