Chapter 68. Consul Component

Available as of Camel version 2.18

The Consul component is a component for integrating your application with 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>

68.1. URI format

    consul://domain?[options]

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

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

68.2. Options

The Consul component supports 9 options which are listed below.

NameDescriptionDefaultType

url (common)

The Consul agent URL

 

String

datacenter (common)

The data center

 

String

sslContextParameters (common)

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

 

SSLContextParameters

useGlobalSslContext Parameters (security)

Enable usage of global SSL context parameters.

false

boolean

aclToken (common)

Sets the ACL token to be used with Consul

 

String

userName (common)

Sets the username to be used for basic authentication

 

String

password (common)

Sets the password to be used for basic authentication

 

String

configuration (advanced)

Sets the common configuration shared among endpoints

 

ConsulConfiguration

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

The Consul endpoint is configured using URI syntax: 

consul:apiEndpoint

with the following path and query parameters:

68.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

apiEndpoint

Required The API endpoint

 

String

68.2.2. Query Parameters (4 parameters):

NameDescriptionDefaultType

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

 

ExchangePattern

synchronous (advanced)

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

false

boolean

68.3. Headers

NameTypeDescription

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.