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

Interface VertxComponentBuilderFactory.VertxComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.vertx.VertxComponent>
All Known Implementing Classes:
VertxComponentBuilderFactory.VertxComponentBuilderImpl
Enclosing interface:
VertxComponentBuilderFactory
public static interface VertxComponentBuilderFactory.VertxComponentBuilder extends ComponentBuilder<org.apache.camel.component.vertx.VertxComponent>
Builder for the Vert.x component.

  • Method Details

    • host

      default VertxComponentBuilderFactory.VertxComponentBuilder host(String host)
      Hostname for creating an embedded clustered EventBus. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      host - the value to set
      Returns:
      the dsl builder

    • port

      default VertxComponentBuilderFactory.VertxComponentBuilder port(int port)
      Port for creating an embedded clustered EventBus. The option is a: <code>int</code> type. Group: common
      Parameters:
      port - the value to set
      Returns:
      the dsl builder

    • timeout

      default VertxComponentBuilderFactory.VertxComponentBuilder timeout(int timeout)
      Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. The option is a: <code>int</code> type. Default: 60 Group: common
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • vertx

      default VertxComponentBuilderFactory.VertxComponentBuilder vertx(io.vertx.core.Vertx vertx)
      To use the given vertx EventBus instead of creating a new embedded EventBus. The option is a: <code>io.vertx.core.Vertx</code> type. Group: common
      Parameters:
      vertx - the value to set
      Returns:
      the dsl builder

    • vertxOptions

      default VertxComponentBuilderFactory.VertxComponentBuilder vertxOptions(io.vertx.core.VertxOptions vertxOptions)
      Options to use for creating vertx. The option is a: <code>io.vertx.core.VertxOptions</code> type. Group: common
      Parameters:
      vertxOptions - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default VertxComponentBuilderFactory.VertxComponentBuilder 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 VertxComponentBuilderFactory.VertxComponentBuilder 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 VertxComponentBuilderFactory.VertxComponentBuilder 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

    • vertxFactory

      default VertxComponentBuilderFactory.VertxComponentBuilder vertxFactory(io.vertx.core.impl.VertxBuilder vertxFactory)
      To use a custom VertxFactory implementation. The option is a: <code>io.vertx.core.impl.VertxBuilder</code> type. Group: advanced
      Parameters:
      vertxFactory - the value to set
      Returns:
      the dsl builder