SFTP コネクタリファレンス

FTP と SFTP を介してファイルを操作できます。

設定


設定

デフォルト設定

パラメータ

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

Name (名前)

String (文字列)

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

x 

Connection (接続)

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

x 

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

String (文字列)

 

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

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

 

接続種別

SFTP 接続

SftpConnector のインスタンスから SftpFileSystem のインスタンスを提供する FileSystemProvider。

パラメータ

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

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

String (文字列)

このコネクタで使用されるすべての相対パスのルートとみなされるディレクトリ。指定しない場合、リモートサーバのデフォルトに設定されます。

 

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

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

  • GSSAPI_WITH_MIC

  • PUBLIC_KEY

  • KEYBOARD_INTERACTIVE

  • PASSWORD

SFTP クライアントによって使用される認証方法のセット。有効な値は次のとおりです。SSAPI_WITH_MIC、PUBLIC_KEY、KEYBOARD_INTERACTIVE、PASSWORD

 

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

String (文字列)

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

 

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

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

 

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

Number (数値)

接続試行がタイムアウトになるまで待機する時間を表すスカラー時間値。この属性は、#connectionTimeoutUnit と連携して機能します。デフォルトは 10 です。

10

 

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

#connectionTimeout 属性を評価する TimeUnit。デフォルトは SECONDS (秒) です。

SECONDS (秒)

 

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

Number (数値)

データの要求がタイムアウトになるまで待機する時間を表すスカラー時間値。この属性は、#responseTimeoutUnit と連携して機能します。デフォルトは 10 です。

10

 

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

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

#responseTimeoutUnit 属性を評価する TimeUnit。デフォルトは SECONDS (秒) です。

SECONDS (秒)

 

Host (ホスト)

String (文字列)

www.mulesoft.com、localhost、192.168.0.1 などの FTP サーバホスト。

x 

Port (ポート)

Number (数値)

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

22

 

Username (ユーザ名)

String (文字列)

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

 

Password (パスワード)

String (文字列)

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

 

Passphrase (パスフレーズ)

String (文字列)

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

 

Identity File (ID ファイル)

String (文字列)

PKI 秘密キーの identityFile の場所。

 

PRNG Algorithm (PRNG アルゴリズム)

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

  • AUTOSELECT

  • NativePRNG

  • SHA1PRNG

  • NativePRNGBlocking

  • NativePRNGNonBlocking

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

AUTOSELECT

 

Reconnection (再接続)

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

 

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

接続プールの特性。

 

関連操作

関連付けられたソース

操作

Copy

<sftp:copy>

sourcePath のファイルを targetPath にコピーします。targetPath が存在せず、その親も存在しない場合には、createParentFolder 引数の値に応じて作成が試行されます。createParentFolder が false であれば、SFTP:ILLEGAL_PATH エラーが発生します。

コピー先ファイルがすでに存在している場合、overwrite (上書き) 引数が true のときは上書きされます。それ以外の場合は、SFTP:FILE_ALREADY_EXISTS エラーが発生します。sourcePath に関しては、ファイルにもディレクトリにもできます。ディレクトリを参照する場合、再帰的にコピーされます。

パラメータ

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

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:CONNECTIVITY  

  • SFTP:FILE_ALREADY_EXISTS  

Create Directory

<sftp:create-directory>

directoryPath で新しいディレクトリを作成します。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

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

String (文字列)

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

x 

Reconnection Strategy (再接続戦略)

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

 

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ACCESS_DENIED  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

  • SFTP:FILE_ALREADY_EXISTS  

Delete

<sftp:delete>

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

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

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

x 

Reconnection Strategy (再接続戦略)

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

 

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ACCESS_DENIED  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

List

<sftp:list>

特定のマッチャーに一致する directoryPath にあるファイルをすべてリストします。リスト中にディレクトリが検出された場合、recursive (再帰) パラメータの値に応じて出力リストにそのコンテンツが含まれます。recursive (再帰) が true に設定されているが見つかったディレクトリがマッチャーによって拒否された場合、これらのディレクトリに対しては再帰が行われません。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

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

String (文字列)

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

x 

Recursive (再帰的)

Boolean (ブール)

サブディレクトリの内容を含めるかどうか。デフォルトは false です。

false

 

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

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

 

Target Variable (対象変数)

String (文字列)

操作の出力を配置する変数の名前。

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

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

 

出力

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

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ACCESS_DENIED  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

Move

<sftp:move>

sourcePath のファイルを targetPath に移動します。targetPath が存在せず、その親も存在しない場合には、createParentFolder 引数の値に応じて作成が試行されます。createParentFolder が false であれば、SFTP:ILLEGAL_PATH エラーが発生します。移動先ファイルがすでに存在している場合、overwrite (上書き) 引数が true のときは上書きされます。それ以外の場合は、SFTP:FILE_ALREADY_EXISTS エラーが発生します。sourcePath に関しては、ファイルにもディレクトリにもできます。ディレクトリを参照する場合、再帰的に移動されます。

パラメータ

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

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:CONNECTIVITY  

  • SFTP:FILE_ALREADY_EXISTS  

Read

<sftp:read>

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

lock (ロック) パラメータを true に設定した場合、この操作によって返される入力ストリームが閉じられるか完全に使用されるまで、ファイルシステムレベルのロックがファイルに配置されます。ロックは実際にはホストファイルシステムによって指定されるため、その動作はマウントされたドライブおよび Mule を実行しているオペレーティングシステムに応じて変わる場合もあります。盲目的にこのロックに依存する前に以上の点を考慮してください。

この方法では、読み取られるファイルの MIME タイプを判断するためにベストエフォートも行います。ファイルの拡張子は、情報に基づいてファイルの MIME タイプを推測するために使用されます。また、ユーザは省略可能な outputEncoding および outputMimeType パラメータを使用して、出力の文字コードと mimeType を強制することもできます。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

File Path (ファイルパス)

String (文字列)

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

x 

Lock (ロック)

Boolean (ブール)

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

false

 

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

 

Output Encoding (出力文字コード)

String (文字列)

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

 

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

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

 

Target Variable (対象変数)

String (文字列)

操作の出力を配置する変数の名前。

 

Target Value (対象値)

String (文字列)

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

#[payload]

 

Reconnection Strategy (再接続戦略)

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

 

出力

Binary (バイナリ)

属性型

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ACCESS_DENIED  

  • SFTP:FILE_LOCK  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

Rename

<sftp:rename>

パスで参照されるファイルの名前を、to パラメータで指定される名前に変更します。to 引数にはパスセパレータを含めることができません。この前提条件を守らなければ、SFTP:ILLEGAL_PATH が発生します。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

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

x 

New Name (新しい名前)

String (文字列)

ファイルの新しい名前。

x 

Overwrite (上書き)

Boolean (ブール)

すでにコピー先ディレクトリが存在している場合にファイルを上書きするかどうか。

false

 

Reconnection Strategy (再接続戦略)

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

 

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ACCESS_DENIED  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

  • SFTP:FILE_ALREADY_EXISTS  

Write

<sftp:write>

パスで参照されているファイルにコンテンツを書き込みます。書き込もうとしているファイルのディレクトリが存在しない場合、createParentDirectory の値に応じて、SFTP:ILLEGAL_PATH エラーが発生するか、フォルダが作成されます。

ファイル自体がすでに存在している場合、その動作は指定されたモードに応じて異なります。この操作では、lock (ロック) 引数の値に応じたロックもサポートしていますが、読み取り操作で説明したのと同じルールおよび考慮事項が適用されます。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Path (パス)

String (文字列)

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

x 

Content (コンテンツ)

Binary (バイナリ)

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

#[payload]

 

Encoding (エンコード)

String (文字列)

content (コンテンツ) が String (文字列) の場合、この属性で書き込み時に使用されるエンコードを指定します。設定しない場合、デフォルトは FileConnectorConfig#getDefaultWriteEncoding() になります。

 

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

Boolean (ブール)

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

true

 

Lock (ロック)

Boolean (ブール)

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

false

 

Write Mode (書き込みモード)

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

  • OVERWRITE (上書き)

  • APPEND (追加)

  • CREATE_NEW (新規作成)

FileWriteMode。デフォルトでは OVERWRITE (上書き) に設定されます。

OVERWRITE (上書き)

 

Reconnection Strategy (再接続戦略)

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

 

次の設定の場合

スロー

  • SFTP:RETRY_EXHAUSTED  

  • SFTP:ILLEGAL_CONTENT  

  • SFTP:ACCESS_DENIED  

  • SFTP:ILLEGAL_PATH  

  • SFTP:CONNECTIVITY  

  • SFTP:FILE_ALREADY_EXISTS  

Sources (ソース)

新規ファイル

<sftp:listener>

ディレクトリをポーリングしてそのディレクトリで作成されたファイルを探します。見つかった各ファイルに 1 つのメッセージが生成されます。この機能の重要な部分は、ファイルが実際に新規かどうかを判断する方法です。

使用できるポーリング戦略は次のとおりです。

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

  • moveToDirectory パラメータの設定: 処理されたファイルをそれぞれ異なるディレクトリに移動し、ファイルを失わずに autoDelete と同じ結果をもたらす。

  • watermarkMode パラメータの使用: 最後のポーリングが実行された後に作成または更新されたファイルのみを選択する。

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

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x 

Directory (ディレクトリ)

String (文字列)

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

 

Recursive (再帰)

Boolean (ブール)

サブディレクトに含まれているファイルも含めるかどうか。

true

 

Matcher (マッチャー)

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

 

Watermark Enabled (透かしの有効化)

Boolean (ブール)

透かしを行うかどうかを制御します。透かしを行う場合は、透かしでファイルの変更または作成のタイムスタンプを考慮する必要があるかどうか。

false

 

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

 

Output Encoding (出力文字コード)

String (文字列)

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

 

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

Boolean (ブール)

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

 

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

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

x 

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

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

 

Redelivery Policy (再配信ポリシー)

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

 

Reconnection Strategy (再接続戦略)

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

 

Auto Delete (自動削除)

Boolean (ブール)

false

 

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

String (文字列)

 

Rename To (変更後の名前)

String (文字列)

 

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

Boolean (ブール)

true

 

出力

Binary (バイナリ)

属性型

次の設定の場合

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

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

Host (ホスト)

String (文字列)

x

Port (ポート)

Number (数値)

x

Username (ユーザ名)

String (文字列)

Password (パスワード)

String (文字列)

Protocol (プロトコル)

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

  • HTTP

  • SOCKS4

  • SOCKS5

x

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

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

true

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 - スタートアップ時にプールに初期コンポーネントを読み込む。

  • INITIALISE_ALL - スタートアップ時にプールにすべてのコンポーネントを読み込む。

Disabled (無効)

Boolean (ブール)

プーリングを無効にする必要があるかどうか。

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

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

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

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

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

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

ObjectStore

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

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub