Module jcifs

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

Class Smb2IoctlRequest

java.lang.Object

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

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

org.codelibs.jcifs.smb.internal.smb2.ioctl.Smb2IoctlRequest

All Implemented Interfaces:

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

public class Smb2IoctlRequest
extends ServerMessageBlock2Request<Smb2IoctlResponse>
implements RequestWithFileId

SMB2 IOCTL request message. This command is used to perform device control operations on files, pipes, or the server itself.

Author:

mbechler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FSCTL_DFS_GET_REFERRALS	Function code to retrieve DFS referrals
static final int	FSCTL_DFS_GET_REFERRALS_EX	Function code to retrieve extended DFS referrals
static final int	FSCTL_FILE_LEVEL_TRIM	Function code to trim file level storage
static final int	FSCTL_LRM_REQUEST_RESILENCY	Function code to request resilient handle for network failures
static final int	FSCTL_PIPE_PEEK	Function code to peek at named pipe data without removing it
static final int	FSCTL_PIPE_TRANSCEIVE	Function code to transceive data on a named pipe
static final int	FSCTL_PIPE_WAIT	Function code to wait for a named pipe to become available
static final int	FSCTL_QUERY_NETWORK_INTERFACE_INFO	Function code to query network interface information
static final int	FSCTL_SET_REPARSE_POINT	Function code to set a reparse point on a file
static final int	FSCTL_SRV_COPYCHUNK	Function code for server-side copy chunk operation
static final int	FSCTL_SRV_COPYCHUNK_WRITE	Function code for server-side copy chunk write operation
static final int	FSCTL_SRV_ENUMERATE_SNAPSHOTS	Function code to enumerate volume shadow copy snapshots
static final int	FSCTL_SRV_READ_HASH	Function code to read hash data from server
static final int	FSCTL_SRV_REQUEST_RESUME_KEY	Function code to request a resume key for server-side copy
static final int	FSCTL_VALIDATE_NEGOTIATE_INFO	Function code to validate SMB2 negotiate information
static final int	SMB2_O_IOCTL_IS_FSCTL	Flag indicating this IOCTL is a file system control operation

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
Smb2IoctlRequest(Configuration config, int controlCode)	Constructs an SMB2 IOCTL request with an unspecified file ID
Smb2IoctlRequest(Configuration config, int controlCode, byte[] fileId)	Constructs an SMB2 IOCTL request with a specified file ID
Smb2IoctlRequest(Configuration config, int controlCode, byte[] fileId, byte[] outputBuffer)	Constructs an SMB2 IOCTL request with output buffer

Method Summary

