1. ホームページ
  2. SFTP Connector

  3. SFTP Connector リファレンス

All Connectors

SFTP Connector リファレンス - Mule 4

SFTP Connector v2.4

SFTP 用 Anypoint Connector (SFTP Connector) は、SFTP サーバーにあるファイルとフォルダーへのアクセスを提供します。

リリースノート: 『SFTP Connector リリースノート』

PPK (非公開キー) ファイルでは、SFTP Connector の ID ファイルはサポートされません。

設定

デフォルト設定

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

SFTP Connection (SFTP 接続)

この設定に指定する接続型。

x

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 (サイズ確認の時間間隔)]​ 属性に使用できる時間単位。 +デフォルトは ​MILLISECONDS (ミリ秒)​ です。

MILLISECONDS (ミリ秒)

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

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

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

接続種別

SFTP Connection (SFTP 接続)

SFTP Connector のインスタンスから SFTP ファイルシステムのインスタンスを提供するファイルシステムプロバイダー。

パラメーター
名前 型 説明 デフォルト値 必須

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

String (文字列)

このコネクタで使用するすべての相対パスのルートとして指定したディレクトリ。指定しない場合、デフォルトはリモートサーバーのデフォルトになります。一部の SFTP サーバーでは現在の作業ディレクトリコマンドの出力が返されないため、作業ディレクトリを定義します。SFTP サーバー側の動作は制御できませんが、この値を設定することでこのような状況が軽減されます。

Preferred Authentication Methods (優先する認証方法)

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

  • GSSAPI_WITH_MIC​

  • PUBLIC_KEY​

  • PASSWORD

SFTP クライアントによって使用される認証方法のセット。有効な値: GSSAPI_WITH_MIC​、​PUBLIC_KEY​、​PASSWORD​。

Known Hosts File (既知のホストファイル)

String (文字列)

指定すると、クライアントは参照ファイルにあるキーに対してサーバーのキーを検証します。サーバーキーがファイルにあるものと一致しなければ、接続は中止されます。

Sftp Proxy Config (Sftp プロキシ設定)

SFTP Proxy Config (SFTP プロキシ設定)

指定すると、接続にプロキシが使用されます。

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

Number (数値)

接続試行がタイムアウトになるまで待機する時間を表すスカラー値。この属性は、​[Connection Timeout Unit (接続タイムアウト単位)]​ と連携して機能します。
デフォルトは ​10​ です。

10

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Connection Timeout (接続タイムアウト)]​ 属性に使用できる時間単位。 +デフォルトは ​SECONDS​ です。

SECONDS

Response Timeout (応答タイムアウト)

Number (数値)

データの要求がタイムアウトになるまで待機する時間を表すスカラー値。この属性は、​[Response Timeout Unit (応答タイムアウト単位)]​ と連携して機能します。 +デフォルトは ​10​ です。

10

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Response Timeout Unit (応答タイムアウト単位)]​ 属性に使用できる時間単位。 +デフォルトは ​SECONDS​ です。

SECONDS

Host (ホスト)

String (文字列)

www.mulesoft.com​、​localhost​、​192.168.0.1​ などの SFTP サーバー。

x

Port (ポート)

Number (数値)

接続する SFTP サーバーのポート番号。

22

Username (ユーザー名)

String (文字列)

SFTP サーバーのユーザー名。サーバーが認証される場合は必須です。

Password (パスワード)

String (文字列)

SFTP サーバーのパスワード。サーバーが認証される場合は必須です。

Passphrase (パスフレーズ)

String (文字列)

必要な場合、ID ファイルのパスフレーズ (パスワード)。ID ファイルが指定されていない場合、このパラメーターは無視されます。

Identity File (ID ファイル)

String (文字列)

PKI 非公開キーの ID ファイルの場所。
ssh-keygen の OpenSSH PKI 形式は受け入れられません。引数の「-m PEM」を使用できます。

PRNG Algorithm (PRNG アルゴリズム)

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

  • AUTOSELECT

  • NativePRNG

  • SHA1PRNG

  • NativePRNGBlocking

  • NativePRNGNonBlocking

使用する疑似乱数生成アルゴリズム。

AUTOSELECT

Security Configuration (セキュリティ設定)

Security Configuration (セキュリティ設定)

暗号化、MAC、キーアルゴリズムなどのセキュリティ関連の設定の上書きのサポートが提供されます。

Reconnection (再接続)

Reconnection (再接続)

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

