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

Interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder
Enclosing interface:
FilesEndpointBuilderFactory
public static interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Azure Files component.

  • Method Details

    • basic

      default FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • download

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder download(boolean download)
      Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      download - the value to set
      Returns:
      the dsl builder

    • download

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder download(String download)
      Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      download - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • inProgressRepository

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder inProgressRepository(org.apache.camel.spi.IdempotentRepository inProgressRepository)
      A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option is a: org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • inProgressRepository

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder inProgressRepository(String inProgressRepository)
      A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. The option will be converted to a org.apache.camel.spi.IdempotentRepository type. Group: consumer (advanced)
      Parameters:
      inProgressRepository - the value to set
      Returns:
      the dsl builder

    • localWorkDirectory

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder localWorkDirectory(String localWorkDirectory)
      When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. The option is a: java.lang.String type. Group: consumer (advanced)
      Parameters:
      localWorkDirectory - the value to set
      Returns:
      the dsl builder

    • onCompletionExceptionHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder onCompletionExceptionHandler(org.apache.camel.spi.ExceptionHandler onCompletionExceptionHandler)
      To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      onCompletionExceptionHandler - the value to set
      Returns:
      the dsl builder

    • onCompletionExceptionHandler

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder onCompletionExceptionHandler(String onCompletionExceptionHandler)
      To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      onCompletionExceptionHandler - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder pollStrategy(String pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • processStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder processStrategy(org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem> processStrategy)
      A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option is a: org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • processStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder processStrategy(String processStrategy)
      A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply. The option will be converted to a org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnConnectFailed

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)
      Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      throwExceptionOnConnectFailed - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnConnectFailed

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed)
      Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      throwExceptionOnConnectFailed - the value to set
      Returns:
      the dsl builder

    • autoCreate

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder autoCreate(boolean autoCreate)
      Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option is a: boolean type. Default: true Group: advanced
      Parameters:
      autoCreate - the value to set
      Returns:
      the dsl builder

    • autoCreate

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder autoCreate(String autoCreate)
      Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option will be converted to a boolean type. Default: true Group: advanced
      Parameters:
      autoCreate - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder browseLimit(int browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option is a: int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder browseLimit(String browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option will be converted to a int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder connectTimeout(int connectTimeout)
      Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option is a: int type. Default: 10000 Group: advanced
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder connectTimeout(String connectTimeout)
      Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option will be converted to a int type. Default: 10000 Group: advanced
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • maximumReconnectAttempts

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder maximumReconnectAttempts(int maximumReconnectAttempts)
      Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option is a: int type. Group: advanced
      Parameters:
      maximumReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • maximumReconnectAttempts

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder maximumReconnectAttempts(String maximumReconnectAttempts)
      Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option will be converted to a int type. Group: advanced
      Parameters:
      maximumReconnectAttempts - the value to set
      Returns:
      the dsl builder

    • reconnectDelay

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder reconnectDelay(long reconnectDelay)
      Delay in millis Camel will wait before performing a reconnect attempt. The option is a: long type. Default: 1000 Group: advanced
      Parameters:
      reconnectDelay - the value to set
      Returns:
      the dsl builder

    • reconnectDelay

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder reconnectDelay(String reconnectDelay)
      Delay in millis Camel will wait before performing a reconnect attempt. The option will be converted to a long type. Default: 1000 Group: advanced
      Parameters:
      reconnectDelay - the value to set
      Returns:
      the dsl builder

    • timeout

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder timeout(int timeout)
      Sets the data timeout for waiting for reply Used only by FTPClient. The option is a: int type. Default: 30000 Group: advanced
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • timeout

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder timeout(String timeout)
      Sets the data timeout for waiting for reply Used only by FTPClient. The option will be converted to a int type. Default: 30000 Group: advanced
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder