HTTPレスポンス圧縮フィルタの設定

WebアプリケーションへのHTTPレスポンス圧縮フィルタの組み込みには，サーバ管理コマンドを使用した属性ファイルの編集による方法と，Server Plug-inを使用する方法と，WebアプリケーションのDD（web.xml）の直接編集による方法の3種類があります。ここでは，サーバ管理コマンドで属性ファイルを編集してフィルタを組み込む方法について説明します。Server Plug-inを使用したフィルタの組み込みについては，マニュアル「Cosminexus　アプリケーション設定操作ガイド」を参照してください。また，WebアプリケーションのDD（web.xml）の直接編集によるフィルタの組み込みについては，マニュアル「Cosminexus　機能解説」のHTTPレスポンス圧縮フィルタを使用するアプリケーションの実装に関する説明を参照してください。

WebアプリケーションにHTTPレスポンス圧縮フィルタを組み込むために，フィルタ属性ファイルおよびWAR属性ファイルに設定する内容を次の表に示します。なお，属性ファイルの取得，編集した属性ファイルの設定の手順については，「9.7.1(2)　built-inフィルタの組み込み手順」を参照してください。

表9-19　属性ファイルでの設定内容（HTTPレスポンス圧縮フィルタ）

設定項目	属性ファイル名	タグ名	設定内容
フィルタ定義	フィルタ属性ファイル	<filter-name>タグ	追加するフィルタ名称を指定します。設定値は，固定値です。設定値（固定値） com.hitachi.software.was.web.ResponseCompressionFilter
フィルタ定義		<filter-class>タグ	追加するフィルタのクラス名を指定します。設定値は，固定値です。設定値（固定値） com.hitachi.software.was.web.ResponseCompressionFilter
URLパターンとHTTPレスポンス圧縮規則のマッピング		<init-param>タグ内の<param-name>タグ，<param-value>タグ	URLパターンとHTTPレスポンス圧縮機能のマッピングを指定します。詳細については，「(a)　URLパターンとHTTPレスポンス圧縮規則のマッピングについて」を参照してください。
HTTPレスポンス圧縮規則		<init-param>タグ内の<param-name>タグ，<param-value>タグ	HTTPレスポンスの圧縮規則として，圧縮規則名，Media-Typeと圧縮しきい値を指定します。詳細については，「(b)　HTTPレスポンス圧縮規則について」を参照してください。
フィルタマッピング定義	WAR属性ファイル	<filter-mapping>タグ内の<filter-name>タグ	フィルタ名称を指定します。設定値は，固定値です。設定値（固定値） com.hitachi.software.was.web.ResponseCompressionFilter
フィルタマッピング定義	WAR属性ファイル	<filter-mapping>タグ内の<url-pattern>タグ	URLパターンやサーブレットクラスと，HTTPレスポンス圧縮フィルタのマッピングを指定します。HTTPレスポンス圧縮機能は，フィルタマッピング定義によって，マッピングされたURLパターンを持つリソースに対してリクエストがあった場合だけ有効となります。設定値は，任意です。

(a)　URLパターンとHTTPレスポンス圧縮規則のマッピングについて

HTTPレスポンス圧縮機能が有効となるURLパターンと，指定したURLパターンに適用するHTTPレスポンス圧縮規則のマッピングを指定します。

