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

Interface KameletComponentBuilderFactory.KameletComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.kamelet.KameletComponent>
All Known Implementing Classes:
KameletComponentBuilderFactory.KameletComponentBuilderImpl
Enclosing interface:
KameletComponentBuilderFactory
public static interface KameletComponentBuilderFactory.KameletComponentBuilder extends ComponentBuilder<org.apache.camel.component.kamelet.KameletComponent>
Builder for the Kamelet component.

  • Method Details

    • location

      default KameletComponentBuilderFactory.KameletComponentBuilder location(String location)
      The location(s) of the Kamelets on the file system. Multiple locations can be set separated by comma. The option is a: <code>java.lang.String</code> type. Default: classpath:kamelets Group: common
      Parameters:
      location - the value to set
      Returns:
      the dsl builder

    • routeProperties

      default KameletComponentBuilderFactory.KameletComponentBuilder routeProperties(Map<String,Properties> routeProperties)
      Set route local parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.util.Properties&gt;</code> type. Group: common
      Parameters:
      routeProperties - the value to set
      Returns:
      the dsl builder

    • templateProperties

      default KameletComponentBuilderFactory.KameletComponentBuilder templateProperties(Map<String,Properties> templateProperties)
      Set template local parameters. The option is a: <code>java.util.Map&lt;java.lang.String, java.util.Properties&gt;</code> type. Group: common
      Parameters:
      templateProperties - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default KameletComponentBuilderFactory.KameletComponentBuilder 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

    • block

      default KameletComponentBuilderFactory.KameletComponentBuilder block(boolean block)
      If sending a message to a kamelet endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      block - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default KameletComponentBuilderFactory.KameletComponentBuilder 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

    • timeout

      default KameletComponentBuilderFactory.KameletComponentBuilder timeout(long timeout)
      The timeout value to use if block is enabled. The option is a: <code>long</code> type. Default: 30000 Group: producer
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default KameletComponentBuilderFactory.KameletComponentBuilder 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

    • noErrorHandler

      default KameletComponentBuilderFactory.KameletComponentBuilder noErrorHandler(boolean noErrorHandler)
      Whether kamelets should use error handling or not. By default, the Kamelet uses the same error handler as from the calling route. This means that if the calling route has error handling that performs retries, or routing to a dead letter channel, then the kamelet route will use this also. This can be turned off by setting this option to true. If off then the kamelet route is not using error handling, and any exception thrown will for source kamelets be logged by the consumer, and the sink/action kamelets will fail processing. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      noErrorHandler - the value to set
      Returns:
      the dsl builder

    • routeTemplateLoaderListener

      default KameletComponentBuilderFactory.KameletComponentBuilder routeTemplateLoaderListener(org.apache.camel.spi.RouteTemplateLoaderListener routeTemplateLoaderListener)
      To plugin a custom listener for when the Kamelet component is loading Kamelets from external resources. The option is a: <code>org.apache.camel.spi.RouteTemplateLoaderListener</code> type. Group: advanced
      Parameters:
      routeTemplateLoaderListener - the value to set
      Returns:
      the dsl builder