Zeebe

Zeebe component which integrates with Camunda Zeebe to interact with the API.

What’s inside

Zeebe component, URI syntax: zeebe:operationName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-zeebe-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 9 options, which are listed below.

Name	Description	Default	Type
camel.component.zeebe.autowired-enabled	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.	true	Boolean
camel.component.zeebe.bridge-error-handler	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.	false	Boolean
camel.component.zeebe.client-id	Client id to be used when requesting access token from OAuth authorization server.		String
camel.component.zeebe.client-secret	Client secret to be used when requesting access token from OAuth authorization server.		String
camel.component.zeebe.enabled	Whether to enable auto configuration of the zeebe component. This is enabled by default.		Boolean
camel.component.zeebe.gateway-host	The gateway server hostname to connect to the Zeebe cluster.	localhost	String
camel.component.zeebe.gateway-port	The gateway server port to connect to the Zeebe cluster.	26500	Integer
camel.component.zeebe.lazy-start-producer	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.	false	Boolean
camel.component.zeebe.o-auth-a-p-i	The authorization server’s URL, from which the access token will be requested.		String

Name

Description

Default

Type

camel.component.zeebe.autowired-enabled

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.

true

Boolean

camel.component.zeebe.bridge-error-handler

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.

false

Boolean

camel.component.zeebe.client-id

Client id to be used when requesting access token from OAuth authorization server.

String

camel.component.zeebe.client-secret

Client secret to be used when requesting access token from OAuth authorization server.

String

camel.component.zeebe.enabled

Whether to enable auto configuration of the zeebe component. This is enabled by default.

Boolean

camel.component.zeebe.gateway-host

The gateway server hostname to connect to the Zeebe cluster.

localhost

String

camel.component.zeebe.gateway-port

The gateway server port to connect to the Zeebe cluster.

26500

Integer

camel.component.zeebe.lazy-start-producer

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.

false

Boolean

camel.component.zeebe.o-auth-a-p-i

The authorization server’s URL, from which the access token will be requested.

String