# mulesoft File Connector - Full Documentation # Anypoint Code Builder を使用した File Connector の設定 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ## [](#creating-integration-project)新しいインテグレーションプロジェクトの作成 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ## [](#adding-connector)インテグレーションプロジェクトへのコネクタの追加 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ## [](#configuring-trigger)フローのトリガーの設定 トリガー (ソース) は、指定された条件が満たされたときにフローを開始します。 次のトリガーのいずれかを File Connector で使用するように設定できます。 - **On New or Updated File** 新規作成または変更されたファイルに対してフローをトリガーする - **\[HTTP\] > \[Listener\]**​ 設定されたホストとポートで要求を受信するたびにフローを開始する - **Scheduler**​ 時間ベースの条件が満たされたときにフローを開始する 詳細は、[anypoint-code-builder::acb-component-scheduler.adoc](https://docs.mulesoft.com/jp/anypoint-code-builder/acb-component-scheduler)を参照してください。 たとえば、​**On New or Updated**​ トリガーを設定する手順は、次のとおりです。 1. **\[On New or Updated\]**​ 操作をキャンバスの UI に追加します。 2. キャンバス UI で ​**\[On New or Updated\]**​ 操作をクリックします。 3. **\[General (一般)\]**​ タブで、次の属性を設定します。
属性 説明 必須

Directory (ディレクトリ)

ポーリングされたファイルが配置されるディレクトリ。

いいえ

Recursive (再帰)

選択した場合、サブディレクトリに含まれるファイルを使用します。

いいえ

Matcher (マッチャー)

マッチャーの条件を満たさないファイルに対するイベントを絞り込むために使用するマッチャー。

いいえ

Watermark mode (ウォーターマークモード)

選択した場合、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。

次のオプションがあります。

  • DISABLED

  • MODIFIED_TIMESTAMP​

  • CREATED_TIMESTAMP

いいえ

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)]​ の単位。

いいえ

Scheduling strategy (スケジュール戦略)

時間ベースの条件に基づいてフローの実行をトリガーします。この項目は現在設定 UI で有効になっていません。XML エディターで設定してください。​XML でのスケジュール戦略の設定​ を参照してください。

はい

後処理アクション​

Auto delete (自動削除)

選択した場合、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが新規ファイルとみなされます。

いいえ

Move to directory (ディレクトリに移動)

処理された各ファイルの送信先となるディレクトリパス。ファイルを削除しない場合、これは ​[Auto delete (自動削除)]​ の代替アクションになります。

いいえ

Rename to (変更後の名前)

ファイルが移動したときにファイルの名前をこの値に変更します。この属性は、​[Move To Directory (ディレクトリに移動)]​ と連携して機能します。この項目を設定しない場合、元のファイル名が保持されます。

いいえ

Apply post action when failed (失敗した場合に事後アクションを適用)

選択した場合、ファイル処理の失敗時にいずれかの事後アクション (​[Auto delete (自動削除)]​ および ​[Move to directory (ディレクトリに移動)]​) を適用します。このオプションを選択解除した場合、失敗したファイルは移動も削除もされません。

いいえ

Overwrite (上書き)

宛先ファイルの名前が同じ場合に対象ファイルを上書きします。

いいえ

## [](#adding-components-to-project)プロジェクトへのコンポーネントの追加 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ## [](#add-global-config)グローバル設定の追加 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ## [](#configuring-component-attributes)コンポーネント属性の設定 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$configure-acb-connectors-partial.adoc\[\] ### [](#copy-操作の設定)Copy 操作の設定 **Copy**​ 操作では、​**\[Source Path (ソースパス)\]**​ で指定されたファイルまたはディレクトリを ​**\[Target Path (対象パス)\]**​ にコピーします。ソースパスには、ファイルまたはディレクトリを指定できます。​**\[Source Path (ソースパス)\]**​ がディレクトリを参照している場合、ディレクトリは再帰的にコピーされます。 1. キャンバス UI で ​**Copy**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] 2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] ### [](#create-directory-操作の設定)Create Directory 操作の設定 **Create Directory**​ 操作では、指定された ​**\[Directory path (ディレクトリパス)\]**​ にディレクトリを作成します。 1. キャンバス UI で ​**Create Directory**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

Directory path (ディレクトリパス)

新しいディレクトリのパス名 (例: ~/newFolder​)。

はい

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] ### [](#delete-操作の設定)Delete 操作の設定 **Delete**​ 操作では、ファイルがロックされていない場合、​**\[Directory path (ディレクトリパス)\]**​ で指定されたファイルを削除します。この操作では、ディレクトリを削除しません。 1. キャンバス UI で ​**Delete**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

Directory path (ディレクトリパス)

削除するファイルへのパス。

はい

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] ### [](#list-操作の設定)List 操作の設定 **List**​ 操作を使用して、指定された ​**\[Directory path (ディレクトリパス)\]**​ にあるすべてのファイルのリストを作成します。 1. キャンバス UI で ​**List**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

Directory path (ディレクトリパス)

リストするファイルを含むディレクトリへのパス。

はい

Recursive (再帰)

選択した場合、サブディレクトリのコンテンツも出力にリストされます。

いいえ

File Matching Rules (ファイル一致ルール)

ファイルの受け入れまたは却下で使用する一致条件に基づいて、ファイルを絞り込みます。ファイル一致ルールの例は、​「一致条件でのファイルの絞り込み」​を参照してください。

いいえ

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。
属性 説明 必須

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)]​ の単位。

いいえ

Subset (サブセット)

返されるファイルの数の制限と並び替えを行います。

いいえ

Streaming strategy (ストリーミング戦略)

Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。​XML でのストリーミング戦略の設定​ を参照してください。

いいえ

Target Variable (対象変数)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

いいえ

エラーのマッピング

Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。

いいえ

Reconnection strategy (再接続戦略)

Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。​「Reconnect (再接続)」​、​「Reconnect Forever (繰り返し再接続)」​、および​XML での再接続戦略の設定​を参照してください。

いいえ

### [](#move-操作の設定)Move 操作の設定 **Move**​ 操作では、ファイルまたはディレクトリを ​**\[Source path (ソースパス)\]**​ から ​**\[Target Path (対象パス)\]**​ に移動します。​**\[Source path (ソースパス)\]**​ がディレクトリを参照している場合、ディレクトリは再帰的に移動します。 1. キャンバス UI で ​**Move**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] 2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] ### [](#read-操作の設定)Read 操作の設定 **Read**​ 操作では、指定されたパスにあるファイルのコンテンツとメタデータを読み取り、ファイルのコンテンツが含まれる入力ストリームをペイロードとするメッセージを返します。メタデータは、メッセージ属性 (​`Message#getAttributes()`​) として表される ​`LocalFileAttributes`​ オブジェクトとして表されます。 ファイルの MIME タイプはファイルの拡張子に基づきます。省略可能な ​**\[Output MIME type (出力 MIME タイプ)\]**​ および ​**\[Output encoding (出力エンコード)\]**​ パラメーターを使用して、出力エンコードと MIME タイプを強制することができます。 1. キャンバス UI で ​**Read**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

File Path (ファイルパス)

読み取るファイルへのパス。

はい

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。
属性 説明 必須

Lock (ロック)

選択した場合、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックはホストのファイルシステムにより提供されるため、その動作は、マウントされたドライブと、Mule Runtime が実行されているオペレーティングシステムに応じて変わる可能性があります。

いいえ

Time between size check (サイズ確認の時間間隔)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。Mule Runtime は 2 回のサイズ確認を実行し、コールから次のコールまでの指定された時間を待機します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

いいえ

Time between size check unit (サイズ確認の時間間隔の単位)

[Time between size check (サイズ確認の時間間隔)]​ の単位。

いいえ

Output MIME type (出力 MIME タイプ)

この操作で出力されるペイロードの MIME タイプ。

いいえ

パラメーター

[Output MIME type (出力 MIME タイプ)]​ 属性の値に追加する 1 つ以上のキー-値ペア。複数のキーと値のペアが許可されます。これらのキー-値ペアを使用すると、データを変数に保存できるため、フロー内の任意のコンポーネントでそのデータを使用できます。

いいえ

Output encoding (出力エンコード)

このコンポーネントで出力されるペイロードのエンコード。

いいえ

Streaming Strategy (ストリーミング戦略)

Mule アプリケーションでのデータストリームのコンシューム方法を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。​XML でのストリーミング戦略の設定​ を参照してください。

いいえ

Target Variable (対象変数)

操作の出力が配置される変数の名前。

いいえ

Target Value (対象値)

操作の出力に対して評価される式。この式の結果は対象変数に保存されます。

いいえ

エラーのマッピング

Mule エラー種別をマップするカスタムエラー種別を作成します。マッピングは、アプリケーションのエラーをさらに識別してグループ化するのに役立つ場合があります。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。Mule Errorsを参照してください。

いいえ

Reconnection strategy (再接続戦略)

Mule アプリケーション内の操作が外部サーバーへの接続に失敗すると、デフォルト動作ではその操作は直ちに失敗し、接続エラーが返されます。デフォルト動作を変更するには、操作の再接続戦略を設定します。この属性は現在設定 UI で有効になっていません。XML エディターで設定してください。​「Reconnect (再接続)」​、​「Reconnect Forever (繰り返し再接続)」​、および​XML での再接続戦略の設定​を参照してください。

いいえ

### [](#rename-操作の設定)Rename 操作の設定 **Rename**​ 操作では、​**\[Path (パス)\]**​ 項目で指定されたファイルの名前が ​`to`​ パラメーターで指定された名前に変更されます。​`to`​ パラメーターにパスセパレーターが含まれている場合、​`FILE:ILLEGAL_PATH`​ がスローされます。 1. キャンバス UI で ​**Rename**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

Path (パス)

名前変更するファイルへのパス。

はい

New Name (新しい名前)

ファイルの新しい名前。

はい

Overwrite (上書き)

選択した場合、​[New Name (新しい名前)]​ で指定した名前のファイルがすでに存在するときに対象ファイルを上書きします。

いいえ

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] ### [](#write-操作の設定)Write 操作の設定 **Write**​ 操作では、​**\[Path (パス)\]**​ で指定されたファイルにコンテンツを書き込みます。 1. キャンバス UI で ​**Write**​ 操作をクリックし、​**\[General (一般)\]**​ タブで次の属性を設定します。
属性 説明 必須

Path (パス)

コンテンツの書き込み先であるファイルを含むディレクトリへのパス。

はい

Content (コンテンツ)

ファイルに書き込むコンテンツ。デフォルトは ​[Content (コンテンツ)]​ ペイロードです。

いいえ

Create parent directories (親ディレクトリの作成)

選択すると、対象パスまたはその親が存在しない場合に親フォルダーが作成されます。選択解除すると、操作を実行しようとしたときに ​FILE:ILLEGAL_PATH​ エラーがスローされます。

いいえ

