このマニュアルには、Tomcat Servlet/JSP コンテナの動作を設定するために conf/server.xml ファイルに含めることができるすべての設定ディレクティブに関するリファレンス情報が含まれています。 特定のタスクを実行するためにどの構成ディレクティブを使用する必要があるかを説明するものではありません。それについては、メインインデックスページのさまざまなHow-Toドキュメントを参照してください。
Tomcat の構成ファイルは、スキーマレス XML としてフォーマットされています。要素と属性は大文字と小文字が区別されます。 Apache Ant スタイルの変数置換がサポートされています。propname という名前のシステムプロパティは、${propname} という構文を使用して構成ファイルで使用できます。 -D 構文を使用して設定されたもの、JVM によって自動的に利用可能になるもの、$CATALINA_BASE/conf/catalina.properties ファイルで構成されたものを含む、すべてのシステムプロパティを利用できます。
構成要素の説明は、次の主要なカテゴリに分類されています。
- トップレベル要素 -
<Server>は構成ファイル全体のルート要素であり、<Service>は Engine に関連付けられた Connectors のグループを表します。 - コネクタ - 特定の Service に対してリクエストを送信する (およびレスポンスを受信する) 外部クライアント間のインターフェイスを表します。
- コンテナ - 入ってくるリクエストを処理し、対応するレスポンスを作成するコンポーネントを表します。 Engine は Service に対するすべてのリクエストを処理し、Host は特定の仮想ホストに対するすべてのリクエストを処理し、Context は特定の Web アプリケーションに対するすべてのリクエストを処理します。
- ネストされたコンポーネント - コンテナの要素内にネストできる要素を表します。 一部の要素は任意のコンテナ内にネストできますが、他の要素は Context 内にのみネストできます。
各要素について、対応するドキュメントは次の一般的な概要に従います。
- 概要 - この特定のコンポーネントの全体的な説明。 対応する Java インターフェース (
org.apache.catalinaパッケージ内) があり、1 つ以上の標準実装によって実装されます。 - 属性 - この要素に対して有効な属性のセット。 一般に、これは、対応する Java インターフェースのすべての実装でサポートされている共通属性と、このインターフェースを実装する特定の Java クラスに固有の標準実装属性に細分化されます。 必須属性の名前は太字です。
- ネストされたコンポーネント - この要素内に合法的にネストできるネストされたコンポーネントを列挙します。
- 特別な機能 - このインターフェースの標準実装でサポートされている、さまざまな特別な機能 (各要素タイプに固有) の構成について説明します。