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

Interface SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
SmbEndpointBuilderFactory.AdvancedSmbEndpointBuilder
Enclosing interface:
SmbEndpointBuilderFactory
public static interface SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the SMB component.

  • Method Details

    • basic

      default SmbEndpointBuilderFactory.SmbEndpointProducerBuilder basic()

    • allowNullBody

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder disconnectOnBatchComplete(boolean disconnectOnBatchComplete)
      Whether or not to disconnect from remote SMB share right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the SMB share. The option is a: boolean type. Default: false Group: producer (advanced)
      Parameters:
      disconnectOnBatchComplete - the value to set
      Returns:
      the dsl builder

    • disconnectOnBatchComplete

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder disconnectOnBatchComplete(String disconnectOnBatchComplete)
      Whether or not to disconnect from remote SMB share right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the SMB share. 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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 SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder 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

    • bufferSize

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder bufferSize(int bufferSize)
      Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files). The option is a: int type. Default: 131072 Group: advanced
      Parameters:
      bufferSize - the value to set
      Returns:
      the dsl builder

    • bufferSize

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder bufferSize(String bufferSize)
      Buffer size in bytes used for writing files (or in case of FTP for downloading and uploading files). The option will be converted to a int type. Default: 131072 Group: advanced
      Parameters:
      bufferSize - the value to set
      Returns:
      the dsl builder

    • smbConfig

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder smbConfig(com.hierynomus.smbj.SmbConfig smbConfig)
      An optional SMB client configuration, can be used to configure client specific configurations, like timeouts. The option is a: com.hierynomus.smbj.SmbConfig type. Group: advanced
      Parameters:
      smbConfig - the value to set
      Returns:
      the dsl builder

    • smbConfig

      default SmbEndpointBuilderFactory.AdvancedSmbEndpointProducerBuilder smbConfig(String smbConfig)
      An optional SMB client configuration, can be used to configure client specific configurations, like timeouts. The option will be converted to a com.hierynomus.smbj.SmbConfig type. Group: advanced
      Parameters:
      smbConfig - the value to set
      Returns:
      the dsl builder