2. **\[Advanced (詳細)\]**​ タブをクリックして、次の属性を設定します。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-config-file-connector-partial.adoc\[\] 3. **Lock**​ を選択すると、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。 ## [](#scheduling-strategy)XML でのスケジュール戦略の設定 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc\[\] ## [](#configuring-reconnection-strategy)XML での再接続戦略の設定 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc\[\] ## [](#configuring-streaming-strategy)XML でのストリーミング戦略の設定 ストリーミング戦略を使用して、Mule によるデータストリームの処理方法を設定できます。 Unresolved include directive in modules/ROOT/pages/file-acb-configuration.adoc - include::connectors::partial$acb-xml-examples.adoc\[\] # Anypoint Studio を使用した File Connector 1.5 の設定 Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。 Studio でコネクタを追加および設定する手順は、次のとおりです。 1. [Mule プロジェクトを作成します](#create-mule-project)​。 2. [コネクタを Mule プロジェクトに追加します](#add-connector-to-project)​。 3. [コネクタのフローのソースを設定します](#configure-input-source)​。 4. [フローにコネクタの操作を追加します](#add-connector-operation)​。 5. [コネクタのグローバル要素を設定します](#configure-global-element)​。 [「アプリケーションログの表示」](#view-app-log)​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。 Studio で初めてコネクタを設定する場合は、​[「Studio を使用したコネクタの設定」](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​[「File Connector リファレンス」](https://docs.mulesoft.com/jp/file-connector/latest/file-documentation)​を参照してください。 ## [](#create-mule-project)Mule プロジェクトを作成する Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。 1. Studio で、​**\[File (ファイル)\] > \[New (新規)\] > \[Mule Project (Mule プロジェクト)\]**​ を選択します。 2. Mule プロジェクトの名前を入力して、​**\[Finish (完了)\]**​ をクリックします。 ## [](#add-connector-to-project)コネクタを Mule プロジェクトに追加する File Connector を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​`pom.xml`​ ファイルに必須の連動関係を追加します。 1. **\[Mule Palette (Mule パレット)\]**​ ビューで、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。 2. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ ウィンドウで、検索項目に「​`file`​」と入力します。 3. **\[Available modules (使用可能なモジュール)\]**​ で ​**\[File Connector\]**​ をクリックします。 4. **\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。 ## [](#configure-input-source)ソースの設定 ソースは、指定された条件が満たされたときにフローを開始します。 次のソースのいずれかを File 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 (ホスト)\]**​ 設定して、FTP サーバーホスト (​`localhost`​ や ​`192.168.0.1`​ など) を指定します。 8. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 9. **\[OK\]**​ をクリックします。 10. **\[On New or Updated File\]**​ 設定画面で、​**\[Scheduling Strategy (スケジュール戦略)\]**​ 値を指定し、必要に応じてその他の項目を入力します。 ## [](#add-connector-operation)フローにコネクタの操作を追加する フローにコネクタの操作を追加すると、そのコネクタで実行する特定の操作をすぐに定義できます。 File Connector の操作を追加する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ ビューで ​**\[File (ファイル)\]**​ を選択し、目的の操作を選択します。 2. その操作を Studio キャンバスのソースの横にドラッグします。 ## [](#configure-global-element)コネクタのグローバル要素を設定する コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定することをお勧めします。グローバル要素を設定するには、FTP サーバー接続を設定する必要があります。 File Connector のグローバル要素を設定する手順は、次のとおりです。 1. Studio キャンバスでコネクタの名前を選択します。 2. Studio キャンバスで操作を選択します。 3. 操作の設定画面で、​**\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックし、グローバル要素設定項目にアクセスします。 4. **\[General (一般)\]**​ タブで、コネクタの接続情報を指定します。 5. **\[Working Directory (作業ディレクトリ)\]**​ をこのコネクタで使用するすべての相対パスのルートとして設定します。 指定しない場合、デフォルトの ​`user.home`​ システムプロパティの値になります。システムプロパティが設定されていない場合、コネクタは初期化に失敗します。 6. **\[Host (ホスト)\]**​ 設定して、FTP サーバーホスト (​`localhost`​ や ​`192.168.0.1`​ など) を指定します。 7. **\[Advanced (詳細)\]**​ タブで、必要に応じてタイムアウト設定と再接続戦略を指定します。 8. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 9. **\[OK\]**​ をクリックします。 **設定 XML**​ エディターでは、​`file:config`​ の設定は次のように記述されます。 ```xml ``` ## [](#view-app-log)アプリケーションログの表示 問題を確認するため、アプリケーションログを次の方法で表示できます。 - アプリケーションを Anypoint Platform から実行している場合、出力は Anypoint Studio のコンソールウィンドウに表示される。 - コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログは OS コンソールに表示される。 アプリケーションのログファイル (​`log4j2.xml`​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​`MULE_HOME/logs/.log`​ でアプリケーションログを表示することもできます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Studio を使用したコネクタの設定](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/latest/file-documentation) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector File Connector v1.3 ファイル用 Anypoint Connector (File Connector) は、ローカルにマウントされたファイルシステムのファイルとフォルダーを処理します。この主な機能は次のとおりです。 - ファイルの読み取りやディレクトリの内容の完全なリストの作成をオンデマンドで実行する機能。 - 一般的な FTP 操作のサポート (ディレクトリの作成、ファイルのコピー、移動、名前変更、削除など)。 - ファイルのロックのサポート。 - ファイル一致機能。 - File Connector および SFTP Connector と完全に一致する設計。各コネクタで同じ操作セットを使用できます。 エラー条件についての詳細は、​[File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/1.3/file-documentation)​を参照してください。 リリースノート: [File Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/connector-file)​ Exchange: [File Connector](https://www.mulesoft.com/exchange/org.mule.connectors/mule-file-connector/) ## [](#connection_settings)File Connector の設定 File Connector は、必ずしも設定を必要としません。ただし、設定を定義することをお勧めします。重要な設定パラメーターは作業ディレクトリ (​`workingDir`​) です。これは、このコネクタで指定するすべての相対パスのルートとして処理されるディレクトリへのパスです。作業ディレクトリを指定しない場合、コネクタ設定のデフォルトの ​`user.home`​ システムプロパティの値になります。システムプロパティが設定されていない場合、コネクタは初期化に失敗します。 ファイルの書き込み時に使用するデフォルトの文字コードも設定できます。デフォルトは、Mule Runtime のデフォルトの文字コードです。設定を参照せずに File Connector の操作を使用する場合、操作ではデフォルト値が使用されます。 次の例では、File Connector の作業ディレクトリを設定します。 ```xml ``` ## [](#属性)属性 ファイルを読み取るまたはファイルのリストを作成する場合、コネクタではファイルメタデータ (ファイル名、フルパス、サイズ、タイムスタンプなど) が提供されます。コネクタは Mule メッセージ属性を使用してこの情報にアクセスします。 ## [](#pom-ファイル情報)POM ファイル情報 ```xml org.mule.connectors mule-file-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。バージョンを指定するには、Anypoint Exchange で [File Connector](https://www.mulesoft.com/exchange/org.mule.connectors/mule-file-connector/)​ を参照して ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#see_also)関連情報 - [File Connector ドキュメントリファレンス](https://docs.mulesoft.com/jp/file-connector/1.3/file-documentation) - [ファイルの読み取り](https://docs.mulesoft.com/jp/file-connector/1.3/file-read) - [ファイルの書き込み](https://docs.mulesoft.com/jp/file-connector/1.3/file-write) - [ファイルのリストの作成](https://docs.mulesoft.com/jp/file-connector/1.3/file-list) - [新規ファイルまたは変更されたファイルのリスン](https://docs.mulesoft.com/jp/file-connector/1.3/file-on-new-file) - [ファイルのコピーまたは移動](https://docs.mulesoft.com/jp/file-connector/1.3/file-copy-move) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector ファイル用 Anypoint Connector (File Connector) では、ローカルにマウントされたファイルシステムのファイルとフォルダーを管理します。このコネクタの主な機能は次のとおりです。 - ファイルの読み取りやディレクトリのコンテンツの完全なリストの作成をオンデマンドで実行する機能。 - 一般的なファイル操作のサポート (ディレクトリの作成、ファイルの読み取り、書き込み、コピー、移動、名前変更、削除、リスト作成など)。 - ファイルのロックのサポート。 - ファイル一致機能。 - FTP Connector および SFTP Connector と一貫性のある設計。 ## [](#ファイル属性の表現)ファイル属性の表現 Mule 4 のペイロードおよび属性のメッセージ構造では、データがさまざまな場所に移動するため、そのペイロードがファイルのコンテンツになります。属性により、ペイロードに関するメタデータと、ファイル名、パス、サイズ、タイムスタンプなどの情報を含むオブジェクトが提供されます。FTP Connector および SFTP Connector の場合、これらの属性は​_ファイル属性_​と呼ばれます。 Mule メッセージでは、ペイロードを表現する形式を記述するエンコードと MIME タイプを指定します。ファイル属性は、ファイルのエンコードおよび MIME タイプを記述します。 ## [](#始める前に)始める前に このコネクタを使用するには、以下に精通している必要があります。 - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio (Studio) を使用した Mule アプリケーションの作成 アプリケーションを作成するには、Anypoint Platform および Anypoint Studio へのアクセスが必要です。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/latest/file-documentation) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector の XML と Maven のサポート XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。 Anypoint Studio の XML エディターまたはテキストエディターから Mule Runtime Engine (Mule) アプリケーションを手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションでコネクタにアクセスできます。 コネクタを Studio に追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力します。さらに、​`pom.xml`​ ファイルに連動関係を追加します。 ## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​``​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd ``` 次の例は、​``​ XML ブロック内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします: ```xml org.mule.connectors mule-file-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`file`​」を検索します。 4. コネクタを選択します。 5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector の XML と Maven のサポート XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。 Anypoint Studio の XML エディターまたはテキストエディターから Mule Runtime Engine (Mule) アプリケーションを手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションでコネクタにアクセスできます。 コネクタを Studio に追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力します。さらに、​`pom.xml`​ ファイルに連動関係を追加します。 ## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​``​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd ``` 次の例は、​``​ XML ブロック内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします: ```xml org.mule.connectors mule-file-connector x.x.x mule-plugin ``` `x.x.x`​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`file`​」を検索します。 4. コネクタを選択します。 5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector のトラブルシューティング ファイル用 Anypoint Connector (File Connector) をトラブルシューティングするには、Mule アプリケーションの問題のトラブルシューティングに関する情報を理解しておきます。 ## [](#mule-アプリケーションの問題のトラブルシューティング)Mule アプリケーションの問題のトラブルシューティング 場合によって、アプリケーションが失敗している理由がわからず、アプリケーションのファイルシステムとのやりとりで何が行われているかについて理解を深める必要があることがあります。 このエラーを解決する手順は、次のとおりです。 - 設定ファイルを使用して、サーバー側のログレベルを引き上げます。 - Cyberduck や Filezilla などのファイルクライアントを使用して、問題の再現を試みます。これらのクライアントを使用した場合でも問題が発生する場合は、問題が Mule アプリケーションには関連していない可能性が高くなります。 - File Connector と JSCH ドライバーの冗長ログを有効にして、Mule アプリケーション側に関するより分かりやすく詳細なログを取得します。 1. Anypoint Studio にアクセスし、​**\[Package Explorer\]**​ ビューに移動します。 2. アプリケーションのプロジェクト名を開きます。 3. `src/main/resources`​ パスフォルダーを開きます。 4. フォルダー内の ​`log4j2.xml`​ ファイルを開きます。 5. 次の行がすでに ​`log4j2.xml`​ ファイル内にある場合は、そのコメントを解除して有効にします。それ以外の場合、次の行を追加します。 ```xml ``` 6. 次の引数を追加して設定を実行します。 ​\`-M-Djavax.net.debug=ssl,handshake\` - アプリケーションを可能な限り単純にして問題がアプリケーションとファイルシステム間のやりとりに関係しているかどうかを判断できるように、不要な DataWeave データ変換は最小限に抑えるか削除してみてください (ハードコードされたデータを使用することもできます)。 Mule アプリケーションの SDK コンポーネントに関する冗長ログの有効化の詳細は、​[「SDK コンポーネントのトラブルシューティング」](https://docs.mulesoft.com/mule-sdk/latest/troubleshooting)​ドキュメントを参照してください。 ## [](#一般的なスローを理解する)一般的なスローを理解する ここでは、一般的なスローメッセージとその解決方法を示します。 - FILE:CONNECTIVITY ファイルサーバーへの接続が有効ではなくなりました。アプリケーションの設定で定義されている場合、再接続ポリシーを適用してください。 - FILE:ILLEGAL\_PATH **createParentDirectories**​ プロパティが ​`false`​ に設定されており、対象パスとその親のどちらも存在しません。 - FILE:FILE\_ALREADY\_EXISTS コピー先のファイルがすでに存在し、​**overwrite**​ プロパティが ​`false`​ に設定されています。 - FILE:RETRY\_EXHAUSTED 操作の最大再試行回数に達しました。 - FILE:ACCESS\_DENIED File Connector の操作がファイルまたはパスへのアクセスを試み、ユーザーに権限のないアクションを実行しました。 - FILE:FILE\_LOCK ファイルをロックしようとしましたが失敗しました。 - FILE:ILLEGAL\_CONTENT **Write**​ 操作で書き込み対象として無効なコンテンツを受信しました。 ## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com) - [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/1.3/file-documentation) # File Connector のトラブルシューティング ファイル用 Anypoint Connector (File Connector) をトラブルシューティングするには、Mule アプリケーションの問題のトラブルシューティングに関する情報を理解しておきます。 ## [](#mule-アプリケーションの問題のトラブルシューティング)Mule アプリケーションの問題のトラブルシューティング 場合によって、アプリケーションが失敗している理由がわからず、アプリケーションのファイルシステムとのやりとりで何が行われているかについて理解を深める必要があることがあります。 このエラーを解決する手順は、次のとおりです。 - 設定ファイルを使用して、サーバー側のログレベルを引き上げます。 - Cyberduck や Filezilla などのファイルクライアントを使用して、問題の再現を試みます。これらのクライアントを使用した場合でも問題が発生する場合は、問題が Mule アプリケーションには関連していない可能性が高くなります。 - File Connector と JSCH ドライバーの冗長ログを有効にして、Mule アプリケーション側に関するより分かりやすく詳細なログを取得します。 1. Anypoint Studio にアクセスし、​**\[Package Explorer\]**​ ビューに移動します。 2. アプリケーションのプロジェクト名を開きます。 3. `src/main/resources`​ パスフォルダーを開きます。 4. フォルダー内の ​`log4j2.xml`​ ファイルを開きます。 5. 次の行がすでに ​`log4j2.xml`​ ファイル内にある場合は、そのコメントを解除して有効にします。それ以外の場合、次の行を追加します。 ```xml ``` 6. 次の引数を追加して設定を実行します。 ​\`-M-Djavax.net.debug=ssl,handshake\` - アプリケーションを可能な限り単純にして問題がアプリケーションとファイルシステム間のやりとりに関係しているかどうかを判断できるように、不要な DataWeave データ変換は最小限に抑えるか削除してみてください (ハードコードされたデータを使用することもできます)。 Mule アプリケーションの SDK コンポーネントに関する冗長ログの有効化の詳細は、​[「SDK コンポーネントのトラブルシューティング」](https://docs.mulesoft.com/mule-sdk/latest/troubleshooting)​ドキュメントを参照してください。 ## [](#repeatable-file-store-iterable-反復可能なファイルストアイテラブル-によるメモリ不足のトラブルシューティング)\[Repeatable File Store Iterable (反復可能なファイルストアイテラブル)\] によるメモリ不足のトラブルシューティング ファイルフォルダーに大きなファイルが含まれていて、​**\[Streaming strategy (ストリーミング戦略)\]**​ 項目を ​**\[List (リスト)\]**​ 操作の ​**\[Repeatable file store iterable (Default) (反復可能なファイルストアイテラブル (デフォルト))\]**​ オプションに設定していると、Mule アプリケーションで ​`java.lang.OutOfMemoryError`​ メッセージがスローされることがあります。 この問題を回避するには、​**\[Streaming strategy (ストリーミング戦略)\]**​ 項目を ​**\[Repeatable file store iterable (Default) (反復可能なファイルストアイテラブル (デフォルト))\]**​ から ​**\[No repeatable iterable (反復可能なイテラブルなし)\]**​ オプションに設定します。 反復可能なファイルストアについての詳細は、​[「Repeatable File Store (反復可能なファイルストア)」](https://docs.mulesoft.com/mule-runtime/latest/tuning-repeatable-nonrepeatable#file-store-repeatable-stream)​を参照してください。 反復可能ストリームの無効化についての詳細は、​[「反復可能ストリームの無効化」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about#disable_repeatable_streaming)​を参照してください。 ## [](#一般的なスローを理解する)一般的なスローを理解する ここでは、一般的なスローメッセージとその解決方法を示します。 - FILE:CONNECTIVITY ファイルサーバーへの接続が有効ではなくなりました。アプリケーションの設定で定義されている場合、再接続ポリシーを適用してください。 - FILE:ILLEGAL\_PATH **createParentDirectories**​ プロパティが ​`false`​ に設定されており、対象パスとその親のどちらも存在しません。 - FILE:FILE\_ALREADY\_EXISTS コピー先のファイルがすでに存在し、​**overwrite**​ プロパティが ​`false`​ に設定されています。 - FILE:RETRY\_EXHAUSTED 操作の最大再試行回数に達しました。 - FILE:ACCESS\_DENIED File Connector の操作がファイルまたはパスへのアクセスを試み、ユーザーに権限のないアクションを実行しました。 - FILE:FILE\_LOCK ファイルをロックしようとしましたが失敗しました。 - FILE:ILLEGAL\_CONTENT **Write**​ 操作で書き込み対象として無効なコンテンツを受信しました。 ## [](#関連情報)関連情報 - [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/latest/file-documentation) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) - [Known Issues](https://help.salesforce.com/s/issues) # File Connector の例 ファイル用 Anypoint Connector (File Connector) を最大限活用するには、次のコネクタ操作の設定例を参照してください。 - [ファイルの読み取り](https://docs.mulesoft.com/jp/file-connector/1.3/file-read) フローの任意の時点でファイルを読み取るように ​**Read**​ 操作を設定します。 - [ファイルの書き込み](https://docs.mulesoft.com/jp/file-connector/1.3/file-write) 必要に応じてコンテンツを特定のパスに書き込むように ​**Write**​ 操作を設定します。 - [ファイルのリストの作成](https://docs.mulesoft.com/jp/file-connector/1.3/file-list) 設定済みのディレクトリパスにあるファイルとフォルダーのリストを作成するように ​**List**​ 操作を設定します。 - [ファイルのコピーと移動](https://docs.mulesoft.com/jp/file-connector/1.3/file-copy-move) 必要に応じてファイルまたはディレクトリをコピーまたは移動するように ​**Copy**​ 操作と ​**Move**​ 操作を設定します。 - [新規作成または更新されたファイルに対するフローのトリガー](https://docs.mulesoft.com/jp/file-connector/1.3/file-on-new-file) 新規作成または変更されたファイルに対してフローをトリガーするように ​**On New or Updated File**​ ソースを設定します。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector の例 ファイル用 Anypoint Connector (File Connector) を最大限活用するには、次のコネクタ操作の設定例を参照してください。 - [ファイルの読み取り](https://docs.mulesoft.com/jp/file-connector/latest/file-read) フローの任意の時点でファイルを読み取るように ​**Read**​ 操作を設定します。 - [ディレクトリの作成](https://docs.mulesoft.com/jp/file-connector/latest/file-create-directory) 特定の名前のディレクトリを作成するように ​**Create directory**​ 操作を設定します。 - [ファイルの書き込み](https://docs.mulesoft.com/jp/file-connector/latest/file-write) 必要に応じてコンテンツを特定のパスに書き込むように ​**Write**​ 操作を設定します。 - [ファイルのリストの作成](https://docs.mulesoft.com/jp/file-connector/latest/file-list) 設定済みのディレクトリパスにあるファイルとフォルダーのリストを作成するように ​**List**​ 操作を設定します。 - [ファイルのコピーと移動](https://docs.mulesoft.com/jp/file-connector/latest/file-copy-move) 必要に応じてファイルまたはディレクトリをコピーまたは移動するように ​**Copy**​ 操作と ​**Move**​ 操作を設定します。 - [新規作成または更新されたファイルに対するフローのトリガー](https://docs.mulesoft.com/jp/file-connector/latest/file-on-new-file) 新規作成または変更されたファイルに対してフローをトリガーするように ​**On New or Updated File**​ ソースを設定します。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector リファレンス File Connector v1.3 ファイル用 Anypoint Connector (File Connector) は、ホストのオペレーションシステムにマウントされたファイルシステムを操作します。 このクラスは拡張機能の定義および設定として機能します。操作は標準の ​`BaseFileSystemOperations`​ に基づきます。 リリースノート: [File Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/connector-file) ## [](#設定)設定 * * * ### [](#config)デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定できる接続種別。

