Package com.consol.citrus.ftp.client

Class ScpClient

java.lang.Object

com.consol.citrus.endpoint.AbstractEndpoint

com.consol.citrus.ftp.client.FtpClient

com.consol.citrus.ftp.client.SftpClient

com.consol.citrus.ftp.client.ScpClient

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

public class ScpClient
extends SftpClient

Since:

2.7.6

Author:

Christoph Deppisch

Constructor Summary

Constructors

Modifier	Constructor	Description
	ScpClient()	Default constructor initializing endpoint configuration.
protected	ScpClient(ScpEndpointConfiguration 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()
ScpEndpointConfiguration	getEndpointConfiguration()
void	initialize()
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.
protected FtpMessage	storeFile(PutCommand command, com.consol.citrus.context.TestContext context)	Performs store file operation.

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

executeCommand, getPrivateKeyPath, getSsh, isDirectory, setSsh

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

ScpClient

public ScpClient()

Default constructor initializing endpoint configuration.

ScpClient

protected ScpClient(ScpEndpointConfiguration endpointConfiguration)

Default constructor using endpoint configuration.

Parameters:

endpointConfiguration -

Method Detail

getEndpointConfiguration

public ScpEndpointConfiguration getEndpointConfiguration()

Specified by:

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

Overrides:

getEndpointConfiguration in class SftpClient

createDir

protected FtpMessage createDir(CommandType ftpCommand)

Description copied from class: SftpClient

Execute mkDir command and create new directory.

Overrides:

createDir in class SftpClient

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 SftpClient

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 SftpClient

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 SftpClient

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 SftpClient

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 SftpClient

initialize

public void initialize()

Specified by:

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

Overrides:

initialize in class SftpClient

destroy

public void destroy()

Specified by:

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

Overrides:

destroy in class SftpClient