Interface CamundaComponentBuilderFactory.CamundaComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.camunda.CamundaComponent>
All Known Implementing Classes:
CamundaComponentBuilderFactory.CamundaComponentBuilderImpl
Enclosing interface:
CamundaComponentBuilderFactory
public static interface CamundaComponentBuilderFactory.CamundaComponentBuilder extends ComponentBuilder<org.apache.camel.component.camunda.CamundaComponent>
Builder for the Camunda component.

  • Method Details

    • grpcAddress

      default CamundaComponentBuilderFactory.CamundaComponentBuilder grpcAddress(String grpcAddress)
      gRPC address of the Camunda cluster (e.g. http://localhost:26500). Used for self-managed connections when clusterId is not set. The option is a: <code>java.lang.String</code> type. Default: http://localhost:26500 Group: common
      Parameters:
      grpcAddress - the value to set
      Returns:
      the dsl builder

    • restAddress

      default CamundaComponentBuilderFactory.CamundaComponentBuilder restAddress(String restAddress)
      REST address of the Camunda cluster (e.g. http://localhost:8080). Used for self-managed connections when clusterId is not set. The option is a: <code>java.lang.String</code> type. Default: http://localhost:8080 Group: common
      Parameters:
      restAddress - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default CamundaComponentBuilderFactory.CamundaComponentBuilder 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 CamundaComponentBuilderFactory.CamundaComponentBuilder 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 CamundaComponentBuilderFactory.CamundaComponentBuilder 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

    • clientId

      default CamundaComponentBuilderFactory.CamundaComponentBuilder clientId(String clientId)
      Client ID for OAuth / SaaS authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • clientSecret

      default CamundaComponentBuilderFactory.CamundaComponentBuilder clientSecret(String clientSecret)
      Client secret for OAuth / SaaS authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder

    • clusterId

      default CamundaComponentBuilderFactory.CamundaComponentBuilder clusterId(String clusterId)
      Camunda SaaS cluster ID. When set, the client connects via the cloud builder. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clusterId - the value to set
      Returns:
      the dsl builder

    • oAuthAPI

      default CamundaComponentBuilderFactory.CamundaComponentBuilder oAuthAPI(String oAuthAPI)
      OAuth authorization server URL for self-managed authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      oAuthAPI - the value to set
      Returns:
      the dsl builder

    • region

      default CamundaComponentBuilderFactory.CamundaComponentBuilder region(String region)
      Camunda SaaS region (default: bru-2). The option is a: <code>java.lang.String</code> type. Default: bru-2 Group: security
      Parameters:
      region - the value to set
      Returns:
      the dsl builder