x

Default Write Encoding (デフォルト書き込みエンコード) (廃止)

String (文字列)

このパラメーターは廃止されており無視されます。

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。これにより、ファイルの書き込みが完了してから処理を実行することができます。値を指定しない場合、確認は実行されません。有効にした場合、Mule はあるコールから次のコールまでの指定された時間を待機して、2 回のサイズ確認を実行します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。この属性は、​[Time Between Size Check Unit (サイズ確認の時間間隔の単位)]​ と連携して機能します。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Time between size check (サイズ確認の時間間隔)]​ 属性の ​[Time unit (時間単位)]​。

MILLISECONDS

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

#### [](#接続種別)接続種別 ##### [](#config_connection)ローカル FileSystem 接続 File Connector のインスタンスからファイルシステムのインスタンスを提供する接続プロバイダー。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Working Directory (作業ディレクトリ)

String (文字列)

このコネクタで使用するすべての相対パスのルートとみなされるディレクトリ。指定しない場合、デフォルトの ​user.home​ システムプロパティの値になります。このシステムプロパティが設定されていない場合、コネクタは初期化に失敗します。

Reconnection (再接続)

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

## [](#操作)操作 - [Copy](#copy) - [Create Directory](#createDirectory) - [削除](#delete) - [List](#list) - [Move](#move) - [Read](#read) - [Rename](#rename) - [Write](#write) ## [](#関連付けられたソース)関連付けられたソース - [新しいファイルまたは更新されたファイル](#listener) ### [](#copy)Copy `` **ソースパス**​で指定されたファイルまたはディレクトリを​**対象パス**​にコピーします。 ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照する場合、再帰的にコピーされます。 対象パスが存在せず、その親も存在しない場合には、​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`true`​ に設定されていると親フォルダーが作成されます。​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`false`​ に設定されている場合、​`FILE:ILLEGAL_PATH`​ エラーがスローされます。 **\[Overwrite (上書き)\]**​ が ​`true`​ に設定されており対象ファイルがすでに存在する場合、対象ファイルが上書きされます。それ以外の場合は、​`FILE:FILE_ALREADY_EXISTS`​ エラーがスローされます。 #### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

コピーするファイルへのパス。

x

Target Path (対象パス)

String (文字列)

ファイルのコピー先のディレクトリ。

x

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Rename To (変更後の名前)

String (文字列)

コピーしたファイルの新しい名前。指定しない場合、元のファイル名のままになります。

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED ### [](#createDirectory)Create Directory `` **ディレクトリパス**​で新しいディレクトリを作成します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory Path (ディレクトリパス)

String (文字列)

新しいディレクトリの名前。

x

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-2)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#delete)削除 `` パス項目で参照されているファイルがロックされていない場合、そのファイルを削除します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

削除するファイルへのパス。

x

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-3)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#list)List `` マッチャーに一致する​**ディレクトリパス**​にあるファイルをすべてリストします。 リスト中にディレクトリが検出された場合、​**Recursive (再帰)**​ パラメーターの値に応じて出力リストにそのコンテンツが含まれます。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory Path (ディレクトリパス)

String (文字列)

リストするディレクトリへのパス。

x

Recursive (再帰)

Boolean (ブール)

サブディレクトリのコンテンツを含めるかどうか。

false

File Matching Rules (ファイル一致ルール)

出力リストを絞り込むために使用するマッチャー。

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

サイズ確認間の待機時間で使用する時間単位。

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

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

#### [](#出力)出力

型

[CursorProvider] ペイロードおよび [​ローカルファイル属性​] 属性のメッセージの配列

#### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-4)スロー - FILE:ILLEGAL\_PATH - FILE:ACCESS\_DENIED ### [](#move)Move `` ファイルまたはディレクトリを​**ソースパス**​から​**対象パス**​に移動します。 ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照している場合、再帰的に移動します。 対象パスが存在せず、その親も存在しない場合には、​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`true`​ に設定されていると親フォルダーが作成されます。​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`false`​ に設定されている場合、​`FILE:ILLEGAL_PATH`​ エラーがスローされます。 コピー先のファイルがすでに存在し、​**\[Overwrite (上書き)\]**​ が ​`true`​ に設定されている場合、コピー先のファイルは上書きされます。​**\[Overwrite (上書き)\]**​ が ​`false`​ に設定されている場合、​`FILE:FILE_ALREADY_EXISTS`​ エラーがスローされます。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

コピーするファイルへのパス。

x

Target Path (対象パス)

String (文字列)

対象のディレクトリ。

x

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Rename To (変更後の名前)

String (文字列)

移動されたファイルの新しい名前。指定しない場合、元のファイル名のままになります。

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-5)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED ### [](#read)Read `` 提供されたパスにあるファイルのコンテンツとメタデータを取得します。操作自体は、ファイルのコンテンツを含む InputStream をペイロードとするメッセージを返します。メタデータは、メッセージの ​`Message#getAttributes()`​ 属性として配置されている LocalFileAttributes オブジェクトとして表されます。 lock (ロック) パラメーターを true に設定した場合、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックは実際にはホストのファイルシステムにより提供されるため、その動作は、マウントされたドライブと、Mule が実行されているオペレーティングシステムに応じて変わる可能性があります。盲目的にこのロックに依存する前に以上の点を考慮してください。 また、この方法では、読み取られるファイルの MIME タイプを判断するために最善を尽くします。ファイルの拡張子は、情報に基づいてファイルの MIME タイプを推測するために使用されます。また、ユーザーは省略可能な ​`outputEncoding`​ および ​`outputMimeType`​ パラメーターを使用して、出力のエンコードと ​`mimeType`​ を強制することもできます。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Path (ファイルパス)

String (文字列)

読み取るファイルへのパス。

x

Lock (ロック)

Boolean (ブール)

ファイルをロックするかどうか。デフォルトは false です。

false

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

サイズ確認間の待機時間で使用する時間単位。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Encoding (エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

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

#### [](#出力-2)出力

型

Binary (バイナリ)

Attributes Type (属性型)

#### [](#次の設定の場合-6)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-6)スロー - FILE:CONNECTIVITY - FILE:FILE\_LOCK - FILE:ILLEGAL\_PATH - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#rename)Rename `` `to`​ パラメーターで指定される名前へのパスによって参照されるファイルの名前を変更します。​`to`​ 引数にはパスセパレーターを含めることができません。この前提条件が満たされない場合、FILE:ILLEGAL\_PATH がスローされます。 #### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

名前を変更するファイルへのパス。

x

New Name (新しい名前)

String (文字列)

ファイルの新しい名前。

x

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-7)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-7)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#write)Write `` パスで参照されているファイルにコンテンツを書き込みます。 書き込み先のファイルのディレクトリが存在しない場合、操作は createParentDirectory の値に応じて FILE:ILLEGAL\_PATH​ エラーをスローするか、該当のフォルダーを作成します。 ファイル自体がすでに存在している場合、その動作は指定されたモードに応じて異なります。 この操作では、Lock (ロック) 引数の値に応じてロックもサポートされます、ただし、Read 操作で説明されているルールおよび考慮事項と同じものが適用されます。 #### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

書き込まれるファイルのパス。

x

Content (コンテンツ)

Binary (バイナリ)

ファイルに書き込まれるコンテンツ。デフォルトは現在のメッセージペイロードです。

#[payload]

Encoding (エンコード) (廃止)

String (文字列)

このパラメーターは廃止されており、設定しても何も実行されません。

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Lock (ロック)

Boolean (ブール)

ファイルをロックするかどうか。デフォルトは false です。

false

Write Mode (書き込みモード)

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

  • OVERWRITE

  • APPEND

  • CREATE_NEW

FileWriteMode。デフォルトは OVERWRITE (上書き) です。

OVERWRITE

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-8)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-8)スロー - FILE:ILLEGAL\_CONTENT - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ## [](#ソース)ソース ### [](#listener)新しいファイルまたは更新されたファイル `` ディレクトリをポーリングして、作成または更新されたファイルを探します。見つかった各ファイルに 1 つのメッセージが生成されます。 この機能の重要な部分は、ファイルが実際に新規かどうかを判断する方法です。 その戦略を次に示します。 - `autoDelete`​ パラメーターを ​`true`​ に設定する: この方法では各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが必ず新規になります。 - `moveToDirectory`​ パラメーターを設定する: この方法では各ファイルを処理した後で処理済みのファイルを異なるディレクトリに移動するため、​`autoDelete<`​ と同じ効果を得ることができますが、ファイルが失われることはありません。 - watermarkMode パラメーターを使用して、前回のポーリングの実行後に作成または更新されたファイルのみを選択する。 ファイルをさらに絞り込むためにマッチャーを使用することもできます。 #### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory (ディレクトリ)

