Index (FTP Connector 1.1.3 API)

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

A

AbstractFtpCopyDelegate - Class in org.mule.extension.ftp.internal: Abstract implementation of FtpCopyDelegate for copying operations which require to FTP connections, one for reading the source file and another for writing into the target path
AbstractFtpCopyDelegate(FtpCommand, FtpFileSystem) - Constructor for class org.mule.extension.ftp.internal.AbstractFtpCopyDelegate: Creates new instance
addConditions(Predicate<FtpFileAttributes>) - Method in class org.mule.extension.ftp.api.FtpFileMatcher
awaitCommandCompletion() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Awaits for the underlying FtpFileSystem.client to complete any pending commands.

B

beforeClose() - Method in class org.mule.extension.ftp.internal.ClassicFtpInputStream: Invokes FtpFileSystem.awaitCommandCompletion() to make sure that the operation is completed before closing the stream
beforeClose() - Method in class org.mule.extension.ftp.internal.FtpInputStream: Template method for performing operations just before the stream is closed.

C

changeToBaseDir() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Changes the FtpFileSystem.client's current working directory to the base path
changeWorkingDirectory(Path) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Changes the current working directory to the given path
changeWorkingDirectory(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Changes the current working directory to the given path
ClassicFtpInputStream - Class in org.mule.extension.ftp.internal: Implementation of FtpInputStream for FTP connections
client - Variable in class org.mule.extension.ftp.internal.command.FtpCommand
connect() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider: Creates and returns a new instance of FtpFileSystem
copy(FileConnectorConfig, String, String, boolean, boolean, String, FtpCopyDelegate) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Performs the base logic and delegates into FtpCopyDelegate.doCopy(FileConnectorConfig, FileAttributes, Path, boolean) to perform the actual copying logic
copy(FileConnectorConfig, String, String, boolean, boolean, String) - Method in class org.mule.extension.ftp.internal.command.FtpCopyCommand
copy(FileConnectorConfig, FileSystem, String, String, boolean, boolean, String) - Method in class org.mule.extension.ftp.internal.FtpOperations: Copies the file at the sourcePath into the targetPath.
copyDirectory(FileConnectorConfig, Path, Path, boolean, FtpFileSystem) - Method in class org.mule.extension.ftp.internal.AbstractFtpCopyDelegate: Performs a recursive copy of a directory
copyFile(FileConnectorConfig, FileAttributes, Path, boolean, FtpFileSystem) - Method in class org.mule.extension.ftp.internal.AbstractFtpCopyDelegate: Copies one individual file
createClient() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
createDirectory(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand
createDirectory(String) - Method in class org.mule.extension.ftp.internal.command.FtpCreateDirectoryCommand
createDirectory(FileSystem, String) - Method in class org.mule.extension.ftp.internal.FtpOperations: Creates a new directory on directoryPath
createLock(Path) - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem

D

delete(String) - Method in class org.mule.extension.ftp.internal.command.FtpDeleteCommand
delete(FileSystem, String) - Method in class org.mule.extension.ftp.internal.FtpOperations: Deletes the file pointed by path, provided that it's not locked
disconnect(FtpFileSystem) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider: Invokes the FtpFileSystem.disconnect() method on the given ftpFileSystem
disconnect() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Severs the connection by invoking FTPClient.logout() and FTPClient.disconnect() on the provided FtpFileSystem.client.
doClose() - Method in class org.mule.extension.ftp.internal.FtpInputStream
doCopy(FileConnectorConfig, FileAttributes, Path, boolean) - Method in class org.mule.extension.ftp.internal.AbstractFtpCopyDelegate: Performs a recursive copy
doCopy(FileConnectorConfig, FileAttributes, Path, boolean) - Method in class org.mule.extension.ftp.internal.command.MoveFtpDelegate
doCopy(FileConnectorConfig, FileAttributes, Path, boolean) - Method in interface org.mule.extension.ftp.internal.FtpCopyDelegate: Performs the copy operation
doMkDirs(Path) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Creates the directory pointed by directoryPath also creating any missing parent directories
doStart() - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
doStop() - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener

E

ERROR_CODE_MASK - Static variable in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
exception(String, Exception) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Same as the super method but adding the FTP rely code
exists(Path) - Method in class org.mule.extension.ftp.internal.command.FtpCommand

F

FtpCommand - Class in org.mule.extension.ftp.internal.command: Base class for FileCommand implementations that target a FTP/SFTP server
FtpCommand(FtpFileSystem) - Constructor for class org.mule.extension.ftp.internal.command.FtpCommand
FtpCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpCommand: Creates a new instance
FTPConnectionException - Exception in org.mule.extension.ftp.api: ConnectionException implementation to declare connectivity errors in the FtpConnector
FTPConnectionException(String) - Constructor for exception org.mule.extension.ftp.api.FTPConnectionException
FTPConnectionException(String, FileError) - Constructor for exception org.mule.extension.ftp.api.FTPConnectionException
FTPConnectionException(String, Throwable, FileError) - Constructor for exception org.mule.extension.ftp.api.FTPConnectionException
FtpConnectionProvider - Class in org.mule.extension.ftp.internal.connection: Connects to an FTP server
FtpConnectionProvider() - Constructor for class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
FtpConnectionSettings - Class in org.mule.extension.ftp.internal.connection: Groups FTP connection parameters
FtpConnectionSettings() - Constructor for class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
FtpConnector - Class in org.mule.extension.ftp.internal: Connects to an FTP server
FtpConnector() - Constructor for class org.mule.extension.ftp.internal.FtpConnector
FtpCopyCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the CopyCommand contract
FtpCopyCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpCopyCommand
FtpCopyDelegate - Interface in org.mule.extension.ftp.internal: A delegate object for copying files
FtpCreateDirectoryCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the CreateDirectoryCommand
FtpCreateDirectoryCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpCreateDirectoryCommand
FtpDeleteCommand - Class in org.mule.extension.ftp.internal.command
FtpDeleteCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpDeleteCommand
FtpDirectoryListener - Class in org.mule.extension.ftp.internal.source: Polls a directory looking for files that have been created on it.
FtpDirectoryListener() - Constructor for class org.mule.extension.ftp.internal.source.FtpDirectoryListener
FtpFileAttributes - Class in org.mule.extension.ftp.api.ftp: Metadata about a file in a FTP server
FtpFileAttributes(Path, FTPFile) - Constructor for class org.mule.extension.ftp.api.ftp.FtpFileAttributes: Creates a new instance
FtpFileMatcher - Class in org.mule.extension.ftp.api: A set of criterias used to filter files stored in a FTP server.
FtpFileMatcher() - Constructor for class org.mule.extension.ftp.api.FtpFileMatcher
FtpFileSystem - Class in org.mule.extension.ftp.internal.connection: Implementation of AbstractFileSystem for files residing on a FTP server
FtpInputStream - Class in org.mule.extension.ftp.internal: An AbstractFileInputStream implementation which obtains a FtpFileSystem through a ConnectionManager and uses it to obtain the contents of a file on a FTP server.
FtpInputStream(Supplier<InputStream>, LazyValue<ConnectionHandler<FtpFileSystem>>, PathLock) - Constructor for class org.mule.extension.ftp.internal.FtpInputStream
FtpListCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the ListCommand contract
FtpListCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpListCommand
FtpMoveCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the MoveCommand contract
FtpMoveCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpMoveCommand
FtpOperations - Class in org.mule.extension.ftp.internal: Ftp connector operations
FtpOperations() - Constructor for class org.mule.extension.ftp.internal.FtpOperations
FtpReadCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the FtpReadCommand
FtpReadCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpReadCommand
FtpRenameCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the RenameCommand
FtpRenameCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpRenameCommand
FtpTransferMode - Enum in org.mule.extension.ftp.api.ftp: Lists the supported transfer modes for FTP operations.
FtpUtils - Class in org.mule.extension.ftp.internal: Utility class for normalizing FTP paths
FtpWriteCommand - Class in org.mule.extension.ftp.internal.command: A FtpCommand which implements the WriteCommand contract
FtpWriteCommand(FtpFileSystem, FTPClient) - Constructor for class org.mule.extension.ftp.internal.command.FtpWriteCommand

G

getBasePath(FileSystem) - Method in class org.mule.extension.ftp.internal.command.FtpCommand
getClient() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getCode() - Method in enum org.mule.extension.ftp.api.ftp.FtpTransferMode
getConnectionHandler(FtpConnector) - Static method in class org.mule.extension.ftp.internal.FtpInputStream
getConnectionManager() - Method in class org.mule.extension.ftp.internal.FtpConnector
getConnectionTimeout() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
getConnectionTimeout() - Method in class org.mule.extension.ftp.internal.TimeoutSettings
getConnectionTimeoutUnit() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
getConnectionTimeoutUnit() - Method in class org.mule.extension.ftp.internal.TimeoutSettings
getCopyCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getCreateDirectoryCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getCurrentWorkingDirectory() - Method in class org.mule.extension.ftp.internal.command.FtpCommand
getDeleteCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getDescription() - Method in enum org.mule.extension.ftp.api.ftp.FtpTransferMode
getExistingFile(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Similar to FtpCommand.getFile(String) but throwing an IllegalArgumentException if the filePath doesn't exist
getFile(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Obtains a FtpFileAttributes for the given filePath by using the FTPClient.mlistFile(String) FTP command
getFile(String, boolean) - Method in class org.mule.extension.ftp.internal.command.FtpCommand
getFtpFileSystem() - Method in class org.mule.extension.ftp.internal.FtpInputStream
getHost() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
getListCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getMoveCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getMoveToDirectory() - Method in class org.mule.extension.ftp.internal.source.PostActionGroup
getName() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
getPassword() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
getPath() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
getPort() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
getReadCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getRenameCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
getRenameTo() - Method in class org.mule.extension.ftp.internal.source.PostActionGroup
getResponseTimeout() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
getResponseTimeout() - Method in class org.mule.extension.ftp.internal.TimeoutSettings
getResponseTimeoutUnit() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
getResponseTimeoutUnit() - Method in class org.mule.extension.ftp.internal.TimeoutSettings
getSize() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
getStreamSupplier(FtpFileAttributes, Supplier<ConnectionHandler<FtpFileSystem>>) - Static method in class org.mule.extension.ftp.internal.FtpInputStream
getTimestamp() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
getTimestampSince() - Method in class org.mule.extension.ftp.api.FtpFileMatcher
getTimestampUntil() - Method in class org.mule.extension.ftp.api.FtpFileMatcher
getUsername() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
getWorkingDir() - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
getWriteCommand() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem

I

isApplyPostActionWhenFailed() - Method in class org.mule.extension.ftp.internal.source.PostActionGroup
isAutoDelete() - Method in class org.mule.extension.ftp.internal.source.PostActionGroup
isConnected() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem
isDirectory() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
isRegularFile() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes
isSymbolicLink() - Method in class org.mule.extension.ftp.api.ftp.FtpFileAttributes

L

list(FileConnectorConfig, String, boolean, Predicate<FtpFileAttributes>) - Method in class org.mule.extension.ftp.internal.command.FtpListCommand
list(FileConnectorConfig, FtpFileSystem, String, boolean, FtpFileMatcher) - Method in class org.mule.extension.ftp.internal.FtpOperations: Lists all the files in the directoryPath which match the given matcher.

M

makeDirectory(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Creates the directory of the given directoryName in the current working directory
move(FileConnectorConfig, String, String, boolean, boolean, String) - Method in class org.mule.extension.ftp.internal.command.FtpMoveCommand
move(FileConnectorConfig, FileSystem, String, String, boolean, boolean, String) - Method in class org.mule.extension.ftp.internal.FtpOperations: Moves the file at the sourcePath into the targetPath.
MoveFtpDelegate - Class in org.mule.extension.ftp.internal.command
MoveFtpDelegate(FtpCommand, FtpFileSystem) - Constructor for class org.mule.extension.ftp.internal.command.MoveFtpDelegate

N

newInstance(FtpConnector, FtpFileAttributes, PathLock) - Static method in class org.mule.extension.ftp.internal.ClassicFtpInputStream: Establishes the underlying connection and returns a new instance of this class.
normalizePath(String) - Static method in class org.mule.extension.ftp.internal.FtpUtils
normalizePath(Path) - Static method in class org.mule.extension.ftp.internal.FtpUtils

O

onBorrow(FtpFileSystem) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
onError(PostActionGroup, SourceCallbackContext) - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
OnNewFileCommand - Class in org.mule.extension.ftp.internal.source: A FtpCommand which implements support functionality for FtpDirectoryListener
onRejectedItem(Result<InputStream, FtpFileAttributes>, SourceCallbackContext) - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
onSuccess(PostActionGroup, SourceCallbackContext) - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
onTerminate(SourceCallbackContext) - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
org.mule.extension.ftp.api - package org.mule.extension.ftp.api
org.mule.extension.ftp.api.ftp - package org.mule.extension.ftp.api.ftp
org.mule.extension.ftp.internal - package org.mule.extension.ftp.internal
org.mule.extension.ftp.internal.command - package org.mule.extension.ftp.internal.command
org.mule.extension.ftp.internal.connection - package org.mule.extension.ftp.internal.connection
org.mule.extension.ftp.internal.source - package org.mule.extension.ftp.internal.source

P

poll(PollContext<InputStream, FtpFileAttributes>) - Method in class org.mule.extension.ftp.internal.source.FtpDirectoryListener
PostActionGroup - Class in org.mule.extension.ftp.internal.source: Groups post processing action parameters
PostActionGroup() - Constructor for class org.mule.extension.ftp.internal.source.PostActionGroup
PostActionGroup(boolean, String, String, boolean) - Constructor for class org.mule.extension.ftp.internal.source.PostActionGroup

R

read(FileConnectorConfig, String, boolean) - Method in class org.mule.extension.ftp.internal.command.FtpReadCommand
read(FileConnectorConfig, FtpFileSystem, String, boolean) - Method in class org.mule.extension.ftp.internal.FtpOperations: Obtains the content and metadata of a file at a given path.
rename(String, String, boolean) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Renames the file at filePath to newName.
rename(String, String, boolean) - Method in class org.mule.extension.ftp.internal.command.FtpRenameCommand: Renames the file at filePath to newName.
rename(FileSystem, String, String, boolean) - Method in class org.mule.extension.ftp.internal.FtpOperations: Renames the file pointed by path to the name provided on the to parameter
resolvePath(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Returns a Path relative to the basePath and the given filePath
resolvePath(String) - Static method in class org.mule.extension.ftp.internal.FtpUtils
resolveRootPath(String) - Method in class org.mule.extension.ftp.internal.source.OnNewFileCommand: Resolves the root path on which the listener needs to be created
retrieveFileContent(FileAttributes) - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Returns an InputStream which obtains the content for the file of the given filePayload.
ROOT - Static variable in class org.mule.extension.ftp.internal.command.FtpCommand

S

setConnectionTimeout(Integer) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
setConnectionTimeout(Integer) - Method in class org.mule.extension.ftp.internal.TimeoutSettings
setConnectionTimeoutUnit(TimeUnit) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
setConnectionTimeoutUnit(TimeUnit) - Method in class org.mule.extension.ftp.internal.TimeoutSettings
setHost(String) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionSettings
setPassiveMode(boolean) - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: If passive is true then the FtpFileSystem.client is set on passive mode.
setResponseTimeout(Integer) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
setResponseTimeout(Integer, TimeUnit) - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Sets the data timeout property on the underlying FtpFileSystem.client
setResponseTimeout(Integer) - Method in class org.mule.extension.ftp.internal.TimeoutSettings
setResponseTimeoutUnit(TimeUnit) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider
setResponseTimeoutUnit(TimeUnit) - Method in class org.mule.extension.ftp.internal.TimeoutSettings
setTimestampSince(LocalDateTime) - Method in class org.mule.extension.ftp.api.FtpFileMatcher
setTimestampUntil(LocalDateTime) - Method in class org.mule.extension.ftp.api.FtpFileMatcher
setTransferMode(FtpTransferMode) - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Sets the transfer mode on the FtpFileSystem.client

T

TimeoutSettings - Class in org.mule.extension.ftp.internal: Groups timeout related parameters
TimeoutSettings() - Constructor for class org.mule.extension.ftp.internal.TimeoutSettings
tryChangeWorkingDirectory(String) - Method in class org.mule.extension.ftp.internal.command.FtpCommand: Attempts to change the current working directory.

V

validate(FtpFileSystem) - Method in class org.mule.extension.ftp.internal.connection.FtpConnectionProvider: Validates the connection by delegating into FtpFileSystem.validateConnection()
validateConnection() - Method in class org.mule.extension.ftp.internal.connection.FtpFileSystem: Validates the underlying connection to the remote server
validateSelf() - Method in class org.mule.extension.ftp.internal.source.PostActionGroup
valueOf(String) - Static method in enum org.mule.extension.ftp.api.ftp.FtpTransferMode: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mule.extension.ftp.api.ftp.FtpTransferMode: Returns an array containing the constants of this enum type, in the order they are declared.

W

write(String, InputStream, FileWriteMode, boolean, boolean, String) - Method in class org.mule.extension.ftp.internal.command.FtpWriteCommand
write(FileConnectorConfig, FileSystem, String, InputStream, String, boolean, boolean, FileWriteMode) - Method in class org.mule.extension.ftp.internal.FtpOperations: Writes the content into the file pointed by path.

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