Coverage Report

Coverage Report - org.jscsi.target.scsi.sense.DescriptorFormatSenseData

Classes in this File

Line Coverage

Branch Coverage

Complexity

DescriptorFormatSenseData

0/25

0/12

2.5

 package org.jscsi.target.scsi.sense;
 
 
 import java.nio.ByteBuffer;
 
 import org.jscsi.target.scsi.sense.senseDataDescriptor.SenseDataDescriptor;
 import org.jscsi.target.util.BitManip;
 import org.jscsi.target.util.ReadWrite;
 
 
 /**
  * Instances of this class represent sense data using the descriptor format.
  * 
  * @see SenseDataFormat#DESCRIPTOR
  * @author Andreas Ergenzinger
  */
 public final class DescriptorFormatSenseData extends SenseData {
 
     /**
      * The length in bytes of all fixed fields of descriptor format sense data.
      */
     private static final int HEADER_LENGTH = 8;
 
     /**
      * The byte position of the ADDITIONAL SENSE CODE field.
      */
     private static final int ADDITIONAL_SENSE_CODE_INDEX = 2;
 
     /**
      * The position of the first reserved byte.
      * 
      * @see #RESERVED_BYTES_MAX_INDEX
      */
     private static final int RESERVED_BYTES_MIN_INDEX = 4;
 
     /**
      * The position of the last reserved byte.
      * 
      * @see #RESERVED_BYTES_MIN_INDEX
      */
     private static final int RESERVED_BYTES_MAX_INDEX = 6;
 
     /**
      * The position of the ADDITIONAL SENSE LENGTH field.
      */
     private static final int ADDITIONAL_SENSE_LENGTH_INDEX = 7;
 
     /**
      * All sense data descriptors that are a part of this sense data object.
      */
     private final SenseDataDescriptor[] senseDataDescriptors;
 
     /**
      * The constructor.
      * 
      * @param errorType the error type
      * @param senseKey a general description of what caused the error
      * @param additionalSenseCodeAndQualifier a more specific description of the error
      * @param senseDataDescriptors more specific error information
      */
     public DescriptorFormatSenseData (final ErrorType errorType, final SenseKey senseKey, AdditionalSenseCodeAndQualifier additionalSenseCodeAndQualifier, SenseDataDescriptor... senseDataDescriptors) {
         super(errorType, SenseDataFormat.DESCRIPTOR, senseKey, additionalSenseCodeAndQualifier);
         this.senseDataDescriptors = senseDataDescriptors;
     }
 
     public void serialize (ByteBuffer byteBuffer, int index) {
 
         byteBuffer.position(index);
 
         // response code and valid
         byte b = (byte) getReponseCodeFor(errorType, SenseDataFormat.DESCRIPTOR);
         b = BitManip.getByteWithBitSet(b, 7, false);// bit 7 is reserved
         byteBuffer.put(b);// index
 
         // sense key
         b = (byte) (senseKey.getValue() & 15);
         byteBuffer.put(b);// index + 1
 
         // additional sense code and additional sense code qualifier
         ReadWrite.writeTwoByteInt(byteBuffer, additionalSenseCodeAndQualifier.getValue(), index + ADDITIONAL_SENSE_CODE_INDEX);
 
         // bytes 4-6 are reserved
         for (int i = index + RESERVED_BYTES_MIN_INDEX; i < index + RESERVED_BYTES_MAX_INDEX; ++i)
             byteBuffer.put(i, (byte) 0);
 
         // additional sense length
         byteBuffer.put(index + ADDITIONAL_SENSE_LENGTH_INDEX, (byte) getAdditionalSenseLength());
 
         // sense data descriptors
         int descriptorIndex = HEADER_LENGTH;
         for (int i = 0; i < senseDataDescriptors.length; ++i) {
             if (senseDataDescriptors[i] != null) {
                 senseDataDescriptors[i].serialize(byteBuffer, descriptorIndex);
                 descriptorIndex += senseDataDescriptors[i].size();
             }
         }
     }
 
     /**
      * Returns the value of the ADDITIONAL SENSE LENGTH field.
      * <p>
      * This is the total length of all included {@link SenseDataDescriptor} objects.
      * 
      * @return the value of the ADDITIONAL SENSE LENGTH field
      */
     private int getAdditionalSenseLength () {
         int additionalSenseLength = 0;
         if (senseDataDescriptors != null) {
             for (int i = 0; i < senseDataDescriptors.length; ++i)
                 if (senseDataDescriptors[i] != null) additionalSenseLength += senseDataDescriptors[i].size();
         }
         return additionalSenseLength;
     }
 
     public int size () {
         return getAdditionalSenseLength()// is never negative
                 + HEADER_LENGTH;
     }
 
 }

1		package org.jscsi.target.scsi.sense;
2
3
4		import java.nio.ByteBuffer;
5
6		import org.jscsi.target.scsi.sense.senseDataDescriptor.SenseDataDescriptor;
7		import org.jscsi.target.util.BitManip;
8		import org.jscsi.target.util.ReadWrite;
9
10
11		/**
12		* Instances of this class represent sense data using the descriptor format.
13		*
14		* @see SenseDataFormat#DESCRIPTOR
15		* @author Andreas Ergenzinger
16		*/
17		public final class DescriptorFormatSenseData extends SenseData {
18
19		/**
20		* The length in bytes of all fixed fields of descriptor format sense data.
21		*/
22		private static final int HEADER_LENGTH = 8;
23
24		/**
25		* The byte position of the ADDITIONAL SENSE CODE field.
26		*/
27		private static final int ADDITIONAL_SENSE_CODE_INDEX = 2;
28
29		/**
30		* The position of the first reserved byte.
31		*
32		* @see #RESERVED_BYTES_MAX_INDEX
33		*/
34		private static final int RESERVED_BYTES_MIN_INDEX = 4;
35
36		/**
37		* The position of the last reserved byte.
38		*
39		* @see #RESERVED_BYTES_MIN_INDEX
40		*/
41		private static final int RESERVED_BYTES_MAX_INDEX = 6;
42
43		/**
44		* The position of the ADDITIONAL SENSE LENGTH field.
45		*/
46		private static final int ADDITIONAL_SENSE_LENGTH_INDEX = 7;
47
48		/**
49		* All sense data descriptors that are a part of this sense data object.
50		*/
51		private final SenseDataDescriptor[] senseDataDescriptors;
52
53		/**
54		* The constructor.
55		*
56		* @param errorType the error type
57		* @param senseKey a general description of what caused the error
58		* @param additionalSenseCodeAndQualifier a more specific description of the error
59		* @param senseDataDescriptors more specific error information
60		*/
61		public DescriptorFormatSenseData (final ErrorType errorType, final SenseKey senseKey, AdditionalSenseCodeAndQualifier additionalSenseCodeAndQualifier, SenseDataDescriptor... senseDataDescriptors) {
62	0	super(errorType, SenseDataFormat.DESCRIPTOR, senseKey, additionalSenseCodeAndQualifier);
63	0	this.senseDataDescriptors = senseDataDescriptors;
64	0	}
65
66		public void serialize (ByteBuffer byteBuffer, int index) {
67
68	0	byteBuffer.position(index);
69
70		// response code and valid
71	0	byte b = (byte) getReponseCodeFor(errorType, SenseDataFormat.DESCRIPTOR);
72	0	b = BitManip.getByteWithBitSet(b, 7, false);// bit 7 is reserved
73	0	byteBuffer.put(b);// index
74
75		// sense key
76	0	b = (byte) (senseKey.getValue() & 15);
77	0	byteBuffer.put(b);// index + 1
78
79		// additional sense code and additional sense code qualifier
80	0	ReadWrite.writeTwoByteInt(byteBuffer, additionalSenseCodeAndQualifier.getValue(), index + ADDITIONAL_SENSE_CODE_INDEX);
81
82		// bytes 4-6 are reserved
83	0	for (int i = index + RESERVED_BYTES_MIN_INDEX; i < index + RESERVED_BYTES_MAX_INDEX; ++i)
84	0	byteBuffer.put(i, (byte) 0);
85
86		// additional sense length
87	0	byteBuffer.put(index + ADDITIONAL_SENSE_LENGTH_INDEX, (byte) getAdditionalSenseLength());
88
89		// sense data descriptors
90	0	int descriptorIndex = HEADER_LENGTH;
91	0	for (int i = 0; i < senseDataDescriptors.length; ++i) {
92	0	if (senseDataDescriptors[i] != null) {
93	0	senseDataDescriptors[i].serialize(byteBuffer, descriptorIndex);
94	0	descriptorIndex += senseDataDescriptors[i].size();
95		}
96		}
97	0	}
98
99		/**
100		* Returns the value of the ADDITIONAL SENSE LENGTH field.
101		* <p>
102		* This is the total length of all included {@link SenseDataDescriptor} objects.
103		*
104		* @return the value of the ADDITIONAL SENSE LENGTH field
105		*/
106		private int getAdditionalSenseLength () {
107	0	int additionalSenseLength = 0;
108	0	if (senseDataDescriptors != null) {
109	0	for (int i = 0; i < senseDataDescriptors.length; ++i)
110	0	if (senseDataDescriptors[i] != null) additionalSenseLength += senseDataDescriptors[i].size();
111		}
112	0	return additionalSenseLength;
113		}
114
115		public int size () {
116	0	return getAdditionalSenseLength()// is never negative
117		+ HEADER_LENGTH;
118		}
119
120		}