org.jscsi.parser

Class ProtocolDataUnit

java.lang.Object

org.jscsi.parser.ProtocolDataUnit

public final class ProtocolDataUnit
extends Object

ProtocolDataUnit

This class encapsulates a Protocol Data Unit (PDU), which is defined in the iSCSI Standard (RFC 3720).

Author:

Volker Wildi

Constructor Summary

Constructors

Constructor and Description
ProtocolDataUnit(IDigest initHeaderDigest, IDigest initDataDigest) Default constructor, creates a new, empty ProtcolDataUnit object.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all stored content of this ProtocolDataUnit object.
int	deserialize(ByteBuffer pdu) Deserializes (parses) a given byte representation of a PDU to an PDU object.
boolean	equals(Object o)
Iterator<org.jscsi.parser.AdditionalHeaderSegment>	getAdditionalHeaderSegments() Returns an iterator to all contained Additional Header Segment in this PDU.
BasicHeaderSegment	getBasicHeaderSegment() Returns the Basic Header Segment contained in this PDU.
IDigest	getDataDigest() Returns the instance of the used digest algorithm for the data segment.
ByteBuffer	getDataSegment() Gets the data segment in this PDU.
IDigest	getHeaderDigest() Returns the instance of the used digest algorithm for the header.
int	read(SocketChannel sChannel) Reads from the given SocketChannel all the neccassary bytes to fill this PDU.
ByteBuffer	serialize() Serialize all informations of this PDU object to its byte representation.
int	serializeDataSegment(ByteBuffer dst, int offset) Serializes the data segment (binary or key-value pairs) to a destination array, staring from offset to write.
void	setDataDigest(IDigest newDataDigest) Sets the digest of the data segment to use for data integrity.
void	setDataSegment(ByteBuffer dataSegment)
void	setDataSegment(IDataSegmentIterator.IDataSegmentChunk chunk) Sets a new data segment in this PDU.
void	setHeaderDigest(IDigest newHeaderDigest) Sets the digest of the header to use for data integrity.
String	toString()
int	write(SocketChannel sChannel) Writes this ProtocolDataUnit object to the given SocketChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolDataUnit

public ProtocolDataUnit(IDigest initHeaderDigest,
                IDigest initDataDigest)

Default constructor, creates a new, empty ProtcolDataUnit object.

Parameters:

initHeaderDigest - The instance of the digest to use for the Basic Header Segment protection.

initDataDigest - The instance of the digest to use for the Data Segment protection.

Method Detail

serialize

public final ByteBuffer serialize()
                           throws InternetSCSIException,
                                  IOException

Serialize all informations of this PDU object to its byte representation.

Returns:

The byte representation of this PDU.

Throws:

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

IOException - if an I/O error occurs.

deserialize

public final int deserialize(ByteBuffer pdu)
                      throws InternetSCSIException,
                             IOException,
                             DigestException

Deserializes (parses) a given byte representation of a PDU to an PDU object.

Parameters:

pdu - The byte representation of an PDU to parse.

Returns:

The number of bytes, which are serialized.

Throws:

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

IOException - if an I/O error occurs.

DigestException - There is a mismatch of the digest.

serializeDataSegment

public final int serializeDataSegment(ByteBuffer dst,
                       int offset)
                               throws InternetSCSIException

Serializes the data segment (binary or key-value pairs) to a destination array, staring from offset to write.

Parameters:

dst - The array to write in.

offset - The start offset to start from in dst.

Returns:

The written length.

Throws:

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

write

public final int write(SocketChannel sChannel)
                throws InternetSCSIException,
                       IOException

Writes this ProtocolDataUnit object to the given SocketChannel.

Parameters:

sChannel - SocketChannel to write to.

Returns:

The number of bytes written, possibly zero.

Throws:

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

IOException - if an I/O error occurs.

read

public final int read(SocketChannel sChannel)
               throws InternetSCSIException,
                      IOException,
                      DigestException

Reads from the given SocketChannel all the neccassary bytes to fill this PDU.

Parameters:

sChannel - SocketChannel to read from.

Returns:

The number of bytes, possibly zero,or -1 if the channel has reached end-of-stream

Throws:

IOException - if an I/O error occurs.

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

DigestException - if a mismatch of the digest exists.

clear

public final void clear()

Clears all stored content of this ProtocolDataUnit object.

getAdditionalHeaderSegments

public final Iterator<org.jscsi.parser.AdditionalHeaderSegment> getAdditionalHeaderSegments()

Returns an iterator to all contained Additional Header Segment in this PDU.

Returns:

The iterator to the contained Additional Header Segment.

See Also:

AdditionalHeaderSegment

getBasicHeaderSegment

public final BasicHeaderSegment getBasicHeaderSegment()

Returns the Basic Header Segment contained in this PDU.

Returns:

The Basic Header Segment.

See Also:

BasicHeaderSegment

getDataSegment

public final ByteBuffer getDataSegment()

Gets the data segment in this PDU.

Returns:

The data segment of this ProtocolDataUnit object.

setDataSegment

public final void setDataSegment(ByteBuffer dataSegment)

setDataSegment

public final void setDataSegment(IDataSegmentIterator.IDataSegmentChunk chunk)

Sets a new data segment in this PDU.

Parameters:

chunk - The new data segment of this ProtocolDataUnit object.

getHeaderDigest

public final IDigest getHeaderDigest()

Returns the instance of the used digest algorithm for the header.

Returns:

The instance of the header digest.

setHeaderDigest

public final void setHeaderDigest(IDigest newHeaderDigest)

Sets the digest of the header to use for data integrity.

Parameters:

newHeaderDigest - An instance of the new header digest.

getDataDigest

public final IDigest getDataDigest()

Returns the instance of the used digest algorithm for the data segment.

Returns:

The instance of the data digest.

setDataDigest

public final void setDataDigest(IDigest newDataDigest)

Sets the digest of the data segment to use for data integrity.

Parameters:

newDataDigest - An instance of the new data segment digest.

toString

public final String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Overrides:

equals in class Object