Package org.frankframework.filesystem

Class LocalFileSystem

java.lang.Object

org.frankframework.filesystem.AbstractFileSystem<Path>

org.frankframework.filesystem.LocalFileSystem

All Implemented Interfaces:

AutoCloseable, HasPhysicalDestination, IBasicFileSystem<Path>, ISupportsCustomFileAttributes<Path>, IWritableFileSystem<Path>

public class LocalFileSystem
extends AbstractFileSystem<Path>
implements IWritableFileSystem<Path>, ISupportsCustomFileAttributes<Path>

FileSystem representation of the local filesystem.

Author:

Gerrit van Brakel

Field Summary

Fields inherited from class org.frankframework.filesystem.AbstractFileSystem

log

Fields inherited from interface org.frankframework.filesystem.ISupportsCustomFileAttributes

FILE_ATTRIBUTE_PARAM_PREFIX

Constructor Summary

Constructors

Constructor	Description
LocalFileSystem()

Method Summary

Modifier and Type	Method	Description
OutputStream	appendFile(Path f)
void	configure()
Path	copyFile(Path f, String destinationFolder, boolean createFolder)	Copies the file to another folder.
Path	copyFile(Path f, String destinationFolder, boolean createFolder, Map<String,String> customFileAttributes)	Copies the file to another folder, adding the given custom file attributes to the file in the destination folder.
OutputStream	createFile(Path f)
void	createFile(Path file, InputStream contents, Map<String,String> customFileAttributes)	Creates a file with the given custom file attributes.
void	createFolder(String folder)
void	deleteFile(Path f)
boolean	exists(Path f)
boolean	folderExists(String folder)
Map<String,Object>	getAdditionalFileProperties(Path file)
String	getCanonicalName(Path f)
String	getCustomFileAttribute(Path file, String name)	Gets the value of the given custom file attribute on the given file.
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>	list(String folder, TypeFilter filter)	Lists files, directories or both, from a 'folder' or in the 'root' of the filesystem (when folder is null).
Path	moveFile(Path f, String destinationFolder, boolean createFolder)	Moves the file to another folder.
Path	moveFile(Path f, String destinationFolder, boolean createFolder, Map<String,String> customFileAttributes)	Moves the file to another folder, adding the given custom file attributes to the file in the destination folder.
void	open()
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 another folder.
Path	renameFile(Path source, Path destination, Map<String,String> customFileAttributes)	Renames the file to a new name, possibly in another folder.
void	setCreateRootFolder(boolean createRootFolder)	Whether the LocalFileSystem tries to create the root folder if it doesn't exist yet.
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 org.frankframework.filesystem.AbstractFileSystem

close, getMaxNumberOfMessagesToList, getNumberOfFilesInFolder, isOpen, setMaxNumberOfMessagesToList

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

getDomain

Methods inherited from interface org.frankframework.filesystem.IBasicFileSystem

close, getCanonicalNameOrErrorMessage, getNumberOfFilesInFolder, isOpen

Methods inherited from interface org.frankframework.filesystem.ISupportsCustomFileAttributes

getCustomFileAttributes, hasCustomFileAttributes

Methods inherited from interface org.frankframework.filesystem.IWritableFileSystem

appendFile, createFile

Constructor Details

LocalFileSystem

public LocalFileSystem()

Method Details

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IBasicFileSystem<Path>

Throws:

ConfigurationException

open

public void open()
          throws FileSystemException

Specified by:

open in interface IBasicFileSystem<Path>

Overrides:

open in class AbstractFileSystem<Path>

Throws:

FileSystemException

toFile

public Path toFile(@Nullable
 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(@Nullable
 String folder,
 @Nullable
 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>

list

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

createFile

public void createFile(Path file,
 InputStream contents,
 Map<String,String> customFileAttributes)
                throws FileSystemException,
IOException

Description copied from interface: ISupportsCustomFileAttributes

Creates a file with the given custom file attributes.

Specified by:

createFile in interface ISupportsCustomFileAttributes<Path>

Parameters:

file -

contents -

customFileAttributes -

Throws:

FileSystemException

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 FileSystemException

Specified by:

readFile in interface IBasicFileSystem<Path>

Throws:

FileSystemException

deleteFile

public void deleteFile(Path f)
                throws FileSystemException

Specified by:

deleteFile in interface IBasicFileSystem<Path>

Throws:

FileSystemException

isFolder

public boolean isFolder(Path f)

Specified by:

isFolder in interface IBasicFileSystem<Path>

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

Throws:

FileSystemException

renameFile

public Path renameFile(Path source,
 Path destination,
 Map<String,String> customFileAttributes)
                throws FileSystemException

Description copied from interface: ISupportsCustomFileAttributes

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

Throws:

FileSystemException

moveFile

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

Throws:

FileSystemException

moveFile

public Path moveFile(Path f,
 String destinationFolder,
 boolean createFolder,
 Map<String,String> customFileAttributes)
              throws FileSystemException

Description copied from interface: ISupportsCustomFileAttributes

Moves the file to another folder, adding the given custom file attributes to the file in the destination 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 ISupportsCustomFileAttributes<Path>

Throws:

FileSystemException

copyFile

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

Throws:

FileSystemException

copyFile

public Path copyFile(Path f,
 String destinationFolder,
 boolean createFolder,
 Map<String,String> customFileAttributes)
              throws FileSystemException

Description copied from interface: ISupportsCustomFileAttributes

Copies the file to another folder, adding the given custom file attributes to the file in the destination 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 ISupportsCustomFileAttributes<Path>

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

@Nullable
public Map<String,Object> getAdditionalFileProperties(Path file)
                                               throws FileSystemException

Specified by:

getAdditionalFileProperties in interface IBasicFileSystem<Path>

Throws:

FileSystemException

getCustomFileAttribute

@Nullable
public String getCustomFileAttribute(@Nonnull
 Path file,
 @Nonnull
 String name)
                              throws FileSystemException

Description copied from interface: ISupportsCustomFileAttributes

Gets the value of the given custom file attribute on the given file. If the attribute does not exist, null is returned.

Specified by:

getCustomFileAttribute in interface ISupportsCustomFileAttributes<Path>

Parameters:

file - File object for which to get the extended attribute. Must not be null.

name - Name of the extended attribute to get. Must not be null.

Returns:

Value of the extended attribute or null if the attribute does not exist.

Throws:

FileSystemException

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()

setCreateRootFolder

@Default("false")
public void setCreateRootFolder(boolean createRootFolder)

Whether the LocalFileSystem tries to create the root folder if it doesn't exist yet.

Parameters:

createRootFolder -