AbstractMessageParser (Libraries 2.5 API)

java.lang.Object
- org.jscsi.parser.AbstractMessageParser

Direct Known Subclasses:

InitiatorMessageParser, TargetMessageParser
```
public abstract class AbstractMessageParser
extends Object
```
AbstractMessageParser

Abstract class from which each parser (initiator or target message parser) for a specific Protocol Data Unit (PDU) is inherited. The version of iSCSI Protocol is the RFC3720.

Author:

Volker Wildi

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`logicalUnitNumber` Some opcodes operate on a specific Logical Unit.
`protected ProtocolDataUnit`	`protocolDataUnit` The read-only reference to the `ProtocolDataUnit` instance, which contains this `AbstractMessageParser` type.

Constructor Summary

Constructors
Constructor and Description

AbstractMessageParser(ProtocolDataUnit initProtocolDataUnit)
Default Contructor to create a new, empty AbstractMessageParser object.

Constructors
Constructor and Description
`AbstractMessageParser(ProtocolDataUnit initProtocolDataUnit)` Default Contructor to create a new, empty AbstractMessageParser object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canContainAdditionalHeaderSegments()` If this method returns `true`, it indicates that this derived AbstractMessageParser can contain one or more Additional Header Segments.
`boolean`	`canHaveDigests()` If this method returns `true`, then it indicates that this derived `AbstractMessageParser` instance can be protected by a digest.
`protected abstract void`	`checkIntegrity()` This method checks, if all parsed fields are valid.
`void`	`clear()` This method sets all settings to their initial values.
`protected void`	`deserializeBytes12to15(int line)` Parse the bytes `12` till `15` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes1to3(int line)` Parse the bytes `1` till `3` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes20to23(int line)` Parse the bytes `20` till `23` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes24to27(int line)` Parse the bytes `24` till `27` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes28to31(int line)` Parse the bytes `28` till `31` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes32to35(int line)` Parse the bytes `32` till `35` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes36to39(int line)` Parse the bytes `36` till `39` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes40to43(int line)` Parse the bytes `40` till `43` in the Basic Header Segment.
`protected abstract void`	`deserializeBytes44to47(int line)` Parse the bytes `44` till `47` in the Basic Header Segment.
`protected void`	`deserializeBytes8to11(int line)` Parse the bytes `8` till `11` in the Basic Header Segment.
`abstract DataSegmentFactory.DataSegmentFormat`	`getDataSegmentFormat()` If this method returns `true`, hen it indicates that the data segment data is interpreted as binary data.
`long`	`getLogicalUnitNumber()` Returns the Logical Unit Number (LUN) of this `AbstractMessageParser` object.
`abstract String`	`getShortInfo()` Returns the short version of the used sequence numbers of this parser instance.
`abstract boolean`	`incrementSequenceNumber()` This `AbstractMessageParser` instance affects the incrementation of a `Sequence Number` counter.
`protected int`	`serializeBytes12to15()` Serializes the bytes `12` till `15` in the Basic Header Segment.
`protected abstract int`	`serializeBytes1to3()` Serializes the bytes `1` till `3` in the Basic Header Segment.
`protected abstract int`	`serializeBytes20to23()` Serializes the bytes `20` till `23` in the Basic Header Segment.
`protected abstract int`	`serializeBytes24to27()` Serializes the bytes `24` till `27` in the Basic Header Segment.
`protected abstract int`	`serializeBytes28to31()` Serializes the bytes `28` till `31` in the Basic Header Segment.
`protected abstract int`	`serializeBytes32to35()` Serializes the bytes `32` till `35` in the Basic Header Segment.
`protected abstract int`	`serializeBytes36to39()` Serializes the bytes `36` till `39` in the Basic Header Segment.
`protected abstract int`	`serializeBytes40to43()` Serializes the bytes `40` till `43` in the Basic Header Segment.
`protected abstract int`	`serializeBytes44to47()` Serializes the bytes `44` till `47` in the Basic Header Segment.
`protected int`	`serializeBytes8to11()` Serializes the bytes `8` till `11` in the Basic Header Segment.
`void`	`setLogicalUnitNumber(long logicalUnitNumber)` Set the Logical Unit Number (LUN) of this `AbstractMessageParser` object.
`String`	`toString()` This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - protocolDataUnit
```
protected final ProtocolDataUnit protocolDataUnit
```
    The read-only reference to the ProtocolDataUnit instance, which contains this AbstractMessageParser type.
  - logicalUnitNumber
```
protected long logicalUnitNumber
```
    Some opcodes operate on a specific Logical Unit. The Logical Unit Number (LUN) field identifies which Logical Unit. If the opcode does not relate to a Logical Unit, this field is either ignored or may be used in an opcode specific way. The LUN field is 64-bits and should be formatted in accordance with [SAM2]. For example, LUN[0] from [SAM2] is BHS byte 8 and so on up to LUN[7] from [SAM2], which is BHS byte 15.
- Constructor Detail
  - AbstractMessageParser
```
public AbstractMessageParser(ProtocolDataUnit initProtocolDataUnit)
```
    Default Contructor to create a new, empty AbstractMessageParser object.
    
    Parameters:
    initProtocolDataUnit - The reference ProtocolDataUnit instance, which contains this AbstractMessageParser object.
- Method Detail
  - getDataSegmentFormat
```
public abstract DataSegmentFactory.DataSegmentFormat getDataSegmentFormat()
```
    If this method returns true, hen it indicates that the data segment data is interpreted as binary data. Else the data segment data must be interpreted as Text Format.
    
    Returns:
    Returns a format defined by the DataSegmentFormat enumeration.
    See Also:
    DataSegmentFactory.DataSegmentFormat
  - canContainAdditionalHeaderSegments
```
public boolean canContainAdditionalHeaderSegments()
```
    If this method returns true, it indicates that this derived AbstractMessageParser can contain one or more Additional Header Segments.
    
    Returns:
    Returns true, if this AbstractMessageParser object can contain one or more AHSs.
    See Also:
    AdditionalHeaderSegment
  - canHaveDigests
```
public boolean canHaveDigests()
```
    If this method returns true, then it indicates that this derived AbstractMessageParser instance can be protected by a digest.
    
    Returns:
    true, if the ProtocolDataUnit can be protected by a header and/or a data digest. Else false.
  - getShortInfo
```
public abstract String getShortInfo()
```
    Returns the short version of the used sequence numbers of this parser instance.
    
    Returns:
    The string with all needed sequence numbers.
  - toString
```
public String toString()
```
    This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The debug formatted string.
  - clear
```
public void clear()
```
    This method sets all settings to their initial values.
  - incrementSequenceNumber
```
public abstract boolean incrementSequenceNumber()
```
    This AbstractMessageParser instance affects the incrementation of a Sequence Number counter.
    
    Returns:
    true, if the counter has to be incremented.
  - getLogicalUnitNumber
```
public final long getLogicalUnitNumber()
```
    Returns the Logical Unit Number (LUN) of this AbstractMessageParser object.
    
    Returns:
    The Logical Unit Number of this object.
  - setLogicalUnitNumber
```
public final void setLogicalUnitNumber(long logicalUnitNumber)
```
    Set the Logical Unit Number (LUN) of this AbstractMessageParser object.
    
    Parameters:
    logicalUnitNumber - The Logical Unit Number of this object.
  - deserializeBytes1to3
```
protected abstract void deserializeBytes1to3(int line)
                                      throws InternetSCSIException
```
    Parse the bytes 1 till 3 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes8to11
```
protected void deserializeBytes8to11(int line)
                              throws InternetSCSIException
```
    Parse the bytes 8 till 11 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes12to15
```
protected void deserializeBytes12to15(int line)
                               throws InternetSCSIException
```
    Parse the bytes 12 till 15 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes20to23
```
protected abstract void deserializeBytes20to23(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 20 till 23 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes24to27
```
protected abstract void deserializeBytes24to27(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 24 till 27 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes28to31
```
protected abstract void deserializeBytes28to31(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 28 till 31 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes32to35
```
protected abstract void deserializeBytes32to35(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 32 till 35 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes36to39
```
protected abstract void deserializeBytes36to39(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 36 till 39 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes40to43
```
protected abstract void deserializeBytes40to43(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 40 till 43 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - deserializeBytes44to47
```
protected abstract void deserializeBytes44to47(int line)
                                        throws InternetSCSIException
```
    Parse the bytes 44 till 47 in the Basic Header Segment.
    
    Parameters:
    line - The actual line
    
    Throws:
    
    InternetSCSIException - If any violation of the iSCSI-Standard emerge.
  - serializeBytes1to3
```
protected abstract int serializeBytes1to3()
```
    Serializes the bytes 1 till 3 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes8to11
```
protected int serializeBytes8to11()
                           throws InternetSCSIException
```
    Serializes the bytes 8 till 11 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
    
    Throws:
    
    InternetSCSIException - if any violation of the iSCSI Standard (RFC3720) occurs.
  - serializeBytes12to15
```
protected int serializeBytes12to15()
```
    Serializes the bytes 12 till 15 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes20to23
```
protected abstract int serializeBytes20to23()
```
    Serializes the bytes 20 till 23 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes24to27
```
protected abstract int serializeBytes24to27()
```
    Serializes the bytes 24 till 27 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes28to31
```
protected abstract int serializeBytes28to31()
```
    Serializes the bytes 28 till 31 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes32to35
```
protected abstract int serializeBytes32to35()
```
    Serializes the bytes 32 till 35 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes36to39
```
protected abstract int serializeBytes36to39()
```
    Serializes the bytes 36 till 39 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes40to43
```
protected abstract int serializeBytes40to43()
```
    Serializes the bytes 40 till 43 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - serializeBytes44to47
```
protected abstract int serializeBytes44to47()
```
    Serializes the bytes 44 till 47 in the Basic Header Segment.
    
    Returns:
    The serialized byte representation.
  - checkIntegrity
```
protected abstract void checkIntegrity()
                                throws InternetSCSIException
```
    This method checks, if all parsed fields are valid. Because there are several fields, which are reserved for future versions, and these must be zero. Is this the case an exception will be thrown.
    
    Throws:
    
    InternetSCSIException - If the integrity is violated.

Class AbstractMessageParser

AbstractMessageParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

protocolDataUnit

logicalUnitNumber

Constructor Detail

AbstractMessageParser

Method Detail

getDataSegmentFormat

canContainAdditionalHeaderSegments

canHaveDigests

getShortInfo

toString

clear

incrementSequenceNumber

getLogicalUnitNumber

setLogicalUnitNumber

deserializeBytes1to3

deserializeBytes8to11

deserializeBytes12to15

deserializeBytes20to23

deserializeBytes24to27

deserializeBytes28to31

deserializeBytes32to35

deserializeBytes36to39

deserializeBytes40to43

deserializeBytes44to47

serializeBytes1to3

serializeBytes8to11

serializeBytes12to15

serializeBytes20to23

serializeBytes24to27

serializeBytes28to31

serializeBytes32to35

serializeBytes36to39

serializeBytes40to43

serializeBytes44to47

checkIntegrity