MQTT Connector 1.0 リファレンス

MQTT 用 Anypoint Connector (MQTT Connector) は、MQTT (Message Queuing Telemetry Transport) v3.x プロトコル準拠の MuleSoft 拡張機能です。MQTT は、小さなコードのフットプリントと最小のネットワーク帯域幅を使用してリモートデバイスを接続することを目的として設計された軽量のパブリッシュ/サブスクライブメッセージングプロトコルです。現在、MQTT は、自動車、製造、電気通信、石油ガスなど、さまざまな業種で使用されています。

このコネクタは MQTT メッセージをコンシュームおよび生成し、メッセージの保持、LWT メッセージ、永続的なセッションを含めすべての l MQTT v3.x 機能をサポートします。

設定

デフォルト設定。

パラメーター

名前	型	説明	必須
Name (名前)	String (文字列)	この設定の名前。コネクタはこの名前の設定を参照します。	x
Connection (接続)	MQTT 3 URL Connection (MQTT 3 URL 接続) MQTT 3 Fail-Over Connection (MQTT 3 フェールオーバー接続) MQTT 3 Form Connection (MQTT 3 フォーム接続)	この設定の接続種別。	x
Name (名前)	String (文字列)	他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。	x
Expiration Policy (有効期限ポリシー)	Expiration Policy (有効期限ポリシー)	設定の有効期限ポリシーを設定します。

名前

型

説明

デフォルト値

必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

Connection (接続)

MQTT 3 URL Connection (MQTT 3 URL 接続)
MQTT 3 Fail-Over Connection (MQTT 3 フェールオーバー接続)
MQTT 3 Form Connection (MQTT 3 フォーム接続)

この設定の接続種別。

Name (名前)

String (文字列)

他のコンポーネント内のこの要素を参照するために使用するこの要素の識別子。

Expiration Policy (有効期限ポリシー)

設定の有効期限ポリシーを設定します。

接続種別

MQTT 3 URL Connection (MQTT 3 URL 接続)

MQTT 接続を作成するキャッシュされた接続プロバイダー。ブローカーの接続 URL を指定できます。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Client ID Generator (クライアント ID ジェネレーター)	次のいずれかになります。 Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター) Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)	MQTT ブローカーへの接続を識別するためのクライアント ID を生成するクライアント ID ジェネレーター。		x
Username (ユーザー名)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのユーザー名。
Password (パスワード)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのパスワード。
URL	String (文字列)	接続先のブローカーを表す URL。
TLS Context	TLS
Topic (トピック)	String (文字列)	LWTmessage をパブリッシュするためのトピック。
Body (本文)	String (文字列)	LWTmessage のコンテンツ。
QoS	Enumeration (列挙)。次のいずれかになります。 AT_MOST_ONCE AT_LEAST_ONCE EXACTLY_ONCE	LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。	AT_LEAST_ONCE
Is Retained (保持)	Boolean (ブール)	`true` に設定されている場合、ブローカーで LWTmessage を保持します。	`false`
Connection Timeout (接続タイムアウト)	Number (数値)	ソケット接続タイムアウト値。この属性は、`timeoutUnit` と連携して機能します。複数のフェールオーバー URL が指定されている場合、タイムアウトは各 URL に個別に適用されます。	30
Timeout Unit (タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	[Connection Timeout (接続タイムアウト)] 項目の時間単位。	SECONDS (秒)
Keep Alive Interval (キープアライブ間隔)	Number (数値)	クライアントとブローカー間でメッセージの交換がないまま接続を存続できる時間。キープアライブ間隔が 0 の場合、キープアライブメカニズムは無効になります。	0
Keep Alive Interval Unit (キープアライブ間隔単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	`keepAliveInterval` パラメーターに対応する時間単位。デフォルトは SECONDS (秒) です。	SECONDS (秒)
Max In Flight (最大インフライト)	Number (数値)	任意の時点で肯定応答されていない状態で存在できるメッセージの最大数。パラメーターを `0` に設定した場合、無制限のインフライトメッセージが存在できます。	10
Clean Session (セッションをクリーンアップ)	Boolean (ブール)	`true` に設定されている場合、クライアントがブローカーから切断されるたびにセッションがクリーンアップされます。サブスクリプションは保存されず、そのクライアントのオフライン (QoS 1 および 2) メッセージは失われます。	`true`
Enable File Persistence (ファイル永続性を有効化)	Boolean (ブール)	`true` に設定されている場合、ファイルベースの永続的なデータストアが作成されます。このデータストアはインフライト中のアウトバウンドメッセージとインバウンドメッセージを保存するために使用され、指定された QoS への配信を可能にします。	`false`
Data Store Path (データストアのパス)	String (文字列)	`enableFilePersistence` が `true` に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。`true` に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。。

Client ID Generator (クライアント ID ジェネレーター)

次のいずれかになります。

Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター)
Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)

