org.jscsi.target.settings.entry

Class StringEntry

java.lang.Object

org.jscsi.target.settings.entry.Entry

org.jscsi.target.settings.entry.StringEntry

public final class StringEntry
extends Entry

This Entry sub-class is used for managing and negotiation String parameters. The value part of the corresponding key-value pairs can be made up of one or several comma-separated strings.

The default or negotiated value can be accessed via the getStringValue() method.

Author:

Andreas Ergenzinger

See Also:

Entry

Field Summary

Fields inherited from class org.jscsi.target.settings.entry.Entry

alreadyNegotiated, keySet, negotiationStatus, negotiationType, use, value

Constructor Summary

Constructors

Constructor and Description
StringEntry(KeySet keySet, NegotiationType negotiationType, Use use, NegotiationStatus negotiationStatus, String[] supportedValues, Object defaultValue) The StringEntry constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Entry	copy() Returns an exact copy of this Entry.
String	getStringValue() Returns the negotiated (or default) value as a String.
protected boolean	inProtocolValueRange(Object values) This method is used for checking if a sub-class-specific Object, representing a single, a range, or a list of values sent by the initiator, is illegal, according to the iSCSI standard.
protected Object	parseOffer(TargetServer target, String values) Parses the passed String parameter and returns a sub-class-specific Object which represents the the specified value part a key=value pair.
protected void	processDeclaration(Object values) Receives a sub-class-specific Object, representing a legal parameter value declared by the initiator and accepts it as the new Entry.value.
protected String	processNegotiation(Object values) Receives a sub-class-specific Object, representing a list, a range, or a single legal parameter value offered by the initiator and tries to select a value from that offer.

Methods inherited from class org.jscsi.target.settings.entry.Entry

checkAccepted, getBooleanValue, getIntegerValue, getNegotiationStatus, matchKey, negotiate, resetAlreadyNegotiated

Methods inherited from class java.lang.Object

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

Constructor Detail

StringEntry

public StringEntry(KeySet keySet,
           NegotiationType negotiationType,
           Use use,
           NegotiationStatus negotiationStatus,
           String[] supportedValues,
           Object defaultValue)

The StringEntry constructor.

Parameters:

keySet - contains all relevant keys

negotiationType - declared or negotiated

use - determines under which circumstances the parameter may be negotiated

negotiationStatus - indicates whether there is a default value or if the parameter must be negotiated

supportedValues - all values supported by the jSCSI Target

defaultValue - the default value or null

Method Detail

inProtocolValueRange

protected boolean inProtocolValueRange(Object values)

Description copied from class: Entry

This method is used for checking if a sub-class-specific Object, representing a single, a range, or a list of values sent by the initiator, is illegal, according to the iSCSI standard.

Specified by:

inProtocolValueRange in class Entry

Parameters:

values - a sub-class-specific Object, representing a single, a range, or a list of values sent by the initiator

Returns:

false if the iSCSI standard has been violated, true if not

parseOffer

protected Object parseOffer(TargetServer target,
                String values)

Description copied from class: Entry

Parses the passed String parameter and returns a sub-class-specific Object which represents the the specified value part a key=value pair.

Specified by:

parseOffer in class Entry

values - the value part of a key=value pair

Returns:

sub-class-specific Object or null if the parameter violated the expected format

processDeclaration

protected void processDeclaration(Object values)

Description copied from class: Entry

Receives a sub-class-specific Object, representing a legal parameter value declared by the initiator and accepts it as the new Entry.value.

Specified by:

processDeclaration in class Entry

Parameters:

values - sub-class-specific representation of a single value declared by the initiator

processNegotiation

protected String processNegotiation(Object values)

Description copied from class: Entry

Receives a sub-class-specific Object, representing a list, a range, or a single legal parameter value offered by the initiator and tries to select a value from that offer. If none of the offered values is supported by the jSCSI Target, null is returned, otherwise the selection is accepted as the new Entry.value and returned as a String. Entry.value.

Specified by:

processNegotiation in class Entry

Parameters:

values - a sub-class-specific Object, representing a list, a range, or a single legal parameter value offered by the initiator

Returns:

the final, negotiated value or null, if the initiator's offer does not overlap with the values supported by the jSCSI Target

getStringValue

public String getStringValue()

Description copied from class: Entry

Returns the negotiated (or default) value as a String.

Overrides:

getStringValue in class Entry

Returns:

the negotiated (or default) value as a String

copy

public Entry copy()

Description copied from class: Entry

Returns an exact copy of this Entry.

Specified by:

copy in class Entry

Returns:

a copy of this Entry.