org.jscsi.initiator

Class Initiator

java.lang.Object

org.jscsi.initiator.Initiator

public final class Initiator
extends Object

Initiator

This class represents an initiator, which request messages to a target defined by the iSCSI Protocol (RFC3720).

Author:

Volker Wildi, University of Konstanz, Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
Initiator(Configuration initConfiguration) Constructor to create an empty Initiator object with the given configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeSession(String targetName) Closes all opened connections within this session to the given target.
void	createSession(InetSocketAddress targetAddress, String targetName) Creates a new session to a target with the given Internet address and port.
void	createSession(String targetName) Creates a new session with the given target name, which is read from the configuration file.
long	getBlockSize(String targetName) Returns the used block size (in bytes) of the iSCSI Target.
long	getCapacity(String targetName) Returns the capacity (in blocks) of the iSCSI Target.
Future<Void>	multiThreadedRead(String targetName, ByteBuffer dst, int logicalBlockAddress, long transferLength) Invokes a read operation for the session targetName and store the read bytes in the buffer dst.
Future<Void>	multiThreadedWrite(String targetName, ByteBuffer src, int logicalBlockAddress, long transferLength) Invokes a write operation for the session targetName and transmits the bytes in the buffer dst.
Boolean	noSessions() is the Sessions Map empty?.
void	read(String targetName, ByteBuffer dst, int logicalBlockAddress, long transferLength) Invokes a read operation for the session targetName and store the read bytes in the buffer dst.
void	removeSession(Session sessionReq) Removes the Session instances form the sessions queue.
void	write(String targetName, ByteBuffer src, int logicalBlockAddress, long transferLength) Invokes a write operation for the session targetName and transmits the bytes in the buffer dst.

Methods inherited from class java.lang.Object

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

Constructor Detail

Initiator

public Initiator(Configuration initConfiguration)

Constructor to create an empty Initiator object with the given configuration.

Parameters:

initConfiguration - The user-defined configuration file.

Method Detail

createSession

public final void createSession(String targetName)
                         throws org.jscsi.exception.NoSuchSessionException

Creates a new session with the given target name, which is read from the configuration file.

Parameters:

targetName - The name of the iSCSI Target to connect.

Throws:

org.jscsi.exception.NoSuchSessionException - if no session was found

createSession

public final void createSession(InetSocketAddress targetAddress,
                 String targetName)

Creates a new session to a target with the given Internet address and port. The target has the name targetName.

Parameters:

targetAddress - The Internet address and Port of the target.

targetName - Name of the target, to which a connection should be created.

Throws:

Exception - if any error occurs.

closeSession

public final void closeSession(String targetName)
                        throws org.jscsi.exception.NoSuchSessionException,
                               org.jscsi.exception.TaskExecutionException

Closes all opened connections within this session to the given target.

Parameters:

targetName - The name of the target, which connection should be closed.

Throws:

org.jscsi.exception.NoSuchSessionException - if no session is accessible

org.jscsi.exception.TaskExecutionException - if logout fails.

multiThreadedRead

public final Future<Void> multiThreadedRead(String targetName,
                             ByteBuffer dst,
                             int logicalBlockAddress,
                             long transferLength)
                                     throws org.jscsi.exception.NoSuchSessionException,
                                            org.jscsi.exception.TaskExecutionException

Invokes a read operation for the session targetName and store the read bytes in the buffer dst. Start reading at the logical block address and request transferLength blocks.

Parameters:

targetName - The name of the session to invoke this read operation.

dst - The buffer to store the read data.

logicalBlockAddress - The logical block address of the beginning.

transferLength - Number of bytes to read.

Returns:

FutureObject for MultiThreadedReads

Throws:

Exception - if any error occurs.

org.jscsi.exception.TaskExecutionException - if execution fails

org.jscsi.exception.NoSuchSessionException - if session is not found

read

public final void read(String targetName,
        ByteBuffer dst,
        int logicalBlockAddress,
        long transferLength)
                throws org.jscsi.exception.NoSuchSessionException,
                       org.jscsi.exception.TaskExecutionException

Invokes a read operation for the session targetName and store the read bytes in the buffer dst. Start reading at the logical block address and request transferLength blocks.

Parameters:

targetName - The name of the session to invoke this read operation.

dst - The buffer to store the read data.

logicalBlockAddress - The logical block address of the beginning.

transferLength - Number of bytes to read.

Throws:

org.jscsi.exception.TaskExecutionException - if execution fails

org.jscsi.exception.NoSuchSessionException - if session is not found

multiThreadedWrite

public final Future<Void> multiThreadedWrite(String targetName,
                              ByteBuffer src,
                              int logicalBlockAddress,
                              long transferLength)
                                      throws org.jscsi.exception.NoSuchSessionException,
                                             org.jscsi.exception.TaskExecutionException

Invokes a write operation for the session targetName and transmits the bytes in the buffer dst. Start writing at the logical block address and transmit transferLength blocks.

Parameters:

targetName - The name of the session to invoke this write operation.

src - The buffer to transmit.

logicalBlockAddress - The logical block address of the beginning.

transferLength - Number of bytes to write.

Returns:

FutureObject for the multi-threaded write operation

Throws:

Exception - if any error occurs.

org.jscsi.exception.TaskExecutionException - if execution fails

org.jscsi.exception.NoSuchSessionException - if session is not found

write

public final void write(String targetName,
         ByteBuffer src,
         int logicalBlockAddress,
         long transferLength)
                 throws org.jscsi.exception.NoSuchSessionException,
                        org.jscsi.exception.TaskExecutionException

Invokes a write operation for the session targetName and transmits the bytes in the buffer dst. Start writing at the logical block address and transmit transferLength blocks.

Parameters:

targetName - The name of the session to invoke this write operation.

src - The buffer to transmit.

logicalBlockAddress - The logical block address of the beginning.

transferLength - Number of bytes to write.

Throws:

org.jscsi.exception.TaskExecutionException - if execution fails

org.jscsi.exception.NoSuchSessionException - if session is not found

getBlockSize

public final long getBlockSize(String targetName)
                        throws org.jscsi.exception.NoSuchSessionException

Returns the used block size (in bytes) of the iSCSI Target.

Parameters:

targetName - The name of the session to invoke this capacity operation.

Returns:

the used block size (in bytes) of the connected iSCSI Target.

Throws:

org.jscsi.exception.NoSuchSessionException - if the session connected to the target is yet not open.

getCapacity

public final long getCapacity(String targetName)
                       throws org.jscsi.exception.NoSuchSessionException

Returns the capacity (in blocks) of the iSCSI Target.

Parameters:

targetName - The name of the session to invoke this capacity operation.

Returns:

the capacity in blocks of the connected iSCSI Target.

Throws:

org.jscsi.exception.NoSuchSessionException - if the session connected to the target is yet not open.

removeSession

public final void removeSession(Session sessionReq)
                         throws org.jscsi.exception.NoSuchSessionException

Removes the Session instances form the sessions queue.

Parameters:

sessionReq - The Session to remove

Throws:

org.jscsi.exception.NoSuchSessionException - if the Session does not exist in the Map

noSessions

public final Boolean noSessions()

is the Sessions Map empty?.

Returns:

true if it is empty