Consul

Since Camel 2.18

Both producer and consumer are supported

The Consul component is a component for integrating your application with Hashicorp Consul.

Maven users will need to add the following dependency to their pom.xml for this component:

    <dependency>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-consul</artifactId>
        <version>${camel-version}</version>
    </dependency>

URI format

    consul://domain?[options]

You can append query options to the URI in the following format:

    ?option=value&option=value&...

Options

The Consul component supports 29 options, which are listed below.

Name Description Default Type

connectTimeout (common)

Connect timeout for OkHttpClient

Duration

connectTimeoutMillis (common)

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

Long

consulClient (common)

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

Consul

key (common)

The default key. Can be overridden by CamelConsulKey

String

pingInstance (common)

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

true

boolean

readTimeout (common)

Read timeout for OkHttpClient

Duration

readTimeoutMillis (common)

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

Long

tags (common)

Set tags. You can separate multiple tags by comma.

String

url (common)

The Consul agent URL

String

writeTimeout (common)

Write timeout for OkHttpClient

Duration

writeTimeoutMillis (common)

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

Long

bridgeErrorHandler (consumer)

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

boolean

action (producer)

The default action. Can be overridden by CamelConsulAction

String

lazyStartProducer (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

valueAsString (producer)

Default to transform values retrieved from Consul i.e. on KV endpoint to string.

false

boolean

basicPropertyBinding (advanced)

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

configuration (advanced)

Consul configuration

ConsulConfiguration

consistencyMode (advanced)

The consistencyMode used for queries, default ConsistencyMode.DEFAULT. There are 3 enums and the value can be one of: DEFAULT, STALE, CONSISTENT

DEFAULT

ConsistencyMode

datacenter (advanced)

The data center

String

nearNode (advanced)

The near node to use for queries.

String

nodeMeta (advanced)

The note meta-data to use for queries.

List

aclToken (security)

Sets the ACL token to be used with Consul

String

password (security)

Sets the password to be used for basic authentication

String

sslContextParameters (security)

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

SSLContextParameters

useGlobalSslContextParameters (security)

Enable usage of global SSL context parameters.

false

boolean

userName (security)

Sets the username to be used for basic authentication

String

blockSeconds (watch)

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

10

Integer

firstIndex (watch)

The first index for watch for, default 0

0

BigInteger

recursive (watch)

Recursively watch, default false

false

boolean

The Consul endpoint is configured using URI syntax:

consul:apiEndpoint

with the following path and query parameters:

Path Parameters (1 parameters):

Name Description Default Type

apiEndpoint

Required The API endpoint

String

Query Parameters (30 parameters):

Name Description Default Type

connectTimeout (common)

Connect timeout for OkHttpClient

Duration

connectTimeoutMillis (common)

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

Long

consulClient (common)

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

Consul

key (common)

The default key. Can be overridden by CamelConsulKey

String

pingInstance (common)

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

true

boolean

readTimeout (common)

Read timeout for OkHttpClient

Duration

readTimeoutMillis (common)

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

Long

tags (common)

Set tags. You can separate multiple tags by comma.

String

url (common)

The Consul agent URL

String

writeTimeout (common)

Write timeout for OkHttpClient

Duration

writeTimeoutMillis (common)

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

Long

bridgeErrorHandler (consumer)

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

boolean

exceptionHandler (consumer)

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.

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

action (producer)

The default action. Can be overridden by CamelConsulAction

String

lazyStartProducer (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

valueAsString (producer)

Default to transform values retrieved from Consul i.e. on KV endpoint to string.

false

boolean

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

consistencyMode (advanced)

The consistencyMode used for queries, default ConsistencyMode.DEFAULT. There are 3 enums and the value can be one of: DEFAULT, STALE, CONSISTENT

DEFAULT

ConsistencyMode

datacenter (advanced)

The data center

String

nearNode (advanced)

The near node to use for queries.

String

nodeMeta (advanced)

The note meta-data to use for queries.

List

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

aclToken (security)

Sets the ACL token to be used with Consul

String

password (security)

Sets the password to be used for basic authentication

String

sslContextParameters (security)

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

SSLContextParameters

userName (security)

Sets the username to be used for basic authentication

String

blockSeconds (watch)

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

10

Integer

firstIndex (watch)

The first index for watch for, default 0

0

BigInteger

recursive (watch)

Recursively watch, default false

false

boolean

Headers

Name Type Description

CamelConsulAction

String

The Producer action

CamelConsulKey

String

The Key on which the action should applied

CamelConsulEventId

String

The event id (consumer only)

CamelConsulEventName

String

The event name (consumer only)

CamelConsulEventLTime

Long

The event LTime

CamelConsulNodeFilter

String

The Node filter

CamelConsulTagFilter

String

The tag filter

CamelConsulSessionFilter

String

The session filter

CamelConsulVersion

int

The data version

CamelConsulFlags

Long

Flags associated with a value

CamelConsulCreateIndex

Long

The internal index value that represents when the entry was created

CamelConsulLockIndex

Long

The number of times this key has successfully been acquired in a lock

CamelConsulModifyIndex

Long

The last index that modified this key

CamelConsulOptions

Object

Options associated to the request

CamelConsulResult

boolean

true if the response has a result

CamelConsulSession

String

The session id

CamelConsulValueAsString

boolean

To transform values retrieved from Consul i.e. on KV endpoint to string.

Spring Boot Auto-Configuration

When using consul with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-consul-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 90 options, which are listed below.

Name Description Default Type

camel.component.consul.acl-token

Sets the ACL token to be used with Consul

String

camel.component.consul.action

The default action. Can be overridden by CamelConsulAction

String

camel.component.consul.block-seconds

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

10

Integer

camel.component.consul.bridge-error-handler

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

Boolean

camel.component.consul.cluster.service.acl-token

Sets the ACL token to be used with Consul

String

camel.component.consul.cluster.service.attributes

Custom service attributes.

Map

camel.component.consul.cluster.service.block-seconds

The time (in seconds) to wait for a watch event, default 10 seconds

10

Integer

camel.component.consul.cluster.service.connect-timeout

Connect timeout for OkHttpClient

Duration

camel.component.consul.cluster.service.connect-timeout-millis

Use connectTimeout instead

Long

camel.component.consul.cluster.service.consistency-mode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT

ConsistencyMode

camel.component.consul.cluster.service.datacenter

The data center

String

camel.component.consul.cluster.service.enabled

Sets if the consul cluster service should be enabled or not, default is false.

false

Boolean

camel.component.consul.cluster.service.first-index

The first index for watch for, default 0

0

BigInteger

camel.component.consul.cluster.service.id

Cluster Service ID

String

camel.component.consul.cluster.service.near-node

The near node to use for queries.

String

camel.component.consul.cluster.service.node-meta

The note meta-data to use for queries.

List

camel.component.consul.cluster.service.order

Service lookup order/priority.

Integer

camel.component.consul.cluster.service.password

Sets the password to be used for basic authentication

String

camel.component.consul.cluster.service.ping-instance

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

true

Boolean

camel.component.consul.cluster.service.read-timeout

Read timeout for OkHttpClient

Duration

camel.component.consul.cluster.service.read-timeout-millis

Use readTimeout instead.

Long

camel.component.consul.cluster.service.recursive

Recursively watch, default false

false

Boolean

camel.component.consul.cluster.service.root-path

Consul root path

/camel

String

camel.component.consul.cluster.service.session-lock-delay

The value for lockDelay

5

Integer

camel.component.consul.cluster.service.session-refresh-interval

The value of wait attribute

5

Integer

camel.component.consul.cluster.service.session-ttl

The value of TTL

60

Integer

camel.component.consul.cluster.service.ssl-context-parameters

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

SSLContextParameters

camel.component.consul.cluster.service.tags

Set tags. You can separate multiple tags by comma.

Set

camel.component.consul.cluster.service.url

The Consul agent URL

String

camel.component.consul.cluster.service.user-name

Sets the username to be used for basic authentication

String

camel.component.consul.cluster.service.write-timeout

Write timeout for OkHttpClient

Duration

camel.component.consul.cluster.service.write-timeout-millis

Use writeTimeout instead.

Long

camel.component.consul.configuration

Consul configuration. The option is a org.apache.camel.component.consul.ConsulConfiguration type.

String

camel.component.consul.connect-timeout

Connect timeout for OkHttpClient. The option is a java.time.Duration type.

String

camel.component.consul.consistency-mode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT

ConsistencyMode

camel.component.consul.consul-client

Reference to a com.orbitz.consul.Consul in the registry. The option is a com.orbitz.consul.Consul type.

String

camel.component.consul.datacenter

The data center

String

camel.component.consul.enabled

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

Boolean

camel.component.consul.first-index

The first index for watch for, default 0. The option is a java.math.BigInteger type.

String

camel.component.consul.key

The default key. Can be overridden by CamelConsulKey

String

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

The near node to use for queries.

String

camel.component.consul.node-meta

The note meta-data to use for queries.

List

camel.component.consul.password

Sets the password to be used for basic authentication

String

camel.component.consul.ping-instance

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

true

Boolean

camel.component.consul.read-timeout

Read timeout for OkHttpClient. The option is a java.time.Duration type.

String

camel.component.consul.recursive

Recursively watch, default false

false

Boolean

camel.component.consul.service-registry.acl-token

Sets the ACL token to be used with Consul

String

camel.component.consul.service-registry.attributes

Custom service attributes.

Map

camel.component.consul.service-registry.block-seconds

The time (in seconds) to wait for a watch event, default 10 seconds

10

Integer

camel.component.consul.service-registry.check-interval

How often (in seconds) a service has to be marked as healthy if its check is TTL or how often the check should run. Default is 5 seconds.

5

Integer

camel.component.consul.service-registry.check-ttl

The time (in seconds) to live for TTL checks. Default is 1 minute.

60

Integer

camel.component.consul.service-registry.connect-timeout

Connect timeout for OkHttpClient

Duration

camel.component.consul.service-registry.connect-timeout-millis

Use connectTimeout instead

Long

camel.component.consul.service-registry.consistency-mode

The consistencyMode used for queries, default ConsistencyMode.DEFAULT

ConsistencyMode

camel.component.consul.service-registry.datacenter

The data center

String

camel.component.consul.service-registry.deregister-after

How long (in seconds) to wait to deregister a service in case of unclean shutdown. Default is 1 hour.

3600

Integer

camel.component.consul.service-registry.deregister-services-on-stop

Should we remove all the registered services know by this registry on stop?

true

Boolean

camel.component.consul.service-registry.enabled

Sets if the consul service registry should be enabled or not, default is false.

false

Boolean

camel.component.consul.service-registry.first-index

The first index for watch for, default 0

0

BigInteger

camel.component.consul.service-registry.id

Service Registry ID

String

camel.component.consul.service-registry.near-node

The near node to use for queries.

String

camel.component.consul.service-registry.node-meta

The note meta-data to use for queries.

List

camel.component.consul.service-registry.order

Service lookup order/priority.

Integer

camel.component.consul.service-registry.override-service-host

Should we override the service host if given ?

true

Boolean

camel.component.consul.service-registry.password

Sets the password to be used for basic authentication

String

camel.component.consul.service-registry.ping-instance

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

true

Boolean

camel.component.consul.service-registry.read-timeout

Read timeout for OkHttpClient

Duration

camel.component.consul.service-registry.read-timeout-millis

Use readTimeout instead.

Long

camel.component.consul.service-registry.recursive

Recursively watch, default false

false

Boolean

camel.component.consul.service-registry.service-host

Service host.

String

camel.component.consul.service-registry.ssl-context-parameters

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

SSLContextParameters

camel.component.consul.service-registry.tags

Set tags. You can separate multiple tags by comma.

Set

camel.component.consul.service-registry.url

The Consul agent URL

String

camel.component.consul.service-registry.user-name

Sets the username to be used for basic authentication

String

camel.component.consul.service-registry.write-timeout

Write timeout for OkHttpClient

Duration

camel.component.consul.service-registry.write-timeout-millis

Use writeTimeout instead.

Long

camel.component.consul.ssl-context-parameters

SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. The option is a org.apache.camel.support.jsse.SSLContextParameters type.

String

camel.component.consul.tags

Set tags. You can separate multiple tags by comma.

String

camel.component.consul.url

The Consul agent URL

String

camel.component.consul.use-global-ssl-context-parameters

Enable usage of global SSL context parameters.

false

Boolean

camel.component.consul.user-name

Sets the username to be used for basic authentication

String

camel.component.consul.value-as-string

Default to transform values retrieved from Consul i.e. on KV endpoint to string.

false

Boolean

camel.component.consul.write-timeout

Write timeout for OkHttpClient. The option is a java.time.Duration type.

String

camel.component.consul.basic-property-binding

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.consul.cluster.service.dc

Deprecated Use datacenter instead

String

camel.component.consul.connect-timeout-millis

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

Long

camel.component.consul.read-timeout-millis

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

Long

camel.component.consul.service-registry.dc

Deprecated Use datacenter instead

String

camel.component.consul.write-timeout-millis

Deprecated Write timeout for OkHttpClient. Deprecation note: Use writeTimeout instead. The option is a java.lang.Long type.

String