String (文字列)

ポーリングするファイルを含むディレクトリ。

Recursive (再帰)

Boolean (ブール)

サブディレクトリに含まれるファイルもポーリングするかどうか。

true

Matcher (マッチャー)

マッチャーの条件を満たさないファイルに対するイベントを絞り込むために使用するマッチャー。

Watermark Mode (ウォーターマークモード)

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

  • DISABLED

  • MODIFIED_TIMESTAMP​

  • CREATED_TIMESTAMP

ウォーターマークを設定するかどうかを制御します。設定する場合は、ファイルの変更タイムスタンプを考慮するか、作成タイムスタンプを考慮するかを制御します。

DISABLED

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。値を省略してこの機能を無効にできます。有効にした場合、Mule はあるコールから次のコールまでの指定された時間を待機して、2 回のサイズ確認を実行します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Time between size check (サイズ確認の時間間隔)]​ の ​[Time unit (時間単位)]​。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Encoding (エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

Auto Delete (自動削除)

Boolean (ブール)

各ファイルを処理後に削除するかどうか。

false

Move To Directory (ディレクトリに移動)

String (文字列)

指定した場合、処理された各ファイルは、このパスで参照されているディレクトリに移動します。

Rename To (変更後の名前)

String (文字列)

このパラメーターは、​[Move To Directory (ディレクトリに移動)]​ と連携して機能します。このパラメーターを使用して入力した名前でファイルが移動します。moveToDirectory を設定しない場合は、このパラメーターも設定しないでください。

Apply Post Action When Failed (失敗した場合に投稿アクションを適用)

Boolean (ブール)

ファイルの処理に失敗した場合に投稿アクション (​[Auto Delete (自動削除)]​ および ​[Move To Directory (ディレクトリに移動)]​) も適用するかどうか。​false​ に設定すると、失敗したファイルは移動も削除もされません。

true

#### [](#出力-3)出力

型

Binary (バイナリ)

Attributes Type (属性型)

#### [](#次の設定の場合-9)次の設定の場合 - [デフォルト設定](#config) ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true

### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Max Idle Time (最大アイドル時間)]​ 属性の時間単位。

### [](#LocalFileAttributes)ローカルファイル属性
項目 型 説明 デフォルト値 必須

Last Modified Time (最終更新時間)

DateTime

x

Last Access Time (最終アクセス時間)

DateTime

x

Creation Time (作成時間)

DateTime

x

Size (サイズ)

Number (数値)

x

Regular File (正規ファイル)

Boolean (ブール)

false

Directory (ディレクトリ)

Boolean (ブール)

false

Symbolic Link (シンボリックリンク)

Boolean (ブール)

false

Path (パス)

String (文字列)

x

File Name (ファイル名)

String (文字列)

x

### [](#matcher)Matcher (マッチャー)
項目 型 説明 デフォルト値 必須

Created Since (指定した日付以降に作成)

DateTime

この日付より前に作成されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Created Until (指定した日付以前に作成)

DateTime

この日付より後に作成されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Updated Since (指定した日付以降に更新)

DateTime

この日付より前に変更されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Updated Until (指定した日付以前に更新)

DateTime

この日付より後に変更されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Accessed Since (指定した日付以降にアクセス)

DateTime

最後のアクセスがこの日付より前のファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Accessed Since (指定した日付以前にアクセス)

DateTime

最後のアクセスがこの日付より後のファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Not Updated In The Last (指定した期間に更新なし)

Number (数値)

ファイルの最終更新後の経過期間がこの期間以上の場合、却下されません。この属性は、​[Time unit (時間単位)]​ と連携して機能します。

Updated In The Last (指定した期間に更新あり)

Number (数値)

ファイルの最終更新後の経過期間がこの期間以内の場合、却下されません。この属性は、​[Time unit (時間単位)]​ と連携して機能します。

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Updated In The Last (指定した期間に更新あり)]​ 属性と ​[Not Updated In The Last (指定した期間に更新なし)]​ 属性の​時間単位​。

MILLISECONDS

Filename Pattern (ファイル名パターン)

String (文字列)

Path Pattern (パスパターン)

String (文字列)

Directories (ディレクトリ)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Regular Files (正規ファイル)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Sym Links (シンボリックリンク)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Min Size (最小サイズ)

Number (数値)

Max Size (最大サイズ)

Number (数値)

### [](#repeatable-in-memory-stream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量です。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max In Memory Size (最大メモリ内サイズ)]​ を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。

Max in Memory Size (最大メモリ内サイズ)

Number (数値)

使用するメモリの最大量。指定された最大値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

### [](#repeatable-file-store-stream)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

[Max in Memory Size (最大メモリ内サイズ)]​ を表す単位

### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずに​プロセス失敗メッセージ​がトリガーされるまでにメッセージを再配信できる最大回数。

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

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

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

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの ​SHA-256​ になります。

Id Expression (ID 式)

String (文字列)

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

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

ObjectStore

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

### [](#repeatable-in-memory-iterable)Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で、メモリ内に保持することが許可されるインスタンスの初期容量です。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max in Memory instances (最大メモリ内インスタンス)]​ を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max in Memory instances (最大メモリ内インスタンス)

Number (数値)

使用するメモリインスタンスの最大数。指定された最大値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。0 以下の値は無制限を意味します。

### [](#repeatable-file-store-iterable)Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

In Memory Objects (メモリ内オブジェクト)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。指定された以上のメモリがコンシュームされると、ディスクへのコンテンツのバッファが開始されます。

500

### [](#time-between-size-check)Time Between Size Check Unit (サイズ確認の時間間隔) パラメーターの動作 ファイルの Write 操作が完了してファイルの読み取りまたはアクセスを行う準備ができるようになるまで時間がかかる可能性があります。操作が未完了のファイルにアクセスしないようにするには、​`timeBetweenSizeCheck`​ パラメーターを使用します。 このパラメーターを設定すると、ファイルのコンテンツにアクセスする前にファイルのサイズが検証されます。 この検証では、​`timeBetweenSizeCheck`​ および ​`timeBetweenSizeCheckUnit`​ パラメーターで指定された時間待機した後にファイルのサイズが変わっていないことを確認します。 その後、​`timeBetweenSizeCheck`​ パラメーターによって、2 回実行される各検証間の待機時間が示されます。ファイルのサイズが両方の時間で変わらない場合、Write 操作が完了し、access 操作を続行できるとみなされます。同じでない場合、例外がスローされます。 実行される待機は、操作を実行しているスレッドが指定の期間スリープすることを示します。この待機は、ファイルのコンテンツを取得した時点で発生します。フローでファイルのコンテンツにアクセスしていない場合、確認は実行されません。
Mule Runtime Engine バージョン 4.1 および 4.2 では、この待機が複数のメッセージプロセッサーで発生する可能性があり、File Connector で待機を実行するスレッドを制御できません。スレッドプールのスレッドは、CPU に負荷がかかるスレッド (この種のタスクを目的とするものではない) でも、待機を実行する可能性があります。
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector リファレンス File Connector v1.5 ファイル用 Anypoint Connector (File Connector) は、ホストのオペレーションシステムにマウントされたファイルシステムを操作します。 このクラスは拡張機能の定義および設定として機能します。操作は標準の ​`BaseFileSystemOperations`​ に基づきます。 リリースノート: [File Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/connector-file) ## [](#設定)設定 * * * ### [](#config)デフォルト設定 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定できる接続種別。

x

Default Write Encoding (デフォルト書き込みエンコード) (廃止)

String (文字列)

このパラメーターは廃止されており無視されます。

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。これにより、ファイルの書き込みが完了してから処理を実行することができます。値を指定しない場合、確認は実行されません。有効にした場合、Mule はあるコールから次のコールまでの指定された時間を待機して、2 回のサイズ確認を実行します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。この属性は、​[Time Between Size Check Unit (サイズ確認の時間間隔の単位)]​ と連携して機能します。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Time between size check (サイズ確認の時間間隔)]​ 属性の ​[Time unit (時間単位)]​。

MILLISECONDS

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、対象になった瞬間にプラットフォームでインスタンスの有効期限が切れるという意味ではありません。ランタイムによって適切と判断されたときに、インスタンスが実際にパージされます。

#### [](#接続種別)接続種別 ##### [](#config_connection)ローカル FileSystem 接続 File Connector のインスタンスからファイルシステムのインスタンスを提供する接続プロバイダー。 ###### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Working Directory (作業ディレクトリ)

String (文字列)

このコネクタで使用するすべての相対パスのルートとみなされるディレクトリ。指定しない場合、デフォルトの ​user.home​ システムプロパティの値になります。このシステムプロパティが設定されていない場合、コネクタは初期化に失敗します。

Reconnection (再接続)

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

## [](#操作)操作 - [Copy](#copy) - [Create Directory](#createDirectory) - [削除](#delete) - [List](#list) - [Move](#move) - [Read](#read) - [Rename](#rename) - [Write](#write) ## [](#関連付けられたソース)関連付けられたソース - [新しいファイルまたは更新されたファイル](#listener) ### [](#copy)Copy `` **ソースパス**​で指定されたファイルまたはディレクトリを​**対象パス**​にコピーします。 ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照する場合、再帰的にコピーされます。 対象パスが存在せず、その親も存在しない場合には、​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`true`​ に設定されていると親フォルダーが作成されます。​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`false`​ に設定されている場合、​`FILE:ILLEGAL_PATH`​ エラーがスローされます。 **\[Overwrite (上書き)\]**​ が ​`true`​ に設定されており対象ファイルがすでに存在する場合、対象ファイルが上書きされます。それ以外の場合は、​`FILE:FILE_ALREADY_EXISTS`​ エラーがスローされます。 #### [](#パラメーター-3)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

コピーするファイルへのパス。

x

Target Path (対象パス)

String (文字列)

ファイルのコピー先のディレクトリ。

x

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Rename To (変更後の名前)

String (文字列)

コピーしたファイルの新しい名前。指定しない場合、元のファイル名のままになります。

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED ### [](#createDirectory)Create Directory `` **ディレクトリパス**​で新しいディレクトリを作成します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory Path (ディレクトリパス)

String (文字列)

新しいディレクトリの名前。

x

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-2)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-2)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#delete)削除 `` パス項目で参照されているファイルがロックされていない場合、そのファイルを削除します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

削除するファイルへのパス。

x

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-3)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-3)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#list)List `` マッチャーに一致する​**ディレクトリパス**​にあるファイルをすべてリストします。 リスト中にディレクトリが検出された場合、​**Recursive (再帰)**​ パラメーターの値に応じて出力リストにそのコンテンツが含まれます。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory Path (ディレクトリパス)

String (文字列)

リストするディレクトリへのパス。

x

Recursive (再帰)

Boolean (ブール)

サブディレクトリのコンテンツを含めるかどうか。

false

File Matching Rules (ファイル一致ルール)

出力リストを絞り込むために使用するマッチャー。

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

サイズ確認間の待機時間で使用する時間単位。

Subset (サブセット)

返されるファイルの数の制限と並び替えを行います。

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

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

#### [](#出力)出力

型

[CursorProvider] ペイロードおよび [​ローカルファイル属性​] 属性のメッセージの配列

#### [](#次の設定の場合-4)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-4)スロー - FILE:ILLEGAL\_PATH - FILE:ACCESS\_DENIED ### [](#move)Move `` ファイルまたはディレクトリを​**ソースパス**​から​**対象パス**​に移動します。 ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照している場合、再帰的に移動します。 対象パスが存在せず、その親も存在しない場合には、​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`true`​ に設定されていると親フォルダーが作成されます。​**\[Create Parent Directories (親ディレクトリの作成)\]**​ が ​`false`​ に設定されている場合、​`FILE:ILLEGAL_PATH`​ エラーがスローされます。 コピー先のファイルがすでに存在し、​**\[Overwrite (上書き)\]**​ が ​`true`​ に設定されている場合、コピー先のファイルは上書きされます。​**\[Overwrite (上書き)\]**​ が ​`false`​ に設定されている場合、​`FILE:FILE_ALREADY_EXISTS`​ エラーがスローされます。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

コピーするファイルへのパス。

x

Target Path (対象パス)

String (文字列)

対象のディレクトリ。

x

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Rename To (変更後の名前)

String (文字列)

移動されたファイルの新しい名前。指定しない場合、元のファイル名のままになります。

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-5)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-5)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED ### [](#read)Read `` 提供されたパスにあるファイルコンテンツとメタデータを取得します。操作自体は、ファイルのコンテンツを含む InputStream をペイロードとするメッセージを返します。メタデータは、メッセージの ​`Message#getAttributes()`​ 属性として配置されている LocalFileAttributes オブジェクトとして表されます。 lock (ロック) パラメーターを true に設定した場合、この操作によって返される入力ストリームが閉じられるか完全にコンシュームされるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックは実際にはホストのファイルシステムにより提供されるため、その動作は、マウントされたドライブと、Mule が実行されているオペレーティングシステムに応じて変わる可能性があります。盲目的にこのロックに依存する前に以上の点を考慮してください。 また、この方法では、読み取られるファイルの MIME タイプを判断するために最善を尽くします。ファイルの拡張子は、情報に基づいてファイルの MIME タイプを推測するために使用されます。また、ユーザーは省略可能な ​`outputEncoding`​ および ​`outputMimeType`​ パラメーターを使用して、出力のエンコードと ​`mimeType`​ を強制することもできます。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Path (ファイルパス)

String (文字列)

読み取るファイルへのパス。

x

Lock (ロック)

Boolean (ブール)

ファイルをロックするかどうか。デフォルトは false です。

false

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

サイズ確認間の待機時間で使用する時間単位。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Encoding (エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。その式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

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

#### [](#出力-2)出力

型

Binary (バイナリ)

Attributes Type (属性型)

#### [](#次の設定の場合-6)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-6)スロー - FILE:CONNECTIVITY - FILE:FILE\_LOCK - FILE:ILLEGAL\_PATH - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#rename)Rename `` `to`​ パラメーターで指定される名前へのパスによって参照されるファイルの名前を変更します。​`to`​ 引数にはパスセパレーターを含めることができません。この前提条件が満たされない場合、FILE:ILLEGAL\_PATH がスローされます。 #### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

名前を変更するファイルへのパス。

x

New Name (新しい名前)

String (文字列)

ファイルの新しい名前。

x

Overwrite (上書き)

Boolean (ブール)

コピー先がすでに存在する場合にファイルを上書きするかどうか。

false

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-7)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-7)スロー - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ### [](#write)Write `` パスで参照されているファイルにコンテンツを書き込みます。 書き込み先のファイルのディレクトリが存在しない場合、操作は createParentDirectory の値に応じて FILE:ILLEGAL\_PATH​ エラーをスローするか、該当のフォルダーを作成します。 ファイル自体がすでに存在している場合、その動作は指定されたモードに応じて異なります。 この操作では、Lock (ロック) 引数の値に応じてロックもサポートされます、ただし、Read 操作で説明されているルールおよび考慮事項と同じものが適用されます。 #### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

書き込まれるファイルのパス。

x

Content (コンテンツ)

Binary (バイナリ)

ファイルに書き込まれるコンテンツ。デフォルトは現在のメッセージペイロードです。

#[payload]

Encoding (エンコード) (廃止)

String (文字列)

このパラメーターは廃止されており、設定しても何も実行されません。

Create Parent Directories (親ディレクトリの作成)

Boolean (ブール)

親ディレクトリが存在しない場合に親ディレクトリを作成するかどうか。

true

Lock (ロック)

Boolean (ブール)

ファイルをロックするかどうか。デフォルトは false です。

false

Write Mode (書き込みモード)

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

  • OVERWRITE

  • APPEND

  • CREATE_NEW

FileWriteMode。デフォルトは OVERWRITE です。

OVERWRITE

Reconnection Strategy (再接続戦略)

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

#### [](#次の設定の場合-8)次の設定の場合 - [デフォルト設定](#config) #### [](#スロー-8)スロー - FILE:ILLEGAL\_CONTENT - FILE:CONNECTIVITY - FILE:ILLEGAL\_PATH - FILE:FILE\_ALREADY\_EXISTS - FILE:RETRY\_EXHAUSTED - FILE:ACCESS\_DENIED ## [](#ソース)ソース ### [](#listener)新しいファイルまたは更新されたファイル `` ディレクトリをポーリングして、作成または更新されたファイルを探します。見つかった各ファイルに 1 つのメッセージが生成されます。 この機能の重要な部分は、ファイルが実際に新規かどうかを判断する方法です。 その戦略を次に示します。 - `autoDelete`​ パラメーターを ​`true`​ に設定する: この方法では各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが必ず新規になります。 - `moveToDirectory`​ パラメーターを設定する: この方法では各ファイルを処理した後で処理済みのファイルを異なるディレクトリに移動するため、​`autoDelete<`​ と同じ効果を得ることができますが、ファイルが失われることはありません。 - watermarkMode パラメーターを使用して、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。 ファイルをさらに絞り込むためにマッチャーを使用することもできます。 #### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory (ディレクトリ)

String (文字列)

ポーリングするファイルを含むディレクトリ。

Recursive (再帰)

Boolean (ブール)

サブディレクトリに含まれるファイルもポーリングするかどうか。

true

Matcher (マッチャー)

マッチャーの条件を満たさないファイルに対するイベントを絞り込むために使用するマッチャー。

Watermark Mode (ウォーターマークモード)

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

  • DISABLED

  • MODIFIED_TIMESTAMP​

  • CREATED_TIMESTAMP

ウォーターマークを設定するかどうかを制御します。設定する場合は、ファイルの変更タイムスタンプを考慮するか、作成タイムスタンプを考慮するかを制御します。

DISABLED

Time Between Size Check (サイズ確認の時間間隔)

Number (数値)

ファイルの読み取り準備ができているかどうかを確認するためのサイズ確認間の待機時間 (ミリ秒)。これにより、ファイルの書き込みが完了してから処理を実行することができます。値を省略してこの機能を無効にできます。有効にした場合、Mule はあるコールから次のコールまでの指定された時間を待機して、2 回のサイズ確認を実行します。この両方の確認で同じ値が返された場合、ファイルの読み取り準備はできています。

Time Between Size Check Unit (サイズ確認の時間間隔の単位)

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

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Time between size check (サイズ確認の時間間隔)]​ の ​[Time unit (時間単位)]​。

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Encoding (エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

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

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

ポーリングをトリガーするスケジューラーを設定します。

x

Streaming Strategy (ストリーミング戦略)

反復可能ストリームを使用すべきかどうか、およびその動作を設定します。

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

Auto Delete (自動削除)

Boolean (ブール)

各ファイルを処理後に削除するかどうか。

false

Move To Directory (ディレクトリに移動)

String (文字列)

指定した場合、処理された各ファイルは、このパスで参照されているディレクトリに移動します。

Rename To (変更後の名前)

String (文字列)

このパラメーターは、​[Move To Directory (ディレクトリに移動)]​ と連携して機能します。このパラメーターを使用して入力した名前でファイルが移動します。moveToDirectory を設定しない場合は、このパラメーターも設定しないでください。

Apply Post Action When Failed (失敗した場合に投稿アクションを適用)

Boolean (ブール)

ファイルの処理に失敗した場合に投稿アクション (​[Auto Delete (自動削除)]​ および ​[Move To Directory (ディレクトリに移動)]​) も適用するかどうか。​false​ に設定すると、失敗したファイルは移動も削除もされません。

true

Overwrite (上書き)

Boolean (ブール)

宛先ファイルの名前が同じ場合に対象ファイルを上書きできます。

false

#### [](#出力-3)出力

型

Binary (バイナリ)

Attributes Type (属性型)

#### [](#次の設定の場合-9)次の設定の場合 - [デフォルト設定](#config) ## [](#型)型 ### [](#Reconnection)Reconnection (再接続)
項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

### [](#reconnect)Reconnect (再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

### [](#reconnect-forever)Reconnect Forever (繰り返し再接続)
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true

### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー)
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Max Idle Time (最大アイドル時間)]​ 属性の時間単位。

### [](#LocalFileAttributes)ローカルファイル属性
項目 型 説明 デフォルト値 必須

Last Modified Time (最終更新時間)

DateTime

x

Last Access Time (最終アクセス時間)

DateTime

x

Creation Time (作成時間)

DateTime

x

Size (サイズ)

Number (数値)

x

Regular File (正規ファイル)

Boolean (ブール)

false

Directory (ディレクトリ)

Boolean (ブール)

false

Symbolic Link (シンボリックリンク)

Boolean (ブール)

false

Path (パス)

String (文字列)

x

File Name (ファイル名)

String (文字列)

x

### [](#matcher)Matcher (マッチャー)
項目 型 説明 デフォルト値 必須

Created Since (指定した日付以降に作成)

DateTime

この日付より前に作成されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Created Until (指定した日付以前に作成)

DateTime

この日付より後に作成されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Updated Since (指定した日付以降に更新)

DateTime

この日付より前に変更されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Updated Until (指定した日付以前に更新)

DateTime

この日付より後に変更されたファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Accessed Since (指定した日付以降にアクセス)

DateTime

最後のアクセスがこの日付より前のファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Accessed Since (指定した日付以前にアクセス)

DateTime

最後のアクセスがこの日付より後のファイルは却下されます。この値でのタイムゾーンの指定は無視され、代わりに Mule サーバーのタイムゾーンが使用されます。

Not Updated In The Last (指定した期間に更新なし)

Number (数値)

ファイルの最終更新後の経過期間がこの期間以上の場合、却下されません。この属性は、​[Time unit (時間単位)]​ と連携して機能します。

Updated In The Last (指定した期間に更新あり)

Number (数値)

ファイルの最終更新後の経過期間がこの期間以内の場合、却下されません。この属性は、​[Time unit (時間単位)]​ と連携して機能します。

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Updated In The Last (指定した期間に更新あり)]​ 属性と ​[Not Updated In The Last (指定した期間に更新なし)]​ 属性の​時間単位​。

MILLISECONDS

Filename Pattern (ファイル名パターン)

String (文字列)

Path Pattern (パスパターン)

String (文字列)

Directories (ディレクトリ)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

ディレクトリを結果に含めるかどうかを制御します。

INCLUDE

Regular Files (正規ファイル)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Sym Links (シンボリックリンク)

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

  • REQUIRE

  • INCLUDE

  • EXCLUDE

INCLUDE

Min Size (最小サイズ)

Number (数値)

Max Size (最大サイズ)

Number (数値)

### [](#repeatable-in-memory-stream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量です。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max In Memory Size (最大メモリ内サイズ)]​ を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。

Max in Memory Size (最大メモリ内サイズ)

Number (数値)

使用するメモリの最大量。指定された最大値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

これらのすべての属性の単位

### [](#repeatable-file-store-stream)Repeatable File Store Stream (反復可能なファイルストアストリーム)
項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

[Max in Memory Size (最大メモリ内サイズ)]​ を表す単位

In Memory Objects (メモリ内オブジェクト)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。指定された以上のメモリがコンシュームされると、ディスクへのコンテンツのバッファが開始されます。

500

### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)
項目 型 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずに​プロセス失敗メッセージ​がトリガーされるまでにメッセージを再配信できる最大回数。

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

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

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

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの ​SHA-256​ になります。

Id Expression (ID 式)

String (文字列)

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

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

ObjectStore

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

### [](#LocalSubsetList)Local Subset List (ローカルサブセットリスト)
項目 型 説明 デフォルト値 必須

Limit (制限)

Number (数値)

0

Offset (オフセット)

Number (数値)

1

Criteria (条件)

Enumeration (列挙)。次のいずれかになります。 ALPHABETICALLY DATE_MODIFIED DATE_CREATED SIZE ** PATH

​DATE_MODIFIED​

Order (順序)

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

DESCENDING

### [](#repeatable-in-memory-iterable)Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)
項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で、メモリ内に保持することが許可されるインスタンスの初期容量です。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ 属性に従って、​[Max in Memory instances (最大メモリ内インスタンス)]​ を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max in Memory instances (最大メモリ内インスタンス)

Number (数値)

使用するメモリインスタンスの最大数。指定された最大値を超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーがスローされます。0 以下の値は無制限を意味します。

### [](#repeatable-file-store-iterable)Repeatable File Store Iterable (反復可能なファイルストアイテラブル)
項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

