Package org.frankframework.filesystem.smb

Class Samba1FileSystem

java.lang.Object

org.frankframework.filesystem.AbstractFileSystem<jcifs.smb.SmbFile>

org.frankframework.filesystem.smb.Samba1FileSystem

All Implemented Interfaces:

AutoCloseable, HasPhysicalDestination, IBasicFileSystem<jcifs.smb.SmbFile>, IWritableFileSystem<jcifs.smb.SmbFile>

public class Samba1FileSystem
extends AbstractFileSystem<jcifs.smb.SmbFile>
implements IWritableFileSystem<jcifs.smb.SmbFile>

Uses the (old) SMB 1 protocol.
Only supports NTLM authentication.

Field Summary

Fields inherited from class org.frankframework.filesystem.AbstractFileSystem

log

Constructor Summary

Constructors

Constructor	Description
Samba1FileSystem()

Method Summary

Modifier and Type	Method	Description
OutputStream	appendFile(jcifs.smb.SmbFile f)
void	configure()
jcifs.smb.SmbFile	copyFile(jcifs.smb.SmbFile f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
OutputStream	createFile(jcifs.smb.SmbFile f)
void	createFolder(String folder)
void	deleteFile(jcifs.smb.SmbFile f)
boolean	exists(jcifs.smb.SmbFile f)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(jcifs.smb.SmbFile file)
String	getCanonicalName(jcifs.smb.SmbFile f)
long	getFileSize(jcifs.smb.SmbFile f)
Date	getModificationTime(jcifs.smb.SmbFile f)
String	getName(jcifs.smb.SmbFile f)	Get a string representation of an identification of a file.
String	getParentFolder(jcifs.smb.SmbFile f)
String	getPhysicalDestinationName()
boolean	isFolder(jcifs.smb.SmbFile f)
DirectoryStream<jcifs.smb.SmbFile>	list(String folder, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
jcifs.smb.SmbFile	moveFile(jcifs.smb.SmbFile f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(jcifs.smb.SmbFile f, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
jcifs.smb.SmbFile	renameFile(jcifs.smb.SmbFile source, jcifs.smb.SmbFile destination)	Renames the file to a new name, possibly in a another folder.
void	setAuthAlias(String authAlias)	Alias used to obtain credentials for the SMB share
void	setDomainName(String domain)	logon/authentication domain, in case the user account is bound to a domain such as Active Directory.
void	setForce(boolean force)	when true, intermediate directories are created also
void	setListHiddenFiles(boolean listHiddenFiles)	controls whether hidden files are seen or not
void	setPassword(String password)	The SMB share password
void	setShare(String share)	The destination, aka smb://xxx/yyy share
void	setUsername(String username)	The SMB share username
jcifs.smb.SmbFile	toFile(String filename)	Get a file 'F' representation of an identification of a file.
jcifs.smb.SmbFile	toFile(String folder, String filename)	Creates a reference to a file.

Methods inherited from class org.frankframework.filesystem.AbstractFileSystem

close, getMaxNumberOfMessagesToList, getNumberOfFilesInFolder, isOpen, setMaxNumberOfMessagesToList

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

close, getCanonicalNameOrErrorMessage, getNumberOfFilesInFolder, isOpen

Methods inherited from interface org.frankframework.filesystem.IWritableFileSystem

appendFile, createFile

Constructor Details

Samba1FileSystem

public Samba1FileSystem()

Method Details

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

ConfigurationException

open

public void open()
          throws FileSystemException

Specified by:

open in interface IBasicFileSystem<jcifs.smb.SmbFile>

Overrides:

open in class AbstractFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

toFile

public jcifs.smb.SmbFile toFile(@Nullable
 String filename)
                         throws FileSystemException

Description copied from interface: IBasicFileSystem

Get a file 'F' representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.getName(Object).

Specified by:

toFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

toFile

public jcifs.smb.SmbFile toFile(@Nullable
 String folder,
 @Nullable
 String filename)
                         throws FileSystemException

Description copied from interface: IBasicFileSystem

Creates a reference to a file. If filename is not absolute, it will be created in 'defaultFolder'.

Specified by:

toFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

list

public DirectoryStream<jcifs.smb.SmbFile> list(String folder,
 TypeFilter filter)
                                        throws FileSystemException

Description copied from interface: IBasicFileSystem

Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null). Only lists the objects as defined by the type filter.

Specified by:

list in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

exists

public boolean exists(jcifs.smb.SmbFile f)
               throws FileSystemException

Specified by:

exists in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

createFile

public OutputStream createFile(jcifs.smb.SmbFile f)
                        throws FileSystemException

Specified by:

createFile in interface IWritableFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

appendFile

public OutputStream appendFile(jcifs.smb.SmbFile f)
                        throws FileSystemException

Specified by:

appendFile in interface IWritableFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

readFile

public Message readFile(jcifs.smb.SmbFile f,
 String charset)
                 throws IOException,
FileSystemException

Specified by:

readFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

IOException

FileSystemException

deleteFile

public void deleteFile(jcifs.smb.SmbFile f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

isFolder

public boolean isFolder(jcifs.smb.SmbFile f)
                 throws FileSystemException

Specified by:

isFolder in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

removeFolder

public void removeFolder(String folder,
 boolean removeNonEmptyFolder)
                  throws FileSystemException

Specified by:

removeFolder in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

renameFile

public jcifs.smb.SmbFile renameFile(jcifs.smb.SmbFile source,
 jcifs.smb.SmbFile destination)
                             throws FileSystemException

Description copied from interface: IWritableFileSystem

Renames the file to a new name, possibly in a another folder. Does not need to check for existence of the source or non-existence of the destination.

Specified by:

renameFile in interface IWritableFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

moveFile

public jcifs.smb.SmbFile moveFile(jcifs.smb.SmbFile f,
 String destinationFolder,
 boolean createFolder)
                           throws FileSystemException

Description copied from interface: IBasicFileSystem

Moves the file to another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the moved file, or null if no file was moved or there is no reference to the moved file.

Specified by:

moveFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

copyFile

public jcifs.smb.SmbFile copyFile(jcifs.smb.SmbFile f,
 String destinationFolder,
 boolean createFolder)
                           throws FileSystemException

Description copied from interface: IBasicFileSystem

Copies the file to another folder. Does not need to check for existence of the source or non-existence of the destination. Returns the copied file, or null if no file was copied or there is no reference to the copied file.

Specified by:

copyFile in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

getFileSize

public long getFileSize(jcifs.smb.SmbFile f)
                 throws FileSystemException

Specified by:

getFileSize in interface IBasicFileSystem<jcifs.smb.SmbFile>

Throws:

FileSystemException

getName

public String getName(jcifs.smb.SmbFile f)

Description copied from interface: IBasicFileSystem

Get a string representation of an identification of a file. Must pair up with the implementation of IBasicFileSystem.toFile(String). Can reflect name a file has in its folder, is not expected to be unique over folders.

Specified by:

getName in interface IBasicFileSystem<jcifs.smb.SmbFile>

getParentFolder

public String getParentFolder(jcifs.smb.SmbFile f)

Specified by:

getParentFolder in interface IBasicFileSystem<jcifs.smb.SmbFile>

getCanonicalName

public String getCanonicalName(jcifs.smb.SmbFile f)

Specified by:

getCanonicalName in interface IBasicFileSystem<jcifs.smb.SmbFile>

getModificationTime

public Date getModificationTime(jcifs.smb.SmbFile f)

Specified by:

getModificationTime in interface IBasicFileSystem<jcifs.smb.SmbFile>

getAdditionalFileProperties

@Nullable
public Map<String,Object> getAdditionalFileProperties(jcifs.smb.SmbFile file)

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<jcifs.smb.SmbFile>

setShare

public void setShare(String share)

The destination, aka smb://xxx/yyy share

setUsername

public void setUsername(String username)

The SMB share username

setPassword

public void setPassword(String password)

The SMB share password

setAuthAlias

public void setAuthAlias(String authAlias)

Alias used to obtain credentials for the SMB share

setDomainName

public void setDomainName(String domain)

logon/authentication domain, in case the user account is bound to a domain such as Active Directory.

setForce

public void setForce(boolean force)

when true, intermediate directories are created also

Default value

false

setListHiddenFiles

public void setListHiddenFiles(boolean listHiddenFiles)

controls whether hidden files are seen or not

Default value

false