org.jscsi.parser.login

Enum LoginStatus

java.lang.Object

java.lang.Enum<LoginStatus>

org.jscsi.parser.login.LoginStatus

All Implemented Interfaces:

Serializable, Comparable<LoginStatus>

public enum LoginStatus
extends Enum<LoginStatus>

LoginStatus

This enumeration contains only all defined Login Stati, which can send in a login response message in the iSCSI Protocol (RFC3720).

0	Success - indicates that the iSCSI target successfully received, understood, and accepted the request. The numbering fields ( StatSN, ExpCmdSN, MaxCmdSN) are only valid if Status-Class is 0.
1	Redirection - indicates that the initiator must take further action to complete the request. This is usually due to the target moving to a different address. All of the redirection status class responses MUST return one or more text key parameters of the type "TargetAddress", which indicates the target's new address. A redirection response MAY be issued by a target prior or after completing a security negotiation if a security negotiation is required. A redirection SHOULD be accepted by an initiator even without having the target complete a security negotiation if any security negotiation is required, and MUST be accepted by the initiator after the completion of the security negotiation if any security negotiation is required.
2	Initiator Error (not a format error) - indicates that the initiator most likely caused the error. This MAY be due to a request for a resource for which the initiator does not have permission. The request should not be tried again.
3	Target Error - indicates that the target sees no errors in the initiator’s Login Request, but is currently incapable of fulfilling the request. The initiator may re-try the same Login Request later. The table below shows all of the currently allocated status codes. The codes are in hexadecimal; the first byte is the status class and the second byte is the status detail.

Author:

Volker Wildi

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATION_FAILURE The initiator could not be successfully authenticated or target authentication is not supported.
AUTHORIZATION_FAILURE The initiator is not allowed access to the given target.
CANNOT_INCLUDE_IN_SESSION Target does not support session spanning to this connection (address).
INITIATOR_ERROR Miscellaneous iSCSI initiator errors.
INVALID_DURING_LOGIN Invalid Request type during Login.
MISSING_PARAMETER Missing parameters (e.g., iSCSI Initiator and/or Target Name).
NOT_FOUND The requested ITN does not exist at this address.
OUT_OF_RESOURCES The target has insufficient session, connection, or other resources.
SERVICE_UNAVAILABLE The iSCSI service or target is not currently operational.
SESSION_DOSE_NOT_EXIST Attempt to add a connection to a non-existent session.
SESSION_TYPE_NOT_SUPPORTED Target does not support this type of of session or not from this Initiator.
SUCCESS Login is proceeding OK.
TARGET_ERROR Target hardware or software error.
TARGET_MOVED The requested ITN has permanently moved permanently to the address provided.
TARGET_MOVED_TEMPORARILY The requested iSCSI Target Name (ITN) has temporarily moved to the address provided.
TARGET_REMOVED The requested ITN has been removed and no forwarding address is provided.
TOO_MANY_CONNECTIONS Too many connections on this SSID.
UNSUPPORTED_VERSION The requested iSCSI version range is not supported by the target.

Method Summary

Methods

Modifier and Type	Method and Description
short	value() Returns the value of this enumeration.
static LoginStatus	valueOf(short value) Returns the constant defined for the given value.
static LoginStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static LoginStatus[]	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

SUCCESS

public static final LoginStatus SUCCESS

Login is proceeding OK.

If the response T bit is 1 in both the request and the matching response, and the NSG is FullFeaturePhase in both the request and the matching response, the Login Phase is finished and the initiator may proceed to issue SCSI commands.

TARGET_MOVED_TEMPORARILY

public static final LoginStatus TARGET_MOVED_TEMPORARILY

The requested iSCSI Target Name (ITN) has temporarily moved to the address provided.

TARGET_MOVED

public static final LoginStatus TARGET_MOVED

The requested ITN has permanently moved permanently to the address provided.

INITIATOR_ERROR

public static final LoginStatus INITIATOR_ERROR

Miscellaneous iSCSI initiator errors.

AUTHENTICATION_FAILURE

public static final LoginStatus AUTHENTICATION_FAILURE

The initiator could not be successfully authenticated or target authentication is not supported.

AUTHORIZATION_FAILURE

public static final LoginStatus AUTHORIZATION_FAILURE

The initiator is not allowed access to the given target.

NOT_FOUND

public static final LoginStatus NOT_FOUND

The requested ITN does not exist at this address.

TARGET_REMOVED

public static final LoginStatus TARGET_REMOVED

The requested ITN has been removed and no forwarding address is provided.

UNSUPPORTED_VERSION

public static final LoginStatus UNSUPPORTED_VERSION

The requested iSCSI version range is not supported by the target.

TOO_MANY_CONNECTIONS

public static final LoginStatus TOO_MANY_CONNECTIONS

Too many connections on this SSID.

MISSING_PARAMETER

public static final LoginStatus MISSING_PARAMETER

Missing parameters (e.g., iSCSI Initiator and/or Target Name).

CANNOT_INCLUDE_IN_SESSION

public static final LoginStatus CANNOT_INCLUDE_IN_SESSION

Target does not support session spanning to this connection (address).

SESSION_TYPE_NOT_SUPPORTED

public static final LoginStatus SESSION_TYPE_NOT_SUPPORTED

Target does not support this type of of session or not from this Initiator.

SESSION_DOSE_NOT_EXIST

public static final LoginStatus SESSION_DOSE_NOT_EXIST

Attempt to add a connection to a non-existent session.

INVALID_DURING_LOGIN

public static final LoginStatus INVALID_DURING_LOGIN

Invalid Request type during Login.

TARGET_ERROR

public static final LoginStatus TARGET_ERROR

Target hardware or software error.

SERVICE_UNAVAILABLE

public static final LoginStatus SERVICE_UNAVAILABLE

The iSCSI service or target is not currently operational.

OUT_OF_RESOURCES

public static final LoginStatus OUT_OF_RESOURCES

The target has insufficient session, connection, or other resources.

Method Detail

values

public static LoginStatus[] 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 (LoginStatus c : LoginStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static LoginStatus 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

value

public final short value()

Returns the value of this enumeration.

Returns:

The value of this enumeration.

valueOf

public static final LoginStatus valueOf(short value)

Returns the constant defined for the given value.

Parameters:

value - The value to search for.

Returns:

The constant defined for the given value. Or null, if this value is not defined by this enumeration.