Module jcifs

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

Class Smb2LockRequest

java.lang.Object

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

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

org.codelibs.jcifs.smb.internal.smb2.lock.Smb2LockRequest

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, Request<Smb2LockResponse>, RequestWithFileId, Message, Request

public class Smb2LockRequest
extends ServerMessageBlock2Request<Smb2LockResponse>
implements RequestWithFileId

SMB2 Lock request message. This command is used to request byte-range locks on portions of a file.

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
Smb2LockRequest(Configuration config, byte[] fileId, Smb2Lock[] locks)	Constructs an SMB2 lock request with the specified parameters.

Method Summary

Modifier and Type	Method	Description
protected Smb2LockResponse	createResponse(CIFSContext tc, ServerMessageBlock2Request<Smb2LockResponse> req)	Create the response object for this request
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body from the wire format.
void	setFileId(byte[] fileId)	Sets the file ID for this request.
int	size()	Gets the size of this message.
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.ServerMessageBlock2Request

allowChain, createCancel, encode, getCreditCost, getNext, getOverrideTimeout, getResponse, ignoreDisconnect, initResponse, isCancel, isResponseAsync, setNext, setOverrideTimeout, setRequestCredits, setResponse, setTid, split

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, readErrorResponse, readHeaderWireFormat, reset, retainPayload, setAsyncId, setCommand, setCredit, setDigest, setExtendedSecurity, setMid, setNext, setRawPayload, setReadSize, 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, getCommand, getDigest, getMid, reset, setCommand, setDigest, setExtendedSecurity, setMid, setSessionId, setUid

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

getRawPayload, isRetainPayload, retainPayload, setRawPayload

Constructor Details

Smb2LockRequest

public Smb2LockRequest(Configuration config,
 byte[] fileId,
 Smb2Lock[] locks)

Constructs an SMB2 lock request with the specified parameters.

Parameters:

config - the configuration for this request

fileId - the file identifier for the file to lock

locks - the array of lock elements to apply

Method Details

createResponse

protected Smb2LockResponse createResponse(CIFSContext tc,
 ServerMessageBlock2Request<Smb2LockResponse> req)

Create the response object for this request

Specified by:

createResponse in class ServerMessageBlock2Request<Smb2LockResponse>

Parameters:

tc - the CIFS context

req - the request object

Returns:

the response object

See Also:

• ServerMessageBlock2Request.createResponse(org.codelibs.jcifs.smb.CIFSContext, org.codelibs.jcifs.smb.internal.smb2.ServerMessageBlock2Request)

setFileId

public void setFileId(byte[] fileId)

Sets the file ID for this request.

Specified by:

setFileId in interface RequestWithFileId

Parameters:

fileId - the file ID to set

See Also:

• RequestWithFileId.setFileId(byte[])

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)