org.jscsi.target

Class Configuration

java.lang.Object

org.jscsi.target.Configuration

public class Configuration
extends Object

Instances of Configuration provides access target-wide parameters, variables that are the same across all sessions and connections that do not change after initialization and which play a role during text parameter negotiation. Some of these parameters are provided or can be overridden by the content of an XML file - jscsi-target.xml.

Author:

Andreas Ergenzinger, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowSloppyNegotiation This variable toggles the strictness with which the parameters IFMarkInt and OFMarkInt are processed, when provided by the initiator.
static String	ATTRIBUTE_SIZE
static File	CONFIGURATION_CONFIG_FILE The file name, which contains all global settings.
static File	CONFIGURATION_SCHEMA_FILE The file name of the XML Schema configuration file for the global settings.
static String	ELEMENT_ALLOWSLOPPYNEGOTIATION
static String	ELEMENT_CREATE
static String	ELEMENT_PORT
static String	ELEMENT_SYNCFILESTORAGE
static String	ELEMENT_TARGET
static String	ELEMENT_TARGET_LIST
protected LogicalUnitNumber	logicalUnitNumber The Logical Unit Number of the virtual Logical Unit.
protected int	outMaxRecvDataSegmentLength The MaxRecvDataSegmentLength parameter for PDUs sent in the out direction (i.e.
protected int	port The port used by the jSCSI Target for listening for new connections.
protected String	targetAddress The TargetAddress parameter (the jSCSI Target's IP address).
protected int	targetPortalGroupTag The TargetPortalGroupTag parameter.
protected List<Target>	targets

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
protected static Node	chopWhiteSpaces(Node node)
static Configuration	create()
static Configuration	create(File schemaLocation, File configFile) Reads the given configuration file in memory and creates a DOM representation.
boolean	getAllowSloppyNegotiation()
int	getInMaxRecvTextPduSequenceLength()
LogicalUnitNumber	getLogicalUnitNumber()
int	getOutMaxRecvDataSegmentLength()
int	getPort()
String	getTargetAddress()
int	getTargetPortalGroupTag()
List<Target>	getTargets()
protected static Target	parseTargetElement(Element targetElement)

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_TARGET_LIST

public static final String ELEMENT_TARGET_LIST

See Also:

Constant Field Values

ELEMENT_TARGET

public static final String ELEMENT_TARGET

See Also:

Constant Field Values

ELEMENT_SYNCFILESTORAGE

public static final String ELEMENT_SYNCFILESTORAGE

See Also:

Constant Field Values

ELEMENT_CREATE

public static final String ELEMENT_CREATE

See Also:

Constant Field Values

ATTRIBUTE_SIZE

public static final String ATTRIBUTE_SIZE

See Also:

Constant Field Values

ELEMENT_ALLOWSLOPPYNEGOTIATION

public static final String ELEMENT_ALLOWSLOPPYNEGOTIATION

See Also:

Constant Field Values

ELEMENT_PORT

public static final String ELEMENT_PORT

See Also:

Constant Field Values

CONFIGURATION_SCHEMA_FILE

public static final File CONFIGURATION_SCHEMA_FILE

The file name of the XML Schema configuration file for the global settings.

CONFIGURATION_CONFIG_FILE

public static final File CONFIGURATION_CONFIG_FILE

The file name, which contains all global settings.

targets

protected final List<Target> targets

targetAddress

protected String targetAddress

The TargetAddress parameter (the jSCSI Target's IP address).

This parameter is initialized automatically.

port

protected int port

The port used by the jSCSI Target for listening for new connections.

The default port number is 3260. This value may be overridden by specifying a different value in the configuration file.

allowSloppyNegotiation

protected boolean allowSloppyNegotiation

This variable toggles the strictness with which the parameters IFMarkInt and OFMarkInt are processed, when provided by the initiator. Usually the offered values must have to following format: smallInteger~largeInteger, however the jSCSI Initiator sends only single integers as value part of the key-value pairs. Since the value of these two parameters always are Irrelevant, this bug can be ignored without any negative consequences by setting allowSloppyNegotiation to true in the configuration file. The default is false.

targetPortalGroupTag

protected final int targetPortalGroupTag

The TargetPortalGroupTag parameter.

See Also:

Constant Field Values

logicalUnitNumber

protected final LogicalUnitNumber logicalUnitNumber

The Logical Unit Number of the virtual Logical Unit.

outMaxRecvDataSegmentLength

protected final int outMaxRecvDataSegmentLength

The MaxRecvDataSegmentLength parameter for PDUs sent in the out direction (i.e. initiator to target).

Since the value of this variable is equal to the specified default value, it does not have to be declared during login.

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()
              throws IOException

Throws:

IOException

Method Detail

getInMaxRecvTextPduSequenceLength

public int getInMaxRecvTextPduSequenceLength()

getOutMaxRecvDataSegmentLength

public int getOutMaxRecvDataSegmentLength()

getTargetAddress

public String getTargetAddress()

getPort

public int getPort()

getAllowSloppyNegotiation

public boolean getAllowSloppyNegotiation()

getTargetPortalGroupTag

public int getTargetPortalGroupTag()

getLogicalUnitNumber

public LogicalUnitNumber getLogicalUnitNumber()

getTargets

public List<Target> getTargets()

create

public static Configuration create()
                            throws SAXException,
                                   ParserConfigurationException,
                                   IOException

Throws:

SAXException

ParserConfigurationException

IOException

create

public static Configuration create(File schemaLocation,
                   File configFile)
                            throws SAXException,
                                   ParserConfigurationException,
                                   IOException

Reads the given configuration file in memory and creates a DOM representation.

Throws:

SAXException - If this operation is supported but failed for some reason.

ParserConfigurationException - If a DocumentBuilder cannot be created which satisfies the configuration requested.

IOException - If any IO errors occur.

parseTargetElement

protected static Target parseTargetElement(Element targetElement)
                                    throws IOException

Throws:

IOException

chopWhiteSpaces

protected static Node chopWhiteSpaces(Node node)