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

Interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder
Enclosing interface:
FilesEndpointBuilderFactory
public static interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Azure Files component.

  • Method Details

    • basic

      default FilesEndpointBuilderFactory.FilesEndpointProducerBuilder basic()

    • allowNullBody

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder allowNullBody(boolean allowNullBody)
      Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged. The option is a: boolean type. Default: false Group: producer (advanced)
      Parameters:
      allowNullBody - the value to set
      Returns:
      the dsl builder

    • allowNullBody

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder allowNullBody(String allowNullBody)
      Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged. The option will be converted to a boolean type. Default: false Group: producer (advanced)
      Parameters:
      allowNullBody - the value to set
      Returns:
      the dsl builder

    • disconnectOnBatchComplete

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder disconnectOnBatchComplete(boolean disconnectOnBatchComplete)
      Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server. The option is a: boolean type. Default: false Group: producer (advanced)
      Parameters:
      disconnectOnBatchComplete - the value to set
      Returns:
      the dsl builder

    • disconnectOnBatchComplete

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder disconnectOnBatchComplete(String disconnectOnBatchComplete)
      Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server. The option will be converted to a boolean type. Default: false Group: producer (advanced)
      Parameters:
      disconnectOnBatchComplete - the value to set
      Returns:
      the dsl builder

    • eagerDeleteTargetFile

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder eagerDeleteTargetFile(boolean eagerDeleteTargetFile)
      Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation. The option is a: boolean type. Default: true Group: producer (advanced)
      Parameters:
      eagerDeleteTargetFile - the value to set
      Returns:
      the dsl builder

    • eagerDeleteTargetFile

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder eagerDeleteTargetFile(String eagerDeleteTargetFile)
      Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation. The option will be converted to a boolean type. Default: true Group: producer (advanced)
      Parameters:
      eagerDeleteTargetFile - the value to set
      Returns:
      the dsl builder

    • keepLastModified

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder keepLastModified(boolean keepLastModified)
      Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. The option is a: boolean type. Default: false Group: producer (advanced)
      Parameters:
      keepLastModified - the value to set
      Returns:
      the dsl builder

    • keepLastModified

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder keepLastModified(String keepLastModified)
      Will keep the last modified timestamp from the source file (if any). Will use the FileConstants.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. The option will be converted to a boolean type. Default: false Group: producer (advanced)
      Parameters:
      keepLastModified - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

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

    • lazyStartProducer

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

    • moveExistingFileStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder moveExistingFileStrategy(org.apache.camel.component.file.strategy.FileMoveExistingStrategy moveExistingFileStrategy)
      Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided. The option is a: org.apache.camel.component.file.strategy.FileMoveExistingStrategy type. Group: producer (advanced)
      Parameters:
      moveExistingFileStrategy - the value to set
      Returns:
      the dsl builder

    • moveExistingFileStrategy

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder moveExistingFileStrategy(String moveExistingFileStrategy)
      Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided. The option will be converted to a org.apache.camel.component.file.strategy.FileMoveExistingStrategy type. Group: producer (advanced)
      Parameters:
      moveExistingFileStrategy - the value to set
      Returns:
      the dsl builder

    • autoCreate

      default FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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.AdvancedFilesEndpointProducerBuilder 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