RocketMQ

Send and receive messages from RocketMQ cluster.

What’s inside

RocketMQ component, URI syntax: rocketmq:topicName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-rocketmq-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 21 options, which are listed below.

Name	Description	Default	Type
camel.component.rocketmq.access-channel	Access channel of RocketMQ cluster. LOCAL or CLOUD, LOCAL by default	LOCAL	String
camel.component.rocketmq.access-key	Access key for RocketMQ ACL.		String
camel.component.rocketmq.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.rocketmq.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.rocketmq.consumer-group	Consumer group name.		String
camel.component.rocketmq.enable-trace	Whether to enable trace.	false	Boolean
camel.component.rocketmq.enabled	Whether to enable auto configuration of the rocketmq component. This is enabled by default.		Boolean
camel.component.rocketmq.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.rocketmq.message-selector-type	Message Selector Type, TAG or SQL TAG by default	tag	String
camel.component.rocketmq.namespace	Namespace of RocketMQ cluster. You need to specify this if you are using serverless version of RocketMQ.		String
camel.component.rocketmq.namesrv-addr	Name server address of RocketMQ cluster.	localhost:9876	String
camel.component.rocketmq.producer-group	Producer group name.		String
camel.component.rocketmq.reply-to-consumer-group	Consumer group name used for receiving response.		String
camel.component.rocketmq.reply-to-topic	Topic used for receiving response when using in-out pattern.		String
camel.component.rocketmq.request-timeout-checker-interval-millis	Check interval milliseconds of request timeout.	1000	Long
camel.component.rocketmq.request-timeout-millis	Timeout milliseconds of receiving response when using in-out pattern.	10000	Long
camel.component.rocketmq.secret-key	Secret key for RocketMQ ACL.		String
camel.component.rocketmq.send-tag	Each message would be sent with this tag.		String
camel.component.rocketmq.subscribe-sql	Subscribe SQL of consumer. See https://rocketmq.apache.org/docs/featureBehavior/07messagefilter/#attribute-based-sql-filtering for more details.	1 = 1	String
camel.component.rocketmq.subscribe-tags	Subscribe tags of consumer. Multiple tags could be split by , such as TagATagB	*	String
camel.component.rocketmq.wait-for-send-result	Whether waiting for send result before routing to next endpoint.	false	Boolean

Name

Description

Default

Type

camel.component.rocketmq.access-channel

Access channel of RocketMQ cluster. LOCAL or CLOUD, LOCAL by default

LOCAL

String

camel.component.rocketmq.access-key

Access key for RocketMQ ACL.

String

camel.component.rocketmq.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.rocketmq.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.rocketmq.consumer-group

Consumer group name.

String

camel.component.rocketmq.enable-trace

Whether to enable trace.

false

Boolean

camel.component.rocketmq.enabled

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

Boolean

camel.component.rocketmq.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.rocketmq.message-selector-type

Message Selector Type, TAG or SQL TAG by default

tag

String

camel.component.rocketmq.namespace

Namespace of RocketMQ cluster. You need to specify this if you are using serverless version of RocketMQ.

String

camel.component.rocketmq.namesrv-addr

Name server address of RocketMQ cluster.

localhost:9876

String

camel.component.rocketmq.producer-group

Producer group name.

String

camel.component.rocketmq.reply-to-consumer-group

Consumer group name used for receiving response.

String

camel.component.rocketmq.reply-to-topic

Topic used for receiving response when using in-out pattern.

String

camel.component.rocketmq.request-timeout-checker-interval-millis

Check interval milliseconds of request timeout.

1000

Long

camel.component.rocketmq.request-timeout-millis

Timeout milliseconds of receiving response when using in-out pattern.

10000

Long

camel.component.rocketmq.secret-key

Secret key for RocketMQ ACL.

String

camel.component.rocketmq.send-tag

Each message would be sent with this tag.

String

camel.component.rocketmq.subscribe-sql

Subscribe SQL of consumer. See https://rocketmq.apache.org/docs/featureBehavior/07messagefilter/#attribute-based-sql-filtering for more details.

1 = 1

String

camel.component.rocketmq.subscribe-tags

Subscribe tags of consumer. Multiple tags could be split by , such as TagATagB

String

camel.component.rocketmq.wait-for-send-result

Whether waiting for send result before routing to next endpoint.

false

Boolean