Consul Component

Table of Contents

URI format
Options
Headers

Available as of Camel 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>

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

The Consul component supports 22 endpoint options which are listed below:

{% raw %}

Name	Group	Default	Java Type	Description
apiEndpoint	common		`String`	Required The API endpoint
connectTimeoutMillis	common		`Long`	Connect timeout for OkHttpClient
dc	common		`String`	The data center
key	common		`String`	The default key. Can be overridden by CamelConsulKey
pingInstance	common	`true`	`boolean`	Configure if the AgentClient should attempt a ping before returning the Consul instance
readTimeoutMillis	common		`Long`	Read timeout for OkHttpClient
tags	common		`String`	Set tags. You can separate multiple tags by comma.
url	common		`String`	The Consul agent URL
writeTimeoutMillis	common		`Long`	Write timeout for OkHttpClient
bridgeErrorHandler	consumer	`false`	`boolean`	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/ERROR level and ignored.
exceptionHandler	consumer (advanced)		`ExceptionHandler`	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/ERROR level and ignored.
exchangePattern	consumer (advanced)		`ExchangePattern`	Sets the exchange pattern when the consumer creates an exchange.
action	producer		`String`	The default action. Can be overridden by CamelConsulAction
valueAsString	producer	`false`	`boolean`	Default to transform values retrieved from Consul i.e. on KV endpoint to string.
synchronous	advanced	`false`	`boolean`	Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
blockSeconds	watch	`10`	`Integer`	The second to wait for a watch event default 10 seconds
firstIndex	watch	`0`	`long`	The first index for watch for default 0
recursive	watch	`false`	`boolean`	Recursively watch default false
aclToken	security		`String`	Sets the ACL token to be used with Consul
password	security		`String`	Sets the password to be used for basic authentication
sslContextParameters	security		`SSLContextParameters`	SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance.
userName	security		`String`	Sets the username to be used for basic authentication

{% endraw %}

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.