308.2. コンポーネントのオプションと設定
Simple JMS2 コンポーネントは、以下に示す 15 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
connectionFactory (advanced) | SjmsComponent を有効にするには、ConnectionFactory が必要です。直接設定することも、ConnectionResource の一部として設定することもできます。 | ConnectionFactory | |
connectionResource (advanced) | ConnectionResource は、ConnectionFactory のカスタマイズとコンテナー制御を可能にするインターフェイスです。詳細については、プラグ可能な接続リソースの管理を参照してください。 | ConnectionResource | |
connectionCount (common) | このコンポーネントで開始されたエンドポイントで使用可能な接続の最大数。 | 1 | Integer |
jmsKeyFormatStrategy (advanced) | JMS 仕様に準拠できるように、JMS キーをエンコードおよびデコードするためのプラグ可能な戦略。Camel はすぐに使用できる 1 つの実装を提供します: デフォルトです。デフォルトのストラテジーでは、ドットとハイフン(. および -)を安全にマーシャリングします。JMS ヘッダーキーに不正な文字が含まれているかどうかは問題にならない JMS ブローカーに使用できます。org.apache.camel.component.jms.JmsKeyFormatStrategy の独自の実装を提供し、# 表記を使用して参照できます。 | JmsKeyFormatStrategy | |
transactionCommit Strategy (transaction) | 使用するコミットストラテジーの種類を設定する場合。Camel は、追加設定なしで、default と batch の 2 つの実装を提供します。 | TransactionCommit ストラテジー | |
destinationCreation Strategy (advanced) | カスタム DestinationCreationStrategy を使用する場合。 | DestinationCreation Strategy | |
timedTaskManager (advanced) | カスタム TimedTaskManager を使用する場合。 | TimedTaskManager | |
messageCreatedStrategy (advanced) | Camel が JMS メッセージを送信しているときに、Camel が javax.jms.Message オブジェクトの新しいインスタンスを作成するときに呼び出される、指定された MessageCreatedStrategy を使用します。 | MessageCreatedStrategy | |
connectionTestOnBorrow (advanced) | デフォルトの org.apache.camel.component.sjms.jms.ConnectionFactoryResource を使用する場合、プールから返される前に各 javax.jms.Connection をテストする (start を呼び出す) 必要があります。 | true | boolean |
connectionUsername (security) | デフォルトの org.apache.camel.component.sjms.jms.ConnectionFactoryResource を使用するときに javax.jms.Connection を作成するときに使用するユーザー名。 | String | |
connectionPassword (security) | デフォルトの org.apache.camel.component.sjms.jms.ConnectionFactoryResource を使用するときに javax.jms.Connection を作成するときに使用するパスワード。 | String | |
connectionClientId (advanced) | デフォルトの org.apache.camel.component.sjms.jms.ConnectionFactoryResource を使用するときに javax.jms.Connection を作成するときに使用するクライアント ID。 | String | |
connectionMaxWait (advanced) | デフォルトの org.apache.camel.component.sjms.jms.ConnectionFactoryResource を使用する場合に、プールが使い果たされたときにブロックして空き接続を待機する最大待機時間 (ミリ単位)。 | 5000 | long |
headerFilterStrategy (filter) | カスタムの org.apache.camel.spi.HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルターします。 | HeaderFilterStrategy | |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
Simple JMS2 エンドポイントは、URI 構文を使用して設定されます。
sjms2:destinationType:destinationName
パスおよびクエリーパラメーターを使用します。
308.2.1. パスパラメーター (2 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
destinationType | 使用する宛先の種類 | queue | String |
destinationName | 必須 DestinationName は、JMS キューまたはトピック名です。デフォルトでは、destinationName はキュー名として解釈されます。 | String |
308.2.2. クエリーパラメーター(37 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
acknowledgementMode (common) | JMS 確認応答名。SESSION_TRANSACTED、CLIENT_ACKNOWLEDGE、AUTO_ACKNOWLEDGE、DUPS_OK_ACKNOWLEDGE のいずれかです。 | AUTO_ ACKNOWLEDGE | SessionAcknowledgement タイプ |
bridgeErrorHandler (consumer) | consumer の Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、consumer が受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
consumerCount (consumer) | このエンドポイントに使用されるコンシューマーリスナーの数を設定します。 | 1 | int |
durable (consumer) | トピックコンシューマーを永続に設定します。 | false | boolean |
durableSubscriptionId (consumer) | 永続トピックに必要な永続サブスクリプション ID を設定します。 | String | |
shared (consumer) | コンシューマーを共有に設定します。 | false | boolean |
subscriptionId (consumer) | 永続トピックまたは共有トピックに必要なサブスクリプション ID を設定します。 | String | |
synchronous (consumer) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | true | boolean |
exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
messageSelector (consumer) | JMS メッセージセレクターの構文を設定します。 | String | |
namedReplyTo (producer) | InOut プロデューサエンドポイントに使用される宛先名への返信を設定します。 | String | |
persistent (producer) | メッセージの永続性を有効/無効にするために使用されるフラグ。 | true | boolean |
producerCount (producer) | このエンドポイントに使用されるプロデューサーの数を設定します。 | 1 | int |
ttl (producer) | 生成されたメッセージの Time To Live 値を調整するために使用されるフラグ。 | -1 | long |
allowNullBody (producer) | ボディーのないメッセージの送信を許可するかどうか。このオプションが false でメッセージボディーが null の場合は、JMSException が出力されます。 | true | boolean |
prefillPool (producer) | 起動時にプロデューサ接続プールを事前に埋めるか、必要に応じて遅延接続を作成するか。 | true | boolean |
responseTimeOut (producer) | InOut 応答がタイムアウトするまでの待機時間を設定します。 | 5000 | long |
asyncStartListener (advanced) | ルートの開始時に consumer メッセージリスナーを非同期で開始するかどうか。たとえば、JmsConsumer がリモート JMS ブローカーへの接続を取得できない場合は、再試行中やフェイルオーバー中にブロックされる可能性があります。これにより、ルートの開始時に Camel がブロックされます。このオプションを true に設定すると、ルートの起動を許可します。一方、JmsConsumer は非同期モードで専用のスレッドを使用して JMS ブローカーに接続します。このオプションを使用する場合は、接続を確立できない場合は例外が WARN レベルでログに記録され、consumer はメッセージを受信できず、ルートを再起動して再試行できます。 | false | boolean |
asyncStopListener (advanced) | ルートを停止するときに、consumer メッセージリスナーを非同期的に停止するかどうか。 | false | boolean |
connectionCount (advanced) | このエンドポイントで利用可能な接続の最大数。 | Integer | |
connectionFactory (advanced) | エンドポイントの connectionFactory を初期化します。これは、コンポーネントの connectionFactory よりも優先されます (存在する場合)。 | ConnectionFactory | |
connectionResource (advanced) | エンドポイントの connectionResource を初期化します。これは、コンポーネントの connectionResource よりも優先されます (存在する場合)。 | ConnectionResource | |
destinationCreationStrategy (advanced) | カスタム DestinationCreationStrategy を使用する場合。 | DestinationCreation Strategy | |
exceptionListener (advanced) | 基礎となる JMS 例外の通知を受ける JMS 例外リスナーを指定します。 | ExceptionListener | |
headerFilterStrategy (advanced) | カスタムの HeaderFilterStrategy を使用して、Camel メッセージとの間でヘッダーをフィルタリングします。 | HeaderFilterStrategy | |
includeAllJMSXProperties (advanced) | JMS から Camel Message へのマッピング時に JMSXxxx プロパティーをすべて含めるかどうか。これを true に設定すると、JMSXAppID や JMSXUserID などのプロパティーが含まれます。注記: カスタムの headerFilterStrategy を使用している場合、このオプションは適用されません。 | false | boolean |
jmsKeyFormatStrategy (advanced) | JMS 仕様に準拠できるように、JMS キーをエンコードおよびデコードするためのプラグ可能なストラテジー。Camel は、デフォルトとパススルーの 2 つの実装をそのまま提供します。デフォルトのストラテジーでは、ドットとハイフン(. および -)を安全にマーシャリングします。パススルー戦略では、キーはそのまま残ります。JMS ヘッダーキーに不正な文字が含まれているかどうかは問題にならない JMS ブローカーに使用できます。org.apache.camel.component.jms.JmsKeyFormatStrategy の独自の実装を提供し、# 表記を使用して参照できます。 | JmsKeyFormatStrategy | |
mapJmsMessage (advanced) | Camel が受信した JMS メッセージを適切なペイロードタイプ (javax.jms.TextMessage を文字列など) に自動マップするかどうかを指定します。詳細については、以下のマッピングの仕組みに関するセクションを参照してください。 | true | boolean |
messageCreatedStrategy (advanced) | Camel が JMS メッセージを送信しているときに、Camel が javax.jms.Message オブジェクトの新しいインスタンスを作成するときに呼び出される、指定された MessageCreatedStrategy を使用します。 | MessageCreatedStrategy | |
errorHandlerLoggingLevel (logging) | キャッチされていない例外をログに記録するためのデフォルトの errorHandler ログレベルを設定できます。 | WARN | LoggingLevel |
errorHandlerLogStackTrace (logging) | デフォルトの errorHandler でスタックトレースをログに記録するかどうかを制御できます。 | true | boolean |
transacted (transaction) | トランザクションモードを使用するかどうかを指定します | false | boolean |
transactionBatchCount (transaction) | If transactioned は、トランザクションをコミットする前に処理するメッセージの数を設定します。 | -1 | int |
transactionBatchTimeout (transaction) | バッチトランザクションのタイムアウト (ミリ秒単位) を設定します。値は 1000 以上である必要があります。 | 5000 | long |
transactionCommitStrategy (transaction) | コミット戦略を設定します。 | TransactionCommit ストラテジー | |
sharedJMSSession (transaction) | JMS セッションを他の SJMS エンドポイントと共有するかどうかを指定します。ルートが複数の JMS プロバイダーにアクセスしている場合は、これをオフにします。複数の JMS プロバイダーに対するトランザクションが必要な場合は、jms コンポーネントを使用して XA トランザクションを利用します。 | true | boolean |