org.jscsi.initiator.connection.phase

Interface IPhase

All Known Implementing Classes:

FullFeaturePhase, LoginOperationalNegotiationPhase, SecurityNegotiationPhase

public interface IPhase

A State Pattern. Each phase of the iSCSI Protocol must implement this interface.

Author:

Volker Wildi

Method Summary

Modifier and Type	Method and Description
boolean	getCapacity(Session session, TargetCapacityInformations capacityInformation) This method handles the TargetCapacityInformations within this session (if possible in the current phase).
LoginStage	getStage() Returns the current stage.
boolean	login(Session session) This method handles the login of a connection (if possible).
boolean	logoutConnection(Session session, short connectionID) This method handles the logout of a connection (if possible) (if possible in the current phase).
boolean	logoutSession(ITask task, Session session) This method handles the logout of the whole session (with all its connections) (if possible in the current phase).
boolean	read(ITask task, Session session, ByteBuffer dst, int logicalBlockAddress, long length) This method handles a read operation within this session (if possible in the current phase).
boolean	write(ITask task, Session session, ByteBuffer src, int logicalBlockAddress, long length) This method handles a write operation within this session (if possible in the current phase).

Method Detail

login

boolean login(Session session)
       throws Exception

This method handles the login of a connection (if possible).

Parameters:

session - The context object of the current session.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

logoutConnection

boolean logoutConnection(Session session,
                         short connectionID)
                  throws Exception

This method handles the logout of a connection (if possible) (if possible in the current phase).

Parameters:

session - The context object of the current session.

connectionID - The ID of the connection to close.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

logoutSession

boolean logoutSession(ITask task,
                      Session session)
               throws Exception

This method handles the logout of the whole session (with all its connections) (if possible in the current phase).

Parameters:

task - The calling Task

session - The context object of the current session.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

read

boolean read(ITask task,
             Session session,
             ByteBuffer dst,
             int logicalBlockAddress,
             long length)
      throws Exception

This method handles a read operation within this session (if possible in the current phase).

Parameters:

task - The calling Task

session - The context object of the current session.

dst - The buffer to store the read data.

logicalBlockAddress - The logical block address to start the read operation.

length - The number of bytes to read.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

write

boolean write(ITask task,
              Session session,
              ByteBuffer src,
              int logicalBlockAddress,
              long length)
       throws Exception

This method handles a write operation within this session (if possible in the current phase).

Parameters:

task - The calling Task

session - The context object of the current session.

src - Write the remaining bytes to the iSCSI Target.

logicalBlockAddress - The logical block address to start the write operation.

length - The number of bytes to write.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

getCapacity

boolean getCapacity(Session session,
                    TargetCapacityInformations capacityInformation)
             throws Exception

This method handles the TargetCapacityInformations within this session (if possible in the current phase).

Parameters:

session - The context object of the current session.

capacityInformation - A TargetCapacityInformations instance to store these informations.

Returns:

true if task is finished

Throws:

Exception - if any error occurs.

getStage

LoginStage getStage()

Returns the current stage.

Returns:

The current stage.

See Also:

LoginStage