org.jscsi.parser.logout.LogoutResponseParser Maven / Gradle / Ivy
/**
* Copyright (c) 2012, University of Konstanz, Distributed Systems Group All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or other materials provided with the
* distribution. * Neither the name of the University of Konstanz nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jscsi.parser.logout;
import org.jscsi.exception.InternetSCSIException;
import org.jscsi.parser.Constants;
import org.jscsi.parser.ProtocolDataUnit;
import org.jscsi.parser.TargetMessageParser;
import org.jscsi.parser.datasegment.DataSegmentFactory.DataSegmentFormat;
import org.jscsi.utils.Utils;
/**
* LogoutResponseParser
*
* This class parses a Logout Response message defined in the iSCSI Standard (RFC3720).
*
* The Logout Response is used by the target to indicate if the cleanup operation for the connection(s) has completed.
*
* After Logout, the TCP connection referred by the CID MUST be closed at both ends (or all connections must be closed
* if the logout reason was session close).
*
*
TotalAHSLength and DataSegmentLength
For this PDU TotalAHSLength and DataSegmentLength MUST be
* 0.
*
*
* @author Volker Wildi
*/
public final class LogoutResponseParser extends TargetMessageParser {
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** The logout response code. */
private LogoutResponse response;
/** Time in seconds to wait for task reassignment. */
private short time2Wait;
/** Time in seconds to wait maximal for allegiance reassignment. */
private short time2Retain;
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Default constructor, creates a new, empty LogoutResponseParser object.
*
* @param initProtocolDataUnit The reference ProtocolDataUnit instance, which contains this
* LogoutResponseParser subclass object.
*/
public LogoutResponseParser (final ProtocolDataUnit initProtocolDataUnit) {
super(initProtocolDataUnit);
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** {@inheritDoc} */
@Override
public final String toString () {
final StringBuilder sb = new StringBuilder(Constants.LOG_INITIAL_SIZE);
Utils.printField(sb, "Response", response.value(), 1);
sb.append(super.toString());
Utils.printField(sb, "Time2Wait", time2Wait, 1);
Utils.printField(sb, "Time2Retain", time2Retain, 1);
return sb.toString();
}
/** {@inheritDoc} */
@Override
public final DataSegmentFormat getDataSegmentFormat () {
return DataSegmentFormat.NONE;
}
/** {@inheritDoc} */
@Override
public final void clear () {
super.clear();
response = null;
time2Wait = 0;
time2Retain = 0;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Returns the Logout Response of this LogoutResponseParser object.
*
* @return The Logout Response of this LogoutResponseParser object.
* @see LogoutResponse
*/
public final LogoutResponse getResponse () {
return response;
}
/**
* If the Logout response code is 0 and if the operational ErrorRecoveryLevel is 2, this
* is the maximum amount of time, in seconds, after the initial wait (Time2Wait), the target waits for the
* allegiance reassignment for any active task after which the task state is discarded. If the Logout response code
* is 0 and if the operational ErrorRecoveryLevel is less than 2, this field is to be
* ignored.
*
* This field is invalid if the Logout response code is 1.
*
* If the Logout response code is 2 or 3, this field specifies the maximum amount of time,
* in seconds, after the initial wait (Time2Wait), the target waits for a new implicit or explicit logout.
*
* If it is the last connection of a session, the whole session state is discarded after Time2Retain.
*
* If Time2Retain is 0, the target has already discarded the connection (and possibly the
* session) state along with the task states. No reassignment or Logout is required in this case.
*
* @return The Time2Retain of this LogoutResponseParser object.
*/
public final short getTime2Retain () {
return time2Retain;
}
/**
* If the Logout Response code is 0 and if the operational ErrorRecoveryLevel is 2, this
* is the minimum amount of time, in seconds, to wait before attempting task reassignment. If the Logout Response
* code is 0 and if the operational ErrorRecoveryLevel is less than 2, this field is to be
* ignored.
*
* This field is invalid if the Logout Response code is 1.
*
* If the Logout response code is 2 or 3, this field specifies the minimum time to wait
* before attempting a new implicit or explicit logout.
*
* If Time2Wait is 0, the reassignment or a new Logout may be attempted immediately.
*
* @return The Time2Wait of this LogoutResponseParser object.
*/
public final short getTime2Wait () {
return time2Wait;
}
public final void setResponse (LogoutResponse response) {
this.response = response;
}
public final void setTime2Retain (short time2Retain) {
this.time2Retain = time2Retain;
}
public final void setTime2Wait (short time2Wait) {
this.time2Wait = time2Wait;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** {@inheritDoc} */
@Override
protected final void deserializeBytes1to3 (final int line) throws InternetSCSIException {
Utils.isReserved(line & Constants.SECOND_BYTE_MASK);
response = LogoutResponse.valueOf((byte) (line & Constants.THIRD_BYTE_MASK));
Utils.isReserved(line & Constants.FOURTH_BYTE_MASK);
}
/** {@inheritDoc} */
@Override
protected final void deserializeBytes40to43 (final int line) throws InternetSCSIException {
time2Wait = (short) ((line & Constants.FIRST_TWO_BYTES_MASK) >>> Constants.TWO_BYTES_SHIFT);
time2Retain = (short) (line & Constants.LAST_TWO_BYTES_MASK);
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** {@inheritDoc} */
@Override
protected final void checkIntegrity () throws InternetSCSIException {
String exceptionMessage;
do {
Utils.isReserved(logicalUnitNumber);
if (response == LogoutResponse.CID_NOT_FOUND) {
if (time2Wait != 0 || time2Retain != 0) {
exceptionMessage = ("Time fields are invalid with this response code.");
break;
}
}
// message is checked correctly
return;
} while (false);
throw new InternetSCSIException(exceptionMessage);
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** {@inheritDoc} */
@Override
protected final int serializeBytes1to3 () {
return response.value() << Constants.ONE_BYTE_SHIFT;
}
/** {@inheritDoc} */
@Override
protected final int serializeBytes40to43 () {
int line = time2Retain;
line |= time2Wait << Constants.TWO_BYTES_SHIFT;
return line;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
}