メイン コンテンツにスキップ

概要

ICAP profile は、ICAP server によるファイル処理をカスタマイズし、CDR を管理するための手段を提供します。複数の ICAP profile の同時有効化がサポートされていますが、受信する各 respmod または reqmod リクエストには、必ず 1 つの profile のみが割り当てられます。

profile

ステータス

status プロパティは、ICAP server が指定された profile の利用を続行するかどうかを決定します。false に設定すると、その profile は無効化され、リクエストはエラーメッセージを伴って失敗します。

profile 設定

コンテンツ管理 policy

ProfileSettings.ContentManagementPolicy プロパティは、Halo 内の名前付き policy を表します。この policy は、RESPMODREQMOD リクエスト内のすべてのコンテンツに適用されます。

処理中に指定された ContentManagementPolicy が存在しない場合、リクエストは default profile を使用するようフォールバックします。

「Default」というラベルのコンテンツ管理 policy は、default profile に割り当てられます。

Policy Management の詳細を見る

Processingrulesdefault

ProfileSettings.ProcessingRulesDefault は、認識されない mime/content-type に遭遇した場合に ICAP server が実行すべきアクションを決定します。認識されないコンテンツタイプとは、ProcessingRules コレクションに含まれていないものを指します。

Processingrules

ProfileSettings.ProcessingRules は、RESPMODOrREQMOD リクエストに適用されるルールのコレクションです。ルールにはカスタムの mime/content-types を含めることができます。

ICAP サーバーが REQMODOrRESPMOD リクエストの content-type に一致した場合、ルールの値に応じてコンテンツをどう処理するかを決定します。

ルール説明
processファイルに CDR を実行し、http コンテンツを再構築されたファイルに置き換えます。
bypass何もせず、元のファイルをそのまま通過させます。
blockファイルに CDR を実行しません。http コンテンツをエラーレポートに置き換えます。

デフォルトの profile

Halo に ICAP がインストールされると、初回起動時にデフォルトの ICAP profile が作成され、永続化されます。この profile は、デフォルトですべてのサポートされている content types を process し、認識されない content types を block するよう設定されています。

release 2.5.4 から profile をリセットすると、新しい media types が含まれるようになります。

profile JSON の例

{
"ProfileIdentity": "f49f7748-4f33-4638-8f24-bfd721bcd487",
"ProfileName": "default",
"ProfileVersion": 1,
"IsDefaultProfile": true,
"Status": "enabled",
"ProfileSettings": {
"ContentManagementPolicy": "default",
"ProcessingRulesDefault": "block",
"ProcessingRules": {
"application/msword": "process",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document": "process",
"application/vnd.ms-excel": "process",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": "process",
"application/vnd.ms-powerpoint": "process",
"application/vnd.openxmlformats-officedocument.presentationml.presentation": "process",
"application/pdf": "process",
"image/jpeg": "process",
"image/png": "process",
"image/gif": "process",
"image/tiff": "process",
"image/bmp": "process",
"image/svg+xml": "process",
"image/webp": "process",
"application/x-emf": "process",
"application/x-wmf": "process",
"audio/wav": "process",
"audio/mpeg": "process",
"audio/mp4": "process",
"application/x-bzip2": "process",
"application/gzip ": "process",
"application/x-rar-compressed": "process",
"application/x-tar": "process",
"application/x-xz": "process",
"application/zip ": "process",
"application/x-7z-compressed": "process"
}
}
}

フォールバックモード

profile の取得およびキャッシュ中に何らかの理由で policy API に接続できない場合、サービスは復旧できるまでフォールバック profile を使用できます。

このprofileはインストール時のデフォルトprofileと同じになるように設定されており、そのためデフォルトのコンテンツ管理policyと処理ルールを使用します。

これを有効にするには、設定変更を参照してください。

無効になっている場合、サービスは再起動によって復旧を試みます。