Package org.frankframework.filesystem.sftp

Class SftpFileSystem

java.lang.Object

org.frankframework.filesystem.sftp.SftpSession

org.frankframework.filesystem.sftp.SftpFileSystem

All Implemented Interfaces:

AutoCloseable, HasPhysicalDestination, IConfigurable, IBasicFileSystem<SftpFileRef>, IWritableFileSystem<SftpFileRef>

@DestinationType(FILE_SYSTEM)
public class SftpFileSystem
extends SftpSession
implements IWritableFileSystem<SftpFileRef>

Implementation of SFTP FileSystem

Author:

Niels Meijer

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.filesystem.sftp.SftpSession

SftpSession.TransportType

Constructor Summary

Constructors

Constructor	Description
SftpFileSystem()

Method Summary

Modifier and Type	Method	Description
void	appendFile(SftpFileRef file, InputStream content)
void	changeDirectory(String folder)
void	close()	Closes the client and correlating SFTP session.
SftpFileRef	copyFile(SftpFileRef f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
void	createFile(SftpFileRef file, InputStream content)
void	createFolder(String folder)
void	deleteFile(SftpFileRef f)
boolean	exists(SftpFileRef file)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(SftpFileRef f)
String	getCanonicalName(SftpFileRef f)
long	getFileSize(SftpFileRef f)
Date	getModificationTime(SftpFileRef f)
String	getName(SftpFileRef file)	Get a string representation of an identification of a file.
int	getNumberOfFilesInFolder(String folder)
String	getParentFolder(SftpFileRef file)
String	getPhysicalDestinationName()
boolean	isFolder(SftpFileRef sftpFileRef)
boolean	isOpen()
DirectoryStream<SftpFileRef>	list(SftpFileRef folder, TypeFilter filter)
SftpFileRef	moveFile(SftpFileRef f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(SftpFileRef f, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
SftpFileRef	renameFile(SftpFileRef source, SftpFileRef destination)	Renames the file to a new name, possibly in another folder.
void	setRemoteDirectory(String remoteDirectory)	Path of the file or directory to start working.
SftpFileRef	toFile(String filename)	Get a file 'F' representation of an identification of a file.
SftpFileRef	toFile(String folder, String filename)	Creates a reference to a file.

Methods inherited from class org.frankframework.filesystem.sftp.SftpSession

configure, getClient, isSessionStillWorking, setAuthAlias, setHost, setKnownHostsPath, setPassword, setPort, setPrefCSEncryption, setPrefSCEncryption, setPrivateKeyAuthAlias, setPrivateKeyFilePath, setPrivateKeyPassword, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyTransportType, setProxyUsername, setStrictHostKeyChecking, setUsername

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

configure, getCanonicalNameOrErrorMessage, list

Constructor Details

SftpFileSystem

public SftpFileSystem()

Method Details

open

public void open()
          throws FileSystemException

Specified by:

open in interface IBasicFileSystem<SftpFileRef>

Overrides:

open in class SftpSession

Throws:

FileSystemException

close

public void close()

Description copied from class: SftpSession

Closes the client and correlating SFTP session.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IBasicFileSystem<SftpFileRef>

Overrides:

close in class SftpSession

isOpen

public boolean isOpen()

Specified by:

isOpen in interface IBasicFileSystem<SftpFileRef>

toFile

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

Throws:

FileSystemException

toFile

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

Throws:

FileSystemException

getNumberOfFilesInFolder

public int getNumberOfFilesInFolder(String folder)
                             throws FileSystemException

Specified by:

getNumberOfFilesInFolder in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

list

public DirectoryStream<SftpFileRef> list(SftpFileRef folder,
 TypeFilter filter)
                                  throws FileSystemException

Specified by:

list in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

exists

public boolean exists(SftpFileRef file)
               throws FileSystemException

Specified by:

exists in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

isFolder

public boolean isFolder(SftpFileRef sftpFileRef)

Specified by:

isFolder in interface IBasicFileSystem<SftpFileRef>

createFile

public void createFile(SftpFileRef file,
 InputStream content)
                throws FileSystemException

Specified by:

createFile in interface IWritableFileSystem<SftpFileRef>

Parameters:

file - FileSystem file reference

content - to write or NULL. When NULL existing files should be overwritten, and new files should be created.

Throws:

FileSystemException

appendFile

public void appendFile(SftpFileRef file,
 InputStream content)
                throws FileSystemException

Specified by:

appendFile in interface IWritableFileSystem<SftpFileRef>

Throws:

FileSystemException

readFile

public Message readFile(SftpFileRef f,
 String charset)
                 throws FileSystemException

Specified by:

readFile in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

deleteFile

public void deleteFile(SftpFileRef f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

changeDirectory

public void changeDirectory(String folder)
                     throws FileSystemException

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

removeFolder

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

Specified by:

removeFolder in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

renameFile

public SftpFileRef renameFile(SftpFileRef source,
 SftpFileRef destination)
                       throws FileSystemException

Description copied from interface: IWritableFileSystem

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

Specified by:

renameFile in interface IWritableFileSystem<SftpFileRef>

Throws:

FileSystemException

moveFile

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

Throws:

FileSystemException

copyFile

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

Throws:

FileSystemException

getFileSize

public long getFileSize(SftpFileRef f)

Specified by:

getFileSize in interface IBasicFileSystem<SftpFileRef>

getName

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

getParentFolder

public String getParentFolder(SftpFileRef file)

Specified by:

getParentFolder in interface IBasicFileSystem<SftpFileRef>

getCanonicalName

public String getCanonicalName(SftpFileRef f)

Specified by:

getCanonicalName in interface IBasicFileSystem<SftpFileRef>

getModificationTime

public Date getModificationTime(SftpFileRef f)
                         throws FileSystemException

Specified by:

getModificationTime in interface IBasicFileSystem<SftpFileRef>

Throws:

FileSystemException

getAdditionalFileProperties

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

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<SftpFileRef>

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setRemoteDirectory

public void setRemoteDirectory(String remoteDirectory)

Path of the file or directory to start working.

Default value

Home folder of the sftp user