Package org.frankframework.filesystem

Interface IBasicFileSystem<F>

Type Parameters:

F - Representation of file and folder.

All Superinterfaces:

AutoCloseable, HasPhysicalDestination

All Known Subinterfaces:

IMailFileSystem<M,A>, IWritableFileSystem<F>

All Known Implementing Classes:

AbstractConnectedFileSystem, AbstractFileSystem, AbstractMailFileSystem, AmazonS3FileSystem, ExchangeFileSystem, FtpFileSystem, ImapFileSystem, LocalFileSystem, Samba1FileSystem, Samba2FileSystem, SftpFileSystem

public interface IBasicFileSystem<F>
extends HasPhysicalDestination, AutoCloseable

Interface to represent a basic filesystem, in which files can be listed, read, deleted or moved to a folder.

For Basic filesystems, filenames could be more or less globally unique IDs. In such a case: - moving or copying a file to a folder might change its name - moving or copying a file to a folder will never 'overwrite' a file already present in the folder and therefore for basic filesystems: - toFile(folder, filename) may return always the same result as toFile(filename) - rollover and overwrite protection is not supported

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure()
F	copyFile(F f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
void	createFolder(String folder)
void	deleteFile(F f)
boolean	exists(F f)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(F f)
String	getCanonicalName(F f)
default String	getCanonicalNameOrErrorMessage(F f)	Safe method to get a string representing the canonical name of a file, or an error message if the canonical name could not be established.
long	getFileSize(F f)
Date	getModificationTime(F f)
String	getName(F f)	Get a string representation of an identification of a file.
int	getNumberOfFilesInFolder(String folder)
String	getParentFolder(F f)
boolean	isFolder(F f)
boolean	isOpen()
DirectoryStream<F>	list(String folder, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
F	moveFile(F f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
void	open()
Message	readFile(F f, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
F	toFile(String filename)	Get a file 'F' representation of an identification of a file.
F	toFile(String defaultFolder, String filename)	Creates a reference to a file.

Methods inherited from interface org.frankframework.core.HasPhysicalDestination

getDomain, getPhysicalDestinationName

Method Details

configure

void configure()
        throws ConfigurationException

Throws:

ConfigurationException

open

void open()
   throws FileSystemException

Throws:

FileSystemException

close

void close()
    throws FileSystemException

Specified by:

close in interface AutoCloseable

Throws:

FileSystemException

isOpen

boolean isOpen()

list

DirectoryStream<F> list(String folder,
 TypeFilter filter)
                 throws FileSystemException

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.

Throws:

FileSystemException

getNumberOfFilesInFolder

int getNumberOfFilesInFolder(String folder)
                      throws FileSystemException

Throws:

FileSystemException

getName

String getName(F f)

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

getParentFolder

String getParentFolder(F f)
                throws FileSystemException

Throws:

FileSystemException

toFile

F toFile(@Nullable
 String filename)
  throws FileSystemException

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

Throws:

FileSystemException

toFile

F toFile(@Nullable
 String defaultFolder,
 @Nullable
 String filename)
  throws FileSystemException

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

Throws:

FileSystemException

exists

boolean exists(F f)
        throws FileSystemException

Throws:

FileSystemException

isFolder

boolean isFolder(F f)
          throws FileSystemException

Throws:

FileSystemException

folderExists

boolean folderExists(String folder)
              throws FileSystemException

Throws:

FileSystemException

readFile

Message readFile(F f,
 String charset)
          throws FileSystemException,
IOException

Throws:

FileSystemException

IOException

deleteFile

void deleteFile(F f)
         throws FileSystemException

Throws:

FileSystemException

moveFile

F moveFile(F f,
 String destinationFolder,
 boolean createFolder)
    throws FileSystemException

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.

Throws:

FileSystemException

copyFile

F copyFile(F f,
 String destinationFolder,
 boolean createFolder)
    throws FileSystemException

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.

Throws:

FileSystemException

createFolder

void createFolder(String folder)
           throws FileSystemException

Throws:

FileSystemException

removeFolder

void removeFolder(String folder,
 boolean removeNonEmptyFolder)
           throws FileSystemException

Throws:

FileSystemException

getFileSize

long getFileSize(F f)
          throws FileSystemException

Throws:

FileSystemException

getCanonicalName

String getCanonicalName(F f)
                 throws FileSystemException

Throws:

FileSystemException

getModificationTime

Date getModificationTime(F f)
                  throws FileSystemException

Throws:

FileSystemException

getAdditionalFileProperties

@Nullable
Map<String,Object> getAdditionalFileProperties(F f)
                                        throws FileSystemException

Throws:

FileSystemException

getCanonicalNameOrErrorMessage

default String getCanonicalNameOrErrorMessage(F f)

Safe method to get a string representing the canonical name of a file, or an error message if the canonical name could not be established. Because this method is not guaranteed to return the actual canonical name, it should be used only for error messages and logging.

Parameters:

f - File for which to try to get canonical name

Returns:

Either the canonical name of the file, or an error.