| // kafka-connector options: START |
| [[camel-rabbitmq-kafka-connector-source]] |
| = camel-rabbitmq-kafka-connector source configuration |
| |
| When using camel-rabbitmq-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-rabbitmq-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-rabbitmq source connector supports 93 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.exchangeName* | The exchange name determines which exchange produced messages will sent to. In the case of consumers, the exchange name determines which exchange the queue will bind to. | null | HIGH |
| | *camel.source.endpoint.addresses* | If this option is set, camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345, server2:12345 | null | MEDIUM |
| | *camel.source.endpoint.autoDelete* | If it is true, the exchange will be deleted when it is no longer in use | true | MEDIUM |
| | *camel.source.endpoint.automaticRecoveryEnabled* | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when existing connection has failures) | "true" | MEDIUM |
| | *camel.source.endpoint.connectionFactory* | To use a custom RabbitMQ connection factory. When this option is set, all connection options (connectionTimeout, requestedChannelMax...) set on URI are not used | null | MEDIUM |
| | *camel.source.endpoint.deadLetterExchange* | The name of the dead letter exchange | null | MEDIUM |
| | *camel.source.endpoint.deadLetterExchangeType* | The type of the dead letter exchange One of: [direct] [fanout] [headers] [topic] | "direct" | MEDIUM |
| | *camel.source.endpoint.deadLetterQueue* | The name of the dead letter queue | null | MEDIUM |
| | *camel.source.endpoint.deadLetterRoutingKey* | The routing key for the dead letter exchange | null | MEDIUM |
| | *camel.source.endpoint.declare* | If the option is true, camel declare the exchange and queue name and bind them together. If the option is false, camel won't declare the exchange and queue name on the server. | true | MEDIUM |
| | *camel.source.endpoint.durable* | If we are declaring a durable exchange (the exchange will survive a server restart) | true | MEDIUM |
| | *camel.source.endpoint.exchangeType* | The exchange type such as direct or topic. One of: [direct] [fanout] [headers] [topic] | "direct" | MEDIUM |
| | *camel.source.endpoint.exclusive* | Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. | false | MEDIUM |
| | *camel.source.endpoint.hostname* | The hostname of the running rabbitmq instance or cluster. | null | MEDIUM |
| | *camel.source.endpoint.passive* | Passive queues depend on the queue already to be available at RabbitMQ. | false | MEDIUM |
| | *camel.source.endpoint.portNumber* | Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | null | MEDIUM |
| | *camel.source.endpoint.queue* | The queue to receive messages from | null | MEDIUM |
| | *camel.source.endpoint.routingKey* | The routing key to use when binding a consumer queue to the exchange. For producer routing keys, you set the header rabbitmq.ROUTING_KEY. | null | MEDIUM |
| | *camel.source.endpoint.skipExchangeDeclare* | This can be used if we need to declare the queue but not the exchange | false | MEDIUM |
| | *camel.source.endpoint.skipQueueBind* | If true the queue will not be bound to the exchange after declaring it | false | MEDIUM |
| | *camel.source.endpoint.skipQueueDeclare* | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | MEDIUM |
| | *camel.source.endpoint.vhost* | The vhost for the channel | "/" | MEDIUM |
| | *camel.source.endpoint.autoAck* | If messages should be auto acknowledged | true | 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.concurrentConsumers* | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). | 1 | MEDIUM |
| | *camel.source.endpoint.exclusiveConsumer* | Request exclusive access to the queue (meaning only this consumer can access the queue). This is useful when you want a long-lived shared queue to be temporarily accessible by just one consumer. | false | MEDIUM |
| | *camel.source.endpoint.prefetchCount* | The maximum number of messages that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | null | MEDIUM |
| | *camel.source.endpoint.prefetchEnabled* | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | false | MEDIUM |
| | *camel.source.endpoint.prefetchGlobal* | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | false | MEDIUM |
| | *camel.source.endpoint.prefetchSize* | The maximum amount of content (measured in octets) that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | null | 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. | null | MEDIUM |
| | *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | MEDIUM |
| | *camel.source.endpoint.threadPoolSize* | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | MEDIUM |
| | *camel.source.endpoint.args* | Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: \http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | null | MEDIUM |
| | *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.source.endpoint.clientProperties* | Connection client properties (client info used in negotiating with the server) | null | MEDIUM |
| | *camel.source.endpoint.connectionTimeout* | Connection timeout | 60000 | MEDIUM |
| | *camel.source.endpoint.networkRecoveryInterval* | Network recovery interval in milliseconds (interval used when recovering from network failure) | "5000" | MEDIUM |
| | *camel.source.endpoint.requestedChannelMax* | Connection requested channel max (max number of channels offered) | 2047 | MEDIUM |
| | *camel.source.endpoint.requestedFrameMax* | Connection requested frame max (max size of frame offered) | 0 | MEDIUM |
| | *camel.source.endpoint.requestedHeartbeat* | Connection requested heartbeat (heart-beat in seconds offered) | 60 | MEDIUM |
| | *camel.source.endpoint.requestTimeout* | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | 20000L | MEDIUM |
| | *camel.source.endpoint.requestTimeoutChecker Interval* | Set requestTimeoutCheckerInterval for inOut exchange | 1000L | MEDIUM |
| | *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM |
| | *camel.source.endpoint.topologyRecoveryEnabled* | Enables connection topology recovery (should topology recovery be performed) | null | MEDIUM |
| | *camel.source.endpoint.transferException* | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | MEDIUM |
| | *camel.source.endpoint.password* | Password for authenticated access | "guest" | MEDIUM |
| | *camel.source.endpoint.sslProtocol* | Enables SSL on connection, accepted value are true, TLS and 'SSLv3 | null | MEDIUM |
| | *camel.source.endpoint.trustManager* | Configure SSL trust manager, SSL should be enabled for this option to be effective | null | MEDIUM |
| | *camel.source.endpoint.username* | Username in case of authenticated access | "guest" | MEDIUM |
| | *camel.component.rabbitmq.addresses* | If this option is set, camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345, server2:12345 | null | MEDIUM |
| | *camel.component.rabbitmq.autoDelete* | If it is true, the exchange will be deleted when it is no longer in use | true | MEDIUM |
| | *camel.component.rabbitmq.connectionFactory* | To use a custom RabbitMQ connection factory. When this option is set, all connection options (connectionTimeout, requestedChannelMax...) set on URI are not used | null | MEDIUM |
| | *camel.component.rabbitmq.deadLetterExchange* | The name of the dead letter exchange | null | MEDIUM |
| | *camel.component.rabbitmq.deadLetterExchangeType* | The type of the dead letter exchange One of: [direct] [fanout] [headers] [topic] | "direct" | MEDIUM |
| | *camel.component.rabbitmq.deadLetterQueue* | The name of the dead letter queue | null | MEDIUM |
| | *camel.component.rabbitmq.deadLetterRoutingKey* | The routing key for the dead letter exchange | null | MEDIUM |
| | *camel.component.rabbitmq.declare* | If the option is true, camel declare the exchange and queue name and bind them together. If the option is false, camel won't declare the exchange and queue name on the server. | true | MEDIUM |
| | *camel.component.rabbitmq.durable* | If we are declaring a durable exchange (the exchange will survive a server restart) | true | MEDIUM |
| | *camel.component.rabbitmq.exclusive* | Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. | false | MEDIUM |
| | *camel.component.rabbitmq.hostname* | The hostname of the running RabbitMQ instance or cluster. | null | MEDIUM |
| | *camel.component.rabbitmq.passive* | Passive queues depend on the queue already to be available at RabbitMQ. | false | MEDIUM |
| | *camel.component.rabbitmq.portNumber* | Port number for the host with the running rabbitmq instance or cluster. | 5672 | MEDIUM |
| | *camel.component.rabbitmq.skipExchangeDeclare* | This can be used if we need to declare the queue but not the exchange | false | MEDIUM |
| | *camel.component.rabbitmq.skipQueueBind* | If true the queue will not be bound to the exchange after declaring it | false | MEDIUM |
| | *camel.component.rabbitmq.skipQueueDeclare* | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | MEDIUM |
| | *camel.component.rabbitmq.vhost* | The vhost for the channel | "/" | MEDIUM |
| | *camel.component.rabbitmq.autoAck* | If messages should be auto acknowledged | true | MEDIUM |
| | *camel.component.rabbitmq.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.rabbitmq.exclusiveConsumer* | Request exclusive access to the queue (meaning only this consumer can access the queue). This is useful when you want a long-lived shared queue to be temporarily accessible by just one consumer. | false | MEDIUM |
| | *camel.component.rabbitmq.prefetchCount* | The maximum number of messages that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | null | MEDIUM |
| | *camel.component.rabbitmq.prefetchEnabled* | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | false | MEDIUM |
| | *camel.component.rabbitmq.prefetchGlobal* | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | false | MEDIUM |
| | *camel.component.rabbitmq.prefetchSize* | The maximum amount of content (measured in octets) that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time | null | MEDIUM |
| | *camel.component.rabbitmq.threadPoolSize* | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | MEDIUM |
| | *camel.component.rabbitmq.args* | Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: \http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | null | MEDIUM |
| | *camel.component.rabbitmq.autoDetectConnection Factory* | Whether to auto-detect looking up RabbitMQ connection factory from the registry. When enabled and a single instance of the connection factory is found then it will be used. An explicit connection factory can be configured on the component or endpoint level which takes precedence. | true | MEDIUM |
| | *camel.component.rabbitmq.automaticRecoveryEnabled* | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | null | MEDIUM |
| | *camel.component.rabbitmq.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| | *camel.component.rabbitmq.clientProperties* | Connection client properties (client info used in negotiating with the server) | null | MEDIUM |
| | *camel.component.rabbitmq.connectionTimeout* | Connection timeout | 60000 | MEDIUM |
| | *camel.component.rabbitmq.networkRecoveryInterval* | Network recovery interval in milliseconds (interval used when recovering from network failure) | "5000" | MEDIUM |
| | *camel.component.rabbitmq.requestedChannelMax* | Connection requested channel max (max number of channels offered) | 2047 | MEDIUM |
| | *camel.component.rabbitmq.requestedFrameMax* | Connection requested frame max (max size of frame offered) | 0 | MEDIUM |
| | *camel.component.rabbitmq.requestedHeartbeat* | Connection requested heartbeat (heart-beat in seconds offered) | 60 | MEDIUM |
| | *camel.component.rabbitmq.requestTimeout* | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | 20000L | MEDIUM |
| | *camel.component.rabbitmq.requestTimeoutChecker Interval* | Set requestTimeoutCheckerInterval for inOut exchange | 1000L | MEDIUM |
| | *camel.component.rabbitmq.topologyRecoveryEnabled* | Enables connection topology recovery (should topology recovery be performed) | null | MEDIUM |
| | *camel.component.rabbitmq.transferException* | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | MEDIUM |
| | *camel.component.rabbitmq.password* | Password for authenticated access | "guest" | MEDIUM |
| | *camel.component.rabbitmq.sslProtocol* | Enables SSL on connection, accepted value are true, TLS and 'SSLv3 | null | MEDIUM |
| | *camel.component.rabbitmq.trustManager* | Configure SSL trust manager, SSL should be enabled for this option to be effective | null | MEDIUM |
| | *camel.component.rabbitmq.username* | Username in case of authenticated access | "guest" | MEDIUM |
| |=== |
| // kafka-connector options: END |
