Module jcifs

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

Class Smb2QueryDirectoryRequest

java.lang.Object

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

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

org.codelibs.jcifs.smb.internal.smb2.info.Smb2QueryDirectoryRequest

All Implemented Interfaces:

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

public class Smb2QueryDirectoryRequest
extends ServerMessageBlock2Request<Smb2QueryDirectoryResponse>
implements RequestWithFileId

SMB2 Query Directory request message. This command is used to enumerate the contents of a directory on the server.

Author:

mbechler

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	FILE_BOTH_DIRECTORY_INFO	File information class for both names directory information.
static final byte	FILE_DIRECTORY_INFO	File information class for basic directory information.
static final byte	FILE_FULL_DIRECTORY_INFO	File information class for full directory information.
static final byte	FILE_ID_BOTH_DIRECTORY_INFO	File information class for both names with file IDs.
static final byte	FILE_ID_FULL_DIRECTORY_INFO	File information class for full directory information with file IDs.
static final byte	FILE_NAMES_INFO	File information class for file names only.
static final byte	SMB2_INDEX_SPECIFIED	Flag indicating that the file index field contains a valid index.
static final byte	SMB2_REOPEN	Flag to reopen the directory enumeration.
static final byte	SMB2_RESTART_SCANS	Flag to restart the directory enumeration from the beginning.
static final byte	SMB2_RETURN_SINGLE_ENTRY	Flag to return only a single directory entry.

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
Smb2QueryDirectoryRequest(Configuration config)	Constructs an SMB2 query directory request with the given configuration.
Smb2QueryDirectoryRequest(Configuration config, byte[] fileId)	Constructs a SMB2 query directory request with the specified configuration and file ID

Method Summary

Modifier and Type	Method	Description
protected Smb2QueryDirectoryResponse	createResponse(CIFSContext tc, ServerMessageBlock2Request<Smb2QueryDirectoryResponse> 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.
void	setFileIndex(int fileIndex)	Sets the file index from which to start the directory enumeration
void	setFileInformationClass(byte fileInformationClass)	Sets the file information class for the directory query
void	setFileName(String fileName)	Sets the file name pattern for filtering directory results
void	setQueryFlags(byte queryFlags)	Sets the query flags for the directory enumeration
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

Field Details

FILE_DIRECTORY_INFO

public static final byte FILE_DIRECTORY_INFO

File information class for basic directory information.

See Also:

• Constant Field Values

FILE_FULL_DIRECTORY_INFO

public static final byte FILE_FULL_DIRECTORY_INFO

File information class for full directory information.

See Also:

• Constant Field Values

FILE_BOTH_DIRECTORY_INFO

public static final byte FILE_BOTH_DIRECTORY_INFO

File information class for both names directory information.

See Also:

• Constant Field Values

FILE_NAMES_INFO

public static final byte FILE_NAMES_INFO

File information class for file names only.

See Also:

• Constant Field Values

FILE_ID_BOTH_DIRECTORY_INFO

public static final byte FILE_ID_BOTH_DIRECTORY_INFO

File information class for both names with file IDs.

See Also:

• Constant Field Values

FILE_ID_FULL_DIRECTORY_INFO

public static final byte FILE_ID_FULL_DIRECTORY_INFO

File information class for full directory information with file IDs.

See Also:

• Constant Field Values

SMB2_RESTART_SCANS

public static final byte SMB2_RESTART_SCANS

Flag to restart the directory enumeration from the beginning.

See Also:

• Constant Field Values

SMB2_RETURN_SINGLE_ENTRY

public static final byte SMB2_RETURN_SINGLE_ENTRY

Flag to return only a single directory entry.

See Also:

• Constant Field Values

SMB2_INDEX_SPECIFIED

public static final byte SMB2_INDEX_SPECIFIED

Flag indicating that the file index field contains a valid index.

See Also:

• Constant Field Values

SMB2_REOPEN

public static final byte SMB2_REOPEN

Flag to reopen the directory enumeration.

See Also:

• Constant Field Values

Constructor Details

Smb2QueryDirectoryRequest

public Smb2QueryDirectoryRequest(Configuration config)

Constructs an SMB2 query directory request with the given configuration.

Parameters:

config - the configuration for this request

Smb2QueryDirectoryRequest

public Smb2QueryDirectoryRequest(Configuration config,
 byte[] fileId)

Constructs a SMB2 query directory request with the specified configuration and file ID

Parameters:

config - the configuration to use for this request

fileId - the file ID of the directory to query

Method Details

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[])

setFileInformationClass

public void setFileInformationClass(byte fileInformationClass)

Sets the file information class for the directory query

Parameters:

fileInformationClass - the fileInformationClass to set

setQueryFlags

public void setQueryFlags(byte queryFlags)

Sets the query flags for the directory enumeration

Parameters:

queryFlags - the queryFlags to set

setFileIndex

public void setFileIndex(int fileIndex)

Sets the file index from which to start the directory enumeration

Parameters:

fileIndex - the fileIndex to set

setFileName

public void setFileName(String fileName)

Sets the file name pattern for filtering directory results

Parameters:

fileName - the fileName to set

createResponse

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

Create the response object for this request

Specified by:

createResponse in class ServerMessageBlock2Request<Smb2QueryDirectoryResponse>

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)

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)