Package com.consol.citrus.ftp.client

Class SftpClientBuilder

java.lang.Object

com.consol.citrus.endpoint.AbstractEndpointBuilder<SftpClient>

com.consol.citrus.ftp.client.SftpClientBuilder

All Implemented Interfaces:

EndpointBuilder<SftpClient>

public class SftpClientBuilder
extends AbstractEndpointBuilder<SftpClient>

Since:

2.7.5

Author:

Christoph Deppisch

Field Summary

Fields inherited from interface com.consol.citrus.endpoint.EndpointBuilder

LOG, RESOURCE_PATH, TYPE_RESOLVER

Constructor Summary

Constructors

Constructor	Description
SftpClientBuilder()

Method Summary

Modifier and Type	Method	Description
SftpClientBuilder	autoReadFiles(boolean autoReadFiles)	Sets the auto read files property.
SftpClientBuilder	correlator(MessageCorrelator correlator)	Sets the message correlator.
SftpClientBuilder	errorHandlingStrategy(ErrorHandlingStrategy errorStrategy)	Sets the error handling strategy.
protected SftpClient	getEndpoint()
SftpClientBuilder	host(String host)	Sets the host property.
SftpClientBuilder	knownHosts(String knownHosts)	Sets the knownHosts property.
SftpClientBuilder	localPassiveMode(boolean localPassiveMode)	Sets the local passive mode property.
SftpClientBuilder	password(String password)	Sets the client password.
SftpClientBuilder	pollingInterval(int pollingInterval)	Sets the polling interval.
SftpClientBuilder	port(int port)	Sets the port property.
SftpClientBuilder	preferredAuthentications(String preferredAuthentications)	Sets the preferred authentications property.
SftpClientBuilder	privateKeyPassword(String privateKeyPassword)	Sets the privateKeyPassword property.
SftpClientBuilder	privateKeyPath(String privateKeyPath)	Sets the privateKeyPath property.
SftpClientBuilder	sessionConfigs(Map<String,String> sessionConfigs)	Sets the sessionConfigs property.
SftpClientBuilder	strictHostChecking(boolean strictHostChecking)	Sets the strictHostChecking property.
SftpClientBuilder	timeout(long timeout)	Sets the default timeout.
SftpClientBuilder	username(String username)	Sets the client username.

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

actor, build, initialize, name, referenceResolver, supports

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.endpoint.EndpointBuilder

build, build

Constructor Detail

SftpClientBuilder

public SftpClientBuilder()

Method Detail

getEndpoint

protected SftpClient getEndpoint()

Specified by:

getEndpoint in class AbstractEndpointBuilder<SftpClient>

host

public SftpClientBuilder host(String host)

Sets the host property.

Parameters:

host -

Returns:

port

public SftpClientBuilder port(int port)

Sets the port property.

Parameters:

port -

Returns:

autoReadFiles

public SftpClientBuilder autoReadFiles(boolean autoReadFiles)

Sets the auto read files property.

Parameters:

autoReadFiles -

Returns:

localPassiveMode

public SftpClientBuilder localPassiveMode(boolean localPassiveMode)

Sets the local passive mode property.

Parameters:

localPassiveMode -

Returns:

username

public SftpClientBuilder username(String username)

Sets the client username.

Parameters:

username -

Returns:

password

public SftpClientBuilder password(String password)

Sets the client password.

Parameters:

password -

Returns:

privateKeyPath

public SftpClientBuilder privateKeyPath(String privateKeyPath)

Sets the privateKeyPath property.

Parameters:

privateKeyPath -

Returns:

privateKeyPassword

public SftpClientBuilder privateKeyPassword(String privateKeyPassword)

Sets the privateKeyPassword property.

Parameters:

privateKeyPassword -

Returns:

strictHostChecking

public SftpClientBuilder strictHostChecking(boolean strictHostChecking)

Sets the strictHostChecking property.

Parameters:

strictHostChecking -

Returns:

knownHosts

public SftpClientBuilder knownHosts(String knownHosts)

Sets the knownHosts property.

Parameters:

knownHosts -

Returns:

preferredAuthentications

public SftpClientBuilder preferredAuthentications(String preferredAuthentications)

Sets the preferred authentications property.

Parameters:

preferredAuthentications -

Returns:

sessionConfigs

public SftpClientBuilder sessionConfigs(Map<String,String> sessionConfigs)

Sets the sessionConfigs property.

Parameters:

sessionConfigs -

Returns:

correlator

public SftpClientBuilder correlator(MessageCorrelator correlator)

Sets the message correlator.

Parameters:

correlator -

Returns:

errorHandlingStrategy

public SftpClientBuilder errorHandlingStrategy(ErrorHandlingStrategy errorStrategy)

Sets the error handling strategy.

Parameters:

errorStrategy -

Returns:

pollingInterval

public SftpClientBuilder pollingInterval(int pollingInterval)

Sets the polling interval.

Parameters:

pollingInterval -

Returns:

timeout

public SftpClientBuilder timeout(long timeout)

Sets the default timeout.

Parameters:

timeout -

Returns: