Class SshClientBuilder

java.lang.Object
org.citrusframework.endpoint.AbstractEndpointBuilder<SshClient>
org.citrusframework.ssh.client.SshClientBuilder
All Implemented Interfaces:
EndpointBuilder<SshClient>

public class SshClientBuilder extends AbstractEndpointBuilder<SshClient>
Since:
2.5
Author:
Christoph Deppisch
  • Constructor Details

    • SshClientBuilder

      public SshClientBuilder()
  • Method Details

    • getEndpoint

      protected SshClient getEndpoint()
      Specified by:
      getEndpoint in class AbstractEndpointBuilder<SshClient>
    • host

      public SshClientBuilder host(String host)
      Sets the host property.
      Parameters:
      host -
      Returns:
    • port

      public SshClientBuilder port(int port)
      Sets the port property.
      Parameters:
      port -
      Returns:
    • user

      public SshClientBuilder user(String user)
      Sets the user property.
      Parameters:
      user -
      Returns:
    • password

      public SshClientBuilder password(String password)
      Sets the client password.
      Parameters:
      password -
      Returns:
    • privateKeyPath

      public SshClientBuilder privateKeyPath(String privateKeyPath)
      Sets the privateKeyPath property.
      Parameters:
      privateKeyPath -
      Returns:
    • privateKeyPassword

      public SshClientBuilder privateKeyPassword(String privateKeyPassword)
      Sets the privateKeyPassword property.
      Parameters:
      privateKeyPassword -
      Returns:
    • strictHostChecking

      public SshClientBuilder strictHostChecking(boolean strictHostChecking)
      Sets the strictHostChecking property.
      Parameters:
      strictHostChecking -
      Returns:
    • knownHosts

      public SshClientBuilder knownHosts(String knownHosts)
      Sets the knownHosts property.
      Parameters:
      knownHosts -
      Returns:
    • commandTimeout

      public SshClientBuilder commandTimeout(long commandTimeout)
      Sets the commandTimeout property.
      Parameters:
      commandTimeout -
      Returns:
    • connectionTimeout

      public SshClientBuilder connectionTimeout(int connectionTimeout)
      Sets the connectionTimeout property.
      Parameters:
      connectionTimeout -
      Returns:
    • messageConverter

      public SshClientBuilder messageConverter(SshMessageConverter messageConverter)
      Sets the message converter.
      Parameters:
      messageConverter -
      Returns:
    • correlator

      public SshClientBuilder correlator(MessageCorrelator correlator)
      Sets the message correlator.
      Parameters:
      correlator -
      Returns:
    • pollingInterval

      public SshClientBuilder pollingInterval(int pollingInterval)
      Sets the polling interval.
      Parameters:
      pollingInterval -
      Returns:
    • timeout

      public SshClientBuilder timeout(long timeout)
      Sets the default timeout.
      Parameters:
      timeout -
      Returns: