| // kafka-connector options: START |
| [[camel-rabbitmq-kafka-connector-sink]] |
| = camel-rabbitmq-kafka-connector sink configuration |
| |
| When using camel-rabbitmq-kafka-connector as sink 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 sink connector supports 93 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.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 | ConfigDef.Importance.HIGH |
| | *camel.sink.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.autoDelete* | If it is true, the exchange will be deleted when it is no longer in use | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.automatic RecoveryEnabled* | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when existing connection has failures) | "true" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.connection Factory* | To use a custom RabbitMQ connection factory. When this option is set, all connection options (connectionTimeout, requestedChannelMax...) set on URI are not used | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.deadLetter Exchange* | The name of the dead letter exchange | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.deadLetter ExchangeType* | The type of the dead letter exchange One of: [direct] [fanout] [headers] [topic] | "direct" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.deadLetter Queue* | The name of the dead letter queue | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.deadLetter RoutingKey* | The routing key for the dead letter exchange | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.durable* | If we are declaring a durable exchange (the exchange will survive a server restart) | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.exchange Type* | The exchange type such as direct or topic. One of: [direct] [fanout] [headers] [topic] | "direct" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.exclusive* | Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.hostname* | The hostname of the running rabbitmq instance or cluster. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.passive* | Passive queues depend on the queue already to be available at RabbitMQ. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.portNumber* | Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.queue* | The queue to receive messages from | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.skip ExchangeDeclare* | This can be used if we need to declare the queue but not the exchange | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.skipQueue Bind* | If true the queue will not be bound to the exchange after declaring it | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.skipQueue Declare* | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.vhost* | The vhost for the channel | "/" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.allowNull Headers* | Allow pass null values to header | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.bridge Endpoint* | If the bridgeEndpoint is true, the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.channel PoolMaxSize* | Get maximum number of opened channel in pool | 10 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.channel PoolMaxWait* | Set the maximum number of milliseconds to wait for a channel from the pool | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.guaranteed Deliveries* | When true, an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case. See also publisher acknowledgements - When will messages be confirmed. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.immediate* | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set, the server will return an undeliverable message with a Return method. If this flag is zero, the server will queue the message, but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.lazyStart 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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.mandatory* | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set, the server will return an unroutable message with a Return method. If this flag is zero, the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.publisher Acknowledgements* | When true, the message will be published with publisher acknowledgements turned on | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.publisher AcknowledgementsTimeout* | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.client Properties* | Connection client properties (client info used in negotiating with the server) | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.connection Timeout* | Connection timeout | 60000 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.network RecoveryInterval* | Network recovery interval in milliseconds (interval used when recovering from network failure) | "5000" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.requested ChannelMax* | Connection requested channel max (max number of channels offered) | 2047 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.requested FrameMax* | Connection requested frame max (max size of frame offered) | 0 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.requested Heartbeat* | Connection requested heartbeat (heart-beat in seconds offered) | 60 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.request Timeout* | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | 20000L | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.request TimeoutCheckerInterval* | Set requestTimeoutCheckerInterval for inOut exchange | 1000L | ConfigDef.Importance.MEDIUM |
| | * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.topology RecoveryEnabled* | Enables connection topology recovery (should topology recovery be performed) | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.transfer Exception* | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.password* | Password for authenticated access | "guest" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.ssl Protocol* | Enables SSL on connection, accepted value are true, TLS and 'SSLv3 | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.trust Manager* | Configure SSL trust manager, SSL should be enabled for this option to be effective | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.username* | Username in case of authenticated access | "guest" | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.auto Delete* | If it is true, the exchange will be deleted when it is no longer in use | true | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.connection Factory* | To use a custom RabbitMQ connection factory. When this option is set, all connection options (connectionTimeout, requestedChannelMax...) set on URI are not used | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.dead LetterExchange* | The name of the dead letter exchange | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.dead LetterExchangeType* | The type of the dead letter exchange One of: [direct] [fanout] [headers] [topic] | "direct" | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.dead LetterQueue* | The name of the dead letter queue | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.dead LetterRoutingKey* | The routing key for the dead letter exchange | null | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.durable* | If we are declaring a durable exchange (the exchange will survive a server restart) | true | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.exclusive* | Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.hostname* | The hostname of the running RabbitMQ instance or cluster. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.passive* | Passive queues depend on the queue already to be available at RabbitMQ. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.port Number* | Port number for the host with the running rabbitmq instance or cluster. | 5672 | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.skip ExchangeDeclare* | This can be used if we need to declare the queue but not the exchange | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.skip QueueBind* | If true the queue will not be bound to the exchange after declaring it | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.skip QueueDeclare* | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.vhost* | The vhost for the channel | "/" | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.allow NullHeaders* | Allow pass null values to header | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.channel PoolMaxSize* | Get maximum number of opened channel in pool | 10 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.channel PoolMaxWait* | Set the maximum number of milliseconds to wait for a channel from the pool | 1000L | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.guaranteed Deliveries* | When true, an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case. See also publisher acknowledgements - When will messages be confirmed. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.immediate* | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set, the server will return an undeliverable message with a Return method. If this flag is zero, the server will queue the message, but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.mandatory* | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set, the server will return an unroutable message with a Return method. If this flag is zero, the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.publisher Acknowledgements* | When true, the message will be published with publisher acknowledgements turned on | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.publisher AcknowledgementsTimeout* | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | null | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.auto DetectConnectionFactory* | 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 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.automatic RecoveryEnabled* | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.client Properties* | Connection client properties (client info used in negotiating with the server) | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.connection Timeout* | Connection timeout | 60000 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.network RecoveryInterval* | Network recovery interval in milliseconds (interval used when recovering from network failure) | "5000" | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.requested ChannelMax* | Connection requested channel max (max number of channels offered) | 2047 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.requested FrameMax* | Connection requested frame max (max size of frame offered) | 0 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.requested Heartbeat* | Connection requested heartbeat (heart-beat in seconds offered) | 60 | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.request Timeout* | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | 20000L | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.request TimeoutCheckerInterval* | Set requestTimeoutCheckerInterval for inOut exchange | 1000L | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.topology RecoveryEnabled* | Enables connection topology recovery (should topology recovery be performed) | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.transfer Exception* | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.password* | Password for authenticated access | "guest" | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.ssl Protocol* | Enables SSL on connection, accepted value are true, TLS and 'SSLv3 | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.rabbitmq.trust Manager* | Configure SSL trust manager, SSL should be enabled for this option to be effective | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.rabbitmq.username* | Username in case of authenticated access | "guest" | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
