nl.nn.adapterframework.filesystem

Class LocalFileSystem

java.lang.Object

nl.nn.adapterframework.filesystem.FileSystemBase<Path>

nl.nn.adapterframework.filesystem.LocalFileSystem

All Implemented Interfaces:

HasPhysicalDestination, IBasicFileSystem<Path>, IWritableFileSystem<Path>

public class LocalFileSystem
extends FileSystemBase<Path>
implements IWritableFileSystem<Path>

FileSystem representation of the local filesystem.

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
LocalFileSystem()

Method Summary

Modifier and Type	Method and Description
OutputStream	appendFile(Path f)
void	configure()
Path	copyFile(Path f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned) Copies the file to a another folder.
OutputStream	createFile(Path f)
void	createFolder(String folder)
void	deleteFile(Path f)
boolean	exists(Path f)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(Path f)
String	getCanonicalName(Path f)
long	getFileSize(Path f)
Date	getModificationTime(Path f)
String	getName(Path f) Get a string representation of an identification of a file.
String	getParentFolder(Path f)
String	getPhysicalDestinationName()
String	getRoot()
boolean	isFolder(Path f)
DirectoryStream<Path>	listFiles(String folder) Lists all files in 'folder' or in the 'root' of the filesystem (when folder is null).
Path	moveFile(Path f, String destinationFolder, boolean createFolder, boolean resultantMustBeReturned) Moves the file to a another folder.
Message	readFile(Path f, String charset)
void	removeFolder(String folder, boolean removeNonEmptyFolder)
Path	renameFile(Path source, Path destination) Renames the file to a new name, possibly in a another folder.
void	setRoot(String root) Path to the folder that serves as the root of this virtual filesystem.
Path	toFile(String filename) Get a file 'F' representation of an identification of a file.
Path	toFile(String folder, String filename) Creates a reference to a file.

Methods inherited from class nl.nn.adapterframework.filesystem.FileSystemBase

close, getMaxNumberOfMessagesToList, getNumberOfFilesInFolder, isOpen, open, setMaxNumberOfMessagesToList

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.filesystem.IBasicFileSystem

close, getNumberOfFilesInFolder, isOpen, open

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Field Detail

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

LocalFileSystem

public LocalFileSystem()

Method Detail

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IBasicFileSystem<Path>

Throws:

ConfigurationException

toFile

public Path toFile(String filename)

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

toFile

public Path toFile(String folder,
                   String filename)

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

listFiles

public DirectoryStream<Path> listFiles(String folder)
                                throws FileSystemException

Description copied from interface: IBasicFileSystem

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

Specified by:

listFiles in interface IBasicFileSystem<Path>

Throws:

FileSystemException

exists

public boolean exists(Path f)

Specified by:

exists in interface IBasicFileSystem<Path>

createFile

public OutputStream createFile(Path f)
                        throws IOException

Specified by:

createFile in interface IWritableFileSystem<Path>

Throws:

IOException

appendFile

public OutputStream appendFile(Path f)
                        throws IOException

Specified by:

appendFile in interface IWritableFileSystem<Path>

Throws:

IOException

readFile

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

Specified by:

readFile in interface IBasicFileSystem<Path>

Throws:

IOException

FileSystemException

deleteFile

public void deleteFile(Path f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<Path>

Throws:

FileSystemException

isFolder

public boolean isFolder(Path f)

folderExists

public boolean folderExists(String folder)
                     throws FileSystemException

Specified by:

folderExists in interface IBasicFileSystem<Path>

Throws:

FileSystemException

createFolder

public void createFolder(String folder)
                  throws FileSystemException

Specified by:

createFolder in interface IBasicFileSystem<Path>

Throws:

FileSystemException

removeFolder

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

Specified by:

removeFolder in interface IBasicFileSystem<Path>

Throws:

FileSystemException

renameFile

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

Throws:

FileSystemException

moveFile

public Path moveFile(Path f,
                     String destinationFolder,
                     boolean createFolder,
                     boolean resultantMustBeReturned)
              throws FileSystemException

Description copied from interface: IBasicFileSystem

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;

Specified by:

moveFile in interface IBasicFileSystem<Path>

resultantMustBeReturned - TODO

Throws:

FileSystemException

copyFile

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

Description copied from interface: IBasicFileSystem

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;

Specified by:

copyFile in interface IBasicFileSystem<Path>

resultantMustBeReturned - TODO

Throws:

FileSystemException

getFileSize

public long getFileSize(Path f)
                 throws FileSystemException

Specified by:

getFileSize in interface IBasicFileSystem<Path>

Throws:

FileSystemException

getName

public String getName(Path f)

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

getParentFolder

public String getParentFolder(Path f)
                       throws FileSystemException

Specified by:

getParentFolder in interface IBasicFileSystem<Path>

Throws:

FileSystemException

getCanonicalName

public String getCanonicalName(Path f)
                        throws FileSystemException

Specified by:

getCanonicalName in interface IBasicFileSystem<Path>

Throws:

FileSystemException

getModificationTime

public Date getModificationTime(Path f)
                         throws FileSystemException

Specified by:

getModificationTime in interface IBasicFileSystem<Path>

Throws:

FileSystemException

getAdditionalFileProperties

public Map<String,Object> getAdditionalFileProperties(Path f)

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<Path>

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setRoot

public void setRoot(String root)

Path to the folder that serves as the root of this virtual filesystem. All specifications of folders or files are relative to this root. When the root is left unspecified, absolute paths to files and folders can be used

getRoot

public String getRoot()