Module jcifs

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

Class Smb2CancelRequest

java.lang.Object

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

org.codelibs.jcifs.smb.internal.smb2.Smb2CancelRequest

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, Message, Request

public class Smb2CancelRequest
extends ServerMessageBlock2
implements CommonServerMessageBlockRequest

SMB2 Cancel request message. This command is used to cancel a previously sent command that is still being processed by the server.

Author:

mbechler

Field Summary

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
Smb2CancelRequest(Configuration config, long mid, long asyncId)	Constructs a SMB2 cancel request

Method Summary

Modifier and Type	Method	Description
boolean	allowChain(CommonServerMessageBlockRequest next)	Checks if chaining is allowed with the next request.
CommonServerMessageBlockRequest	createCancel()	Creates a cancel request for this request.
int	getCreditCost()	Gets the number of credits this request requires.
ServerMessageBlock2Request<?>	getNext()	Gets the next message in the compound chain.
Integer	getOverrideTimeout()	Gets the custom response timeout for this request.
boolean	isCancel()	Checks if this is a cancel request.
boolean	isResponseAsync()	Checks if the request will be handled asynchronously.
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body from the wire format.
void	setRequestCredits(int credits)	Sets the number of request credits.
void	setTid(int t)	Sets the tree ID.
int	size()	Gets the size of this message.
CommonServerMessageBlockRequest	split()	Splits this request for processing.
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.ServerMessageBlock2

addFlags, chain, clearFlags, decode, decode, encode, equals, getAsyncId, getCommand, getConfig, getCredit, getCreditCharge, getDigest, getErrorContextCount, getErrorData, getFlags, getHeaderStart, getLength, getMid, getNextCommandOffset, getRawPayload, getResponse, getSessionId, getStatus, getTreeId, hashCode, haveResponse, isAsync, isErrorResponseStatus, isRetainPayload, pad8, readErrorResponse, readHeaderWireFormat, reset, 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, reset, setCommand, setDigest, setExtendedSecurity, setMid, setResponse, setSessionId, setUid

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.Request

getResponse

Constructor Details

Smb2CancelRequest

public Smb2CancelRequest(Configuration config,
 long mid,
 long asyncId)

Constructs a SMB2 cancel request

Parameters:

config - The configuration to use

mid - The message ID of the request to cancel

asyncId - The async ID for asynchronous operations (0 for synchronous)

Method Details

getCreditCost

public int getCreditCost()

Gets the number of credits this request requires.

Specified by:

getCreditCost in interface Request

Returns:

number of credits this request requires

See Also:

• Request.getCreditCost()

isResponseAsync

public boolean isResponseAsync()

Checks if the request will be handled asynchronously.

Specified by:

isResponseAsync in interface CommonServerMessageBlockRequest

Returns:

request was handled asynchronously

See Also:

• CommonServerMessageBlockRequest.isResponseAsync()

getNext

public ServerMessageBlock2Request<?> getNext()

Description copied from class: ServerMessageBlock2

Gets the next message in the compound chain.

Specified by:

getNext in interface CommonServerMessageBlockRequest

Specified by:

getNext in interface Request

Overrides:

getNext in class ServerMessageBlock2

Returns:

the next message or null if this is the last message

getOverrideTimeout

public Integer getOverrideTimeout()

Gets the custom response timeout for this request.

Specified by:

getOverrideTimeout in interface CommonServerMessageBlockRequest

Returns:

custom response timeout for this request

See Also:

• CommonServerMessageBlockRequest.getOverrideTimeout()

allowChain

public boolean allowChain(CommonServerMessageBlockRequest next)

Checks if chaining is allowed with the next request.

Specified by:

allowChain in interface CommonServerMessageBlockRequest

Parameters:

next - the next request in the chain

Returns:

whether to allow chaining

See Also:

• CommonServerMessageBlockRequest.allowChain(org.codelibs.jcifs.smb.internal.CommonServerMessageBlockRequest)

split

public CommonServerMessageBlockRequest split()

Splits this request for processing.

Specified by:

split in interface CommonServerMessageBlockRequest

Returns:

the following message

See Also:

• CommonServerMessageBlockRequest.split()

createCancel

public CommonServerMessageBlockRequest createCancel()

Creates a cancel request for this request.

Specified by:

createCancel in interface CommonServerMessageBlockRequest

Returns:

create cancel request

See Also:

• CommonServerMessageBlockRequest.createCancel()

setRequestCredits

public void setRequestCredits(int credits)

Sets the number of request credits.

Specified by:

setRequestCredits in interface Request

Parameters:

credits - the number of credits to set

See Also:

• Request.setRequestCredits(int)

setTid

public void setTid(int t)

Sets the tree ID.

Specified by:

setTid in interface CommonServerMessageBlockRequest

Parameters:

t - the tree ID to set

See Also:

• CommonServerMessageBlockRequest.setTid(int)

isCancel

public boolean isCancel()

Checks if this is a cancel request.

Specified by:

isCancel in interface Request

Returns:

whether this is a cancel request

See Also:

• Request.isCancel()

size

public int size()

Gets the size of this message.

Specified by:

size in interface CommonServerMessageBlockRequest

Returns:

the size of this message

See Also:

• CommonServerMessageBlockRequest.size()

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)

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

See Also:

• ServerMessageBlock2.readBytesWireFormat(byte[], int)