Module jcifs

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

Class Smb2ChangeNotifyRequest

java.lang.Object

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

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

org.codelibs.jcifs.smb.internal.smb2.notify.Smb2ChangeNotifyRequest

All Implemented Interfaces:

CommonServerMessageBlock, CommonServerMessageBlockRequest, Request<Smb2ChangeNotifyResponse>, Message, Request

public class Smb2ChangeNotifyRequest
extends ServerMessageBlock2Request<Smb2ChangeNotifyResponse>

SMB2 Change Notify request message. This command is used to monitor a directory for changes and receive notifications when modifications occur.

Author:

mbechler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FILE_NOTIFY_CHANGE_ATTRIBUTES	Notify when file attributes change
static final int	FILE_NOTIFY_CHANGE_CREATION	Notify when creation time changes
static final int	FILE_NOTIFY_CHANGE_DIR_NAME	Notify when a directory name changes
static final int	FILE_NOTIFY_CHANGE_EA	Notify when extended attributes change
static final int	FILE_NOTIFY_CHANGE_FILE_NAME	Notify when a file name changes
static final int	FILE_NOTIFY_CHANGE_LAST_ACCESS	Notify when last access time changes
static final int	FILE_NOTIFY_CHANGE_LAST_WRITE	Notify when last write time changes
static final int	FILE_NOTIFY_CHANGE_SECURITY	Notify when security descriptor changes
static final int	FILE_NOTIFY_CHANGE_SIZE	Notify when file size changes
static final int	FILE_NOTIFY_CHANGE_STREAM_NAME	Notify when alternate data stream name changes
static final int	FILE_NOTIFY_CHANGE_STREAM_SIZE	Notify when alternate data stream size changes
static final int	FILE_NOTIFY_CHANGE_STREAM_WRITE	Notify when alternate data stream is written
static final int	SMB2_WATCH_TREE	Flag to watch the directory tree recursively

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
Smb2ChangeNotifyRequest(Configuration config, byte[] fileId)	Constructs a change notify request

Method Summary

Modifier and Type	Method	Description
protected Smb2ChangeNotifyResponse	createResponse(CIFSContext tc, ServerMessageBlock2Request<Smb2ChangeNotifyResponse> req)	Create the response object for this request
protected int	readBytesWireFormat(byte[] buffer, int bufferIndex)	Reads the message body from the wire format.
void	setCompletionFilter(int completionFilter)	Set the completion filter specifying which changes to monitor
void	setNotifyFlags(int notifyFlags)	Set the notification flags
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

SMB2_WATCH_TREE

public static final int SMB2_WATCH_TREE

Flag to watch the directory tree recursively

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_FILE_NAME

public static final int FILE_NOTIFY_CHANGE_FILE_NAME

Notify when a file name changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_DIR_NAME

public static final int FILE_NOTIFY_CHANGE_DIR_NAME

Notify when a directory name changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_ATTRIBUTES

public static final int FILE_NOTIFY_CHANGE_ATTRIBUTES

Notify when file attributes change

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_SIZE

public static final int FILE_NOTIFY_CHANGE_SIZE

Notify when file size changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_LAST_WRITE

public static final int FILE_NOTIFY_CHANGE_LAST_WRITE

Notify when last write time changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_LAST_ACCESS

public static final int FILE_NOTIFY_CHANGE_LAST_ACCESS

Notify when last access time changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_CREATION

public static final int FILE_NOTIFY_CHANGE_CREATION

Notify when creation time changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_EA

public static final int FILE_NOTIFY_CHANGE_EA

Notify when extended attributes change

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_SECURITY

public static final int FILE_NOTIFY_CHANGE_SECURITY

Notify when security descriptor changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_STREAM_NAME

public static final int FILE_NOTIFY_CHANGE_STREAM_NAME

Notify when alternate data stream name changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_STREAM_SIZE

public static final int FILE_NOTIFY_CHANGE_STREAM_SIZE

Notify when alternate data stream size changes

See Also:

• Constant Field Values

FILE_NOTIFY_CHANGE_STREAM_WRITE

public static final int FILE_NOTIFY_CHANGE_STREAM_WRITE

Notify when alternate data stream is written

See Also:

• Constant Field Values

Constructor Details

Smb2ChangeNotifyRequest

public Smb2ChangeNotifyRequest(Configuration config,
 byte[] fileId)

Constructs a change notify request

Parameters:

config - The configuration to use

fileId - The file ID to monitor for changes

Method Details

setNotifyFlags

public void setNotifyFlags(int notifyFlags)

Set the notification flags

Parameters:

notifyFlags - the notifyFlags to set

setCompletionFilter

public void setCompletionFilter(int completionFilter)

Set the completion filter specifying which changes to monitor

Parameters:

completionFilter - the completionFilter to set

createResponse

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

Create the response object for this request

Specified by:

createResponse in class ServerMessageBlock2Request<Smb2ChangeNotifyResponse>

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.

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)