Module jcifs

Package org.codelibs.jcifs.smb.internal.smb1.trans.nt

Class SmbComNtCancel

java.lang.Object

org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

org.codelibs.jcifs.smb.internal.smb1.trans.nt.SmbComNtCancel

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, CommonServerMessageBlockResponse, RequestWithPath, Message, Request, Response

public class SmbComNtCancel
extends ServerMessageBlock

SMB1 NT Cancel command implementation. Provides functionality to cancel previously issued SMB1 NT transaction commands that are in progress, allowing clients to abort long-running operations.

Author:

mbechler

Field Summary

Fields inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

batchLevel, byteCount, digest, errorCode, flags2, headerStart, length, mid, path, pid, SMB_COM_CHECK_DIRECTORY, SMB_COM_CLOSE, SMB_COM_CREATE_DIRECTORY, SMB_COM_DELETE, SMB_COM_DELETE_DIRECTORY, SMB_COM_ECHO, SMB_COM_FIND_CLOSE2, SMB_COM_LOCKING_ANDX, SMB_COM_LOGOFF_ANDX, SMB_COM_MOVE, SMB_COM_NEGOTIATE, SMB_COM_NT_CANCEL, SMB_COM_NT_CREATE_ANDX, SMB_COM_NT_TRANSACT, SMB_COM_NT_TRANSACT_SECONDARY, SMB_COM_OPEN_ANDX, SMB_COM_QUERY_INFORMATION, SMB_COM_READ_ANDX, SMB_COM_RENAME, SMB_COM_SEEK, SMB_COM_SESSION_SETUP_ANDX, SMB_COM_SET_INFORMATION, SMB_COM_TRANSACTION, SMB_COM_TRANSACTION_SECONDARY, SMB_COM_TRANSACTION2, SMB_COM_TREE_CONNECT_ANDX, SMB_COM_TREE_DISCONNECT, SMB_COM_WRITE, SMB_COM_WRITE_ANDX, tid, uid, wordCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SmbComNtCancel(Configuration config, int mid)	Constructs an NT cancel command.

Method Summary

Modifier and Type	Method	Description
boolean	isCancel()	Checks if this is a cancel request.
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the data bytes portion of the SMB message from the wire format.
protected int	readParameterWordsWireFormat(byte[] buffer, int bufferIndex)	Reads the parameter words portion of the SMB message from the wire format.
protected int	writeBytesWireFormat(byte[] dst, int dstIndex)	Writes the data bytes portion of the SMB message to the wire format.
protected int	writeParameterWordsWireFormat(byte[] dst, int dstIndex)	Writes the parameter words portion of the SMB message to the wire format.

Methods inherited from class org.codelibs.jcifs.smb.internal.smb1.ServerMessageBlock

addFlags2, allowChain, clearReceived, createCancel, decode, encode, equals, error, exception, getByteCount, getCommand, getConfig, getCreditCost, getDigest, getDomain, getErrorCode, getException, getExpiration, getFlags, getFlags2, getFullUNCPath, getGrantedCredits, getLength, getMid, getNext, getNextResponse, getOverrideTimeout, getPath, getPid, getRawPayload, getResponse, getServer, getSignSeq, getTid, getUid, hashCode, ignoreDisconnect, isAsync, isError, isExtendedSecurity, isForceUnicode, isReceived, isResolveInDfs, isResponse, isResponseAsync, isRetainPayload, isUseUnicode, isVerifyFailed, prepare, readHeaderWireFormat, readString, readString, readString, readStringLength, received, remFlags2, reset, retainPayload, setCommand, setDigest, setErrorCode, setExpiration, setExtendedSecurity, setFlags, setFlags2, setFullUNCPath, setMid, setOverrideTimeout, setPath, setPid, setRawPayload, setRequestCredits, setResolveInDfs, setResponse, setSessionId, setSignSeq, setTid, setUid, setUseUnicode, size, split, stringWireLength, toString, verifySignature, writeHeaderWireFormat, writeString, writeString

Methods inherited from class java.lang.Object

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

Constructor Details

SmbComNtCancel

protected SmbComNtCancel(Configuration config,
 int mid)

Constructs an NT cancel command.

Parameters:

config - the configuration

mid - the message ID to cancel

Method Details

isCancel

public boolean isCancel()

Checks if this is a cancel request.

Specified by:

isCancel in interface Request

Overrides:

isCancel in class ServerMessageBlock

Returns:

whether this is a cancel request

See Also:

• ServerMessageBlock.isCancel()

writeParameterWordsWireFormat

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

Writes the parameter words portion of the SMB message to the wire format.

Specified by:

writeParameterWordsWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

See Also:

• ServerMessageBlock.writeParameterWordsWireFormat(byte[], int)

writeBytesWireFormat

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

Writes the data bytes portion of the SMB message to the wire format.

Specified by:

writeBytesWireFormat in class ServerMessageBlock

Parameters:

dst - the destination buffer

dstIndex - the starting offset in the buffer

Returns:

the number of bytes written

See Also:

• ServerMessageBlock.writeBytesWireFormat(byte[], int)

readParameterWordsWireFormat

protected int readParameterWordsWireFormat(byte[] buffer,
 int bufferIndex)

Reads the parameter words portion of the SMB message from the wire format.

Specified by:

readParameterWordsWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

See Also:

• ServerMessageBlock.readParameterWordsWireFormat(byte[], int)

readBytesWireFormat

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

Reads the data bytes portion of the SMB message from the wire format.

Specified by:

readBytesWireFormat in class ServerMessageBlock

Parameters:

buffer - the buffer containing the message data

bufferIndex - the starting offset in the buffer

Returns:

the number of bytes read

See Also:

• ServerMessageBlock.readBytesWireFormat(byte[], int)