Package org.citrusframework.model.config.ssh

Class SshClientModel

java.lang.Object
org.citrusframework.model.config.ssh.SshClientModel
public class SshClientModel extends Object

Java-Klasse für anonymous complex type.

Das folgende Schemafragment gibt den erwarteten Content an, der in dieser Klasse enthalten ist.


 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
       <attribute name="host" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="port" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="private-key-path" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="private-key-password" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="user" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="password" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="strict-host-checking" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="known-hosts-path" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="command-timeout" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="connection-timeout" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="actor" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="message-correlator" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="message-converter" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="timeout" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="polling-interval" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • id

      protected String id

    • host

      protected String host
      Host to connect to for sending an SSH Exec request. Default is 'localhost'

    • port

      protected String port
      Port to use. Default is 2222

    • privateKeyPath

      protected String privateKeyPath
      Path to a private key, which can be either a plain file path or an class resource if prefixed with 'classpath:'

    • privateKeyPassword

      protected String privateKeyPassword
      Optional password for the private key

    • user

      protected String user
      User used for connecting to the SSH server.

    • password

      protected String password
      Password used for password based authentication. Might be combined with "private-key-path" in which case both authentication mechanism are tried.

    • strictHostChecking

      protected Boolean strictHostChecking
      Whether the host key should be verified by looking it up in a 'known_hosts' file. Default is false.

    • knownHostsPath

      protected String knownHostsPath
      Path to a known hosts file. If prefixed with 'classpath:' this file is looked up as a resource in the classpath.

    • commandTimeout

      protected Integer commandTimeout
      Timeout in milliseconds for how long to wait for the SSH command to complete. Default is 5 minutes.

    • connectionTimeout

      protected Integer connectionTimeout
      Timeout in milliseconds for how long to for a connectiuon to connect. Default is 1 minute.

    • actor

      protected String actor
      Actor used for switching groups of actions. See the reference documentation for details.

    • messageCorrelator

      protected String messageCorrelator

    • messageConverter

      protected String messageConverter

    • timeout

      protected String timeout

    • pollingInterval

      protected String pollingInterval

  • Constructor Details

    • SshClientModel

      public SshClientModel()

  • Method Details

    • getId

      public String getId()
      Ruft den Wert der id-Eigenschaft ab.
      Returns:
      possible object is String

    • setId

      public void setId(String value)
      Legt den Wert der id-Eigenschaft fest.
      Parameters:
      value - allowed object is String

    • getHost

      public String getHost()
      Host to connect to for sending an SSH Exec request. Default is 'localhost'
      Returns:
      possible object is String

    • setHost

      public void setHost(String value)
      Legt den Wert der host-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getPort

      public String getPort()
      Port to use. Default is 2222
      Returns:
      possible object is String

    • setPort

      public void setPort(String value)
      Legt den Wert der port-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getPrivateKeyPath

      public String getPrivateKeyPath()
      Path to a private key, which can be either a plain file path or an class resource if prefixed with 'classpath:'
      Returns:
      possible object is String

    • setPrivateKeyPath

      public void setPrivateKeyPath(String value)
      Legt den Wert der privateKeyPath-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getPrivateKeyPassword

      public String getPrivateKeyPassword()
      Optional password for the private key
      Returns:
      possible object is String

    • setPrivateKeyPassword

      public void setPrivateKeyPassword(String value)
      Legt den Wert der privateKeyPassword-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getUser

      public String getUser()
      User used for connecting to the SSH server.
      Returns:
      possible object is String

    • setUser

      public void setUser(String value)
      Legt den Wert der user-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getPassword

      public String getPassword()
      Password used for password based authentication. Might be combined with "private-key-path" in which case both authentication mechanism are tried.
      Returns:
      possible object is String

    • setPassword

      public void setPassword(String value)
      Legt den Wert der password-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • isStrictHostChecking

      public Boolean isStrictHostChecking()
      Whether the host key should be verified by looking it up in a 'known_hosts' file. Default is false.
      Returns:
      possible object is Boolean

    • setStrictHostChecking

      public void setStrictHostChecking(Boolean value)
      Legt den Wert der strictHostChecking-Eigenschaft fest.
      Parameters:
      value - allowed object is Boolean
      See Also:

    • getKnownHostsPath

      public String getKnownHostsPath()
      Path to a known hosts file. If prefixed with 'classpath:' this file is looked up as a resource in the classpath.
      Returns:
      possible object is String

    • setKnownHostsPath

      public void setKnownHostsPath(String value)
      Legt den Wert der knownHostsPath-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getCommandTimeout

      public Integer getCommandTimeout()
      Timeout in milliseconds for how long to wait for the SSH command to complete. Default is 5 minutes.
      Returns:
      possible object is Integer

    • setCommandTimeout

      public void setCommandTimeout(Integer value)
      Legt den Wert der commandTimeout-Eigenschaft fest.
      Parameters:
      value - allowed object is Integer
      See Also:

    • getConnectionTimeout

      public Integer getConnectionTimeout()
      Timeout in milliseconds for how long to for a connectiuon to connect. Default is 1 minute.
      Returns:
      possible object is Integer

    • setConnectionTimeout

      public void setConnectionTimeout(Integer value)
      Legt den Wert der connectionTimeout-Eigenschaft fest.
      Parameters:
      value - allowed object is Integer
      See Also:

    • getActor

      public String getActor()
      Actor used for switching groups of actions. See the reference documentation for details.
      Returns:
      possible object is String

    • setActor

      public void setActor(String value)
      Legt den Wert der actor-Eigenschaft fest.
      Parameters:
      value - allowed object is String
      See Also:

    • getMessageCorrelator

      public String getMessageCorrelator()
      Ruft den Wert der messageCorrelator-Eigenschaft ab.
      Returns:
      possible object is String

    • setMessageCorrelator

      public void setMessageCorrelator(String value)
      Legt den Wert der messageCorrelator-Eigenschaft fest.
      Parameters:
      value - allowed object is String

    • getMessageConverter

      public String getMessageConverter()
      Ruft den Wert der messageConverter-Eigenschaft ab.
      Returns:
      possible object is String

    • setMessageConverter

      public void setMessageConverter(String value)
      Legt den Wert der messageConverter-Eigenschaft fest.
      Parameters:
      value - allowed object is String

    • getTimeout

      public String getTimeout()
      Ruft den Wert der timeout-Eigenschaft ab.
      Returns:
      possible object is String

    • setTimeout

      public void setTimeout(String value)
      Legt den Wert der timeout-Eigenschaft fest.
      Parameters:
      value - allowed object is String

    • getPollingInterval

      public String getPollingInterval()
      Ruft den Wert der pollingInterval-Eigenschaft ab.
      Returns:
      possible object is String

    • setPollingInterval

      public void setPollingInterval(String value)
      Legt den Wert der pollingInterval-Eigenschaft fest.
      Parameters:
      value - allowed object is String