Package com.consol.citrus.ftp.client

Class SftpClient

java.lang.Object

com.consol.citrus.endpoint.AbstractEndpoint

com.consol.citrus.ftp.client.FtpClient

com.consol.citrus.ftp.client.SftpClient

All Implemented Interfaces:

com.consol.citrus.common.InitializingPhase, com.consol.citrus.common.Named, com.consol.citrus.common.ShutdownPhase, com.consol.citrus.endpoint.Endpoint, com.consol.citrus.messaging.Consumer, com.consol.citrus.messaging.Producer, com.consol.citrus.messaging.ReplyConsumer, com.consol.citrus.messaging.SelectiveConsumer

Direct Known Subclasses:

ScpClient

public class SftpClient
extends FtpClient

Since:

2.7.5

Author:

Christoph Deppisch

Constructor Summary

Constructors

Modifier	Constructor	Description
	SftpClient()	Default constructor initializing endpoint configuration.
protected	SftpClient(SftpEndpointConfiguration endpointConfiguration)	Default constructor using endpoint configuration.

Method Summary

Modifier and Type	Method	Description
protected void	connectAndLogin()	Opens a new connection and performs login with user name and password if set.
protected FtpMessage	createDir(CommandType ftpCommand)	Execute mkDir command and create new directory.
protected FtpMessage	deleteFile(DeleteCommand delete, com.consol.citrus.context.TestContext context)	Performs delete file operation.
void	destroy()
protected FtpMessage	executeCommand(CommandType ftpCommand, com.consol.citrus.context.TestContext context)
SftpEndpointConfiguration	getEndpointConfiguration()
protected String	getPrivateKeyPath()
com.jcraft.jsch.JSch	getSsh()	Gets the ssh.
void	initialize()
protected boolean	isDirectory(String remoteFilePath)	Check file path type directory or file.
protected FtpMessage	listFiles(ListCommand list, com.consol.citrus.context.TestContext context)	Perform list files operation and provide file information as response.
protected FtpMessage	retrieveFile(GetCommand command, com.consol.citrus.context.TestContext context)	Performs retrieve file operation.
void	setSsh(com.jcraft.jsch.JSch ssh)	Sets the ssh.
protected FtpMessage	storeFile(PutCommand command, com.consol.citrus.context.TestContext context)	Performs store file operation.

Methods inherited from class com.consol.citrus.ftp.client.FtpClient

addFileNameToTargetPath, createConsumer, createProducer, getFtpClient, getLocalFileInputStream, receive, receive, receive, receive, send, setCorrelationManager, setFtpClient

Methods inherited from class com.consol.citrus.endpoint.AbstractEndpoint

getActor, getConsumerName, getName, getProducerName, setActor, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.consol.citrus.messaging.Consumer

getName

Methods inherited from interface com.consol.citrus.messaging.Producer

getName

Constructor Detail

SftpClient

public SftpClient()

Default constructor initializing endpoint configuration.

SftpClient

protected SftpClient(SftpEndpointConfiguration endpointConfiguration)

Default constructor using endpoint configuration.

Parameters:

endpointConfiguration -

Method Detail

getEndpointConfiguration

public SftpEndpointConfiguration getEndpointConfiguration()

Specified by:

getEndpointConfiguration in interface com.consol.citrus.endpoint.Endpoint

Overrides:

getEndpointConfiguration in class FtpClient

executeCommand

protected FtpMessage executeCommand(CommandType ftpCommand,
                                    com.consol.citrus.context.TestContext context)

Overrides:

executeCommand in class FtpClient

createDir

protected FtpMessage createDir(CommandType ftpCommand)

Execute mkDir command and create new directory.

Parameters:

ftpCommand -

Returns:

listFiles

protected FtpMessage listFiles(ListCommand list,
                               com.consol.citrus.context.TestContext context)

Description copied from class: FtpClient

Perform list files operation and provide file information as response.

Overrides:

listFiles in class FtpClient

Returns:

deleteFile

protected FtpMessage deleteFile(DeleteCommand delete,
                                com.consol.citrus.context.TestContext context)

Description copied from class: FtpClient

Performs delete file operation.

Overrides:

deleteFile in class FtpClient

isDirectory

protected boolean isDirectory(String remoteFilePath)

Description copied from class: FtpClient

Check file path type directory or file.

Overrides:

isDirectory in class FtpClient

Returns:

storeFile

protected FtpMessage storeFile(PutCommand command,
                               com.consol.citrus.context.TestContext context)

Description copied from class: FtpClient

Performs store file operation.

Overrides:

storeFile in class FtpClient

retrieveFile

protected FtpMessage retrieveFile(GetCommand command,
                                  com.consol.citrus.context.TestContext context)

Description copied from class: FtpClient

Performs retrieve file operation.

Overrides:

retrieveFile in class FtpClient

connectAndLogin

protected void connectAndLogin()

Description copied from class: FtpClient

Opens a new connection and performs login with user name and password if set.

Overrides:

connectAndLogin in class FtpClient

getPrivateKeyPath

protected String getPrivateKeyPath()
                            throws IOException

Throws:

IOException

initialize

public void initialize()

Specified by:

initialize in interface com.consol.citrus.common.InitializingPhase

Overrides:

initialize in class FtpClient

destroy

public void destroy()

Specified by:

destroy in interface com.consol.citrus.common.ShutdownPhase

Overrides:

destroy in class FtpClient

getSsh

public com.jcraft.jsch.JSch getSsh()

Gets the ssh.

Returns:

setSsh

public void setSsh(com.jcraft.jsch.JSch ssh)

Sets the ssh.

Parameters:

ssh -