camel-jbpm-kafka-connector source configuration

Connector Description: Interact with jBPM workflow engine over REST.

When using camel-jbpm-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-jbpm-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.jbpm.CamelJbpmSourceConnector

The camel-jbpm source connector supports 33 options, which are listed below.

Name Description Default Priority

camel.source.path.connectionURL

Required The URL to the jBPM server.

HIGH

camel.source.path.eventListenerType

Sets the event listener type to attach to.

MEDIUM

camel.source.endpoint.attachmentId

attachId to use when retrieving attachments.

MEDIUM

camel.source.endpoint.contentId

contentId to use when retrieving attachments.

MEDIUM

camel.source.endpoint.deploymentId

Required The id of the deployment.

HIGH

camel.source.endpoint.emitterSendItems

Sets if event produced by emitter should be sent as single items or complete collection.

MEDIUM

camel.source.endpoint.event

the data associated with this event when signalEvent operation is performed.

MEDIUM

camel.source.endpoint.eventType

the type of event to use when signalEvent operation is performed.

MEDIUM

camel.source.endpoint.identifier

identifier the global identifier.

MEDIUM

camel.source.endpoint.maxNumber

the maximum number of rules that should be fired.

MEDIUM

camel.source.endpoint.page

The page to use when retrieving user tasks.

MEDIUM

camel.source.endpoint.pageSize

The page size to use when retrieving user tasks.

MEDIUM

camel.source.endpoint.processId

the id of the process that should be acted upon.

MEDIUM

camel.source.endpoint.processInstanceId

the id of the process instance.

MEDIUM

camel.source.endpoint.targetUserId

The targetUserId used when delegating a task.

MEDIUM

camel.source.endpoint.task

The task instance to use with task operations.

MEDIUM

camel.source.endpoint.taskId

the id of the task.

MEDIUM

camel.source.endpoint.timeout

A timeout value.

MEDIUM

camel.source.endpoint.userId

userId to use with task operations.

MEDIUM

camel.source.endpoint.value

the value to assign to the global identifier.

MEDIUM

camel.source.endpoint.workItemId

the id of the work item.

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used.

false

MEDIUM

camel.source.endpoint.entities

The potentialOwners when nominateTask operation is performed.

MEDIUM

camel.source.endpoint.extraJaxbClasses

To load additional classes when working with XML.

MEDIUM

camel.source.endpoint.parameters

the variables that should be set for various operations.

MEDIUM

camel.source.endpoint.statuses

The list of status to use when filtering tasks.

MEDIUM

camel.source.endpoint.password

Password for authentication.

MEDIUM

camel.source.endpoint.userName

Username for authentication.

MEDIUM

camel.component.jbpm.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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

MEDIUM

camel.component.jbpm.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.

true

MEDIUM

The camel-jbpm source connector has no converters out of the box.

The camel-jbpm source connector has no transforms out of the box.

The camel-jbpm source connector has no aggregation strategies out of the box.

Back to top