Package org.apache.camel.builder.component.dsl

Interface RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.robotframework.RobotFrameworkComponent>
All Known Implementing Classes:
RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilderImpl
Enclosing interface:
RobotframeworkComponentBuilderFactory
public static interface RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder extends ComponentBuilder<org.apache.camel.component.robotframework.RobotFrameworkComponent>
Builder for the Robot Framework component.

  • Method Details

    • allowContextMapAll

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • allowTemplateFromHeader

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • argumentFiles

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder argumentFiles(String argumentFiles)
      A text String to read more arguments from. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      argumentFiles - the value to set
      Returns:
      the dsl builder

    • combinedTagStats

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • criticalTags

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder debugFile(String debugFile)
      A debug String that is written during execution. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      debugFile - the value to set
      Returns:
      the dsl builder

    • document

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • excludes

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • includes

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder log(String log)
      Sets the path to the generated log String. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      log - the value to set
      Returns:
      the dsl builder

    • logLevel

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • output

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder output(String output)
      Sets the path to the generated output String. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      output - the value to set
      Returns:
      the dsl builder

    • outputDirectory

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder outputDirectory(String outputDirectory)
      Configures where generated reports are to be placed. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      outputDirectory - the value to set
      Returns:
      the dsl builder

    • randomize

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder report(String report)
      Sets the path to the generated report String. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      report - the value to set
      Returns:
      the dsl builder

    • reportBackground

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • runFailed

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder runFailed(String runFailed)
      Re-run failed tests, based on output.xml String. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      runFailed - the value to set
      Returns:
      the dsl builder

    • runMode

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • splitOutputs

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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

    • variableFiles

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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 RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder warnOnSkippedFiles(boolean warnOnSkippedFiles)
      Show a warning when an invalid String is skipped. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      warnOnSkippedFiles - the value to set
      Returns:
      the dsl builder

    • xunitFile

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder xunitFile(String xunitFile)
      Sets the path to the generated XUnit compatible result String, relative to outputDirectory. The String is in xml format. By default, the String name is derived from the testCasesDirectory parameter, replacing blanks in the directory name by underscores. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      xunitFile - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • configuration

      default RobotframeworkComponentBuilderFactory.RobotframeworkComponentBuilder configuration(org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration configuration)
      The configuration. The option is a: <code>org.apache.camel.component.robotframework.RobotFrameworkCamelConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder