nl.nn.adapterframework.filesystem

Interface IBasicFileSystem<F>

Type Parameters:

F - Representation of file and folder.

All Superinterfaces:

HasPhysicalDestination

All Known Subinterfaces:

IMailFileSystem<M,A>, IWithAttachments<F,A>, IWritableFileSystem<F>

All Known Implementing Classes:

AmazonS3FileSystem, ConnectedFileSystemBase, ExchangeFileSystem, FileSystemBase, FtpFileSystem, ImapFileSystem, LocalFileSystem, MailFileSystemBase, Samba1FileSystem, Samba2FileSystem, SftpFileSystem

public interface IBasicFileSystem<F>
extends HasPhysicalDestination

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 and Description
void	close()
void	configure()
F	copyFile(F f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned) Copies the file to a 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)
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	isOpen()
DirectoryStream<F>	listFiles(String folder) Lists all files in 'folder' or in the 'root' of the filesystem (when folder is null).
F	moveFile(F f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned) Moves the file to a 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 nl.nn.adapterframework.core.HasPhysicalDestination

getDomain, getPhysicalDestinationName

Method Detail

configure

void configure()
        throws ConfigurationException

Throws:

ConfigurationException

open

void open()
   throws FileSystemException

Throws:

FileSystemException

close

void close()
    throws FileSystemException

Throws:

FileSystemException

isOpen

boolean isOpen()

listFiles

DirectoryStream<F> listFiles(String folder)
                      throws FileSystemException

Lists all files in 'folder' or in the 'root' of the filesystem (when folder is null). Should list only 'files', no folders.

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(@Nonnull
         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(String defaultFolder,
         @Nonnull
         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

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,
           boolean resultantMustBeReturned)
    throws FileSystemException

Moves the file to a 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.
If the reference to the moved file is unknown after the move, then:
if resultantMustBeReturned is set, then an Exception must be thrown, preferably before the file is moved;
if resultantMustBeReturned is not set, then a null result returned might also mean the file was moved successfully, but with unknown destination;

Parameters:

resultantMustBeReturned - TODO

Throws:

FileSystemException

copyFile

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

Copies the file to a 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. If the reference to the copied file is unknown after the copy, then:
if resultantMustBeReturned is set, then an Exception must be thrown, preferably before the file is copied;
if resultantMustBeReturned is not set, then a null result returned might also mean the file was copied successfully, but with unknown destination;

Parameters:

resultantMustBeReturned - TODO

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

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

Throws:

FileSystemException