Interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder
- Enclosing interface:
- RobotFrameworkEndpointBuilderFactory
public static interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilderBuilder for endpoint consumers for the Robot Framework component.
-
-
Method Summary
-
-
-
Method Detail
-
advanced
default RobotFrameworkEndpointBuilderFactory.AdvancedRobotFrameworkEndpointConsumerBuilder advanced()
-
allowContextMapAll
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder allowContextMapAll(boolean allowContextMapAll)
Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
allowContextMapAll- the value to set- Returns:
- the dsl builder
-
allowContextMapAll
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder allowContextMapAll(String allowContextMapAll)
Sets whether the context map should allow access to all details. By default only the message body and headers can be accessed. This option can be enabled for full access to the current Exchange and CamelContext. Doing so impose a potential security risk as this opens access to the full power of CamelContext API. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
allowContextMapAll- the value to set- Returns:
- the dsl builder
-
allowTemplateFromHeader
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder allowTemplateFromHeader(boolean allowTemplateFromHeader)
Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
allowTemplateFromHeader- the value to set- Returns:
- the dsl builder
-
allowTemplateFromHeader
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder allowTemplateFromHeader(String allowTemplateFromHeader)
Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
allowTemplateFromHeader- the value to set- Returns:
- the dsl builder
-
argumentFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder argumentFile(File argumentFile)
A text file to read more arguments from. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
argumentFile- the value to set- Returns:
- the dsl builder
-
argumentFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder argumentFile(String argumentFile)
A text file to read more arguments from. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
argumentFile- the value to set- Returns:
- the dsl builder
-
combinedTagStats
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder combinedTagStats(String combinedTagStats)
Creates combined statistics based on tags. Use the format tags:title List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
combinedTagStats- the value to set- Returns:
- the dsl builder
-
contentCache
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder contentCache(boolean contentCache)
Sets whether to use resource content cache or not. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
contentCache- the value to set- Returns:
- the dsl builder
-
contentCache
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder contentCache(String contentCache)
Sets whether to use resource content cache or not. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
contentCache- the value to set- Returns:
- the dsl builder
-
criticalTags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder criticalTags(String criticalTags)
Tests that have the given tags are considered critical. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
criticalTags- the value to set- Returns:
- the dsl builder
-
debugFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder debugFile(File debugFile)
A debug file that is written during execution. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
debugFile- the value to set- Returns:
- the dsl builder
-
debugFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder debugFile(String debugFile)
A debug file that is written during execution. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
debugFile- the value to set- Returns:
- the dsl builder
-
document
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder document(String document)
Sets the documentation of the top-level tests suites. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
document- the value to set- Returns:
- the dsl builder
-
dryrun
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder dryrun(boolean dryrun)
Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
dryrun- the value to set- Returns:
- the dsl builder
-
dryrun
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder dryrun(String dryrun)
Sets dryrun mode on use. In the dry run mode tests are run without executing keywords originating from test libraries. Useful for validating test data syntax. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
dryrun- the value to set- Returns:
- the dsl builder
-
excludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder excludes(String excludes)
Selects the tests cases by tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
excludes- the value to set- Returns:
- the dsl builder
-
exitOnFailure
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder exitOnFailure(boolean exitOnFailure)
Sets robot to stop execution immediately if a critical test fails. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
exitOnFailure- the value to set- Returns:
- the dsl builder
-
exitOnFailure
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder exitOnFailure(String exitOnFailure)
Sets robot to stop execution immediately if a critical test fails. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
exitOnFailure- the value to set- Returns:
- the dsl builder
-
includes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder includes(String includes)
Selects the tests cases by tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
includes- the value to set- Returns:
- the dsl builder
-
listener
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder listener(String listener)
Sets a single listener for monitoring tests execution. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
listener- the value to set- Returns:
- the dsl builder
-
listeners
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder listeners(String listeners)
Sets multiple listeners for monitoring tests execution. Use the format ListenerWithArgs:arg1:arg2 or simply ListenerWithoutArgs List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
listeners- the value to set- Returns:
- the dsl builder
-
log
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder log(File log)
Sets the path to the generated log file. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
log- the value to set- Returns:
- the dsl builder
-
log
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder log(String log)
Sets the path to the generated log file. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
log- the value to set- Returns:
- the dsl builder
-
logLevel
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder logLevel(String logLevel)
Sets the threshold level for logging. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
logLevel- the value to set- Returns:
- the dsl builder
-
logTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder logTitle(String logTitle)
Sets a title for the generated tests log. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
logTitle- the value to set- Returns:
- the dsl builder
-
metadata
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder metadata(String metadata)
Sets free metadata for the top level tests suites. comma seperated list of string resulting as List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
metadata- the value to set- Returns:
- the dsl builder
-
monitorColors
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder monitorColors(String monitorColors)
Using ANSI colors in console. Normally colors work in unixes but not in Windows. Default is 'on'. 'on' - use colors in unixes but not in Windows 'off' - never use colors 'force' - always use colors (also in Windows). The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
monitorColors- the value to set- Returns:
- the dsl builder
-
monitorWidth
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder monitorWidth(String monitorWidth)
Width of the monitor output. Default is 78. The option is a: <code>java.lang.String</code> type. Default: 78 Group: common- Parameters:
monitorWidth- the value to set- Returns:
- the dsl builder
-
name
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder name(String name)
Sets the name of the top-level tests suites. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
name- the value to set- Returns:
- the dsl builder
-
nonCriticalTags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder nonCriticalTags(String nonCriticalTags)
Tests that have the given tags are not critical. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
nonCriticalTags- the value to set- Returns:
- the dsl builder
-
noStatusReturnCode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder noStatusReturnCode(boolean noStatusReturnCode)
If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
noStatusReturnCode- the value to set- Returns:
- the dsl builder
-
noStatusReturnCode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder noStatusReturnCode(String noStatusReturnCode)
If true, sets the return code to zero regardless of failures in test cases. Error codes are returned normally. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
noStatusReturnCode- the value to set- Returns:
- the dsl builder
-
output
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder output(File output)
Sets the path to the generated output file. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
output- the value to set- Returns:
- the dsl builder
-
output
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder output(String output)
Sets the path to the generated output file. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
output- the value to set- Returns:
- the dsl builder
-
outputDirectory
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder outputDirectory(File outputDirectory)
Configures where generated reports are to be placed. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
outputDirectory- the value to set- Returns:
- the dsl builder
-
outputDirectory
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder outputDirectory(String outputDirectory)
Configures where generated reports are to be placed. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
outputDirectory- the value to set- Returns:
- the dsl builder
-
randomize
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder randomize(String randomize)
Sets the test execution order to be randomized. Valid values are all, suite, and test. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
randomize- the value to set- Returns:
- the dsl builder
-
report
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder report(File report)
Sets the path to the generated report file. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
report- the value to set- Returns:
- the dsl builder
-
report
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder report(String report)
Sets the path to the generated report file. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
report- the value to set- Returns:
- the dsl builder
-
reportBackground
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder reportBackground(String reportBackground)
Sets background colors for the generated report and summary. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
reportBackground- the value to set- Returns:
- the dsl builder
-
reportTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder reportTitle(String reportTitle)
Sets a title for the generated tests report. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
reportTitle- the value to set- Returns:
- the dsl builder
-
runEmptySuite
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder runEmptySuite(boolean runEmptySuite)
Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
runEmptySuite- the value to set- Returns:
- the dsl builder
-
runEmptySuite
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder runEmptySuite(String runEmptySuite)
Executes tests also if the top level test suite is empty. Useful e.g. with --include/--exclude when it is not an error that no test matches the condition. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
runEmptySuite- the value to set- Returns:
- the dsl builder
-
runFailed
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder runFailed(File runFailed)
Re-run failed tests, based on output.xml file. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
runFailed- the value to set- Returns:
- the dsl builder
-
runFailed
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder runFailed(String runFailed)
Re-run failed tests, based on output.xml file. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
runFailed- the value to set- Returns:
- the dsl builder
-
runMode
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder runMode(String runMode)
Sets the execution mode for this tests run. Note that this setting has been deprecated in Robot Framework 2.8. Use separate dryryn, skipTeardownOnExit, exitOnFailure, and randomize settings instead. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
runMode- the value to set- Returns:
- the dsl builder
-
skipTeardownOnExit
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder skipTeardownOnExit(boolean skipTeardownOnExit)
Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
skipTeardownOnExit- the value to set- Returns:
- the dsl builder
-
skipTeardownOnExit
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder skipTeardownOnExit(String skipTeardownOnExit)
Sets whether the teardowns are skipped if the test execution is prematurely stopped. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
skipTeardownOnExit- the value to set- Returns:
- the dsl builder
-
splitOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder splitOutputs(String splitOutputs)
Splits output and log files. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
splitOutputs- the value to set- Returns:
- the dsl builder
-
suites
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder suites(String suites)
Selects the tests suites by name. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
suites- the value to set- Returns:
- the dsl builder
-
suiteStatLevel
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder suiteStatLevel(String suiteStatLevel)
Defines how many levels to show in the Statistics by Suite table in outputs. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
suiteStatLevel- the value to set- Returns:
- the dsl builder
-
summaryTitle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder summaryTitle(String summaryTitle)
Sets a title for the generated summary report. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
summaryTitle- the value to set- Returns:
- the dsl builder
-
tagDocs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tagDocs(String tagDocs)
Adds documentation to the specified tags. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tagDocs- the value to set- Returns:
- the dsl builder
-
tags
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tags(String tags)
Sets the tags(s) to all executed tests cases. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tags- the value to set- Returns:
- the dsl builder
-
tagStatExcludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tagStatExcludes(String tagStatExcludes)
Excludes these tags from the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tagStatExcludes- the value to set- Returns:
- the dsl builder
-
tagStatIncludes
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tagStatIncludes(String tagStatIncludes)
Includes only these tags in the Statistics by Tag and Test Details by Tag tables in outputs. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tagStatIncludes- the value to set- Returns:
- the dsl builder
-
tagStatLinks
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tagStatLinks(String tagStatLinks)
Adds external links to the Statistics by Tag table in outputs. Use the format pattern:link:title List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tagStatLinks- the value to set- Returns:
- the dsl builder
-
tests
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder tests(String tests)
Selects the tests cases by name. List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
tests- the value to set- Returns:
- the dsl builder
-
timestampOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder timestampOutputs(boolean timestampOutputs)
Adds a timestamp to all output files. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
timestampOutputs- the value to set- Returns:
- the dsl builder
-
timestampOutputs
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder timestampOutputs(String timestampOutputs)
Adds a timestamp to all output files. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
timestampOutputs- the value to set- Returns:
- the dsl builder
-
variableFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder variableFiles(String variableFiles)
Sets variables using variables files. Use the format path:args List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
variableFiles- the value to set- Returns:
- the dsl builder
-
variables
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder variables(String variables)
Sets individual variables. Use the format name:value List. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
variables- the value to set- Returns:
- the dsl builder
-
warnOnSkippedFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder warnOnSkippedFiles(boolean warnOnSkippedFiles)
Show a warning when an invalid file is skipped. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
warnOnSkippedFiles- the value to set- Returns:
- the dsl builder
-
warnOnSkippedFiles
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder warnOnSkippedFiles(String warnOnSkippedFiles)
Show a warning when an invalid file is skipped. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
warnOnSkippedFiles- the value to set- Returns:
- the dsl builder
-
xunitFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder xunitFile(File xunitFile)
Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option is a: <code>java.io.File</code> type. Group: common- Parameters:
xunitFile- the value to set- Returns:
- the dsl builder
-
xunitFile
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder xunitFile(String xunitFile)
Sets the path to the generated XUnit compatible result file, relative to outputDirectory. The file is in xml format. By default, the file name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option will be converted to a <code>java.io.File</code> type. Group: common- Parameters:
xunitFile- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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 <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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 RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointConsumerBuilder 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
-
-