How to use SftpClient method of com.consol.citrus.ftp.client.SftpClientBuilder class

Best Citrus code snippet using com.consol.citrus.ftp.client.SftpClientBuilder.SftpClient

Source:SftpClientBuilder.java

...21/**22 * @author Christoph Deppisch23 * @since 2.7.524 */25public class SftpClientBuilder extends AbstractEndpointBuilder<SftpClient> {26    /** Endpoint target */27    private SftpClient endpoint = new SftpClient();28    @Override29    protected SftpClient getEndpoint() {30        return endpoint;31    }32    /**33     * Sets the host property.34     * @param host35     * @return36     */37    public SftpClientBuilder host(String host) {38        endpoint.getEndpointConfiguration().setHost(host);39        return this;40    }41    /**42     * Sets the port property.43     * @param port44     * @return45     */46    public SftpClientBuilder port(int port) {47        endpoint.getEndpointConfiguration().setPort(port);48        return this;49    }50    /**51     * Sets the auto read files property.52     * @param autoReadFiles53     * @return54     */55    public SftpClientBuilder autoReadFiles(boolean autoReadFiles) {56        endpoint.getEndpointConfiguration().setAutoReadFiles(autoReadFiles);57        return this;58    }59    /**60     * Sets the local passive mode property.61     * @param localPassiveMode62     * @return63     */64    public SftpClientBuilder localPassiveMode(boolean localPassiveMode) {65        endpoint.getEndpointConfiguration().setLocalPassiveMode(localPassiveMode);66        return this;67    }68    /**69     * Sets the client username.70     * @param username71     * @return72     */73    public SftpClientBuilder username(String username) {74        endpoint.getEndpointConfiguration().setUser(username);75        return this;76    }77    /**78     * Sets the client password.79     * @param password80     * @return81     */82    public SftpClientBuilder password(String password) {83        endpoint.getEndpointConfiguration().setPassword(password);84        return this;85    }86    /**87     * Sets the privateKeyPath property.88     * @param privateKeyPath89     * @return90     */91    public SftpClientBuilder privateKeyPath(String privateKeyPath) {92        endpoint.getEndpointConfiguration().setPrivateKeyPath(privateKeyPath);93        return this;94    }95    /**96     * Sets the privateKeyPassword property.97     * @param privateKeyPassword98     * @return99     */100    public SftpClientBuilder privateKeyPassword(String privateKeyPassword) {101        endpoint.getEndpointConfiguration().setPrivateKeyPassword(privateKeyPassword);102        return this;103    }104    /**105     * Sets the strictHostChecking property.106     * @param strictHostChecking107     * @return108     */109    public SftpClientBuilder strictHostChecking(boolean strictHostChecking) {110        endpoint.getEndpointConfiguration().setStrictHostChecking(strictHostChecking);111        return this;112    }113    /**114     * Sets the knownHosts property.115     * @param knownHosts116     * @return117     */118    public SftpClientBuilder knownHosts(String knownHosts) {119        endpoint.getEndpointConfiguration().setKnownHosts(knownHosts);120        return this;121    }122    /**123     * Sets the preferred authentications property.124     * @param preferredAuthentications125     * @return126     */127    public SftpClientBuilder preferredAuthentications(String preferredAuthentications) {128        endpoint.getEndpointConfiguration().setPreferredAuthentications(preferredAuthentications);129        return this;130    }131    /**132     * Sets the sessionConfigs property.133     * @param sessionConfigs134     * @return135     */136    public SftpClientBuilder sessionConfigs(Map<String, String> sessionConfigs) {137        endpoint.getEndpointConfiguration().setSessionConfigs(sessionConfigs);138        return this;139    }140    /**141     * Sets the message correlator.142     * @param correlator143     * @return144     */145    public SftpClientBuilder correlator(MessageCorrelator correlator) {146        endpoint.getEndpointConfiguration().setCorrelator(correlator);147        return this;148    }149    /**150     * Sets the error handling strategy.151     * @param errorStrategy152     * @return153     */154    public SftpClientBuilder errorHandlingStrategy(ErrorHandlingStrategy errorStrategy) {155        endpoint.getEndpointConfiguration().setErrorHandlingStrategy(errorStrategy);156        return this;157    }158    /**159     * Sets the polling interval.160     * @param pollingInterval161     * @return162     */163    public SftpClientBuilder pollingInterval(int pollingInterval) {164        endpoint.getEndpointConfiguration().setPollingInterval(pollingInterval);165        return this;166    }167    /**168     * Sets the default timeout.169     * @param timeout170     * @return171     */172    public SftpClientBuilder timeout(long timeout) {173        endpoint.getEndpointConfiguration().setTimeout(timeout);174        return this;175    }176}...

Source:SftpClientConfigParser.java

...16package com.consol.citrus.ftp.config.annotation;17import com.consol.citrus.TestActor;18import com.consol.citrus.config.annotation.AbstractAnnotationConfigParser;19import com.consol.citrus.context.ReferenceResolver;20import com.consol.citrus.ftp.client.SftpClient;21import com.consol.citrus.ftp.client.SftpClientBuilder;22import com.consol.citrus.message.MessageCorrelator;23import org.springframework.util.StringUtils;24import java.util.Map;25/**26 * @author Christoph Deppisch27 * @since 2.7.528 */29public class SftpClientConfigParser extends AbstractAnnotationConfigParser<SftpClientConfig, SftpClient> {30    /**31     * Constructor matching super.32     * @param referenceResolver33     */34    public SftpClientConfigParser(ReferenceResolver referenceResolver) {35        super(referenceResolver);36    }37    @Override38    public SftpClient parse(SftpClientConfig annotation) {39        SftpClientBuilder builder = new SftpClientBuilder();40        if (StringUtils.hasText(annotation.host())) {41            builder.host(annotation.host());42        }43        builder.port(annotation.port());44        builder.autoReadFiles(annotation.autoReadFiles());45        builder.localPassiveMode(annotation.localPassiveMode());46        if (StringUtils.hasText(annotation.username())) {47            builder.username(annotation.username());48        }49        if (StringUtils.hasText(annotation.password())) {50            builder.password(annotation.password());51        }52        if (StringUtils.hasText(annotation.privateKeyPath())) {53            builder.privateKeyPath(annotation.privateKeyPath());...

SftpClient

Using AI Code Generation

1import com.consol.citrus.ftp.client.SftpClientBuilder;2import com.consol.citrus.ftp.client.SftpClient;3import com.consol.citrus.ftp.message.FtpMessageHeaders;4import com.consol.citrus.ftp.message.FtpMessage;5import com.consol.citrus.context.TestContext;6import com.consol.citrus.exceptions.CitrusRuntimeException;7import com.consol.citrus.message.MessageType;8import com.consol.citrus.message.Message;9import com.consol.citrus.message.MessageBuilder;10import com.consol.citrus.spi.ReferenceResolver;11import com.consol.citrus.spi.ReferenceResolverAware;12import com.consol.citrus.spi.ReferenceResolverFactory;13import com.consol.citrus.spi.ReferenceResolverFactoryAware;14import com.consol.citrus.spi.ReferenceResolverFactoryBean;15import com.consol.citrus.spi.ReferenceResolverB

SftpClient

Using AI Code Generation

1import com.consol.citrus.ftp.client.FtpClientBuilder;2import com.consol.citrus.ftp.client.SftpClientBuilder;3import org.springframework.context.annotation.Bean;4import org.springframework.context.annotation.Configuration;5import org.springframework.context.annotation.DependsOn;6import org.springframework.integration.sftp.session.DefaultSftpSessionFactory;7import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;8public class SftpClientConfig {9    public DefaultSftpSessionFactory sftpSessionFactory() {10        DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory();11        factory.setHost("localhost");12        factory.setPort(22);13        factory.setUser("user");14        factory.setPassword("password");15        return factory;16    }17    public SftpRemoteFileTemplate sftpRemoteFileTemplate() {18        return new SftpRemoteFileTemplate(sftpSessionFactory());19    }20    @DependsOn("sftpRemoteFileTemplate")21    public SftpClientBuilder sftpClientBuilder() {22        return new SftpClientBuilder()23                .sftpRemoteFileTemplate(sftpRemoteFileTemplate());24    }25}26import com.consol.citrus.ftp.client.SftpClientBuilder;27import org.springframework.context.annotation.Bean;28import org.springframework.context.annotation.Configuration;29import org.springframework.context.annotation.DependsOn;30import org.springframework.integration.sftp.session.DefaultSftpSessionFactory;31import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;32public class SftpClientConfig {33    public DefaultSftpSessionFactory sftpSessionFactory() {34        DefaultSftpSessionFactory factory = new DefaultSftpSessionFactory();35        factory.setHost("localhost");36        factory.setPort(22);37        factory.setUser("user");38        factory.setPassword("password");39        return factory;40    }41    public SftpRemoteFileTemplate sftpRemoteFileTemplate() {42        return new SftpRemoteFileTemplate(sftpSessionFactory());43    }44    @DependsOn("sftpRemoteFileTemplate")45    public SftpClientBuilder sftpClientBuilder() {46        return new SftpClientBuilder()47                .sftpRemoteFileTemplate(sftpRemoteFileTemplate());48    }49}

SftpClient

Using AI Code Generation

1package com.consol.citrus.ftp.client;2import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;3import org.testng.annotations.Test;4public class SftpClientIT extends TestNGCitrusTestDesigner {5    public void sftpClient() {6        variable("username", "user");7        variable("password", "password");8        variable("localFile", "src/test/resources/test.txt");9        variable("remoteFile", "target/test.txt");10        sftp(action -> action11            .client("sftpClient")12            .put("${localFile}", "${remoteFile}")13        );14    }15}16package com.consol.citrus.ftp.client;17import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;18import org.testng.annotations.Test;19public class SftpClientIT extends TestNGCitrusTestDesigner {20    public void sftpClient() {21        variable("username", "user");22        variable("password", "password");23        variable("localFile", "src/test/resources/test.txt");24        variable("remoteFile", "target/test.txt");25        sftp(action -> action26            .client("sftpClient")27            .get("${remoteFile}", "${localFile}")28        );29    }30}31package com.consol.citrus.ftp.client;32import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;33import org.testng.annotations.Test;34public class SftpClientIT extends TestNGCitrusTestDesigner {35    public void sftpClient() {36        variable("username", "user");37        variable("password", "password");38        variable("localFile", "src/test/resources/test.txt");39        variable("remoteFile", "target/test.txt");40        sftp(action -> action41            .client("sftpClient")42            .delete("${remoteFile}")43        );44    }45}46package com.consol.citrus.ftp.client;47import com.consol.citrus.dsl

SftpClient

Using AI Code Generation

1package com.consol.citrus.ftp.client;2import java.io.File;3import org.springframework.context.annotation.Bean;4import org.springframework.context.annotation.Configuration;5import com.consol.citrus.dsl.endpoint.CitrusEndpoints;6import com.consol.citrus.sftp.client.SftpClient;7public class SftpClientConfig {8public SftpClient sftpClient() {9return CitrusEndpoints.sftp()10.client()11.host("localhost")12.port(22)13.username("user")14.password("password")15.privateKey(new File("src/test/resources/ssh/id_rsa"))16.privateKeyPassphrase("passphrase")17.build();18}19}20package com.consol.citrus.ftp.client;21import java.io.File;22import org.springframework.context.annotation.Bean;23import org.springframework.context.annotation.Configuration;24import com.consol.citrus.dsl.endpoint.CitrusEndpoints;25import com.consol.citrus.sftp.client.SftpClient;26public class SftpClientConfig {27public SftpClient sftpClient() {28return CitrusEndpoints.sftp()29.client()30.host("localhost")31.port(22)32.username("user")33.password("password")34.privateKey(new File("src/test/resources/ssh/id_rsa"))35.privateKeyPassphrase("passphrase")36.build();37}38}39package com.consol.citrus.ftp.client;40import java.io.File;41import org.springframework.context.annotation.Bean;42import org.springframework.context.annotation.Configuration;43import com.consol.citrus.dsl.endpoint.CitrusEndpoints;44import com.consol.citrus.sftp.client.SftpClient;45public class SftpClientConfig {46public SftpClient sftpClient() {47return CitrusEndpoints.sftp()48.client()49.host("localhost")50.port(22)51.username("user")52.password("password")53.privateKey(new File("src/test/resources/ssh/id_rsa"))54.privateKeyPassphrase("passphrase")55.build();56}57}58package com.consol.citrus.ftp.client;59import java.io.File;60import org.springframework.context.annotation

SftpClient

Using AI Code Generation

1public class 3 {2    public static void main(String[] args) {3                .sftp()4                .host("localhost")5                .port(22)6                .username("user")7                .password("password")8                .build();9        sftpClient.send("localFile.txt", "remoteFile.txt");10        sftpClient.close();11    }12}13public class 4 {14    public static void main(String[] args) {15                .sftp()16                .host("localhost")17                .port(22)18                .username("user")19                .password("password")20                .build();21        sftpClient.send("localFile.txt", "remoteFile.txt");22        sftpClient.close();23    }24}25public class 5 {26    public static void main(String[] args) {27                .sftp()28                .host("localhost")29                .port(22)30                .username("user")31                .password("password")32                .build();33        sftpClient.send("localFile.txt", "remoteFile.txt");34        sftpClient.close();35    }36}37public class 6 {38    public static void main(String[] args) {39                .sftp()40                .host("localhost")41                .port(22)42                .username("user")43                .password("password")44                .build();45        sftpClient.send("localFile.txt", "remoteFile.txt");46        sftpClient.close();47    }48}49public class 7 {50    public static void main(String[] args) {

SftpClient

Using AI Code Generation

1public class SftpClientBuilder {2    private SftpClient sftpClient;3    private SftpClientBuilder() {4        sftpClient = new SftpClient();5    }6    public static SftpClientBuilder sftp() {7        return new SftpClientBuilder();8    }9    public SftpClientBuilder host(String host) {10        sftpClient.setHost(host);11        return this;12    }13    public SftpClientBuilder port(int port) {14        sftpClient.setPort(port);15        return this;16    }17    public SftpClientBuilder user(String user) {18        sftpClient.setUser(user);19        return this;20    }21    public SftpClientBuilder password(String password) {22        sftpClient.setPassword(password);23        return this;24    }25    public SftpClientBuilder timeout(long timeout) {26        sftpClient.setTimeout(timeout);27        return this;28    }29    public SftpClientBuilder strictHostKeyChecking(boolean strictHostKeyChecking) {30        sftpClient.setStrictHostKeyChecking(strictHostKeyChecking);31        return this;32    }33    public SftpClientBuilder privateKey(String privateKey) {34        sftpClient.setPrivateKey(privateKey);35        return this;36    }37    public SftpClientBuilder privateKeyResource(Resource privateKeyResource) {38        sftpClient.setPrivateKeyResource(privateKeyResource);39        return this;40    }41    public SftpClientBuilder privateKeyPassphrase(String privateKeyPassphrase) {42        sftpClient.setPrivateKeyPassphrase(privateKeyPassphrase);43        return this;44    }45    public SftpClientBuilder knownHosts(String knownHosts) {46        sftpClient.setKnownHosts(knownHosts);47        return this;48    }49    public SftpClientBuilder knownHostsResource(Resource knownHostsResource) {50        sftpClient.setKnownHostsResource(knownHostsResource);51        return this;52    }53    public SftpClientBuilder knownHostsResource(Resource knownHostsResource, boolean strictHostKeyChecking) {54        sftpClient.setKnownHostsResource(knownHostsResource);55        sftpClient.setStrictHostKeyChecking(strictHostKeyChecking);56        return this;57    }58    public SftpClientBuilder knownHostsResource(Resource knownHostsResource, boolean strictHostKeyChecking, String knownHosts) {59        sftpClient.setKnownHostsResource(knownHostsResource);60        sftpClient.setStrictHostKeyChecking(strictHostKeyChecking);

SftpClient

Using AI Code Generation

1public class SftpClientBuilderTest {2    public static void main(String[] args) {3        SftpClientBuilder builder = new SftpClientBuilder();4        builder.host("localhost");5        builder.port(22);6        builder.username("username");7        builder.password("password");8        builder.timeout(10000);9        builder.autoCreateLocalDirectory(true);10        builder.autoCreateRemoteDirectory(true);11        builder.autoCreateLocalDirectory(true);

SftpClient

Using AI Code Generation

1public class 3 {2    public void test3() {3        given()4            .client("sftpClient")5            .send()6            .put("localPath", "remotePath");7    }8}9public class 4 {10    public void test4() {11        given()12            .client("sftpClient")13            .send()14            .put("localPath", "remotePath", "fileMode");15    }16}17public class 5 {18    public void test5() {19        given()20            .client("sftpClient")21            .send()22            .put("localPath", "remotePath", "fileMode", "time");23    }24}25public class 6 {26    public void test6() {27        given()28            .client("sftpClient")29            .send()30            .put("localPath", "remotePath", "fileMode", "time", "fileType");31    }32}33public class 7 {34    public void test7() {35        given()36            .client("sftpClient")37            .send()38            .put("localPath", "remotePath", "fileMode", "time", "fileType", "link");39    }40}41public class 8 {42    public void test8() {43        given()44            .client("sftpClient")45            .send()46            .put("localPath", "remotePath", "fileMode", "time", "fileType", "link", "progressMonitor");47    }48}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.