Skip navigation links
A B C D E F G I L M N O P R S T U V W 

A

AbstractFileAttributes - Class in org.mule.extension.file.common.api
Base class for implementations of FileAttributes
AbstractFileAttributes(Path) - Constructor for class org.mule.extension.file.common.api.AbstractFileAttributes
Creates a new instance
AbstractFileInputStream - Class in org.mule.extension.file.common.api.stream
Base class for InputStream instances returned by connectors which operate over a FileSystem.
AbstractFileInputStream(LazyStreamSupplier, PathLock) - Constructor for class org.mule.extension.file.common.api.stream.AbstractFileInputStream
 
AbstractFileInputStreamSupplier - Class in org.mule.extension.file.common.api
This is an abstract class that implements Supplier adding the logic to check that the file size is stable.
AbstractFileInputStreamSupplier(FileAttributes, Long) - Constructor for class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 
AbstractFileSystem<A extends FileAttributes> - Class in org.mule.extension.file.common.api
Base class for implementations of FileSystem
AbstractFileSystem(String) - Constructor for class org.mule.extension.file.common.api.AbstractFileSystem
 
AbstractPostActionGroup - Class in org.mule.extension.file.common.api.source
Groups post processing action parameters
AbstractPostActionGroup() - Constructor for class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
acceptsAll() - Method in enum org.mule.extension.file.common.api.matcher.MatchPolicy
 
