Anypoint Studio を使用した SFTP Connector の設定 - Mule 4

Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。

Studio でコネクタを追加および設定する手順は、次のとおりです。

「アプリケーションログの表示」​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。

Studio で初めてコネクタを設定する場合は、​「Anypoint Studio を使用したコネクタの設定」​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​「SFTP Connector リファレンス」​を参照してください。

Mule プロジェクトを作成する

Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。

  1. Studio で、​[File (ファイル)] > [New (新規)] > [Mule Project (Mule プロジェクト)]​ を選択します。

  2. Mule プロジェクトの名前を入力して、​[Finish (完了)]​ をクリックします。

コネクタを Mule プロジェクトに追加する

SFTP Connector を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​pom.xml​ ファイルに必須の連動関係を追加します。

  1. [Mule Palette (Mule パレット)]​ ビューで、​[(X) Search in Exchange ((X) Exchange 内を検索)]​ をクリックします。

  2. [Add Dependencies to Project (連動関係をプロジェクトに追加)]​ ウィンドウで、検索項目に「​sftp​」と入力します。

  3. [Available modules (使用可能なモジュール)]​ で ​[SFTP Connector]​ をクリックします。

  4. [Add (追加)]​ をクリックします。

  5. [Finish (完了)]​ をクリックします。

Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。

ソースの設定

ソースは、指定された条件が満たされたときにフローを開始します。 次の入力元のいずれかを設定して、SFTP Connector で使用できます。

  • On New or Updated File
    ディレクトリをポーリングして、作成または更新されたファイルがないかどうかを確認してフローを開始し、見つかった各ファイルのメッセージを生成します。

  • HTTP Listener
    設定されたホストとポートで要求を受信するたびにフローを開始します。

  • Scheduler
    時間ベースの条件が満たされたときにフローを開始します。

たとえば、On New or Updated File ソースを設定する手順は、次のとおりです。

  1. [Mule Palette (Mule パレット)]​ ビューで、​[On New or Updated File]​ を選択します。

  2. [On New or Updated File]​ 操作を Studio キャンバスにドラッグします。

  3. [On New or Updated File]​ 設定画面で、必要に応じて ​[Display Name (表示名)]​ 項目の値を変更します。

  4. [Path (パス)]​ 項目の値を指定します。

  5. [Connector configuration (コネクタ設定)]​ 項目の横にあるプラス記号 (​+​) をクリックして、アプリケーション内の ​On New or Updated File​ のすべてのインスタンスで使用できるグローバル要素を設定します。

  6. [General (一般)]​ タブで、コネクタの接続情報を指定します。

  7. [Host (ホスト)]​ 項目を設定して、SFTP サーバーホスト (​localhost​ や ​192.168.0.1​ など) を指定します。

  8. [Test Connection (接続をテスト)]​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。

  9. [OK]​ をクリックします。

  10. [On New or Updated File]​ 設定画面で、​[Scheduling Strategy (スケジュール戦略)]​ 値を指定し、必要に応じてその他の項目を入力します。

フローにコネクタの操作を追加する

フローにコネクタの操作を追加すると、そのコネクタで実行する特定の操作をすぐに定義できます。

SFTP Connector の操作を追加するには、次の手順に従います。

  1. [Mule Palette (Mule パレット)]​ ビューで ​[SFTP]​ を選択し、目的の操作を選択します。

  2. その操作を Studio キャンバスのソースの右にドラッグします。

次のスクリーンショットは、Anypoint Studio の [Mule Palette (Mule パレット)] ビューの SFTP Connector の操作を示しています。

SFTP Connector の操作
Figure 1. SFTP Connector の操作

コネクタのグローバル要素を設定する

コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定することをお勧めします。グローバル要素を設定するには、SFTP サーバー接続を設定する必要があります。

SFTP Connector のグローバル要素を設定する手順は、次のとおりです。

  1. Studio キャンバスでコネクタの名前を選択します。

  2. Studio キャンバスで操作を選択します。

  3. 操作の設定画面で、​[Connector configuration (コネクタ設定)]​ 項目の横にあるプラス記号 (​+​) をクリックし、グローバル要素設定項目にアクセスします。

  4. [General (一般)]​ タブで、コネクタの接続情報を指定します。

  5. EdDSA のサポートが必要な場合は、​[Required Libraries (必要なライブラリ)]​ 項目で ​[Configure (設定)]​ をクリックして EdDSA 連動関係を指定してください。

  6. [Working Directory (作業ディレクトリ)]​ をこのコネクタで使用するすべての相対パスのルートとして設定します。
    指定しない場合、デフォルト値はリモートサーバーになります。

  7. [Host (ホスト)]​ 項目を設定して、SFTP サーバーホスト (​localhost​ や ​192.168.0.1​ など) を指定します。

  8. [Advanced (詳細)]​ タブで、必要に応じてタイムアウト設定と再接続戦略を指定します。

  9. [Test Connection (接続をテスト)]​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。

  10. [OK]​ をクリックします。

次のスクリーンショットは、Anypoint Studio の SFTP Connector の ​[Global Element Configuration (グローバル要素設定)]​ ウィンドウを示しています。

SFTP Connector の [Global Element Configuration (グローバル要素設定)]
Figure 2. SFTP Connector の [Global Element Configuration (グローバル要素設定)]

XML エディターでは、設定 ​sftp:config​ は次のように記述されます。

<sftp:config name="sftp">
  <sftp:connection username="anonymous" password="password"
    host="localhost" port="${sftpPort}"
    workingDir="${workingDir}"/>
</sftp:config>

アプリケーションログの表示

問題を確認するため、アプリケーションログを次の方法で表示できます。

  • アプリケーションを Anypoint Platform から実行している場合、出力は Anypoint Studio のコンソールウィンドウに表示される。

  • コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログは OS コンソールに表示される。

アプリケーションのログファイル (​log4j2.xml​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​MULE_HOME/logs/<app-name>.log​ でアプリケーションログを表示することもできます。