org.mule.extension.ftp.internal.sftp.command

Class SftpRenameCommand

java.lang.Object

org.mule.extension.file.common.api.command.FileCommand<C>

org.mule.extension.ftp.internal.ftp.command.FtpCommand<SftpFileSystem>

org.mule.extension.ftp.internal.sftp.command.SftpCommand

org.mule.extension.ftp.internal.sftp.command.SftpRenameCommand

All Implemented Interfaces:

org.mule.extension.file.common.api.command.RenameCommand

public final class SftpRenameCommand
extends SftpCommand
implements org.mule.extension.file.common.api.command.RenameCommand

A SftpCommand which implements the RenameCommand contract

Since:

4.0

Field Summary

Fields inherited from class org.mule.extension.ftp.internal.sftp.command.SftpCommand

client

Fields inherited from class org.mule.extension.file.common.api.command.FileCommand

fileSystem

Constructor Summary

Constructors

Constructor and Description
SftpRenameCommand(SftpFileSystem fileSystem, SftpClient client)

Method Summary

Modifier and Type	Method and Description
void	rename(String filePath, String newName, boolean overwrite) Template method that renames the file at filePath to newName.

Methods inherited from class org.mule.extension.ftp.internal.sftp.command.SftpCommand

doMkDirs, doRename, getCurrentWorkingDirectory, getFile, tryChangeWorkingDirectory

Methods inherited from class org.mule.extension.ftp.internal.ftp.command.FtpCommand

changeWorkingDirectory, changeWorkingDirectory, copy, createDirectory, exists, getBasePath, getExistingFile, getFile

Methods inherited from class org.mule.extension.file.common.api.command.FileCommand

alreadyExistsException, assureParentFolderExists, cannotListFileException, cannotReadDirectoryException, exception, exception, isVirtualDirectory, mkdirs, pathNotFoundException, resolveExistingPath, resolvePath

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpRenameCommand

public SftpRenameCommand(SftpFileSystem fileSystem,
                         SftpClient client)

Method Detail

rename

public void rename(String filePath,
                   String newName,
                   boolean overwrite)

Template method that renames the file at filePath to newName.

This method performs path resolution and validation and eventually delegates into FtpCommand.doRename(String, String), in which the actual renaming implementation is.

Specified by:

rename in interface org.mule.extension.file.common.api.command.RenameCommand

Overrides:

rename in class FtpCommand<SftpFileSystem>

Parameters:

filePath - the path of the file to be renamed

newName - the new name

overwrite - whether to overwrite the target file if it already exists