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

Interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    SshEndpointBuilderFactory.SshEndpointBuilder
    Enclosing interface:
    SshEndpointBuilderFactory
    public static interface SshEndpointBuilderFactory.SshEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the SSH component.

    • Method Detail

      • failOnUnknownHost

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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

      • pollCommand

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder pollCommand​(String pollCommand)
        Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer, i.e. from(ssh://...) You may need to end your command with a newline, and that must be URL encoded %0A. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        pollCommand - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder sendEmptyMessageWhenIdle​(boolean sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • sendEmptyMessageWhenIdle

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder sendEmptyMessageWhenIdle​(String sendEmptyMessageWhenIdle)
        If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        sendEmptyMessageWhenIdle - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffErrorThreshold​(int backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffErrorThreshold​(String backoffErrorThreshold)
        The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffErrorThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffIdleThreshold

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffIdleThreshold​(String backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffIdleThreshold - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffMultiplier​(int backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • backoffMultiplier

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder backoffMultiplier​(String backoffMultiplier)
        To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
        Parameters:
        backoffMultiplier - the value to set
        Returns:
        the dsl builder

      • delay

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder delay​(long delay)
        Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
        Parameters:
        delay - the value to set
        Returns:
        the dsl builder

      • greedy

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder greedy​(boolean greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • greedy

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder greedy​(String greedy)
        If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
        Parameters:
        greedy - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder initialDelay​(long initialDelay)
        Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • initialDelay

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder initialDelay​(String initialDelay)
        Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
        Parameters:
        initialDelay - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder repeatCount​(long repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • repeatCount

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder repeatCount​(String repeatCount)
        Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
        Parameters:
        repeatCount - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder runLoggingLevel​(org.apache.camel.LoggingLevel runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • runLoggingLevel

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder runLoggingLevel​(String runLoggingLevel)
        The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
        Parameters:
        runLoggingLevel - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder scheduledExecutorService​(ScheduledExecutorService scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduledExecutorService

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder scheduledExecutorService​(String scheduledExecutorService)
        Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
        Parameters:
        scheduledExecutorService - the value to set
        Returns:
        the dsl builder

      • scheduler

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder scheduler​(Object scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • scheduler

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder scheduler​(String scheduler)
        To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
        Parameters:
        scheduler - the value to set
        Returns:
        the dsl builder

      • schedulerProperties

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder schedulerProperties​(String key,
                                                                                 Object value)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • schedulerProperties

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • startScheduler

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder startScheduler​(boolean startScheduler)
        Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • startScheduler

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder startScheduler​(String startScheduler)
        Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        startScheduler - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder timeUnit​(TimeUnit timeUnit)
        Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • timeUnit

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder timeUnit​(String timeUnit)
        Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
        Parameters:
        timeUnit - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • useFixedDelay

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder useFixedDelay​(String useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
        Parameters:
        useFixedDelay - the value to set
        Returns:
        the dsl builder

      • certResource

        default SshEndpointBuilderFactory.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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.SshEndpointConsumerBuilder 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