231.2. オプション
MQTT コンポーネントは、以下に示す 4 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
host (common) | 接続する MQTT ブローカーの URI - このコンポーネントは SSL もサポートしています - 例: ssl://127.0.0.1:8883 | String | |
userName (security) | MQTT ブローカーに対する認証に使用されるユーザー名 | String | |
password (security) | MQTT ブローカーに対する認証に使用されるパスワード | String | |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
MQTT エンドポイントは、URI 構文を使用して設定されます。
mqtt:name
パスおよびクエリーパラメーターを使用します。
231.2.1. パスパラメーター (1 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
name | 必須 トピック名ではない、使用する論理名。 | String |
231.2.2. クエリーパラメーター (39 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
blockingExecutor (common) | SSL 接続は、setBlockingExecutor メソッドを呼び出して代わりに使用するエグゼキューターを設定しない限り、内部スレッドプールに対してブロック操作を実行します。 | エグゼキューター (Executor) | |
byDefaultRetain (common) | MQTT ブローカーに送信されるメッセージで使用されるデフォルトの保持ポリシー | false | boolean |
cleanSession (common) | MQTT サーバーがクライアントセッション間でトピックサブスクリプションと ACK 位置を保持するようにする場合は、false に設定します。デフォルトは true です。 | false | boolean |
clientId (common) | セッションのクライアント ID を設定するために使用します。これは、MQTT サーバーが setCleanSession(false); のセッションを識別するために使用するものです。使用されています。ID は 23 文字以下にする必要があります。デフォルトは、自動生成された ID (ソケットアドレス、ポート、およびタイムスタンプに基づく) です。 | String | |
connectAttemptsMax (common) | クライアントがサーバーへの最初の接続試行時にエラーがクライアントに報告されるまでの再接続試行の最大回数。無制限の試行を使用するには、-1 に設定します。デフォルトは -1 です。 | -1 | long |
connectWaitInSeconds (common) | MQTT ブローカーへの接続が確立されるまでコンポーネントが待機する遅延 (秒単位) | 10 | int |
disconnectWaitInSeconds (common) | コンポーネントが MQTT ブローカーからの stop () での有効な切断を待機する秒数 | 5 | int |
dispatchQueue (common) | HawtDispatch ディスパッチキューは、接続へのアクセスを同期するために使用されます。setDispatchQueue メソッドを使用して明示的なキューが設定されていない場合、接続用に新しいキューが作成されます。複数の接続で Synchronization のために同じキューを共有する場合は、明示的なキューを設定すると便利です。 | DispatchQueue | |
host (common) | 接続する MQTT ブローカーの URI - このコンポーネントは SSL もサポートしています - 例: ssl://127.0.0.1:8883 | tcp://127.0.0.1:1883 | URI |
keepAlive (common) | キープアライブタイマーを秒単位で設定します。クライアントから受信するメッセージ間の最大時間間隔を定義します。これにより、サーバーは長い TCP/IP タイムアウトを待たずに、クライアントへのネットワーク接続が切断されたことを検出できます。 | short | |
localAddress (common) | 使用するローカル InetAddress とポート | URI | |
maxReadRate (common) | このトランスポートがデータを受信する 1 秒あたりの最大バイト数を設定します。この設定は、レートを超えないように読み取りを調整します。デフォルトは 0 で、スロットリングを無効にします。 | int | |
maxWriteRate (common) | このトランスポートがデータを送信する 1 秒あたりの最大バイト数を設定します。この設定は、レートを超えないように書き込みを抑制します。デフォルトは 0 で、スロットリングを無効にします。 | int | |
mqttQosPropertyName (common) | 公開された個々のメッセージを Exchange で検索するプロパティー名。これが設定されている場合 (AtMostOnce、AtLeastOnce または ExactlyOnce のいずれか) - MQTT メッセージブローカーに送信されるメッセージにその QoS が設定されます。 | MQTTQos | String |
mqttRetainPropertyName (common) | 公開された個々のメッセージを Exchange で検索するプロパティー名。これが設定されている場合 (ブール値が必要) - MQTT メッセージブローカーに送信されるメッセージに保持プロパティーが設定されます。 | MQTTRetain | String |
mqttTopicPropertyName (common) | これらのプロパティは、Exchange - に公開するために探されるものです。 | MQTTTopicPropertyName | String |
publishTopicName (common) | メッセージを公開するデフォルトのトピック | camel/mqtt/test | String |
qualityOfService (common) | トピックに使用するサービス品質レベル。 | AtLeastOnce | String |
receiveBufferSize (common) | 内部ソケット受信バッファーのサイズを設定します。デフォルトは 65536 (64k) | 65536 | int |
reconnectAttemptsMax (common) | サーバー接続が以前に確立された後、エラーがクライアントに報告されるまでの再接続の最大試行回数。無制限の試行を使用するには、-1 に設定します。デフォルトは -1 です。 | -1 | long |
reconnectBackOffMultiplier (common) | 再接続試行の間に指数バックオフが使用されます。指数バックオフを無効にするには、1 に設定します。デフォルトは 2 です。 | 2.0 | double |
reconnectDelay (common) | 最初の再接続試行までの待機時間 (ミリ秒)。デフォルトは 10 です。 | 10 | long |
reconnectDelayMax (common) | 次の再接続試行までの最大待機時間 (ミリ秒)。デフォルトは 30,000 です。 | 30000 | long |
sendBufferSize (common) | 内部ソケット送信バッファーのサイズを設定します。デフォルトは 65536 (64k) | 65536 | int |
sendWaitInSeconds (common) | 例外を出力する前に、MQTT ブローカからの受信がパブリッシュされたメッセージを確認するのをコンポーネントが待機する最大時間 | 5 | int |
sslContext (common) | SSLContext 設定を使用してセキュリティーを設定するには | SSLContext | |
subscribeTopicName (common) | 非推奨 これらはエンドポイントに設定され、MQTT から継承されたプロパティと合わせて使用されます。 | String | |
subscribeTopicNames (common) | メッセージをサブスクライブするトピックのコンマ区切りリスト。このリストの各項目には、階層内の特定のパターンに一致するトピックをサブスクライブするために、MQTT ワイルドカード (および/または #) を含めることができることに注意してください。たとえば、は階層内のあるレベルのすべてのトピックのワイルドカードであるため、ブローカーにトピック topic/one と topic/two がある場合、topics/を使用して両方をサブスクライブできます。ここで考慮すべき注意点は、ブローカーがトピック/3 を追加すると、ルートもそのトピックからのメッセージの受信を開始することです。 | String | |
trafficClass (common) | トランスポートから送信されるパケットの IP ヘッダーにトラフィッククラスまたはタイプオブサービスオクテットを設定します。デフォルトは 8 で、スループットのためにトラフィックを最適化する必要があることを意味します。 | 8 | int |
version (common) | MQTT バージョン 3.1.1 を使用するには、3.1.1 に設定します。それ以外の場合は、デフォルトで 3.1 プロトコルバージョンになります。 | 3.1 | String |
willMessage (common) | 送信する Will メッセージ。デフォルトは長さゼロのメッセージです。 | String | |
willQos (common) | Will メッセージに使用するサービスの品質を設定します。デフォルトは AT_MOST_ONCE です。 | AtMostOnce | QoS |
willRetain (common) | Will を保持オプション付きで公開する場合は、true に設定します。 | QoS | |
willTopic (common) | 設定されている場合、サーバーは、クライアントに予期しない切断が発生した場合に、クライアントの Will メッセージを指定されたトピックに公開します。 | String | |
bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer) | コンシューマーがエクスチェンジを作成する際に交換パターンを設定します。 | ExchangePattern | |
lazySessionCreation (producer) | Camel プロデューサーの起動時にリモートサーバーが稼働していない場合は、例外を回避するためにセッションを遅延作成できます。 | true | boolean |
synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |