ch.swaechter.smbjwrapper

Class SmbFile

java.lang.Object

ch.swaechter.smbjwrapper.SmbItem

ch.swaechter.smbjwrapper.SmbFile

public final class SmbFile
extends SmbItem

This class represents a SMB file.

Author:

Simon Wächter

Field Summary

Fields inherited from class ch.swaechter.smbjwrapper.SmbItem

PATH_SEPARATOR, ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
SmbFile(SmbConnection smbConnection, String pathName) Create a new SMB file based on the SMB connection and the path name.

Method Summary

Modifier and Type	Method and Description
void	copyFileViaServerSideCopy(SmbFile destinationSmbFile) Copy the current file to another file on the same server share via server side copy.
void	createFile() Create a new file.
void	deleteFile() Delete the current file.
boolean	equals(Object object) Check if the current and the given objects are equals.
long	getFileSize() Get the file size of the SMB item.
InputStream	getInputStream() Get the input stream of the file that can be used to download the file.
OutputStream	getOutputStream() Get the output stream of the file that can be used to upload content to this file.
OutputStream	getOutputStream(boolean appendContent) Get the output stream of the file that can be used to upload and append content to this file.
SmbFile	renameTo(String newFileName, boolean replaceIfExist) Rename the current item and return it as newly renamed item.

Methods inherited from class ch.swaechter.smbjwrapper.SmbItem

getChangeTime, getCreationTime, getDiskShare, getLastAccessTime, getLastWriteTime, getName, getParentPath, getPath, getRootPath, getServerName, getShareName, getSmbConnection, getSmbPath, isDirectory, isExisting, isFile, isHidden, isRootPath

Methods inherited from class java.lang.Object

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

Constructor Detail

SmbFile

public SmbFile(SmbConnection smbConnection,
               String pathName)

Create a new SMB file based on the SMB connection and the path name.

Parameters:

smbConnection - SMB connection

pathName - Path name

Method Detail

createFile

public void createFile()

Create a new file.

deleteFile

public void deleteFile()

Delete the current file.

copyFileViaServerSideCopy

public void copyFileViaServerSideCopy(SmbFile destinationSmbFile)
                               throws com.hierynomus.protocol.commons.buffer.Buffer.BufferException,
                                      com.hierynomus.protocol.transport.TransportException

Copy the current file to another file on the same server share via server side copy. This does not work as soon the files are on different shares (In that case copy the input/output streams). For more information check out this Samba article: https://wiki.samba.org/index.php/Server-Side_Copy

Parameters:

destinationSmbFile - Other file on the same server share

Throws:

com.hierynomus.protocol.commons.buffer.Buffer.BufferException - Buffer related exception

com.hierynomus.protocol.transport.TransportException - Transport related exception

getInputStream

public InputStream getInputStream()

Get the input stream of the file that can be used to download the file.

Returns:

Input stream of the SMB file

getOutputStream

public OutputStream getOutputStream()

Get the output stream of the file that can be used to upload content to this file.

Returns:

Output stream of the SMB file

getOutputStream

public OutputStream getOutputStream(boolean appendContent)

Get the output stream of the file that can be used to upload and append content to this file.

Parameters:

appendContent - Append content or overwrite it

Returns:

Output stream of the SMB file

getFileSize

public long getFileSize()

Get the file size of the SMB item.

Returns:

File size of the SMB items in bytes

renameTo

public SmbFile renameTo(String newFileName,
                        boolean replaceIfExist)

Rename the current item and return it as newly renamed item. Renames are only possible from/to the same type. For example it's not possible to rename a file to an existing directory.

Specified by:

renameTo in class SmbItem

Parameters:

newFileName - New item name

replaceIfExist - Flag to replace an existing path of the same type (File/Directory)

Returns:

Newly renamed SMB item with the new path

equals

public boolean equals(Object object)

Check if the current and the given objects are equals.

Specified by:

equals in class SmbItem

Parameters:

object - Given object to compare against

Returns:

Status of the check