9.1.1 ファイル監視機能
ファイル監視機能とは,HCSCサーバからアクセスできる特定のフォルダ内での,ファイルの新規作成を監視する機能です。ファイル監視機能は,HCSCサーバランタイム定義ファイルで指定されたfileevent-reception.monitor-intervalプロパティの値を基準として,一定間隔でファイルの存在確認を実施します。
ファイル監視を14:00に開始し,fileevent-reception.monitor-intervalプロパティの値を30分に設定した場合の例を次の図に示します。
- 〈この項の構成〉
(1) ファイル監視機能を有効にするための設定
ファイル監視機能は,HCSCサーバランタイム定義ファイルのfileevent-reception.monitored-file.enabledプロパティにtrueを設定することによって有効になります。ファイル監視機能は,ファイルイベント連携を使用する際に必要です。
- 注意事項
-
ファイルイベント受付をHCSCサーバに配備する場合は,fileevent-reception.monitored-file.enabledプロパティに必ずtrueを設定してください。falseが設定されていると,ファイルイベント受付の起動に失敗します。
(2) 監視対象の設定
監視対象のフォルダは,ファイルイベント受付定義ファイルのurecp-fileevent.monitored.common-folderプロパティで設定します。次のどちらかを指定してください。
-
false
監視フォルダを監視対象とします。
-
true
共通フォルダを監視対象とします。
(3) ファイル監視の開始
ファイル監視機能が有効になっている場合は,HCSCサーバの起動時にファイル監視が開始されます。ファイル監視は,HCSCサーバの起動コマンドが実行された直後から,HCSCサーバランタイム定義ファイルで指定されたfileevent-reception.monitor-starting.delayプロパティの開始遅延時間が経過したあとに開始されます。それ以降は,HCSCサーバランタイム定義ファイルで指定されたfileevent-reception.monitor-intervalプロパティの値を基準として,一定間隔でファイル監視を実施します。
HCSCサーバの起動を14:00に開始し,開始遅延時間を10分,ファイル監視の間隔を30分で設定した場合の例を次の図に示します。
1回目のファイルの存在確認は14:10に,2回目は14:40に実施されます。
(5) 監視対象のファイルの登録
監視対象となるフォルダ,およびファイル名などの条件は,ファイルイベント受付の起動時にファイル監視機能に登録されます。登録された内容は,次のファイルの存在確認時に反映されます。監視対象ファイルの登録の流れを次の図に示します。
(6) 監視対象のファイルの登録解除
ファイル監視機能にファイル監視の対象として登録されたファイルの条件は,ファイルを登録したファイルイベント受付を停止したときにファイル監視機能から削除されます。登録が解除されたファイルの条件は,次のファイルの存在確認からファイル検知の対象外となります。
- 注意事項
-
ファイルイベント受付の停止の処理が異常終了した場合,登録されたファイルの条件がファイル監視機能から解除されずに,ファイルの検知を続けることがあります。この場合,異常停止したファイルイベント受付を起動するか,HCSCサーバを再起動してください。
(7) 監視対象のファイルと取得対象ファイル
ファイル監視機能は,監視対象のフォルダによって,監視対象ファイルと取得対象ファイルが異なります。
監視対象のフォルダによる違いを次に示します。
-
監視対象のフォルダが監視フォルダの場合
監視フォルダ内の更新完了通知ファイルを監視します。取得対象ファイルの監視はできません。取得対象ファイルと更新完了通知ファイルの,両方を用意する必要があります。更新完了通知ファイルの詳細については「9.3.4(1) 更新完了通知ファイルの作成」を参照してください。
-
監視対象のフォルダが共通フォルダの場合
共通フォルダ内の取得対象ファイルを監視します。監視フォルダおよび更新完了通知ファイルは不要です。取得対象ファイルの詳細については,「9.3.4(2) 取得対象ファイルの作成」を参照してください。
(8) 監視対象のファイルの数量とリクエスト回数の関係
ファイル監視機能によって複数の監視対象のファイルが検知された場合,ファイル監視機能はファイルイベント受付が検知したファイルと同じ数だけ,独立したリクエストとしてファイルイベントの検知を通知します。ただし,監視対象のファイルを通知する順番は指定できません。
監視対象のファイルが3つあり,リクエスト処理が3回実行される場合の動作を次の図に示します。
また,ファイル監視機能からファイルイベント受付へ通知する際にエラーが発生した場合は,エラーが発生した通知処理だけ終了し,そのほかに検知された処理は続行されます。
(9) ファイル監視の処理時間がファイル監視の間隔を超えた場合の動作
処理の遅延などによって,ファイル監視処理に掛かる時間がファイル監視の間隔を超えた場合は,ファイル監視処理が終了したあと,ファイル監視の間隔を待たないで,すぐに次のファイル監視処理を開始します。
ファイル監視処理に掛かる時間がファイル監視の間隔を超えた場合の動作例を次の図に示します。
図の例では,ファイル監視1回目の処理時間が,2回目と3回目のファイル監視予定時刻に差し掛かっています。この場合,1回目の処理が終わった段階で2回目と3回目の予定時刻をオーバーしているため,すぐに実行されます。