Interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointBuilder
- Enclosing interface:
- RobotFrameworkEndpointBuilderFactory
public static interface RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Robot Framework component.
-
-
Method Summary
-
-
-
Method Detail
-
advanced
default RobotFrameworkEndpointBuilderFactory.AdvancedRobotFrameworkEndpointProducerBuilder advanced()
-
allowContextMapAll
default RobotFrameworkEndpointBuilderFactory.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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.RobotFrameworkEndpointProducerBuilder 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
-
-