付録A リファレンス資料

A.1. サーバーランタイム引数

アプリケーションサーバーの起動スクリプトは実行時に引数とスイッチを受け入れます。そのため、standalone.xmldomain.xml、および host.xml 設定ファイルに定義されていない他の設定でサーバーを起動できます。

他の設定には、ソケットバインディングの代替セットを持つサーバーの起動や 2 次設定が含まれていることがあります。

help スイッチ -h または --help を起動時に渡すと、利用可能なパラメーターのリストを使用できます。

表A.1 ランタイムスイッチおよび引数

引数またはスイッチ操作モード説明

--admin-only

Standalone

サーバーの実行タイプを ADMIN_ONLY に設定します。これにより管理インターフェースが開かれ、管理リクエストが許可されますが、他のランタイムサービスは起動されず、エンドユーザーのリクエストは許可されません。

--admin-only

Domain

ホストコントローラーの実行タイプを ADMIN_ONLY に設定します。これにより管理インターフェースが開かれ、管理リクエストが許可されますが、サーバーは起動しません。ホストコントローラーがドメインのマスターである場合はスレーブホストコントローラーからの受信接続が許可されます。

-b=<value>、-b <value>

Standalone、Domain

パブリックインターフェースのバインドアドレスを設定するために使用される jboss.bind.address システムプロパティーを設定します。値の指定がない場合は、デフォルトで 127.0.0.1 が指定されます。他のインターフェースにバインドアドレスを設定するには -b<interface>=<value> エントリーを確認します。

-b<interface>=<value>

Standalone、Domain

システムプロパティー jboss.bind.address.<interface> を指定の値に設定します (例: -bmanagement=IP_ADDRESS)。

--backup

Domain

このホストがドメインコントローラーではない場合でも永続ドメイン設定のコピーを保持します。

-c=<config>、-c <config>

Standalone

使用するサーバー設定ファイルの名前。デフォルトは standalone.xml です。

-c=<config>、-c <config>

Domain

使用するサーバー設定ファイルの名前。デフォルトは domain.xml です。

--cached-dc

Domain

ホストがドメインコントローラーではなく、起動時にドメインコントローラーに接続できない場合、ローカルでキャッシュされたドメイン設定のコピーを使用してブートします。

--debug [<port>]

Standalone

オプションの引数を用いてデバッグモードを有効にし、ポートを指定します。起動スクリプトがサポートする場合のみ動作します。

-D<name>[=<value>]

Standalone、Domain

システムプロパティーを設定します。

--domain-config=<config>

Domain

使用するサーバー設定ファイルの名前。デフォルトは domain.xml です。

-h、--help

Standalone、Domain

ヘルプメッセージを表示し、終了します。

--host-config=<config>

Domain

使用するホスト設定ファイルの名前。デフォルトは host.xml です。

--interprocess-hc-address=<address>

Domain

ホストコントローラーがプロセスコントローラーからの通信をリッスンしなければならないアドレス。

--interprocess-hc-port=<port>

Domain

ホストコントローラーがプロセスコントローラーからの通信をリッスンしなければならないポート。

--master-address=<address>

Domain

システムプロパティー jboss.domain.master.address を指定の値に設定します。デフォルトのスレーブホストコントローラーの設定では、マスターホストコントローラーのアドレスを設定するために使用されます。

--master-port=<port>

Domain

システムプロパティー jboss.domain.master.port を指定の値に設定します。デフォルトのスレーブホストコントローラーの設定では、マスターホストコントローラーによるネイティブ管理の通信で使用されるポートを設定するために使用されます。

--read-only-server-config=<config>

Standalone

使用するサーバー設定ファイルの名前。元のファイルは上書きされないため、--server-config および -c とは異なります。

--read-only-domain-config=<config>

Domain

使用するドメイン設定ファイルの名前。最初のファイルは上書きされないため、--domain-config および -c とは異なります。

--read-only-host-config=<config>

Domain

使用するホスト設定ファイルの名前。最初のファイルは上書きされないため、--host-config とは異なります。

-P=<url>、-P <url>、--properties=<url>

Standalone、Domain

該当する URL からシステムプロパティーをロードします。

--pc-address=<address>

Domain

プロセスコントローラーが制御するプロセスからの通信をリッスンするアドレス。

--pc-port=<port>

Domain

プロセスコントローラーが制御するプロセスからの通信をリッスンするポート。

-S<name>[=<value>]

Standalone

セキュリティープロパティーを設定します。

-secmgr

Standalone、Domain

セキュリティーマネージャーがインストールされた状態でサーバーを実行します。

--server-config=<config>

Standalone

使用するサーバー設定ファイルの名前。デフォルトは standalone.xml です。

-u=<value>、-u <value>

Standalone、Domain

設定ファイルの socket-binding 要素のマルチキャストアドレスを設定するために使用される jboss.default.multicast.address システムプロパティーを設定します。値の指定がない場合はデフォルトで 230.0.0.4 が指定されます。

-v、-V、--version

Standalone、Domain

アプリケーションサーバーのバージョンを表示し、終了します。

警告

JBoss EAP に同梱される設定ファイルは、スイッチ (-b-u など) を処理するよう設定されます。スイッチによって制御されるシステムプロパティーを使用しないよう設定ファイルを変更した場合は、実行するコマンドにスイッチを追加しても効果はありません。

A.2. RPM サービス設定ファイル

JBoss EAP の RPM インストールには、ZIP またはインストーラーインストールよりも 2 つ多い設定ファイルが含まれています。これらのファイルは、JBoss EAP の起動環境を指定するために、サービス初期化スクリプトによって使用されます。これらのサービス設定ファイルの場所は、Red Hat Enterprise Linux 6 と Red Hat Enterprise Linux 7 では異なります。

表A.2 Red Hat Enterprise Linux 6 の RPM 設定ファイル

File説明

/etc/sysconfig/eap7-standalone

Red Hat Enterprise Linux 6 のスタンドアロン JBoss EAP サーバーに固有する設定

/etc/sysconfig/eap7-domain

Red Hat Enterprise Linux 6 で管理対象ドメインとして実行されている JBoss EAP に固有する設定

表A.3 Red Hat Enterprise Linux 7 の RPM 設定ファイル

File説明

/etc/opt/rh/eap7/wildfly/eap7-standalone.conf

Red Hat Enterprise Linux 7 のスタンドアロン JBoss EAP サーバーに固有する設定

/etc/opt/rh/eap7/wildfly/eap7-domain.conf

Red Hat Enterprise Linux 7 で管理対象ドメインとして実行されている JBoss EAP に固有する設定

A.3. RPM サービス設定プロパティー

以下の表は、JBoss EAP RPM サービスで使用できる設定プロパティーと、そのデフォルト値のリストになります。

注記

同じ名前のプロパティーが RPM サービス設定ファイル (例: /etc/sysconfig/eap7-standalone) と JBoss EAP 起動設定ファイル (例: EAP_HOME/bin/standalone.conf) にある場合、JBoss EAP 起動設定ファイルのプロパティーの値が優先されます。このようなプロパティーの 1 つが JAVA_HOME です。

表A.4 RPM サービス設定プロパティー

プロパティー説明

JAVA_HOME

Java Runtime Environment がインストールされたディレクトリー。

デフォルト値: /usr/lib/jvm/jre

JAVAPTH

Java 実行可能ファイルがインストールされたパス。

デフォルト値: $JAVA_HOME/bin

WILDFLY_STARTUP_WAIT

start または restart コマンドを受け取った後にサーバーが正常に起動されたことを確認するまで、初期化スクリプトが待機する秒数。このプロパティーは、Red Hat Enterprise Linux 6 のみに適用されます。

デフォルト値: 60

WILDFLY_SHUTDOWN_WAIT

stop または restart コマンドの受信時、続行する前に初期化スクリプトがサーバーのシャットダウンを待機する秒数。このプロパティーは、Red Hat Enterprise Linux 6 のみに適用されます。

デフォルト値: 20

WILDFLY_CONSOLE_LOG

CONSOLE ログハンドラーがリダイレクトされるファイル。

デフォルト値: スタンドアロンサーバーの場合は /var/opt/rh/eap7/log/wildfly/standalone/console.log、管理対象ドメインの場合は /var/opt/rh/eap7/log/wildfly/domain/console.log

WILDFLY_SH

JBoss EAP サーバーを起動するために使用されるスクリプト。

デフォルト値: スタンドアロンサーバーの場合は /opt/rh/eap7/root/usr/share/wildfly/bin/standalone.sh、管理対象ドメインの場合は /opt/rh/eap7/root/usr/share/wildfly/bin/domain.sh

WILDFLY_SERVER_CONFIG

使用するサーバー設定ファイル。

このプロパティーにはデフォルト値がありません。開始時に standalone.xml または domain.xml を定義できます。

WILDFLY_HOST_CONFIG

管理対象ドメインでは、このプロパティーによってユーザーはホスト設定ファイル (host.xml など) を指定できます。デフォルトとして設定されている値はありません。

WILDFLY_MODULEPATH

JBoss EAP モジュールディレクトリーのパス。

デフォルト値: /opt/rh/eap7/root/usr/share/wildfly/modules

WILDFLY_BIND

パブリックインターフェースのバインドアドレスを設定するために使用される jboss.bind.address システムプロパティーを設定します。値の指定がない場合、0.0.0.0 がデフォルトとして使用されます。

A.4. JBoss EAP サブシステムの概要

以下の表は、JBoss EAP のサブシステムを簡単に説明します。

表A.5 JBoss EAP サブシステム

JBoss EAP サブシステム説明

batch-jberet

バッチアプリケーションを実行する環境を設定 し、バッチジョブを管理します。

bean-validation

Java オブジェクトデータを検証するために bean バリデーションを設定します。

datasources

データソースを作成および設定し、JDBC データベースドライバーを管理します。

deployment-scanner

アプリケーションがデプロイする特定の場所を監視するためにデプロイメントスキャナーを設定します。

ee

グローバルモジュールの定義、 記述子ベースのプロパティー置換の有効化、およびデフォルトバインディングの設定など、Java EE プラットフォームで一般的な機能を設定します。

ejb3

セッション Bean やメッセージ駆動型 Bean を含むエンタープライズ JavaBean (EJB) を設定します。

ejb3 サブシステムの詳細は、JBoss EAP の Developing EJB Applications を参照してください。

iiop-openjdk

JTS トランザクションの CORBA (Common Object Request Broker Architecture) サービスおよびセキュリティーを含むその他の ORB サービスを設定します。JBoss EAP 6 ではこの機能は jacorb サブシステムに含まれていました。

infinispan

JBoss EAP の高可用性サービスの キャッシング 機能を設定します。

io

他のサブシステムによって使用される ワーカーおよびバッファープールを定義します。

jaxrs

JAX-RS アプリケーションのデプロイメントおよび機能を有効にします。

jca

JCA (Java EE Connector Architecture) コンテナーおよびリソースアダプターデプロイメントの一般設定を行います。

jdr

トラブルシューティングに役立つ診断データの収集を有効にします。JBoss EAP のサブスクライバーはサポートをリクエストするときにこの情報を Red Hat に提供できます。

jgroups

クラスターのサーバーがお互いに対話するためのプロトコルスタックと通信メカニズムを設定します。

jmx

リモート JMX (Java Management Extensions) のアクセスを設定します。

jpa

JPA (Java Persistence API) 2.1 のコンテナ管理の要件を管理し、永続ユニットの定義、アノテーション、および記述子のデプロイを可能にします。

jpa サブシステムの詳細は、JBoss EAP 開発ガイドを参照してください。

jsf

JSF (JavaServer Faces) 実装を管理します。

jsr77

JSR-77 仕様によって定義された Java EE 管理機能を提供します。

logging

ログカテゴリーおよびログハンドラーを介してシステムおよびアプリケーションレベルのロギングを設定します。

mail

メールサーバーの属性カスタムメールトランスポートを設定して、JBoss EAP へデプロイされたアプリケーションがメールを送信できるメールサービスを作成します。

messaging-activemq

統合メッセージングプロバイダーである Artemis の JMS 宛先、接続ファクトリー、およびその他の設定を設定します。JBoss EAP 6 では、メッセージング機能は messaging サブシステムに含まれていました。

messaging-activemq サブシステムの詳細は、JBoss EAP の Configuring Messaging を参照してください。

modcluster

サーバー側の mod_cluster ワーカーノードを設定します。

naming

エントリーをグローバル JNDI 名前空間にバインドし、リモート JNDI インターフェースを設定します。

picketlink-federation

PicketLink SAML ベースのシングルサインオン (SSO) を設定します。

picketlink-federation サブシステムの詳細は、JBoss EAP の How To Set Up SSO with SAML v2 を参照してください。

picketlink-identity-management

PicketLink アイデンティティー管理サービスを設定します。このサブシステムはサポート対象外です。

pojo

過去のバージョンの JBoss EAP でサポートされたように、JBoss Microcontainer サービスが含まれるアプリケーションのデプロイメントを有効にします。

remoting

ローカルおよび リモートサービスのインバウンドおよびアウトバウンド接続を設定します。

request-controller

サーバーを正常に停止およびシャットダウンするよう設定します。

resource-adapters

JCA (Java Connector Architecture) 仕様を使用して Java EE アプリケーションおよび EIS (Enterprise Information System) 間の通信を行うためにリソースアダプターを設定および維持します。

rts

REST-AT のサポート対象外の実装。

sar

過去のバージョンの JBoss EAP でサポートされたように、MBean サービスが含まれる SAR アーカイブのデプロイメントを有効にします。

security

アプリケーションのセキュリティーを設定します。

security サブシステムの詳細は、JBoss EAP の Security Architecture を参照してください。

security-manager

Java Security Manager によって使用される Java セキュリティーポリシーを設定します。

security-manager サブシステムの詳細は、JBoss EAP の How to Configure Server Security を参照してください。

singleton

シングルトンポリシーを定義して、シングルトンデプロイメントの動作を設定したり、シングルトン MSC サービスを作成したりします。

singleton サブシステムの詳細は、JBoss EAP の 開発ガイドを参照してください。

transactions

タイムアウト値やトランザクションロギングなどのトランザクションマネージャーのオプション と、JTS (Java Transaction Service) を使用するかどうかを設定します。

undertow

JBoss EAP の web サーバーおよびサーブレットコンテナーを設定します。JBoss EAP 6 では、この機能は web サブシステムに含まれていました。

webservices

パブリッシュされたエンドポイントアドレスおよびエンドポイントハンドラーチェーンを設定します。また、Web サービスプロバイダーのホスト名、ポート、および WSDL アドレスも設定します。

webservices サブシステムの詳細は、JBoss EAP の Developing Web Services Applications を参照してください。

weld

JBoss EAP の CDI (Contexts and Dependency Injection) を設定します。

xts

トランザクションの Web サービスの調整を設定します。

A.5. Add-User ユーティリティー引数

以下の表は、add-user.sh または add-user.bat スクリプトで使用できる引数を示しています。これらのスクリプトは既定の認証のプロパティーファイルに新しいユーザーを追加するためのユーティリティーです。

表A.6 add-user コマンド引数

コマンドライン引数説明

-a

アプリケーションレルムでユーザーを作成します。省略した場合、デフォルトでは管理レルムでユーザーが作成されます。

-dc <value>

プロパティーファイルが含まれるドメイン設定ディレクトリー。省略した場合、デフォルトのディレクトリーは EAP_HOME/domain/configuration/ になります。

-sc <value>

プロパティーファイルが含まれる代替のスタンドアロンサーバー設定ディレクトリー。省略した場合、デフォルトのディレクトリーは EAP_HOME/standalone/configuration/ になります。

-up、--user-properties <value>

代替のユーザープロパティーファイルの名前。絶対パスを使用でき、代替の設定ディレクトリーを指定する -sc または -dc 引数と共に使用されるファイル名を使用することもできます。

-g、--group <value>

このユーザーに割り当てるグループのコンマ区切りリスト。

-gp、--group-properties <value>

代替のグループプロパティーファイルの名前。絶対パスを使用でき、代替の設定ディレクトリーを指定する -sc または -dc 引数と共に使用されるファイル名を使用することもできます。

-p、--password <value>

ユーザーのパスワード。

-u、--user <value>

ユーザーの名前。英数字と ,./=@\ のみが有効です。

-r、--realm <value>

管理インターフェースをセキュアにするために使用されるレルムの名前。省略した場合、デフォルト値は ManagementRealm です。

-s、--silent

コンソールへ出力せずに add-user スクリプトを実行します。

-e、--enable

ユーザーを有効にします。

-d、--disable

ユーザーを無効にします。

-cw、--confirm-warning

対話モードで自動的に警告を確認します。

-h、--help

add-user スクリプトの使用情報を表示します。

A.6. 管理監査ロギング属性

表A.7 ロガー属性

属性説明

enabled

監査ロギングが有効になっているかどうか。

log-boot

操作がサーバーの起動時にログに記録されるかどうか。

log-read-only

設定を変更しない操作またはランタイムサービスがログに記録されるかどうか。

表A.8 ログフォーマッター属性

属性説明

compact

true の場合、JSON を 1 行でフォーマットします。新しい行が含まれる値が存在する可能性があるため、レコード全体を 1 行にするのが重要な場合は、 escape-new-line または escape-control-characterstrue に設定します。

date-format

java.text.SimpleDateFormat が理解するように使用するデータ形式。include-datefalse に設定されている場合は無視されます。

date-separator

日付と他のフォーマットされたログメッセージのセパレーター。include-datefalse に設定されている場合は無視されます。

escape-control-characters

true の場合、すべての制御文字 (10 進値が 32 を超える ASCII エントリー) を 8 進の ASCII コードでエスケープします。たとえば、新しい行は #012 になります。true の場合、escape-new-line=false を上書きします。

escape-new-line

true の場合、新しい行を 8 進の ASCII コードでエスケープします (#012)。

include-date

フォーマットされたログレコードに日付が含まれるかどうか。

表A.9 ファイルハンドラー属性

属性説明

disabled-due-to-failure

ロギングの失敗によりこのハンドラーが無効になったかどうか (読み取り専用)。

failure-count

ハンドラーが初期化された後に発生したロギング失敗数 (読み取り専用)。

formatter

ログメッセージのフォーマットに使用される JSON フォーマッター。

max-failure-count

このハンドラーを無効化する前の最大ロギング失敗数。

path

監査ログファイルのパス。

relative-to

以前指定された別のパスの名前、またはシステムによって提供される標準的なパスの 1 つ。relative-to が指定された場合、path 属性の値は、この属性によって指定されたパスへの相対値としてみなされます。

表A.10 syslog ハンドラー属性

属性説明

app-name

RFC-5424 のセクション 6.2.5 で定義された syslog レコードに追加するアプリケーション名。指定されない場合、デフォルト値は製品の名前になります。

disabled-due-to-failure

ロギングの失敗によりこのハンドラーが無効になったかどうか (読み取り専用)。

facility

RFC-5424 のセクション 6.2.1 と RFC-3164 のセクション 4.1.1 で定義された syslog ロギングに使用する機能。

failure-count

ハンドラーが初期化された後に発生したロギング失敗数 (読み取り専用)。

formatter

ログメッセージのフォーマットに使用される JSON フォーマッター。

max-failure-count

このハンドラーを無効化する前の最大ロギング失敗数。

max-length

許可される、ヘッダーを含むログメッセージの最大長 (バイト単位)。未定義の場合、デフォルト値は 1024 バイト (syslog-formatRFC3164 の場合) または 2048 バイト (syslog-formatRFC5424 の場合) になります。

protocol

syslog ハンドラーに使用するプロトコル。udptcp、または tls のいずれか 1 つである必要があります。

syslog-format

syslog 形式: RFC5424 または RFC3164.

truncate

ヘッダーを含むメッセージの長さ (バイト単位)が max-length 属性の値よりも大きい場合、そのメッセージを省略するかどうか。false に設定すると、メッセージが分割され、同じヘッダー値で送信されます。

注記

syslog サーバーごとに実装が異なるため、すべての設定をすべての syslog サーバーに適用できるとは限りません。テストは rsyslog syslog 実装を使用して実行されています。

次の表には、高度な属性のみがリストされています。各属性は設定パラメーターを持ち、一部の属性は個設定パラメーターを持ちます。

A.7. インターフェース属性

表A.11 インターフェース属性と値

インターフェース要素説明

any

インターフェースの選択基準の一部は、最低でも基準のネストされたセットの 1 つ (すべてとは限らない) を満たす必要があることを示す要素。

any-address

このインターフェースを使用するソケットをワイルドカードアドレスにバインドする必要があることを示す空の要素。java.net.preferIPv4Stack システムプロパティーが true に設定されていない限り、IPv6 ワイルドカードアドレス (::) が使用されます。true に設定された場合は、IPv4 ワイルドカードアドレス (0.0.0.0) が使用されます。ソケットがデュアルスタックマシンの IPv6 anylocal アドレスにバインドされた場合は、IPv6 および IPv4 トラフィックを受け入れることができます。IPv4 (IPv4 マッピング) anylocal アドレスにバインドされた場合は、IPv4 トラフィックのみを受け入れることができます。

inet-address

IPv6 または IPv4 のドット区切り表記の IP アドレス、または IP アドレスに解決できるホスト名。

link-local-address

インターフェースの選択基準の一部として、関連付けられたアドレスがリンクローカルであるかどうかを示す空の要素。

loopback

インターフェースの選択基準の一部として、ループバックインターフェースであるかどうかを示す空の要素。

loopback-address

マシンのループバックインターフェースで実際には設定できないループバックアドレス。IP アドレスが関連付けられた NIC が見つからない場合であっても該当する値が使用されるため、inet-address タイプとは異なります。

multicast

インターフェースの選択基準の一部として、マルチキャストをサポートするかどうかを示す空の要素。

nic

ネットワークインターフェースの名前 (eth0、eth1、lo など)。

nic-match

使用できるインターフェースを見つけるために、マシンで利用可能なネットワークインターフェースの名前を検索する正規表現。

not

インターフェースの選択基準の一部は、基準のネストされたセットを満たしてはならないことを示す要素。

point-to-point

インターフェースの選択基準の一部として、ポイントツーポイントインターフェースであるかどうかを示す空の要素。

public-address

インターフェースの選択基準の一部として、公開されたルーティング可能なアドレスを持つかどうかを示す空の要素。

site-local-address

インターフェースの選択基準の一部として、関連付けられたアドレスがサイトローカルであるかどうかを示す空の要素。

subnet-match

「スラッシュ表記法」で記述されたネットワーク IP アドレスとアドレスのネットワーク接頭辞のビット数 (たとえば、192.168.0.0/16)。

up

インターフェースの選択基準の一部として、現在稼動しているかどうかを示す空の要素。

virtual

インターフェースの選択基準の一部として、仮想インターフェースであるかどうかを示す空の要素。

A.8. ソケットバインディング属性

表A.12 ソケットバインディング属性

属性説明

client-mappings

このソケットバインディングのクライアントマッピングを指定します。このソケットへ接続するクライアントは、希望のアウトバウンドインターフェースと一致するマッピングに指定された宛先アドレスを使用する必要があります。これにより、ネットワークアドレスの変換を使用する高度なネットワークトポロジーまたは複数のネットワークインターフェースにバインディングを持つ高度なネットワークトポロジーが機能します。各マッピングは宣言された順序で評価される必要があり、最初に一致したマッピングを使用して宛先が決定されます。

fixed-port

ソケットグループの他のソケットに数値のオフセットが適用された場合でもポートの値を固定したままにするかどうか。

interface

ソケットがバインドされる必要があるインターネットの名前、またはマルチキャストソケットの場合はリッスンするインターフェース。宣言されたインターフェースの 1 つである必要があります。定義されないと、エンクロージングソケットバインディンググループからの default-interface の値が使用されます。

multicast-address

ソケットがマルチキャストトラフィックを受信するマルチキャストアドレス。指定しないと、ソケットがマルチキャストを受信するよう設定されません。

multicast-port

ソケットがマルチキャストトラフィックを受信するポート。multicast-address が設定されている場合に設定する必要があります。

name

ソケットの名前。ソケット設定情報にアクセスする必要があるサービスは、この名前を使用してソケット設定情報を探します。必須の属性です。

port

ソケットがバインドされる必要があるポートの番号。サーバーによってポートオフセットが適用され、ポートの値がすべて増加または減少される場合、この値は上書きされることに注意してください。

A.9. デフォルトのソケットバインディング

表A.13 デフォルトのソケットバインディング

名前ポートマルチキャストポート説明ソケットバインディンググループ

ajp

8009

 

Apache JServ プロトコル。HTTP クラスタリングおよび負荷分散に使用されます。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

http

8080

 

デプロイされた Web アプリケーションのデフォルトポート。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

https

8443

 

デプロイされた Web アプリケーションとクライアントとの間の SSL で暗号化された接続。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

iiop

3528

 

JTS トランザクションおよび他の ORB 依存サービス用の CORBA サービス。

full-sockets、full-ha-sockets

iiop-ssl

3529

 

SSL 暗号化 CORBA サービス。

full-sockets、full-ha-sockets

jgroups-mping

 

45700

マルチキャスト。HA クラスターでの初期メンバーシップの検出に使用されます。

ha-sockets、full-ha-sockets

jgroups-tcp

7600

 

TCP を使用した、HA クラスター内でのユニキャストピア検出。

ha-sockets、full-ha-sockets

jgroups-tcp-fd

57600

 

TCP を介した HA 障害検出に使用されます。

ha-sockets、full-ha-sockets

jgroups-udp

55200

45688

UDP を使用した、HA クラスター内でのマルチキャストピア検出。

ha-sockets、full-ha-sockets

jgroups-udp-fd

54200

 

UDP を介した HA 障害検出に使用されます。

ha-sockets、full-ha-sockets

management-http

9990

 

管理レイヤーを用いた HTTP 通信に使用されます。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

management-https

9993

 

管理レイヤーを用いた HTTPS 通信に使用されます。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

modcluster

 

23364

JBoss EAP と HTTP ロードバランサー間の通信に対するマルチキャストポート。

ha-sockets、full-ha-sockets

txn-recovery-environment

4712

 

JTA トランザクションリカバリーマネージャー。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

txn-status-manager

4713

 

JTA / JTS トランザクションマネージャー。

standard-sockets、ha-sockets、full-sockets、full-ha-sockets

A.10. デプロイメントスキャナーマーカーファイル

マーカーファイルは、JBoss EAP サーバーインスタンスのデプロイメントディレクトリー内でアプリケーションの状態をマーク付けするためにデプロイメントスキャナーによって使用されます。マーカーファイルの名前はデプロイメントの名前と同じで、ファイル接尾辞はアプリケーションのデプロイメントの状態を示します。

たとえば、test-application.war のデプロイメントには test-application.war.deployed という名前のマーカーファイルがあります。

以下の表は、使用できるマーカーファイルタイプとそれらの意味を表しています。

表A.14 マーカーファイルのタイプ

ファイル名接尾辞生成説明

.deployed

システムによる生成

コンテンツがデプロイされたことを示します。このファイルが削除された場合、コンテンツはアンデプロイされます。

.dodeploy

ユーザーによる生成

コンテンツをデプロイまたは再デプロイする必要があることを意味します。

.failed

システムによる生成

デプロイメントの失敗を示します。マーカーファイルには、失敗の原因に関する情報が含まれます。マーカーファイルが削除された場合、コンテンツは再度自動デプロイの対象になります。

.isdeploying

システムによる生成

デプロイ中であることを示します。デプロイの完了後、このマーカーファイルは削除されます。

.isundeploying

システムによる生成

.deployed ファイルの削除によってトリガーされ、コンテンツのアンデプロイ中であることを示します。アンデプロイの完了後、このマーカーファイルは削除されます。

.pending

システムによる生成

デプロイメントスキャナーはコンテンツをデプロイする必要性を認識しているにも関わらず、現在問題によって自動デプロイメントが実行されないことを意味します (例: コンテンツのコピー中である場合)。このマーカーはグローバルデプロイメントロードブロックとして機能するため、スキャナーはこのマーカーファイルが存在する間、あらゆるコンテンツのデプロイおよびアンデプロイをサーバーに指示しません。

.skipdeploy

ユーザーによる生成

アプリケーションの自動デプロイを無効にします。展開されたコンテンツの自動デプロイメントを一時的にブロックする方法として役に立ち、不完全なコンテンツの編集がプッシュされないようにします。スキャナーは zip 形式のコンテンツに対する処理中の変更を検出し、完了するまで待機しますが、zip 形式のコンテンツとともに使用できます。

.undeployed

システムによる生成

コンテンツがアンデプロイされたことを示します。このマーカーファイルを削除しても、コンテンツの再デプロイメントには影響ありません。

A.11. デプロイメントスキャナーの属性

デプロイメントスキャナーには設定可能な以下の属性が含まれます。

表A.15 デプロイメントスキャナーの属性

名前デフォルト説明

auto-deploy-exploded

false

.dodeploy マーカーファイルなしで、展開されたコンテンツの自動デプロイメントを許可します。基本的な開発シナリオに対してのみ推奨され、開発者またはオペレーティングシステムによる変更中に、展開されたアプリケーションデプロイメントが行われないようにします。

auto-deploy-xml

true

.dodeploy マーカーファイルなしでの XML コンテンツの自動デプロイメントを許可します。

auto-deploy-zipped

true

.dodeploy マーカーファイルなしでの zip 形式のコンテンツの自動デプロイメントを許可します。

deployment-timeout

600

デプロイメントスキャナーでデプロイメントをキャンセルするまでのデプロイメント試行許可時間 (秒単位)。

path

deployments

スキャンされる実際のファイルシステムパス。relative-to 属性が指定されない限り、絶対パスとして処理され、値はそのパスの相対パスとして処理されます。

relative-to

jboss.server.base.dir

サーバー設定のパスとして定義されるファイルシステムパスへの参照。

runtime-failure-causes-rollback

false

デプロイメントのランタイム障害が原因で、スキャン操作の一部としてそのデプロイメントやその他すべてのデプロイメント (関係しないデプロイメントの可能性あり) のロールバックが発生するかどうか。

scan-enabled

true

scan-interval により起動時にアプリケーションの自動スキャンを許可します。

scan-interval

5000

変更に対してレポジトリーがスキャンされる間隔 (ミリ秒単位)。1 未満の値を設定すると、初期設定時のみスキャンが行われます。

A.12. ルートロガーの属性

表A.16 ルートロガーの属性

属性説明

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*")) は、パターンに一致しないログエントリーを除外するフィルターを定義します。

handlers

ルートロガーによって使用されるログハンドラーの一覧。

level

ルートロガーが記録するログメッセージの最低レベル。

注記

ルートロガーに指定された filter-spec は他のハンドラーによって継承されません。ハンドラーごとに filter-spec を指定する必要があります。

A.13. ログカテゴリーの属性

表A.17 ログカテゴリーの属性

属性説明

category

ログメッセージがキャプチャーされるログカテゴリー。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

handlers

ロガーに関連付けられたログハンドラーのリスト。

level

ログカテゴリーが記録するログメッセージの最低レベル。

use-parent-handlers

true に設定した場合、割り当てられた他のハンドラーだけでなく、ルートロガーのログハンドラーを使用します。

A.14. ログハンドラーの属性

表A.18 コンソールログハンドラーの属性

属性説明

autoflush

true に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

target

ログハンドラーの出力先となるシステム出力ストリーム。これは システムエラーストリームの場合は System.err、標準出力ストリームの場合は System.out とすることができます。

表A.19 ファイルログハンドラーの属性

属性説明

append

true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。

autoflush

true に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

file

このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、relative-topath の 2 つの設定プロパティーが含まれます。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

表A.20 周期ログハンドラーの属性

属性説明

append

true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。

autoflush

true に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

file

このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、relative-topath の 2 つの設定プロパティーが含まれます。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

suffix

この文字列はローテーションログに追加される接尾辞に含まれます。 suffix の書式は、ドット (.) の後に SimpleDateFormat クラスが解析できる日付の文字列を追加したものです。

表A.21 サイズログハンドラーの属性

属性説明

append

true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。

autoflush

true に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

file

このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、relative-topath の 2 つの設定プロパティーが含まれます。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

max-backup-index

保持するローテーションログの最大数。この数に達すると、古いログが再使用されます。デフォルト値は 1 です。

suffix 属性が使用された場合は、ローテーションログファイルの接尾辞がローテーションアルゴリズムに含まれます。ログファイルがローテーションされると、名前が name+suffix で始まる最も古いファイルが削除され、残りのローテーションログファイルの数値接尾辞が増分され、新しくローテーションされたログファイルに数値接尾辞 1 が提供されます。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

rotate-on-boot

true に設定されると、新しいログファイルがサーバーの起動時に作成されます。デフォルト値は false です。

rotate-size

ログファイルがローテーションされる前に到達できる最大サイズです。数字に追加された単一の文字はサイズ単位を示します。バイトの場合は b、キロバイトの場合は k、メガバイトの場合は m、ギガバイトの場合は g になります。たとえば、50 メガバイトの場合は、50m になります。

suffix

この文字列はローテーションログに追加される接尾辞に含まれます。 suffix の書式は、ドット (.) の後に SimpleDateFormat クラスが解析できる日付の文字列を追加したものです。

表A.22 周期サイズログハンドラーの属性

属性説明

append

true に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。false に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。

autoflush

true に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

file

このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、relative-topath の 2 つの設定プロパティーが含まれます。

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

max-backup-index

保持するローテーションログの最大数。この数に達すると、古いログが再使用されます。デフォルト値は 1 です。

suffix 属性が使用された場合は、ローテーションログファイルの接尾辞がローテーションアルゴリズムに含まれます。ログファイルがローテーションされると、名前が name+suffix で始まる最も古いファイルが削除され、残りのローテーションログファイルの数値接尾辞が増分され、新しくローテーションされたログファイルに数値接尾辞 1 が提供されます。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

rotate-on-boot

true に設定されると、新しいログファイルがサーバーの起動時に作成されます。デフォルト値は false です。

rotate-size

ログファイルがローテーションされる前に到達できる最大サイズです。数字に追加された単一の文字はサイズ単位を示します。バイトの場合は b、キロバイトの場合は k、メガバイトの場合は m、ギガバイトの場合は g になります。たとえば、50 メガバイトの場合は、50m になります。

suffix

この文字列はローテーションログに追加される接尾辞に含まれます。 suffix の書式は、ドット (.) の後に SimpleDateFormat クラスが解析できる日付の文字列を追加したものです。

表A.23 syslog ハンドラー属性

属性説明

app-name

メッセージを RFC5424 形式でフォーマットするときに使用されるアプリケーション名。デフォルトのアプリケーション名は java です。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

facility

RFC-5424 および RFC-3164 によって定義される機能。

hostname

メッセージ送信元のホストの名前。たとえば、アプリケーションサーバーが実行されているホストの名前になります。

level

ログハンドラーが記録するログメッセージの最低レベル。

port

syslog サーバーがリッスンしているポート。

server-address

syslog サーバーのアドレス。

syslog-format

RFC 仕様にしたがってログメッセージをフォーマットします。

表A.24 カスタムログハンドラーの属性

属性説明

class

使用されるロギングハンドラークラス。

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

encoding

出力に使用する文字エンコーディングスキーム。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

formatter

このログハンドラーで使用するログフォーマッター。

level

ログハンドラーが記録するログメッセージの最低レベル。

module

ロギングハンドラーが依存するモジュール。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

named-formatter

ハンドラーで使用する定義されたフォーマッターの名前。

properties

ロギングハンドラーに使用されるプロパティー。

表A.25 非同期ログハンドラーの属性

属性説明

enabled

true に設定された場合、ハンドラーが有効になり、通常とおり機能します。false に設定された場合、ログメッセージの処理時にハンドラーが無視されます。

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため廃止されました

filter-spec

フィルターを定義する式の値。式 not(match("WFLY.*") はパターンに一致しないフィルターを定義します。

level

ログハンドラーが記録するログメッセージの最低レベル。

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため廃止されました。

overflow-action

キューの長さを超えたときにこのハンドラーがどのように応答するかを示します。これは BLOCK または DISCARD に設定できます。BLOCK により、キューでスペースが利用可能になるまでロギングアプリケーションが待機します。これは、非同期でないログハンドラーと同じ動作です。DISCARD により、ロギングアプリケーションは動作し続けますが、ログメッセージは削除されます。

queue-length

サブハンドラーが応答するときに、このハンドラーが保持するログメッセージの最大数。

subhandlers

この非同期ハンドラーがログメッセージを渡すログハンドラーの一覧。

A.15. データソース接続 URL

表A.26 データソース接続 URL

データソース接続 URL

IBM DB2

jdbc:db2://SERVER_NAME:PORT/DATABASE_NAME

MariaDB

jdbc:mariadb://SERVER_NAME:PORT/DATABASE_NAME

Microsoft SQL Server

jdbc:sqlserver://SERVER_NAME:PORT;DatabaseName=DATABASE_NAME

MySQL

jdbc:mysql://SERVER_NAME:PORT/DATABASE_NAME

Oracle

jdbc:oracle:thin:@SERVER_NAME:PORT:ORACLE_SID

PostgreSQL

jdbc:postgresql://SERVER_NAME:PORT/DATABASE_NAME

Sybase

jdbc:sybase:Tds:SERVER_NAME:PORT/DATABASE_NAME

A.16. データソースのパラメーター

表A.27 データソースのパラメーター

パラメーターデータソースタイプ説明

allocation-retry

非 XA、XA

例外が発生する前に接続の割り当てを試行する回数。デフォルトは 0 で、初回の割り当て失敗で例外が発生します。

allocation-retry-wait-millis

非 XA、XA

接続の割り当てを再試行する間隔 (ミリ秒単位)。デフォルトは 5000 ミリ秒です。

allow-multiple-users

非 XA、XA

複数のユーザーが getConnection(user, password) メソッドを使いデータソースへアクセスするかどうか、およびこの挙動が内部プールタイプによるものであるかどうか。

background-validation

非 XA、XA

接続がバックグラウンドスレッドで検証されるべきか、または使用前に検証されるか。通常バックグラウンド検証は validate-on-match とともに使用されません。使用されると冗長チェックが行われます。バックグラウンド検証では、検証時とクライアントへ渡す時の間で接続が不良になる可能性があるため、アプリケーションはこの可能性に対応する必要があります。

background-validation-millis

非 XA、XA

バックグラウンド検証を実行する頻度 (ミリ秒単位)。

blocking-timeout-wait-millis

非 XA、XA

接続待機中にブロックする最大時間数 (ミリ秒単位) を指定します。この時間を超過すると、例外が発生します。これは、接続のロックを待っている間のみブロックし、新規接続の作成に長時間要している場合は例外は発生しません。

capacity-decrementer-class

非 XA、XA

プールの接続をデクリメントするポリシーを定義するクラス。

capacity-decrementer-properties

非 XA、XA

プールの接続をデクリメントするポリシーを定義するクラスにインジェクトされるプロパティー。

capacity-incrementer-class

非 XA、XA

プールの接続をインクリメントするポリシーを定義するクラス。

capacity-incrementer-properties

非 XA、XA

プールの接続をインクリメントするポリシーを定義するクラスにインジェクトされるプロパティー。

check-valid-connection-sql

非 XA、XA

プール接続の妥当性を確認する SQL ステートメント。これは、プールから管理接続を取得するときに呼び出される場合があります。

connectable

非 XA、XA

CMR の使用を有効にします。これは、ローカルリソースが信頼して XA トランザクションに参加できることを意味します。

connection-listener-class

非 XA、XA

org.jboss.jca.adapters.jdbc.spi.listener.ConnectionListener を拡張するクラス名を指定します。このクラスは、接続がアプリケーションまたはプールに返される前にアクションを実行するために接続のアクティベーションおよびパッシベーションをリッスンします。指定されたクラスは、2 つのリソース jar (JDBC ドライバーをコアモジュールとしてインストール) を使用して 1 つのモジュールで JDBC ドライバーとバンドルするか、個別のグローバルモジュール (グローバルモジュールの定義) でバンドルする必要があります。

connection-listener-property

非 XA、XA

connection-listener-class で指定されたクラスにインジェクトされるプロパティー。インジェクトされるプロパティーは JavaBeans の慣例に対応します。たとえば、foo という名前のプロパティーを指定する場合、接続リスナークラスには String を引数として許可するメソッド setFoo が必要です。

connection-properties

非 XA のみ

Driver.connect(url, props) メソッドに渡す任意の文字列名と値のペアである接続プロパティー。

connection-url

非 XA のみ

JDBC ドライバーの接続 URL。

datasource-class

非 XA のみ

JDBC データソースクラスの完全修飾名。

driver-class

非 XA のみ

JDBC ドライバークラスの完全修飾名。

driver-name

非 XA、XA

データソースが使用する JDBC ドライバーを定義します。インストールされたドライバーに一致するシンボリック名になります。ドライバーが JAR としてデプロイされた場合、名前はデプロイメントの名前になります。

enabled

非 XA、XA

データソースを有効にするかどうか。

enlistment-trace

非 XA、XA

エンリストメントトレースを記録するかどうか。

exception-sorter-class-name

非 XA、XA

例外がエラーをブロードキャストする場合に検証するメソッドを提供する org.jboss.jca.adapters.jdbc.ExceptionSorter のインスタンス。

exception-sorter-properties

非 XA、XA

例外ソータープロパティー。

flush-strategy

非 XA、XA

エラーの場合にプールをフラッシュする方法を指定します。有効な値は次のとおりです。

  • FailingConnectionOnly (デフォルト)
  • IdleConnections
  • EntirePool

idle-timeout-minutes

非 XA、XA

接続が閉じられるまでのアイドル最大時間 (分単位) を指定します。実際の最大時間は、IdleRemover スキャン時間 (プールの最小 idle-timeout-minutes の半分) に基づきます。

initial-pool-size

非 XA、XA

プールが保持する最初の接続数。

interleaving

XA のみ

XA 接続のインターリービングを有効にするかどうか。

jndi-name

非 XA、XA

データソースの一意の JNDI 名。

jta

非 XA のみ

JTA の統合を有効にします。

max-pool-size

非 XA、XA

プールが保持可能な最大接続数。

mcp

非 XA、XA

ManagedConnectionPool 実装 (例: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool)。

min-pool-size

非 XA、XA

プールが保持可能な最小接続数。

new-connection-sql

非 XA、XA

接続が接続プールに追加されたときに実行する SQL ステートメント。

no-recovery

XA のみ

リカバリーから接続プールが除外されるかどうか。

no-tx-separate-pool

XA のみ

各コンテキストに対して個別のサブプールを作成するかどうか。これは、JTA トランザクションの内部と外部の両方で XA 接続を使用できない一部の Oracle データソースで必要になることがあります。

pad-xid

XA のみ

Xid のパディングを行うかどうかを指定します。

password

非 XA、XA

新しい接続の作成時に使用するパスワード。

pool-fair

非 XA、XA

プールが fair であるかを定義します。この設定は、JCA の接続プールを管理するために使用される Semaphore クラスの一部で、リースする接続の順番が必要でない一部のユースケースでパフォーマンスが向上されます。

pool-prefill

非 XA、XA

プールをプレフィルするかどうか。

pool-use-strict-min

非 XA、XA

min-pool-size を厳格に考慮するかどうか。

prepared-statements-cache-size

非 XA、XA

LRU (Least Recently Used) キャッシュにある接続毎の準備済みステートメントの数。

query-timeout

非 XA、XA

クエリーのタイムアウト (秒単位)。デフォルトではタイムアウトはありません。

reauth-plugin-class-name

非 XA、XA

物理接続の再認証する再認証プラグイン実装の完全修飾クラス名。

reauth-plugin-properties

非 XA、XA

再認証プラグインのプロパティー。

recovery-password

XA のみ

リカバリーのリソースへの接続に使用するパスワード。

recovery-plugin-class-name

XA のみ

リカバリープラグイン実装の完全修飾クラス名。

recovery-plugin-properties

XA のみ

リカバリープラグインのプロパティー。

recovery-security-domain

XA のみ

リカバリーでリソースに接続するために使用するセキュリティードメイン。

recovery-username

XA のみ

リカバリーのリソースへの接続に使用するユーザー名。

same-rm-override

XA のみ

javax.transaction.xa.XAResource.isSameRM(XAResource) クラスが true または false を返すかどうか。

security-domain

非 XA、XA

認証処理を行う JAAS security-manager の名前。この名前は、JAAS ログイン設定の application-policy/name 属性に相関します。

set-tx-query-timeout

非 XA、XA

トランザクションがタイムアウトするまでの残り時間を基にクエリーのタイムアウトを設定するかどうかを指定します。トランザクションが存在しない場合は設定済みのクエリーのタイムアウトが使用されます。

share-prepared-statements

非 XA、XA

閉じずに同じステートメントを 2 回要求した場合に、同じ基盤の準備済みステートメントを使用するかどうかを指定します。

spy

非 XA、XA

JDBC レイヤーでスパイ機能を有効にします。この機能は、データソースへの JDBC トラフィックをすべてログに記録します。ロギングカテゴリーの jboss.jdbc.spylogging サブシステムのログレベルである DEBUG に設定する必要があることに注意してください。

stale-connection-checker-class-name

非 XA、XA

isStaleConnection(SQLException) メソッドを提供する org.jboss.jca.adapters.jdbc.StaleConnectionChecker のインスタンス。このメソッドが true を返す場合、例外は org.jboss.jca.adapters.jdbc.StaleConnectionException でラップされます。

stale-connection-checker-properties

非 XA、XA

陳腐接続チェッカーのプロパティー。

statistics-enabled

非 XA、XA

ランタイム統計が有効になっているかどうか。デフォルトは false です。

track-statements

非 XA、XA

接続がプールへ返され、ステートメントが準備済みステートメントキャッシュへ返された時に、閉じられていないステートメントをチェックするかどうか。false の場合、ステートメントは追跡されません。有効な値は次のとおりです。

  • true: ステートメントと結果セットが追跡され、ステートメントが閉じられていない場合は警告が出力されます。
  • false: ステートメントと結果セットのいずれも追跡されません。
  • nowarn: ステートメントは追跡されますが、警告は出力されません (デフォルト)。

tracking

非 XA、XA

トランザクション境界にまたがる接続ハンドルを追跡するかどうか。

transaction-isolation

非 XA、XA

java.sql.Connection トランザクション分離レベル。有効な値は次のとおりです。

  • TRANSACTION_READ_UNCOMMITTED
  • TRANSACTION_READ_COMMITTED
  • TRANSACTION_REPEATABLE_READ
  • TRANSACTION_SERIALIZABLE
  • TRANSACTION_NONE

url-delimiter

非 XA、XA

高可用性 (HA) データソースの connection-url にある URL の区切り文字。

url-property

XA のみ

xa-datasource-property 値の URL プロパティーのプロパティー。

url-selector-strategy-class-name

非 XA、XA

org.jboss.jca.adapters.jdbc.URLSelectorStrategy を実装するクラス。

use-ccm

非 XA、XA

キャッシュ接続マネージャーを有効にします。

use-fast-fail

非 XA、XA

true の場合、接続が無効であれば最初に接続を割り当てしようとした時点で失敗します。false の場合、プールが枯渇するまで再試行します。

use-java-context

非 XA、XA

データソースをグローバル JNDI にバインドするかどうか。

use-try-lock

非 XA、XA

内部ロックのタイムアウト値。ロックが使用できない場合に即座に失敗するのではなく、タイムアウトする前に設定された秒数間ロックの取得を試みます。 tryLock() の代わりに lock() を使用します。

user-name

非 XA、XA

新しい接続の作成時に使用するユーザー名。

valid-connection-checker-class-name

非 XA、XA

SQLException.isValidConnection(Connection e) メソッドを提供し接続を検証する org.jboss.jca.adaptors.jdbc.ValidConnectionChecker の実装。接続が破棄されると例外が発生します。存在する場合、check-valid-connection-sql パラメーターが上書きされます。

valid-connection-checker-properties

非 XA、XA

有効な接続チェッカープロパティー。

validate-on-match

非 XA、XA

接続ファクトリーが管理された接続への一致を試みたときに接続の検証が実行されるかどうか。これは、使用前にクライアントの接続を検証する必要がある場合に使用する必要があります。通常、Validate-on-match は background-validation と使用しません。使用すると冗長チェックが行われます。

wrap-xa-resource

XA のみ

org.jboss.tm.XAResourceWrapper インスタンスで XAResource をラップするかどうか。

xa-datasource-class

XA のみ

javax.sql.XADataSource 実装クラスの完全修飾名。

xa-datasource-properties

XA のみ

XA データソースプロパティーの文字列名と値のペア。

xa-resource-timeout

XA のみ

ゼロ以外の値は XAResource.setTransactionTimeout メソッドに渡されます。

A.17. データソースの統計

表A.28 コアプールの統計

名前説明

ActiveCount

アクティブな接続の数。各接続はアプリケーションによって使用されているか、プールで使用可能な状態であるかのいずれかになります。

AvailableCount

プールの使用可能な接続の数。

AverageBlockingTime

プールの排他ロックの取得をブロックするために費やされた平均時間。値はミリ秒単位です。

AverageCreationTime

接続の作成に費やされた平均時間。値はミリ秒単位です。

AverageGetTime

接続の取得に費やされた平均時間。

AverageUsageTime

接続の使用に費やされた平均時間。

BlockingFailureCount

接続の取得に失敗した回数。

CreatedCount

作成された接続の数。

DestroyedCount

破棄された接続の数。

IdleCount

現在アイドル状態の接続数。

InUseCount

現在使用中の接続の数。

MaxCreationTime

接続の作成にかかった最大時間。値はミリ秒単位です。

MaxGetTime

接続取得の最大時間。

MaxPoolTime

プールの接続の最大時間。

MaxUsageTime

接続使用の最大時間。

MaxUsedCount

使用される接続の最大数。

MaxWaitCount

同時に接続を待機する要求の最大数。

MaxWaitTime

プールの排他ロックの待機に費やされた最大時間。

TimedOut

タイムアウトした接続の数。

TotalBlockingTime

プールの排他ロックの待機に費やされた合計時間。値はミリ秒単位です。

TotalCreationTime

接続の作成に費やされた合計時間。値はミリ秒単位です。

TotalGetTime

接続の取得に費やされた合計時間。

TotalPoolTime

プールの接続によって費やされた合計時間。

TotalUsageTime

接続の使用に費やされた合計時間。

WaitCount

接続の取得を待つ必要のあるリクエストの数。

XACommitAverageTime

XAResource commit 呼び出しの平均時間。

XACommitCount

XAResource commit 呼び出しの数。

XACommitMaxTime

XAResource commit 呼び出しの最大時間。

XACommitTotalTime

すべての XAResource commit 呼び出しの合計時間。

XAEndAverageTime

XAResource end 呼び出しの平均時間。

XAEndCount

XAResource end 呼び出しの数。

XAEndMaxTime

XAResource end 呼び出しの最大時間。

XAEndTotalTime

すべての XAResource end 呼び出しの合計時間。

XAForgetAverageTime

XAResource forget 呼び出しの平均時間。

XAForgetCount

XAResource forget 呼び出しの数。

XAForgetMaxTime

XAResource forget 呼び出しの最大時間。

XAForgetTotalTime

すべての XAResource forget 呼び出しの合計時間。

XAPrepareAverageTime

XAResource prepare 呼び出しの平均時間。

XAPrepareCount

XAResource prepare 呼び出しの数。

XAPrepareMaxTime

XAResource prepare 呼び出しの最大時間。

XAPrepareTotalTime

すべての XAResource prepare 呼び出しの合計時間。

XARecoverAverageTime

XAResource recover 呼び出しの平均時間。

XARecoverCount

XAResource recover 呼び出しの数。

XARecoverMaxTime

XAResource recover 呼び出しの最大時間。

XARecoverTotalTime

すべての XAResource recover 呼び出しの合計時間。

XARollbackAverageTime

XAResource rollback 呼び出しの平均時間。

XARollbackCount

XAResource rollback 呼び出しの数。

XARollbackMaxTime

XAResource rollback 呼び出しの最大時間。

XARollbackTotalTime

すべての XAResource rollback 呼び出しの合計時間。

XAStartAverageTime

XAResource start 呼び出しの平均時間。

XAStartCount

XAResource start 呼び出しの数。

XAStartMaxTime

XAResource start 呼び出しの最大時間。

XAStartTotalTime

すべての XAResource start 呼び出しの合計時間。

表A.29 JDBC の統計

名前説明

PreparedStatementCacheAccessCount

ステートメントキャッシュがアクセスされた回数。

PreparedStatementCacheAddCount

ステートメントキャッシュに追加されたステートメントの数。

PreparedStatementCacheCurrentSize

ステートメントキャッシュに現在キャッシュされた準備済みおよび呼び出し可能ステートメントの数。

PreparedStatementCacheDeleteCount

キャッシュから破棄されたステートメントの数。

PreparedStatementCacheHitCount

キャッシュからのステートメントが使用された回数。

PreparedStatementCacheMissCount

ステートメント要求がキャッシュのステートメントと一致しなかった回数。

A.18. トランザクションマネージャーの設定オプション

表A.30 トランザクションマネージャーの設定オプション

オプション説明

default-timeout

デフォルトのトランザクションタイムアウトです。デフォルトでは 300 秒に設定されています。トランザクションごとにプログラムで上書きできます。

enable-statistics

statistics-enabled が導入されたため廃止されました。

enable-tsm-status

アウトオブプロセスのリカバリーに使用される TSM (トランザクションステータスマネージャー) サービスを有効にするかどうか。アウトオブプロセスのリカバリーマネージャーを実行してメモリー内ではなく異なるプロセスから ActionStatusService にアクセスすることはサポートされないため、このオプションはサポート対象外になります。

hornetq-store-enable-async-io

journal-store-enable-async-io が導入されたため廃止されました。

jdbc-action-store-drop-table

JDBC アクションストアがテーブルをドロップするか。デフォルトは false です。

jdbc-action-store-table-prefix

設定された JDBC アクションストアにトランザクションログを書き込むために使用されるテーブルのオプションの接頭辞。

jdbc-communication-store-drop-table

JDBC コミュニケーションストアがテーブルをドロップするか。デフォルトは false です。

jdbc-communication-store-table-prefix

設定された JDBC コミュニケーションストアにトランザクションログを書き込むために使用されるテーブルのオプションの接頭辞。

jdbc-state-store-drop-table

JDBC ステートストアがテーブルをドロップするか。デフォルトは false です。

jdbc-state-store-table-prefix

設定された JDBC ステートストアにトランザクションログを書き込むために使用されるテーブルのオプションの接頭辞。

jdbc-store-datasource

使用される非 XA データソースの名前。データソースは datasources サブシステムで定義する必要があります。

journal-store-enable-async-io

ジャーナルストアに対して AsyncIO を有効にするかどうか。デフォルトは false です。この設定を有効にするにはサーバーを再起動する必要があります。

jts

Java Transaction Service (JTS) トランザクションを使用するかどうかを指定します。デフォルト値は false で、JTA トランザクションのみを使用します。

node-identifier

トランザクションマネージャーのノード識別子。このオプションが設定されていないと、サーバーの起動時に警告が表示されます。このオプションは以下の場合に必要になります。

  • JTS 対 JTS の通信
  • 2 つのトランザクションマネージャーが共有のリソースマネージャーにアクセスする場合
  • 2 つのトランザクションマネージャーが共有のオブジェクトマネージャーにアクセスする場合

リカバリー中にデータの整合性を維持する必要があるため、各トランザクションマネージャーの node-identifier は一意である必要があります。複数のノードが同じリソースマネージャーと対話したり、トランザクションオブジェクトストアを共有したりするため、node-identifier は JTA に対しても一意である必要があります。

object-store-path

トランザクションマネージャーオブジェクトストアがデータを格納するファイルシステムの相対または絶対パスです。デフォルトは object-store-relative-to パラメーターに相対する値になります。object-store-relative-to を空の文字列に設定すると、この値は絶対パスとして処理されます。

object-store-relative-to

ドメインモデルのグローバルなパス設定を参照します。デフォルト値は、JBoss EAP のデータディレクトリーで、jboss.server.data.dir プロパティーの値です。デフォルトは、管理対象ドメインの場合は EAP_HOME/domain/data/、スタンドアロンサーバーインスタンスの場合は EAP_HOME/standalone/data/ です。オブジェクトストアの object-store-path トランザクションマネージャー属性の値はこのパスに相対的です。object-store-path が絶対パスとして処理されるようにするには、この属性を空の文字列に設定します。

process-id-socket-binding

トランザクションマネージャーがソケットベースのプロセス ID を使用する必要がある場合に使用するソケットバインディング設定の名前。 process-id-uuidtrue に設定された場合は undefined になります。それ以外の場合は、設定する必要があります。

process-id-socket-max-ports

トランザクションマネージャーは、各トランザクションログに対し一意の識別子を作成します。一意の識別子を生成するメカニズムは 2 種類あります。ソケットベースのメカニズムとプロセスのプロセス識別子をベースにしたメカニズムです。

ソケットベースの識別子の場合、あるソケットを開くと、そのポート番号が識別子に使用されます。ポートがすでに使用されている場合は、空きのポートが見つかるまで次のポートがプローブされます。process-id-socket-max-ports は失敗するまでトランザクションマネージャーが試行するソケットの最大数を表します。デフォルト値は 10 です。

process-id-uuid

true に設定すると、プロセス識別子を使用して各トランザクションに一意の識別子が作成されます。そうでない場合は、ソケットベースのメカニズムが使用されます。デフォルト値は true です。詳細は、process-id-socket-max-ports を参照してください。process-id-socket-binding を有効にするには、process-id-uuidfalse に設定します。

recovery-listener

トランザクションリカバリーのプロセスがネットワークソケットをリッスンするかどうかを指定します。デフォルト値は false です。

socket-binding

recovery-listenertrue に設定されている場合にトランザクション周期リカバリーリスナーによって使用されるソケットバインディングの名前を指定します。

statistics-enabled

統計を有効にするかどうか。

status-socket-binding

トランザクションステータスマネージャーに使用するソケットバインディングを指定します。この設定オプションはサポートされません。

use-hornetq-store

use-journal-store が導入されたため廃止されました。

use-jdbc-store

トランザクションログの書き込みに JDBC ストアを使用します。有効にする場合は true、デフォルトのログストアタイプを使用する場合は false を設定します。

use-journal-store

ファイルベースのストレージの代わりに Apache ActiveMQ Artemis のジャーナルストレージメカニズムをトランザクションログに使用します。デフォルトでは無効になっていますが、I/O パフォーマンスが改善されます。別々のトランザクションマネージャーで JTS トランザクションを使用することは推奨されません。このオプションの変更を反映するには shutdown コマンドを使用してサーバーを再起動する必要があります。

A.19. リソースアダプターの属性

以下の表はリソースアダプターの属性を示しています。

表A.31 主な属性

属性説明

archive

リソースアダプターアーカイブ。

beanvalidationgroups

使用する必要がある Bean バリデーショングループ。

bootstrap-context

使用する必要があるブートストラップコンテキストの一意な名前。

config-properties

カスタム定義の設定プロパティー。

module

リソースアダプターがロードされるモジュール。

statistics-enabled

ランタイム統計が有効になっているかどうか。

transaction-support

リソースアダプターのトランザクションサポートレベル。

wm-security

このリソースアダプターの wm.security をオンまたはオフにします。false の場合、デフォルトを含む wm-security-* パラメーターが無視されます。

wm-security-default-groups

使用された Subject インスタンスに追加する必要があるデフォルトのグループリスト。

wm-security-default-principal

使用された Subject インスタンスに追加する必要があるデフォルトのプリンシパルリスト。

wm-security-domain

使用する必要のあるセキュリティードメインの名前。

wm-security-mapping-groups

グループマッピングのリスト。

wm-security-mapping-required

セキュリティークレデンシャルにマッピングが必要であるかどうかを定義します。

wm-security-mapping-users

ユーザーマッピングのリスト。

表A.32 admin-objects Attributes

属性説明

class-name

管理オブジェクトの完全修飾クラス名。

enabled

管理オブジェクトを有効にする必要があるかを指定します。

jndi-name

管理オブジェクトの JNDI 名。

use-java-context

false に設定するとオブジェクトがグローバル JNDI にバインドされます。

表A.33 connection-definitions Attributes

属性説明

allocation-retry

接続の割り当てを再試行する回数を示します。この回数を超えると例外が発生します。

allocation-retry-wait-millis

接続の割り当てを再試行する間隔 (ミリ秒単位)。

background-validation

接続をバックグラウンドで検証するか、または使用前に検証するかを指定します。値を変更した後にサーバーを再起動する必要があります。

background-validation-millis

バックグラウンド検証を実行する期間 (ミリ秒単位)。値の変更後、サーバーを再起動する必要があります。

blocking-timeout-wait-millis

接続待機中にブロックする最大時間数 (ミリ秒単位) を指定します。この時間を超過すると、例外が発生します。これは、接続のロックを待っている間のみブロックし、新規接続の作成に長時間要している場合は例外は発生しません。

capacity-decrementer-class

プールの接続をデクリメントするポリシーを定義するクラス。

capacity-decrementer-properties

プールの接続をデクリメントするポリシーを定義するクラスにインジェクトするプロパティー。

capacity-incrementer-class

プールの接続をインクリメントするポリシーを定義するクラス。

capacity-incrementer-properties

プールの接続をインクリメントするポリシーを定義するクラスにインジェクトするプロパティー。

class-name

管理された接続ファクトリーまたは管理オブジェクトの完全修飾クラス名。

connectable

CMR の使用を有効にします。この機能により、ローカルリソースが信頼して XA トランザクションに参加できます。

enabled

リソースアダプターを有効にするべきかどうかを指定します。

enlistment

リソースアダプターによってサポートされる場合に lazy enlistment (レイジーエンリストメント) が使用されるべきであるかどうかを指定します。

enlistment-trace

JBoss EAP または IronJacamar がエンリストメントトレースを記録すべきかどうかを指定します。

flush-strategy

エラー発生時にプールがどのようにフラッシュされるか。有効な値は FailingConnectionOnly (デフォルト)、IdleConnections、および EntirePool です。

idle-timeout-minutes

接続が閉じられるまでのアイドル最大時間 (分単位) を指定します。実際の最大時間は、IdleRemover スキャン時間 (プールの最小 idle-timeout-minutes の半分) に基づきます。この値の変更後にサーバーを再起動する必要があります。

initial-pool-size

プールが保持する最初の接続数。

interleaving

XA 接続のインターリービングを有効にするかどうかを指定します。

jndi-name

接続ファクトリーの JNDI 名。

max-pool-size

プールの最大接続数。各サブプールではこの値を超える接続は作成されません。

mcp

ManagedConnectionPool 実装。例: org.jboss.jca.core.connectionmanager.pool.mcp.SemaphoreArrayListManagedConnectionPool

min-pool-size

プールの最小接続数。

no-recovery

接続プールがリカバリーから除外されるべきであるかどうかを指定します。

no-tx-separate-pool

Oracle では、XA 接続を JTA トランザクションの内部と外部の両方で使用することが推奨されません。この問題を回避するには、異なるコンテキストに個別のサブプールを作成します。

pad-xid

Xid のパディングを行うべきかどうかを指定します。

pool-fair

プールの使用が公正であるべきかどうかを指定します。

pool-prefill

プールをプレフィルすべきかどうかを指定します。値の変更後にサーバーを再起動する必要があります。

pool-use-strict-min

min-pool-size を厳格に考慮するかどうかを指定します。

recovery-password

リカバリーに使用されるパスワード。

recovery-plugin-class-name

リカバリープラグイン実装の完全修飾クラス名。

recovery-plugin-properties

リカバリープラグインのプロパティー。

recovery-security-domain

リカバリーに使用されるセキュリティードメイン。

recovery-username

リカバリーに使用されるユーザー名。

same-rm-override

javax.transaction.xa.XAResource.isSameRM(XAResource) が true または false を返すかどうかを無条件に設定します。

security-application

プール内の接続を区別するために、アプリケーションにより提供されたパラメーター (getConnection(user, pw) からなど) を使用することを指定します。

security-domain

プール内の接続を区別するために使用される javax.security.auth.Subject を定義するセキュリティードメイン。

security-domain-and-application

プール内の接続を区別するために、getConnection(user, pw) または Subject (セキュリティードメインから) などのアプリケーションが提供するパラメーターを使用するかどうかを指定します。

sharable

共有可能な接続の使用を有効にします。サポートされる場合はレイジーアソシエーションが有効になります。

tracking

IronJacamar がトランザクション境界にまたがって接続ハンドルを追跡するかどうかを指定します。

use-ccm

キャッシュされた接続マネージャーの使用を有効にします。

use-fast-fail

無効な場合に最初の接続で接続割り当てを失敗させるか (true)、プールですべての接続が使用されるまで試行を続けるか (false)。

use-java-context

false に設定するとオブジェクトがグローバル JNDI にバインドされます。

validate-on-match

接続ファクトリーが管理された接続への一致を試みたときに接続の検証を実行すべきかどうかを指定します。通常、バックグラウンド検証の使用のみに限定されます。

wrap-xa-resource

XAResource インスタンスを org.jboss.tm.XAResourceWrapper インスタンスでラップするかどうかを指定します。

xa-resource-timeout

値は XAResource.setTransactionTimeout() に渡されます (秒単位)。デフォルトは 0 です。

リソースアダプタースキーマは EAP_HOME/docs/schema/wildfly-resource-adapters_4_0.xsd にあります。

A.20. リソースアダプターの統計

表A.34 リソースアダプターの統計

名前説明

ActiveCount

アクティブな接続の数。各接続はアプリケーションによって使用されているか、プールで使用可能な状態であるかのいずれかになります。

AvailableCount

プールの使用可能な接続の数。

AverageBlockingTime

プールの排他ロックの取得をブロックするために費やされた平均時間。値はミリ秒単位です。

AverageCreationTime

接続の作成に費やされた平均時間。値はミリ秒単位です。

CreatedCount

作成された接続の数。

DestroyedCount

破棄された接続の数。

InUseCount

現在使用中の接続の数。

MaxCreationTime

接続の作成にかかった最大時間。値はミリ秒単位です。

MaxUsedCount

使用される接続の最大数。

MaxWaitCount

同時に接続を待機する要求の最大数。

MaxWaitTime

プールの排他ロックの待機に費やされた最大時間。

TimedOut

タイムアウトした接続の数。

TotalBlockingTime

プールの排他ロックの待機に費やされた合計時間。値はミリ秒単位です。

TotalCreationTime

接続の作成に費やされた合計時間。値はミリ秒単位です。

WaitCount

接続を待機する必要がある要求の数。

A.21. Undertow サブシステムの属性

表A.35 undertow の属性

属性デフォルト説明

default-security-domain

other

Web デプロイメントによって使用されるデフォルトのセキュリティードメイン。

default-server

default-server

デプロイメントに使用するデフォルトのサーバー。

default-servlet-container

default

デプロイメントに使用するデフォルトのサーブレットコンテナー。

default-virtual-host

default-host

デプロイメントに使用するデフォルトの仮想ホスト。

instance-id

${jboss.node.name}

クラスターインスタンス ID。

statistics-enabled

false

統計を有効にするかどうか。

バッファーキャッシュの属性

表A.36 buffer-cache の属性

属性デフォルト説明

buffer-size

1024

バッファーのサイズ。バッファーが小さいと領域をより効率的に使用できます。

buffers-per-region

1024

リージョンごとのバッファーの数。

max-regions

10

リージョンの最大数。キャッシングに使用できる最大メモリー容量を制御します。

サーブレットコンテナーの属性

サーブレットコンテナーコンポーネントの構造は次のとおりです。

servlet-container の属性

表A.37 servlet-container の属性

属性デフォルト説明

allow-non-standard-wrappers

false

標準のラッパークラスを拡張しないリクエストおよび応答ラッパーが使用可能であるかどうか。

default-buffer-cache

default

静的リソースのキャッシュに使用するバッファーキャッシュ。

default-encoding

 

デプロイされたすべてのアプリケーションに使用するデフォルトのエンコード。

default-session-timeout

30

コンテナーにデプロイされたすべてのアプリケーションに対するデフォルトのセッションタイムアウト (分単位)。

directory-listing

 

デフォルトのサーブレットにディレクトリーリスティングを有効にするかどうか。

disable-caching-for-secured-pages

true

ヘッダーを設定してセキュア化されたページのキャッシュを無効にするかどうか。無効にすると機密性の高いページが中間者によってキャッシュされる可能性があるため、セキュリティー上の問題が発生することがあります。

eager-filter-initialization

false

最初にリクエストされたときではなく、デプロイメントの開始時に filter init() を呼び出すかどうか。

ignore-flush

false

サーブレット出力ストリームでのフラッシュを無視します。ほとんどの場合でパフォーマンスに悪影響を与えます。

max-sessions

 

1 度にアクティブにできるセッションの最大数。

proactive-authentication

false

プロアクティブ認証を使用すべきかどうか。true の場合、クレデンシャルのあるユーザーは常に認証されます。

session-id-length

30

生成されたセッション ID の長さ。セッション ID が長いほどセキュアになります。

stack-trace-on-error

local-only

エラーの発生時にスタックトレースがあるエラーページを生成するかどうか。値は all、none、local-only です。

use-listener-encoding

false

リスナーで定義されたエンコードを使用します。

mime-mapping 属性

表A.38 mime-mapping 属性

属性デフォルト説明

value

 

このマッピングの mime タイプ。

welcome-file の属性

ウェルカムファイルを定義し、オプションはありません。

crawler-session-management の属性

クローラーボット (crawler bot) に特別なセッション処理を設定します。

注記

管理 CLI を使用して crawler-session-management 要素を管理する場合、servlet-container 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/servlet-container=default/setting=crawler-session-management:add
/subsystem=undertow/servlet-container=default/setting=crawler-session-management:read-resource

表A.39 crawler-session-management の属性

属性デフォルト説明

session-timeout

 

クローラーが所有するセッションのセッションタイムアウト (秒単位)。

user-agents

 

クローラーのユーザーエージェントの一致に使用される正規表現。

jsp の属性
注記

管理 CLI を使用して jsp 要素を管理する場合、servlet-container 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/servlet-container=default/setting=jsp:read-resource

表A.40 jsp の属性

属性デフォルト説明

check-interval

0

バックグラウンドスレッドを使用して JSP 更新の間隔をチェックします。

development

false

JSP のリロードをオンザフライで有効にする開発モードを有効にします。

disabled

false

JSP コンテナーを有効にします。

display-source-fragment

true

ランタイムエラーの発生時に、対応する JSP ソースの断片の表示を試行します。

dump-smap

false

SMAP データをファイルに書き込みます。

error-on-use-bean-invalid-class-attribute

false

useBean で不適切なクラスを使用するときにエラーを有効にします。

generate-strings-as-char-arrays

false

String 定数を char 配列として生成します。

java-encoding

UTF8

Java ソースに使用するエンコーディングを指定します。

keep-generated

true

生成されたサーブレットを保持します。

mapped-file

true

JSP ソースへマップします。

modification-test-interval

4

更新の 2 つのテスト間の最小時間 (秒単位)。

optimize-scriptlets

false

文字列連結の削除に JSP スクリプトレットを最適化するかどうか。

recompile-on-fail

false

各リクエストで失敗した JSP のコンパイルを再試行します。

scratch-dir

 

別のワークディレクトリーを指定します。

smap

true

SMAP を有効にします。

source-vm

1.8

コンパイルのソース VM レベル。

tag-pooling

true

タブプーリングを有効にします。

target-vm

1.8

コンパイルのターゲット VM レベル。

trim-spaces

false

生成されたサーブレットから一部の領域をトリミングします。

x-powered-by

true

x-powered-by で JSP エンジンのアドバタイズを有効にします。

persistent-sessions の属性
注記

管理 CLI を使用して persistent-sessions 要素を管理する場合、servlet-container 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/servlet-container=default/setting=persistent-sessions:add
/subsystem=undertow/servlet-container=default/setting=persistent-sessions:read-resource

表A.41 persistent-sessions の属性

属性デフォルト説明

path

 

永続セッションデータディレクトリーへのパス。null の場合、セッションがメモリーに保存されます。

relative-to

 

相対パスの起点となるディレクトリー。

注記

管理 CLI を使用して session-cookie 要素を管理する場合、servlet-container 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/servlet-container=default/setting=session-cookie:add
/subsystem=undertow/servlet-container=default/setting=session-cookie:read-resource

表A.42 session-cookie の属性

属性デフォルト説明

comment

 

クッキーのコメント。

domain

 

クッキーのドメイン。

http-only

 

クッキーが http 専用であるかどうか。

max-age

 

クッキーの最大有効期間。

name

 

クッキーの名前。

secure

 

クッキーがセキュアであるかどうか。

websockets の属性
注記

管理 CLI を使用して websockets 要素を管理する場合、servlet-container 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/servlet-container=default/setting=websockets:read-resource

表A.43 websockets の属性

属性デフォルト説明

buffer-pool

default

websocket デプロイメントに使用するバッファープール。

dispatch-to-worker

true

コールバックがワーカースレッドにディスパッチされるべきかどうか。false の場合、IO スレッドで実行され、より高速になりますが、ブロッキング操作を実行しないように注意する必要があります。

worker

default

websocket デプロイメントに使用するワーカー。

フィルターの属性

custom-filter フィルター

表A.44 custom-filter の属性

属性デフォルト説明

class-name

 

HttpHandler のクラス名。

module

 

クラスをロードできるモジュール名。

parameters

 

フィルターのパラメーター。

error-page フィルター

エラーページ。

表A.45 error-page の属性

属性デフォルト説明

code

 

エラーページコード。

path

 

エラーページパス。

expression-filter フィルター

Undertow 式言語から解析されたフィルター。

表A.46 expression-filter の属性

属性デフォルト説明

expression

 

フィルターを定義する式。

module

 

フィルター定義のロードに使用するモジュール。

gzip フィルター

gzip フィルターを定義し、属性はありません。

mod-cluster フィルター

mod-cluster フィルターコンポーネントの構造は次のとおりです。

表A.47 mod-cluster の属性

属性デフォルト説明

advertise-frequency

10000

ネットワーク上で mod_cluster 自体がアドバタイズする頻度 (ミリ秒単位)。

advertise-path

/

このパス以下に mod-cluster が登録されます。

advertise-protocol

http

使用中のプロトコル。

advertise-socket-binding

 

アドバタイズに使用されるマルチキャストグループ。

broken-node-timeout

60000

この期間の経過後に破損したノードがテーブルから削除されます。

cached-connections-per-thread

5

永遠にキープアライブを使用する接続の数。

connection-idle-timeout

60

接続がアイドル状態でいられる期間。この期間を経過すると接続が閉じられます。プールサイズが設定された最小値に達すると (cached-connections-per-thread によって設定) 接続はタイムアウトしません。

connections-per-thread

10

IO スレッドごとにバックエンドサーバーに保持される接続の数。

enable-http2

false

ロードバランサーがバックエンドサーバーの HTTP2 へのアップグレードを使用するかどうか。HTTP2 がサポートされていない場合は通常どおり HTTP または HTTPS が使用されます。

health-check-interval

10000

バックエンドノードへのヘルスチェック ping の頻度。

management-access-predicate

 

mod_cluster 管理コマンドを実行できるかどうかを判断するために受信リクエストに適用される述語。management-socket-binding からのリクエストの管理を制限することで、提供されるセキュリティーに追加のセキュリティーを提供します。

management-socket-binding

 

mod_cluster 管理ポートのソケットバインディング。mod_cluster を使用する場合、リクエストを処理するパブリックの HTTP リスナーと、mod_cluster コマンドを処理するための内部ネットワークにバインドされた HTTP リスナーの 2 つの HTTP リスナーを定義する必要があります。このソケットバインディングは内部リスナーと対応する必要があり、公的にアクセスできない必要があります。

max-request-time

-1

バックエンドノードへのリクエストの送信にかかる最大期間。この期間を超えるとリクエストが Kill されます。

request-queue-size

10

接続プールが満杯の場合にキューに置けるリクエストの数。この数を超えるリクエストは拒否され、503 エラーが発生します。

security-key

 

mod_cluster グループに使用されるセキュリティーキー。すべてのメンバーが同じセキュリティーキーを使用する必要があります。

security-realm

 

SSL 設定を提供するセキュリティーレルム。

use-alias

false

エイリアスチェックが実行されるかどうか。

worker

default

アドバタイズ通知の送信に使用される XNIO ワーカー。

表A.48 balancer の属性

属性デフォルト説明

max-attempts

 

リクエストをバックエンドサーバーへ送信する試行回数。

sticky-session

 

スティッキーセッションが有効であるかどうか。

sticky-session-cookie

 

セッションクッキー名。

sticky-session-force

 

true の場合、リクエストがスティッキーノードへルーティングできないとエラーが返されます。その他の場合は別のノードにルーティングされます。

sticky-session-path

 

スティッキーセッションクッキーのパス。

sticky-session-remove

 

リクエストを正しいホストへルーティングできない場合、セッションクッキーを削除します。

wait-worker

 

利用可能なワーカーを待つ秒数。

load-balancing-group の属性

ロードバランシンググループを定義し、オプションはありません。

表A.49 node の属性

属性デフォルト説明

aliases

 

ノードのエイリアス。

cache-connections

 

永遠にキープアライブを使用する接続の数。

elected

 

選択 (elected) 数。

flush-packets

 

受信したデータを即座にフラッシュするかどうか。

load

 

このノードの現在の負荷。

load-balancing-group

 

このノードが属するロードバランシンググループ。

max-connections

 

IO スレッドごとの最大接続数。

open-connections

 

現在開かれている接続の数。

ping

 

ノードの ping。

queue-new-requests

 

リクエストが受信され、即座に使用できるワーカーがない場合にキューに置くかどうか。

read

 

ノードから読み取るバイト数。

request-queue-size

 

リクエストキューのサイズ。

status

 

このノードの現在の状態。

timeout

 

リクエストのタイムアウト。

ttl

 

接続の数が cache-connections よりも多い場合に、閉じられる前にリクエストがない状態で接続にキープアライブが使用される時間。

uri

 

ロードバランサーがノードへの接続に使用する URI。

written

 

ノードに転送されたバイト数。

表A.50 context の属性

属性デフォルト説明

requests

 

このコンテキストに対するリクエストの数。

status

 

このコンテキストの状態。

request-limit フィルター

表A.51 request-limit の属性

属性デフォルト説明

max-concurrent-requests

 

同時リクエストの最大数。

queue-size

 

キューに置くリクエスト数。この数を超えるリクエストは拒否されます。

response-header フィルター

response-header フィルターはカスタムヘッダーの追加を可能にします。

表A.52 response-header の属性

属性デフォルト説明

header-name

 

ヘッダー名。

header-value

 

ヘッダーの値

rewrite フィルター

表A.53 rewrite の属性

属性デフォルト説明

redirect

false

再書き込みの代わりにリダイレクトが行われるかどうか。

target

 

ターゲットを定義する式。定数ターゲットにリダイレクトを行う場合は、値を単一引用符で囲みます。

Handler の属性

file の属性

表A.54 file の属性

属性デフォルト説明

cache-buffer-size

1024

バッファーのサイズ。

cache-buffers

1024

バッファーの数。

case-sensitive

true

大文字と小文字を区別してファイルを処理するかどうか。false (区別しない) に設定すると、基盤のファイルシステムが大文字と小文字を区別しない場合のみ動作します。

directory-listing

false

ディレクトリーの一覧を有効にするかどうか。

follow-symlink

false

シンボリックリンクのフォローを有効にするかどうか。

path

 

ファイルハンドラーがリソースに対応する場所からのファイルシステム上のパス。

safe-symlink-paths

 

シンボリックリンクのターゲットとして安全なパス。

静的リソースに WebDAV を使用

過去のバージョンの JBoss EAP では、web サブシステムで WebDAV を使用して (WebdavServlet 経由) 静的リソースをホストし、追加の HTTP メソッドを有効にしてこれらのファイルへのアクセスや操作を実行できました。JBoss EAP 7 では、ファイルハンドラーを経由した静的ファイルの対応メカニズムは undertow サブシステムによって提供されますが、undertow サブシステムは WebDAV をサポートしません。JBoss EAP 7 で WebDAV を使用する場合は、カスタムの WebDav サーブレットを記述してください。

reverse-proxy の属性

reverse-proxy ハンドラーコンポーネントの構造は以下のとおりです。

表A.55 reverse-proxy の属性

属性デフォルト説明

cached-connections-per-thread

5

永遠にキープアライブを使用する接続の数。

connection-idle-timeout

60

接続がアイドル状態でいられる期間。この期間を経過すると接続が閉じられます。プールサイズが設定された最小値に達すると (cached-connections-per-thread によって設定) 接続はタイムアウトしません。

connections-per-thread

10

IO スレッドごとにバックエンドサーバーに保持される接続の数。

max-request-time

-1

プロキシーリクエストがアクティブな状態でいられる最大時間。この値を超えるとリクエストは kill されます。デフォルトは unlimited (無制限) です。

problem-server-retry

30

ダウンしたサーバーへの再接続を試みる前に待機する時間 (秒単位)。

request-queue-size

10

接続プールが満杯の場合にキューに置けるリクエストの数。この数を超えるリクエストは拒否され、503 エラーが発生します。

session-cookie-names

JSESSIONID

セッションクッキー名のカンマ区切りリスト。通常は JSESSIONID。

表A.56 host の属性

属性デフォルト説明

instance-id

 

スティッキーセッションを有効にするために使用されるインスタンス ID または JVM ルート。

outbound-socket-binding

 

このホストのアウトバウンドソケットバインディング。

path

/

ホストがルート以外のリソースを使用する場合のオプションのパス。

scheme

http

使用されるスキームの種類。

security-realm

 

ホストへの接続の SSL 設定を提供するセキュリティーレルム。

サーバー属性

server コンポーネントの構造は次のとおりです。

server の属性

表A.57 server の属性

属性デフォルト説明

default-host

default-host

サーバーのデフォルトの仮想ホスト。

servlet-container

default

サーバーのデフォルトのサーブレットコンテナー。

http-listener の属性

表A.58 http-listener の属性

属性デフォルト説明

allow-encoded-slash

false

リクエストにエンコードされた文字 (例: %2F) が含まれる場合にデコードするかどうか。

allow-equals-in-cookie-value

false

引用符で囲まれていないクッキー値のエスケープされていない等号記号を許可するかどうか。引用符で囲まれていないクッキー値に等号記号が含まれないことがあります。等号記号が含まれると、等号の前で値が終了し、残りのクッキー値は破棄されます。

always-set-keep-alive

true

仕様が厳密に必要としない場合でも Connection: keep-alive ヘッダーが応答に追加されるかどうか。

buffer-pipelined-data

true

パイプライン化されたリクエストをバッファーするかどうか。

buffer-pool

default

リスナーのバッファープール。

certificate-forwarding

false

証明書の転送を有効にするかどうか。有効な場合、リスナーは SSL_CLIENT_CERT 属性から証明書を取得します。これらのヘッダーを常に設定するようプロキシーが設定されている場合のみ有効にする必要があります。

decode-url

true

パーサーが選択された文字エンコーディング (デフォルトでは UTF-8) を使用して URL および クエリーパラメーターをデコードするかどうか。false の場合はデコードされません。これにより、ハンドラーによる希望の文字セットへのデコードが可能になります。

disallowed-methods

["TRACE"]

許可されない HTTP メソッドのカンマ区切りリスト。

enable-http2

false

このリスナーの HTTP2 サポートを有効にするかどうか。

enabled

true

リスナーが有効であるかどうか。

http2-enable-push

true

この接続に対してサーバープッシュが有効であるかどうか。

http2-header-table-size

 

HPACK 圧縮に使用されるヘッダーテーブルのサイズ (バイト単位)。圧縮の接続ごとにメモリー量が割り当てされます。大きな値ほどメモリーを使用しますが、圧縮が向上する可能性があります。

http2-initial-window-size

 

クライアントがサーバーにデータを送信できる速度を制御するフロー制御ウインドウサイズ。

http2-max-concurrent-streams

 

単一の接続上でいつでもアクティブな状態になれる HTTP/2 の最大数。

http2-max-frame-size

 

HTTP/2 の最大フレームサイズ。

http2-max-header-list-size

 

サーバーが許可する用意があるリクエストヘッダーの最大サイズ。

max-buffered-request-size

16384

バッファー済みのリクエストの最大サイズ (バイト単位)。リクエストは通常バッファーされませんが、バッファーされる最も一般的なケースが POST リクエストの SSL 再ネゴシエーションを実行する場合です。再ネゴシエーションを実行するには、POST データを完全にバッファーする必要があります。

max-connections

 

同時接続の最大数。

max-cookies

200

解析されるクッキーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-header-size

1048576

HTTP リクエストヘッダーの最大サイズ (バイト単位)。

max-headers

200

解析されるヘッダーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-parameters

1000

解析されるパラメーターの最大数。ハッシュの脆弱性に対して保護するために使用されます。クエリーパラメーターと POST データの両方に適用されますが累積されません。たとえば、max-parameters の 2 倍をパラメーターの合計数とすることができます。

max-post-size

10485760

許可される最大 POST サイズ。

no-request-timeout

 

接続がアイドル状態でいられる期間 (ミリ秒単位)。この期間を超えると接続がコンテナーによって閉じられます。

proxy-address-forwarding

false

x-forwarded-host および同様のヘッダーを有効にし、リモート IP アドレスおよびホスト名を設定するかどうか。

read-timeout

 

ソケットの読み取りタイムアウトを設定します (ミリ秒単位)。読み取りに成功しないまま指定の時間が経過すると、ソケットの次の読み取りによって {@link ReadTimeoutException} が発生します。

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

リクエストの開始時間を記録し、リクエスト時間がログに記録されるようにするかどうか。パフォーマンスへの影響は小さいながら、ある程度の影響を与えます。

redirect-socket

 

このリスナーが SSL でないリクエストをサポートし、リクエストが一致する必要がある SSL トランスポートに対して受信された場合、リクエストをここに指定されたソケットバインディングポートに自動的にリダイレクトするかどうか。

request-parse-timeout

 

リクエストの解析に費やすことができる最大時間 (ミリ秒単位)。

resolve-peer-address

false

ホストの DNS ルックアップを有効にします。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

リスナーのソケットバインディング。

tcp-backlog

 

指定のバックログでサーバーを設定します。

tcp-keep-alive

 

実装に依存して TCP キープアライブメッセージを送信するようチャネルを設定します。

url-charset

UTF-8

URL の文字セット。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

ソケットの書き込みタイムアウトを設定します (ミリ秒単位)。書き込みに成功しないまま指定の時間が経過すると、ソケットの次の書き込みによって {@link ReadTimeoutException} が発生します。

以下の属性は読み取り専用で、undertow サブシステムに対して統計が有効になっている場合のみ使用できます。

表A.59 http-listener メトリック属性

属性デフォルト説明

bytes-received

 

このリスナーによって受信されたバイト数。

bytes-sent

 

このリスナーによって送信されたバイト数。

error-count

 

このリスナーによって送信された 500 応答コードの数。

max-processing-time

 

このリスナーのリクエストによる最大処理時間。

processing-time

 

このリスナーによって処理されるすべてのリクエストの合計処理時間。

request-count

 

このリスナーが対応したリクエストの数。

https-listener の属性

表A.60 https-listener の属性

属性デフォルト説明

allow-encoded-slash

false

リクエストにエンコードされた文字 (例: %2F) が含まれる場合にデコードするかどうか。

allow-equals-in-cookie-value

false

引用符で囲まれていないクッキー値のエスケープされていない等号記号を許可するかどうか。引用符で囲まれていないクッキー値に等号記号が含まれないことがあります。等号記号が含まれると、等号の前で値が終了し、残りのクッキー値は破棄されます。

always-set-keep-alive

true

仕様が厳密に必要としない場合でも Connection: keep-alive ヘッダーが応答に追加されるかどうか。

buffer-pipelined-data

true

パイプライン化されたリクエストをバッファーするかどうか。

buffer-pool

default

リスナーのバッファープール。

decode-url

true

パーサーが選択された文字エンコーディング (デフォルトでは UTF-8) を使用して URL および クエリーパラメーターをデコードするかどうか。false の場合はデコードされません。これにより、ハンドラーによる希望の文字セットへのデコードが可能になります。

disallowed-methods

["TRACE"]

許可されない HTTP メソッドのカンマ区切りリスト。

enable-http2

false

このリスナーの HTTP2 サポートを有効にします。

enable-spdy

false

このリスナーの SPDY サポートを有効にします。

enabled

true

リスナーが有効であるかどうか。

enabled-cipher-suites

 

有効な SSL 暗号を設定します。

enabled-protocols

 

SSL プロトコルを設定します。

http2-enable-push

true

この接続に対してサーバープッシュが有効であるかどうか。

http2-header-table-size

 

HPACK 圧縮に使用されるヘッダーテーブルのサイズ (バイト単位)。圧縮の接続ごとにメモリー量が割り当てされます。大きな値ほどメモリーを使用しますが、圧縮が向上する可能性があります。

http2-initial-window-size

 

クライアントがサーバーにデータを送信できる速度を制御するフロー制御ウインドウサイズ。

http2-max-concurrent-streams

 

単一の接続上でいつでもアクティブな状態になれる HTTP/2 の最大数。

http2-max-frame-size

 

HTTP/2 の最大フレームサイズ。

http2-max-header-list-size

 

サーバーが許可する用意があるリクエストヘッダーの最大サイズ。

max-buffered-request-size

16384

バッファー済みのリクエストの最大サイズ (バイト単位)。リクエストは通常バッファーされませんが、バッファーされる最も一般的なケースが POST リクエストの SSL 再ネゴシエーションを実行する場合です。再ネゴシエーションを実行するには、POST データを完全にバッファーする必要があります。

max-connections

 

同時接続の最大数。

max-cookies

100

解析されるクッキーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-header-size

1048576

HTTP リクエストヘッダーの最大サイズ (バイト単位)。

max-headers

200

解析されるヘッダーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-parameters

1000

解析されるパラメーターの最大数。ハッシュの脆弱性に対して保護するために使用されます。クエリーパラメーターと POST データの両方に適用されますが累積されません。たとえば、max-parameters の 2 倍をパラメーターの合計数とすることができます。

max-post-size

10485760

許可される最大 POST サイズ。

no-request-timeout

 

接続がアイドル状態でいられる期間 (ミリ秒単位)。この期間を超えると接続がコンテナーによって閉じられます。

read-timeout

 

ソケットの読み取りタイムアウトを設定します (ミリ秒単位)。読み取りに成功しないまま指定の時間が経過すると、ソケットの次の読み取りによって {@link ReadTimeoutException} が発生します。

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

リクエストの開始時間を記録し、リクエスト時間がログに記録されるようにするかどうか。パフォーマンスへの影響は小さいながら、ある程度の影響を与えます。

request-parse-timeout

 

リクエストの解析に費やすことができる最大時間 (ミリ秒単位)。

resolve-peer-address

false

ホストの DNS ルックアップを有効にします。

security-realm

 

リスナーのセキュリティーレルム。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

リスナーのソケットバインディング。

ssl-session-cache-size

 

アクティブな SSL セッションの最大数。

ssl-session-timeout

 

SSL セッションのタイムアウト (秒単位)。

tcp-backlog

 

指定のバックログでサーバーを設定します。

tcp-keep-alive

 

実装に依存して TCP キープアライブメッセージを送信するようチャネルを設定します。

url-charset

UTF-8

URL の文字セット。

verify-client

NOT_REQUESTED

SSL チャネルに対する希望の SSL クライアント認証モード。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

ソケットの書き込みタイムアウトを設定します (ミリ秒単位)。書き込みに成功しないまま指定の時間が経過すると、ソケットの次の書き込みによって {@link ReadTimeoutException} が発生します。

以下の属性は読み取り専用で、undertow サブシステムに対して統計が有効になっている場合のみ使用できます。

表A.61 https-listener メトリック属性

属性デフォルト説明

bytes-received

 

このリスナーによって受信されたバイト数。

bytes-sent

 

このリスナーによって送信されたバイト数。

error-count

 

このリスナーによって送信された 500 応答コードの数。

max-processing-time

 

このリスナーのリクエストによる最大処理時間。

processing-time

 

このリスナーによって処理されるすべてのリクエストの合計処理時間。

request-count

 

このリスナーが対応したリクエストの数。

ajp-listener 属性

表A.62 ajp-listener 属性

属性デフォルト説明

allow-encoded-slash

false

リクエストにエンコードされた文字 (例: %2F) が含まれる場合にデコードするかどうか。

allow-equals-in-cookie-value

false

引用符で囲まれていないクッキー値のエスケープされていない等号記号を許可するかどうか。引用符で囲まれていないクッキー値に等号記号が含まれないことがあります。等号記号が含まれると、等号の前で値が終了し、残りのクッキー値は破棄されます。

always-set-keep-alive

true

仕様が厳密に必要としない場合でも Connection: keep-alive ヘッダーが応答に追加されるかどうか。

buffer-pipelined-data

true

パイプライン化されたリクエストをバッファーするかどうか。

buffer-pool

default

AJP リスナーのバッファープール。

decode-url

true

true の場合、パーサーは選択された文字エンコーディング (デフォルトでは UTF-8) を仕様して URL および クエリーパラメーターをデコードします。false の場合はデコードされません。これにより、ハンドラーによる希望の文字セットへのデコードが可能になります。

disallowed-methods

["TRACE"]

許可されない HTTP メソッドのカンマ区切りリスト。

enabled

true

リスナーが有効であるかどうか。

max-ajp-packet-size

 

AJP パケットがサポートされる最大サイズ。変更する場合は、ロードバランサーとバックエンドサーバーで増やす必要があります。

max-buffered-request-size

16384

バッファー済みのリクエストの最大サイズ (バイト単位)。リクエストは通常バッファーされませんが、バッファーされる最も一般的なケースが POST リクエストの SSL 再ネゴシエーションを実行する場合です。再ネゴシエーションを実行するには、POST データを完全にバッファーする必要があります。

max-connections

 

同時接続の最大数。

max-cookies

200

解析されるクッキーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-header-size

1048576

HTTP リクエストヘッダーの最大サイズ (バイト単位)。

max-headers

200

解析されるヘッダーの最大数。ハッシュの脆弱性に対して保護するために使用されます。

max-parameters

100

解析されるパラメーターの最大数。ハッシュの脆弱性に対して保護するために使用されます。クエリーパラメーターと POST データの両方に適用されますが累積されません。たとえば、max-parameters の 2 倍をパラメーターの合計数とすることができます。

max-post-size

10485760

許可される最大 POST サイズ。

no-request-timeout

 

接続がアイドル状態でいられる期間 (ミリ秒単位)。この期間を超えると接続がコンテナーによって閉じられます。

read-timeout

 

ソケットの読み取りタイムアウトを設定します (ミリ秒単位)。読み取りに成功しないまま指定の時間が経過すると、ソケットの次の読み取りによって {@link ReadTimeoutException} が発生します。

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

リクエストの開始時間を記録し、リクエスト時間がログに記録されるようにするかどうか。パフォーマンスへの影響は小さいながら、ある程度の影響を与えます。

redirect-socket

 

このリスナーが SSL でないリクエストをサポートし、リクエストが一致する必要がある SSL トランスポートに対して受信された場合、リクエストをここに指定されたソケットバインディングポートに自動的にリダイレクトするかどうか。

request-parse-timeout

 

リクエストの解析に費やすことができる最大時間 (ミリ秒単位)。

resolve-peer-address

false

ホストの DNS ルックアップを有効にします。

scheme

 

リスナースキーム (HTTP または HTTPS)。デフォルトでは、スキーマは受信 AJP リクエストから取得されます。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

AJP リスナーのソケットバインディング。

tcp-backlog

 

指定のバックログでサーバーを設定します。

tcp-keep-alive

 

実装に依存して TCP キープアライブメッセージを送信するようチャネルを設定します。

url-charset

UTF-8

URL の文字セット。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

ソケットの書き込みタイムアウトを設定します (ミリ秒単位)。書き込みに成功しないまま指定の時間が経過すると、ソケットの次の書き込みによって {@link ReadTimeoutException} が発生します。

以下の属性は読み取り専用で、undertow サブシステムに対して統計が有効になっている場合のみ使用できます。

表A.63 ajp-listener メトリック属性

属性デフォルト説明

bytes-received

 

このリスナーによって受信されたバイト数。

bytes-sent

 

このリスナーによって送信されたバイト数。

error-count

 

このリスナーによって送信された 500 応答コードの数。

max-processing-time

 

このリスナーのリクエストによる最大処理時間。

processing-time

 

このリスナーによって処理されるすべてのリクエストの合計処理時間。

request-count

 

このリスナーが対応したリクエストの数。

host の属性

表A.64 host の属性

属性デフォルト説明

alias

 

ホストのエイリアスのカンマ区切りリスト。

default-response-code

404

設定した場合、サーバー上に要求されたコンテキストが存在しない場合に設定した応答コードが返信されます。

default-web-module

ROOT.war

デフォルトの Web モジュール。

disable-console-redirect

false

true に設定した場合、このホストに対して /console リダイレクトが有効になりません。

filter-ref の属性

表A.65 filter-ref の属性

属性デフォルト説明

predicate

 

predicate は交換を基に true または false の決定を行う簡単な方法です。多くのハンドラーには条件によって適用される要件があり、predicate は条件を指定する一般的な方法を提供します。

priority

1

フィルターの順序を定義します。1 以上を設定する必要があります。同じコンテキスト下で数字が大きいほどサーバーのハンドラーチェインでの順序が早くなるよう指示します。

access-log の属性
注記

管理 CLI を使用して access-log 要素を管理する場合、host 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/server=default-server/host=default-host/setting=access-log:add
/subsystem=undertow/server=default-server/host=default-host/setting=access-log:read-resource

表A.66 access-log の属性

属性デフォルト説明

directory

${jboss.server.log.dir}

ログを保存するディレクトリー。

extended

false

ログが拡張されたログファイル形式を使用するかどうか。

pattern

common

アクセスログパターン。

predicate

 

リクエストをログに記録するかどうかを判断する述語。

prefix

access_log

ログファイル名の接頭辞。

relative-to

 

相対パスの起点となるディレクトリー。

rotate

true

アクセスログを毎日ローテーションするかどうか。

suffix

.log

ログファイル名の接尾辞。

use-server-log

false

ログが個別のファイルではなくサーバーログに書き込まれるかどうか。

worker

default

ロギングに使用するワーカーの名前。

single-sign-on の属性
注記

管理 CLI を使用して single-sign-on 要素を管理する場合、host 要素の settings 下で使用できます。以下に例を示します。

/subsystem=undertow/server=default-server/host=default-host/setting=single-sign-on:add
/subsystem=undertow/server=default-server/host=default-host/setting=single-sign-on:read-resource
重要

配布されるシングルサインオンは、アプリケーションの観点からではこれまでのバージョンの JBoss EAP と変わりありませんが、JBoss EAP 7 では認証情報のキャッシュおよび配布の処理が異なります。JBoss EAP 7 で HA プロファイルを実行する場合、デフォルトではホストは関連するセッションおよび SSO クッキー情報が保存される独自の Infinispan キャッシュを持ちます。このキャッシュは Web キャッシュコンテナーのデフォルトキャッシュがベースになります。また、JBoss EAP はホストすべての個別のキャッシュ間で情報の伝搬を処理します。

表A.67 single-sign-on の属性

属性デフォルト説明

cookie-name

JSESSIONIDSSO

クッキーの名前。

domain

 

使用されるクッキードメイン。

http-only

false

クッキーの httpOnly 属性を設定します。

path

/

クッキーのパス。

secure

false

クッキーの secure 属性を設定します。

location の属性

表A.68 location の属性

属性デフォルト説明

handler

 

この場所のデフォルトのハンドラー。

A.22. HTTP メソッドのデフォルトの動作。

JBoss EAP 7.0 の undertow subsystem は、これまでの JBoss EAP リリースの web サブシステムと比較して HTTP メソッドのデフォルト動作が異なります。以下の表は、JBoss EAP 7.0 のデフォルト動作を表しています。

表A.69 HTTP メソッドのデフォルト動作

HTTP メソッドJSPServlet静的 HTML

GET

OK

実装によって異なる

OK

POST

OK

実装によって異なる

NOT_ALLOWED

HEAD

OK

実装によって異なる

OK

PUT

NOT_ALLOWED

実装によって異なる

NOT_ALLOWED

TRACE

NOT_ALLOWED

NOT_ALLOWED

NOT_ALLOWED

DELETE

NOT_ALLOWED

実装によって異なる

NOT_ALLOWED

OPTIONS

NOT_ALLOWED

実装によって異なる

OK

A.23. IO サブシステムの属性

表A.70 worker の属性

属性デフォルト説明

io-threads

 

使用する IO スレッドの数。

stack-size

0

スタックのサイズ。

task-keepalive

60

タスクのキープアライブ時間。

task-max-threads

 

タスクの最大スレッド数。

表A.71 buffer-pool の属性

属性デフォルト説明

buffer-size

 

バッファーのサイズ

buffers-per-slice

 

スライスごとのバッファー数。

direct-buffers

 

直接バッファーをバッファープールが使用するかどうか。

A.24. Remoting サブシステムの属性

表A.72 remoting の属性

属性デフォルト説明

worker-read-threads

1

リモーティングワーカーに対して作成する読み取りスレッドの数。

worker-task-core-threads

4

リモーティングワーカーのタスクスレッドプールに対するコアスレッドの数。

worker-task-keepalive

60

コアでないリモーティングワーカーのタスクスレッドにキープアライブを使用する期間 (ミリ秒単位)。

worker-task-limit

16384

許可するリモーティングワーカータスクの最大数。この数を超えるリモーティングワーカータスクは拒否されます。

worker-task-max-threads

16

リモーティングワーカーのタスクスレッドプールに対するスレッドの最大数。

worker-write-threads

1

リモーティングワーカーに作成する書き込みスレッドの数。

重要

remoting 要素の上記の属性は非推奨になりました。これらの属性は io サブシステムを使用して設定する必要があります。

表A.73 endpoint の属性

属性デフォルト説明

auth-realm

 

認証の CallbackHandler が指定されていない場合に使用する認証レルム。

authentication-retries

3

接続を閉じる前にクライアントが認証を再試行できる回数を指定します。

authorize-id

 

SASL 認証 ID。指定されている認証 CallbackHandler がなく、選択した SASL メカニズムがユーザー名を要求する場合に認証ユーザー名として使用されます。

buffer-region-size

 

割り当てられたバッファーリージョンのサイズ。

heartbeat-interval

2147483647

接続ハートビートに使用する間隔 (ミリ秒単位)。この時間アウトバウンド方向の接続がアイドル状態であると、ping メッセージが送信され、対応する応答メッセージがトリガーされます。

max-inbound-channels

40

チャネルの同時インバウンドメッセージの最大数。

max-inbound-message-size

9223372036854775807

許可されるインバウンドメッセージの最大サイズ。メッセージがこのサイズを超えると、読み取り側および書き込み側に例外が発生します。

max-inbound-messages

80

接続に対してサポートされるインバウンドチャネルの最大数。

max-outbound-channels

40

チャネルの同時アウトバウンドメッセージの最大数。

max-outbound-message-size

9223372036854775807

送信するアウトバウンドメッセージの最大サイズ。これよりも大きいサイズのメッセージは送信されません。送信しようとすると、書き込み側に例外が発生します。

max-outbound-messages

65535

接続に対してサポートされるアウトバウンドチャネルの最大数。

receive-buffer-size

8192

接続上でこのエンドポイントが許可する最大バッファーサイズ。

receive-window-size

131072

接続チャネルの受信方向の最大ウインドウサイズ (バイト単位)。

sasl-protocol

remoting

SaslServer または SaslClient が作成され、デフォルトで remoting プロトコルが指定された場合、これを使用して上書きできます。

send-buffer-size

8192

接続上でこのエンドポイントが送信する最大バッファーサイズ。

server-name

 

最初の案内応答で接続のサーバー側はその名前をクライアントに渡します。デフォルトでは、名前は接続のローカルアドレスから自動的に検索されますが、これを使用して名前を上書きできます。

transmit-window-size

131072

接続チャネルの受信方向の最大ウインドウサイズ (バイト単位)。

worker

default

使用するワーカー

注記

endpoint 要素の更新に管理 CLI を使用する場合、remoting 要素の configuration (例: /subsystem=remoting/configuration=endpoint/) で使用できます。

コネクターの属性

connector コンポーネントの構造は次のとおりです。

表A.74 connector の属性

属性デフォルト説明

authentication-provider

 

authentication-provider 要素には、受信接続に使用する認証プロバイダーの名前が含まれます。

sasl-protocol

remote

認証に使用する SASL メカニズムに渡すプロトコル。

security-realm

 

このコネクターの認証に使用する、関連するセキュリティーレルム。

server-name

 

最初のメッセージ交換で送信され、SASL ベースの認証用のサーバー名。

socket-binding

 

アタッチするソケットバインディングの名前。

表A.75 property の属性

属性デフォルト説明

value

 

プロパティーの値。

セキュリティーの属性

security コンポーネントはコネクターのセキュリティーを設定できるようにしますが、直接の設定属性は含まれていません。sasl などのネストされたコンポーネントを使用して設定できます。

表A.76 sasl の属性

属性デフォルト説明

include-mechanisms

 

オプションのネストされた include-mechanisms 要素には、許可される SASL メカニズム名のホワイトリストが含まれます。このリストにないメカニズムは許可されません。

qop

 

オプションのネストされた qop 要素には、QOP (保護品質) の値が希望順に並ぶリストが含まれます。

reuse-session

false

オプションのネストされた reuse-session ブール値要素は、以前認証したセッション情報をサーバーが再使用するかどうかを指定します。メカニズムによってはこのような再使用をサポートしない可能性があり、その他の要因によって再使用できないこともあります。

server-auth

false

オプションのネストされた server-auth ブール値要素は、サーバーがクライアントに対して認証されるかどうかを指定します。メカニズムによってはこの設定をサポートしない可能性があります。

strength

 

オプションのネストされた「strength」要素には暗号強度の値が希望順に並ぶリストが含まれます。

sasl-policy 属性

sasl-policy コンポーネントでは、利用できるメカニズムのセットを限定するために使用する任意のポリシーを指定できますが、直接の設定属性は含まれていません。policy などのネストされたコンポーネントを使用して設定できます。

表A.77 policy 属性

属性デフォルト説明

forward-secrecy

true

オプションのネストされた forward-secrecy 要素には、セッション間で Forward Secrecy を実装するメカニズムを指定するブール値が含まれます。Forward Secrecy とは、あるセッションが侵入されてもその後のセッションに侵入するための情報が自動的に提供されないことを意味します。

no-active

true

オプションのネストされた no-active 要素には、能動的攻撃 (辞書攻撃でない) を受けやすいメカニズムを許可するかどうかを指定するブール値が含まれます。許可する場合は false、拒否する場合は true を設定します。

no-anonymous

true

オプションのネストされた no-anonymous 要素には、匿名のログインを許可するメカニズムを許可するかどうかを指定するブール値が含まれます。許可する場合は false、拒否する場合は true を設定します。

no-dictionary

true

オプションのネストされた no-dictionary 要素には、受動的な辞書攻撃を受けやすいメカニズムを許可するかどうかを指定するブール値が含まれます。許可する場合は false、拒否する場合は true を設定します。

no-plain-text

true

オプションのネストされた no-plain-text 要素には、平文の受動的攻撃 (例: PLAIN) を受けやすいメカニズムを許可するかどうかを指定するブール値が含まれます。許可する場合は false、拒否する場合は true を設定します。

pass-credentials

true

オプションネストされた pass-credentials 要素には、クライアントのクレデンシャルを渡すメカニズムが必要であるかどうかを指定するブール値が含まれます。

HTTP コネクターの属性

http-connector コンポーネントの構造は次のとおりです。

表A.78 http-connector の属性

属性デフォルト説明

authentication-provider

 

authentication-provider 要素には、受信接続に使用する認証プロバイダーの名前が含まれます。

connector-ref

 

接続する undertow サブシステムのコネクターの名前。

sasl-protocol

remote

認証に使用する SASL メカニズムに渡すプロトコル。

security-realm

 

このコネクターの認証に使用する、関連するセキュリティーレルム。

server-name

 

最初のメッセージ交換で送信され、SASL ベースの認証用のサーバー名。

アウトバウンド接続の属性

outbound-connection コンポーネントの構造は次のとおりです。

表A.79 outbound-connection の属性

属性デフォルト説明

uri

 

アウトバウンド接続の接続 URI。

表A.80 property の属性

属性デフォルト説明

value

 

プロパティーの値。

注記

上記の property 属性は、接続の作成中に使用される XNIO 操作に関連します。

リモートアウトバウンド接続

remote-outbound-connection コンポーネントの構造は次のとおりです。

表A.81 remote-outbound-connection 属性

属性デフォルト説明

outbound-socket-binding-ref

 

接続の宛先アドレスとポートの判断に使用される outbound-socket-binding の名前。

protocol

http-remoting

リモート接続に使用するプロトコル。デフォルトは http-remoting です。

security-realm

 

パスワードおよび SSL 設定の取得に使用するセキュリティーレルムへの参照。

username

 

リモートサーバーの認証時に使用するユーザー名。

ローカルアウトバウンド接続の属性

local-outbound-connection コンポーネントの構造は次のとおりです。

表A.82 local-outbound-connection の属性

属性デフォルト説明

outbound-socket-binding-ref

 

接続の宛先アドレスとポートの判断に使用される outbound-socket-binding の名前。

A.25. Apache HTTP Server の mod_cluster ディレクティブ

mod_cluster コネクターは Apache HTTP Server ベースのロードバランサーです。通信チャネルを使用して、リクエストを Apache HTTP Server からアプリケーションサーバーノードのセットの 1 つに転送します。mod_cluster の設定には以下のディレクティブを指定できます。

注記

mod_cluser は Apache HTTP Server に転送しなければならない URL を自動的に設定するため、ProxyPass ディレクティブを使用する必要はありません。

表A.83 mod_cluster ディレクティブ

ディレクティブ説明

CreateBalancers

バランサーが Apache HTTP Server の VirtualHosts でどのように作成されるかを定義します。ProxyPass /balancer://mycluster1/ のようなディレクティブを許可します。

  • 0: Apache HTTP Server に定義されるすべての VirtualHosts を作成します。
  • 1: バランサーを作成しません (バランサー名を定義するため最低でも 1 つの ProxyPass または ProxyMatch が必要です)。
  • 2: メインサーバーのみ作成します (デフォルト)

UseAlias

エイリアスがサーバー名に対応することを確認します。

  • 0: エイリアスを無視します (デフォルト)
  • 1: エイリアスをチェックします。

LBstatusRecalTime

負荷分散ロジックがノードの状態を再計算する間隔 (秒単位)。

デフォルト: 5 秒

WaitBeforeRemove

削除されたノードを httpd が記憶しなくなるまでの時間 (分単位)。

デフォルト: 10 秒

ProxyPassMatch/ProxyPass

ProxyPassMatch および ProxyPass は、バックエンド URL の代わりに「!」を使用するとパスのリバースプロキシーを防ぐ mod_proxy ディレクティブです。これは、Apache HTTP Server が静的なコンテンツに対応できるようにするために使用されます。たとえば、ProxyPassMatch ^(/.*\.gif)$ ! を指定すると、Apache HTTP Server は直接 .gif ファイルに対応できます。

 

mod_cluster ロジックのホットスタンバイノードは、他のすべてのノードがダウンした場合にすべての要求がルーティングされる最後のノードです。これは、mod_proxy のホットスタンバイロジックと似ています。

ホットスタンバイノードを設定するには、modcluster サブシステムの dynamic-load-provider を、ファクターが 0 に設定されている simple-load-provider に置き換えます。

<subsystem xmlns="urn:jboss:domain:modcluster:2.0">
  <mod-cluster-config advertise-socket="modcluster" connector="ajp">
    <dynamic-load-provider>
      <load-metric type="cpu"/>
    </dynamic-load-provider>
    <simple-load-provider factor="0"/>
  </mod-cluster-config>
</subsystem>

mod_cluster-manager コンソールで、状態が OKLoad: 0 のノードが表示されます。

たとえば、以下の 3 つのノードがあるとします。

  • ノード A、Load: 10
  • ノード B、Load: 10
  • ノード C、Load: 0

この場合、負荷はノード A と B の間で分散されます。両方のノードが使用できない場合は、ノード C に負荷が集中します。

mod_manager

mod_manager ディレクティブのコンテキストは、指定がある場合を除きすべて VirtualHost になります。server config コンテキストは、ディレクティブが VirtualHost 設定の外部になければならないことを示します。そうでない場合、エラーメッセージが表示され、Apache HTTP Server が開始しません。

表A.84 mod_manager ディレクティブ

ディレクティブ説明

EnableMCPMReceive

VirtualHost がノードから MCPM を受信できるようにします。mod_cluster が動作するようにするため、Apache HTTP Server 設定に EnableMCPMReceive が含まれます。VirtualHost のアドバタイズを設定する場所に保存します。

 

MemManagerFile

設定の保存、共有メモリーまたはロックされたファイルのキー生成に mod_manager が使用する名前のベース名。絶対パス名である必要があります。ディレクトリーは必要な場合に作成されます。これらのファイルは NFS 共有ではなくローカルドライブに格納することが推奨されます。コンテキスト: server config

$server_root/logs/

Maxcontext

mod_cluster によってサポートされるコンテキストの最大数。コンテキスト: server config

デフォルト: 100

Maxnode

mod_cluster によってサポートされるノードの最大数。コンテキスト: server config

デフォルト: 20

Maxhost

mod_cluster によってサポートされるホスト (エイリアス) の最大数。バランサーの最大数も含まれます。コンテキスト: server config

デフォルト: 20

Maxsessionid

mod_cluster-manager ハンドラーにアクティブなセッションの数を提供するために保存されるアクティブ sessionid の数。5 分以内に mod_cluster がセッションから情報を受信しないとセッションは非アクティブになります。コンテキスト: server config。このフィールドはデモおよびデバッグの目的のみで使用されます。

0: ロジックはアクティベートされません。

MaxMCMPMaxMessSize

他の Max ディレクティブからの MCMP メッセージの最大サイズ。

他の Max ディレクティブより計算されます。最小: 1024

ManagerBalancerName

JBoss EAP インスタンスがバランサー名を提供しない場合に使用されるバランサーの名前。

mycluster

PersistSlots

ファイルのノード、エイリアス、およびコンテキストを保持するよう mod_slotmem に伝えます。コンテキスト: server config

オフ

CheckNonce

mod_cluster-manager ハンドラーを使用する際に nonce のチェックを切り替えます。

on/off、デフォルト: on - Nonce をチェック

AllowDisplay

mod_cluster-manager メインページの追加表示を切り替えます。

on/off、デフォルト: off - バージョンのみを表示

AllowCmd

mod_cluster-manager URL を使用するコマンドを許可します。

on/off、デフォルト: on - コマンドを許可

ReduceDisplay

メインの mod_cluster-manager ページに表示される情報を減らし、ページ上により多くのノードを表示できるようにします。

on/off、デフォルト: off - 情報をすべて表示

SetHandler mod_cluster-manager

mod_cluster がクラスターから可視できるノードの情報を表示します。情報には一般的な情報が含まれ、追加でアクティブなセッションの数を調べます。

<Location /mod_cluster-manager>
  SetHandler mod_cluster-manager
  Require ip 127.0.0.1
</Location>

on/off、デフォルト: off

注記

httpd.conf に定義された場所にアクセスする場合:

  • Transferred: バックエンドサーバーに送信された POST データに対応。
  • Connected: mod_cluster の状態ページが要求されたときに処理された要求の数に対応。
  • Num_sessions: mod_cluster がアクティブと報告するセッションの数に対応 (過去 5 分以内に要求があった場合)。Maxsessionid がゼロの場合、このフィールドは存在しません。このフィールドはデモおよびデバッグの目的でのみ使用されます。

A.26. ModCluster サブシステムの属性

modcluster サブシステムの構造は次のとおりです。

表A.85 mod-cluster-config 設定オプション

属性デフォルト説明

advertise

true

Advertise ロジックを使用するかどうか。

advertise-security-key

 

Advertise ロジックのセキュリティーキーが含まれる文字列。

advertise-socket

 

Advertise ソケットに使用するソケットバインディングの名前。

auto-enable-contexts

true

mod_cluster_manager (httpd) で無効になっている場合でもコンテキストを有効にします。

balancer

 

バランサーの名前。

connector

 

mod_cluster のリバースプロキシーが接続する Undertow リスナーの名前。

excluded-contexts

 

mod_cluster が無視するコンテキストのリスト。形式は文字列のカンマ区切り。

flush-packets

false

httpd でのパケットのフラッシュを有効または無効にします。

flush-wait

-1

httpd でパケットをフラッシュする前に待機する期間。最大値は 2,147,483,647

load-balancing-group

 

loadBalancingGroup の名前。

max-attempts

1

べき等のリクエストを処理する最大試行回数。-1 から 2,147,483,647 までの値が許可されます。

node-timeout

-1

ノードへのプロキシー接続のタイムアウト値 (秒単位)。-1 から 2,147,483,647 までの値が許可されます。

ping

10

ping に対する pong 返答を待つ時間 (秒単位)。

proxies

 

socket-binding-group の outbound-socket-binding によって定義される、登録する mod_cluster のプロキシーリスト。

proxy-list

 

プロキシーのリスト。形式 (hostname:port) はカンマ区切り。

注記

proxy-list 属性は非推奨となり、proxies 属性 (outbound-socket-binding への参照のリスト) の使用が推奨されます。

proxy-url

/

MCMP リクエストのベース URL。

session-draining-strategy

DEFAULT

Web アプリケーションのアンデプロイ中に使用されるセッションドレインストラテジー。

simple-load-provider

 

簡単なロードプロバイダー。-1 から 2,147,483,647 までの値が許可されます。

smax

-1

httpd でのソフトリミットの最大アイドル接続数。-1 から 2,147,483,647 までの値が許可されます。

socket-timeout

20

httpd による MCMP メッセージへの返答待ちのタイムアウト値。-1 から 2,147,483,647 までの値が許可されます。

status-interval

10

STATUS メッセージがアプリケーションサーバーからリバースプロキシーへ送信される秒数。-1 から 2,147,483,647 までの値が許可されます。

sticky-session

true

リクエストにスティッキーセッションを使用します。

sticky-session-force

false

セッション情報を持つリクエストをフェイルオーバーしません。

sticky-session-remove

false

フェイルオーバー時にセッション情報を削除します。

stop-context-timeout

10

コンテキストによる保留中リクエストの処理を待つ最大時間。-1 から 2,147,483,647 までの値が許可されます。

ttl

-1

smax を超えるアイドル接続の TTL (Time To Live)。-1 から 2,147,483,647 までの値が許可されます。

worker-timeout

-1

httpd で利用可能なワーカーによるリクエスト処理の待機時間のタイムアウト値。-1 から 2,147,483,647 までの値が許可されます。

表A.86 dynamic-load-provider 設定オプション

属性デフォルト説明

decay

2

減退 (Decay)。

history

9

履歴。

表A.87 custom-load-metric 属性オプション

属性デフォルト説明

capacity

1.0

メトリックの容量。

class

 

カスタムメトリックのクラス名。

property

 

メトリックのプロパティー

weight

1

メトリックの重み。

表A.88 load-metric 属性オプション

属性デフォルト説明

capacity

1.0

メトリックの容量。

property

 

メトリックのプロパティー

type

 

メトリックのタイプ。

weight

1

メトリックの重み。

表A.89 ssl 属性オプション

属性デフォルト説明

ca-certificate-file

 

認証局。

ca-revocation-url

 

認証局の失効リスト。

certificate-key-file

${user.home}/.keystore

証明書のキーファイル。

cipher-suite

 

許可された暗号スイート。

key-alias

 

キーエイリアス。

password

changeit

パスワード。

protocol

TLS

有効な SSL プロトコル。

A.27. mod_jk ワーカープロパティー

workers.properties ファイルは mod_jk がクライアント要求を渡すワーカーの動作を定義します。workers.properties ファイルは、異なるサーブレットコンテナーが存在する場所と、ワークロードをアプリケーションサーバーすべてで分散する方法を定義します。

プロパティーの一般的な構造は worker.WORKER_NAME.DIRECTIVE です。WORKER_NAME は、JBoss EAP の undertow サブシステムに設定された instance-id と一致する必要がある一意な名前です。DIRECTIVE はワーカーに適用される設定です。

Apache mod_jk ロードバランサーの設定リファレンス

テンプレートはデフォルトのロードバランサーごとの設定を指定します。ロードバランサーの設定内でテンプレートを上書きできます。

表A.90 グローバルプロパティー

プロパティー説明

worker.list

mod_jk によって使用されるワーカー名のカンマ区切りリスト。

表A.91 必須ディレクティブ

プロパティー説明

type

ワーカーのタイプ。デフォルトのタイプは ajp13 です。他の可能な値は ajp14lbstatus です。これらのディレクティブの詳細は、https://tomcat.apache.org/connectors-doc/reference/workers.html の『Apache Tomcat Connectors Reference』を参照してください。

表A.92 負荷分散ディレクティブ

プロパティー説明

balance_workers

ロードバランサーが管理する必要があるワーカーノードを指定します。同じロードバランサーにディレクティブを複数回使用できます。カンマ区切りのワーカーノード名のリストで構成されます。

sticky_session

同じセッションからのリクエストを常に同じワーカーにルーティングするかどうかを指定します。デフォルトは 1 で、スティッキーセッションが有効になります。スティッキーセッションを無効にするには 0 を設定します。すべてのリクエストが実際にステートレスである場合を除き、スティッキーセッションは通常有効にする必要があります。

表A.93 接続ディレクティブ

プロパティー説明

host

バックエンドサーバーのホスト名または IP アドレス。バックエンドサーバーは ajp プロコトルスタックをサポートする必要があります。デフォルト値は localhost です。

port

定義されたプロトコルリクエストをリッスンしているバックエンドサーバーインスタンスのポート番号。デフォルトの値は、AJP13 ワーカーのデフォルトのリッスンポートである 8009 です。AJP14 ワーカーのデフォルト値は 8011 です。

ping_mode

ネットワークの状態に対して接続がプローブされる条件。プローブは CPing に空の AJP13 パケットを使用し、応答で CPong を想定します。ディレクティブフラグの組み合わせを使用して条件を指定します。フラグはコンマまたはスペースで区切られません。ping_mode は C、P、I、および A の任意の組み合わせです。

  • C - Connect (接続)。サーバーへの接続後に 1 回接続をプローブします。connect_timeout の値を使用してタイムアウトを指定します。指定がないと、ping_timeout の値が使用されます。
  • P - Prepost (プレポスト)。各リクエストをサーバーに送信する前に接続をプローブします。prepost_timeout ディレクティブを使用してタイムアウトを指定します。指定がないと、ping_timeout の値が使用されます。
  • I - Interval (間隔)。connection_ping_interval で指定された間隔で接続をプローブします (指定がある場合)。指定がないと、ping_timeout の値が使用されます。
  • A - All (すべて)。すべての接続プローブを使用することを指定する CPI のショートカットです。

ping_timeout、connect_timeout、prepost_timeout、connection_ping_interval

上記の接続プローブ設定のタイムアウト値。値はミリ秒単位で指定され、ping_timeout のデフォルト値は 10000 です。

lbfactor

各バックエンドサーバーインスタンスの負荷分散係数を指定します。より強力なサーバーにより多くのワークロードを割り当てる場合に便利です。ワーカーにデフォルトの 3 倍の負荷を割り当てるには、worker.my_worker.lbfactor=3 のように 3 を設定します。

以下の例は、ポート 8009 でリッスンする 2 つのワーカーノード (node1 および node2) の間でスティッキーセッションを用いて負荷を分散します。

workers.properties ファイルの例

# Define list of workers that will be used for mapping requests
worker.list=loadbalancer,status

# Define Node1
# modify the host as your host IP or DNS name.
worker.node1.port=8009
worker.node1.host=node1.mydomain.com
worker.node1.type=ajp13
worker.node1.ping_mode=A
worker.node1.lbfactor=1

# Define Node2
# modify the host as your host IP or DNS name.
worker.node2.port=8009
worker.node2.host= node2.mydomain.com
worker.node2.type=ajp13
worker.node2.ping_mode=A
worker.node2.lbfactor=1

# Load-balancing behavior
worker.loadbalancer.type=lb
worker.loadbalancer.balance_workers=node1,node2
worker.loadbalancer.sticky_session=1

# Status worker for managing load balancer
worker.status.type=status

Apache mod_jk の設定の詳細は、本書の範囲外です。Apache のドキュメントを参照してください。

A.28. security manager サブシステム

security-manager サブサブシステム自体には設定可能な属性はありませんが、deployment-permissions=default という設定可能な属性を持つ子リソースが 1 つあります。

表A.94 デフォルトの設定オプション

属性デフォルト説明

maximum-permissions

 

デプロイメントまたは jar に付与できる最大パーミッションセット。

minimum-permissions

 

デプロイメントまたは jar に付与できる最小パーミッションセット。





Revised on 2017-02-16 23:39:36 EST