ch.swaechter.smbjwrapper

Class SharedFile

java.lang.Object

ch.swaechter.smbjwrapper.core.AbstractSharedItem<SharedDirectory>

ch.swaechter.smbjwrapper.SharedFile

All Implemented Interfaces:

SharedItem

public final class SharedFile
extends AbstractSharedItem<SharedDirectory>

This class represents a shared file.

Author:

Simon Wächter

Field Summary

Fields inherited from class ch.swaechter.smbjwrapper.core.AbstractSharedItem

PATH_SEPARATOR, ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
SharedFile(SharedConnection sharedConnection, String pathName) Create a new shared file based on the shared connection and the path name.

Method Summary

Modifier and Type	Method and Description
void	copyFileViaServerSideCopy(SharedFile destinationSharedFile) Copy the current file to another file on the same server share via server side copy.
void	createFile() Create a new file.
protected SharedDirectory	createSharedNodeItem(String pathName) Create a new shared directory via factory.
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 shared 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.

Methods inherited from class ch.swaechter.smbjwrapper.core.AbstractSharedItem

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedFile

public SharedFile(SharedConnection sharedConnection,
                  String pathName)

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

Parameters:

sharedConnection - Shared 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(SharedFile destinationSharedFile)
                               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:

destinationSharedFile - 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 shared 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 shared file

getFileSize

public long getFileSize()

Get the file size of the shared item.

Returns:

File size of the shared items in bytes

equals

public boolean equals(Object object)

Check if the current and the given objects are equals.

Specified by:

equals in class AbstractSharedItem<SharedDirectory>

Parameters:

object - Given object to compare against

Returns:

Status of the check

createSharedNodeItem

protected SharedDirectory createSharedNodeItem(String pathName)

Create a new shared directory via factory.

Specified by:

createSharedNodeItem in class AbstractSharedItem<SharedDirectory>

Parameters:

pathName - Path name of the shared item

Returns:

New shared directory