camel-consul-kafka-connector source configuration

Connector Description: Integrate with Consul service discovery and configuration store.

When using camel-consul-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-consul-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.consul.CamelConsulSourceConnector

The camel-consul source connector supports 52 options, which are listed below.

Name Description Default Priority

camel.source.path.apiEndpoint

Required The API endpoint.

HIGH

camel.source.endpoint.connectTimeout

Connect timeout for OkHttpClient.

MEDIUM

camel.source.endpoint.connectTimeoutMillis

Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead.

LOW

camel.source.endpoint.consulClient

Reference to a com.orbitz.consul.Consul in the registry.

MEDIUM

camel.source.endpoint.key

The default key. Can be overridden by CamelConsulKey.

MEDIUM

camel.source.endpoint.pingInstance

Configure if the AgentClient should attempt a ping before returning the Consul instance.

true

MEDIUM

camel.source.endpoint.readTimeout

Read timeout for OkHttpClient.

MEDIUM

camel.source.endpoint.readTimeoutMillis

Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead.

LOW

camel.source.endpoint.tags

Set tags. You can separate multiple tags by comma.

MEDIUM

camel.source.endpoint.url

The Consul agent URL.

MEDIUM

camel.source.endpoint.writeTimeout

Write timeout for OkHttpClient.

MEDIUM

camel.source.endpoint.writeTimeoutMillis

Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead.

LOW

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.consistencyMode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT].

Enum values:

  • DEFAULT

  • STALE

  • CONSISTENT

"DEFAULT"

MEDIUM

camel.source.endpoint.datacenter

The data center.

MEDIUM

camel.source.endpoint.nearNode

The near node to use for queries.

MEDIUM

camel.source.endpoint.nodeMeta

The note meta-data to use for queries.

MEDIUM

camel.source.endpoint.aclToken

Sets the ACL token to be used with Consul.

MEDIUM

camel.source.endpoint.password

Sets the password to be used for basic authentication.

MEDIUM

camel.source.endpoint.sslContextParameters

SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.

MEDIUM

camel.source.endpoint.userName

Sets the username to be used for basic authentication.

MEDIUM

camel.source.endpoint.blockSeconds

The second to wait for a watch event, default 10 seconds.

"10"

MEDIUM

camel.source.endpoint.firstIndex

The first index for watch for, default 0.

"0"

MEDIUM

camel.source.endpoint.recursive

Recursively watch, default false.

false

MEDIUM

camel.component.consul.connectTimeout

Connect timeout for OkHttpClient.

MEDIUM

camel.component.consul.connectTimeoutMillis

Connect timeout for OkHttpClient. Deprecation note: Use connectTimeout instead.

LOW

camel.component.consul.consulClient

Reference to a com.orbitz.consul.Consul in the registry.

MEDIUM

camel.component.consul.key

The default key. Can be overridden by CamelConsulKey.

MEDIUM

camel.component.consul.pingInstance

Configure if the AgentClient should attempt a ping before returning the Consul instance.

true

MEDIUM

camel.component.consul.readTimeout

Read timeout for OkHttpClient.

MEDIUM

camel.component.consul.readTimeoutMillis

Read timeout for OkHttpClient. Deprecation note: Use readTimeout instead.

LOW

camel.component.consul.tags

Set tags. You can separate multiple tags by comma.

MEDIUM

camel.component.consul.url

The Consul agent URL.

MEDIUM

camel.component.consul.writeTimeout

Write timeout for OkHttpClient.

MEDIUM

camel.component.consul.writeTimeoutMillis

Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead.

LOW

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

camel.component.consul.configuration

Consul configuration.

MEDIUM

camel.component.consul.consistencyMode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT].

Enum values:

  • DEFAULT

  • STALE

  • CONSISTENT

"DEFAULT"

MEDIUM

camel.component.consul.datacenter

The data center.

MEDIUM

camel.component.consul.nearNode

The near node to use for queries.

MEDIUM

camel.component.consul.nodeMeta

The note meta-data to use for queries.

MEDIUM

camel.component.consul.aclToken

Sets the ACL token to be used with Consul.

MEDIUM

camel.component.consul.password

Sets the password to be used for basic authentication.

MEDIUM

camel.component.consul.sslContextParameters

SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance.

MEDIUM

camel.component.consul.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

MEDIUM

camel.component.consul.userName

Sets the username to be used for basic authentication.

MEDIUM

camel.component.consul.blockSeconds

The second to wait for a watch event, default 10 seconds.

"10"

MEDIUM

camel.component.consul.firstIndex

The first index for watch for, default 0.

"0"

MEDIUM

camel.component.consul.recursive

Recursively watch, default false.

false

MEDIUM

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

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

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

Back to top