org.jscsi.parser.scsi

Enum SCSIStatus

java.lang.Object

java.lang.Enum<SCSIStatus>

org.jscsi.parser.scsi.SCSIStatus

All Implemented Interfaces:

Serializable, Comparable<SCSIStatus>

public enum SCSIStatus
extends Enum<SCSIStatus>

SCSIStatus

This enumerations defines all valid stati, which are defined in the iSCSI Standard (RFC 3720) and the SCSI Architecture Model 2 [SAM2].

Status Code	Status	Task Ended	Service Response
00h	GOOD	Yes	TASK COMPLETE
02h	CHECK CONDITION	Yes	TASK COMPLETE
04h	CONDITION MET	Yes	TASK COMPLETE
08h	BUSY	Yes	TASK COMPLETE
10h	INTERMEDIATE	No	LINKED COMMAND COMPLETE
14h	INTERMEDIATE-CONDITION MET	No	LINKED COMMAND COMPLETE
18h	RESERVATION CONFLICT	Yes	TASK COMPLETE
22h	Obsolete
28h	TASK SET FULL	Yes	TASK COMPLETE
30h	ACA ACTIVE	Yes	TASK COMPLETE
40h	TASK ABORTED	Yes	TASK COMPLETE

All other codes are reserved.

Author:

Volker Wildi

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACA_ACTIVE This status shall be returned when an ACA exists within a task set and a SCSI initiator port issues a command for that task set when at least one of the following is true: There is a task with the ACA attribute (see 7.5.4)[SAM2] in the task set; The SCSI initiator port issuing the command did not cause the ACA condition; or The task created to process the command did not have the ACA attribute and the NACA bit was set to one in the CDB CONTROL byte of the faulting command (see 5.9.1)[SAM2]. The SCSI initiator port may reissue the command after the ACA condition has been cleared.
BUSY This status indicates that the logical unit is busy.
CHECK_CONDITION This status indicates that an CA or ACA condition has occurred (see 5.9.1).
CONDITION_MET This status shall be returned whenever the requested operation specified by an unlinked command is satisfied (see the PRE-FETCH commands in the SBC standard).
GOOD This status indicates that the device server has successfully completed the task.
INTERMEDIATE This status or INTERMEDIATE-CONDITION MET shall be returned for each successfully completed command in a series of linked commands (except the last command), unless the command is termi- nated with CHECK CONDITION, RESERVATION CONFLICT, TASK SET FULL, or BUSY status.
INTERMEDIATE_CONDITION_MET This status is returned whenever the requested operation specified by a linked command is satisfied (see the PRE-FETCH commands in the SBC standard), unless the command is termi- nated with CHECK CONDITION, RESERVATION CONFLICT, TASK SET FULL, or BUSY status.
RESERVATION_CONFLICT This status shall be returned whenever a SCSI initiator port attempts to access a logical unit or an element of a logical unit in a way that conflicts with an existing reservation.
TASK_ABORTED This status shall be returned when a task is aborted by another SCSI initiator port and the Control mode page TAS bit is set to one (see 5.7.3)[SAM2].
TASK_SET_FULL This status shall be implemented if the logical unit supports the creation of tagged tasks (see 4.10)[SAM2].

Method Summary

Methods

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

GOOD

public static final SCSIStatus GOOD

This status indicates that the device server has successfully completed the task.

CHECK_CONDITION

public static final SCSIStatus CHECK_CONDITION

This status indicates that an CA or ACA condition has occurred (see 5.9.1). Autosense data may be delivered (see 5.9.4.3)[SAM2].

CONDITION_MET

public static final SCSIStatus CONDITION_MET

This status shall be returned whenever the requested operation specified by an unlinked command is satisfied (see the PRE-FETCH commands in the SBC standard).

BUSY

public static final SCSIStatus BUSY

This status indicates that the logical unit is busy. This status shall be returned whenever a logical unit is temporarily unable to accept a command. The recommended application client recovery action is to issue the command again at a later time. If the UA_INTLCK_CTRL field in the Control mode page contains 11b (see SPC-3), termination of a command with BUSY status shall cause an unit attention condition to be established for the SCSI initiator port that sent the command with an additional sense code of PREVIOUS BUSY STATUS unless a PREVIOUS BUSY STATUS unit attention condition already exists.

