Module jcifs

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

Class ServerMessageBlock2Request<T extends ServerMessageBlock2Response>

java.lang.Object

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

org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Request<T>

Type Parameters:

T - response type

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, Request<T>, Message, Request

Direct Known Subclasses:

Smb2ChangeNotifyRequest, Smb2CloseRequest, Smb2CreateRequest, Smb2EchoRequest, Smb2FlushRequest, Smb2IoctlRequest, Smb2LockRequest, Smb2LogoffRequest, Smb2NegotiateRequest, Smb2QueryDirectoryRequest, Smb2QueryInfoRequest, Smb2ReadRequest, Smb2SessionSetupRequest, Smb2SetInfoRequest, Smb2TreeConnectRequest, Smb2TreeDisconnectRequest, Smb2WriteRequest

public abstract class ServerMessageBlock2Request<T extends ServerMessageBlock2Response>
extends ServerMessageBlock2
implements CommonServerMessageBlockRequest, Request<T>

Base class for SMB2/SMB3 request messages. This abstract class provides common functionality for handling request messages in the SMB2/SMB3 protocol.

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

Modifier	Constructor	Description
protected	ServerMessageBlock2Request(Configuration config)	Constructor for SMB2 request with configuration.
	ServerMessageBlock2Request(Configuration config, int command)	Constructor for SMB2 request with configuration and command.

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.
protected abstract T	createResponse(CIFSContext tc, ServerMessageBlock2Request<T> req)	Create the response object for this request
int	encode(byte[] dst, int dstIndex)	Encodes this message into a byte array.
int	getCreditCost()	Gets the number of credits this request requires.
ServerMessageBlock2Request<?>	getNext()	Gets the next message in the compound chain.
final Integer	getOverrideTimeout()	Gets the custom response timeout for this request.
T	getResponse()	Gets the response associated with this message.
ServerMessageBlock2Request<T>	ignoreDisconnect()	Marks this request to ignore disconnection errors.
T	initResponse(CIFSContext tc)	Initializes and returns a response object for this request.
boolean	isCancel()	Checks if this is a cancel request.
boolean	isResponseAsync()	Checks if the request will be handled asynchronously.
void	setNext(ServerMessageBlock2Request<?> next)	Sets the next request in the compound chain.
final void	setOverrideTimeout(Integer overrideTimeout)	Sets an override timeout for this request.
void	setRequestCredits(int credits)	Sets the number of request credits.
final void	setResponse(CommonServerMessageBlockResponse msg)	Sets the response for this message.
void	setTid(int t)	Sets the tree ID.
CommonServerMessageBlockRequest	split()	Splits this request for processing.

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

addFlags, chain, clearFlags, decode, decode, equals, getAsyncId, getCommand, getConfig, getCredit, getCreditCharge, getDigest, getErrorContextCount, getErrorData, getFlags, getHeaderStart, getLength, getMid, getNextCommandOffset, getRawPayload, getSessionId, getStatus, getTreeId, hashCode, haveResponse, isAsync, isErrorResponseStatus, isRetainPayload, pad8, readBytesWireFormat, readErrorResponse, readHeaderWireFormat, reset, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, setSessionId, setTreeId, setUid, size8, size8, toString, writeBytesWireFormat, 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, getCommand, getDigest, getMid, reset, setCommand, setDigest, setExtendedSecurity, setMid, setSessionId, setUid

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

size

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

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Constructor Details

ServerMessageBlock2Request

protected ServerMessageBlock2Request(Configuration config)

Constructor for SMB2 request with configuration.

Parameters:

config - the configuration object

ServerMessageBlock2Request

public ServerMessageBlock2Request(Configuration config,
 int command)

Constructor for SMB2 request with configuration and command.

Parameters:

config - the configuration object

command - the SMB2 command code

Method Details

ignoreDisconnect

public ServerMessageBlock2Request<T> ignoreDisconnect()

Description copied from interface: Request

Marks this request to ignore disconnection errors.

Specified by:

ignoreDisconnect in interface Request<T extends ServerMessageBlock2Response>

Returns:

this request

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

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()

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()

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)

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()

split

public CommonServerMessageBlockRequest split()

Splits this request for processing.

Specified by:

split in interface CommonServerMessageBlockRequest

Returns:

the following message

See Also:

• CommonServerMessageBlockRequest.split()

setNext

public void setNext(ServerMessageBlock2Request<?> next)

Sets the next request in the compound chain.

Parameters:

next - the next request

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()

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)

getOverrideTimeout

public final 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()

setOverrideTimeout

public final void setOverrideTimeout(Integer overrideTimeout)

Sets an override timeout for this request.

Parameters:

overrideTimeout - the overrideTimeout to set

initResponse

public T initResponse(CIFSContext tc)

Description copied from interface: Request

Initializes and returns a response object for this request.

Specified by:

initResponse in interface Request<T extends ServerMessageBlock2Response>

Parameters:

tc - the CIFS context

Returns:

create response

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)

encode

public int encode(byte[] dst,
 int dstIndex)

Encodes this message into a byte array.

Specified by:

encode in interface CommonServerMessageBlock

Overrides:

encode in class ServerMessageBlock2

Parameters:

dst - the destination byte array

dstIndex - the starting index in the destination array

Returns:

message length

See Also:

• ServerMessageBlock2.encode(byte[], int)

getResponse

public T getResponse()

Gets the response associated with this message.

Specified by:

getResponse in interface CommonServerMessageBlock

Specified by:

getResponse in interface Request<T extends ServerMessageBlock2Response>

Specified by:

getResponse in interface Request

Overrides:

getResponse in class ServerMessageBlock2

Returns:

the response

See Also:

• ServerMessageBlock2.getResponse()

createResponse

protected abstract T createResponse(CIFSContext tc,
 ServerMessageBlock2Request<T> req)

Create the response object for this request

Parameters:

tc - the CIFS context

req - the request object

Returns:

the response object

setResponse

public final void setResponse(CommonServerMessageBlockResponse msg)

Sets the response for this message.

Specified by:

setResponse in interface CommonServerMessageBlock

Overrides:

setResponse in class ServerMessageBlock2

Parameters:

msg - the response message to set

See Also:

• ServerMessageBlock2.setResponse(org.codelibs.jcifs.smb.internal.CommonServerMessageBlockResponse)