org.mule.extension.ftp.internal.sftp.connection

Class SftpClient

java.lang.Object

org.mule.extension.ftp.internal.sftp.connection.SftpClient

public class SftpClient
extends Object

Wrapper around jsch sftp library which provides access to basic sftp commands.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANNEL_SFTP
static String	PREFERRED_AUTHENTICATION_METHODS
static String	STRICT_HOST_KEY_CHECKING

Constructor Summary

Constructors

Constructor and Description
SftpClient(String host, int port, com.google.common.base.Supplier<com.jcraft.jsch.JSch> jSchSupplier) Creates a new instance which connects to a server on a given host and port

Method Summary

Modifier and Type	Method and Description
void	changeWorkingDirectory(String path) Changes the current working directory to wd
void	deleteDirectory(String path) Deletes the directory at path.
void	deleteFile(String path) Deletes the file at the given path
void	disconnect() Closes the active session and severs the connection (if any of those were active)
protected RuntimeException	exception(String message, Exception cause)
SftpFileAttributes	getAttributes(Path path) Gets the attributes for the file in the given {code path}
InputStream	getFileContent(String path) An InputStream with the contents of the file at the given path
String	getHost()
OutputStream	getOutputStream(String path, org.mule.extension.file.common.api.FileWriteMode mode) Opens an OutputStream which allows writing into the file pointed by path
int	getPort()
String	getWorkingDirectory()
boolean	isConnected()
List<SftpFileAttributes>	list(String path) Lists the contents of the directory at the given path
void	login(String user) Performs a login operation for the given user using the connection options and additional credentials optionally set on this client
void	mkdir(String directoryName) Creates a directory
void	rename(String sourcePath, String target) Renames the file at sourcePath to target
void	setConnectionTimeoutMillis(long connectionTimeoutMillis)
void	setIdentity(String identityFilePath, String passphrase)
void	setKnownHostsFile(String knownHostsFile)
void	setPassword(String password)
void	setPreferredAuthenticationMethods(String preferredAuthenticationMethods)
void	write(String path, InputStream stream, org.mule.extension.file.common.api.FileWriteMode mode) Writes the contents of the stream into the file at the given path

Methods inherited from class java.lang.Object

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

Field Detail

CHANNEL_SFTP

public static final String CHANNEL_SFTP

See Also:

Constant Field Values

STRICT_HOST_KEY_CHECKING

public static final String STRICT_HOST_KEY_CHECKING

See Also:

Constant Field Values

PREFERRED_AUTHENTICATION_METHODS

public static final String PREFERRED_AUTHENTICATION_METHODS

See Also:

Constant Field Values

Constructor Detail

SftpClient

public SftpClient(String host,
                  int port,
                  com.google.common.base.Supplier<com.jcraft.jsch.JSch> jSchSupplier)

Creates a new instance which connects to a server on a given host and port

Parameters:

host - the host address

port - the remote connection port

jSchSupplier - a Supplier for obtaining a JSch client

Method Detail

getWorkingDirectory

public String getWorkingDirectory()

Returns:

the current working directory

changeWorkingDirectory

public void changeWorkingDirectory(String path)

Changes the current working directory to wd

Parameters:

path - the new working directory path

getAttributes

public SftpFileAttributes getAttributes(Path path)

Gets the attributes for the file in the given {code path}

Parameters:

path - the file's path

Returns:

a SftpFileAttributes or null if the file doesn't exists.

login

public void login(String user)
           throws IOException,
                  com.jcraft.jsch.JSchException

Performs a login operation for the given user using the connection options and additional credentials optionally set on this client

Parameters:

user - the authentication user

Throws:

IOException

com.jcraft.jsch.JSchException

rename

public void rename(String sourcePath,
                   String target)
            throws IOException

Renames the file at sourcePath to target

Parameters:

sourcePath - the path to the renamed file

target - the new path

Throws:

IOException

deleteFile

public void deleteFile(String path)

Deletes the file at the given path

Parameters:

path - the path to the file to be deleted

disconnect

public void disconnect()

Closes the active session and severs the connection (if any of those were active)

isConnected

public boolean isConnected()

Returns:

whether this client is currently connected and logged into the remote server

list

public List<SftpFileAttributes> list(String path)

Lists the contents of the directory at the given path

Parameters:

path - the path to list

Returns:

a immutable List of . Might be empty but will never be null

getFileContent

public InputStream getFileContent(String path)

An InputStream with the contents of the file at the given path

Parameters:

path - the path to the file to read

Returns:

an InputStream

write

public void write(String path,
                  InputStream stream,
                  org.mule.extension.file.common.api.FileWriteMode mode)
           throws Exception

Writes the contents of the stream into the file at the given path

Parameters:

path - the path to write into

stream - the content to be written

mode - the write mode

Throws:

Exception - if anything goes wrong

getOutputStream

public OutputStream getOutputStream(String path,
                                    org.mule.extension.file.common.api.FileWriteMode mode)
                             throws Exception

Opens an OutputStream which allows writing into the file pointed by path

Parameters:

path - the path to write into

mode - the write mode

Returns:

an OutputStream

Throws:

Exception

mkdir

public void mkdir(String directoryName)

Creates a directory

Parameters:

directoryName - The directory name

Throws:

IOException - If an error occurs

deleteDirectory

public void deleteDirectory(String path)

Deletes the directory at path.

The directory is expected to be empty

Parameters:

path - the path of the directory to be deleted

getHost

public String getHost()

setPreferredAuthenticationMethods

public void setPreferredAuthenticationMethods(String preferredAuthenticationMethods)

exception

protected RuntimeException exception(String message,
                                     Exception cause)

setKnownHostsFile

public void setKnownHostsFile(String knownHostsFile)

setPassword

public void setPassword(String password)

setIdentity

public void setIdentity(String identityFilePath,
                        String passphrase)

getPort

public int getPort()

setConnectionTimeoutMillis

public void setConnectionTimeoutMillis(long connectionTimeoutMillis)