acquireLock(PathLock) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Attempts to lock the given lock and throws FileLockedException if already locked
addConditions(Predicate<A>) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
This method is invoked by FileMatcher.build() before returning the built Predicate.
alreadyExistsException(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a IllegalPathException explaining that an operation is trying to write to the given path but it already exists and no overwrite instruction was provided.
apply(AbstractFileSystem, FileAttributes, FileConnectorConfig) - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
apply(LocalDateTime, LocalDateTime) - Method in class org.mule.extension.file.common.api.util.TimeSinceFunction
 
apply(LocalDateTime, LocalDateTime) - Method in class org.mule.extension.file.common.api.util.TimeUntilFunction
 
asBoolean() - Method in enum org.mule.extension.file.common.api.matcher.MatchPolicy
 
asDateTime(Instant) - Method in class org.mule.extension.file.common.api.AbstractFileAttributes
 
assureParentFolderExists(Path, boolean) - Method in class org.mule.extension.file.common.api.command.FileCommand
 
attributes - Variable in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 

B

BaseFileSystemOperations - Class in org.mule.extension.file.common.api
Basic set of operations and templates for extensions which perform operations over a generic file system
BaseFileSystemOperations() - Constructor for class org.mule.extension.file.common.api.BaseFileSystemOperations
 
build() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
Builds a Predicate from the criterias in this builder's state.

C

cannotListFileException(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a IllegalPathException explaining that a FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate) operation was attempted on a path pointing to a file.
cannotReadDirectoryException(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns an IllegalPathException explaining that a FileSystem#read(FileConnectorConfig, Message, String, boolean) operation was attempted on a path pointing to a directory
changeToBaseDir() - Method in interface org.mule.extension.file.common.api.FileSystem
Changes the current working directory to the user base
close() - Method in class org.mule.extension.file.common.api.stream.AbstractFileInputStream
Closes the stream and invokes PathLock.release() on the lock.
copy(FileConnectorConfig, String, String, boolean, boolean, String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Copies the file at the sourcePath into the targetPath.
copy(FileConnectorConfig, String, String, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.command.CopyCommand
Performs a copy operation under the considerations of FileSystem.copy(FileConnectorConfig, String, String, boolean, boolean, String)
copy(FileConnectorConfig, String, String, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.FileSystem
Copies the file at the sourcePath into the targetPath.
CopyCommand - Interface in org.mule.extension.file.common.api.command
Command for copying files
createDirectory(String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Creates a new directory
createDirectory(String) - Method in interface org.mule.extension.file.common.api.command.CreateDirectoryCommand
Creates a directory under the considerations of FileSystem.createDirectory(String)
createDirectory(String) - Method in interface org.mule.extension.file.common.api.FileSystem
Creates a new directory
CreateDirectoryCommand - Interface in org.mule.extension.file.common.api.command
Command design pattern for creating directories
createLock(Path) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
createMuleLock(String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
createMuleLock(String) - Method in interface org.mule.extension.file.common.api.FileSystem
 

D

delete(String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Deletes the file pointed by filePath, provided that it's not locked
delete(String) - Method in interface org.mule.extension.file.common.api.command.DeleteCommand
Deletes a file under the considerations of FileSystem#delete(FileConnectorConfig, String)
delete(String) - Method in interface org.mule.extension.file.common.api.FileSystem
Deletes the file pointed by filePath, provided that it's not locked
DeleteCommand - Interface in org.mule.extension.file.common.api.command
Command design pattern for deleting files
DeletedFileWhileReadException - Exception in org.mule.extension.file.common.api.exceptions
This exception is thrown when at the moment of getting the actual content of a file, it has already been deleted.
DeletedFileWhileReadException(I18nMessage) - Constructor for exception org.mule.extension.file.common.api.exceptions.DeletedFileWhileReadException
Creates a new instance with the specified detail message
DeletedFileWhileReadException(I18nMessage, Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.DeletedFileWhileReadException
Creates a new instance with the specified detail message
DeletedFileWhileReadException(Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.DeletedFileWhileReadException
Creates a new instance
doClose() - Method in class org.mule.extension.file.common.api.stream.AbstractFileInputStream
 
doCopy(FileConnectorConfig, FileSystem, String, String, boolean, boolean, String) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Copies the file at the sourcePath into the targetPath.
doCreateDirectory(FileSystem, String) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Creates a new directory on directoryPath
doDelete(FileSystem, String) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Deletes the file pointed by path, provided that it's not locked
doList(FileConnectorConfig, FileSystem, String, boolean, FileMatcher) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Deprecated.
doList(FileConnectorConfig, FileSystem, String, boolean, FileMatcher, Long) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Lists all the files in the directoryPath which match the given matcher.
doMkDirs(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
 
doMove(FileConnectorConfig, FileSystem, String, String, boolean, boolean, String) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Moves the file at the sourcePath into the targetPath.
doPagedList(FileConnectorConfig, String, boolean, FileMatcher, Long, StreamingHelper) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Lists all the files in the directoryPath which match the given matcher.
doRead(FileConnectorConfig, FileSystem, String, boolean) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Deprecated.
doRead(FileConnectorConfig, FileSystem, String, boolean, Long) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Obtains the content and metadata of a file at a given path.
doRename(FileSystem, String, String, boolean) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Renames the file pointed by path to the name provided on the to parameter
doWrite(FileConnectorConfig, FileSystem, String, InputStream, String, boolean, boolean, FileWriteMode) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
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 IllegalArgumentException or create such folder depending on the value of the createParentDirectory.

If the file itself already exists, then the behavior depends on the supplied mode.

This operation also supports locking support depending on the value of the lock argument, but following the same rules and considerations as described in the read operation.

doWrite(FileConnectorConfig, FileSystem, String, InputStream, boolean, boolean, FileWriteMode) - Method in class org.mule.extension.file.common.api.BaseFileSystemOperations
Writes the content into the file pointed by path.

E

exception(String) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a properly formatted MuleRuntimeException for the given message and cause
exception(String, Exception) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a properly formatted MuleRuntimeException for the given message and cause
exists(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns true if the given path exists

F

FILE_NO_LONGER_EXISTS_MESSAGE - Static variable in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 
FILE_TIME_SINCE - Static variable in class org.mule.extension.file.common.api.matcher.FileMatcher
 
FILE_TIME_UNTIL - Static variable in class org.mule.extension.file.common.api.matcher.FileMatcher
 
FileAccessDeniedException - Exception in org.mule.extension.file.common.api.exceptions
ModuleException to be thrown in the cases in which there is not enough permissions to access a particular file or directory.
FileAccessDeniedException(String) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileAccessDeniedException
Creates a new instance with the specified detail message
FileAccessDeniedException(String, Exception) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileAccessDeniedException
 
FileAlreadyExistsException - Exception in org.mule.extension.file.common.api.exceptions
ModuleException to be thrown in the cases in which a given file already exists.
FileAlreadyExistsException(String) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileAlreadyExistsException
Creates a new instance with the specified detail message
FileAlreadyExistsException(String, Exception) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileAlreadyExistsException
Creates a new instance with the specified detail message
FileAttributes - Interface in org.mule.extension.file.common.api
Canonical representation of a file's metadata attributes.
FileBeingModifiedException - Exception in org.mule.extension.file.common.api.exceptions
This exception is thrown when at the moment of getting the actual content of a file, its size is still changing.
FileBeingModifiedException(I18nMessage) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileBeingModifiedException
Creates a new instance with the specified detail message
FileBeingModifiedException(I18nMessage, Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileBeingModifiedException
Creates a new instance with the specified detail message
FileBeingModifiedException(Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileBeingModifiedException
Creates a new instance
FileCommand<F extends FileSystem> - Class in org.mule.extension.file.common.api.command
Base class for implementations of the Command design pattern which performs operations on a file system
FileCommand(F) - Constructor for class org.mule.extension.file.common.api.command.FileCommand
Creates a new instance
FileConnectorConfig - Class in org.mule.extension.file.common.api
Generic contract for a config of a connector which operates over a FileSystem
FileConnectorConfig() - Constructor for class org.mule.extension.file.common.api.FileConnectorConfig
 
FileCopyErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
Errors that can be thrown both in BaseFileSystemOperations#copy(FileConnectorConfig, FileSystem, String, String, boolean, boolean, CoreEvent) or BaseFileSystemOperations#move(FileConnectorConfig, FileSystem, String, String, boolean, boolean, CoreEvent) operation.
FileCopyErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileCopyErrorTypeProvider
 
FileDeleteErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
Errors that can be thrown in the BaseFileSystemOperations#delete(FileSystem, String, CoreEvent) operation.
FileDeleteErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileDeleteErrorTypeProvider
 
FileDisplayConstants - Class in org.mule.extension.file.common.api
Utility class to hold all the common constants between File related extensions for UI enhancement
FileDisplayConstants() - Constructor for class org.mule.extension.file.common.api.FileDisplayConstants
 
FileError - Enum in org.mule.extension.file.common.api.exceptions
Errors for the file family extensions
FileListErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
Errors that can be thrown in the BaseFileSystemOperations#list(FileConnectorConfig, FileSystem, String, boolean, Message, FileMatcher) operation.
FileListErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileListErrorTypeProvider
 
FileLockedException - Exception in org.mule.extension.file.common.api.exceptions
ModuleException for the cases in which a lock cannot be acquired over a file.
FileLockedException(String) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileLockedException
Creates a new instance with the specified detail message
FileMatcher<T extends FileMatcher,A extends FileAttributes> - Class in org.mule.extension.file.common.api.matcher
Builds a Predicate which verifies that a FileAttributes instance is compliant with a number of criterias.
FileMatcher() - Constructor for class org.mule.extension.file.common.api.matcher.FileMatcher
 
FileReadErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
Errors that can be thrown in the BaseFileSystemOperations#doRead(FileConnectorConfig, FileSystem, String, MediaType, boolean) operation.
FileReadErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileReadErrorTypeProvider
 
FileReadException - Exception in org.mule.extension.file.common.api.exceptions
MuleRuntimeException to be thrown when there is a problem while trying to read the content of a file lazily.
FileReadException(I18nMessage) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileReadException
Creates a new instance with the specified detail message
FileReadException(I18nMessage, Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileReadException
Creates a new instance with the specified detail message
FileReadException(Throwable) - Constructor for exception org.mule.extension.file.common.api.exceptions.FileReadException
Creates a new instance
FileRenameErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
Errors that can be thrown both in the BaseFileSystemOperations#rename(FileSystem, String, String, boolean, CoreEvent) or the BaseFileSystemOperations#createDirectory(FileSystem, String) operation.
FileRenameErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileRenameErrorTypeProvider
 
fileSystem - Variable in class org.mule.extension.file.common.api.command.FileCommand
 
FileSystem<A extends FileAttributes> - Interface in org.mule.extension.file.common.api
Represents an abstract file system and the operations which can be performed on it.
FileSystemProvider<T extends FileSystem> - Class in org.mule.extension.file.common.api
Base class for a ConnectionProvider which provides instances of FileSystem
FileSystemProvider() - Constructor for class org.mule.extension.file.common.api.FileSystemProvider
 
FileWriteErrorTypeProvider - Class in org.mule.extension.file.common.api.exceptions
FileWriteErrorTypeProvider() - Constructor for class org.mule.extension.file.common.api.exceptions.FileWriteErrorTypeProvider
 
FileWriteMode - Enum in org.mule.extension.file.common.api
List different strategies regarding how to write new files

G

get() - Method in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 
get() - Method in class org.mule.extension.file.common.api.stream.LazyStreamSupplier
 
getBasePath() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
getBasePath(FileSystem) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a Path to which all non absolute paths are relative to
getBasePath() - Method in interface org.mule.extension.file.common.api.FileSystem
 
getConfigName() - Method in class org.mule.extension.file.common.api.FileConnectorConfig
 
getConfigName() - Method in class org.mule.extension.file.common.api.FileSystemProvider
 
getContentInputStream() - Method in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
Gets the InputStream of the file described by the attributes passed to the constructor
getCopyCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getCreateDirectoryCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getDefaultWriteEncoding() - Method in class org.mule.extension.file.common.api.FileConnectorConfig
 
getDeleteCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getDirectories() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileCopyErrorTypeProvider
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileDeleteErrorTypeProvider
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileListErrorTypeProvider
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileReadErrorTypeProvider
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileRenameErrorTypeProvider
 
getErrorTypes() - Method in class org.mule.extension.file.common.api.exceptions.FileWriteErrorTypeProvider
 
getFileMessageMediaType(FileAttributes) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Creates a new DataType to be associated with a Message which payload is a InputStream and the attributes an instance of FileAttributes
getFileMessageMediaType(FileAttributes) - Method in interface org.mule.extension.file.common.api.FileSystem
Creates a new DataType to be associated with a Message which payload is a InputStream and the attributes an instance of FileAttributes
getFilenamePattern() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getListCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getMaxSize() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getMinSize() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getMoveCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getMoveToDirectory() - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
getName() - Method in class org.mule.extension.file.common.api.AbstractFileAttributes
getName() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
getParent() - Method in enum org.mule.extension.file.common.api.exceptions.FileError
 
getPath() - Method in class org.mule.extension.file.common.api.AbstractFileAttributes
getPath() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
getPath() - Method in class org.mule.extension.file.common.api.lock.NullPathLock
getPath() - Method in interface org.mule.extension.file.common.api.lock.PathLock
 
getPath() - Method in class org.mule.extension.file.common.api.lock.URLPathLock
getPathPattern() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getReadCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getRegularFiles() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getRenameCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 
getRenameTo() - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
getSize() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
getSymLinks() - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
getTimeBetweenSizeCheckInMillis(Long, TimeUnit) - Method in class org.mule.extension.file.common.api.FileConnectorConfig
 
getUpdatedAttributes() - Method in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
Gets the updated attributes of the file.
getWorkingDir() - Method in class org.mule.extension.file.common.api.FileSystemProvider
The directory to be considered as the root of every relative path used with this connector.
getWriteCommand() - Method in class org.mule.extension.file.common.api.AbstractFileSystem
 

I

IllegalContentException - Exception in org.mule.extension.file.common.api.exceptions
ModuleException to be thrown in the cases in which the received content to be written is invalid.
IllegalContentException(String) - Constructor for exception org.mule.extension.file.common.api.exceptions.IllegalContentException
Creates a new instance with the specified detail message
IllegalPathException - Exception in org.mule.extension.file.common.api.exceptions
ModuleException to be thrown in the cases in which a given path is invalid.
IllegalPathException(String) - Constructor for exception org.mule.extension.file.common.api.exceptions.IllegalPathException
Creates a new instance with the specified detail message
IllegalPathException(String, Exception) - Constructor for exception org.mule.extension.file.common.api.exceptions.IllegalPathException
Creates a new instance with the specified detail message
IS_A_DIRECTORY_MESSAGE - Static variable in interface org.mule.extension.file.common.api.command.WriteCommand
 
isApplyPostActionWhenFailed() - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
isAutoDelete() - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
isDirectory() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
isLocked(Path) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Try to acquire a lock on a file and release it immediately.
isLocked() - Method in class org.mule.extension.file.common.api.lock.NullPathLock
 
isLocked() - Method in interface org.mule.extension.file.common.api.lock.PathLock
 
isLocked() - Method in class org.mule.extension.file.common.api.lock.URLPathLock
isLocked() - Method in class org.mule.extension.file.common.api.stream.AbstractFileInputStream
 
isRegularFile() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
isSupplied() - Method in class org.mule.extension.file.common.api.stream.LazyStreamSupplier
 
isSymbolicLink() - Method in interface org.mule.extension.file.common.api.FileAttributes
 
isVirtualDirectory(String) - Method in class org.mule.extension.file.common.api.command.FileCommand
 

L

LazyStreamSupplier - Class in org.mule.extension.file.common.api.stream
Decorate a Supplier so that the first invokation to the LazyStreamSupplier.get() method is actually forwarded to it, but subsequent ones return the same cached value.
LazyStreamSupplier(Supplier<InputStream>) - Constructor for class org.mule.extension.file.common.api.stream.LazyStreamSupplier
 
list(FileConnectorConfig, String, boolean, Predicate<A>) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Deprecated.
list(FileConnectorConfig, String, boolean, Predicate<A>, Long) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Lists all the files in the directoryPath which match the given matcher.
list(FileConnectorConfig, String, boolean, Predicate<A>) - Method in interface org.mule.extension.file.common.api.command.ListCommand
Deprecated.
list(FileConnectorConfig, String, boolean, Predicate<A>, Long) - Method in interface org.mule.extension.file.common.api.command.ListCommand
list(FileConnectorConfig, String, boolean, Predicate<A>) - Method in interface org.mule.extension.file.common.api.FileSystem
Deprecated.
list(FileConnectorConfig, String, boolean, Predicate<A>, Long) - Method in interface org.mule.extension.file.common.api.FileSystem
Lists all the files in the directoryPath which match the given matcher.
ListCommand<A extends FileAttributes> - Interface in org.mule.extension.file.common.api.command
Command design pattern for listing files
lock(Path) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Acquires and returns lock over the given path.
lock(Path) - Method in interface org.mule.extension.file.common.api.FileSystem
Acquires and returns lock over the given path.

M

MATCHER - Static variable in class org.mule.extension.file.common.api.FileDisplayConstants
 
MatchPolicy - Enum in org.mule.extension.file.common.api.matcher
Criterias used to accept or reject a matcher filter.
mkdirs(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Creates the directory pointed by directoryPath also creating any missing parent directories
move(FileConnectorConfig, String, String, boolean, boolean, String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Moves the file at the sourcePath into the targetPath.
move(FileConnectorConfig, String, String, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.command.MoveCommand
move(FileConnectorConfig, String, String, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.FileSystem
Moves the file at the sourcePath into the targetPath.
MoveCommand - Interface in org.mule.extension.file.common.api.command
Command design pattern for moving files

N

NullFilePayloadPredicate<T extends FileAttributes> - Class in org.mule.extension.file.common.api.matcher
A Predicate of FileAttributes instances which accepts any value
NullFilePayloadPredicate() - Constructor for class org.mule.extension.file.common.api.matcher.NullFilePayloadPredicate
 
NullPathLock - Class in org.mule.extension.file.common.api.lock
Implementation of the Null Object design pattern for the PathLock interface
NullPathLock(Path) - Constructor for class org.mule.extension.file.common.api.lock.NullPathLock
 

O

onFileDeleted() - Method in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 
onFileDeleted(Exception) - Method in class org.mule.extension.file.common.api.AbstractFileInputStreamSupplier
 
org.mule.extension.file.common.api - package org.mule.extension.file.common.api
 
org.mule.extension.file.common.api.command - package org.mule.extension.file.common.api.command
 
org.mule.extension.file.common.api.exceptions - package org.mule.extension.file.common.api.exceptions
 
org.mule.extension.file.common.api.lock - package org.mule.extension.file.common.api.lock
 
org.mule.extension.file.common.api.matcher - package org.mule.extension.file.common.api.matcher
 
org.mule.extension.file.common.api.source - package org.mule.extension.file.common.api.source
 
org.mule.extension.file.common.api.stream - package org.mule.extension.file.common.api.stream
 
org.mule.extension.file.common.api.util - package org.mule.extension.file.common.api.util
 

P

path - Variable in class org.mule.extension.file.common.api.AbstractFileAttributes
 
PathLock - Interface in org.mule.extension.file.common.api.lock
Use to generate a lock on a file reference by a path.
PathMatcherPredicate - Class in org.mule.extension.file.common.api.matcher
A Predicate which tests random paths in String representation to match a specific pattern.
PathMatcherPredicate(String) - Constructor for class org.mule.extension.file.common.api.matcher.PathMatcherPredicate
Creates a new instance using the given pattern
pathNotFoundException(Path) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns a IllegalPathException explaining that a FileSystem#list(FileConnectorConfig, String, boolean, Message, Predicate) operation was attempted on a path pointing to a file.

R

read(FileConnectorConfig, String, boolean) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Deprecated.
read(FileConnectorConfig, String, boolean, Long) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Obtains the content and metadata of a file at a given path.
read(FileConnectorConfig, String, boolean) - Method in interface org.mule.extension.file.common.api.command.ReadCommand
Deprecated.
read(FileConnectorConfig, String, boolean, Long) - Method in interface org.mule.extension.file.common.api.command.ReadCommand
Reads files under the considerations of FileSystem.read(FileConnectorConfig, String, boolean)
read(FileConnectorConfig, String, boolean) - Method in interface org.mule.extension.file.common.api.FileSystem
Deprecated.
read(FileConnectorConfig, String, boolean, Long) - Method in interface org.mule.extension.file.common.api.FileSystem
Obtains the content and metadata of a file at a given path.
ReadCommand<A extends FileAttributes> - Interface in org.mule.extension.file.common.api.command
Command design pattern for reading files
release() - Method in class org.mule.extension.file.common.api.lock.NullPathLock
Does nothing regardless of how many invokations the NullPathLock.tryLock() method has received
release() - Method in interface org.mule.extension.file.common.api.lock.PathLock
Releases the lock that was previously obtained by invoking PathLock.tryLock() on this instance with a true return value.
release() - Method in class org.mule.extension.file.common.api.lock.URLPathLock
Releases the lock that was previously obtained by invoking PathLock.tryLock() on this instance with a true return value.
rename(String, String, boolean) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Renames the file pointed by filePath to the provided newName
rename(String, String, boolean) - Method in interface org.mule.extension.file.common.api.command.RenameCommand
Renames a file under the considerations of FileSystem#rename(FileConnectorConfig, String, String, boolean)
rename(String, String, boolean) - Method in interface org.mule.extension.file.common.api.FileSystem
Renames the file pointed by filePath to the provided newName
RenameCommand - Interface in org.mule.extension.file.common.api.command
Command design pattern for reading files
resolveExistingPath(String) - Method in class org.mule.extension.file.common.api.command.FileCommand
Similar to FileCommand.resolvePath(String) only that it throws a IllegalArgumentException if the given path doesn't exist.
resolvePath(String) - Method in class org.mule.extension.file.common.api.command.FileCommand
Returns an absolute Path to the given filePath

S

setDirectories(MatchPolicy) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setFilenamePattern(String) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setMaxSize(Long) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setMinSize(Long) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setPathPattern(String) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setRegularFiles(MatchPolicy) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 
setSymLinks(MatchPolicy) - Method in class org.mule.extension.file.common.api.matcher.FileMatcher
 

T

test(T) - Method in class org.mule.extension.file.common.api.matcher.NullFilePayloadPredicate
 
test(String) - Method in class org.mule.extension.file.common.api.matcher.PathMatcherPredicate
 
TimeSinceFunction - Class in org.mule.extension.file.common.api.util
A Boolean BiFunction which returns true if a given LocalDateTime is posterior or equal to a reference date
TimeSinceFunction() - Constructor for class org.mule.extension.file.common.api.util.TimeSinceFunction
 
TimeUntilFunction - Class in org.mule.extension.file.common.api.util
A Boolean BiFunction which returns true if a given LocalDateTime is prior or equal to a reference date
TimeUntilFunction() - Constructor for class org.mule.extension.file.common.api.util.TimeUntilFunction
 
toString() - Method in class org.mule.extension.file.common.api.AbstractFileAttributes
 
tryLock() - Method in class org.mule.extension.file.common.api.lock.NullPathLock
Does nothing and always returns true
tryLock() - Method in interface org.mule.extension.file.common.api.lock.PathLock
Attempts to obtain a lock on the referenced path.
tryLock() - Method in class org.mule.extension.file.common.api.lock.URLPathLock
Attempts to obtain a lock on the referenced path.

U

URLPathLock - Class in org.mule.extension.file.common.api.lock
A PathLock which is based on locks obtained through a URLPathLock.lockFactory.
URLPathLock(URL, LockFactory) - Constructor for class org.mule.extension.file.common.api.lock.URLPathLock
Creates a new instance

V

validateSelf() - Method in class org.mule.extension.file.common.api.source.AbstractPostActionGroup
 
valueOf(String) - Static method in enum org.mule.extension.file.common.api.exceptions.FileError
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.extension.file.common.api.FileWriteMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.mule.extension.file.common.api.matcher.MatchPolicy
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mule.extension.file.common.api.exceptions.FileError
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.extension.file.common.api.FileWriteMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.mule.extension.file.common.api.matcher.MatchPolicy
Returns an array containing the constants of this enum type, in the order they are declared.
verifyNotLocked(Path) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Verify that the given path is not locked
verifyNotLocked(Path) - Method in interface org.mule.extension.file.common.api.FileSystem
Verify that the given path is not locked

W

write(String, InputStream, FileWriteMode, boolean, boolean, String) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
write(String, InputStream, FileWriteMode, boolean, boolean) - Method in class org.mule.extension.file.common.api.AbstractFileSystem
Writes the content into the file pointed by filePath.
write(String, InputStream, FileWriteMode, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.command.WriteCommand
write(String, InputStream, FileWriteMode, boolean, boolean) - Method in interface org.mule.extension.file.common.api.command.WriteCommand
write(String, InputStream, FileWriteMode, boolean, boolean, String) - Method in interface org.mule.extension.file.common.api.FileSystem
Deprecated.
FileSystem.write(String, InputStream, FileWriteMode, boolean, boolean) must be used instead. Writes the content into the file pointed by filePath.

The content can be of any of the given types:

null contents are not allowed and will result in an IllegalArgumentException.

If the directory on which the file is attempting to be written doesn't exist, then the operation will either throw IllegalArgumentException or create such folder depending on the value of the createParentDirectory.

If the file itself already exists, then the behavior depends on the supplied mode.

This method also supports locking support depending on the value of the lock argument, but following the same rules and considerations as described in the FileSystem.read(FileConnectorConfig, String, boolean) method

write(String, InputStream, FileWriteMode, boolean, boolean) - Method in interface org.mule.extension.file.common.api.FileSystem
Writes the content into the file pointed by filePath.
WriteCommand - Interface in org.mule.extension.file.common.api.command
Command design pattern for writing files
A B C D E F G I L M N O P R S T U V W 
Skip navigation links

Copyright © 2003–2019 MuleSoft, Inc.. All rights reserved.