2 Home
gitea_admin edited this page 2026-03-11 14:39:40 +00:00

IronMQ

Send and receive messages to/from IronMQ an elastic and durable hosted message queue as a service.

Metadata

Property Value
Scheme ironmq
Support Level Stable
Labels cloud,messaging
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-ironmq</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
queueName string The name of the IronMQ queue
ironMQCloud string https://mq-aws-us-east-1-1.iron.io IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU)
preserveHeaders boolean false Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer.
projectId string IronMQ projectId
batchDelete boolean false Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one per exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges.
concurrentConsumers integer 1 The number of concurrent consumers.
maxMessagesPerPoll integer 1 Number of messages to poll per call. Maximum is 100.
sendEmptyMessageWhenIdle boolean false If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
timeout integer 60 After timeout (in seconds), item will be placed back onto the queue.
wait integer Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30.
bridgeErrorHandler boolean false 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.
exceptionHandler object 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.
exchangePattern object Sets the exchange pattern when the consumer creates an exchange.
pollStrategy object A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
visibilityDelay integer The item will not be available on the queue until this many seconds have passed. Default is 0 seconds.
lazyStartProducer boolean false 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.
client object Reference to a io.iron.ironmq.Client in the Registry.
backoffErrorThreshold integer The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold integer The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier integer To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
delay integer 500 Milliseconds before the next poll.
greedy boolean false If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay integer 1000 Milliseconds before the first poll starts.
repeatCount integer 0 Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
runLoggingLevel object TRACE The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService object Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
scheduler object none To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
schedulerProperties object To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
startScheduler boolean true Whether the scheduler should be auto started.
timeUnit object MILLISECONDS Time unit for initialDelay and delay options.
useFixedDelay boolean true Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
token string IronMQ token