Interface SmbEndpointBuilderFactory.SmbEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- SmbEndpointBuilderFactory
public static interface SmbEndpointBuilderFactory.SmbEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the SMB component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SmbEndpointBuilderFactory.AdvancedSmbEndpointBuilder
advanced()
default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SmbEndpointBuilderFactory.SmbEndpointBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SmbEndpointBuilderFactory.SmbEndpointBuilder
delay(long delay)
Milliseconds before the next poll.default SmbEndpointBuilderFactory.SmbEndpointBuilder
delay(String delay)
Milliseconds before the next poll.default SmbEndpointBuilderFactory.SmbEndpointBuilder
domain(String domain)
The user domain.default SmbEndpointBuilderFactory.SmbEndpointBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SmbEndpointBuilderFactory.SmbEndpointBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SmbEndpointBuilderFactory.SmbEndpointBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default SmbEndpointBuilderFactory.SmbEndpointBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default SmbEndpointBuilderFactory.SmbEndpointBuilder
password(String password)
The password to access the share.default SmbEndpointBuilderFactory.SmbEndpointBuilder
path(String path)
The path, within the share, to consume the files from.default SmbEndpointBuilderFactory.SmbEndpointBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default SmbEndpointBuilderFactory.SmbEndpointBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default SmbEndpointBuilderFactory.SmbEndpointBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SmbEndpointBuilderFactory.SmbEndpointBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SmbEndpointBuilderFactory.SmbEndpointBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SmbEndpointBuilderFactory.SmbEndpointBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SmbEndpointBuilderFactory.SmbEndpointBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SmbEndpointBuilderFactory.SmbEndpointBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SmbEndpointBuilderFactory.SmbEndpointBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SmbEndpointBuilderFactory.SmbEndpointBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SmbEndpointBuilderFactory.SmbEndpointBuilder
searchPattern(String searchPattern)
The search pattern used to list the files.default SmbEndpointBuilderFactory.SmbEndpointBuilder
sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.default SmbEndpointBuilderFactory.SmbEndpointBuilder
sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.default SmbEndpointBuilderFactory.SmbEndpointBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default SmbEndpointBuilderFactory.SmbEndpointBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default SmbEndpointBuilderFactory.SmbEndpointBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default SmbEndpointBuilderFactory.SmbEndpointBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default SmbEndpointBuilderFactory.SmbEndpointBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default SmbEndpointBuilderFactory.SmbEndpointBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.default SmbEndpointBuilderFactory.SmbEndpointBuilder
username(String username)
The username required to access the share.
-
-
-
Method Detail
-
advanced
default SmbEndpointBuilderFactory.AdvancedSmbEndpointBuilder advanced()
-
path
default SmbEndpointBuilderFactory.SmbEndpointBuilder path(String path)
The path, within the share, to consume the files from. The option is a: <code>java.lang.String</code> type. Required: true Group: consumer- Parameters:
path
- the value to set- Returns:
- the dsl builder
-
searchPattern
default SmbEndpointBuilderFactory.SmbEndpointBuilder searchPattern(String searchPattern)
The search pattern used to list the files. The option is a: <code>java.lang.String</code> type. Default: *.txt Group: consumer- Parameters:
searchPattern
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SmbEndpointBuilderFactory.SmbEndpointBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SmbEndpointBuilderFactory.SmbEndpointBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SmbEndpointBuilderFactory.SmbEndpointBuilder backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
default SmbEndpointBuilderFactory.SmbEndpointBuilder delay(long delay)
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
default SmbEndpointBuilderFactory.SmbEndpointBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
default SmbEndpointBuilderFactory.SmbEndpointBuilder greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
default SmbEndpointBuilderFactory.SmbEndpointBuilder greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default SmbEndpointBuilderFactory.SmbEndpointBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default SmbEndpointBuilderFactory.SmbEndpointBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
default SmbEndpointBuilderFactory.SmbEndpointBuilder repeatCount(long repeatCount)
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
default SmbEndpointBuilderFactory.SmbEndpointBuilder repeatCount(String repeatCount)
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SmbEndpointBuilderFactory.SmbEndpointBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SmbEndpointBuilderFactory.SmbEndpointBuilder runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SmbEndpointBuilderFactory.SmbEndpointBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SmbEndpointBuilderFactory.SmbEndpointBuilder scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
default SmbEndpointBuilderFactory.SmbEndpointBuilder scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
default SmbEndpointBuilderFactory.SmbEndpointBuilder scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default SmbEndpointBuilderFactory.SmbEndpointBuilder schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
default SmbEndpointBuilderFactory.SmbEndpointBuilder schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default SmbEndpointBuilderFactory.SmbEndpointBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default SmbEndpointBuilderFactory.SmbEndpointBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
default SmbEndpointBuilderFactory.SmbEndpointBuilder timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
default SmbEndpointBuilderFactory.SmbEndpointBuilder timeUnit(String timeUnit)
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default SmbEndpointBuilderFactory.SmbEndpointBuilder useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default SmbEndpointBuilderFactory.SmbEndpointBuilder useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
domain
default SmbEndpointBuilderFactory.SmbEndpointBuilder domain(String domain)
The user domain. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
domain
- the value to set- Returns:
- the dsl builder
-
password
default SmbEndpointBuilderFactory.SmbEndpointBuilder password(String password)
The password to access the share. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
username
default SmbEndpointBuilderFactory.SmbEndpointBuilder username(String username)
The username required to access the share. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
-