Package com.consol.citrus.ssh.client

Class SshClient

  • All Implemented Interfaces:
    com.consol.citrus.common.Named, 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 SshClient
extends com.consol.citrus.endpoint.AbstractEndpoint
implements com.consol.citrus.messaging.Producer, com.consol.citrus.messaging.ReplyConsumer
    Ssh client connects to ssh server and sends commands to that server.
    Since:
    1.4
    Author:
    Roland Huss, Christoph Deppisch

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        SshClient()
      Default constructor initializing endpoint configuration.
      protected SshClient​(SshEndpointConfiguration endpointConfiguration)
      Default constructor using endpoint configuration.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.consol.citrus.messaging.SelectiveConsumer createConsumer()  
      com.consol.citrus.messaging.Producer createProducer()  
      SshEndpointConfiguration getEndpointConfiguration()  
      com.jcraft.jsch.JSch getJsch()
      Gets the JSch implementation.
      com.consol.citrus.message.Message receive​(com.consol.citrus.context.TestContext context)  
      com.consol.citrus.message.Message receive​(com.consol.citrus.context.TestContext context, long timeout)  
      com.consol.citrus.message.Message receive​(String selector, com.consol.citrus.context.TestContext context)  
      com.consol.citrus.message.Message receive​(String selector, com.consol.citrus.context.TestContext context, long timeout)  
      void send​(com.consol.citrus.message.Message message, com.consol.citrus.context.TestContext context)
      Send a message as SSH request.
      void setCorrelationManager​(com.consol.citrus.message.correlation.CorrelationManager<com.consol.citrus.message.Message> correlationManager)
      Sets the correlation manager.
      void setJsch​(com.jcraft.jsch.JSch jsch)
      Sets the JSch implementation.

      • Methods inherited from class com.consol.citrus.endpoint.AbstractEndpoint

        getActor, getConsumerName, getName, getProducerName, setActor, setName

      • Methods inherited from interface com.consol.citrus.messaging.Consumer

        getName

      • Methods inherited from interface com.consol.citrus.messaging.Producer

        getName

    • Constructor Detail

      • SshClient

        public SshClient()
        Default constructor initializing endpoint configuration.

      • SshClient

        protected SshClient​(SshEndpointConfiguration endpointConfiguration)
        Default constructor using endpoint configuration.
        Parameters:
        endpointConfiguration -

    • Method Detail

      • getEndpointConfiguration

        public SshEndpointConfiguration getEndpointConfiguration()
        Specified by:
        getEndpointConfiguration in interface com.consol.citrus.endpoint.Endpoint
        Overrides:
        getEndpointConfiguration in class com.consol.citrus.endpoint.AbstractEndpoint

      • send

        public void send​(com.consol.citrus.message.Message message,
                 com.consol.citrus.context.TestContext context)
        Send a message as SSH request. The message format is created from SshServer.
        Specified by:
        send in interface com.consol.citrus.messaging.Producer
        Parameters:
        message - the message object to send.
        context -

      • receive

        public com.consol.citrus.message.Message receive​(com.consol.citrus.context.TestContext context)
        Specified by:
        receive in interface com.consol.citrus.messaging.Consumer

      • receive

        public com.consol.citrus.message.Message receive​(String selector,
                                                 com.consol.citrus.context.TestContext context)
        Specified by:
        receive in interface com.consol.citrus.messaging.SelectiveConsumer

      • receive

        public com.consol.citrus.message.Message receive​(com.consol.citrus.context.TestContext context,
                                                 long timeout)
        Specified by:
        receive in interface com.consol.citrus.messaging.Consumer

      • receive

        public com.consol.citrus.message.Message receive​(String selector,
                                                 com.consol.citrus.context.TestContext context,
                                                 long timeout)
        Specified by:
        receive in interface com.consol.citrus.messaging.SelectiveConsumer

      • createProducer

        public com.consol.citrus.messaging.Producer createProducer()
        Specified by:
        createProducer in interface com.consol.citrus.endpoint.Endpoint

      • createConsumer

        public com.consol.citrus.messaging.SelectiveConsumer createConsumer()
        Specified by:
        createConsumer in interface com.consol.citrus.endpoint.Endpoint

      • getJsch

        public com.jcraft.jsch.JSch getJsch()
        Gets the JSch implementation.
        Returns:

      • setJsch

        public void setJsch​(com.jcraft.jsch.JSch jsch)
        Sets the JSch implementation.
        Parameters:
        jsch -

      • setCorrelationManager

        public void setCorrelationManager​(com.consol.citrus.message.correlation.CorrelationManager<com.consol.citrus.message.Message> correlationManager)
        Sets the correlation manager.
        Parameters:
        correlationManager -