### [](#time-between-size-check)Time Between Size Check Unit (サイズ確認の時間間隔) パラメーターの動作 ファイルの Write 操作が完了してファイルの読み取りまたはアクセスを行う準備ができるようになるまで時間がかかる可能性があります。操作が未完了のファイルにアクセスしないようにするには、​`timeBetweenSizeCheck`​ パラメーターを使用します。 このパラメーターを設定すると、ファイルのコンテンツにアクセスする前にファイルのサイズが検証されます。 この検証では、​`timeBetweenSizeCheck`​ および ​`timeBetweenSizeCheckUnit`​ パラメーターで指定された時間待機した後にファイルのサイズが変わっていないことを確認します。 その後、​`timeBetweenSizeCheck`​ パラメーターによって、2 回実行される各検証間の待機時間が示されます。ファイルのサイズが両方の時間で変わらない場合、Write 操作が完了し、access 操作を続行できるとみなされます。同じでない場合、例外がスローされます。 実行される待機は、操作を実行しているスレッドが指定の期間スリープすることを示します。この待機は、ファイルのコンテンツを取得した時点で発生します。フローでファイルのコンテンツにアクセスしていない場合、確認は実行されません。
Mule Runtime Engine バージョン 4.1 および 4.2 では、この待機が複数のメッセージプロセッサーで発生する可能性があり、File Connector で待機を実行するスレッドを制御できません。スレッドプールのスレッドは、CPU に負荷がかかるスレッド (この種のタスクを目的とするものではない) でも、待機を実行する可能性があります。
## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector を使用したディレクトリの作成の例 ファイル用 Anypoint Connector (File Connector) の ​**Create directory**​ 操作を使用すれば、特定の名前のディレクトリを作成できます。 ディレクトリを作成する理由がすぐにコンテンツをディレクトリに書き込む、コピーする、または移動することである場合、​**\[Create parent directories (親ディレクトリを作成)\]**​ 項目を ​**TRUE**​ に設定した状態で ​**Write**​、​**Copy**​、または ​**Move**​ 操作を使用してください。 ## [](#studio-で-create-directory-操作を設定する)Studio で Create Directory 操作を設定する Studio で ​**Create directory**​ 操作を追加および設定する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ ビューで「​`file`​」を検索し、​**\[Create directory\]**​ 操作を選択します。 2. **\[Create directory\]**​ 操作を Studio キャンバスにドラッグします。 3. 操作の設定画面の ​**\[General (一般)\]**​ タブで、​**\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックし、グローバル要素設定項目にアクセスします。 4. 接続情報を指定し、​**\[OK\]**​ をクリックします。 5. **\[Directory path (ディレクトリパス)\]**​ を、新しいディレクトリのパス名に設定します (例: `~/newFolder`​)。 ![Studio の Create directory 操作の設定](/mulesoft/current/ja-jp/file-connector/latest/_images/file-create-directory-operation.png) **設定 XML**​ エディターでは、​``​ 設定は次のように記述されます。 ```xml ``` ## [](#関連情報)関連情報 - [File Connector の例](https://docs.mulesoft.com/jp/file-connector/latest/file-examples) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # File Connector を使用したファイルのリストの作成 `List`​ 操作を使用して、​`directoryPath`​ パラメーターで示されるパスにあるファイルとフォルダーのリストを作成します。​`List`​ 操作は、次の状態のメッセージの配列を返します。 - 各メッセージがそのペイロードでファイルのコンテンツを保持している。 - ファイルの属性セクションにファイルのメタデータ (名前、作成時間、サイズなど) が含まれている。 - 要素がフォルダーの場合、ペイロードが空である。 `List`​ 操作には ​`directoryPath`​ パラメーターが必要です。このパラメーターは、ディレクトリのフルパスを指定しない場合、リストを作成するディレクトリの相対パスを表します。パスは、​`config-ref`​ パラメーターによって参照される設定で定義された作業ディレクトリの値に対して相対的です。設定が参照されていない場合、作業ディレクトリはデフォルトで ​`user.home`​ システムプロパティの値に設定されます。システムプロパティが設定されていない場合、コネクタは初期化に失敗します。 設定の定義の例については、​[「ファイル接続設定」](https://docs.mulesoft.com/jp/file-connector/1.3/#connection_settings)​を参照してください。 ファイル設定を参照することで相対パスを使用する ​`List`​ の例を次に示します。 ```xml ``` 前述のように、これはメッセージの配列を返します。Anypoint Studio では、DataSense に操作の出力のメタデータが表示されます。 ![list output](/mulesoft/current/ja-jp/file-connector/1.3/_images/list-output.png)

List​ 操作はディレクトリとファイル両方のリストを作成しますが、ファイルの場合、ペイロード内のファイルのコンテンツの遅延ストリームも返されます。これを他の操作で直接コンシュームできます。つまり、ファイルのコンテンツにアクセスするために、​List​ 操作の後に ​Read​ 操作を実行する必要はありません。例については、​「リストで返されるファイルの読み取り」​を参照してください。

