FTPS コネクタドキュメントリファレンス

FTPS サーバのファイルを操作できるようにします。

設定


設定

デフォルト設定

パラメータ

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

Name (名前)

String (文字列)

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

x 

Connection (接続)

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

x 

Default Write Encoding (デフォルト書き込みエンコーディング)

String (文字列)

 

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

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

 

接続種別

FTPS Connection (FTPS 接続)

SSL をサポートする FtpConnectionProvider の特殊化。

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

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

String (文字列)

このコネクタで使用するすべての相対パスのルートと見なされるディレクトリ。

 

Transfer Mode (転送モード)

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

  • BINARY (バイナリ)

  • ASCII (アスキー)

使用する転送モード。

BINARY

 

Passive (パッシブ)

Boolean (ブール)

パッシブモードを使用するかどうか。アクティブモードに切り替えるには false に設定します。

true

 

Ftps Mode (FTPS モード)

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

 

TLS Configuration (TLS 設定)

TLS

SSH 接続を確立するために使用される TLS コンテキスト。指定しない場合、Mule のデフォルトが使用されます。

 

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

Number (数値)

接続タイムアウト値。

10

 

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

接続タイムアウトで使用する時間の単位。

SECONDS (秒)

 

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

Number (数値)

応答タイムアウト値。

10

 

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

応答タイムアウトに使用する時間の単位。

SECONDS (秒)

 

Host (ホスト)

String (文字列)

x 

Port (ポート)

Number (数値)

21

 

Username (ユーザ名)

String (文字列)

 

Password (パスワード)

String (文字列)

 

Reconnection (再接続)

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

 

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

接続プールの特性。

 

関連操作

関連付けられたソース

操作

Copy

<ftps:copy>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Source Path (コピー元パス)

String (文字列)

x 

Target Path (コピー先パス)

String (文字列)

x 

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

Boolean (ブール)

true

 

Overwrite (上書き)

Boolean (ブール)

false

 

Rename To (変更後の名前)

String (文字列)

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:FILE_ALREADY_EXISTS  

  • FTPS:ILLEGAL_PATH  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

Create Directory

<ftps:create-directory>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

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

String (文字列)

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:FILE_ALREADY_EXISTS  

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

Delete

<ftps:delete>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

x 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

List

<ftps:list>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

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

String (文字列)

x 

Recursive (再帰的)

Boolean (ブール)

false

 

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

リストされたファイルを絞り込むためのマッチャー。

 

Target Variable (対象変数)

String (文字列)

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

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

出力

Type (型)

[Binary] ペイロードおよび [Ftp File Attributes (Ftp ファイル属性)] 属性のメッセージの配列。

設定

スロー

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

Move

<ftps:move>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Source Path (コピー元パス)

String (文字列)

x 

Target Path (コピー先パス)

String (文字列)

x 

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

Boolean (ブール)

true

 

Overwrite (上書き)

Boolean (ブール)

false

 

Rename To (変更後の名前)

String (文字列)

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:FILE_ALREADY_EXISTS  

  • FTPS:ILLEGAL_PATH  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

Read

<ftps:read>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

File Path (ファイルパス)

String (文字列)

x 

Lock (ロック)

Boolean (ブール)

false

 

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

 

Output Encoding (出力文字コード)

String (文字列)

この操作で出力するペイロードの文字コード。

 

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

繰り返し可能なストリームを使用するかどうかと、それらの動作を設定します。

 

Target Variable (対象変数)

String (文字列)

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

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

出力

Type (型)

Binary (バイナリ)

Attributes Type (属性型)

設定

スロー

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:FILE_LOCK  

  • FTPS:RETRY_EXHAUSTED  

Rename

<ftps:rename>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

x 

New Name (新しい名前)

String (文字列)

x 

Overwrite (上書き)

Boolean (ブール)

false

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:FILE_ALREADY_EXISTS  

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:RETRY_EXHAUSTED  

Write

<ftps:write>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

x 

Content (コンテンツ)

Binary (バイナリ)

ファイルに書き込むコンテンツ。

#[payload]

 

Encoding (エンコーディング)

String (文字列)

String (文字列) ファイルを書き込もうとするときのエンコーディング。設定しない場合、デフォルトは設定 1 または Mule のデフォルトになります。

 

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

Boolean (ブール)

true

 

Lock (ロック)

Boolean (ブール)

false

 

Write Mode (書き込みモード)

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

  • OVERWRITE (上書き)

  • APPEND (追加)

  • CREATE_NEW

