| Package | Description |
|---|---|
| org.mule.extension.file.common.api | |
| org.mule.extension.file.common.api.command |
| Modifier and Type | Class and Description |
|---|---|
class |
FileSystemProvider<T extends FileSystem>
Base class for a
ConnectionProvider which provides instances of
FileSystem |
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractFileSystem<A extends FileAttributes>
Base class for implementations of
FileSystem |
| Modifier and Type | Method and Description |
|---|---|
protected org.mule.runtime.extension.api.runtime.streaming.PagingProvider<FileSystem,org.mule.runtime.extension.api.runtime.operation.Result<org.mule.runtime.api.streaming.CursorProvider,FileAttributes>> |
BaseFileSystemOperations.doPagedList(FileConnectorConfig config,
String directoryPath,
boolean recursive,
FileMatcher matchWith,
Long timeBetweenSizeCheck,
org.mule.runtime.extension.api.runtime.streaming.StreamingHelper streamingHelper)
Lists all the files in the
directoryPath which match the given matcher. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
BaseFileSystemOperations.doCopy(FileConnectorConfig config,
FileSystem fileSystem,
String sourcePath,
String targetPath,
boolean createParentDirectories,
boolean overwrite,
String renameTo)
Copies the file at the
sourcePath into the targetPath. |
protected void |
BaseFileSystemOperations.doCreateDirectory(FileSystem fileSystem,
String directoryPath)
Creates a new directory on
directoryPath |
protected void |
BaseFileSystemOperations.doDelete(FileSystem fileSystem,
String path)
Deletes the file pointed by
path, provided that it's not locked |
protected List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes>> |
BaseFileSystemOperations.doList(FileConnectorConfig config,
FileSystem fileSystem,
String directoryPath,
boolean recursive,
FileMatcher matchWith)
Deprecated.
|
protected List<org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes>> |
BaseFileSystemOperations.doList(FileConnectorConfig config,
FileSystem fileSystem,
String directoryPath,
boolean recursive,
FileMatcher matchWith,
Long timeBetweenSizeCheck)
Lists all the files in the
directoryPath which match the given matcher. |
protected void |
BaseFileSystemOperations.doMove(FileConnectorConfig config,
FileSystem fileSystem,
String sourcePath,
String targetPath,
boolean createParentDirectories,
boolean overwrite,
String renameTo)
Moves the file at the
sourcePath into the targetPath. |
protected org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes> |
BaseFileSystemOperations.doRead(FileConnectorConfig config,
FileSystem fileSystem,
String path,
boolean lock)
Deprecated.
|
protected org.mule.runtime.extension.api.runtime.operation.Result<InputStream,FileAttributes> |
BaseFileSystemOperations.doRead(FileConnectorConfig config,
FileSystem fileSystem,
String path,
boolean lock,
Long timeBetweenSizeCheck)
Obtains the content and metadata of a file at a given path.
|
protected void |
BaseFileSystemOperations.doRename(FileSystem fileSystem,
String path,
String to,
boolean overwrite)
Renames the file pointed by
path to the name provided on the to parameter |
protected void |
BaseFileSystemOperations.doWrite(FileConnectorConfig config,
FileSystem fileSystem,
String path,
InputStream content,
boolean createParentDirectories,
boolean lock,
FileWriteMode mode)
Writes the
content into the file pointed by path. |
protected void |
BaseFileSystemOperations.doWrite(FileConnectorConfig config,
FileSystem fileSystem,
String path,
InputStream content,
String encoding,
boolean createParentDirectories,
boolean lock,
FileWriteMode mode)
Deprecated.
BaseFileSystemOperations.doWrite(FileConnectorConfig, FileSystem, String, InputStream, boolean, boolean, FileWriteMode)
must be used instead.
Writes the content into the file pointed by path.
If the directory on which the file is attempting to be written doesn't exist, then the operation will either throw
If the file itself already exists, then the behavior depends on the supplied
This operation also supports locking support depending on the value of the |
| Modifier and Type | Class and Description |
|---|---|
class |
FileCommand<F extends FileSystem>
Base class for implementations of the Command design pattern which performs operations on a file system
|
| Modifier and Type | Field and Description |
|---|---|
protected F |
FileCommand.fileSystem |
| Modifier and Type | Method and Description |
|---|---|
protected abstract Path |
FileCommand.getBasePath(FileSystem fileSystem)
Returns a
Path to which all non absolute paths are relative to |
Copyright © 2003–2019 MuleSoft, Inc.. All rights reserved.