Pooling Profile (プーリングプロファイル)

Pooling Profile (プーリングプロファイル)

接続プールの特性。

サポートされている操作

関連付けられたソース

操作

Copy

<sftp:copy>

[Source Path (ソースパス)]​ で指定されたファイルまたはディレクトリを ​[Target Path (対象パス)]​ にコピーします。ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照する場合、再帰的にコピーされます。

対象パスが存在せず、その親も存在しない場合には、​[Create Parent Directories (親ディレクトリの作成)]​ が ​true​ に設定されていると親フォルダーが作成されます。​[Create Parent Directories (親ディレクトリの作成)]​ が ​false​ に設定されている場合、​SFTP:ILLEGAL_PATH​ エラーがスローされます。

[Overwrite (上書き)]​ が ​true​ に設定されておりコピー先ファイルがすでに存在する場合、コピー先ファイルが上書きされます。それ以外の場合は、​SFTP:FILE_ALREADY_EXISTS​ エラーがスローされます。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

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

x

Target Path (対象パス)

String (文字列)

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

x

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

Boolean (ブール)

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

true

Overwrite (上書き)

Boolean (ブール)

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

false

Rename To (変更後の名前)

String (文字列)

コピーしたファイルの名前を変更します。この値を指定しない場合、元のファイル名が保持されます。

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:FILE_ALREADY_EXISTS

  • SFTP:CONNECTIVITY

Create Directory

<sftp:create-directory>

[Directory Path (ディレクトリパス)]​ 項目の値を使用して、新しいディレクトリを作成します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

String (文字列)

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

x

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

  • SFTP:FILE_ALREADY_EXISTS

  • SFTP:CONNECTIVITY

Delete

<sftp:delete>

パス項目で参照されているファイルがロックされていない場合、そのファイルを削除します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

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

x

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

  • SFTP:CONNECTIVITY

List

<sftp:list>

[File Matching Rules (ファイル一致ルール)] 項目のルールに応じて ​[Directory Path (ディレクトリパス)]​ のすべてのファイルをリストします。

リストの作成時にディレクトリが検出された場合、​[Recursive(再帰)]​ 項目の値に応じて出力リストにそのコンテンツが含まれます。

[Recursive (再帰)]​ が ​true​ に設定されていても、見つかったディレクトリが ​[File Matching Rules (ファイル一致ルール)]​ 項目のルールによって拒否された場合、そのディレクトリで再帰は行われません。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

String (文字列)

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

x

Recursive (再帰)

Boolean (ブール)

サブディレクトリのコンテンツを含めるかどうか。デフォルトは ​false​ です。

false

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

Matcher (マッチャー)

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

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

型

[String] ペイロードおよび [​SFTP ファイル属性​] 属性のメッセージの配列。ペイロードには、要素のパスが含まれます。

次の設定の場合

スロー

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

Move

<sftp:move>

ファイルまたはディレクトリを ​[Source Path (ソースパス)]​ から ​[Target Path (対象パス)]​ に移動します。ソースパスには、ファイルまたはディレクトリを指定できます。ディレクトリを参照している場合、再帰的に移動します。

対象パスが存在せず、その親も存在しない場合には、​[Create Parent Directories (親ディレクトリの作成)]​ が ​true​ に設定されていると親フォルダーが作成されます。​[Create Parent Directories (親ディレクトリの作成)]​ が ​false​ に設定されている場合、​SFTP:ILLEGAL_PATH​ エラーがスローされます。

コピー先のファイルがすでに存在し、​[Overwrite (上書き)]​ が ​true​ に設定されている場合、コピー先のファイルは上書きされます。​[Overwrite (上書き)]​ が ​false​ に設定されている場合、​SFTP:FILE_ALREADY_EXISTS​ エラーがスローされます。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Source Path (ソースパス)

String (文字列)

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

x

Target Path (対象パス)

String (文字列)

対象のディレクトリ。

x

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

Boolean (ブール)

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

true

Overwrite (上書き)

Boolean (ブール)

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

false

Rename To (変更後の名前)

String (文字列)

移動後のファイルの名前。値を指定しない場合、元のファイル名が保持されます。

Reconnection Strategy (再接続戦略)

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

設定。

スロー

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:FILE_ALREADY_EXISTS

  • SFTP:CONNECTIVITY

Read

<sftp:read>

提供されたパスにあるファイルのコンテンツとメタデータを取得します。この操作自体は、ファイルのコンテンツを含む入力ストリームをペイロードとするメッセージを返し、メタデータはメッセージの ​Message#getAttributes()​ 属性として配置される ​SftpFileAttributes​ オブジェクトとして表現されます。

lock (ロック) パラメーターを ​true​ に設定した場合、この操作によって返される入力ストリームが閉じられるか完全に使用されるまで、ファイルシステムレベルのロックがファイルに適用されます。ロックはホストのファイルシステムにより提供されるため、その動作は、SFTP サーバーまたはそのファイルシステムに応じて変わる可能性があります。このロックに依存する前に以上の点を考慮してください。

また、この方法では、ファイルの拡張子を使用した情報に基づく推測により、読み取られるファイルの MIME タイプがベストエフォートで判断されます。出力の ​[Encoding (エンコード)]​ と ​[MIME Type (MIME タイプ)]​ の 2 つの省略可能なパラメーターを使用して、エンコードと MIME タイプを強制的に適用することもできます。

パラメーター

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

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 タイプ。

Output Encoding (出力エンコード)

String (文字列)

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

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

反復可能なストリームを使用するかどうかを設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

型

Binary (バイナリ)

Attributes Type (属性型)

SFTP ファイル属性

次の設定の場合

スロー

  • SFTP:FILE_LOCK

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

  • SFTP:CONNECTIVITY

Rename

<sftp:rename>

パスの参照先のファイルの名前を、​[New Name (新しい名前)]​ で指定された値に変更します。この引数にはパスセパレーターを含めることができません。含めると、​SFTP:ILLEGAL_PATH​ エラーがスローされます。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

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

x

New Name (新しい名前)

String (文字列)

ファイルの新しい名前。

x

Overwrite (上書き)

Boolean (ブール)

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

false

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

  • SFTP:FILE_ALREADY_EXISTS

  • SFTP:CONNECTIVITY

Write

<sftp:write>

パスで参照されているファイルにコンテンツを書き込みます。

書き込み先のファイルのディレクトリが存在しない場合、操作は ​[Create parent directories (親ディレクトリの作成)]​ の値に応じて ​SFTP:ILLEGAL_PATH​ エラーをスローするか、新しいフォルダーを作成します。ファイルがすでに存在している場合、その動作は指定されたモードに応じて異なります。

この操作では、lock (ロック) 引数の値に応じたロックもサポートし、読み取り操作で説明したのと同じルールおよび考慮事項が適用されます。

ファイルがすでに存在する場合は追加のチェックが実行されるため、ファイルを書き込む前に FTP ​STAT​ コマンドが実行されます。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Path (パス)

String (文字列)

書き込むファイルのパス。

x

Content (コンテンツ)

Binary (バイナリ)

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

#[payload]

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

Boolean (ブール)

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

true

Lock (ロック)

Boolean (ブール)

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

false

Write Mode (書き込みモード)

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

  • OVERWRITE

  • APPEND

  • CREATE_NEW

FileWriteMode​ (日付)。デフォルトは ​OVERWRITE​ です。

OVERWRITE

Write Strategy (書き込み戦略)

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

  • STANDARD

  • CUSTOM

ファイルを書き込む戦略。

STANDARD

Buffer Size For Write Strategy (書き込み戦略のバッファサイズ)

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

  • BUFFER_SIZE_1KB​

  • BUFFER_SIZE_2KB​

  • BUFFER_SIZE_4KB​

  • BUFFER_SIZE_8KB​

  • BUFFER_SIZE_16KB

カスタム書き込みのバッファサイズ。

BUFFER_SIZE_8KB

Config Ref (設定参照)

ConfigurationProvider

書き込み戦略を実行するための設定名。

x

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • SFTP:FILE_LOCK

  • SFTP:RETRY_EXHAUSTED

  • SFTP:ILLEGAL_PATH

  • SFTP:ACCESS_DENIED

  • SFTP:ILLEGAL_CONTENT

  • SFTP:FILE_ALREADY_EXISTS

  • SFTP:CONNECTIVITY

  • SFTP:FILE_DOESNT_EXIST

ソース

On New or Updated File

<sftp:listener>

ディレクトリをポーリングしてそのディレクトリで作成されたファイルを探します。見つかった各ファイルに 1 つのメッセージが生成されます。

