org.jscsi.utils

Class Utils

java.lang.Object

org.jscsi.utils.Utils

public final class Utils
extends Object

This class encapsulate all the needed common constants and methods with are needed by the used classes for the parsing and logging process. There are also common used bit masks for the extraction of the needed field in such a iSCSI message.

Author:

Volker Wildi, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIRST_BYTE_MASK Bit mask to extract the first byte of a 32 bit number.
static int	FOURTH_BYTE_MASK Bit mask to extract the fourth byte of a 32 bit number.
static String	LOG_OUT_INDENT Indent for each line (dependent of the level of indent).
static int	SECOND_BYTE_MASK Bit mask to extract the second byte of a 32 bit number.
static int	THIRD_BYTE_MASK Bit mask to extract the third byte of a 32 bit number.

Method Summary

Methods

Modifier and Type	Method and Description
static int	getUnsignedInt(byte b) This method converts a byte with the highest (sign) bit set, to an unsigned int value.
static long	getUnsignedLong(int i) This method converts an integer with the highest (sign) bit set, to an unsigned long value.
static long	getUnsignedLong(short i) This method converts an short integer with the highest (sign) bit set, to an unsigned long value.
static boolean	isBitSet(int num) Checks with a given int is unequal to zero.
static void	isExpected(int field, int expected) Checks for equality of a given value with the expected value.
static void	isReserved(long field) Method to guarantee that a given field is not zero.
static void	printField(StringBuilder sb, String fieldName, boolean fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.
static void	printField(StringBuilder sb, String fieldName, ByteBuffer fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.
static void	printField(StringBuilder sb, String fieldName, byte fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.
static void	printField(StringBuilder sb, String fieldName, int fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.
static void	printField(StringBuilder sb, String fieldName, long fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.
static void	printField(StringBuilder sb, String fieldName, String fieldValue, int indent) This methods creates an easy to use interface to print out a logging message of a specific variable.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_OUT_INDENT

public static final String LOG_OUT_INDENT

Indent for each line (dependent of the level of indent).

See Also:

Constant Field Values

FIRST_BYTE_MASK

public static final int FIRST_BYTE_MASK

Bit mask to extract the first byte of a 32 bit number.

See Also:

Constant Field Values

SECOND_BYTE_MASK

public static final int SECOND_BYTE_MASK

Bit mask to extract the second byte of a 32 bit number.

See Also:

Constant Field Values

THIRD_BYTE_MASK

public static final int THIRD_BYTE_MASK

Bit mask to extract the third byte of a 32 bit number.

See Also:

Constant Field Values

FOURTH_BYTE_MASK

public static final int FOURTH_BYTE_MASK

Bit mask to extract the fourth byte of a 32 bit number.

See Also:

Constant Field Values

Method Detail

isReserved

public static final void isReserved(long field)
                             throws InternetSCSIException

Method to guarantee that a given field is not zero.

Parameters:

field - Field to check

Throws:

InternetSCSIException - If the field is not reserved, then throw an exception

isExpected

public static final void isExpected(int field,
              int expected)
                             throws InternetSCSIException

Checks for equality of a given value with the expected value.

Parameters:

field - This value should be equal to the expected value

expected - This is what we expect

Throws:

InternetSCSIException - If this comparison failed, this exception will be thrown

isBitSet

public static final boolean isBitSet(int num)

Checks with a given int is unequal to zero.

Parameters:

num - Number to check

Returns:

Returns true if the line unequal than zero

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              String fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              int fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              long fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              byte fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              boolean fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

printField

public static final void printField(StringBuilder sb,
              String fieldName,
              ByteBuffer fieldValue,
              int indent)

This methods creates an easy to use interface to print out a logging message of a specific variable.

Parameters:

sb - StringBuilder to directly write the logging messages in.

fieldName - The name of the variable.

fieldValue - The value of the given variable.

indent - The level of indention.

getUnsignedInt

public static final int getUnsignedInt(byte b)

This method converts a byte with the highest (sign) bit set, to an unsigned int value.

Parameters:

b - The signed byte number.

Returns:

The unsigned int number.

getUnsignedLong

public static final long getUnsignedLong(int i)

This method converts an integer with the highest (sign) bit set, to an unsigned long value.

Parameters:

i - The signed int number.

Returns:

The unsigned long number.

getUnsignedLong

public static final long getUnsignedLong(short i)

This method converts an short integer with the highest (sign) bit set, to an unsigned long value.

Parameters:

i - The signed integer number.

Returns:

The unsigned long number.