## [](#リストで返されるファイルの読み取り)リストで返されるファイルの読み取り 次の例は、​`directoryPath`​ 内のすべてのファイルとフォルダーのリストを ​`foreach`​ ループで作成します。 ```xml ``` `foreach`​ ループは、​`choice`​ コンポーネントで各要素がファイルであるかフォルダーであるかを判断します。 要素がファイルの場合、​[Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference)​ でそのパスとコンテンツが出力されます。要素がディレクトリの場合、別のフローに送信されて処理されます。 前述のように、​`List`​ 操作はすでに (遅延方法で) ペイロード内のファイルのコンテンツを返しているため、​`foreach`​ ループ内に ​`Read`​ 操作はありません。そのため、ストリームが最後にコンシュームされないときにパフォーマンスやオーバーヘッドを心配する必要はありません。 ## [](#サブフォルダー内のファイルとフォルダーのリストの作成)サブフォルダー内のファイルとフォルダーのリストの作成 `directoryPath`​ のサブフォルダー内のファイルまたはフォルダーのリスト (再帰的リストなど) を作成するには、​`recursive`​ パラメーターを ​`true`​ に設定します。 ```xml ``` ## [](#一致条件でのファイルの絞り込み)一致条件でのファイルの絞り込み ``​ 要素を使用して、ファイルの受け入れまたは却下で使用する一致条件に基づいて、ファイルを絞り込むことができます。使用できるファイル一致ルールの例を次に示します。 例: ファイルマッチャー ```xml ``` 上記のすべての属性は省略可能であり、提供されていない場合は無視されます。これらはすべて ​`AND`​ 操作の下で相互に関連します。 ### [](#最上位の再利用可能なマッチャー)最上位の再利用可能なマッチャー ファイルマッチャーは、次の例に示すように再利用可能な要素 (名前付きの最上位要素) にすることができます。 次に例を示します。 ```xml ... ``` ### [](#内部要素再利用できないマッチャー)内部要素、再利用できないマッチャー マッチャーは、次の例に示すように特定のコンポーネント専用の (再利用できない) 内部要素にすることができます。 ```xml ... ``` ## [](#time-between-size-checks-サイズ確認の時間間隔-パラメーター)Time Between Size Checks (サイズ確認の時間間隔) パラメーター `List`​ 操作で返されるファイルのコンテンツを読み取り、ファイルがまだ書き込み中であるか不明な場合は、​`TimeBetweenSizeChecks`​ パラメーターを使用できます。このパラメーターは、​`TimeBetweenSizeCheckUnit`​ パラメーターと連携します。この 2 つのパラメーターの組み合わせで、2 つのサイズ確認が実行されます。 - 1 つは、ストリームがコンシュームされるポイントにフローが到達したとき。​`List`​ はファイルのコンテンツを参照する遅延ストリームを返すため、​`List`​ 操作では時間の確認は行われません。そのため、ストリームがコンシュームされるときにのみサイズ確認を行うことが理にかなっています。 - もう 1 つの確認は、​`TimeBetweenSizeChecks`​ および ​`TimeBetweenSizeCheckUnit`​ パラメーターで設定された待機時間後に実行。 この両方のサイズ確認で同じファイルサイズが返された場合、ストリームは正常にコンシュームされています。2 つのサイズ確認で異なるファイルサイズが返された場合、ファイルはまだ書き込み中であるため、ストリームはコンシュームされず、操作はエラーで失敗します。 ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。 ## [](#関連情報)関連情報 [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/1.3/file-documentation)​
​[foreach ループ](https://docs.mulesoft.com/mule-runtime/latest/for-each-scope-concept)​
​[Choice コンポーネント](https://docs.mulesoft.com/mule-runtime/latest/choice-router-concept) # File Connector を使用したファイルのリストの作成 `List`​ 操作を使用して、​`directoryPath`​ パラメーターで示されるパスにあるファイルとフォルダーのリストを作成します。​`List`​ 操作は、次の状態のメッセージの配列を返します。 - 各メッセージがそのペイロードでファイルコンテンツを保持している。 - ファイルのメッセージ属性セクションにファイルのメタデータ (名前、作成時間、サイズなど) が含まれている。 - 要素がフォルダーの場合、ペイロードが空である。 `List`​ 操作には ​`directoryPath`​ パラメーターが必要です。このパラメーターは、ディレクトリのフルパスを指定しない場合、リストを作成するディレクトリの相対パスを表します。パスは、​`config-ref`​ パラメーターによって参照される設定で定義された作業ディレクトリの値に対して相対的です。設定が参照されていない場合、作業ディレクトリはデフォルトで ​`user.home`​ システムプロパティの値に設定されます。システムプロパティが設定されていない場合、コネクタは初期化に失敗します。 設定の定義の例については、​[「ファイル接続設定」](https://docs.mulesoft.com/jp/file-connector/latest/#connection_settings)​を参照してください。 ファイル設定を参照することで相対パスを使用する ​`List`​ の例を次に示します。 ```xml ``` 前述のように、これはメッセージの配列を返します。Anypoint Studio では、DataSense に操作の出力のメタデータが表示されます。 ![list output](/mulesoft/current/ja-jp/file-connector/latest/_images/list-output.png)

List​ 操作はディレクトリとファイル両方のリストを作成しますが、ファイルの場合、ペイロード内のファイルのコンテンツの遅延ストリームも返されます。これを他の操作で直接コンシュームできます。つまり、ファイルのコンテンツにアクセスするために、​List​ 操作の後に ​Read​ 操作を実行する必要はありません。例については、​「リストで返されるファイルの読み取り」​を参照してください。

## [](#read-files-returned)リストで返されるファイルの読み取り 次の例は、​`directoryPath`​ 内のすべてのファイルとフォルダーのリストを ​`foreach`​ ループで作成します。 ```xml ``` `foreach`​ ループは、​`choice`​ コンポーネントで各要素がファイルであるかフォルダーであるかを判断します。 要素がファイルの場合、​[Logger](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference)​ でそのパスとコンテンツが出力されます。要素がディレクトリの場合、別のフローに送信されて処理されます。 前述のように、​`List`​ 操作はすでに (遅延方法で) ペイロード内のファイルのコンテンツを返しているため、​`foreach`​ ループ内に ​`Read`​ 操作はありません。そのため、ストリームが最後にコンシュームされないときにパフォーマンスやオーバーヘッドを心配する必要はありません。 ## [](#サブフォルダー内のファイルとフォルダーのリストの作成)サブフォルダー内のファイルとフォルダーのリストの作成 `directoryPath`​ のサブフォルダー内のファイルまたはフォルダーのリスト (再帰的リストなど) を作成するには、​`recursive`​ パラメーターを ​`true`​ に設定します。 ```xml ``` ## [](#file-matcher)一致条件でのファイルの絞り込み ``​ 要素を使用して、ファイルの受け入れまたは却下で使用する一致条件に基づいて、ファイルを絞り込むことができます。使用できるファイル一致ルールの例を次に示します。 例: ファイルマッチャー ```xml ``` 上記のすべての属性は省略可能であり、提供されていない場合は無視されます。これらはすべて ​`AND`​ 操作の下で相互に関連します。 ### [](#最上位の再利用可能なマッチャー)最上位の再利用可能なマッチャー ファイルマッチャーは、次の例に示すように再利用可能な要素 (名前付きの最上位要素) にすることができます。 次に例を示します。 ```xml ... ``` ### [](#内部要素再利用できないマッチャー)内部要素、再利用できないマッチャー マッチャーは、次の例に示すように特定のコンポーネント専用の (再利用できない) 内部要素にすることができます。 ```xml ... ``` ## [](#time-between-size-checks)Time Between Size Checks (サイズ確認の時間間隔) パラメーター `List`​ 操作で返されるファイルのコンテンツを読み取り、ファイルがまだ書き込み中であるか不明な場合は、​`TimeBetweenSizeChecks`​ パラメーターを使用できます。このパラメーターは、​`TimeBetweenSizeCheckUnit`​ パラメーターと連携します。この 2 つのパラメーターの組み合わせで、2 つのサイズ確認が実行されます。 - 1 つは、ストリームがコンシュームされるポイントにフローが到達したとき。​`List`​ はファイルコンテンツを参照する遅延ストリームを返すため、​`List`​ 操作では時間の確認は行われません。そのため、ストリームがコンシュームされるときにのみサイズ確認を行うことが理にかなっています。 - もう 1 つの確認は、​`TimeBetweenSizeChecks`​ および ​`TimeBetweenSizeCheckUnit`​ パラメーターで設定された待機時間後に実行。 この両方のサイズ確認で同じファイルサイズが返された場合、ストリームは正常にコンシュームされています。2 つのサイズ確認で異なるファイルサイズが返された場合、ファイルはまだ書き込み中であるため、ストリームはコンシュームされず、操作はエラーで失敗します。 ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。 ## [](#limit-sort)返されるファイルの数の制限と並び替え **List**​ 操作の ​**\[Advanced (詳細)\]**​ 設定タブで、返されるファイルの数を制限してからファイルを並び替えるように ​**\[Subset (サブセット)\]**​ 項目を設定できます。\[Limit (制限)\] および \[Offset (オフセット)\] 属性は省略可能です。 ![List 操作の \[Subset (サブセット)\] 設定画面](_images/file-connector-subset.png) **設定 XML**​ エディターでは、​``​ 設定は次のように記述されます。 ```xml ``` ## [](#関連情報)関連情報 [File Connector リファレンス](https://docs.mulesoft.com/jp/file-connector/latest/file-documentation)​ ​[foreach ループ](https://docs.mulesoft.com/mule-runtime/latest/for-each-scope-concept)​ ​[Choice コンポーネント](https://docs.mulesoft.com/mule-runtime/latest/choice-router-concept) # File Connector を使用したファイルの読み取り ファイル用 Anypoint Connector (File Connector) を使用すると、トランスポートは Mule 3 実装でのインバウンドエンドポイントポーリングの結果としてのみでなく、フローの任意の時点でファイルを読み取ることができます。 `Read`​ 操作で必須のパラメーターは、読み取られるファイルへのパスのみです。パスには、ファイルへのフルパスまたは相対パスを指定できます。パスは、​`config-ref`​ パラメーターによって参照される設定で定義された作業ディレクトリの値を使用します。Anypoint Studio では、​**\[File path (ファイルパス)\]**​ 項目でパスを設定できます。XML では、​` ``` 次の例は、フルパスを使用してファイルを読み取ります。 ```xml ``` Studio では、参照ボタン (…​) をクリックして次のようなファイルを見つけます。 `/Users/me/myfile` XML では、​**path**​ 属性を使用して次のようなファイルへのパスを指定します。 `` ## [](#返される情報)返される情報 `Read`​ 操作は、次の情報を含むメッセージを返します。 - ペイロードとしてのファイルのコンテンツ - メッセージ属性のファイルのメタデータ、メッセージ属性のメタデータ (名前、作成時間、サイズなど)。 ファイルが存在しない場合、​`Read`​ 操作は ​`FILE:ILLEGAL_PATH`​ エラーをスローします。この操作では、ディレクトリを読み取りません。

Read​ 操作は (non-void 値を返す他の操作と同様)、対象パラメーターをサポートしています。 「Mule 対象変数」​を参照してください。

## [](#相対パスの設定)相対パスの設定 同じ Mule アプリケーションで多数の ​`Read`​ 操作 (またはその他のファイル操作) がパスの一部を共有している場合、ベースパスを​[ファイル設定](https://docs.mulesoft.com/jp/file-connector/1.3/#connection_settings)​に抽出して容易に再利用できます。 たとえば、フルパスが ​`/Users/Documents/Examples/manual.txt`​ と ​`/Users/Documents/Examples/readme.txt`​ の 2 つのファイルにアクセスするには、次のように設定でパスの同じ部分を定義します。 ```xml ``` この設定を参照する ​`Read`​ 操作は次のようになります。 ```xml ``` ## [](#mime-タイプおよび文字コード)MIME タイプおよび文字コード 各コネクタはファイルの MIME タイプをその拡張子から判別しようとします。​**MIME Type (MIME タイプ)**​ (​`outputMimeType`​) パラメーターを使用して強制的に MIME タイプを別の値に変更できます。 同じプロセスが文字コードでも機能します。デフォルトでは、コネクタは、Mule Runtime のデフォルトの文字コードがファイルの MIME タイプに一致するものとみなします。ただし、文字コードは ​**Encoding (エンコード)**​ (​`outputEncoding`​) パラメーターで設定できます。 ## [](#mime-タイプが重要な理由)MIME タイプが重要な理由 ペイロードと他の値を生成する操作内に DataWeave 式を埋め込むことができます。適切な MIME タイプを設定することで、DataWeave は型を自動で割り当てることができるほか、適切な出力を生成できます。また、DataSense の機能を最大限活用することで、ユーザーエクスペリエンスが向上します。 ## [](#mule-アプリケーションで定義されてファイルへのアクセス)Mule アプリケーションで定義されてファイルへのアクセス Mule アプリケーションの開発中、フォルダーとファイルを ​`resources`​ フォルダーに保存できます。アプリケーションがデプロイされると、それらのフォルダーとファイルは ​`${app.home}`​ プロパティで定義されたディレクトリにコピーされます。 たとえば、​`resources`​ フォルダー内に ​`MyFiles`​ という名前のフォルダーを定義し、​`MyFiles`​ フォルダー内に ​`Example.txt`​ という名前のファイルを定義する場合、次のプロジェクト構造を使用します。 ![project resources](/mulesoft/current/ja-jp/file-connector/1.3/_images/project-resources.png) ランタイムでは、ファイルにアクセスするパスは ​`${app.home}/MyFiles/Example.txt`​ です。 ファイルを読み取るには、次の設定を定義します。 ```xml ``` `Read`​ 操作を次のように設定します。 ```xml ```
前述のように、アプリケーションがデプロイされるたびに、​src/main/resources​ フォルダーの内容は ​${app.home}​ ディレクトリにコピーされ、実行中にこれらのファイルに加えられた変更は、アプリケーションが停止または再デプロイされると失われます。そのため、アプリケーションの実行中に読み取る必要があるファイルのみを ​resource​ フォルダーに置くことをお勧めします。
## [](#ファイルロック)ファイルロック `lock`​ パラメーターを ​`true`​ に設定することで、ファイルの読み取り中に他のプロセスがそのファイルにアクセスするのを防ぐことができます。ただし、これはホストのファイルシステムにより提供されるため、ロックの動作は、マウントされたドライブと、Mule が実行されているオペレーティングシステムに応じて変わる可能性があります。このロックに依存する前に以上の点を考慮してください。 ファイルが他のユーザーによりすでにロックされている場合、コネクタはファイルをロックできず、操作で ​`FILE:FILE_LOCK`​ エラーがスローされます。 次のいずれかの状況が発生した場合、ロックは自動的にリリースされます。 - ファイルをロックしていた Mule フローが終了した。 - ファイルのコンテンツが完全に読み取られた。 次に、ロックの例を示します。 ```xml ``` ## [](#出力-mime-タイプおよびエンコードの変更)出力 MIME タイプおよびエンコードの変更 `outputEncoding`​ および ​`outputMimeType`​ パラメーターを使用して、​`Read`​ 操作が出力する MIME タイプまたはエンコードを変更できます。これはファイルのコンテンツは変換せず、MIME タイプまたはエンコード情報を上書きするだけです。次に例を示します。 ```xml ``` ## [](#time-between-size-checks-サイズ確認の時間間隔-パラメーター)Time Between Size Checks (サイズ確認の時間間隔) パラメーター `Read`​ 操作で返されるファイルのコンテンツを読み取り、ファイルがまだ書き込み中であるか不明な場合は、​`TimeBetweenSizeChecks`​ パラメーターを使用できます。このパラメーターは、​`TimeBetweenSizeCheckUnit`​ パラメーターと連携します。この 2 つのパラメーターの組み合わせで、2 つのサイズ確認が実行されます。 - 1 つは、ストリームがコンシュームされるポイントにフローが到達したとき。​`Read`​ はファイルのコンテンツを参照する遅延ストリームを返すため、​`Read`​ 操作では時間の確認は行われません。そのため、ストリームがコンシュームされるときにのみサイズ確認を行うことが理にかなっています。 - もう 1 つの確認は、​`TimeBetweenSizeChecks`​ および ​`TimeBetweenSizeCheckUnit`​ パラメーターで設定された待機時間後に実行。 この両方のサイズ確認で同じファイルサイズが返された場合、ストリームは正常にコンシュームされています。2 つのサイズ確認で異なるファイルサイズが返された場合、ファイルはまだ書き込み中であるため、ストリームはコンシュームされず、操作はエラーで失敗します。 サイズ確認パラメーターを含む ​`Read`​ 操作を使用して、​[Logger コンポーネント](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference)​で出力ストリームをコンシュームできます。 ```xml ``` 15 秒の確認は、​`Read`​ 操作時ではなく ​`logger`​ コンポーネントの実行時に行われます。 ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。 # File Connector を使用したファイルの読み取り ファイル用 Anypoint Connector (File Connector) を使用すると、トランスポートは Mule 3 実装でのインバウンドエンドポイントポーリングの結果としてのみでなく、フローの任意の時点でファイルを読み取ることができます。 `Read`​ 操作で必須のパラメーターは、読み取られるファイルへのパスのみです。パスには、ファイルへのフルパスまたは相対パスを指定できます。パスは、​`config-ref`​ パラメーターによって参照される設定で定義された作業ディレクトリの値を使用します。Anypoint Studio では、​**\[File path (ファイルパス)\]**​ 項目でパスを設定できます。XML では、​` ``` 次の例は、フルパスを使用してファイルを読み取ります。 ```xml ``` Studio では、参照ボタン (…​) をクリックして次のようなファイルを見つけます。 `/Users/me/myfile` XML では、​**path**​ 属性を使用して次のようなファイルへのパスを指定します。 `` ## [](#返される情報)返される情報 `Read`​ 操作は、次の情報を含むメッセージを返します。 - ペイロードとしてのファイルコンテンツ - メッセージ属性のファイルのメタデータ、メッセージ属性のメタデータ (名前、作成時間、サイズなど)。 ファイルが存在しない場合、​`Read`​ 操作は ​`FILE:ILLEGAL_PATH`​ エラーをスローします。この操作では、ディレクトリを読み取りません。

Read​ 操作は (non-void 値を返す他の操作と同様)、対象パラメーターをサポートしています。 「Mule 対象変数」​を参照してください。

## [](#相対パスの設定)相対パスの設定 同じ Mule アプリケーションで多数の ​`Read`​ 操作 (またはその他のファイル操作) がパスの一部を共有している場合、ベースパスを​[ファイル設定](https://docs.mulesoft.com/jp/file-connector/latest/#connection_settings)​に抽出して容易に再利用できます。 たとえば、フルパスが ​`/Users/Documents/Examples/manual.txt`​ と ​`/Users/Documents/Examples/readme.txt`​ の 2 つのファイルにアクセスするには、次のように設定でパスの同じ部分を定義します。 ```xml ``` この設定を参照する ​`Read`​ 操作は次のようになります。 ```xml ``` ## [](#mime-タイプおよび文字コード)MIME タイプおよび文字コード 各コネクタはファイルの MIME タイプをその拡張子から判別しようとします。​**MIME Type (MIME タイプ)**​ (​`outputMimeType`​) パラメーターを使用して強制的に MIME タイプを別の値に変更できます。 同じプロセスが文字コードでも機能します。デフォルトでは、コネクタは、Mule Runtime のデフォルトの文字コードがファイルの MIME タイプに一致するものとみなします。ただし、文字コードは ​**Encoding (エンコード)**​ (​`outputEncoding`​) パラメーターで設定できます。 ## [](#mime-タイプが重要な理由)MIME タイプが重要な理由 ペイロードと他の値を生成する操作内に DataWeave 式を埋め込むことができます。適切な MIME タイプを設定することで、DataWeave は型を自動で割り当てることができるほか、適切な出力を生成できます。また、DataSense の機能を最大限活用することで、ユーザーエクスペリエンスが向上します。 ## [](#mule-アプリケーションで定義されてファイルへのアクセス)Mule アプリケーションで定義されてファイルへのアクセス Mule アプリケーションの開発中、フォルダーとファイルを ​`resources`​ フォルダーに保存できます。アプリケーションがデプロイされると、それらのフォルダーとファイルは ​`${app.home}`​ プロパティで定義されたディレクトリにコピーされます。 たとえば、​`resources`​ フォルダー内に ​`MyFiles`​ という名前のフォルダーを定義し、​`MyFiles`​ フォルダー内に ​`Example.txt`​ という名前のファイルを定義する場合、次のプロジェクト構造を使用します。 ![project resources](/mulesoft/current/ja-jp/file-connector/latest/_images/project-resources.png) ランタイムでは、ファイルにアクセスするパスは ​`${app.home}/MyFiles/Example.txt`​ です。 ファイルを読み取るには、次の設定を定義します。 ```xml ``` `Read`​ 操作を次のように設定します。 ```xml ```
前述のように、アプリケーションがデプロイされるたびに、​src/main/resources​ フォルダーのコンテンツは ​${app.home}​ ディレクトリにコピーされ、実行中にこれらのファイルに加えられた変更は、アプリケーションが停止または再デプロイされると失われます。そのため、アプリケーションの実行中に読み取る必要があるファイルのみを ​resource​ フォルダーに置くことをお勧めします。
## [](#ファイルロック)ファイルロック `lock`​ パラメーターを ​`true`​ に設定することで、ファイルの読み取り中に他のプロセスがそのファイルにアクセスするのを防ぐことができます。ただし、これはホストのファイルシステムにより提供されるため、ロックの動作は、マウントされたドライブと、Mule が実行されているオペレーティングシステムに応じて変わる可能性があります。このロックに依存する前に以上の点を考慮してください。 ファイルが他のユーザーによりすでにロックされている場合、コネクタはファイルをロックできず、操作で ​`FILE:FILE_LOCK`​ エラーがスローされます。 次のいずれかの状況が発生した場合、ロックは自動的にリリースされます。 - ファイルをロックしていた Mule フローが終了した。 - ファイルコンテンツが完全に読み取られた。 次に、ロックの例を示します。 ```xml ``` ## [](#出力-mime-タイプおよびエンコードの変更)出力 MIME タイプおよびエンコードの変更 `outputEncoding`​ および ​`outputMimeType`​ パラメーターを使用して、​`Read`​ 操作が出力する MIME タイプまたはエンコードを変更できます。これはファイルコンテンツは変換せず、MIME タイプまたはエンコード情報を上書きするだけです。次に例を示します。 ```xml ``` ## [](#time-between-size-checks-サイズ確認の時間間隔-パラメーター)Time Between Size Checks (サイズ確認の時間間隔) パラメーター `Read`​ 操作で返されるファイルコンテンツを読み取り、ファイルがまだ書き込み中であるか不明な場合は、​`TimeBetweenSizeChecks`​ パラメーターを使用できます。このパラメーターは、​`TimeBetweenSizeCheckUnit`​ パラメーターと連携します。この 2 つのパラメーターの組み合わせで、2 つのサイズ確認が実行されます。 - 1 つは、ストリームがコンシュームされるポイントにフローが到達したとき。​`Read`​ はファイルコンテンツを参照する遅延ストリームを返すため、​`Read`​ 操作では時間の確認は行われません。そのため、ストリームがコンシュームされるときにのみサイズ確認を行うことが理にかなっています。 - もう 1 つの確認は、​`TimeBetweenSizeChecks`​ および ​`TimeBetweenSizeCheckUnit`​ パラメーターで設定された待機時間後に実行。 この両方のサイズ確認で同じファイルサイズが返された場合、ストリームは正常にコンシュームされています。2 つのサイズ確認で異なるファイルサイズが返された場合、ファイルはまだ書き込み中であるため、ストリームはコンシュームされず、操作はエラーで失敗します。 サイズ確認パラメーターを含む ​`Read`​ 操作を使用して、​[Logger コンポーネント](https://docs.mulesoft.com/mule-runtime/latest/logger-component-reference)​で出力ストリームをコンシュームできます。 ```xml ``` 15 秒の確認は、​`Read`​ 操作時ではなく ​`logger`​ コンポーネントの実行時に行われます。 ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。 # File Connector を使用してファイルを書き込む方法 Write 操作はファイル、FTP、および SFTP Connector で使用できます。これらのコネクタでは、この操作によりコンテンツが特定のパスにオンデマンドで書き込まれます。サポートされる一般的なユースケースを次に示します。 ## [](#埋め込み-dataweave-変換)埋め込み DataWeave 変換 デフォルトでは、コネクタはメッセージペイロードに含まれるものをすべて書き込みます。 例: File Connector ```xml ``` ただし、ペイロードの形式が異なる (CSV ではないなど) ため、書き込む前に形式を変換する必要がある場合はどうしますか? Write 操作の前に Transform コンポーネントを配置した場合、メッセージペイロードが変更され、Write 操作の後に配置した操作に影響します。 この望ましくない影響を回避するには、変換を Write 操作の内部に配置して、送信中のメッセージに副次的影響を生じずに、書き込まれるコンテンツを生成できます。 次の例では、File Connector を使用してコンテンツを書き込みます。 例: ファイルの Write 操作内での変換 ```xml #[%dw 2.0 output application/csv --- payload.customers.email ] ``` ## [](#ディレクトリへの書き込み)ディレクトリへの書き込み 以下の例の ​`a`​、​`b`​、または ​`c`​ ディレクトリのいずれかが存在しない場合、デフォルトでは Write 操作は失敗します。ただし、​`createParentDirectories`​ を ​`true`​ に設定した場合、コネクタは、欠落しているディレクトリを自動的に作成します。 例: File Connector によるディレクトリへの書き込み ```xml ``` ## [](#既存のファイルへの書き込み)既存のファイルへの書き込み コンテンツをファイルの書き込む場合、​**\[Write Mode (書き込みモード)\]**​ を次のいずれかのモードに設定します。 - **OVERWRITE (デフォルト)**​ ファイルが存在する場合、ファイルを完全に上書きします。 - **APPEND**​ ファイルが存在する場合、コンテンツを既存のファイルの最後に追加します。 - **CREATE\_NEW**​ 新しいファイルを作成します。ファイルがすでに存在する場合、エラーになります。 ## [](#ロック)ロック **Write**​ 操作では、​**Read**​ 操作に似たロックがサポートされます。主な違いは、​**Write**​ 操作の終了後にロックが自動的にリリースされることです。​**\[Lock (ロック)\]**​ を次のいずれかのモードに設定します。 - **TRUE** - **FALSE (デフォルト)** # File Connector を使用してファイルを書き込む方法 Write 操作はファイル、FTP、および SFTP Connector で使用できます。これらのコネクタでは、この操作によりコンテンツが特定のパスにオンデマンドで書き込まれます。サポートされる一般的なユースケースを次に示します。 ## [](#埋め込み-dataweave-変換)埋め込み DataWeave 変換 デフォルトでは、コネクタはメッセージペイロードに含まれるものをすべて書き込みます。 例: File Connector ```xml ``` ただし、ペイロードの形式が異なる (CSV ではないなど) ため、書き込む前に形式を変換する必要がある場合はどうしますか? Write 操作の前に Transform コンポーネントを配置した場合、メッセージペイロードが変更され、Write 操作の後に配置した操作に影響します。 この望ましくない影響を回避するには、変換を Write 操作の内部に配置して、送信中のメッセージに副次的影響を生じずに、書き込まれるコンテンツを生成できます。 次の例では、File Connector を使用してコンテンツを書き込みます。 例: ファイルの Write 操作内での変換 ```xml #[%dw 2.0 output application/csv --- payload.customers.email ] ``` ## [](#ディレクトリへの書き込み)ディレクトリへの書き込み 以下の例の ​`a`​、​`b`​、または ​`c`​ ディレクトリのいずれかが存在しない場合、デフォルトでは Write 操作は失敗します。ただし、​`createParentDirectories`​ を ​`true`​ に設定した場合、コネクタは、欠落しているディレクトリを自動的に作成します。 例: File Connector によるディレクトリへの書き込み ```xml ``` ## [](#既存のファイルへの書き込み)既存のファイルへの書き込み コンテンツをファイルに書き込む場合、​**\[Write Mode (書き込みモード)\]**​ を次のいずれかのモードに設定します。 - **OVERWRITE (デフォルト)**​ ファイルが存在する場合、ファイルを完全に上書きします。 - **APPEND**​ ファイルが存在する場合、コンテンツを既存のファイルの最後に追加します。 - **CREATE\_NEW**​ 新しいファイルを作成します。ファイルがすでに存在する場合、エラーになります。 ## [](#ロック)ロック **Write**​ 操作では、​**Read**​ 操作に似たロックがサポートされます。主な違いは、​**Write**​ 操作の終了後にロックが自動的にリリースされることです。​**\[Lock (ロック)\]**​ を次のいずれかのモードに設定します。 - **TRUE** - **FALSE (デフォルト)** # ファイルのコピーと移動 File Connector は、ファイルやディレクトリをオンデマンドでコピーまたは移動できます。​`sourcePath`​ をディレクトリ名として指定すると、ディレクトリがコピーまたは移動されます。そうでない場合、​`sourcePath`​ がファイルだと、ファイルのみがコピーまたは移動されます。 ファイルまたはディレクトリがすでに存在していて、​`overwrite`​ が ​`false`​ の場合、​`FILE:FILE_ALREADY_EXISTS`​ エラーが発生します。 例: Copy および Move 操作 ```xml ``` `targetPath`​ および ​`renameTo`​ パラメーターに注意してください。 - `targetPath`​ - ファイルのコピー先または移動先のディレクトリの名前。このパスはディレクトリを参照する必要があります。​`targetPath`​ が存在せず、その親も存在しない場合には、​`createParentDirectories`​ 引数の値に応じて作成が試行されます。​`createParentDirectories`​ が ​`false`​ の場合、​`FILE:ILLEGAL_PATH`​ が発生します。 - `renameTo`​ - 操作の一環としてファイル名を変更する省略可能なパラメーター。このパラメーターはパスではなくファイル名である必要があります。この属性を指定しない場合、元のファイル名が保持されます。 ## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # ファイルのコピーと移動 ファイル用 Anypoint Connector (File Connector) には、必要に応じてファイルまたはディレクトリをコピーまたは移動できる ​**Copy**​ および ​**Move**​ 操作が用意されています。 - **Source path (ソースパス)**​ コピーまたは移動するディレクトリパス名またはファイル名。ファイルまたはディレクトリがすでに存在していて、​**\[Overwrite (上書き)\]**​ 項目が ​`false`​ に設定されている場合、コネクタでメッセージ ​`FILE:FILE_ALREADY_EXISTS`​ がスローされます。 - **Target path (対象パス)**​ ファイルのコピー先または移動先となるディレクトリパス名。対象パスが存在せず、その親も存在しない場合には、​**\[Create parent directories (親ディレクトリの作成)\]**​ 引数の値に応じてパスの作成が試行されます。​**\[Create parent directories (親ディレクトリの作成)\]**​ が ​`false`​ の場合、​`FILE:ILLEGAL_PATH`​ が発生します。 - **Rename to (変更後の名前)**​ 操作の一環としてファイル名を変更します。パスではなくファイル名を使用してこの項目を設定します。この項目を設定しない場合、元のファイル名が保持されます。 ## [](#studio-で-copy-操作を設定する)Studio で Copy 操作を設定する 1. **\[Mule Palette (Mule パレット)\]**​ ビューで「​`file`​」を検索し、​**\[Copy\]**​ 操作を選択します。 2. **\[Copy\]**​ 操作を Studio キャンバスにドラッグします。 3. 操作の設定画面の ​**\[General (一般)\]**​ タブで、​**\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックし、グローバル要素設定項目にアクセスします。 4. 接続情報を指定し、​**\[OK\]**​ をクリックします。 5. **\[Source path (ソースパス)\]**​ を、コピーするファイルのパスに設定します (例: `Documents/source-folder/file.txt`​)。 6. **\[Target path (対象パス)\]**​ を、ファイルのコピー先となるディレクトリパスに設定します (例: `Documents/target-folder`​)。 7. **\[Rename To (変更後の名前)\]**​ を設定して、操作の一環としてファイル名を変更します (例: `renamed.txt`​)。 この項目はパスではなくファイル名である必要があります。この属性を指定しない場合、元のファイル名が使用されます。 ![Studio の Copy 操作の設定](/mulesoft/current/ja-jp/file-connector/latest/_images/file-copy-operation.png) **設定 XML**​ エディターでは、​``​ 設定は次のように記述されます。 ```xml ``` ## [](#studio-で-move-操作を設定する)Studio で Move 操作を設定する Studio で ​**Move**​ 操作を追加および設定する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ ビューで「​`ftp`​」を検索し、​**\[Move\]**​ 操作を選択します。 2. **\[Move\]**​ 操作を Studio キャンバスにドラッグします。 3. 操作の設定画面の ​**\[General (一般)\]**​ タブで、​**\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックし、グローバル要素設定項目にアクセスします。 4. 接続情報を指定し、​**\[OK\]**​ をクリックします。 5. **\[Source path (ソースパス)\]**​ を、移動するファイルのパスに設定します (例: `source.txt`​)。 6. **\[Target path (対象パス)\]**​ を、ファイルの移動先となるディレクトリパスに設定します (例: `backup`​)。 7. **\[Rename To (変更後の名前)\]**​ を設定して、操作の一環としてファイル名を変更します (例: `renamed.txt`​)。 この項目はパスではなくファイル名である必要があります。この属性を指定しない場合、元のファイル名が使用されます。 ![Studio の Move 操作の設定](/mulesoft/current/ja-jp/file-connector/latest/_images/file-move-operation.png) **設定 XML**​ エディターでは、​``​ 設定は次のように記述されます。 ```xml ``` ## [](#関連情報)関連情報 - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # 新規ファイルの作成時またはファイルの変更時にフローをトリガーする方法 ファイル、FTP、および SFTP 用 Anypoint Connector では、ディレクトリをポーリングして、作成または更新されたファイルがないかどうかを確認する ​**On New or Updated File**​ 操作が提供されます。見つかったファイルごとにメッセージが生成されます。 次の戦略は、ファイルが新規かどうかを判断します。 - **\[Auto Delete (自動削除)\]**​ 項目を ​**True**​ に設定する: この方法では、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが新規とみなされます。 - **\[Move To Directory (ディレクトリに移動)\]**​ 項目を設定する: この方法では、各ファイルを処理した後で処理済みのファイルを異なるディレクトリに移動するため、​**\[Auto Delete (自動削除)\]**​ と同じ効果を得ることができますが、ファイルが消去されることはありません。 - **\[Watermark (ウォーターマーク)\]**​ 項目を設定する: この方法では、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。 ファイルをさらに絞り込むためにマッチャーを使用することもできます。 例: ファイルリスナー (新規ファイルトリガー) ```xml ``` ## [](#ウォーターマーク)ウォーターマーク File Connector では、ウォーターマーク戦略を ​`CREATION_TIMESTAMP`​ または ​`MODIFIED_TIMESTAMP`​ の 2 つの異なるモードで使用できます。戦略は、ファイルの絞り込みを作成時間に基づいて実行するか、変更時間に基づいて実行するかによって異なります。 例: ファイルリスナーを使用したウォーターマーク ```xml ``` ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。 # 新規ファイルの作成時またはファイルの変更時にフローをトリガーする方法 ファイル、FTP、および SFTP 用 Anypoint Connector では、ディレクトリをポーリングして、作成または更新されたファイルがないかどうかを確認する ​**On New or Updated File**​ 操作が提供されます。見つかったファイルごとにメッセージが生成されます。 次の戦略は、ファイルが新規かどうかを判断します。 - **\[Auto Delete (自動削除)\]**​ 項目を ​**True**​ に設定する: この方法では、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが新規とみなされます。 - **\[Move To Directory (ディレクトリに移動)\]**​ 項目を設定する: この方法では、各ファイルを処理した後で処理済みのファイルを異なるディレクトリに移動するため、​**\[Auto Delete (自動削除)\]**​ と同じ効果を得ることができますが、ファイルが消去されることはありません。 - **\[Watermark (ウォーターマーク)\]**​ 項目を設定する: この方法では、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。 ファイルをさらに絞り込むためにマッチャーを使用することもできます。 例: ファイルリスナー (新規ファイルトリガー) ```xml ``` ## [](#ウォーターマーク)ウォーターマーク File Connector では、ウォーターマーク戦略を ​`CREATION_TIMESTAMP`​ または ​`MODIFIED_TIMESTAMP`​ の 2 つの異なるモードで使用できます。戦略は、ファイルの絞り込みを作成時間に基づいて実行するか、変更時間に基づいて実行するかによって異なります。 例: ファイルリスナーを使用したウォーターマーク ```xml ``` ## [](#反復可能ストリーム)反復可能ストリーム **List**​ 操作では、Mule 4 で導入された反復可能ストリーム機能が使用されます。この操作ではメッセージのリストが返されます。各メッセージはリスト内のファイルを表し、ファイルへのストリームを保持します。デフォルトでは、ストリームは反復可能です。 詳細は、​[「Mule 4 でのストリーミング」](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。