Package org.apache.camel.builder.endpoint.dsl

Interface SshEndpointBuilderFactory.SshEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    SshEndpointBuilderFactory.SshEndpointBuilder
    Enclosing interface:
    SshEndpointBuilderFactory
    public static interface SshEndpointBuilderFactory.SshEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the SSH component.

    • Method Detail

      • failOnUnknownHost

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder failOnUnknownHost​(boolean failOnUnknownHost)
        Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        failOnUnknownHost - the value to set
        Returns:
        the dsl builder

      • failOnUnknownHost

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder failOnUnknownHost​(String failOnUnknownHost)
        Specifies whether a connection to an unknown host should fail or not. This value is only checked when the property knownHosts is set. The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        failOnUnknownHost - the value to set
        Returns:
        the dsl builder

      • knownHostsResource

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder knownHostsResource​(String knownHostsResource)
        Sets the resource path for a known_hosts file. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        knownHostsResource - the value to set
        Returns:
        the dsl builder

      • timeout

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder timeout​(long timeout)
        Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. The option is a: <code>long</code> type. Default: 30000 Group: common
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • timeout

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder timeout​(String timeout)
        Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. The option will be converted to a <code>long</code> type. Default: 30000 Group: common
        Parameters:
        timeout - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        lazyStartProducer - the value to set
        Returns:
        the dsl builder

      • certResource

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder certResource​(String certResource)
        Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate, and depends on keyType setting. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        certResource - the value to set
        Returns:
        the dsl builder

      • certResourcePassword

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder certResourcePassword​(String certResourcePassword)
        Sets the password to use in loading certResource, if certResource is an encrypted key. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        certResourcePassword - the value to set
        Returns:
        the dsl builder

      • keyPairProvider

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder keyPairProvider​(org.apache.sshd.common.keyprovider.KeyPairProvider keyPairProvider)
        Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. The option is a: <code>org.apache.sshd.common.keyprovider.KeyPairProvider</code> type. Group: security
        Parameters:
        keyPairProvider - the value to set
        Returns:
        the dsl builder

      • keyPairProvider

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder keyPairProvider​(String keyPairProvider)
        Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. The option will be converted to a <code>org.apache.sshd.common.keyprovider.KeyPairProvider</code> type. Group: security
        Parameters:
        keyPairProvider - the value to set
        Returns:
        the dsl builder

      • keyType

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder keyType​(String keyType)
        Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. From Camel 3.0.0 / 2.25.0, by default Camel will select the first available KeyPair that is loaded. Prior to this, a KeyType of 'ssh-rsa' was enforced by default. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        keyType - the value to set
        Returns:
        the dsl builder

      • password

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder password​(String password)
        Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        password - the value to set
        Returns:
        the dsl builder

      • username

        default SshEndpointBuilderFactory.SshEndpointProducerBuilder username​(String username)
        Sets the username to use in logging into the remote SSH server. The option is a: <code>java.lang.String</code> type. Group: security
        Parameters:
        username - the value to set
        Returns:
        the dsl builder