Modifier and Type	Method	Description
protected Smb2IoctlResponse	createResponse(CIFSContext tc, ServerMessageBlock2Request<Smb2IoctlResponse> 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	setFlags(int flags)	Set the IOCTL flags
void	setInputData(Encodable inputData)	Set the input data for the IOCTL request
void	setMaxInputResponse(int maxInputResponse)	Set the maximum input response size
void	setMaxOutputResponse(int maxOutputResponse)	Set the maximum output response size
void	setOutputData(Encodable outputData)	Set the output data for the IOCTL 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

Field Details

FSCTL_DFS_GET_REFERRALS

public static final int FSCTL_DFS_GET_REFERRALS

Function code to retrieve DFS referrals

See Also:

• Constant Field Values

FSCTL_PIPE_PEEK

public static final int FSCTL_PIPE_PEEK

Function code to peek at named pipe data without removing it

See Also:

• Constant Field Values

FSCTL_PIPE_WAIT

public static final int FSCTL_PIPE_WAIT

Function code to wait for a named pipe to become available

See Also:

• Constant Field Values

FSCTL_PIPE_TRANSCEIVE

public static final int FSCTL_PIPE_TRANSCEIVE

Function code to transceive data on a named pipe

See Also:

• Constant Field Values

FSCTL_SRV_COPYCHUNK

public static final int FSCTL_SRV_COPYCHUNK

Function code for server-side copy chunk operation

See Also:

• Constant Field Values

FSCTL_SRV_ENUMERATE_SNAPSHOTS

public static final int FSCTL_SRV_ENUMERATE_SNAPSHOTS

Function code to enumerate volume shadow copy snapshots

See Also:

• Constant Field Values

FSCTL_SRV_REQUEST_RESUME_KEY

public static final int FSCTL_SRV_REQUEST_RESUME_KEY

Function code to request a resume key for server-side copy

See Also:

• Constant Field Values

FSCTL_SRV_READ_HASH

public static final int FSCTL_SRV_READ_HASH

Function code to read hash data from server

See Also:

• Constant Field Values

FSCTL_SRV_COPYCHUNK_WRITE

public static final int FSCTL_SRV_COPYCHUNK_WRITE

Function code for server-side copy chunk write operation

See Also:

• Constant Field Values

FSCTL_LRM_REQUEST_RESILENCY

public static final int FSCTL_LRM_REQUEST_RESILENCY

Function code to request resilient handle for network failures

See Also:

• Constant Field Values

FSCTL_QUERY_NETWORK_INTERFACE_INFO

public static final int FSCTL_QUERY_NETWORK_INTERFACE_INFO

Function code to query network interface information

See Also:

• Constant Field Values

FSCTL_SET_REPARSE_POINT

public static final int FSCTL_SET_REPARSE_POINT

Function code to set a reparse point on a file

See Also:

• Constant Field Values

FSCTL_DFS_GET_REFERRALS_EX

public static final int FSCTL_DFS_GET_REFERRALS_EX

Function code to retrieve extended DFS referrals

See Also:

• Constant Field Values

FSCTL_FILE_LEVEL_TRIM

public static final int FSCTL_FILE_LEVEL_TRIM

Function code to trim file level storage

See Also:

• Constant Field Values

FSCTL_VALIDATE_NEGOTIATE_INFO

public static final int FSCTL_VALIDATE_NEGOTIATE_INFO

Function code to validate SMB2 negotiate information

See Also:

• Constant Field Values

SMB2_O_IOCTL_IS_FSCTL

public static final int SMB2_O_IOCTL_IS_FSCTL

Flag indicating this IOCTL is a file system control operation

See Also:

• Constant Field Values

Constructor Details

Smb2IoctlRequest

public Smb2IoctlRequest(Configuration config,
 int controlCode)

Constructs an SMB2 IOCTL request with an unspecified file ID

Parameters:

config - the client configuration

controlCode - the IOCTL control code

Smb2IoctlRequest

public Smb2IoctlRequest(Configuration config,
 int controlCode,
 byte[] fileId)

Constructs an SMB2 IOCTL request with a specified file ID

Parameters:

config - the client configuration

controlCode - the IOCTL control code

fileId - the file identifier

Smb2IoctlRequest

public Smb2IoctlRequest(Configuration config,
 int controlCode,
 byte[] fileId,
 byte[] outputBuffer)

Constructs an SMB2 IOCTL request with output buffer

Parameters:

config - the client configuration

controlCode - the IOCTL control code

fileId - the file identifier

outputBuffer - the output buffer for the IOCTL operation

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

createResponse

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

Description copied from class: ServerMessageBlock2Request

Create the response object for this request

Specified by:

createResponse in class ServerMessageBlock2Request<Smb2IoctlResponse>

Parameters:

tc - the CIFS context

req - the request object

Returns:

the response object

setFlags

public void setFlags(int flags)

Set the IOCTL flags

Parameters:

flags - the flags to set

setMaxInputResponse

public void setMaxInputResponse(int maxInputResponse)

Set the maximum input response size

Parameters:

maxInputResponse - the maxInputResponse to set

setMaxOutputResponse

public void setMaxOutputResponse(int maxOutputResponse)

Set the maximum output response size

Parameters:

maxOutputResponse - the maxOutputResponse to set

setInputData

public void setInputData(Encodable inputData)

Set the input data for the IOCTL request

Parameters:

inputData - the inputData to set

setOutputData

public void setOutputData(Encodable outputData)

Set the output data for the IOCTL request

Parameters:

outputData - the outputData to set

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)