INTERMEDIATE

public static final SCSIStatus INTERMEDIATE

This status or INTERMEDIATE-CONDITION MET shall be returned for each successfully completed command in a series of linked commands (except the last command), unless the command is termi- nated with CHECK CONDITION, RESERVATION CONFLICT, TASK SET FULL, or BUSY status. If INTERME- DIATE or INTERMEDIATE-CONDITION MET status is not returned, the series of linked commands is terminated and the task is ended. This status is the equivalent of GOOD status for linked commands.

INTERMEDIATE_CONDITION_MET

public static final SCSIStatus INTERMEDIATE_CONDITION_MET

This status is returned whenever the requested operation specified by a linked command is satisfied (see the PRE-FETCH commands in the SBC standard), unless the command is termi- nated with CHECK CONDITION, RESERVATION CONFLICT, TASK SET FULL, or BUSY status. If INTERME- DIATE or INTERMEDIATE-CONDITION MET status is not returned, the series of linked commands is terminated and the task is ended.

RESERVATION_CONFLICT

public static final SCSIStatus RESERVATION_CONFLICT

This status shall be returned whenever a SCSI initiator port attempts to access a logical unit or an element of a logical unit in a way that conflicts with an existing reservation. (See the RESERVE, RELEASE, PERSISTENT RESERVE OUT and PERSISTENT RESERVE IN commands in SPC-2).

If the UA_INTLCK_CTRL field in the Control mode page contains 11b (see SPC-3), termination of a command with RESERVATION CONFLICT status shall cause an unit attention condition to be established for the SCSI initiator port that sent the command with an additional sense code of PREVIOUS RESERVATION CONFLICT STATUS unless a PREVIOUS RESERVATION CONFLICT STATUS unit attention condition already exists.

TASK_SET_FULL

public static final SCSIStatus TASK_SET_FULL

This status shall be implemented if the logical unit supports the creation of tagged tasks (see 4.10)[SAM2]. This status shall not be implemented if the logical unit does not support the creation of tagged tasks.

When the logical unit has at least one task in the task set for a SCSI initiator port and a lack of task set resources prevents accepting a received tagged task from that SCSI initiator port into the task set, TASK SET FULL shall be returned. When the logical unit has no task in the task set for a SCSI initiator port and a lack of task set resources prevents accepting a received tagged task from that SCSI initiator port into the task set, BUSY should be returned.

When the logical unit has at least one task in the task set and a lack of task set resources prevents accepting a received untagged task into the task set, BUSY should be returned.

The logical unit should allow at least one command in the task set for each supported SCSI initiator port that has identified itself to the SCSI target port by a SCSI transport protocol specific procedure or by the successful trans- mission of a command.

If the UA_INTLCK_CTRL field in the Control mode page contains 11b (see SPC-3), termination of a command with TASK SET FULL status shall cause an unit attention condition to be established for the SCSI initiator port that sent the command with an additional sense code of PREVIOUS TASK SET FULL STATUS unless a PREVIOUS TASK SET FULL STATUS unit attention condition already exists.

ACA_ACTIVE

public static final SCSIStatus ACA_ACTIVE

This status shall be returned when an ACA exists within a task set and a SCSI initiator port issues a command for that task set when at least one of the following is true:

1. There is a task with the ACA attribute (see 7.5.4)[SAM2] in the task set;
2. The SCSI initiator port issuing the command did not cause the ACA condition; or
3. The task created to process the command did not have the ACA attribute and the NACA bit was set to one in the CDB CONTROL byte of the faulting command (see 5.9.1)[SAM2].

The SCSI initiator port may reissue the command after the ACA condition has been cleared.

TASK_ABORTED

public static final SCSIStatus TASK_ABORTED

This status shall be returned when a task is aborted by another SCSI initiator port and the Control mode page TAS bit is set to one (see 5.7.3)[SAM2].

Method Detail

values

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

Returns:

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

valueOf

public static SCSIStatus 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 byte value()

Returns the value of this enumeration.

Returns:

The value of this enumeration.

valueOf

public static final SCSIStatus valueOf(byte 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.