3.13.1 ファイル転送機能の概要

DocumentBrokerサーバに接続するDocumentBrokerクライアントが異なるマシン上に存在する場合,DocumentBrokerサーバとDocumentBrokerクライアントの間のファイル転送には,ファイル転送機能を使用する必要があります。例えば,DocumentBrokerで管理している文書のファイルを異なるクライアントマシンに取得したり,異なるクライアントマシンに存在するファイルをDocumentBrokerの文書として登録したりする場合に,ファイル転送が発生します。

ファイル転送機能は,DocumentBrokerクライアントで開始したファイル転送サービスが提供しています。ただし,ファイル転送サービスを使用するには,DocumentBrokerクライアントでの環境設定が必要です。

<この項の構成>
(1) ファイル転送サービス開始モード
(2) ファイル転送サービスのプロセス構成
(3) 静的モードと動的モードの違い

(1) ファイル転送サービス開始モード

ファイル転送サービスには,次の二つの開始モードがあります。

(a) 静的モード

クライアントアプリケーションがファイル転送サービスを使用する前に,ファイル転送サービスをコマンドによって明示的に開始するモードです。

(b) 動的モード

クライアントアプリケーションで最初にファイル転送サービスを使用する時点で,ファイル転送サービスが自動的に開始されるモードです。

このモードは,クライアントアプリケーションを実行するときにプロセスが起動されるため,クライアントアプリケーションの処理時間が多く掛かります。

(2) ファイル転送サービスのプロセス構成

ファイル転送サービスのプロセス構成について,次の表に示します。なお,「(静的モードの場合)」とあるプロセスは,開始モードが静的モードの場合だけ使用するプロセスです。これらのプロセス間の通信には,メッセージキューを利用しています。

表3-9 ファイル転送サービスのプロセス構成

プロセス名機能概要
ファイル転送サービス開始ファイル転送サービスを開始する(静的モードの場合)。
ファイル転送サービス監視ファイル転送サービスを監視する(静的モードの場合)。
ファイル転送サービスファイル転送サービスを提供する。
ファイル転送サービス停止ファイル転送サービスを停止する(静的モードの場合)。

(a) ファイル転送サービス開始プロセス(静的モードの場合)

ファイル転送サービスを,静的モードで開始するプロセスです。

このプロセスは,静的モードのファイル転送サービス開始コマンド(FtpSvStart)を実行したときに生成され,ファイル転送サービス監視プロセスを起動します。そして,ファイル転送サービス監視プロセスから起動完了メッセージの応答を確認すると終了します。

(b) ファイル転送サービス監視プロセス(静的モードの場合)

静的モードで開始されたファイル転送サービスプロセスを管理するプロセスです。

静的モードのファイル転送サービス開始コマンド(FtpSvStart)で指定した数のファイル転送サービスプロセスを起動します。そのあと,ファイル転送サービスプロセスの動作状況を監視して,ファイル転送サービスプロセスが終了した場合は再起動します。さらに,ファイル転送サービスを使用するクライアントアプリケーションに対して,最適なファイル転送サービスプロセスを割り当てます。

このプロセスは,ファイル転送サービス開始プロセスによって生成されます。ファイル転送サービス開始制御プロセスからの終了要求メッセージを受信すると,ファイル転送サービスプロセスに終了要求メッセージを通知し,ファイル転送サービスプロセスの終了を確認すると停止します。

(c) ファイル転送サービスプロセス

ファイル転送サービスを提供するプロセスです。

このプロセスは,同時に複数実行できます。

開始モードが静的モードの場合
ファイル転送サービスプロセスは,静的モードのファイル転送サービス開始コマンド(FtpSvStart)を実行した時に,このコマンドで指定した数だけファイル転送サービス監視プロセスによって生成されます。このプロセスは,クライアントアプリケーションに対して文書空間への接続単位(セッション単位)に割り当てられます。クライアントアプリケーションでファイル転送を要求すると,ファイル転送サービスプロセスの中から,割り当て数が最も少ないプロセスが割り当てられます。また,静的モードのファイル転送サービス停止コマンド(FtpSvStop)を実行したときに,ファイル転送サービス監視プロセスから終了要求メッセージを受信し,すべてのファイル転送サービスプロセスが終了します。
静的モードで開始されたファイル転送サービスプロセスは,一つのプロセスで,クライアントマシン上で動作するすべてのクライアントアプリケーションプロセスの,すべてのセッションに対してサービスを提供できます。ただし,ファイル転送サービスプロセスがダウンした場合,ダウンしたプロセスに割り当てられていたセッションを使用しファイル転送を要求すると,その要求したセッションに対してエラーが返却されます。この場合,ファイル転送の失敗でエラーが発生したAPIを再度実行して,ファイル転送を要求すると新たなファイル転送サービスプロセスが割り当てられます。
開始モードが動的モードの場合
ファイル転送サービスプロセスは,クライアントアプリケーションプロセス内で最初にファイル転送サービスを利用するときに,クライアントアプリケーションプロセスによって生成されます。したがって,ファイル転送サービスを利用するクライアントアプリケーションプロセスの数だけファイル転送サービスプロセスが生成されます。また,起動したクライアントアプリケーションプロセスが終了すると,停止します。
動的モードで開始されたファイル転送サービスプロセスは,そのプロセスを起動したクライアントアプリケーションプロセス内で動作するセッションに対してだけ,サービスを提供できます。ただし,ファイル転送サービスプロセスがダウンした場合,ダウンしたプロセスを生成したクライアントアプリケーションプロセスがファイル転送を要求すると,エラーが返却されます。この場合,ファイル転送の失敗でエラーが発生したAPIを再度実行して,ファイル転送を要求すると新たなファイル転送サービスプロセスが生成され,サービスが提供されます。

(d) ファイル転送サービス停止プロセス(静的モードの場合)

静的モードで開始されたファイル転送サービスを停止するプロセスです。

このプロセスは,静的モードのファイル転送サービス停止コマンド(FtpSvStop)を実行したときに生成され,ファイル転送サービス監視プロセスに対して終了要求メッセージを送信します。ファイル転送サービス監視プロセスからの終了完了メッセージの応答を確認すると終了します。

(3) 静的モードと動的モードの違い

静的モードと動的モードの違いを,次の表に示します。

表3-10 静的モードと動的モードの違い

項目静的モード動的モード
開始方法および停止方法手動(コマンド)でファイル転送サービスを開始または停止する。クライアントアプリケーション実行時に自動的にファイル転送サービスが開始または停止される。
ファイル転送サービスプロセス割り当て単位文書空間への接続単位クライアントアプリケーションプロセス単位
DocumentBrokerサーバのファイルにアクセスするときのアクセス権ファイル転送サービス開始実行ユーザのアクセス権クライアントアプリケーションプロセス実行ユーザのアクセス権
DocumentBrokerサーバから転送されるファイルの所有者ファイル転送サービス開始実行ユーザクライアントアプリケーションプロセス実行ユーザ
動的モード使用時の注意事項
動的モードでファイル転送機能を使用する場合,ファイル転送サービスプロセスはクライアントアプリケーションプロセスの数だけ作成されます。また,プロセスの起動ごとに,一時的に使用するメッセージキューを一つ作成します。このため,リソース不足が発生する可能性があります。なお,メッセージキューの設定については,「3.4.2 パラメタのカスタマイズ」を参照してください。
リソース不足が発生した場合は,次のどちらかの対処をしてください。
  • 静的モードに変更してファイル転送サービスを開始する
  • ファイル転送サービスを使用するクライアントアプリケーションプロセス数を減少させる