ファイルを書き込む方法。

OVERWRITE (上書き)

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

設定

スロー

  • FTPS:FILE_ALREADY_EXISTS  

  • FTPS:ILLEGAL_PATH  

  • FTPS:ACCESS_DENIED  

  • FTPS:CONNECTIVITY  

  • FTPS:ILLEGAL_CONTENT  

  • FTPS:RETRY_EXHAUSTED  

Sources (ソース)

新規ファイル

<ftps:listener>

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Directory (ディレクトリ)

String (文字列)

 

Recursive (再帰的)

Boolean (ブール)

サブディレクトリで作成されたファイルもキャッチするかどうか。

true

 

Matcher (マッチャー)

 

Polling Frequency (ポーリング頻度)

Number (数値)

x 

Pooling Frequency Time Unit (プーリング頻度の時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

SECONDS (秒)

 

Watermark Enabled (透かし有効)

Boolean (ブール)

false

 

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

 

Output Encoding (出力文字コード)

String (文字列)

この操作で出力するペイロードの文字コード。

 

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

Boolean (ブール)

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

 

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

繰り返し可能なストリームを使用するかどうかと、それらの動作を設定します。

 

Redelivery Policy (再配信ポリシー)

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

 

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略

 

Auto Delete (自動削除)

Boolean (ブール)

false

 

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

String (文字列)

 

Rename To (変更後の名前)

String (文字列)

 

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

Boolean (ブール)

true

 

出力

Type (型)

Binary (バイナリ)

Attributes Type (属性型)

設定

TLS

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (信頼ストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

Trust Store (信頼ストア)

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

Path (パス)

String (文字列)

信頼ストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

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

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

信頼ストアで使用するアルゴリズム。

Insecure (安全でない)

Boolean (ブール)

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

Key Store (キーストア)

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

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開鍵がある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (鍵のパスワード)

String (文字列)

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

Password (パスワード)

String (文字列)

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

Algorithm (アルゴリズム)

String (文字列)

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

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

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

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

Boolean (ブール)

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

Prefer Crls (CRL を優先)

Boolean (ブール)

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

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェイル)

Boolean (ブール)

取り消しサーバに到達できない場合や取り消しサーバがビジー状態の場合に検証エラーを回避します。

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

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

Url (URL)

String (文字列)

OCSP レスポンダの URL。

Cert Alias (証明書の別名)

String (文字列)

(信頼ストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

Crl File (Crl ファイル)

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

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

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

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

Max Active (最大アクティブ)

Number (数値)

一度にセッションから借りることができる Mule コンポーネントの数を制御します。負の値に設定した場合、同時にアクティブにできるコンポーネントの数に制限はありません。maxActive を超えた場合、プールは枯渇したと呼ばれます。

Max Idle (最大アイドル)

Number (数値)

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

Max Wait (最大待機)

Number (数値)

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

Min Eviction Millis (最小除去時間)

Number (数値)

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

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

Number (数値)

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

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 が負数の場合、無期限にブロックされます。

Initialisation Policy (初期化ポリシー)

次のいずれかの Enumeration (列挙)

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

プール内のコンポーネントの初期化方法を決定します。使用可能な値は次のいずれかです。INITIALISE_NONE (起動時にプールにコンポーネントを読み込みません)、INITIALISE_ONE (起動時に 1 つの初期コンポーネントをプールに読み込みます)、INITIALISE_ALL (起動時にすべてのコンポーネントをプールに読み込みます)

Disabled (無効)

Boolean (ブール)

プーリングを無効化するかどうか。

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

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

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

Number (数値)

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

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

Ftp File Attributes (Ftp ファイル属性)

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

Directory (ディレクトリ)

Boolean (ブール)

Name (名前)

String (文字列)

Path (パス)

String (文字列)

Regular File (正規ファイル)

Boolean (ブール)

Size (サイズ)

Number (数値)

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

Boolean (ブール)

Timestamp (タイムスタンプ)

DateTime (日時)

Matcher (マッチャー)

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

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

DateTime (日時)

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

DateTime (日時)

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 (繰り返し可能なメモリ内ストリーム)

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

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

Number (数値)

これは、ストリームを消費し、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量です。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従って拡張され、上限は maxInMemorySize となります。

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 (オブジェクトストア)

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

Ftps Explicit (明示的) モード

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

Prot Setting (PROT 設定)

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

  • CLEAR (クリア)

  • PRIVATE (プライベート)

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub