306.2. 组件选项和配置
Simple JMS Batch 组件支持 5 个选项,如下所列。
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
ConnectionFactory (advanced) | 需要 ConnectionFactory 才能启用 SjmsBatchComponent。 | ConnectionFactory | |
asyncStartListener (advanced) | 在启动路由时,是否异步启动消费者消息监听程序。例如,如果 JmsConsumer 无法连接到远程 JMS 代理,则在重试和/或故障转移时可能会阻止。这将导致 Camel 在启动路由时阻止。通过将此选项设置为 true,您将让路由启动,而 JmsConsumer 以异步模式使用专用线程连接到 JMS 代理。如果使用这个选项,请注意,如果无法建立连接,那么会记录异常在 WARN 级别,消费者将无法接收消息;然后您可以重启路由来重试。 | false | 布尔值 |
recoveryInterval (advanced) | 指定恢复尝试之间的间隔,例如当连接被刷新时,以毫秒为单位。默认值为 5000 ms,即 5 秒。 | 5000 | int |
headerFilterStrategy (filter) | 使用自定义 org.apache.camel.spi.HeaderFilterStrategy 过滤到 Camel 消息的标头。 | HeaderFilterStrategy | |
resolveProperty Placeholders (advanced) | 组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。 | true | 布尔值 |
Simple JMS Batch 端点使用 URI 语法进行配置:
sjms-batch:destinationName
使用以下路径和查询参数:
306.2.1. 路径参数(1 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
destinationName | 必需 目的地名称。仅支持队列,名称可能以 'queue:' 前缀。 | 字符串 |
306.2.2. 查询参数(23 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
aggregationStrategy (consumer) | 必需 使用的聚合策略,它会将所有批处理的消息合并到单个消息中 | AggregationStrategy | |
allowNullBody (consumer) | 是否允许发送没有正文的消息。如果此选项为 false,并且消息正文为 null,则抛出 JMSException。 | true | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
completionInterval (consumer) | millis 中的完成间隔,每个间隔都会以固定率完成批处理。如果触发超时并且批处理中没有消息,则批处理可能为空。请注意,您不能同时使用完成超时和完成间隔,只能配置一个。 | 1000 | int |
completionPredicate (consumer) | completion predicate,当 predicate 评估为 true 时,它会导致批处理完成。predicate 也可以使用字符串语法简单的语言进行配置。您可能希望将 eagerCheckCompletion 选项设为 true,以便 predicate 与传入消息匹配,否则它与聚合消息匹配。 | 字符串 | |
completionSize (consumer) | 批处理要完成的消息数量 | 200 | int |
completionTimeout (consumer) | 当批处理完成后,第一个消息被接收后的 millis 中超时。如果触发超时并且批处理中没有消息,则批处理可能为空。请注意,您不能同时使用完成超时和完成间隔,只能配置一个。 | 500 | int |
consumerCount (consumer) | 要从其中使用的 JMS 会话数量 | 1 | int |
eagerCheckCompletion (consumer) | 使用 eager 完成检查,这意味着 completionPredicate 将使用传入的交换。在不强制完成检查 completionPredicate 的情况下,将使用聚合的交换。 | false | 布尔值 |
includeAllJMSXProperties (consumer) | 从 JMS 映射到 Camel 消息时,是否要包含所有 JMSXxxx 属性。把它设置为 true 将包括 JMSXAppID 和 JMSXUserID 等属性。注: 如果您使用自定义 headerFilterStrategy,则不会应用这个选项。 | false | 布尔值 |
mapJmsMessage (consumer) | 指定 Camel 是否应该自动将收到的 JMS 消息映射到合适的有效负载类型,如 javax.jms.TextMessage 到 String 等。如需了解更多详细信息,请参阅映射如何工作。 | true | 布尔值 |
pollDuration (consumer) | 每个轮询消息的持续时间(毫秒)。如果消息比较短且批处理已启动,则将使用 completionTimeOut。 | 1000 | int |
sendEmptyMessageWhenIdle (consumer) | 如果使用完成超时或间隔,则在触发超时且没有批处理中没有消息时,批处理可能为空。如果此选项为 true,并且批处理为空,则将向批处理添加一个空消息,以便路由空消息。 | false | 布尔值 |
ExceptionHandler ( consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 在消费者创建交换时设置交换模式。 | ExchangePattern | |
asyncStartListener (advanced) | 在启动路由时,是否异步启动消费者消息监听程序。例如,如果 JmsConsumer 无法连接到远程 JMS 代理,则在重试和/或故障转移时可能会阻止。这将导致 Camel 在启动路由时阻止。通过将此选项设置为 true,您将让路由启动,而 JmsConsumer 以异步模式使用专用线程连接到 JMS 代理。如果使用这个选项,请注意,如果无法建立连接,那么会记录异常在 WARN 级别,消费者将无法接收消息;然后您可以重启路由来重试。 | false | 布尔值 |
headerFilterStrategy (advanced) | 使用自定义 HeaderFilterStrategy 过滤到 Camel 消息的标头。 | HeaderFilterStrategy | |
jmsKeyFormatStrategy (advanced) | 可插拔编码和解码 JMS 密钥策略,以便它们能够与 JMS 规范兼容。Camel 提供了两个开箱即用的实现:default 和 passthrough。默认策略可以安全地放入点和连字符(. 和 -)。passthrough 策略将密钥保留原样。可用于 JMS 代理,其不小心是 JMS 标头键是否包含非法字符。您可以提供自己的 org.apache.camel.component.jms.JmsKeyFormatStrategy 的实现,并使用 # 表示法引用它。 | JmsKeyFormatStrategy | |
keepAliveDelay (advanced) | 尝试重新建立有效会话之间的延迟。如果这是一个正值,SjmsBatchConsumer 将尝试创建新会话,如果它在消息消耗期间看到 IllegalStateException。此延迟值允许您在尝试防止垃圾日志之间暂停。如果这是一个负值(默认为 -1),则 SjmsBatchConsumer 将像在之前一样的行为,而如果看到 IllegalStateException,则路由将关闭。 | -1 | int |
messageCreatedStrategy (advanced) | 要使用给定的 MessageCreatedStrategy,后者在 Camel 在 Camel 发送 JMS 消息时创建 javax.jms.Message 对象的新实例。 | MessageCreatedStrategy | |
recoveryInterval (advanced) | 指定恢复尝试之间的间隔,例如当连接被刷新时,以毫秒为单位。默认值为 5000 ms,即 5 秒。 | 5000 | int |
同步 (高级) | 设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。 | false | 布尔值 |
timeoutCheckerExecutor Service (advanced) | 如果使用 completionInterval 选项,则会创建一个后台线程来触发完成间隔。设置这个选项,以提供要使用的自定义线程池,而不是为每个消费者创建新线程。 | ScheduledExecutor Service |