org.jscsi.target.settings.entry

Enum Use

java.lang.Object

java.lang.Enum<Use>

org.jscsi.target.settings.entry.Use

All Implemented Interfaces:

Serializable, Comparable<Use>

public enum Use
extends Enum<Use>

Instances of this class are used by Entry objects to determine during which circumstances a parameter may be negotiated or declared.

The factors to consider are:

• the current stage of the connection
• whether that connection is the leading connection, i.e. the initial connection in the enclosing session.
• if the key-value pair relating to the parameter was part of the first ProtocolDataUnit sent over the connection

Author:

Andreas Ergenzinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
FFP The parameter may be negotiated by any connection in the Full Feature Phase (specifically the TextNegotiationStage).
INITIAL The parameter may only be declared in the initial ProtocolDataUnit.
INITIAL_AND_FFP The parameter may only be declared in the initial ProtocolDataUnit or by any PDU sent as part of the TextNegotiationStage in the Full Feature Phase.
LEADING_LOPNS The parameter may be negotiated by a leading connection in the LoginOperationalParameterNegotiationStage only.
LOPNS The parameter may be negotiated by any connection in the LoginOperationalParameterNegotiationStage.
LOPNS_AND_FFP The parameter may be negotiated by any connection in the LoginOperationalParameterNegotiationStage or in the Full Feature Phase (specifically the TextNegotiationStage).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkUse(org.jscsi.parser.login.LoginStage loginStage, boolean leadingConnection, boolean initialPdu) This method can be used for checking if this Use instance permits negotiating its associated parameter given a situation described by the passed parameters.
static Use	valueOf(String name) Returns the enum constant of this type with the specified name.
static Use[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEADING_LOPNS

public static final Use LEADING_LOPNS

The parameter may be negotiated by a leading connection in the LoginOperationalParameterNegotiationStage only.

LOPNS

public static final Use LOPNS

The parameter may be negotiated by any connection in the LoginOperationalParameterNegotiationStage.

LOPNS_AND_FFP

public static final Use LOPNS_AND_FFP

The parameter may be negotiated by any connection in the LoginOperationalParameterNegotiationStage or in the Full Feature Phase (specifically the TextNegotiationStage).

FFP

public static final Use FFP

The parameter may be negotiated by any connection in the Full Feature Phase (specifically the TextNegotiationStage).

INITIAL

public static final Use INITIAL

The parameter may only be declared in the initial ProtocolDataUnit.

INITIAL_AND_FFP

public static final Use INITIAL_AND_FFP

The parameter may only be declared in the initial ProtocolDataUnit or by any PDU sent as part of the TextNegotiationStage in the Full Feature Phase.

Method Detail

values

public static Use[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Use c : Use.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Use valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

checkUse

public boolean checkUse(org.jscsi.parser.login.LoginStage loginStage,
               boolean leadingConnection,
               boolean initialPdu)

This method can be used for checking if this Use instance permits negotiating its associated parameter given a situation described by the passed parameters.

Parameters:

loginStage - specifies the stage of phase

leadingConnection - true if and only if the connection is the leading connection of its session

initialPdu - true if and only if the ProtocolDataUnit is the first PDU sent over the connection

Returns:

true if and only if all requirements of this Use instance have been met