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

Interface Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
Smb2EndpointBuilderFactory.AdvancedSmb2EndpointBuilder
Enclosing interface:
Smb2EndpointBuilderFactory
public static interface Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the SMB2 component.

  • Method Details

    • basic

      default Smb2EndpointBuilderFactory.Smb2EndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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

    • exceptionHandler

      default Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder processStrategy(org.apache.camel.component.file.GenericFileProcessStrategy<com.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation> 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.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • processStrategy

      default Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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.hierynomus.msfscc.fileinformation.FileIdBothDirectoryInformation> type. Group: consumer (advanced)
      Parameters:
      processStrategy - the value to set
      Returns:
      the dsl builder

    • autoCreate

      default Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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 Smb2EndpointBuilderFactory.AdvancedSmb2EndpointConsumerBuilder 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