Module jcifs

Package org.codelibs.jcifs.smb.internal.smb2.io

Class Smb2ReadResponse

java.lang.Object

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Response

org.codelibs.jcifs.smb.internal.smb2.io.Smb2ReadResponse

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockResponse, Message, Response

public class Smb2ReadResponse
extends ServerMessageBlock2Response

SMB2 Read response message. This response contains the data that was read from the file along with information about the read operation.

Author:

mbechler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	OVERHEAD	Protocol overhead size for SMB2 read response

Fields inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

SMB2_CANCEL, SMB2_CHANGE_NOTIFY, SMB2_CLOSE, SMB2_CREATE, SMB2_ECHO, SMB2_FLAGS_ASYNC_COMMAND, SMB2_FLAGS_DFS_OPERATIONS, SMB2_FLAGS_PRIORITY_MASK, SMB2_FLAGS_RELATED_OPERATIONS, SMB2_FLAGS_REPLAY_OPERATION, SMB2_FLAGS_SERVER_TO_REDIR, SMB2_FLAGS_SIGNED, SMB2_FLUSH, SMB2_IOCTL, SMB2_LOCK, SMB2_LOGOFF, SMB2_NEGOTIATE, SMB2_OPLOCK_BREAK, SMB2_QUERY_DIRECTORY, SMB2_QUERY_INFO, SMB2_READ, SMB2_SESSION_SETUP, SMB2_SET_INFO, SMB2_TREE_CONNECT, SMB2_TREE_DISCONNECT, SMB2_WRITE

Constructor Summary

Constructors

Constructor	Description
Smb2ReadResponse(Configuration config, byte[] outputBuffer, int outputBufferOffset)	Constructs a SMB2 read response with the specified configuration and output buffer

Method Summary

Modifier and Type	Method	Description
int	getDataLength()	Gets the number of bytes actually read
int	getDataRemaining()	Gets the number of bytes remaining to be read
protected boolean	isErrorResponseStatus()	Checks if this message has an error status.
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body from the wire format.
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the message body to the wire format.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Response

clearReceived, error, exception, getErrorCode, getException, getExpiration, getGrantedCredits, getNextResponse, haveResponse, isAsyncHandled, isError, isReceived, isSigned, isVerifyFailed, prepare, received, reset, setAsyncHandled, setExpiration, verifySignature

Methods inherited from class org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2

addFlags, chain, clearFlags, decode, decode, encode, equals, getAsyncId, getCommand, getConfig, getCredit, getCreditCharge, getDigest, getErrorContextCount, getErrorData, getFlags, getHeaderStart, getLength, getMid, getNext, getNextCommandOffset, getRawPayload, getResponse, getSessionId, getStatus, getTreeId, hashCode, isAsync, isRetainPayload, pad8, readErrorResponse, readHeaderWireFormat, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, setResponse, setSessionId, setTreeId, setUid, size8, size8, toString, writeHeaderWireFormat

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlock

decode, encode, getCommand, getDigest, getMid, getResponse, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

Methods inherited from interface org.codelibs.jcifs.smb.internal.CommonServerMessageBlockResponse

isAsync

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Message

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Methods inherited from interface org.codelibs.jcifs.smb.util.transport.Response

getMid, setMid

Field Details

OVERHEAD

public static final int OVERHEAD

Protocol overhead size for SMB2 read response

See Also:

• Constant Field Values

Constructor Details

Smb2ReadResponse

public Smb2ReadResponse(Configuration config,
 byte[] outputBuffer,
 int outputBufferOffset)

Constructs a SMB2 read response with the specified configuration and output buffer

Parameters:

config - the configuration to use for this response

outputBuffer - the buffer to receive the read data

outputBufferOffset - the offset in the output buffer to start writing data

Method Details

getDataLength

public int getDataLength()

Gets the number of bytes actually read

Returns:

the dataLength

getDataRemaining

public int getDataRemaining()

Gets the number of bytes remaining to be read

Returns:

the dataRemaining

writeBytesWireFormat

protected int writeBytesWireFormat(byte[] dst,
 int dstIndex)

Writes the message body to the wire format.

Specified by:

writeBytesWireFormat in class ServerMessageBlock2

Parameters:

dst - the destination buffer

dstIndex - the starting position in the buffer

Returns:

number of bytes written

See Also:

• ServerMessageBlock2.writeBytesWireFormat(byte[], int)

readBytesWireFormat

protected int readBytesWireFormat(byte[] buffer,
 int bufferIndex)
                           throws SMBProtocolDecodingException

Reads the message body from the wire format.

Specified by:

readBytesWireFormat in class ServerMessageBlock2

Parameters:

buffer - the buffer to read from

bufferIndex - the starting position in the buffer

Returns:

number of bytes read

Throws:

SMBProtocolDecodingException - if decoding fails

See Also:

• ServerMessageBlock2.readBytesWireFormat(byte[], int)

isErrorResponseStatus

protected boolean isErrorResponseStatus()

Checks if this message has an error status.

Overrides:

isErrorResponseStatus in class ServerMessageBlock2

Returns:

true if the message has an error status

See Also:

• ServerMessageBlock2.isErrorResponseStatus()