MQTT ブローカーへの接続を識別するためのクライアント ID を生成するクライアント ID ジェネレーター。

Username (ユーザー名)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのユーザー名。

Password (パスワード)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのパスワード。

URL

String (文字列)

接続先のブローカーを表す URL。

TLS Context

TLS

Topic (トピック)

String (文字列)

LWTmessage をパブリッシュするためのトピック。

Body (本文)

String (文字列)

LWTmessage のコンテンツ。

QoS

Enumeration (列挙)。次のいずれかになります。

AT_MOST_ONCE
AT_LEAST_ONCE
EXACTLY_ONCE

LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。

AT_LEAST_ONCE

Is Retained (保持)

Boolean (ブール)

true に設定されている場合、ブローカーで LWTmessage を保持します。

false

Connection Timeout (接続タイムアウト)

Number (数値)

ソケット接続タイムアウト値。この属性は、timeoutUnit と連携して機能します。複数のフェールオーバー URL が指定されている場合、タイムアウトは各 URL に個別に適用されます。

Timeout Unit (タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Connection Timeout (接続タイムアウト)] 項目の時間単位。

SECONDS (秒)

Keep Alive Interval (キープアライブ間隔)

Number (数値)

クライアントとブローカー間でメッセージの交換がないまま接続を存続できる時間。キープアライブ間隔が 0 の場合、キープアライブメカニズムは無効になります。

Keep Alive Interval Unit (キープアライブ間隔単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

keepAliveInterval パラメーターに対応する時間単位。デフォルトは SECONDS (秒) です。

SECONDS (秒)

Max In Flight (最大インフライト)

Number (数値)

任意の時点で肯定応答されていない状態で存在できるメッセージの最大数。パラメーターを 0 に設定した場合、無制限のインフライトメッセージが存在できます。

Clean Session (セッションをクリーンアップ)

Boolean (ブール)

true に設定されている場合、クライアントがブローカーから切断されるたびにセッションがクリーンアップされます。サブスクリプションは保存されず、そのクライアントのオフライン (QoS 1 および 2) メッセージは失われます。

true

Enable File Persistence (ファイル永続性を有効化)

Boolean (ブール)

true に設定されている場合、ファイルベースの永続的なデータストアが作成されます。このデータストアはインフライト中のアウトバウンドメッセージとインバウンドメッセージを保存するために使用され、指定された QoS への配信を可能にします。

false

Data Store Path (データストアのパス)

String (文字列)

enableFilePersistence が true に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。。

MQTT 3 Fail-Over Connection (MQTT 3 フェールオーバー接続)

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Client ID Generator (クライアント ID ジェネレーター)	次のいずれかになります。 * Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター) * Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)	MQTT ブローカーへの接続を識別するためのクライアント ID を生成する ClientIDGenerator。		x
Username (ユーザー名)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのユーザー名。
Password (パスワード)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのパスワード。
Fail Over Servers (フェールオーバーサーバー)	Fail Over URL (フェールオーバー URL) の配列	ブローカーへの接続を確立するために使用するサーバー URL のリスト。		x
TLS Context	TLS
Topic (トピック)	String (文字列)	LWTmessage をパブリッシュするためのトピック。
Body (本文)	String (文字列)	LWTmessage のコンテンツ。
QoS	Enumeration (列挙)。次のいずれかになります。 AT_MOST_ONCE AT_LEAST_ONCE EXACTLY_ONCE	LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。	AT_LEAST_ONCE
Is Retained (保持)	Boolean (ブール)	`true` に設定されている場合、ブローカーで LWTmessage を保持します。	`false`
Connection Timeout (接続タイムアウト)	Number (数値)	ソケット接続タイムアウト値。この属性は、`timeoutUnit` と連携して機能します。複数のフェールオーバー URL が指定されている場合、タイムアウトは各 URL に個別に適用されます。	30
Timeout Unit (タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	[Connection Timeout (接続タイムアウト)] 項目の時間単位。デフォルトは SECONDS (秒) です。	SECONDS (秒)
Keep Alive Interval (キープアライブ間隔)	Number (数値)	クライアントとブローカー間でメッセージの交換がないまま接続を存続できる時間。キープアライブ間隔が `0` の場合、キープアライブメカニズムは無効になります。	0
Keep Alive Interval Unit (キープアライブ間隔単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	`keepAliveInterval` パラメーターに対応する時間単位。デフォルトは SECONDS (秒) です。	SECONDS (秒)
Max In Flight (最大インフライト)	Number (数値)	任意の時点で肯定応答されていない状態で存在できるメッセージの最大数。パラメーターを `0` に設定した場合、無制限のインフライトメッセージが存在できます。	10
Clean Session (セッションをクリーンアップ)	Boolean (ブール)	`true` に設定されている場合、クライアントがブローカーから切断されるたびにセッションがクリーンアップされます。サブスクリプションは保存されず、そのクライアントのオフライン (QoS 1 および 2) メッセージは失われます。	`true`
Enable File Persistence (ファイル永続性を有効化)	Boolean (ブール)	`true` に設定されている場合、ファイルベースの永続的なデータストアが作成されます。このデータストアはインフライト中のアウトバウンドメッセージとインバウンドメッセージを保存するために使用され、指定された QoS への配信を可能にします。	`false`
Data Store Path (データストアのパス)	String (文字列)	`enableFilePersistence` が `true` に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。`true` に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。。

Client ID Generator (クライアント ID ジェネレーター)

次のいずれかになります。 * Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター) * Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)

MQTT ブローカーへの接続を識別するためのクライアント ID を生成する ClientIDGenerator。

Username (ユーザー名)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのユーザー名。

Password (パスワード)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのパスワード。

Fail Over Servers (フェールオーバーサーバー)

Fail Over URL (フェールオーバー URL) の配列

ブローカーへの接続を確立するために使用するサーバー URL のリスト。

TLS Context

TLS

Topic (トピック)

String (文字列)

LWTmessage をパブリッシュするためのトピック。

Body (本文)

String (文字列)

LWTmessage のコンテンツ。

QoS

Enumeration (列挙)。次のいずれかになります。

AT_MOST_ONCE
AT_LEAST_ONCE
EXACTLY_ONCE

LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。

AT_LEAST_ONCE

Is Retained (保持)

Boolean (ブール)

true に設定されている場合、ブローカーで LWTmessage を保持します。

false

Connection Timeout (接続タイムアウト)

Number (数値)

Timeout Unit (タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Connection Timeout (接続タイムアウト)] 項目の時間単位。デフォルトは SECONDS (秒) です。

SECONDS (秒)

Keep Alive Interval (キープアライブ間隔)

Number (数値)

クライアントとブローカー間でメッセージの交換がないまま接続を存続できる時間。キープアライブ間隔が 0 の場合、キープアライブメカニズムは無効になります。

