Apache Tomcat 11

• はじめに
• インストール
• サーブレット設定
• フィルタ設定
• ディレクティブ
• 変数

SSI（サーバーサイドインクルード）は、HTMLページに配置され、ページが提供される際にサーバー上で評価されるディレクティブです。これにより、CGIプログラムやその他の動的技術を介してページ全体を提供する手間なく、動的に生成されたコンテンツを既存のHTMLページに追加できます。

Tomcat内でSSIサポートは、TomcatをHTTPサーバーとして使用し、SSIサポートが必要な場合に追加できます。通常、これはApacheのようなWebサーバーを起動したくない開発中に実行されます。

TomcatのSSIサポートは、Apacheと同じSSIディレクティブを実装しています。SSIディレクティブの使用については、Apache SSI入門を参照してください。

SSIサポートはサーブレットとしてもフィルターとしても利用可能です。SSIサポートを提供するには、どちらか一方を使用し、両方を使用しないでください。

サーブレットベースのSSIサポートは、クラス org.apache.catalina.ssi.SSIServlet を使用して実装されています。従来、このサーブレットはURLパターン「*.shtml」にマッピングされます。

フィルターベースのSSIサポートは、クラス org.apache.catalina.ssi.SSIFilter を使用して実装されています。従来、このフィルターはURLパターン「*.shtml」にマッピングされますが、MIMEタイプに基づいてSSI処理を選択的に有効/無効にするため、「*」にマッピングすることも可能です。`contentType` initパラメーターを使用すると、JSPページ、JavaScript、またはその他の任意のコンテンツにSSI処理を適用できます。

デフォルトでは、TomcatでSSIサポートは無効になっています。

注意 - SSIディレクティブは、Tomcat JVMの外部のプログラムを実行するために使用される可能性があります。

SSIサーブレットを使用するには、$CATALINA_BASE/conf/web.xml 内のSSIサーブレットとサーブレットマッピングの設定を囲んでいるXMLコメントを削除します。

SSIフィルターを使用するには、$CATALINA_BASE/conf/web.xml 内のSSIフィルターとフィルターマッピングの設定を囲んでいるXMLコメントを削除します。

特権としてマークされたコンテキストのみがSSI機能を使用できます（Context要素の`privileged`プロパティを参照）。

SSIサーブレットの動作を設定するために使用できるサーブレット初期化パラメーターがいくつかあります。

• buffered - このサーブレットからの出力はバッファリングされますか？ (0=false, 1=true) デフォルトは0 (false)です。
• debug - このサーブレットによってログに記録されるメッセージのデバッグ詳細レベル。デフォルトは0です。
• expires - SSIディレクティブを含むページが期限切れになるまでの秒数。デフォルトの動作では、すべてのSSIディレクティブがすべてのリクエストに対して評価されます。
• isVirtualWebappRelative - 「仮想」SSIディレクティブパスは、サーバールートではなく、コンテキストルートからの相対パスとして解釈されるべきですか？デフォルトはfalseです。
• inputEncoding - SSIリソースのエンコーディングがリソース自体から判別できない場合に想定されるエンコーディング。デフォルトはプラットフォームのデフォルトエンコーディングです。
• outputEncoding - SSI処理の結果に使用されるエンコーディング。デフォルトはUTF-8です。
• allowExec - `exec`コマンドは有効ですか？デフォルトはfalseです。

SSIフィルターの動作を設定するために使用できるフィルター初期化パラメーターがいくつかあります。

• contentType - SSI処理が適用される前に一致する必要がある正規表現パターン。独自のパターンを作成する際は、MIMEコンテンツタイプが「mime/type; charset=set」の形式でオプションの文字セットを伴う場合があることを考慮に入れるのを忘れないでください。デフォルトは「text/x-server-parsed-html(;.*)?」です。
• debug - このサーブレットによってログに記録されるメッセージのデバッグ詳細レベル。デフォルトは0です。
• expires - SSIディレクティブを含むページが期限切れになるまでの秒数。デフォルトの動作では、すべてのSSIディレクティブがすべてのリクエストに対して評価されます。
• isVirtualWebappRelative - 「仮想」SSIディレクティブパスは、サーバールートではなく、コンテキストルートからの相対パスとして解釈されるべきですか？デフォルトはfalseです。
• allowExec - `exec`コマンドは有効ですか？デフォルトはfalseです。

サーバーサイドインクルードは、SSIサーブレットによって処理されるタイプのHTMLドキュメントにSSIディレクティブを埋め込むことによって呼び出されます。ディレクティブはHTMLコメントの形式を取ります。ディレクティブは、ページをクライアントに送信する前に解釈された結果に置き換えられます。ディレクティブの一般的な形式は次のとおりです。

<!--#directive [param=value] -->

ディレクティブは次のとおりです

• config - <!--#config errmsg="Error occurred" sizefmt="abbrev" timefmt="%B %Y" --> SSIエラーメッセージ、およびSSIによって処理される日付とファイルサイズの形式を設定するために使用されます。
  すべてオプションですが、少なくとも1つは使用する必要があります。利用可能なオプションは次のとおりです
  errmsg - SSIエラーに使用されるエラーメッセージ
  sizefmt - fsize ディレクティブでのサイズに使用される形式
  timefmt - flastmod ディレクティブでのタイムスタンプに使用される形式
  
• echo - <!--#echo var="VARIABLE_NAME" encoding="entity" --> は変数の値に置き換えられます。
  オプションの encoding パラメーターは、使用するエンコーディングのタイプを指定します。有効な値は entity (デフォルト)、url または none です。注：entity 以外のエンコーディングを使用すると、セキュリティ上の問題につながる可能性があります。
• exec - <!--#exec cmd="file-name" --> ホストシステムでコマンドを実行するために使用されます。
• exec - <!--#exec cgi="file-name" --> これは include virtual ディレクティブと同じように動作し、実際にはどのコマンドも実行しません。
• include - <!--#include file="file-name" --> は内容を挿入します。パスは、このディレクティブが使用されているドキュメントからの相対パスとして解釈され、コンテキストルートまたはサーバールートからの「仮想」パスではありません。
• include - <!--#include virtual="file-name" --> は内容を挿入します。パスは、コンテキストルートまたはサーバールートのいずれかからの相対パスである「仮想」パスとして解釈されます（isVirtualWebappRelative パラメーターによって異なります）。
• flastmod - <!--#flastmod file="filename.shtml" --> ファイルが最後に変更された時刻を返します。パスは、このディレクティブが使用されているドキュメントからの相対パスとして解釈され、コンテキストルートまたはサーバールートからの「仮想」パスではありません。
• flastmod - <!--#flastmod virtual="filename.shtml" --> ファイルが最後に変更された時刻を返します。パスは、コンテキストルートまたはサーバールートのいずれかからの相対パスである「仮想」パスとして解釈されます（isVirtualWebappRelative パラメーターによって異なります）。
• fsize - <!--#fsize file="filename.shtml" --> ファイルのサイズを返します。パスは、このディレクティブが使用されているドキュメントからの相対パスとして解釈され、コンテキストルートまたはサーバールートからの「仮想」パスではありません。
• fsize - <!--#fsize virtual="filename.shtml" --> ファイルのサイズを返します。パスは、コンテキストルートまたはサーバールートのいずれかからの相対パスである「仮想」パスとして解釈されます（isVirtualWebappRelative パラメーターによって異なります）。
• printenv - <!--#printenv --> 定義されているすべての変数の一覧を返します。
• set - <!--#set var="foo" value="Bar" --> は、ユーザー定義変数に値を割り当てるために使用されます。
• if elif endif else - 条件付きセクションを作成するために使用されます。例：

  <!--#config timefmt="%A" -->
  <!--#if expr="$DATE_LOCAL = /Monday/" -->
  <p>Meeting at 10:00 on Mondays</p>
  <!--#elif expr="$DATE_LOCAL = /Friday/" -->
  <p>Turn in your time card</p>
  <!--#else -->
  <p>Yoga class at noon.</p>
  <!--#endif -->

SSIディレクティブの使用に関する詳細については、Apache SSI入門を参照してください。

SSI変数は、jakarta.servlet.ServletRequest オブジェクトのリクエスト属性を介して実装され、SSIサーブレットに限定されません。「java.」、「javax.」、「sun」、または「org.apache.catalina.ssi.SSIMediator.」で始まる変数は予約されており、使用できません。

SSIサーブレットは現在、以下の変数を実装しています