Package org.frankframework.filesystem.ftp

Class FtpFileSystem

java.lang.Object

org.frankframework.filesystem.ftp.FtpSession

org.frankframework.filesystem.ftp.FtpFileSystem

All Implemented Interfaces:

AutoCloseable, HasApplicationContext, HasPhysicalDestination, IConfigurable, IScopeProvider, HasKeystore, HasTruststore, IBasicFileSystem<FTPFileRef>, IWritableFileSystem<FTPFileRef>

public class FtpFileSystem
extends FtpSession
implements IWritableFileSystem<FTPFileRef>

Implementation of FTP and FTPs FileSystem

Author:

Daniël Meyer, Niels Meijer

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.filesystem.ftp.FtpSession

FtpSession.FileType, FtpSession.FtpType, FtpSession.Prot, FtpSession.TransportType

Constructor Summary

Constructors

Constructor	Description
FtpFileSystem()

Method Summary

Modifier and Type	Method	Description
OutputStream	appendFile(FTPFileRef f)
void	close()
FTPFileRef	copyFile(FTPFileRef f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
OutputStream	createFile(FTPFileRef f)
void	createFolder(String folder)
void	deleteFile(FTPFileRef f)
boolean	exists(FTPFileRef file)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(FTPFileRef f)
String	getCanonicalName(FTPFileRef f)
long	getFileSize(FTPFileRef f)
Date	getModificationTime(FTPFileRef file)
String	getName(FTPFileRef file)	Get a string representation of an identification of a file.
int	getNumberOfFilesInFolder(String folder)
String	getParentFolder(FTPFileRef file)
String	getPhysicalDestinationName()
boolean	isFolder(FTPFileRef ftpFileRef)
boolean	isOpen()
DirectoryStream<FTPFileRef>	list(String folder, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
FTPFileRef	moveFile(FTPFileRef f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(FTPFileRef f, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
FTPFileRef	renameFile(FTPFileRef source, FTPFileRef destination)	Renames the file to a new name, possibly in a another folder.
void	setRemoteDirectory(String remoteDirectory)	pathname of the file or directory to list.
FTPFileRef	toFile(String filename)	Get a file 'F' representation of an identification of a file.
FTPFileRef	toFile(String folder, String filename)	Creates a reference to a file.

Methods inherited from class org.frankframework.filesystem.ftp.FtpSession

close, configure, openClient, setAllowSelfSignedCertificates, setAuthAlias, setFileType, setFtpType, setHost, setIgnoreCertificateExpiredException, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setPassive, setPassword, setPort, setProt, setProxyHost, setProxyPort, setProxyTransportType, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setUsername, setVerifyHostname

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.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.encryption.HasKeystore

getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface org.frankframework.encryption.HasTruststore

getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

configure, getCanonicalNameOrErrorMessage

Methods inherited from interface org.frankframework.filesystem.IWritableFileSystem

appendFile, createFile

Constructor Details

FtpFileSystem

public FtpFileSystem()

Method Details

open

public void open()
          throws FileSystemException

Specified by:

open in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IBasicFileSystem<FTPFileRef>

Overrides:

close in class FtpSession

isOpen

public boolean isOpen()

Specified by:

isOpen in interface IBasicFileSystem<FTPFileRef>

toFile

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

Throws:

FileSystemException

toFile

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

Throws:

FileSystemException

getNumberOfFilesInFolder

public int getNumberOfFilesInFolder(String folder)
                             throws FileSystemException

Specified by:

getNumberOfFilesInFolder in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

list

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

Throws:

FileSystemException

exists

public boolean exists(FTPFileRef file)
               throws FileSystemException

Specified by:

exists in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

isFolder

public boolean isFolder(FTPFileRef ftpFileRef)

Specified by:

isFolder in interface IBasicFileSystem<FTPFileRef>

createFile

public OutputStream createFile(FTPFileRef f)
                        throws FileSystemException,
IOException

Specified by:

createFile in interface IWritableFileSystem<FTPFileRef>

Throws:

FileSystemException

IOException

appendFile

public OutputStream appendFile(FTPFileRef f)
                        throws FileSystemException,
IOException

Specified by:

appendFile in interface IWritableFileSystem<FTPFileRef>

Throws:

FileSystemException

IOException

readFile

public Message readFile(FTPFileRef f,
 String charset)
                 throws FileSystemException,
IOException

Specified by:

readFile in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

IOException

deleteFile

public void deleteFile(FTPFileRef f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

removeFolder

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

Specified by:

removeFolder in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

renameFile

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

Throws:

FileSystemException

moveFile

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

Throws:

FileSystemException

copyFile

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

Throws:

FileSystemException

getFileSize

public long getFileSize(FTPFileRef f)
                 throws FileSystemException

Specified by:

getFileSize in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

getName

public String getName(FTPFileRef 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<FTPFileRef>

getParentFolder

public String getParentFolder(FTPFileRef file)

Specified by:

getParentFolder in interface IBasicFileSystem<FTPFileRef>

getCanonicalName

public String getCanonicalName(FTPFileRef f)

Specified by:

getCanonicalName in interface IBasicFileSystem<FTPFileRef>

getModificationTime

public Date getModificationTime(FTPFileRef file)
                         throws FileSystemException

Specified by:

getModificationTime in interface IBasicFileSystem<FTPFileRef>

Throws:

FileSystemException

getAdditionalFileProperties

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

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<FTPFileRef>

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setRemoteDirectory

public void setRemoteDirectory(String remoteDirectory)

pathname of the file or directory to list.

Default value

Home folder of the ftp user