この機能の重要な部分は、ファイルが実際に新規かどうかを判断する方法です。3 つの方法があります。

  • Auto Delete (自動削除)​ パラメーターを ​true​ に設定する: この方法では、各ファイルを処理した後で処理済みのファイルを削除するため、次のポーリングで取得されるすべてのファイルが必ず新規になります。

  • Move To Directory (ディレクトリに移動)​ パラメーターを設定する: この方法では、各ファイルを処理した後で処理済みのファイルを異なるディレクトリに移動するため、​Auto Delete (自動削除)​ と同じ効果を得ることができますが、ファイルが失われることはありません。

  • Watermark Enabled (ウォーターマークの有効化)​ を使用する: この方法では、前回ポーリングが実行された後で作成または更新されたファイルのみを選択します。

ファイルをさらに絞り込むためにマッチャーを使用することもできます。

On New Or Updated File​ ソースでは、空の属性リストを含めて返すファイルは無視されます。SFTP サーバーによって変更時間 (MDTM) が有効になっていないか、属性をリストする際にサーバーがエラーを返した場合は、リストが空になることがあります。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Directory (ディレクトリ)

String (文字列)

ポーリングされたファイルが含まれているディレクトリ。

Recursive (再帰)

Boolean (ブール)

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

true

Matcher (マッチャー)

Matcher (マッチャー)

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

Watermark Enabled (ウォーターマークの有効化)

Boolean (ブール)

ウォーターマークを設定するかどうかを制御します。設定する場合は、ファイルの変更タイムスタンプを考慮するか、作成タイムスタンプを考慮するかを制御します。この項目を有効にすると、コネクタでは最新のポーリングの完了後に作成または更新されたファイルのみが選択されます。

false

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

Number (数値)

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

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

[Time between size check (サイズ確認の時間間隔)]​ 属性に使用できる時間単位。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

Boolean (ブール)

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

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

scheduling-strategy

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

x

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

反復可能なストリームを使用するかどうかを設定します。

Redelivery Policy (再配信ポリシー)

Redelivery Policy (再配信ポリシー)

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

Reconnection Strategy (再接続戦略)

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

Auto Delete (自動削除)

Boolean (ブール)

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

false

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

String (文字列)

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

Rename To (変更後の名前)

String (文字列)

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

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

Boolean (ブール)

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

true

Overwrite (上書き)

Boolean (ブール)

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

false

出力

型

Binary (バイナリ)

Attributes Type (属性型)

SFTP ファイル属性

次の設定の場合

型

SFTP Proxy Config (SFTP プロキシ設定)

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

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザー名)

String (文字列)

Password (パスワード)

String (文字列)

Protocol (プロトコル)

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

  • HTTP

  • SOCKS5

x

Security Configuration (セキュリティ設定)

[SSH Config Override File (SSH 設定上書きファイル)] を使用してセキュリティ設定を定義すると、 共有責任Leaving the Site​ドキュメントを受け入れることになります。

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

SSH Config Override File (SSH 設定上書きファイル)

String (文字列)

SSH 上書き設定が含まれるファイルへのパス。次の設定がサポートされています。

  • KexAlgorithms
    キー交換アルゴリズムのカンマ区切りリストが指定されます。

  • Ciphers
    対称暗号化のカンマ区切りリストが指定されます。

  • HostKeyAlgorithms
    ホストキー署名アルゴリズムのカンマ区切りリストが指定されます。

  • MACs
    メッセージ認証コードのカンマ区切りリストが指定されます。

上書きする必要があるファイルでキーを定義します。残りのキーについてはデフォルト値が使用されます。

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。​[Fails Deployment (デプロイに失敗)]​ 項目よりも優先されます。そのため、再接続戦略が ​reconnect-forever​ に設定されていると、デプロイメントに失敗することはありません。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true

Pooling Profile (プーリングプロファイル)

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

Max Active (最大アクティブ)

Number (数値)

一度にアクティブにできる Mule コンポーネントの最大数を制御します。負の値に設定した場合、同時にアクティブにできるコンポーネントの数に制限はありません。​[Max Active (最大アクティブ)]​ を超えた場合、プールは枯渇します。

5

Max Idle (最大アイドル)

Number (数値)

プール内で任意の時点でアイドル状態のままにできる Mule コンポーネントの最大数を制御します。負の値に設定した場合、同時にアイドルにできる Mule コンポーネントの数に制限はありません。

5

Max Wait (最大待機)

Number (数値)

