Module jcifs

Package org.codelibs.jcifs.smb.internal.fscc

Class FileRenameInformation2

java.lang.Object

org.codelibs.jcifs.smb.internal.fscc.FileRenameInformation2

All Implemented Interfaces:

Decodable, Encodable, FileInformation

public class FileRenameInformation2
extends Object
implements FileInformation

File System Control Code (FSCC) structure for File Rename Information. Used in SMB2/SMB3 set file information operations to rename files or directories, with support for specifying whether to replace existing files with the same name.

Author:

mbechler

Field Summary

Fields inherited from interface org.codelibs.jcifs.smb.internal.fscc.FileInformation

FILE_BASIC_INFO, FILE_ENDOFFILE_INFO, FILE_INTERNAL_INFO, FILE_RENAME_INFO, FILE_STANDARD_INFO

Constructor Summary

Constructors

Constructor	Description
FileRenameInformation2()	Default constructor for decoding.
FileRenameInformation2(String name, boolean replaceIfExists)	Constructs file rename information.

Method Summary

Modifier and Type	Method	Description
int	decode(byte[] buffer, int bufferIndex, int len)	Decode data from a byte buffer
int	encode(byte[] dst, int dstIndex)	Encodes this object into the specified byte array.
byte	getFileInformationLevel()	Gets the file information level/class for this file information object.
int	size()	Returns the size in bytes that this object will occupy when encoded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileRenameInformation2

public FileRenameInformation2()

Default constructor for decoding.

FileRenameInformation2

public FileRenameInformation2(String name,
 boolean replaceIfExists)

Constructs file rename information.

Parameters:

name - the new file name

replaceIfExists - whether to replace if the target file exists

Method Details

decode

public int decode(byte[] buffer,
 int bufferIndex,
 int len)
           throws SMBProtocolDecodingException

Decode data from a byte buffer

Specified by:

decode in interface Decodable

Parameters:

buffer - the byte buffer containing the data to decode

bufferIndex - the starting index in the buffer

len - the maximum length of data to decode

Returns:

decoded length

Throws:

SMBProtocolDecodingException - if decoding fails

See Also:

• Decodable.decode(byte[], int, int)

encode

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

Encodes this object into the specified byte array.

Specified by:

encode in interface Encodable

Parameters:

dst - the destination byte array to encode into

dstIndex - the starting index in the destination array

Returns:

encoded length

See Also:

• Encodable.encode(byte[], int)

size

public int size()

Returns the size in bytes that this object will occupy when encoded.

Specified by:

size in interface Encodable

Returns:

the encoded size

See Also:

• Encodable.size()

getFileInformationLevel

public byte getFileInformationLevel()

Gets the file information level/class for this file information object.

Specified by:

getFileInformationLevel in interface FileInformation

Returns:

the file information class

See Also:

• FileInformation.getFileInformationLevel()