Keep Alive Interval Unit (キープアライブ間隔単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

keepAliveInterval パラメーターに対応する時間単位。デフォルトは SECONDS (秒) です。

SECONDS (秒)

Max In Flight (最大インフライト)

Number (数値)

Clean Session (セッションをクリーンアップ)

Boolean (ブール)

true

Enable File Persistence (ファイル永続性を有効化)

Boolean (ブール)

false

Data Store Path (データストアのパス)

String (文字列)

enableFilePersistence が true に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。

Reconnection (再接続)

MQTT 3 Form Connection (MQTT 3 フォーム接続)

MQTT 接続を作成するキャッシュされた接続プロバイダー。ブローカーへの接続を確立するためのプロトコル、ホスト、およびポートを指定できます。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Client ID Generator (クライアント ID ジェネレーター)	次のいずれかになります。 * Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター) * Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)	MQTT ブローカーへの接続を識別するためのクライアント ID を生成するクライアント ID ジェネレーター。		x
Username (ユーザー名)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのユーザー名。
Password (パスワード)	String (文字列)	MQTT ブローカーへのログイン情報を認証するためのパスワード。
Protocol (プロトコル)	Enumeration (列挙)。次のいずれかになります。 TCP WS WSS SSL LOCAL	ブローカーへの接続時に使用するトランスポートレベルのプロトコル。	TCP
URL	String (文字列)	接続先のブローカーのホスト。		x
Port (ポート)	String (文字列)	接続先のブローカーのポート	1883
TLS Context	TLS
Topic (トピック)	String (文字列)	LWTmessage をパブリッシュするためのトピック。
Body (本文)	String (文字列)	LWTmessage のコンテンツ。
QoS	Enumeration (列挙)。次のいずれかになります。 AT_MOST_ONCE AT_LEAST_ONCE EXACTLY_ONCE	LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。	AT_LEAST_ONCE
Is Retained (保持)	Boolean (ブール)	`true` に設定されている場合、ブローカーで LWTmessage を保持します。	`false`
Connection Timeout (接続タイムアウト)	Number (数値)	ソケット接続タイムアウト値。この属性は、`timeoutUnit` と連携して機能します。複数のフェールオーバー URL が指定されている場合、タイムアウトは各 URL に個別に適用されます。	30
Timeout Unit (タイムアウト単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	[Connection Timeout (接続タイムアウト)] 項目の時間単位。デフォルトは SECONDS (秒) です。	SECONDS (秒)
Keep Alive Interval (キープアライブ間隔)	Number (数値)	クライアントとブローカー間でメッセージの交換がないまま接続を存続できる時間。キープアライブ間隔が `0` の場合、キープアライブメカニズムは無効になります。	0
Keep Alive Interval Unit (キープアライブ間隔単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	`keepAliveInterval` パラメーターに対応する時間単位。	SECONDS (秒)
Max In Flight (最大インフライト)	Number (数値)	任意の時点で肯定応答されていない状態で存在できるメッセージの最大数。パラメーターを `0` に設定した場合、無制限のインフライトメッセージが存在できます。	10
Clean Session (セッションをクリーンアップ)	Boolean (ブール)	`true` に設定されている場合、クライアントがブローカーから切断されるたびにセッションがクリーンアップされます。サブスクリプションは保存されず、そのクライアントのオフライン (QoS 1 および 2) メッセージは失われます。	`true`
Enable File Persistence (ファイル永続性を有効化)	Boolean (ブール)	`true` に設定されている場合、ファイルベースの永続的なデータストアが作成されます。このデータストアはインフライト中のアウトバウンドメッセージとインバウンドメッセージを保存するために使用され、指定された QoS への配信を可能にします。	`false`
Data Store Path (データストアのパス)	String (文字列)	`enableFilePersistence` が `true` に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。
Reconnection (再接続)	Reconnection (再接続)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。`true` に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。。

Client ID Generator (クライアント ID ジェネレーター)

MQTT ブローカーへの接続を識別するためのクライアント ID を生成するクライアント ID ジェネレーター。

Username (ユーザー名)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのユーザー名。

Password (パスワード)

String (文字列)

MQTT ブローカーへのログイン情報を認証するためのパスワード。

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

TCP
WS
WSS
SSL
LOCAL

ブローカーへの接続時に使用するトランスポートレベルのプロトコル。

TCP

URL

String (文字列)

接続先のブローカーのホスト。

Port (ポート)

String (文字列)

接続先のブローカーのポート

1883

TLS Context

TLS

Topic (トピック)

String (文字列)

LWTmessage をパブリッシュするためのトピック。

Body (本文)

String (文字列)

LWTmessage のコンテンツ。

QoS

Enumeration (列挙)。次のいずれかになります。

AT_MOST_ONCE
AT_LEAST_ONCE
EXACTLY_ONCE

LWTmessage のパブリッシュで使用するサービス品質 (QoS)。デフォルトは AT_LEAST_ONCE です。

AT_LEAST_ONCE

Is Retained (保持)

Boolean (ブール)

true に設定されている場合、ブローカーで LWTmessage を保持します。

false

Connection Timeout (接続タイムアウト)

Number (数値)

Timeout Unit (タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Connection Timeout (接続タイムアウト)] 項目の時間単位。デフォルトは SECONDS (秒) です。

SECONDS (秒)

Keep Alive Interval (キープアライブ間隔)

Number (数値)

Keep Alive Interval Unit (キープアライブ間隔単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

keepAliveInterval パラメーターに対応する時間単位。

SECONDS (秒)

Max In Flight (最大インフライト)

Number (数値)

Clean Session (セッションをクリーンアップ)

Boolean (ブール)

true

Enable File Persistence (ファイル永続性を有効化)

Boolean (ブール)

false

Data Store Path (データストアのパス)

String (文字列)

enableFilePersistence が true に設定されている場合、ファイルベースの永続的なデータストアが作成されるディレクトリ。

Reconnection (再接続)

操作

Publish

<mqtt3:publish>

単一の MQTT 3 メッセージを任意のエクスチェンジにパブリッシュできるようにする操作。

パラメーター

名前型説明デフォルト値必須

名前	型	説明	デフォルト値	必須
Configuration (設定)	String (文字列)	使用する設定の名前。		x
Topic (トピック)	String (文字列)	メッセージのパブリッシュ先のトピック。		x
Message (メッセージ)	Any (任意)	パブリッシュするメッセージのコンテンツ。	#[payload]
QoS	Enumeration (列挙)。次のいずれかになります。 AT_MOST_ONCE AT_LEAST_ONCE EXACTLY_ONCE	メッセージのパブリッシュで使用するサービス品質 (QoS)。	AT_LEAST_ONCE
Is Retained (保持)	Boolean (ブール)	ブローカーでメッセージを保持するかどうか。	`false`
Config Ref (設定参照)	ConfigurationProvider	コンポーネントを実行するための設定の名前。		x
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

Configuration (設定)

String (文字列)

使用する設定の名前。

Topic (トピック)

String (文字列)

メッセージのパブリッシュ先のトピック。

Message (メッセージ)

Any (任意)

パブリッシュするメッセージのコンテンツ。

#[payload]

QoS

Enumeration (列挙)。次のいずれかになります。

AT_MOST_ONCE
AT_LEAST_ONCE
EXACTLY_ONCE

メッセージのパブリッシュで使用するサービス品質 (QoS)。

AT_LEAST_ONCE

Is Retained (保持)

Boolean (ブール)

ブローカーでメッセージを保持するかどうか。

false

Config Ref (設定参照)

ConfigurationProvider

コンポーネントを実行するための設定の名前。

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

設定

スロー

MQTT3:CONNECTIVITY

メッセージのパブリッシュ中にクライアントがブローカーから切断されました。
MQTT3:INVALID_TOPIC

トピックが無効です。たとえば、名前が短すぎるか、名前が長すぎるか、名前に無効な文字が含まれます。
MQTT3:PERSISTENCE

メッセージのパブリッシュ時に、信頼性の高いメッセージング用の永続的なデータの読み取りまたは書き込み中にエラーが発生しました。
MQTT3:PUBLISH

メッセージのパブリッシュ中にエラーが発生しました。
MQTT3:RETRY_EXHAUSTED

すべての再接続の試行に失敗しました。
MQTT3:WRITE_TIMEOUT

サーバーへのメッセージの書き込みを待機している間にクライアントがタイムアウトしてエラーが発生しました。

ソース

新規メッセージ

<mqtt3:listener>

1 つ以上のトピック検索条件に対応する新しい受信メッセージをリスンするソース。各トピック検索条件には特定の QoS が設定されています。

パラメーター

名前	型	説明	必須
Configuration (設定)	String (文字列)	使用する設定の名前。	x
Topics	Topic (トピック) の配列	リスナーでサブスクライブするトピックのリスト。	x
Config Ref (設定参照)	ConfigurationProvider	コンポーネントを実行するための設定の名前。	x
Primary Node Only (プライマリノードのみ)	Boolean (ブール)	クラスターでの Mule インスタンスの実行時、ソースをプライマリノード上でのみ実行するかどうかを決定します。
Redelivery Policy (再配信ポリシー)	Redelivery Policy (再配信ポリシー)	同じメッセージの再配信を処理するためのポリシーを定義します。
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	接続エラーが発生した場合の再試行戦略。

名前

型

説明

デフォルト値

必須

Configuration (設定)

String (文字列)

使用する設定の名前。

Topics

Topic (トピック) の配列

リスナーでサブスクライブするトピックのリスト。

Config Ref (設定参照)

ConfigurationProvider

コンポーネントを実行するための設定の名前。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの Mule インスタンスの実行時、ソースをプライマリノード上でのみ実行するかどうかを決定します。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシーを定義します。

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型

Any (任意)

Attributes Type (属性型)

MQTT 3 メッセージ属性

次の設定の場合

設定

型

TLS

Mule アプリケーションのセキュアな通信を提供するように TLS を設定します。

項目

型

説明

デフォルト値

必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

トラストストア

Key Store (キーストア)

Revocation Check (取り消し確認)

Standard Revocation Check (標準の取り消し確認)
Custom OCSP Responder (カスタム OCSP レスポンダー)
CRL File (CRL ファイル)

トラストストア

TLS 用のトラストストアを設定します。

項目型説明デフォルト値必須

項目	型	説明
Path (パス)	String (文字列)	トラストストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。
Password (パスワード)	String (文字列)	トラストストアを保護するために使用するパスワード。
Type (型)	String (文字列)	トラストストアの型。
Algorithm (アルゴリズム)	String (文字列)	トラストストアで使用する暗号化アルゴリズム。
Insecure (安全ではない)	Boolean (ブール)	`true` の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Path (パス)

String (文字列)

トラストストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

トラストストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用する暗号化アルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

TLS プロトコル用のキーストアを設定します。生成したキーストアには、非公開キーと公開証明書が格納されます。

項目	型	説明
Path (パス)	String (文字列)	キーストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。
Type (型)	String (文字列)	キーストアの型。
Alias (別名)	String (文字列)	キーストアに複数の非公開キーが含まれている場合に使用するキーの別名。デフォルトでは、Mule はファイル内の最初のキーを使用します。
Key Password (キーパスワード)	String (文字列)	非公開キーを保護するために使用するパスワード。
Password (パスワード)	String (文字列)	キーストアを保護するために使用するパスワード。
Algorithm (アルゴリズム)	String (文字列)	キーストアで使用する暗号化アルゴリズム。

項目

型

説明

デフォルト値

必須

Path (パス)

String (文字列)

キーストアへのパス。Mule では、可能であれば、現在のクラスパスとファイルシステムへの相対的なパスを解決します。

Type (型)

String (文字列)

キーストアの型。

Alias (別名)

String (文字列)

キーストアに複数の非公開キーが含まれている場合に使用するキーの別名。デフォルトでは、Mule はファイル内の最初のキーを使用します。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用する暗号化アルゴリズム。

Standard Revocation Check (標準の取り消し確認)

TLS 証明書の標準取り消し確認を設定します。

項目	型	説明
Only End Entities (最後のエンティティのみ)	Boolean (ブール)	証明書チェーンの最後の要素のみを確認します。
Prefer Crls (CRL を優先)	Boolean (ブール)	最初に OCSP ではなく CRL を試みます。
No Fallback (代替なし)	Boolean (ブール)	第 2 の確認方法 ([Prefer Crls (CRL を優先)] 項目で指定されていない方法) を使用しません。
Soft Fail (ソフトフェール)	Boolean (ブール)	取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

項目

型

説明

デフォルト値

必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 ([Prefer Crls (CRL を優先)] 項目で指定されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

証明書の取り消し確認のカスタム OCSP レスポンダーを設定します。

項目	型	説明	デフォルト値	必須
Url	String (文字列)	OCSP レスポンダーの URL。
Cert Alias (証明書の別名)	String (文字列)	OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアに存在する必要があります。

項目

型

説明

デフォルト値

必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

OCSP 応答の署名証明書の別名。指定した場合、別名はトラストストアに存在する必要があります。

CRL File (CRL ファイル)

証明書失効リスト (CRL) ファイルの場所を指定します。

項目	型	説明	デフォルト値	必須
Path (パス)	String (文字列)	CRL ファイルへのパス。

項目

型

説明

デフォルト値

必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

操作の再接続戦略を設定します。

項目型説明デフォルト値必須

項目	型	説明	デフォルト値	必須
Fails Deployment (デプロイに失敗)	Boolean (ブール)	アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。`true` に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。
Reconnection Strategy (再接続戦略)	Reconnect (再接続) Reconnect Forever (繰り返し再接続)	使用する再接続戦略。

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

Reconnect (再接続)
Reconnect Forever (繰り返し再接続)

使用する再接続戦略。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

項目型説明デフォルト値必須

項目	型	説明
Frequency (頻度)	Number (数値)	再接続する頻度 (ミリ秒)。
Blocking (ブロック)	Boolean (ブール)	`false` の場合、再接続戦略が個別の非ブロックスレッドで実行されます。
Count (数)	Number (数値)	再接続の試行回数。

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

繰り返し再接続戦略を設定します。この戦略では、Mule アプリケーションが実行されている限り、コネクタ操作のソースまたは操作で、指定した頻度で再接続を試行します。

項目型説明デフォルト値必須

項目	型	説明	デフォルト値	必須
Frequency (頻度)	Number (数値)	再接続を試行する頻度 (ミリ秒)。
Blocking (ブロック)	Boolean (ブール)	`false` の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Fail Over URL (フェールオーバー URL)

項目	型	説明	デフォルト値
Protocol (プロトコル)	Enumeration (列挙)。次のいずれかになります。 TCP WS WSS SSL LOCAL	ブローカーへの接続時に使用するトランスポートレベルのプロトコル。	TCP
Host (ホスト)	String (文字列)	接続先のブローカーのホスト。	localhost
Port (ポート)	String (文字列)	接続先のブローカーのポート。	1883

項目

型

説明

デフォルト値

必須

Protocol (プロトコル)

Enumeration (列挙)。次のいずれかになります。

TCP
WS
WSS
SSL
LOCAL

ブローカーへの接続時に使用するトランスポートレベルのプロトコル。

TCP

Host (ホスト)

String (文字列)

接続先のブローカーのホスト。

localhost

Port (ポート)

String (文字列)

接続先のブローカーのポート。

1883

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

項目	型	説明	デフォルト値	必須
Max Idle Time (最大アイドル時間)	Number (数値)	有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。
Time Unit (時間単位)	Enumeration (列挙)。次のいずれかになります。 NANOSECONDS (ナノ秒) MICROSECONDS (マイクロ秒) MILLISECONDS (ミリ秒) SECONDS (秒) MINUTES (分) HOURS (時間) DAYS (日)	[Max Idle Time (最大アイドル時間)] 項目の時間単位。

項目

型

説明

デフォルト値

必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

NANOSECONDS (ナノ秒)
MICROSECONDS (マイクロ秒)
MILLISECONDS (ミリ秒)
SECONDS (秒)
MINUTES (分)
HOURS (時間)
DAYS (日)

[Max Idle Time (最大アイドル時間)] 項目の時間単位。

MQTT 3 メッセージ属性

項目型説明デフォルト値必須

項目	型	説明	デフォルト値	必須
Topic (トピック)	String (文字列)	ブローカーで転送されたメッセージの転送先のトピック。		x
Message Id (メッセージ ID)	Number (数値)	ブローカーから受信したメッセージを識別する MQTT ID。		x
QoS	Number (数値)	ブローカーにより配信されたメッセージのサービス品質。		x
Is Duplicate (重複)	Boolean (ブール)	`true` に設定されている場合、メッセージは別の受信済みメッセージと重複することができます。	`false`
Is Retained (保持)	Boolean (ブール)	`true` に設定されている場合、メッセージは現在のパブリッシャーから送信されたか、トピックに対してパブリッシュされた最後のメッセージとしてサーバーにより保持されました。	`false`

Topic (トピック)

String (文字列)

ブローカーで転送されたメッセージの転送先のトピック。

Message Id (メッセージ ID)

Number (数値)

ブローカーから受信したメッセージを識別する MQTT ID。

QoS

Number (数値)

ブローカーにより配信されたメッセージのサービス品質。

Is Duplicate (重複)

Boolean (ブール)

true に設定されている場合、メッセージは別の受信済みメッセージと重複することができます。

false

Is Retained (保持)

Boolean (ブール)

true に設定されている場合、メッセージは現在のパブリッシャーから送信されたか、トピックに対してパブリッシュされた最後のメッセージとしてサーバーにより保持されました。

false

Topic (トピック)

項目	型	説明	デフォルト値	必須
Topic Filter (トピック検索条件)	String (文字列)	トピックの単一レベルまたはマルチレベルのサブスクリプションを表すトピック検索条件。		x
QoS	Enumeration (列挙)。次のいずれかになります。 AT_MOST_ONCE AT_LEAST_ONCE EXACTLY_ONCE	ブローカーはこのサービス品質 (QoS) で、トピックの [Topic filter (トピック検索条件)] 項目に向けられたメッセージを送信する必要があります。	AT_LEAST_ONCE

項目

型

説明

デフォルト値

必須

Topic Filter (トピック検索条件)

String (文字列)

トピックの単一レベルまたはマルチレベルのサブスクリプションを表すトピック検索条件。

QoS

Enumeration (列挙)。次のいずれかになります。

AT_MOST_ONCE
AT_LEAST_ONCE
EXACTLY_ONCE

ブローカーはこのサービス品質 (QoS) で、トピックの [Topic filter (トピック検索条件)] 項目に向けられたメッセージを送信する必要があります。

AT_LEAST_ONCE

Redelivery Policy (再配信ポリシー)

エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。

項目型説明デフォルト値必須

項目	型	説明
Max Redelivery Count (最大再配信数)	Number (数値)	REDELIVERY_EXHAUSTED エラーが返されるまでに、配信された要求が処理に失敗できる最大回数。
Message Digest Algorithm (メッセージダイジェストアルゴリズム)	String (文字列)	[Use Secure Hash (セキュアハッシュを使用)] 項目が `true` の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの `hashCode()` が返した値が返されます。
Message Identifier (メッセージ識別子)	Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)	メッセージを識別するための戦略を定義します。
Object Store (オブジェクトストア)	ObjectStore	各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。

Max Redelivery Count (最大再配信数)

Number (数値)

REDELIVERY_EXHAUSTED エラーが返されるまでに、配信された要求が処理に失敗できる最大回数。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

[Use Secure Hash (セキュアハッシュを使用)] 項目が true の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの hashCode() が返した値が返されます。

Message Identifier (メッセージ識別子)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

メッセージを識別するための戦略を定義します。

Object Store (オブジェクトストア)

ObjectStore

各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

再配信されたメッセージを識別する方法と、メッセージがいつ再配信されたのかを見つける方法を設定します。

項目型説明デフォルト値必須

項目	型	説明	デフォルト値	必須
Use Secure Hash (セキュアハッシュを使用)	Boolean (ブール)	`true` の場合、Mule では再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用します。
Id Expression (ID 式)	String (文字列)	メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、[Use Secure Hash (セキュアハッシュを使用)] 項目が `false` の場合にのみ設定できます。

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

true の場合、Mule では再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用します。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、[Use Secure Hash (セキュアハッシュを使用)] 項目が false の場合にのみ設定できます。

Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター)

項目	型	説明	デフォルト値	必須
Client Id (クライアント ID)	String (文字列)	MQTT ブローカーへの接続を識別するためのクライアント ID。

項目

型

説明

デフォルト値

必須

Client Id (クライアント ID)

String (文字列)

MQTT ブローカーへの接続を識別するためのクライアント ID。

Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)

項目	型	説明	デフォルト値	必須
Client Id (クライアント ID)	String (文字列)	MQTT ブローカーへの接続を識別するためのクライアント ID。
Custom Client Id Suffix (カスタムクライアント ID サフィックス)	String (文字列)	MQTT ブローカーへの接続を識別するために使用するカスタムクライアント ID サフィックス。

項目

型

説明

デフォルト値

必須

Client Id (クライアント ID)

String (文字列)

MQTT ブローカーへの接続を識別するためのクライアント ID。

Custom Client Id Suffix (カスタムクライアント ID サフィックス)

String (文字列)

MQTT ブローカーへの接続を識別するために使用するカスタムクライアント ID サフィックス。

MQTT Connector 1.0 リファレンス

設定

設定

パラメーター

接続種別

MQTT 3 URL Connection (MQTT 3 URL 接続)

パラメーター

MQTT 3 Fail-Over Connection (MQTT 3 フェールオーバー接続)

パラメーター

MQTT 3 Form Connection (MQTT 3 フォーム接続)

パラメーター

関連操作

関連付けられたソース

操作

Publish

パラメーター

次の設定の場合

スロー

ソース

新規メッセージ

パラメーター

出力

次の設定の場合

型

TLS

トラストストア

Key Store (キーストア)

Standard Revocation Check (標準の取り消し確認)

Custom OCSP Responder (カスタム OCSP レスポンダー)

CRL File (CRL ファイル)

Reconnection (再接続)

Reconnect (再接続)

Reconnect Forever (繰り返し再接続)

Fail Over URL (フェールオーバー URL)

Expiration Policy (有効期限ポリシー)

MQTT 3 メッセージ属性

Topic (トピック)

Redelivery Policy (再配信ポリシー)

Redelivery Policy Message Identifier (再配信ポリシーメッセージ識別子)

Client ID Random Suffix Generator (クライアント ID ランダムサフィックスジェネレーター)

Client ID Custom Expression Generator (クライアント ID カスタム式ジェネレーター)

関連情報