プールが枯渇し、​[Exhausted action (枯渇アクション)]​ が ​WHEN_EXHAUSTED_WAIT​ に設定されている場合に、プールされたコンポーネントが使用可能になるまで待機する時間 (ミリ秒) を指定します。

5

Min Eviction Millis (最小除去時間)

Number (数値)

オブジェクトが除去対象となるまでにオブジェクトをプール内でアイドル状態のままにできる最小時間を決定します。正の値以外の場合、アイドル時間のみによってオブジェクトがプールから削除されることはありません。

1800000

Eviction Check Interval Millis (除去確認間隔)

Number (数値)

オブジェクトエビクターの実行間隔 (ミリ秒) を指定します。正の値以外の場合、オブジェクトエビクターは実行されません。

-1

Exhausted Action (枯渇アクション)

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

  • WHEN_EXHAUSTED_GROW​

  • WHEN_EXHAUSTED_WAIT​

  • WHEN_EXHAUSTED_FAIL

Mule コンポーネントプールが枯渇した場合のプールの動作を指定します。可能な値:

  • WHEN_EXHAUSTED_FAIL​。​NoSuchElementException​ をスローする。 *​WHEN_EXHAUSTED_WAIT​。新規またはアイドルオブジェクトが利用可能なるまで、​Object.wait(long)​ を呼び出してブロックする。

  • WHEN_EXHAUSTED_GROW​。新しい Mule インスタンスを作成して返す。​maxActive​ は基本的に意味がなくなります。正の ​maxWait​ 値を指定した場合、最大で、指定された時間 (ミリ秒) ブロックされた後、​NoSuchElementException​ がスローされます。​maxThreadWait​ が負の値の場合、無期限にブロックされます。

WHEN_EXHAUSTED_GROW

Initialisation Policy (初期化ポリシー)

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

  • INITIALISE_NONE​

  • INITIALISE_ONE​

  • INITIALISE_ALL

プール内のコンポーネントの初期化方法を決定します。可能な値:

  • INITIALISE_NONE​。起動時にコンポーネントをプールに一切読み込まない。

  • INITIALISE_ONE​。起動時に 1 つの初期コンポーネントをプールに読み込む。

  • INITIALISE_ALL​。起動時にすべてのコンポーネントをプールに読み込む。

INITIALISE_NONE​

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

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

SFTP ファイル属性

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

Timestamp (タイムスタンプ)

DateTime

x

Size (サイズ)

Number (数値)

x

Regular File (正規ファイル)

Boolean (ブール)

false

Directory (ディレクトリ)

Boolean (ブール)

false

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

Boolean (ブール)

false

Path (パス)

String (文字列)

x

File Name (ファイル名)

String (文字列)

x

Matcher (マッチャー)

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

Timestamp Since (次の日時からのタイムスタンプ)

DateTime

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

Timestamp Until (次の日時までのタイムスタンプ)

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 (日)

[Not updated in the last (指定した期間に更新なし)]​ 属性。
デフォルトは MILLISECONDS (ミリ秒) です。

MILLISECONDS (ミリ秒)

Case Sensitive (大文字と小文字を区別)

Boolean (ブール)

外部ファイルシステムマッチャーで大文字と小文字を区別するかどうかを設定できるようにします。

true

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

String (文字列)

ファイル名で適用する一致パターン。グロブ表現 (デフォルト) および正規表現がサポートされています。いずれかの表現を使用するには、たとえば ​glob:*.{java, js}​ や ​regex:[0-9]test.csv​ のようにプレフィックスを設定します。

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 (反復可能なメモリ内ストリーム)

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

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

Number (数値)

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

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

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれくらい拡張されるか。0 以下の値を設定すると、バッファは拡張されず、バッファがフルになると ​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

Repeatable File Store Stream (反復可能なファイルストアストリーム)

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

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Redelivery Policy (再配信ポリシー)

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

Max Redelivery Count (最大再配信数)

Number (数値)

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

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

Boolean (ブール)

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

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

String (文字列)

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

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。

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

ObjectStore

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

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

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

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

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供することを目的としてメモリに保持することを許可された初期インスタンス数です。ストリームのデータ量がこのバッファサイズを超える場合は、​[Buffer size increment (バッファサイズ増分)]​ 属性に従って、​[Max in memory size (最大メモリ内サイズ)]​ を上限としてバッファが拡張されます。デフォルト値は 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 (反復可能なファイルストアイテラブル)

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

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

Number (数値)

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

関連情報

MuleSoft ヘルプセンターLeaving the Site