org.jscsi.target.settings.entry

Class Entry

java.lang.Object

org.jscsi.target.settings.entry.Entry

Direct Known Subclasses:

BooleanEntry, NumericalEntry, NumericalRangeEntry, StringEntry

public abstract class Entry
extends Object

Entry objects are used by instances SettingsNegotiator during text negotiation of connection and session parameter. For all parameters that are either declared by the iSCSI initiator or negotiated between the initiator and the target a separate Entry takes care of processing the respective key=value pair and returning the negotiated value, if appropriate.

For brevity, the term "negotiated" will be used in the following in a way that can either mean "declared or negotiated", unless the distinction is evident by context.

Author:

Andreas Ergenzinger, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alreadyNegotiated This variable is used to detect illegal attempts to renegotiate a previously negotiated or declared text parameter.
protected KeySet	keySet A KeySet containing all keys that can be used for negotiating this Entry's value.
protected NegotiationStatus	negotiationStatus This variable specifies the progress and necessity of negotiating the parameter managed by this Entry.
protected NegotiationType	negotiationType Specifies if the Entry's parameter is declared or negotiated.
protected Use	use Determines during which stages this Entry's parameters may be negotiated.
protected Object	value The currently valid value or null.

Constructor Summary

Constructors

Constructor and Description
Entry(KeySet keySet, NegotiationType negotiationType, Use use, NegotiationStatus negotiationStatus, Object defaultValue) Abstract constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAccepted() Returns true if negotiationStatus is NegotiationStatus.ACCEPTED and false if it is not.
abstract Entry	copy() Returns an exact copy of this Entry.
Boolean	getBooleanValue() Returns the negotiated (or default) value as a Boolean.
Integer	getIntegerValue() Returns the negotiated (or default) value as an Integer.
NegotiationStatus	getNegotiationStatus() Returns negotiationStatus.
String	getStringValue() Returns the negotiated (or default) value as a String.
protected abstract 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.
boolean	matchKey(String key) Returns true if one of the keys of keySet equals the parameter and false if there is not match.
boolean	negotiate(TargetServer target, org.jscsi.parser.login.LoginStage loginStage, boolean leadingConnection, boolean initialPdu, String key, String values, Collection<String> responseKeyValuePairs) This method is used for negotiating or declaring the Entry's parameter.
protected abstract 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 abstract 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 value.
protected abstract 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.
void	resetAlreadyNegotiated() Sets alreadyNegotiated back to false.

Methods inherited from class java.lang.Object

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

Field Detail

keySet

protected final KeySet keySet

A KeySet containing all keys that can be used for negotiating this Entry's value.

negotiationType

protected final NegotiationType negotiationType

Specifies if the Entry's parameter is declared or negotiated.

use

protected final Use use

Determines during which stages this Entry's parameters may be negotiated.

negotiationStatus

protected NegotiationStatus negotiationStatus

This variable specifies the progress and necessity of negotiating the parameter managed by this Entry.

value

protected Object value

The currently valid value or null.

alreadyNegotiated

protected boolean alreadyNegotiated

This variable is used to detect illegal attempts to renegotiate a previously negotiated or declared text parameter.

This variable will be set back to false after each negotiation task (login phase, or text parameter negotiation stage). Renegotiation accross stages/tasks can be prevented by initializing the use variable accordingly.

See Also:

resetAlreadyNegotiated()

Constructor Detail

Entry

public Entry(KeySet keySet,
     NegotiationType negotiationType,
     Use use,
     NegotiationStatus negotiationStatus,
     Object defaultValue)

Abstract 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

defaultValue - the default value or null

Method Detail

parseOffer

protected abstract 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.

Parameters:

values - the value part of a key=value pair

Returns:

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

negotiate

public final boolean negotiate(TargetServer target,
                org.jscsi.parser.login.LoginStage loginStage,
                boolean leadingConnection,
                boolean initialPdu,
                String key,
                String values,
                Collection<String> responseKeyValuePairs)

This method is used for negotiating or declaring the Entry's parameter.

Parameters:

loginStage - specifying the current stage or phase of the connection whose parameters are to be negotiated

leadingConnection - true if the connection is the first connection in its session, false if not

initialPdu - true if the key=value pair parameters have been sent in the first login ProtocolDataUnit from the initiator, false if thy have not

key - the key part from the received key=value pair

values - the value part from the received key=value pair

responseKeyValuePairs - where the reply key=value pair will be added to if necessary

Returns:

true if everything went fine, false if errors occured

resetAlreadyNegotiated

public void resetAlreadyNegotiated()

Sets alreadyNegotiated back to false.

This method must be used at the end of each negotiation task, i.e. at the end of the login phase and the FFP text negotiation stage.

getBooleanValue

public Boolean getBooleanValue()
                        throws OperationNotSupportedException

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

Returns:

the negotiated (or default) value as a Boolean

Throws:

OperationNotSupportedException - if value is not of the boolean type

getIntegerValue

public Integer getIntegerValue()
                        throws OperationNotSupportedException

Returns the negotiated (or default) value as an Integer.

Returns:

the negotiated (or default) value as an Integer

Throws:

OperationNotSupportedException - if value is not of the integer type

getStringValue

public String getStringValue()
                      throws OperationNotSupportedException

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

Returns:

the negotiated (or default) value as a String

Throws:

OperationNotSupportedException - if value is not a String

matchKey

public final boolean matchKey(String key)

Returns true if one of the keys of keySet equals the parameter and false if there is not match.

Parameters:

key - the key to compare to the keySet keys

Returns:

true if one of the keys of keySet equals the parameter and false if not

inProtocolValueRange

protected abstract 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.

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

processDeclaration

protected abstract 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 value.

Parameters:

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

processNegotiation

protected abstract 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. If none of the offered values is supported by the jSCSI Target, null is returned, otherwise the selection is accepted as the new value and returned as a String. value.

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

getNegotiationStatus

public final NegotiationStatus getNegotiationStatus()

Returns negotiationStatus.

Returns:

negotiationStatus

copy

public abstract Entry copy()

Returns an exact copy of this Entry.

Returns:

a copy of this Entry.

checkAccepted

public boolean checkAccepted()

Returns true if negotiationStatus is NegotiationStatus.ACCEPTED and false if it is not.

Returns:

true if negotiationStatus is NegotiationStatus.ACCEPTED, false if not