Interface SftpComponentBuilderFactory.SftpComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.file.remote.SftpComponent>
All Known Implementing Classes:
SftpComponentBuilderFactory.SftpComponentBuilderImpl
Enclosing interface:
SftpComponentBuilderFactory
public static interface SftpComponentBuilderFactory.SftpComponentBuilder extends ComponentBuilder<org.apache.camel.component.file.remote.SftpComponent>
Builder for the SFTP component.

  • Method Details

    • bridgeErrorHandler

      default SftpComponentBuilderFactory.SftpComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default SftpComponentBuilderFactory.SftpComponentBuilder 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

    • autowiredEnabled

      default SftpComponentBuilderFactory.SftpComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default SftpComponentBuilderFactory.SftpComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default SftpComponentBuilderFactory.SftpComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • autoCreateKnownHostsFile

      default SftpComponentBuilderFactory.SftpComponentBuilder autoCreateKnownHostsFile(boolean autoCreateKnownHostsFile)
      If knownHostFile does not exist, then attempt to auto-create the path and file (beware that the file will be created by the current user of the running Java process, which may not have file permission). The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      autoCreateKnownHostsFile - the value to set
      Returns:
      the dsl builder

    • knownHosts

      default SftpComponentBuilderFactory.SftpComponentBuilder knownHosts(byte[] knownHosts)
      Sets the known_hosts from the byte array globally, so that the SFTP endpoints can do host key verification. The option is a: <code>byte[]</code> type. Group: security
      Parameters:
      knownHosts - the value to set
      Returns:
      the dsl builder

    • knownHostsFile

      default SftpComponentBuilderFactory.SftpComponentBuilder knownHostsFile(String knownHostsFile)
      Sets the known_hosts file globally, so that the SFTP endpoints can do host key verification. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      knownHostsFile - the value to set
      Returns:
      the dsl builder

    • knownHostsUri

      default SftpComponentBuilderFactory.SftpComponentBuilder knownHostsUri(String knownHostsUri)
      Sets the known_hosts file (loaded from classpath by default) globally, so that the SFTP endpoints can do host key verification. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      knownHostsUri - the value to set
      Returns:
      the dsl builder

    • strictHostKeyChecking

      default SftpComponentBuilderFactory.SftpComponentBuilder strictHostKeyChecking(String strictHostKeyChecking)
      Sets whether to use strict host key checking globally for all endpoints. Setting this to 'no' (the default) disables host key verification and makes SFTP connections vulnerable to man-in-the-middle attacks. Use 'yes' in production environments. The option is a: <code>java.lang.String</code> type. Default: no Group: security
      Parameters:
      strictHostKeyChecking - the value to set
      Returns:
      the dsl builder

    • useUserKnownHostsFile

      default SftpComponentBuilderFactory.SftpComponentBuilder useUserKnownHostsFile(boolean useUserKnownHostsFile)
      If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts. The option is a: <code>boolean</code> type. Default: true Group: security
      Parameters:
      useUserKnownHostsFile - the value to set
      Returns:
      the dsl builder