Package org.frankframework.filesystem.smb

Class Samba2FileSystem

java.lang.Object

org.frankframework.filesystem.AbstractFileSystem<SmbFileRef>

org.frankframework.filesystem.smb.Samba2FileSystem

All Implemented Interfaces:

AutoCloseable, HasPhysicalDestination, IBasicFileSystem<SmbFileRef>, IWritableFileSystem<SmbFileRef>

public class Samba2FileSystem
extends AbstractFileSystem<SmbFileRef>
implements IWritableFileSystem<SmbFileRef>

Uses the (newer) SMB 2 and 3 protocol. Possible error codes:
Pre-authentication information was invalid (24) / Idenitfier doesn't match expected value (906): login information is incorrect Server not found in Kerberos database (7): Verify that the hostname is the FQDN and the server is using a valid SPN.

Author:

Ali Sihab, Niels Meijer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Samba2FileSystem.Samba2AuthType

Field Summary

Fields inherited from class org.frankframework.filesystem.AbstractFileSystem

log

Constructor Summary

Constructors

Constructor	Description
Samba2FileSystem()

Method Summary

Modifier and Type	Method	Description
OutputStream	appendFile(SmbFileRef f)
void	close()
void	configure()
SmbFileRef	copyFile(SmbFileRef f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
OutputStream	createFile(SmbFileRef f)
void	createFolder(String folder)
void	deleteFile(SmbFileRef f)
boolean	exists(SmbFileRef f)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(SmbFileRef f)
String	getCanonicalName(SmbFileRef f)
long	getFileSize(SmbFileRef f)
Date	getModificationTime(SmbFileRef f)
String	getName(SmbFileRef file)	Get a string representation of an identification of a file.
String	getParentFolder(SmbFileRef f)
String	getPhysicalDestinationName()
boolean	isFolder(SmbFileRef smbFileRef)
DirectoryStream<SmbFileRef>	list(String folder, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
SmbFileRef	moveFile(SmbFileRef f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(SmbFileRef filename, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
SmbFileRef	renameFile(SmbFileRef source, SmbFileRef 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	setAuthType(Samba2FileSystem.Samba2AuthType authType)	Type of the authentication either 'NTLM' or 'SPNEGO'.
void	setDomainName(String domain)	NTLM only: logon/authentication domain, in case the user account is bound to a domain such as Active Directory.
void	setHostname(String hostname)	Hostname of the SMB share.
void	setKdc(String kdc)	SPNEGO only: Key Distribution Center, typically hosted on a domain controller.
void	setListHiddenFiles(boolean listHiddenFiles)	Controls if hidden files are seen
void	setPassword(String password)	the smb share password
void	setPort(int port)	Port to connect to.
void	setRealm(String realm)	SPNEGO only: Kerberos Realm, case sensitive.
void	setShare(String share)	May not contain '\\' characters.
void	setUsername(String username)	the smb share username
SmbFileRef	toFile(String filename)	Get a file 'F' representation of an identification of a file.
SmbFileRef	toFile(String folder, String filename)	Creates a reference to a file.

Methods inherited from class org.frankframework.filesystem.AbstractFileSystem

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

getCanonicalNameOrErrorMessage, getNumberOfFilesInFolder, isOpen

Methods inherited from interface org.frankframework.filesystem.IWritableFileSystem

appendFile, createFile

Constructor Details

Samba2FileSystem

public Samba2FileSystem()

Method Details

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IBasicFileSystem<SmbFileRef>

Throws:

ConfigurationException

open

public void open()
          throws FileSystemException

Specified by:

open in interface IBasicFileSystem<SmbFileRef>

Overrides:

open in class AbstractFileSystem<SmbFileRef>

Throws:

FileSystemException

close

public void close()
           throws FileSystemException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IBasicFileSystem<SmbFileRef>

Overrides:

close in class AbstractFileSystem<SmbFileRef>

Throws:

FileSystemException

toFile

public SmbFileRef 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<SmbFileRef>

Throws:

FileSystemException

toFile

public SmbFileRef 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<SmbFileRef>

Throws:

FileSystemException

list

public DirectoryStream<SmbFileRef> 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<SmbFileRef>

Throws:

FileSystemException

exists

public boolean exists(SmbFileRef f)

Specified by:

exists in interface IBasicFileSystem<SmbFileRef>

isFolder

public boolean isFolder(SmbFileRef smbFileRef)

Specified by:

isFolder in interface IBasicFileSystem<SmbFileRef>

createFile

public OutputStream createFile(SmbFileRef f)
                        throws FileSystemException,
IOException

Specified by:

createFile in interface IWritableFileSystem<SmbFileRef>

Throws:

FileSystemException

IOException

appendFile

public OutputStream appendFile(SmbFileRef f)
                        throws FileSystemException,
IOException

Specified by:

appendFile in interface IWritableFileSystem<SmbFileRef>

Throws:

FileSystemException

IOException

readFile

public Message readFile(SmbFileRef filename,
 String charset)
                 throws FileSystemException

Specified by:

readFile in interface IBasicFileSystem<SmbFileRef>

Throws:

FileSystemException

deleteFile

public void deleteFile(SmbFileRef f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<SmbFileRef>

Throws:

FileSystemException

renameFile

public SmbFileRef renameFile(SmbFileRef source,
 SmbFileRef 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<SmbFileRef>

Throws:

FileSystemException

moveFile

public SmbFileRef moveFile(SmbFileRef 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<SmbFileRef>

Throws:

FileSystemException

copyFile

public SmbFileRef copyFile(SmbFileRef 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<SmbFileRef>

Throws:

FileSystemException

getAdditionalFileProperties

@Nullable
public Map<String,Object> getAdditionalFileProperties(SmbFileRef f)

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<SmbFileRef>

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<SmbFileRef>

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<SmbFileRef>

Throws:

FileSystemException

removeFolder

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

Specified by:

removeFolder in interface IBasicFileSystem<SmbFileRef>

Throws:

FileSystemException

getFileSize

public long getFileSize(SmbFileRef f)

Specified by:

getFileSize in interface IBasicFileSystem<SmbFileRef>

getName

public String getName(SmbFileRef file)

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<SmbFileRef>

getParentFolder

public String getParentFolder(SmbFileRef f)

Specified by:

getParentFolder in interface IBasicFileSystem<SmbFileRef>

getCanonicalName

public String getCanonicalName(SmbFileRef f)

Specified by:

getCanonicalName in interface IBasicFileSystem<SmbFileRef>

getModificationTime

public Date getModificationTime(SmbFileRef f)

Specified by:

getModificationTime in interface IBasicFileSystem<SmbFileRef>

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setShare

public void setShare(String share)

May not contain '\\' characters. The destination share, 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)

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

setAuthType

public void setAuthType(Samba2FileSystem.Samba2AuthType authType)

Type of the authentication either 'NTLM' or 'SPNEGO'. When setting SPNEGO, the host must use the FQDN, and must be registered on the KDC with a valid SPN.

Default value

SPNEGO

setKdc

public void setKdc(String kdc)

SPNEGO only: Key Distribution Center, typically hosted on a domain controller. Stored in java.security.krb5.kdc

setRealm

public void setRealm(String realm)

SPNEGO only: Kerberos Realm, case sensitive. Typically upper case and the same as the domain name. An Active Directory domain acts as a Kerberos Realm. Stored in java.security.krb5.realm

setHostname

public void setHostname(String hostname)

Hostname of the SMB share.

setPort

public void setPort(int port)

Port to connect to.

Default value

445

setListHiddenFiles

public void setListHiddenFiles(boolean listHiddenFiles)

Controls if hidden files are seen

Default value

false