URLパターンとHTTPレスポンス圧縮規則のマッピングは，フィルタ属性ファイルの<init-param>タグで定義します。初期化パラメタの名前（<param-name>タグ）には，「url-mapping」を指定します。また，初期化パラメタの値（<param-value>タグ）には，URLパターンとHTTPレスポンス圧縮機能のマッピングを指定します。デフォルトの設定では，URLパターン「/*」にデフォルトのレスポンス圧縮規則がマッピングされます。

パラメタ指定時の規則を示します。

URLパターンは，大文字と小文字が区別されます。
HTTPレスポンス圧縮規則名は，大文字と小文字が区別されます。
URLパターンとHTTPレスポンス圧縮規則名は，半角のイコール（=）で区切ります。
複数指定する場合は，半角のセミコロン（;）で区切ります。
複数のURLパターンに該当する場合は，先に指定したものが使用されます。
パラメタ値の改行，タブ，スペースは無視されます。
パラメタ値の末尾にある半角のセミコロン（;）は無視されます。

url-mappingパラメタに定義するURLパターンは，パス一致，拡張子一致，および完全一致のマッピング規則が適用されます。それぞれのマッピング規則を次に示します。

パス一致
URLパターンとして「/」で始まり「/*」で終わる文字列を指定した場合は，リクエストURLのコンテキストルートからの相対パスがURLパターンの「*」を除く文字列で始まっているときに一致します。また，URLパターンとして「/*」を指定した場合は，すべてのリクエストURLが一致します。

（例）

URLパターンが「/jsp/*」で，リクエストURLのコンテキストルートからの相対パスが「/jsp/index.jsp」の場合に一致します。
拡張子一致
URLパターンとして「*.」で始まる文字列を指定した場合は，リクエストURLの拡張子とURLパターンの「*.」に続く文字列が同じときに一致します。

（例）

URLパターンが「*.jsp」で，リクエストURLのコンテキストルートからの相対パスが「/jsp/index.jsp」の場合に一致します。
完全一致
URLパターンとして「/」で始まる上記以外の文字列を指定した場合は，リクエストURLのコンテキストルートからの相対パスがこのURLパターンと完全に同じときに一致します。

（例）

URLパターンが「/jsp/index.jsp」で，リクエストURLのコンテキストルートからの相対パスが「/ jsp/index.jsp」の場合に一致します。

(b)　HTTPレスポンス圧縮規則について

レスポンス圧縮規則が有効となるURLパターンに適用するレスポンス圧縮規則を設定します。

レスポンス圧縮規則は，フィルタ属性ファイルの<init-param>タグで定義します。初期化パラメタの名前（<param-name>タグ）には，圧縮規則名を指定します。また，初期化パラメタの値（<param-value>タグ）には，圧縮するHTTPレスポンスのMedia-Typeと圧縮しきい値を指定します。

Media-Type: HTTPレスポンス圧縮機能では，条件として指定したMedia-TypeがHTTPレスポンスに含まれる場合に，HTTPレスポンスを圧縮します。

圧縮しきい値: 圧縮しきい値とは，HTTPレスポンスボディのサイズによって，HTTPレスポンスを圧縮するかどうかを判定するためのしきい値です。HTTPレスポンス圧縮機能では，HTTPレスポンスボディのサイズが圧縮しきい値に定義したサイズを超える場合に，HTTPレスポンスを圧縮します。; 圧縮しきい値を定義することで，HTTPレスポンスのサイズが小さい場合に，HTTPレスポンスの圧縮に掛かる時間が，通信に掛かる時間よりも大きくならないようにします。; 圧縮しきい値は，圧縮するリソースの種別と通信回線の速度によって適切なサイズが決まるので，圧縮しきい値に定義するサイズは実測で求め，適切なサイズを定義することをお勧めします。圧縮しきい値は，100から2,147,483,647までの整数値で指定します。デフォルトの設定では，すべてのMedia-Typeに対して圧縮しきい値「100」が適用されます。

パラメタ指定時の規則を示します。

Media-Typeにアスタリスク（*）を指定した場合は，すべてのMedia-Typeを表します。ただし，Media-Typeごとの指定がある場合は，Media-Typeごとの指定が優先されます。
Media-Typeは，大文字と小文字が区別されません。
Media-Typeと圧縮しきい値は，半角のコロン（:）で区切ります。
複数指定する場合は半角のセミコロン（;）で区切ります。
同じMedia-Typeを複数指定した場合はあとに指定したものが使用されます。
パラメタ値の改行・タブ・スペースは無視されます。
パラメタ値の末尾にある半角のセミコロン（;）は無視されます。

(2)　注意事項

HTTPレスポンス圧縮フィルタの設定時の注意事項を次に示します。

レスポンス圧縮用フィルタの初期化時に，フィルタ属性ファイルに定義された初期化パラメタの妥当性をチェックします。ここで初期化パラメタに定義された値に問題がある場合は，フィルタの初期化処理でエラーとなり，Webアプリケーションは開始しません。
リクエストURLがurl-mappingパラメタに指定したURLパターンに一致しても，レスポンス圧縮用フィルタがマッピングされているURLパターンに一致しない場合は，url-mappingパラメタに指定したレスポンス圧縮規則が適用されることはありません。
レスポンス圧縮フィルタに複数のURLパターンをマッピングする場合は，リクエストURLが同時に複数のURLパターンに一致しないようにフィルタマッピングの定義を記述する必要があります。複数のURLパターンに対して異なるレスポンス圧縮機能を設定する場合は，url-mappingパラメタに複数のURLパターンを指定してください。
セッションフェイルオーバ機能を使用している場合は，セッションフェイルオーバ用フィルタのフィルタマッピングの定義よりも下にレスポンス圧縮フィルタのフィルタマッピングの定義を記述してください。
WebアプリケーションのバージョンがServlet2.4の場合，<filter-mapping>タグの要素，および<dispatcher>タグは指定しないでください。また，<dispatcher>タグで「FORWARD」，「INCLUDE」，「ERROR」を指定した場合，Webアプリケーションの開始時にエラーが発生し，アプリケーションが開始できないので，注意してください。

(3)　属性ファイルの記述例

次に示すそれぞれの場合を例に，属性ファイルの記述例を示します。

HTTPレスポンスのボディサイズで圧縮条件を指定する場合
URLパターンで圧縮条件を指定する場合
HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合
圧縮条件を組み合わせて指定する場合

(a)　HTTPレスポンスのボディサイズで圧縮条件を指定する場合

HTTPレスポンスのボディサイズで圧縮条件を指定する場合の記述例を示します。

フィルタ属性ファイルの記述例

　　 （省略）
　　　　：
<filter>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <filter-class>com.hitachi.software.was.web.ResponseCompressionFilter</filter-class>
    <init-param>
        <param-name>url-mapping</param-name>
        <param-value>
         /*=rule1;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule1</param-name>
        <param-value>
         *:1000;
        </param-value>
    </init-param>
</filter>
　　　　：
　　 （省略）

WAR属性ファイルの記述例

　　 （省略）
　　　　：
<filter-mapping>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
　　　　：
　　 （省略）

記述例では，URLパターンが「/*」のアクセスに対するHTTPレスポンスで，ボディサイズが1,000バイトを超えるものを圧縮します。

(b)　URLパターンで圧縮条件を指定する場合

URLパターンで圧縮条件を指定する場合の定義例を示します。

フィルタ属性ファイルの記述例

　　 （省略）
　　　　：
<filter>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <filter-class>com.hitachi.software.was.web.ResponseCompressionFilter</filter-class>
    <init-param>
        <param-name>url-mapping</param-name>
        <param-value>
         /app/dir/*=rule1;
         *.html=rule1;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule1</param-name>
        <param-value>
         *:100;
        </param-value>
    </init-param>
</filter>
　　　　：
　　 （省略）

WAR属性ファイルの記述例

　　 （省略）
　　　　：
<filter-mapping>
   <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <url-pattern>/app/*</url-pattern>
</filter-mapping>
　　　　：
　　 （省略）

記述例では，URLパターンが「/app/*」のアクセスに対するHTTPレスポンスで次の条件を満たすものを圧縮します。

HTTPリクエストのURLパターンが「/app/dir/*」で，ボディサイズが100バイトを超えるHTTPレスポンス
HTTPリクエストのURLパターンが「*.html」で，ボディサイズが100バイトを超えるHTTPレスポンス

(c)　HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合

HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合の定義例を示します。

フィルタ属性ファイルの記述例

　　 （省略）
　　　　：
<filter>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <filter-class>com.hitachi.software.was.web.ResponseCompressionFilter</filter-class>
    <init-param>
        <param-name>url-mapping</param-name>
        <param-value>
         /*=rule1;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule1</param-name>
        <param-value>
         text/html:500;
         application/pdf:1000;
        </param-value>
    </init-param>
</filter>
　　　　：
　　 （省略）

WAR属性ファイルの記述例

　　 （省略）
　　　　：
<filter-mapping>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
　　　　：
　　 （省略）

記述例はURLパターンが「/*」のアクセスに対するHTTPレスポンスで次の条件を満たすものを圧縮します。

Media-Typeが「text/html」でボディサイズが500バイトを超えるHTTPレスポンス
Media-Typeが「application/pdf」でボディサイズが1,000バイトを超えるHTTPレスポンス

(d)　圧縮条件を組み合わせて指定する場合

次に示す例のように，圧縮条件を組み合わせて定義することもできます。

フィルタ属性ファイルの記述例

　　 （省略）
　　　　：
<filter>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <filter-class>com.hitachi.software.was.web.ResponseCompressionFilter</filter-class>
    <init-param>
        <param-name>url-mapping</param-name>
        <param-value>
         /app/dir1/*=rule1;
         /app/dir2/*=rule2;
         *.html=rule3;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule1</param-name>
        <param-value>
         *:500;
         application/pdf:1000;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule2</param-name>
        <param-value>
         application/pdf:2000;
        </param-value>
    </init-param>
    <init-param>
        <param-name>rule3</param-name>
        <param-value>
         *:100;
        </param-value>
    </init-param>
</filter>
　　　　：
　　 （省略）

WAR属性ファイルの記述例

　　 （省略）
　　　　：
<filter-mapping>
    <filter-name>com.hitachi.software.was.web.ResponseCompressionFilter</filter-name>
    <url-pattern>/app/*</url-pattern>
</filter-mapping>
　　　　：
　　 （省略）

定義例では，URLパターンが「/app/*」のアクセスに対するHTTPレスポンスで次の条件を満たすものを圧縮します。

HTTPリクエストのURLパターンが「/app/dir1/*」でMedia-Typeが「application/pdf」以外，ボディサイズが500バイトを超えるHTTPレスポンス
HTTPリクエストのURLパターンが「/app/dir1/*」でMedia-Typeが「application/pdf」，ボディサイズが1,000バイトを超えるHTTPレスポンス
HTTPリクエストのURLパターンが「/app/dir2/*」でMedia-Typeが「application/pdf」，ボディサイズが2,000バイトを超えるHTTPレスポンス
HTTPリクエストのURLパターンが「*.html」でボディサイズが100バイトを超えるHTTPレスポンス

9.7.3　HTTPレスポンス圧縮フィルタの設定

(1)　HTTPレスポンス圧縮フィルタのWebアプリケーションへの組み込み

(a)　URLパターンとHTTPレスポンス圧縮規則のマッピングについて

(b)　HTTPレスポンス圧縮規則について

(2)　注意事項

(3)　属性ファイルの記述例

(a)　HTTPレスポンスのボディサイズで圧縮条件を指定する場合

(b)　URLパターンで圧縮条件を指定する場合

(c)　HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合

(d)　圧縮条件を組み合わせて指定する場合

9.7.3 HTTPレスポンス圧縮フィルタの設定

(1) HTTPレスポンス圧縮フィルタのWebアプリケーションへの組み込み

(a) URLパターンとHTTPレスポンス圧縮規則のマッピングについて

(b) HTTPレスポンス圧縮規則について

(2) 注意事項

(3) 属性ファイルの記述例

(a) HTTPレスポンスのボディサイズで圧縮条件を指定する場合

(b) URLパターンで圧縮条件を指定する場合

(c) HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合

(d) 圧縮条件を組み合わせて指定する場合

9.7.3　HTTPレスポンス圧縮フィルタの設定

(1)　HTTPレスポンス圧縮フィルタのWebアプリケーションへの組み込み

(a)　URLパターンとHTTPレスポンス圧縮規則のマッピングについて

(b)　HTTPレスポンス圧縮規則について

(2)　注意事項

(3)　属性ファイルの記述例

(a)　HTTPレスポンスのボディサイズで圧縮条件を指定する場合

(b)　URLパターンで圧縮条件を指定する場合

(c)　HTTPレスポンスのMedia-Typeで圧縮条件を指定する場合

(d)　圧縮条件を組み合わせて指定する場合