Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

付録A リファレンス資料

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

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

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

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

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

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

--admin-only

Standalone

サーバーの実行タイプを ADMIN_ONLY に設定します。これにより管理インターフェースが開かれ、管理リクエストが許可されますが、他のランタイムサービスは起動されず、エンドユーザーのリクエストは許可されません。この代わりに --start-mode=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 です。

--start-mode=<mode>

Standalone

サーバーの起動モードを設定します。このオプションは、 --admin-only と併用できません。有効な値は以下のとおりです。

  • normal: サーバーは通常どおりに起動します。
  • admin-only: サーバーは管理インターフェースのみを開き、管理リクエストを許可しますが、他のランタイムサービスは起動せず、エンドユーザーのリクエストを許可しません。
  • suspend: サーバーは中断モードで起動され、再開するまでリクエストに対処しません。

-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 では異なります。

重要

Red Hat Enterprise Linux 7 では、RPM サービス設定ファイルは systemd を使用してロードされるため、変数式は拡張されません。

表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 がデフォルトとして使用されます。

WILDFLY_OPTS

起動時に含む追加の引数。例を以下に示します。

-Dorg.wildfly.openssl.path=PATH_TO_OPENSSL_LIBS

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

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

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

JBoss EAP サブシステム説明

batch-jberet

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

bean-validation

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

core-management

サーバーライフサイクルイベント のリスナーを登録し、設定の変更を追跡します。

datasources

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

deployment-scanner

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

ee

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

ejb3

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

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

elytron

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

elytron サブシステムの詳細は JBoss EAP の『セキュリティーアーキテクチャー』を参照してください。

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-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>

ユーザーの名前。ユーザー名には、以下の文字のみを使用できます。文字の数と順番は自由です。

  • 英数字 (a-z、A-Z、0-9)
  • ダッシュ (-)、ピリオド (.)、コンマ (,)、アットマーク(@)
  • バックスラッシュ (\)
  • 等号 (=)

-r、--realm <value>

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

-s、--silent

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

-e、--enable

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

-d、--disable

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

-cw、--confirm-warning

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

-h、--help

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

-ds、 --display-secret

非対話モードで秘密の値を出力します。

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

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-config_5_0.xsd のスキーマ定義ファイルで確認してください。

表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 file ハンドラーの属性

属性説明

disabled-due-to-failure

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

failure-count

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

formatter

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

max-failure-count

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

path

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

relative-to

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

rotate-at-startup

サーバーの起動時に古いログファイルをローテーションするかどうか。

表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. インターフェース属性

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-config_5_0.xsd のスキーマ定義ファイルで確認してください。

表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

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

name

インターフェースの名前。

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. ソケットバインディングの属性

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-config_5_0.xsd のスキーマ定義ファイルで確認してください。

以下の表は、3 種類のソケットバインディングそれぞれに設定できる属性を表しています。

表A.12 インバウンドソケットバインディング (socket-binding) の属性

属性説明

client-mappings

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

fixed-port

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

interface

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

multicast-address

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

multicast-port

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

name

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

port

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

表A.13 リモートアウトバウンドソケットバインディング (remote-destination-outbound-socket-binding) の属性

属性説明

fixed-source-port

数値のオフセットポートがソケットグループの別のアウトバウンドソケットに適用される場合、ポートの値を固定すべきかどうか。

host

このアウトバウンドソケットが接続するリモート宛先のホスト名または IP アドレス。

port

アウトバウンドソケットが接続すべきリモート宛先のポート番号。

source-interface

アウトバウンドソケットのソースアドレスに使用されるインターフェースの名前。

source-port

アウトバウンドソケットのソースポートとして使用されるポート番号。

表A.14 ローカルアウトバウンドソケットバインディング (local-destination-outbound-socket-binding) の属性

属性説明

fixed-source-port

数値のオフセットポートがソケットグループの別のアウトバウンドソケットに適用される場合、ポートの値を固定すべきかどうか。

socket-binding-ref

このアウトバウンドソケットが接続するポートを決定するために使用されるローカルソケットバインディングの名前。

source-interface

アウトバウンドソケットのソースアドレスに使用されるインターフェースの名前。

source-port

アウトバウンドソケットのソースポートとして使用されるポート番号。

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

以下の表は、各ソケットバインディンググループのデフォルトのソケットバインディングを示しています。

表A.15 standard-sockets

ソケットバインディングポート説明

ajp

8009

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

http

8080

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

https

8443

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

management-http

9990

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

management-https

9993

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

txn-recovery-environment

4712

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

txn-status-manager

4713

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

表A.16 ha-sockets

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

ajp

8009

 

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

http

8080

 

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

https

8443

 

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

jgroups-mping

 

45700

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

jgroups-tcp

7600

 

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

jgroups-udp

55200

45688

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

management-http

9990

 

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

management-https

9993

 

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

modcluster

 

23364

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

txn-recovery-environment

4712

 

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

txn-status-manager

4713

 

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

表A.17 full-sockets

ソケットバインディングポート説明

ajp

8009

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

http

8080

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

https

8443

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

iiop

3528

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

iiop-ssl

3529

SSL 暗号化 CORBA サービス。

management-http

9990

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

management-https

9993

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

txn-recovery-environment

4712

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

txn-status-manager

4713

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

表A.18 full-ha-sockets

名前ポートマルチキャストポート説明

ajp

8009

 

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

http

8080

 

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

https

8443

 

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

iiop

3528

 

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

iiop-ssl

3529

 

SSL 暗号化 CORBA サービス。

jgroups-mping

 

45700

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

jgroups-tcp

7600

 

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

jgroups-udp

55200

45688

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

management-http

9990

 

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

management-https

9993

 

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

modcluster

 

23364

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

txn-recovery-environment

4712

 

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

txn-status-manager

4713

 

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

表A.19 load-balancer-sockets

名前ポートマルチキャストポート説明

http

8080

 

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

https

8443

 

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

management-http

9990

 

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

management-https

9993

 

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

mcmp-management

8090

 

ライフサイクルイベントを送信する MCMP (Mod-Cluster Management Protocol) 接続のポート。

modcluster

 

23364

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

A.10. モジュールコマンド引数

以下の引数は、module add 管理 CLI コマンドに渡すことができます。

表A.20 モジュールコマンド引数

引数説明

--absolute-resources

この引数を使用して、module.xml ファイルから参照するファイルシステムの絶対パスのリストを指定します。指定されるファイルはモジュールディレクトリーにはコピーされません。

区切り文字の詳細は --resource-delimiter を参照してください。

--allow-nonexistent-resources

この引数を使用して、--resources によって指定された存在しないリソースの空のディレクトリーを作成します。存在しないリソースがある場合、この引数を使用しないと module add コマンドの実行に失敗します。

--dependencies

この引数を使用して、このモジュールが依存するモジュール名のカンマ区切りリストを提供します。

--export-dependencies

この引数を使用して、エクスポートされた依存関係を指定します。

module add --name=com.mysql --resources=/path/to/mysql-connector-java-5.1.36-bin.jar --export-dependencies=javax.api,javax.transaction.api

--main-class

この引数を使用して、モジュールのメインメソッドを宣言する完全修飾クラス名を指定します。

--module-root-dir

デフォルトの EAP_HOME/modules/ ディレクトリーの代わりに、外部の JBoss EAP モジュールディレクトリーを定義した場合は、この引数を使用します。

module add --module-root-dir=/path/to/my-external-modules/ --name=com.mysql --resources=/path/to/mysql-connector-java-5.1.36-bin.jar --dependencies=javax.api,javax.transaction.api

--module-xml

この引数を使用して、この新規モジュールに使用する module.xml へのファイルシステムパスを提供します。この引数を指定しないと、モジュールディレクトリーに module.xml ファイルが生成されます。

--name

この引数を使用して、追加するモジュールの名前を提供します。この引数は必須です。

--properties

この引数を使用して、モジュールプロパティーを定義する PROPERTY_NAME=PROPERTY_VALUE ペアのカンマ区切りリストを提供します。

--resource-delimiter

この引数を使用して、--resources または absolute-resources 引数に提供されたリソースリストの、ユーザー定義のファイルパス区切り文字を設定します。設定されていない場合、ファイルパスの区切り文字は Linux ではコロン (:) 、Windows ではセミコロン (;) になります。

--resources

この引数を使用して、ファイルシステムパスのリストを提供してこのモジュールのリソースを指定します。ファイルは直接このモジュールディレクトリーにコピーされ、その module.xml ファイルから参照されます。ディレクトリーへのパスを提供した場合、ディレクトリーとその内容はモジュールディレクトリーにコピーされます。シンボリックリンクは保持されず、リンクされたリソースはモジュールディレクトリーにコピーされます。--absolute-resources または --module-xml が提供されている場合を除き、この引数は必須です。

区切り文字の詳細は --resource-delimiter を参照してください。

--slot

この引数を使用して、デフォルトの main スロット以外のスロットにモジュールを追加します。

module add --name=com.mysql --slot=5.1 --resources=/path/to/mysql-connector-java-5.1.36-bin.jar --dependencies=javax.api,javax.transaction.api

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

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

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

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

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

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

.deployed

システムによる生成

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

.dodeploy

ユーザーによる生成

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

.failed

システムによる生成

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

.isdeploying

システムによる生成

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

.isundeploying

システムによる生成

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

.pending

システムによる生成

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

.skipdeploy

ユーザーによる生成

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

.undeployed

システムによる生成

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

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

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

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss-as-deployment-scanner_2_0.xsd のスキーマ定義ファイルで確認してください。

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

名前デフォルト説明

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.13. Managed Domain JVM Configuration Attributes

The following JVM configuration options can be set for a managed domain at the host, server group, or server level. Note that valid values for some of these attributes are dependent upon your JVM. See your JDK vendor’s documentation for additional information.

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-config_5_0.xsd のスキーマ定義ファイルで確認してください。

表A.23 JVM Configuration Attributes

属性説明

agent-lib

Sets the value of the -agentlib java option, which specifies the Java agent library.

agent-path

Sets the value of the -agentpath java option, which specifies the Java agent path.

debug-enabled

Whether to enable debug. This attribute only applies to JVM configurations at the server level.

debug-options

Specifies the JVM options to use when debug is enabled. This attribute only applies to JVM configurations at the server level.

env-classpath-ignored

Whether to ignore the CLASSPATH environment variable.

environment-variables

Specifies key/value pair environment variables.

heap-size

Sets the value of the -Xms option, which specifies the initial heap size allocated by the JVM.

java-agent

Sets the value of the -javaagent java option, which specifies the Java agent.

java-home

Sets the value of the JAVA_HOME variable.

jvm-options

Specifies any additional JVM options needed.

launch-command

Specifies an operating system level command to prefix before the java command used to launch the server process. For example, you could use the sudo command to run the Java process as another user.

max-heap-size

Sets the value of the -Xmx option, which specifies the maximum heap size allocated by the JVM.

max-permgen-size

Sets the maximum size of the permanent generation. Deprecated: The JVM no longer provides a separate permanent generation space.

permgen-size

Sets the initial permanent generation size. Deprecated: The JVM no longer provides a separate permanent generation space.

stack-size

Sets the value of the -Xss option, which specifies the JVM stack size.

type

Specifies which vendor provided the JVM in use. Available options are ORACLE, IBM, SUN, or OTHER.

A.14. Mail サブシステムの属性

以下の表は、メールセッション と以下のメールサーバータイプ用の mail サブシステムの属性を表しています。

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-mail_3_0.xsd のスキーマ定義ファイルで確認してください。

表A.24 メールセッションの属性

属性説明

debug

JavaMail のデバッグを有効にするかどうか。

from

送信時に送信元が設定されていない場合のデフォルトの送信元 (from) アドレス。

jndi-name

メールセッションのバインド先の JNDI 名。

表A.25 IMAP メールサーバーの属性

属性説明

credential-reference

サーバー上で認証される、クレデンシャルストアからのクレデンシャル。

outbound-socket-binding-ref

メールサーバーのアウトバウンドソケットバインディングへの参照。

password

サーバー上で認証するパスワード。

ssl

サーバーが SSL を必要とするかどうか。

tls

サーバーに TLS が必要であるかどうか。

username

サーバー上で認証するユーザー名。

表A.26 POP3 メールサーバーの属性

属性説明

credential-reference

サーバー上で認証される、クレデンシャルストアからのクレデンシャル。

outbound-socket-binding-ref

メールサーバーのアウトバウンドソケットバインディングへの参照。

password

サーバー上で認証するパスワード。

ssl

サーバーが SSL を必要とするかどうか。

tls

サーバーに TLS が必要であるかどうか。

username

サーバー上で認証するユーザー名。

表A.27 SMTP メールサーバーの属性

属性説明

credential-reference

サーバー上で認証される、クレデンシャルストアからのクレデンシャル。

outbound-socket-binding-ref

メールサーバーのアウトバウンドソケットバインディングへの参照。

password

サーバー上で認証するパスワード。

ssl

サーバーが SSL を必要とするかどうか。

tls

サーバーに TLS が必要であるかどうか。

username

サーバー上で認証するユーザー名。

表A.28 カスタムメールサーバーの属性

属性説明

credential-reference

サーバー上で認証される、クレデンシャルストアからのクレデンシャル。

outbound-socket-binding-ref

メールサーバーのアウトバウンドソケットバインディングへの参照。

password

サーバー上で認証するパスワード。

properties

このサーバーの JavaMail プロパティー。

ssl

サーバーが SSL を必要とするかどうか。

tls

サーバーに TLS が必要であるかどうか。

username

サーバー上で認証するユーザー名。

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

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss-as-logging_3_0.xsd のスキーマ定義ファイルで確認してください。

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

属性説明

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため非推奨になりました。

filter-spec

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

handlers

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

level

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

注記

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

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

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss_as_logging_3_0.xsd のスキーマ定義ファイルで確認してください。

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

属性説明

category

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

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため非推奨になりました。

filter-spec

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

handlers

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

level

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

use-parent-handlers

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

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

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss_as_logging_3_0.xsd のスキーマ定義ファイルで確認してください。

表A.31 Console ログハンドラーの属性

属性説明

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.32 File ログハンドラーの属性

属性説明

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.33 Periodic ログハンドラーの属性

属性説明

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.34 Size ログハンドラーの属性

属性説明

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.35 Periodic Size ログハンドラーの属性

属性説明

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.36 syslog ハンドラーの属性

属性説明

app-name

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

enabled

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

facility

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

hostname

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

level

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

port

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

server-address

syslog サーバーのアドレス。

syslog-format

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

表A.37 Custom ログハンドラーの属性

属性説明

class

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

enabled

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

encoding

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

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため非推奨になりました。

filter-spec

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

formatter

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

level

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

module

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

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。

named-formatter

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

properties

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

表A.38 Async ログハンドラーの属性

属性説明

enabled

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

filter

簡単なフィルタータイプを定義します。filter-spec が導入されたため非推奨になりました。

filter-spec

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

level

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

name

ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。

overflow-action

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

queue-length

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

subhandlers

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

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

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

データソース接続 URL

IBM DB2

jdbc:db2://SERVER_NAME:PORT/DATABASE_NAME

MariaDB

jdbc:mariadb://SERVER_NAME:PORT/DATABASE_NAME

MariaDB Galera クラスター

jdbc:mariadb://SERVER_NAME:PORT,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.19. データソースの属性

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss_as_logging_3_0.xsd のスキーマ定義ファイルで確認してください。

表A.40 データソースの属性

属性データソースタイプ説明

allocation-retry

非 XA、XA

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

allocation-retry-wait-millis

非 XA、XA

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

allow-multiple-users

非 XA、XA

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

authentication-context

非 XA、XA

プールの接続を区別するために使用される javax.security.auth.Subject を定義する Elytron 認証コンテキスト。

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 を拡張するクラス名を指定します。このクラスは、接続がアプリケーションまたはプールに返される前にアクションを実行するために接続のアクティベーションおよびパッシベーションをリッスンします。「JDBC ドライバーをコアモジュールとしてインストール」のとおりに、2 つのリソース jar を使用して 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。

credential-reference

非 XA、XA

データソース上で認証される、クレデンシャルストアからのクレデンシャル。

datasource-class

非 XA のみ

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

driver-class

非 XA のみ

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

driver-name

非 XA、XA

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

elytron-enabled

非 XA、XA

接続の認証の処理に Elytron セキュリティーを有効にします。指定されたコンテキストがない場合、使用される Elytron の authentication-context が現在のコンテキストになります。詳細は authentication-context を参照してください。

enabled

非 XA、XA

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

enlistment-trace

非 XA、XA

エンリストメントトレースを記録するかどうか。これはデフォルトで false に設定されています。

exception-sorter-class-name

非 XA、XA

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

exception-sorter-properties

非 XA、XA

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

flush-strategy

非 XA、XA

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

FailingConnectionOnly
問題のある接続のみが削除されます。これはデフォルト設定です。
InvalidIdleConnections
同じクレデンシャルを共有し、ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
IdleConnections
同じクレデンシャルを共有する問題のある接続とアイドル状態の接続が削除されます。
Gracefully
同じクレデンシャルを共有する問題のある接続とアイドル状態の接続が削除されます。同じクレデンシャルを共有するアクティブな接続は、プールに戻された時点で破棄されます。
EntirePool
同じクレデンシャルを共有する問題のある接続、アイドル状態の接続、およびアクティブな接続が削除されます。この設定は、本番環境のシステムには推奨されません。
AllInvalidIdleConnections
ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
AllIdleConnections
問題のある接続と、アイドル状態の接続すべてが削除されます。
AllGracefully
問題のある接続と、アイドル状態の接続すべてが削除されます。アクティブな接続は、プールに戻された時点で破棄されます。
AllConnections
問題のある接続、アイドル状態の接続すべて、およびアクティブな接続すべてが削除されます。この設定は本番環境のシステムには推奨されません。

idle-timeout-minutes

非 XA、XA

接続が閉じられるまでアイドル状態でいられる最大時間 (分単位) を指定します。指定がない場合、デフォルトは 30 分になります。実際の最大時間は、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-authentication-context

XA のみ

プールの接続を区別するために使用される javax.security.auth.Subject を定義する Elytron 認証コンテキスト。

recovery-credential-reference

XA のみ

データソース上で認証される、クレデンシャルストアからのクレデンシャル。

recovery-elytron-enabled

XA のみ

リカバリーに対する接続の認証の処理に Elytron セキュリティーを有効にします。指定された authentication-context がない場合、使用される Elytron の authentication-context が現在のコンテキストになります。詳細は authentication-context を参照してください。

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

アプリケーションに提供されたラッパーがアプリケーションコードによって閉じられたときに、JBoss EAP が基盤の物理ステートメントを閉じたり終了せずに、キャッシュするかどうか。デフォルトは false です。

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.20. データソースの統計

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

名前説明

ActiveCount

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

AvailableCount

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

AverageBlockingTime

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

AverageCreationTime

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

AverageGetTime

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

AveragePoolTime

接続がプールで費やす時間の平均。

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.42 JDBC の統計

名前説明

PreparedStatementCacheAccessCount

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

PreparedStatementCacheAddCount

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

PreparedStatementCacheCurrentSize

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

PreparedStatementCacheDeleteCount

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

PreparedStatementCacheHitCount

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

PreparedStatementCacheMissCount

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

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

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-txn_4_0.xsd のスキーマ定義ファイルで確認してください。

表A.43 Transactions サブシステムの属性

属性説明

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

統計を有効にするべきか。デフォルトは false です。

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.44 ログストアの属性

属性説明

expose-all-logs

すべてのログを公開するかどうか。デフォルトは false で、トランザクションログのサブセットのみが公開されます。

type

ロギングストアの実装タイプを指定します。デフォルトは default です。

表A.45 CMR (Commit Markable Resurce) の属性

属性説明

batch-size

この CMR リソースのバッチサイズ。デフォルトは 100 です。

immediate-cleanup

このCMR リソースの即時クリーンアップを実行するかどうか。デフォルトは true です。

jndi-name

この CMR リソースの JNDI 名。

name

XID を格納するテーブルの名前。デフォルトは xids です。

A.22. IIOP サブシステムの属性

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-iiop-openjdk_3_0.xsd のスキーマ定義ファイルで確認してください。

表A.46 IIOP サブシステムの属性

属性説明

add-component-via-interceptor

SSL コンポーネントが IOR インターセプターによって追加されるべきかどうかを示します。非推奨

auth-method

認証方法。有効な値は none および username_password です。

authentication-context

セキュリティーイニシャライザーが elytron に設定されたときに使用する認証コンテキストの名前。

caller-propagation

呼び出し元の ID を SAS コンテキストで伝播する必要があるかどうかを示します。有効な値は none および supported です。

client-requires

クライアント SSL がパラメーターを必要とすることを示す値。有効な値は NoneServerAuthClientAuth、および MutualAuth です。非推奨のため、代わりに client-requires-ssl を使用してください

client-requires-ssl

サーバーからの IIOP 接続に SSL が必要であるかどうかを示します。

client-ssl-context

クライアント側の SSL ソケットの作成に使用される SSL コンテキストの名前。

client-supports

クライアント SSL がサポートされるパラメーターを示す値。有効な値は NoneServerAuthClientAuth、および MutualAuth です。非推奨のため、代わりに client-requires-ssl を使用してください

confidentiality

トランスポートに機密性の保護が必要であるかどうかを示します。有効な値は nonesupported、および required です。非推奨のため、代わりに server-requires-ssl を使用してください

detect-misordering

トランスポートに間違った順序の検出が必要であるかどうかを示します。有効な値は nonesupported、および required です。非推奨のため、代わりに server-requires-ssl を使用してください

detect-replay

トランスポートにリプレイの検出が必要であるかどうかを示します。有効な値は nonesupported、および required です。非推奨のため、代わりに server-requires-ssl を使用してください

export-corbaloc

ルートコンテキストを corbaloc::address:port/NameService としてエクスポートすべきかどうかを示します。

giop-version

使用される GIOP バージョン。

high-water-mark

TCP 接続キャッシュパラメーター。接続数がこの値を超えるたびに、ORB は接続を再利用しようとします。再利用される接続の数は、number-to-reclaim プロパティーによって指定されます。このプロパティーが設定されていない場合は、デフォルトの OpenJDK ORB が使用されます。

integrity

トランスポートに整合性の保護が必要であるかどうかを示します。有効な値は nonesupported、および required です。非推奨のため、代わりに server-requires-ssl を使用してください

number-to-reclaim

TCP 接続キャッシュパラメーター。接続数が high-water-mark プロパティーを超えるたびに、ORB は接続を再利用しようとします。再利用される接続の数は、このプロパティーによって指定されます。このプロパティーが設定されていない場合は、デフォルトの OpenJDK ORB が使用されます。

persistent-server-id

サーバーの永続 ID。永続オブジェクト参照はサーバーの多くのアクティベーションで有効であり、このプロパティーを使用してこの ID を識別します。結果として、同じサーバーの多くのアクティベーションではこのプロパティーを同じ値に設定し、同じホストで実行されている異なる複数のサーバーインスタンスに異なるサーバー ID を割り当てる必要があります。

properties

汎用キー/値のプロパティ一覧。

realm

認証サービスのレルム名。

required

認証が必要であるかどうかを示します。

root-context

ネーミングサービスのルートコンテキスト

security

セキュリティーインターセプターをインストールするかどうかを示します。有効な値は clientidentityelytron、および none です。

security-domain

SSL 接続の確立に使用されるキーストアとトラストストアを保持するセキュリティードメインの名前。

server-requires

サーバーSSL がパラメーターを必要とすることを示す値。有効な値は NoneServerAuthClientAuth、および MutualAuth です。非推奨のため、代わりに server-requires-ssl を使用してください

server-requires-ssl

サーバーへの IIOP 接続に SSL が必要であるかどうかを示します。

server-ssl-context

サーバー側の SSL ソケットの作成に使用される SSL コンテキストの名前。

server-supports

サーバーSSL がサポートされるパラメーターを示す値。有効な値は NoneServerAuthClientAuth、および MutualAuth です。非推奨のため、代わりに server-requires-ssl を使用してください

socket-binding

ORB ポートを指定するソケットバインディング設定名

ssl-socket-binding

ORB SSL を指定するソケットバインディング設定名

support-ssl

SSL がサポートされるかどうかを示します。

transactions

トランザクションインターセプターがインストールされるかどうかを示します。有効な値は fullspec、および none です。値が full の場合は JTS が有効になり、spec の場合は受信トランザクションコンテキストを拒否する JTS でない仕様に準拠するモードを有効にします。

trust-in-client

トランスポートの確立にクライアントの信頼が必要であるかどうかを示します。有効な値は nonesupported、および required です。非推奨のため、代わりに server-requires-ssl を使用してください

trust-in-target

トランスポートの確立にターゲットの信頼が必要であるかどうかを示します。有効な値は none および supported です。非推奨のため、代わりに server-requires-ssl を使用してください

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

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

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-resource-adapters_5_0.xsd のスキーマ定義ファイルで確認してください。

表A.47 主な属性

属性説明

archive

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

beanvalidationgroups

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

bootstrap-context

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

config-properties

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

module

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

statistics-enabled

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

transaction-support

リソースアダプターのトランザクションサポートレベル。有効な値は NoTransactionLocalTransaction、または XATransaction です。

wm-elytron-security-domain

使用される必要がある Elytron セキュリティードメインの名前を定義します

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

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

注記

リソースアダプターが bootstrap-context とともに、elytron-enabledtrue に設定されているワークマネージャーを使用している場合、セキュリティードメインの仕様に wm-security-domain 属性ではなく wm-elytron-security-domain 属性を使用する必要があります。

表A.48 admin-objects Attributes

属性説明

class-name

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

enabled

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

jndi-name

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

use-java-context

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

表A.49 connection-definitions Attributes

属性説明

allocation-retry

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

allocation-retry-wait-millis

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

authentication-context

プールの接続を区別するために使用される javax.security.auth.Subject を定義する Elytron 認証コンテキスト。

authentication-context-and-application

プール内の接続を区別するために、getConnection(user, pw)Subject などからのアプリケーションによって提供されたパラメーターを使用するかどうかを示します。これらのパラメーターは、設定済みの authentication-context を使用するときに Elytron によって認証後に提供されます。

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 トランザクションに参加できます。

elytron-enabled

接続の認証の処理に Elytron セキュリティーを有効にします。指定されたコンテキストがない場合、使用される Elytron の authentication-context が現在のコンテキストになります。詳細は authentication-context を参照してください。

enabled

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

enlistment

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

enlistment-trace

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

flush-strategy

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

FailingConnectionOnly
問題のある接続のみが削除されます。これはデフォルト設定です。
InvalidIdleConnections
同じクレデンシャルを共有し、ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
IdleConnections
同じクレデンシャルを共有する問題のある接続とアイドル状態の接続が削除されます。
Gracefully
同じクレデンシャルを共有する問題のある接続とアイドル状態の接続が削除されます。同じクレデンシャルを共有するアクティブな接続は、プールに戻された時点で破棄されます。
EntirePool
同じクレデンシャルを共有する問題のある接続、アイドル状態の接続、およびアクティブな接続が削除されます。この設定は、本番環境のシステムには推奨されません。
AllInvalidIdleConnections
ValidatingManagedConnectionFactory.getInvalidConnections(…​) メソッドによって無効として返される、問題のある接続とアイドル状態の接続が削除されます。
AllIdleConnections
問題のある接続と、アイドル状態の接続すべてが削除されます。
AllGracefully
問題のある接続と、アイドル状態の接続すべてが削除されます。アクティブな接続は、プールに戻された時点で破棄されます。
AllConnections
問題のある接続、アイドル状態の接続すべて、およびアクティブな接続すべてが削除されます。この設定は本番環境のシステムには推奨されません。

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-authentication-context

リカバリーに使用される Elytron 認証コンテキスト。authentication-context の指定がない場合、現在の認証コンテキストが使用されます。

recovery-credential-reference

接続のリカバリーで認証される、クレデンシャルストアからのクレデンシャル。

recovery-elytron-enabled

Elytron 認証コンテキストがリカバリーに使用されることを示します。デフォルトは false です。

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 です。

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

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

名前説明

ActiveCount

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

AvailableCount

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

AverageBlockingTime

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

AverageCreationTime

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

CreatedCount

作成された接続の数。

DestroyedCount

破棄された接続の数。

InUseCount

現在使用中の接続の数。

MaxCreationTime

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

MaxUsedCount

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

MaxWaitCount

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

MaxWaitTime

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

TimedOut

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

TotalBlockingTime

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

TotalCreationTime

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

WaitCount

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

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

undertow サブシステムのさまざまな要素の属性は以下の表を参照してください。

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-undertow_4_0.xsd のスキーマ定義ファイルで確認してください。

表A.51 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

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

アプリケーションセキュリティードメインの属性

アプリケーションセキュリティードメインの属性の構造は以下のとおりです。

application-security-domain 属性

表A.52 application-security-domain 属性

属性デフォルト説明

enable-jacc

false

JACC を使用して承認を有効にします。

http-authentication-factory

 

マップされたセキュリティードメインを参照するデプロイメントで使用される HTTP 認証ファクトリー。

override-deployment-config

false

デプロイメントの認証設定がファクトリーによってオーバーライドされるべきであるかどうか。

referencing-deployments

 

現在このマッピングを参照しているデプロイメント。

single-sign-on 属性

表A.53 single-sign-on 属性

属性デフォルト説明

client-ssl-context

 

バックチャネルログアウト接続のセキュア化に使用される SSL コンテキストへの参照。

cookie-name

JSESSIONIDSSO

クッキーの名前。

credential-reference

 

プライベートキーエントリーを復号化するためのクレデンシャル参照。

domain

 

使用されるクッキードメイン。

http-only

false

クッキーの httpOnly 属性を設定します。

key-alias

 

バックチャネルログアウト接続の署名および検証に使用されるプライベートキーエントリーのエイリアス。

key-store

 

プライベートキーエントリーが含まれるキーストアへの参照。

path

/

クッキーのパス。

secure

false

クッキーの secure 属性を設定します。

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

表A.54 buffer-cache 属性

属性デフォルト説明

buffer-size

1024

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

buffers-per-region

1024

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

max-regions

10

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

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

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

servlet-container 属性

表A.55 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

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

disable-file-watch-service

false

true に設定した場合、展開形式のデプロイメントの変更を監視するためにファイルウォッチサービスは使用されません。この属性は、io.undertow.disable-file-system-watcher システムプロパティーをオーバーライドします。

disable-session-id-reuse

false

true に設定した場合、未知のセッション ID は再使用されず、新しいセッション ID が生成されます。false に設定した場合、同じサーバー上のアプリケーション間で同じ ID を共有できるようにするため別のデプロイメントのセッションマネージャーに存在する場合のみセッション ID が再使用されます。

eager-filter-initialization

false

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

ignore-flush

false

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

max-sessions

 

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

proactive-authentication

true

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

session-id-length

30

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

stack-trace-on-error

local-only

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

use-listener-encoding

false

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

mime-mapping 属性

表A.56 mime-mapping 属性

属性デフォルト説明

value

 

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

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.57 crawler-session-management 属性

属性デフォルト説明

session-timeout

 

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

user-agents

 

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

jsp 属性
注記

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

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

表A.58 jsp 属性

属性デフォルト説明

check-interval

0

バックグラウンドスレッドを使用して JSP 更新の間隔をチェックします。ファイルシステム通知 API を使用して 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.59 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.60 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.61 websockets 属性

属性デフォルト説明

buffer-pool

default

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

deflater-level

0

DEFLATE アルゴリズムの圧縮レベルを設定します。

dispatch-to-worker

true

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

per-message-deflate

false

websocket のメッセージごとの圧縮拡張機能を有効にします。

worker

default

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

welcome-file 属性

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

フィルターの属性

これらのコンポーネントは /subsystem=undertow/configuration=filter にあります。

custom-filter フィルター

表A.62 custom-filter 属性

属性デフォルト説明

class-name

 

HttpHandler のクラス名。

module

 

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

parameters

 

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

error-page フィルター

エラーページ。

表A.63 error-page 属性

属性デフォルト説明

code

 

エラーページコード。

path

 

エラーページパス。

expression-filter フィルター

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

表A.64 expression-filter 属性

属性デフォルト説明

expression

 

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

module

 

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

gzip フィルター

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

mod-cluster フィルター

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

表A.65 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

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

failover-strategy

LOAD_BALANCED

セッションアフィニティーが実行されるノードが利用できない場合にフェイルオーバーノードの選択方法を判断する属性。

health-check-interval

10000

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

http2-enable-push

true

HTTP/2 接続に対してプッシュを有効にするべきかどうか。

http2-header-table-size

4096

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

http2-initial-window-size

65535

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

http2-max-concurrent-streams

 

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

http2-max-frame-size

16384

HTTP/2 の最大フレームサイズ (バイト単位)。

http2-max-header-list-size

 

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

management-access-predicate

 

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

management-socket-binding

 

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

max-ajp-packet-size

8192

AJP パケットの最大サイズ (バイト単位)。この値を大きくすると、AJP はヘッダーの量が多いリクエストおよび応答に対応できます。ロードバランサーとバックエンドサーバーで同じにする必要があります。

max-request-time

-1

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

max-retries

1

リクエストの失敗時に、リクエストの再試行を実行する回数。

注記

リクエストがべき等とみなされない場合、バックエントサーバーに送信されなかったことをプロキシーが確信できる場合のみ再試行が行われます。

request-queue-size

10

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

security-key

 

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

security-realm

 

SSL 設定を提供するセキュリティーレルム。非推奨: ssl-context 属性を使用して設定済みの SSLContext を直接参照してください。

ssl-context

 

フィルターによって使用される SSLContext への参照。

use-alias

false

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

worker

default

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

表A.66 balancer 属性

属性デフォルト説明

max-attempts

 

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

sticky-session

 

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

sticky-session-cookie

 

セッションクッキー名。

sticky-session-force

 

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

sticky-session-path

 

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

sticky-session-remove

 

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

wait-worker

 

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

load-balancing-group 属性

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

表A.67 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.68 context 属性

属性デフォルト説明

requests

 

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

status

 

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

request-limit フィルター

表A.69 request-limit 属性

属性デフォルト説明

max-concurrent-requests

 

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

queue-size

 

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

response-header フィルター

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

表A.70 response-header 属性

属性デフォルト説明

header-name

 

ヘッダー名。

header-value

 

ヘッダーの値

rewrite フィルター

表A.71 rewrite 属性

属性デフォルト説明

redirect

false

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

target

 

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

ハンドラーの属性

これらのコンポーネントは /subsystem=undertow/configuration=handler にあります。

file 属性

表A.72 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.73 reverse-proxy 属性

属性デフォルト説明

cached-connections-per-thread

5

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

connection-idle-timeout

60

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

connections-per-thread

40

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

max-request-time

-1

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

max-retries

1

リクエストの失敗時に、リクエストの再試行を実行する回数。

注記

リクエストがべき等とみなされない場合、バックエントサーバーに送信されなかったことをプロキシーが確信できる場合のみ再試行が行われます。

problem-server-retry

30

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

request-queue-size

10

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

session-cookie-names

JSESSIONID

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

表A.74 host 属性

属性デフォルト説明

enable-http2

false

true の場合、プロキシーは HTTP/2 を使用してバックエンドへの接続を試行します。サポートされていない場合は、HTTP/1.1 にフォールバックします。

instance-id

 

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

outbound-socket-binding

 

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

path

/

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

scheme

http

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

security-realm

 

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

ssl-context

 

このハンドラーによって使用される SSLContext への参照。

サーバーの属性

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

server 属性

表A.75 server 属性

属性デフォルト説明

default-host

default-host

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

servlet-container

default

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

ajp-listener 属性

表A.76 ajp-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

always-set-keep-alive

true

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

buffer-pipelined-data

false

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

buffer-pool

default

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

decode-url

true

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

disallowed-methods

["TRACE"]

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

enabled

true

リスナーが有効であるかどうか。非推奨: 属性を有効にすると、設定の一貫性の保持に問題が生じます。

max-ajp-packet-size

8192

AJP パケットがサポートされる最大サイズ。変更する場合は、ロードバランサーとバックエンドサーバーで増やす必要があります。

max-buffered-request-size

16384

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

max-connections

 

同時接続の最大数。サーバー設定で値が設定されないと、同時接続の数は Integer.MAX_VALUE に制限されます。

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

60000

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

read-timeout

 

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

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

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

redirect-socket

 

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

request-parse-timeout

 

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

resolve-peer-address

false

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

scheme

 

リスナースキーム (HTTP または HTTPS)。デフォルトでは、スキーマは受信 AJP リクエストから取得されます。

secure

false

true の場合、リクエストが HTTPS を使用しなくてもこのリスナーから送信されるリクエストはセキュアであるとマーク付けされます。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

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

tcp-backlog

 

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

tcp-keep-alive

 

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

url-charset

UTF-8

URL の文字セット。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

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

host 属性

表A.77 host 属性

属性デフォルト説明

alias

 

ホストのエイリアスのカンマ区切りリスト。

default-response-code

404

設定した場合、サーバー上に要求されたコンテキストが存在しない場合に設定した応答コードが返信されます。

default-web-module

ROOT.war

デフォルトの Web モジュール。

disable-console-redirect

false

true に設定すると、/console リダイレクトはこのホストに対して有効になりません。

filter-ref 属性

表A.78 filter-ref 属性

属性デフォルト説明

predicate

 

predicate は交換を基に true または false の決定を行う簡単な方法です。多くのハンドラーには条件によって適用される要件があり、predicate は条件を指定する一般的な方法を提供します。

priority

1

フィルターの順序を定義します。1 以上を設定する必要があります。同じコンテキスト下で数字が大きいほどサーバーのハンドラーチェインでの順序が早くなるよう指示します。

location 属性

表A.79 location 属性

属性デフォルト説明

handler

 

この場所のデフォルトのハンドラー。

filter-ref 属性

表A.80 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.81 access-log 属性

属性デフォルト説明

directory

${jboss.server.log.dir}

ログを保存するディレクトリー。

extended

false

ログが拡張されたログファイル形式を使用するかどうか。

pattern

common

アクセスログパターン。

注記

リクエストの処理にかかった時間を出力するよう pattern を設定した場合、該当するリスナーの record-request-start-time 属性も有効にする必要があります。そうしないと、アクセスログに時間が適切に記録されません。例を以下に示します。

/subsystem=undertow/server=default-server/http-listener=default:write-attribute(name=record-request-start-time,value=true)

predicate

 

リクエストをログに記録するかどうかを判断する述語。

prefix

access_log

ログファイル名の接頭辞。

relative-to

 

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

rotate

true

アクセスログを毎日ローテーションするかどうか。

suffix

log

ログファイル名の接尾辞。

use-server-log

false

ログが個別のファイルではなくサーバーログに書き込まれるかどうか。

worker

default

ロギングに使用するワーカーの名前。

http-invoker Attributes

表A.82 http-invoker Attributes

属性デフォルト説明

http-authentication-factory

 

認証に使用する HTTP 認証ファクトリー。

path

wildfly-services

サービスがインストールされるパス。

security-realm

 

認証に使用するレガシーのセキュリティーレルム。

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.83 single-sign-on 属性

属性デフォルト説明

cookie-name

JSESSIONIDSSO

クッキーの名前。

domain

 

使用されるクッキードメイン。

http-only

false

クッキーの httpOnly 属性を設定します。

path

/

クッキーのパス。

secure

false

クッキーの secure 属性を設定します。

http-listener 属性

表A.84 http-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

always-set-keep-alive

true

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

buffer-pipelined-data

false

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

buffer-pool

default

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

certificate-forwarding

false

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

decode-url

true

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

disallowed-methods

["TRACE"]

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

enable-http2

false

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

enabled

true

リスナーが有効であるかどうか。非推奨: 属性を有効にすると、設定の一貫性の保持に問題が生じます。

http2-enable-push

true

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

http2-header-table-size

4096

HPACK 圧縮で使用されるヘッダーテーブルのサイズ (バイト単位)。このメモリー量が圧縮のために接続ごとに割り当てられます。より大きな値はより多くのメモリーを使用しますが、圧縮が向上されます。

http2-initial-window-size

65535

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

http2-max-concurrent-streams

 

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

http2-max-frame-size

16384

HTTP/2 の最大フレームサイズ (バイト単位)。

http2-max-header-list-size

 

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

max-buffered-request-size

16384

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

max-connections

 

同時接続の最大数。サーバー設定で値が設定されないと、同時接続の数は Integer.MAX_VALUE に制限されます。

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

60000

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

proxy-address-forwarding

false

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

read-timeout

 

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

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

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

redirect-socket

 

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

request-parse-timeout

 

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

require-host-http11

false

すべての HTTP/1.1 リクエストに Host ヘッダーが必要になります。リクエストにこのヘッダーが含まれないと、403 エラーにより拒否されます。

resolve-peer-address

false

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

secure

false

true の場合、リクエストが HTTPS を使用しなくてもこのリスナーから送信されるリクエストはセキュアであるとマーク付けされます。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

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

tcp-backlog

 

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

tcp-keep-alive

 

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

url-charset

UTF-8

URL の文字セット。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

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

https-listener 属性

表A.85 https-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

always-set-keep-alive

true

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

buffer-pipelined-data

false

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

buffer-pool

default

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

certificate-forwarding

false

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

decode-url

true

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

disallowed-methods

["TRACE"]

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

enable-http2

false

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

enable-spdy

false

このリスナーの SPDY サポートを有効にします。非推奨: SPDY は HTTP/2 に置き換えられました。

enabled

true

リスナーが有効であるかどうか。非推奨: 属性を有効にすると、設定の一貫性の保持に問題が生じます。

enabled-cipher-suites

 

有効な SSL 暗号を設定します。非推奨: SSLContext が参照される場合は、暗号スイートで設定してサポートされるようにする必要があります。

enabled-protocols

 

SSL プロトコルを設定します。非推奨: SSLContext が参照される場合は、暗号スイートで設定してサポートされるようにする必要があります。

http2-enable-push

true

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

http2-header-table-size

4096

HPACK 圧縮で使用されるヘッダーテーブルのサイズ (バイト単位)。このメモリー量が圧縮のために接続ごとに割り当てられます。より大きな値はより多くのメモリーを使用しますが、圧縮が向上されます。

http2-initial-window-size

65535

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

http2-max-concurrent-streams

 

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

http2-max-frame-size

16384

HTTP/2 の最大フレームサイズ (バイト単位)。

http2-max-header-list-size

 

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

max-buffered-request-size

16384

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

max-connections

 

同時接続の最大数。サーバー設定で値が設定されないと、同時接続の数は Integer.MAX_VALUE に制限されます。

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

60000

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

proxy-address-forwarding

false

x-forwarded-host ヘッダー (およびその他の x-forwarded-* ヘッダー) の処理を有効にし、このヘッダー情報を使用してリモートアドレスを設定します。これらのヘッダーを設定する信頼されたプロキシーの背後でのみ使用する必要があります。そうでないと、リモートユーザーによる IP アドレスの偽装が可能になります。

read-timeout

 

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

receive-buffer

 

受信バッファーサイズ。

record-request-start-time

false

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

request-parse-timeout

 

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

require-host-http11

false

すべての HTTP/1.1 リクエストに Host ヘッダーが必要になります。リクエストにこのヘッダーが含まれないと、403 エラーにより拒否されます。

resolve-peer-address

false

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

secure

false

true の場合、HTTPS を使用しなくてもこのリスナーから送信されるリクエストはセキュアであるとマーク付けされます。

security-realm

 

リスナーのセキュリティーレルム。非推奨: ssl-context 属性を使用して設定済みの SSLContext を直接参照してください。

send-buffer

 

送信バッファーサイズ。

socket-binding

 

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

ssl-context

 

このリスナーによって使用される SSLContext への参照。

ssl-session-cache-size

 

アクティブな SSL セッションの最大数。非推奨: Elytron セキュリティーコンテキスト上で設定できるようになりました。

ssl-session-timeout

 

SSL セッションのタイムアウト (秒単位)。非推奨: Elytron セキュリティーコンテキスト上で設定できるようになりました。

tcp-backlog

 

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

tcp-keep-alive

 

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

url-charset

UTF-8

URL の文字セット。

verify-client

NOT_REQUESTED

SSL チャネルの希望の SSL クライアント認証モード。非推奨: SSLContext が参照される場合は、クライアント検証の必要なモードに対して直接設定する必要があります。

worker

default

リスナーの XNIO ワーカー。

write-timeout

 

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

A.26. Undertow サブシステムの統計

表A.86 ajp-listener の統計

名前説明

bytes-received

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

bytes-sent

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

error-count

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

max-processing-time

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

processing-time

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

request-count

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

表A.87 http-listener の統計

名前説明

bytes-received

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

bytes-sent

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

error-count

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

max-processing-time

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

processing-time

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

request-count

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

表A.88 https-listener の統計

名前説明

bytes-received

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

bytes-sent

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

error-count

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

max-processing-time

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

processing-time

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

request-count

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

A.27. HTTP メソッドのデフォルトの動作

JBoss EAP 7.1 の undertow サブシステムは、これまでの JBoss EAP リリースの web サブシステムとは HTTP メソッドのデフォルト動作が異なります。以下の表は、JBoss EAP 7.1 のデフォルト動作を表しています。

表A.89 HTTP メソッドのデフォルト動作

HTTP メソッドJSP静的 HTMLファイルハンドラーによる静的 HTML

GET

OK

OK

OK

POST

OK

NOT_ALLOWED

OK

HEAD

OK

OK

OK

PUT

NOT_ALLOWED

NOT_ALLOWED

NOT_ALLOWED

TRACE

NOT_ALLOWED

NOT_ALLOWED

NOT_ALLOWED

DELETE

NOT_ALLOWED

NOT_ALLOWED

NOT_ALLOWED

OPTIONS

NOT_ALLOWED

OK

NOT_ALLOWED

注記

サーブレットでは、実装によってデフォルトの動作が異なりますが、デフォルトの動作が NOT_ALLOWED である TRACE メソッドは例外です。

A.28. Remoting サブシステムの属性

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-undertow_4_0.xsd のスキーマ定義ファイルで確認してください。

表A.90 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.91 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

remote

SaslServer または SaslClient が作成された場合、デフォルトで指定されるプロトコルは remote になります。この属性を使用すると、このプロトコルをオーバーライドできます。

send-buffer-size

8192

接続上でこのエンドポイントが送信する最大バッファーサイズ。

server-name

 

最初の案内応答で接続のサーバー側はその名前をクライアントに渡します。デフォルトでは、名前は接続のローカルアドレスから自動的に検索されますが、これを使用して名前を上書きできます。

transmit-window-size

131072

接続チャネルの受信方向の最大ウインドウサイズ (バイト単位)。

worker

default

使用するワーカー

注記

endpoint 要素の更新に管理 CLI を使用する場合、remoting 要素の configuration 下で利用できます (例: /subsystem=remoting/configuration=endpoint/)。

コネクターの属性

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

表A.92 connector 属性

属性デフォルト説明

authentication-provider

 

authentication-provider 要素には、受信接続に使用する認証プロバイダーの名前が含まれます。

sasl-authentication-factory

 

このコネクターをセキュアにする SASL 認証ファクトリーへの参照。

sasl-protocol

remote

認証に使用する SASL メカニズムに渡すプロトコル。

security-realm

 

このコネクターの認証に使用する、関連するセキュリティーレルム。

server-name

 

最初のメッセージ交換で送信され、SASL ベースの認証用のサーバー名。

socket-binding

 

アタッチするソケットバインディングの名前。

ssl-context

 

このコネクターに使用する SSL コンテキストへの参照。

表A.93 property 属性

属性デフォルト説明

value

 

プロパティーの値。

セキュリティーの属性

security コンポーネントはコネクターのセキュリティーを設定できるようにしますが、直接の設定属性は含まれていません。これは、sasl などのネストされたコンポーネントを使用して設定できます。

表A.94 sasl 属性

属性デフォルト説明

include-mechanisms

 

オプションのネストされた include-mechanisms 要素には、許可される SASL メカニズム名のホワイトリストが含まれます。このリストにないメカニズムは許可されません。

qop

 

オプションのネストされた qop 要素には、QOP (保護品質) の値が希望順に並ぶカンマ区切りリストが含まれます。

このリストの QOP の値は次のとおりです。

  • auth: 認証のみ
  • auth-int: 認証と整合性保護
  • auth-conf: 認証、整合性保護および機密性保護

reuse-session

false

オプションのネストされた reuse-session ブール値要素は、以前認証したセッション情報をサーバーが再使用するかどうかを指定します。メカニズムによってはこのような再使用をサポートしない可能性があり、その他の要因によって再使用できないこともあります。

server-auth

false

オプションのネストされた server-auth ブール値要素は、サーバーがクライアントに対して認証されるかどうかを指定します。メカニズムによってはこの設定をサポートしない可能性があります。

strength

 

オプションのネストされた strength 要素には希望順に並ぶ暗号強度の値のカンマ区切りリストが含まれます。

このリストの暗号強度の値は次のとおりです。

  • high
  • medium
  • low

sasl-policy 属性

sasl-policy コンポーネントでは、利用できるメカニズムのセットを限定するために使用する任意のポリシーを指定できますが、直接の設定属性は含まれていません。policy などのネストされたコンポーネントを使用して設定できます。

表A.95 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) を受けやすいメカニズムを拒否するかどうかを指定するブール値が含まれます。拒否する場合は true、許可する場合は false を設定します。

pass-credentials

true

オプションネストされた pass-credentials 要素には、クライアントのクレデンシャルを渡すメカニズムが必要であるかどうかを指定するブール値が含まれます。

HTTP コネクターの属性

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

表A.96 http-connector 属性

属性デフォルト説明

authentication-provider

 

authentication-provider 要素には、受信接続に使用する認証プロバイダーの名前が含まれます。

connector-ref

 

接続する undertow サブシステムのコネクターの名前。

sasl-authentication-factory

 

このコネクターをセキュアにする SASL 認証ファクトリーへの参照。

sasl-protocol

remote

認証に使用する SASL メカニズムに渡すプロトコル。

security-realm

 

このコネクターの認証に使用する、関連するセキュリティーレルム。

server-name

 

最初のメッセージ交換で送信され、SASL ベースの認証用のサーバー名。

アウトバウンド接続の属性

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

表A.97 outbound-connection 属性

属性デフォルト説明

uri

 

アウトバウンド接続の接続 URI。

表A.98 property 属性

属性デフォルト説明

value

 

プロパティーの値。

注記

上記の property 属性は、接続の作成中に使用される XNIO 操作に関連します。

リモートアウトバウンド接続

remote-outbound-connection コンポーネントの構造は次のとおりです。

表A.99 remote-outbound-connection 属性

属性デフォルト説明

authentication-context

 

アウトバウンド接続の設定が含まれる認証コンテキストインスタンスへの参照。

outbound-socket-binding-ref

 

接続の宛先アドレスとポートの判断に使用される outbound-socket-binding の名前。

protocol

http-remoting

リモート接続に使用するプロトコル。デフォルトは http-remoting です。非推奨: アウトバウンドセキュリティー設定は authentication-context 定義に移行する必要があります。

security-realm

 

パスワードと SSL 設定の取得に使用するセキュリティーレルムへの参照。非推奨: アウトバウンドセキュリティー設定は authentication-context 定義に移行する必要があります。

username

 

リモートサーバーに対して認証する際に使用するユーザー名。非推奨: アウトバウンドセキュリティー設定は authentication-context 定義に移行する必要があります。

ローカルアウトバウンド接続の属性

local-outbound-connection コンポーネントの構造は次のとおりです。

表A.100 local-outbound-connection 属性

属性デフォルト説明

outbound-socket-binding-ref

 

接続の宛先アドレスとポートの判断に使用される outbound-socket-binding の名前。

A.29. IO サブシステムの属性

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-io_2_0.xsd のスキーマ定義ファイルで確認してください。

表A.101 worker 属性

属性デフォルト説明

io-threads

 

ワーカーに作成する I/O スレッドの数。指定のない場合は、スレッドの数が CPU の数の 2 倍に設定されます。

stack-size

0

ワーカースレッドへの使用を試みるスタックサイズ (バイト単位)。

task-keepalive

60000

コア以外のタスクスレッドをアクティブな状態に維持する期間(ミリ秒単位) 。現在、この属性は無視されるため使用しないでください。

task-max-threads

 

ワーカータスクスレッドプールの最大スレッド数。指定のない場合は、MaxFileDescriptorCount JMX プロパティーを考慮して (設定されている場合)、最大スレッド数が CPU の数の 16 倍に設定されます。

表A.102 buffer-pool 属性

属性デフォルト説明

buffer-size

 

各バッファースライスのサイズ (バイト単位)。指定のない場合は、以下のようにシステムで利用できる RAM を基にサイズが設定されます。

  • RAM が 64 MB 未満の場合は 512 バイト
  • RAM が 64 - 128 MB の場合は 1024 バイト (1 KB)
  • RAM が 128 MB を超える場合は 16384 バイト (16 KB)

この属性のパフォーマウス調整に関する情報は、JBoss EAP『Performance Tuning Guide』の「Configuring Buffer Pools」を参照してください。

buffers-per-slice

 

大型のバッファーをいくつのスライス (セクション) に分割するか。これは、多数の個別のバッファーに割り当てするよりもメモリーの効率がよくなります。指定のない場合、システムで利用可能な RAM を基にしてスライスの数が設定されます。

  • RAM が 128 MB 未満の場合は 10
  • RAM が 128 MB を超える場合は 20

direct-buffers

 

バッファープールが直接バッファーを使用するかどうか。多くの場合で NIO を使用するとより高速になります。直接バッファーをサポートしないプラットフォームがあることに注意してください。

A.30. JSF モジュールテンプレート

以下は、JBoss EAP に異なる JSF バージョンをインストールするときに必要な JSF モジュールに使用するテンプレートの例になります。手順の詳細は、「JSF 実装のインストール」を参照してください。

例: Mojarra JSF 実装 JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
<module xmlns="urn:jboss:module:1.5" name="com.sun.jsf-impl" slot="JSF_IMPL_NAME-JSF_VERSION">
    <properties>
        <property name="jboss.api" value="private"/>
    </properties>

    <dependencies>
        <module name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION"/>
        <module name="javaee.api"/>
        <module name="javax.servlet.jstl.api"/>
        <module name="org.apache.xerces" services="import"/>
        <module name="org.apache.xalan" services="import"/>
        <module name="javax.xml.rpc.api"/>
        <module name="javax.rmi.api"/>
        <module name="org.omg.api"/>
    </dependencies>

    <resources>
        <resource-root path="jsf-impl-JSF_VERSION.jar"/>
    </resources>
</module>

例: MyFaces JSF 実装 JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
<module xmlns="urn:jboss:module:1.5" name="com.sun.jsf-impl" slot="JSF_IMPL_NAME-JSF_VERSION">
    <properties>
        <property name="jboss.api" value="private"/>
    </properties>

    <dependencies>
        <module name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION">
            <imports>
                <include path="META-INF/**"/>
            </imports>
        </module>
        <module name="javaee.api"/>
        <module name="javax.servlet.jstl.api"/>
        <module name="org.apache.xerces" services="import"/>
        <module name="org.apache.xalan" services="import"/>

        <!-- extra dependencies for MyFaces -->
        <module name="org.apache.commons.collections"/>
        <module name="org.apache.commons.codec"/>
        <module name="org.apache.commons.beanutils"/>
        <module name="org.apache.commons.digester"/>

        <!-- extra dependencies for MyFaces 1.1
        <module name="org.apache.commons.logging"/>
        <module name="org.apache.commons.el"/>
        <module name="org.apache.commons.lang"/> -->
        <module name="javax.xml.rpc.api"/>
        <module name="javax.rmi.api"/>
        <module name="org.omg.api"/>
    </dependencies>

    <resources>
        <resource-root path="JSF_IMPL_NAME-impl-JSF_VERSION.jar"/>
    </resources>
</module>

例: Mojarra JSF API JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
<module xmlns="urn:jboss:module:1.5" name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION">
    <dependencies>
        <module name="com.sun.jsf-impl" slot="JSF_IMPL_NAME-JSF_VERSION"/>
        <module name="javax.enterprise.api" export="true"/>
        <module name="javax.servlet.api" export="true"/>
        <module name="javax.servlet.jsp.api" export="true"/>
        <module name="javax.servlet.jstl.api" export="true"/>
        <module name="javax.validation.api" export="true"/>
        <module name="org.glassfish.javax.el" export="true"/>
        <module name="javax.api"/>
    </dependencies>

    <resources>
        <resource-root path="jsf-api-JSF_VERSION.jar"/>
    </resources>
</module>

例: MyFaces JSF API JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
<module xmlns="urn:jboss:module:1.5" name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION">
    <dependencies>
        <module name="javax.enterprise.api" export="true"/>
        <module name="javax.servlet.api" export="true"/>
        <module name="javax.servlet.jsp.api" export="true"/>
        <module name="javax.servlet.jstl.api" export="true"/>
        <module name="javax.validation.api" export="true"/>
        <module name="org.glassfish.javax.el" export="true"/>
        <module name="javax.api"/>

        <!-- extra dependencies for MyFaces 1.1
        <module name="org.apache.commons.logging"/>
        <module name="org.apache.commons.el"/>
        <module name="org.apache.commons.lang"/> -->
    </dependencies>

    <resources>
        <resource-root path="myfaces-api-JSF_VERSION.jar"/>
    </resources>
</module>

例: Mojarra JSF インジェクション JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
  • INJECTION_VERSION
  • WELD_VERSION
<module xmlns="urn:jboss:module:1.5" name="org.jboss.as.jsf-injection" slot="JSF_IMPL_NAME-JSF_VERSION">
    <properties>
        <property name="jboss.api" value="private"/>
    </properties>

    <resources>
        <resource-root path="wildfly-jsf-injection-INJECTION_VERSION.jar"/>
        <resource-root path="weld-core-jsf-WELD_VERSION.jar"/>
    </resources>

    <dependencies>
        <module name="com.sun.jsf-impl" slot="JSF_IMPL_NAME-JSF_VERSION"/>
        <module name="javax.api"/>
        <module name="org.jboss.as.web-common"/>
        <module name="javax.servlet.api"/>
        <module name="org.jboss.as.ee"/>
        <module name="org.jboss.as.jsf"/>
        <module name="javax.enterprise.api"/>
        <module name="org.jboss.logging"/>
        <module name="org.jboss.weld.core"/>

        <module name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION"/>
    </dependencies>
</module>

例: MyFaces JSF インジェクション JAR の module.xml

注記

テンプレートの置き換え可能な変数に適切な値を使用するようにしてください。

  • JSF_IMPL_NAME
  • JSF_VERSION
  • INJECTION_VERSION
  • WELD_VERSION
<module xmlns="urn:jboss:module:1.5" name="org.jboss.as.jsf-injection" slot="JSF_IMPL_NAME-JSF_VERSION">
    <properties>
        <property name="jboss.api" value="private"/>
    </properties>

    <resources>
        <resource-root path="wildfly-jsf-injection-INJECTION_VERSION.jar"/>
        <resource-root path="weld-core-jsf-WELD_VERSION.jar"/>
    </resources>

    <dependencies>
        <module name="com.sun.jsf-impl" slot="JSF_IMPL_NAME-JSF_VERSION"/>
        <module name="javax.api"/>
        <module name="org.jboss.as.web-common"/>
        <module name="javax.servlet.api"/>
        <module name="org.jboss.as.ee"/>
        <module name="org.jboss.as.jsf"/>
        <module name="javax.enterprise.api"/>
        <module name="org.jboss.logging"/>
        <module name="org.jboss.weld.core"/>
        <module name="org.wildfly.security.elytron"/>

        <module name="javax.faces.api" slot="JSF_IMPL_NAME-JSF_VERSION"/>
    </dependencies>
</module>

例: MyFaces commons-digester JAR の module.xml

注記

テンプレートの置き換え可能な VERSION 変数に適切な値を使用するようにしてください。

<module xmlns="urn:jboss:module:1.5" name="org.apache.commons.digester">
    <properties>
        <property name="jboss.api" value="private"/>
    </properties>

    <resources>
        <resource-root path="commons-digester-VERSION.jar"/>
    </resources>

    <dependencies>
        <module name="javax.api"/>
        <module name="org.apache.commons.collections"/>
        <module name="org.apache.commons.logging"/>
        <module name="org.apache.commons.beanutils"/>
    </dependencies>
</module>

A.31. JGroups サブシステムの属性

jgroups サブシステムのさまざまな要素の属性は以下の表を参照してください。

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss-as-jgroups_5_0.xsd のスキーマ定義ファイルで確認してください。

表A.103 jgroups の主な属性

属性デフォルト説明

default-channel

ee

デフォルトの JGroups チャネル。

default-stack

 

デフォルトの JGroups プロトコルスタック。

チャネルの属性

channel 要素の構造は次のとおりです。

channel 属性

表A.104 channel 属性

属性デフォルト説明

cluster

 

JGroups チャネルのクラスター名。定義されていない場合はチャネルの名前が使用されます。

module

org.wildfly.clustering.server

チャネルサービスをロードするモジュール。

stack

 

JGroups チャネルのプロトコルスタック。

statistics-enabled

false

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

stats-enabled

false

統計が有効であるかどうか。非推奨: 代わりに statistics-enabled 属性を使用してください。

スタックの属性

stack 要素の構造は次のとおりです。

stack 属性

表A.105 stack 属性

属性デフォルト説明

statistics-enabled

false

スタックのすべてのプロトコルが統計を収集するかどうかを示します。

protocol 属性

一般的に使用されるプロトコルのリストは、「JGroups プロトコル 」の項を参照してください。

表A.106 protocol 属性

属性デフォルト説明

module

org.jgroups

プロトコルタイプを解決するモジュール。

properties

 

このプロトコルのプロパティー。

statistics-enabled

false

スタック設定をオーバーライドして、このプロトコルが統計を収集するかどうかを示します。

relay 属性

表A.107 relay 属性

属性デフォルト説明

module

org.jgroups

プロトコルタイプを解決するモジュール。

properties

 

このプロトコルのプロパティー。

site

 

ローカルサイトの名前。

statistics-enabled

false

スタック設定をオーバーライドして、このプロトコルが統計を収集するかどうかを示します。

remote-site 属性

表A.108 remote-site 属性

属性デフォルト説明

channel

 

このリモートサイトと通信するために使用されるブリッジチャネルの名前。

cluster

 

このリモートサイトへのブリッジチャネルのクラスター名。非推奨: 代わりに明示的に定義された channel を使用してください。

stack

 

このリモートサイトへのブリッジを作成するスタック。非推奨: 代わりに明示的に定義された channel を使用してください。

transport 属性

表A.109 transport 属性

属性デフォルト説明

default-executor

 

受信メッセージを処理するスレッドプールエグゼキューター。非推奨: 代わりに事前定義された default スレッドプールを設定してください。

diagnostics-socket-binding

 

このプロトコル層の診断ソケットバインディング仕様。通信用の IP インターフェースとポートを指定するために使用されます。

machine

 

このノードのマシン (ホスト) 識別子。Infinispan のトポロジー認識のコンシステントハッシュ法によって使用されます。

module

org.jgroups

プロトコルタイプを解決するモジュール。

oob-executor

 

受信 OOB (out of band) メッセージを処理するスレッドプールエグゼキューター。非推奨: 代わりに事前定義された oob スレッドプールを設定してください。

properties

 

このトランスポートのプロパティー。

rack

 

サーバーラックなど、このノードのラック識別子。Infinispan のトポロジー認識のコンシステントハッシュ法によって使用されます。

shared

false

true の場合、このスタックを使用するすべてのチャネルによって基盤のトランスポートが共有されます。非推奨: 代わりにチャネルの fork を設定してください。

site

 

データセンターなど、このノードのサイト識別子。Infinispan のトポロジー認識のコンシステントハッシュ法によって使用されます。

socket-binding

 

このプロトコル層のソケットバインディング仕様。通信用の IP インターフェースおよびポートを指定するために使用されます。

statistics-enabled

false

スタック設定をオーバーライドして、このプロトコルが統計を収集するかどうかを示します。

thread-factory

 

非同期のトランスポート固有のタスクを処理するために使用するスレッドファクトリー。非推奨: 代わりに事前定義された internal スレッドプールを設定してください。

timer-executor

 

プロトコル関連のタイミングタスクを処理するスレッドプールエグゼキューター。非推奨: 代わりに事前定義された timer スレッドプールを設定してください。

thread-pool 属性

表A.110 thread-pool 属性

属性デフォルト説明

keepalive-time

5000L

アイドル時にプールスレッドの実行を継続すべき時間 (ミリ秒単位) 。指定されていない場合は、スレッドはエグゼキューターが終了するまで実行します。

max-threads

4

スレッドプールの最大サイズ。

min-threads

2

max-threads よりも小さいコアスレッドプールサイズ。定義されていない場合、コアスレッドプールサイズは max-threads と同じになります。

queue-length

500

キューの長さ。

A.32. JGroups プロトコル

プロトコルプロトコルタイプ説明

ASYM_ENCRYPT

暗号化

クラスターのコーディネーターに保存されるシークレットキーを使用して、クラスターメンバー間のメッセージを暗号化します。

AUTH

認証

認証のレイヤーをクラスターメンバーに提供します。

azure.AZURE_PING

検出

Microsoft Azure の blob ストレージを使用したノード検出をサポートします。

FD_ALL

障害検出

簡単なハートビートプロトコルを基にした障害検出を提供します。

FD_SOCK

障害検出

クラスターメンバー間で作成された TCP ソケットのリングを基にした障害検出を提供します。

JDBC_PING

検出

メンバーがアドレスを書き込む共有データベースを使用してクラスターメンバーを検出します。

MERGE3

マージ

クラスターの分割が発生したときにサブクラスターをマージします。

MFC

フロー制御

送信元とすべてのクラスターメンバーとの間でマルチキャストフロー制御を提供します。

MPING

検出

IP マルチキャストでクラスターメンバーを検出します。

pbcast.GMS

グループメンバーシップ

新規メンバーのクラスター参加、既存メンバーによる離脱リクエスト、およびクラッシュしたメンバーの SUSPECT メッセージを含む、グループメンバーシップを処理します。

pbcast.NAKACK2

メッセージの送信

メッセージの信頼性および順序を確実にし、1 つの送信元から送信されたすべてのメッセージが送信順に受信されることを保証します。

pbcast.STABLE

メッセージの安定性

すべてのメンバーによって送信されたメッセージを削除します。

PING

検出

クラスターメンバーの動的検出のサポートによる、メンバーの最初の検出。

SASL

認証

SASL メカニズムを使用してクラスターメンバーに認証のレイヤーを提供します。

SYM_ENCRYPT

暗号化

共有キーストアを使用して、クラスターメンバー間のメッセージを暗号化します。

S3_PING

検出

Amazon S3 を使用して最初のメンバーを検出します。

TCPGOSSIP

検出

外部のゴシップルーターを使用してクラスターメンバーを検出します。

TCPPING

検出

クラスターを形成するクラスターメンバーのアドレスの静的リストが含まれます。

UFC

フロー制御

送信元とすべてのクラスターメンバーとの間でユニキャストフロー制御を提供します。

UNICAST3

メッセージの送信

ユニキャストメッセージのメッセージの信頼性および順序を確実にし、1 つの送信元から送信されたすべてのメッセージが送信順に受信されることを保証します。

VERIFY_SUSPECT

障害検出

疑わしいメンバーをエビクトする前に最終的に ping してそのメンバーが不能になったことを検証します。

汎用プロトコルの属性

すべてのプロトコルは以下の属性にアクセスできます。

表A.111 protocol 属性

属性デフォルト説明

module

org.jgroups

プロトコルタイプを解決するモジュール。

properties

 

このプロトコルのプロパティー。

statistics-enabled

false

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

認証プロトコル

認証プロトコルは、認証を実行するために使用されます。主な役目は、認証されたメンバーのみがクラスターに参加できるようにすることです。これらのプロトコルは、GMS プロトコルの下に位置するため、クラスター参加のリクエストをリッスンする可能性があります。

AUTH 属性

AUTH プロトコルにはその他の属性は含まれませんが、トークンが子要素として定義されている必要があります。

注記

このプロトコルを定義するとき、protocol 要素の代わりに auth-protocol 要素が使用されます。

トークンタイプ

Elytron をセキュリティーに使用する場合、以下の認証トークンの 1 つを使用することが推奨されます。これらの認証トークンは、Elytron と使用する目的で設計されており、レガシーのセキュリティー設定とは使用できない可能性があります。

表A.112 Elytron トークンタイプ

トークン説明

cipher-token

共有の秘密が変換される認証トークン。変換に使用されるデフォルトのアルゴリズムは RSA です。

digest-token

共有の秘密が変換される認証トークン。変換に使用されるデフォルトのアルゴリズムは SHA-256 です。

plain-token

共有の秘密に追加の変換を行わない認証トークン。

以下の認証トークンは JGroups から継承されます。認証が望ましいすべての設定で使用の対象となります。

表A.113 JGroups トークンタイプ

トークン説明

MD5Token

共有の秘密が MD5 または SHA ハッシュを使用して暗号化される認証トークン。この暗号化に使用されるデフォルトのアルゴリズムは MD5 です。

SimpleToken

共有の秘密に追加の変換を行わない認証トークン。このトークンは大文字と小文字を区別せず、文字列の一致を判断するときに大文字と小文字を考慮しません。

X509Token

共有の秘密が X509 証明書を使用して暗号化される認証トークン。

SASL の属性

表A.114 SASL の属性

属性デフォルト説明

client_callback_handler

 

ノードがクライアントとして動作するときに使用する CallbackHandler のクラス名。

client_name

 

ノードがクライアントとして動作するときに使用する名前。JAAS ログインモジュールを使用する場合、この名前はサブジェクトの取得にも使用されます。

client_password

 

ノードがクライアントとして動作するときに使用するパスワード。JAAS ログインモジュールを使用する場合、このパスワードはサブジェクトの取得にも使用されます。

login_module_name

 

SASL クライアントおよびサーバーを作成するためにサブジェクトとして使用する JAAS ログインモジュールの名前。この属性は、GSSAPI などの一部の mech 値でのみ必要です。

mech

 

SASL 認証メカニズムの名前。この名前にはローカル SASL プロバイダーがサポートするすべてのメカニズムを指定でき、JDK はデフォルトで CRAM-MD5DIGEST-MD5GSSAPI、および NTLM を提供します。

sasl_props

 

定義された mech のプロパティー。

server_callback_handler

 

ノードがサーバーとして動作するときに使用する CallbackHandler のクラス名。

server_name

 

完全修飾サーバー名。

timeout

5000

チャレンジへの応答を待つ時間 (ミリ秒単位)。

検出プロトコル

以下のプロトコルはクラスターの最初のメンバーシップを見つけるために使用され、その後現在のコーディネーターを決定するために使用できます。検出プロトコルのリストは次のとおりです。

AZURE_PING の属性

表A.115 AZURE_PING の属性

属性デフォルト説明

container

 

PING データに使用する blob コンテナーの名前。有効な DNS 名を指定する必要があります。

storage_access_key

 

ストレージアカウントのシークレットアクセスキー。

storage_account_name

 

blob コンテナーが含まれる Microsoft Azure ストレージアカウントの名前。

JDBC_PING の属性

表A.116 JDBC_PING の属性

属性デフォルト説明

data-source

 

接続および JNDI ルックアッププロパティーの代わりに使用されるデータソース参照。

注記

JDBC_PING プロトコルを定義するとき、protocol 要素の代わりに jdbc-protocol 要素が使用されます。

S3_PING の属性

表A.117 S3_PING の属性

属性デフォルト説明

access_key

 

S3 バケットのアクセスに使用される Amazon S3 アクセスキー。

host

s3.amazonaws.com

S3 web サービスの宛先。

location

 

使用する Amazon S3 バケットの名前。バケットが存在する必要があり、一意な名前を使用する必要があります。

pre_signed_delete_url

 

DELETE 操作に使用する事前署名付き URL。

port

  • use_ssltrue の場合は 443。
  • use_sslfalse の場合は 80。

web サービスがリッスンしているポート。

pre_signed_put_url

 

PUT 操作に使用する事前署名付き URL。

prefix

 

設定され、location が設定されている場合、バケット名を PREFIX-LOCATION として定義します。設定され、指定の PREFIX-LOCATION にバケットが存在しない場合は、 PREFIX の後に無作為の UUID が続くバケット名になります。

secret_access_key

 

S3 バケットのアクセスに使用される Amazon S3 のシークレットアクセスキー。

use_ssl

true

ホストとポートの組み合わせと通信するときに SSL が使用されるかどうかを決定します。

TCPGOSSIP の属性

表A.118 TCPGOSSIP の属性

属性デフォルト説明

socket-binding

 

このプロトコル層のソケットバインディング仕様。非推奨: 代わりに socket-bindings を使用してください。

socket-bindings

 

このプロトコルのアウトバウンドソケットバインディング。

注記

TCPGOSSIP プロトコルを定義するとき、protocol 要素の代わりに socket-discovery-protocol 要素が使用されます。

TCPPING の属性

表A.119 TCPPING の属性

属性デフォルト説明

socket-binding

 

このプロトコル層のソケットバインディング仕様。非推奨: 代わりに socket-bindings を使用してください。

socket-bindings

 

このプロトコルのアウトバウンドソケットバインディング。

注記

TCPPING プロトコルを定義するとき、protocol 要素の代わりに socket-discovery-protocol 要素が使用されます。

暗号化プロトコル

以下のプロトコルは通信スタックをセキュアにするために使用されます。暗号化はクラスターのすべてのメンバーが持つ共有のシークレットキーを基にします。このキーは、SYM_ENCRYPT を使用している場合は共有のキーストアから取得され、ASYM_ENCRYPT を使用している場合はパブリック/プライベートキーの交換から取得されます。以下のプロトコルのいずれかを定義すると、結果となる XML に encrypt-protocol 要素が作成されます。

注記

ASYM_ENCRYPT を使用している場合は、同じスタックに AUTH プロトコルが定義されている必要があります。SYM_ENCRYPT を使用している場合、AUTH プロトコルは任意です。

ASYM_ENCRYPT の属性

表A.120 ASYM_ENCRYPT の属性

属性デフォルト説明

key-alias

 

指定されたキーストアから取得される暗号化キーのエイリアス。

key-credential-reference

 

キーストアから暗号化キーを取得するために必要なクレデンシャル。

key-store

 

暗号化キーが含まれるキーストアへの参照。

SYM_ENCRYPT の属性

表A.121 SYM_ENCRYPT の属性

属性デフォルト説明

key-alias

 

指定されたキーストアから取得される暗号化キーのエイリアス。

key-credential-reference

 

キーストアから暗号化キーを取得するために必要なクレデンシャル。

key-store

 

暗号化キーが含まれるキーストアへの参照。

障害検出プロトコル

以下のプロトコルは、クラスターのメンバーを調査して生存の有無を判断するために使用されます。これらのプロトコルには、汎用属性以外の属性はありません。

  • FD_ALL
  • FD_SOCK
  • VERIFY_SUSPECT

フロー制御プロトコル

以下のプロトコルは、メッセージの送信側の速度を最も遅い受信側に合わせて処理するフロー制御を行います。送信側が送信するメッセージの速度が継続して受信側よりも速い場合、受信側はメッセージをキューに置くか破棄するため、再送信が発生します。これらのプロトコルには、汎用属性以外の属性はありません。

  • MFC - マルチキャストフロー制御
  • UFC - ユニキャストフロー制御

グループメンバーシッププロトコル

pbcast.GMS プロトコルは、新規メンバーのクラスターへの参加、既存メンバーによるクラスターからの離脱、およびクラッシュした疑いのあるメンバーに対応します。このプロトコルには、汎用属性以外の属性はありません。

マージプロトコル

クラスターが分割された場合、MERGE3 プロトコルによってサブクラスターが元どおりにマージされます。このプロトコルはクラスターメンバーを元どおりにマージする役割を果たしますが、クラスターの状態はマージしません。マージ状態のコールバックはアプリケーションが対応します。このプロトコルには、汎用属性以外の属性はありません。

メッセージの安定性

pbcast.STABLE プロトコルは、クラスターのすべてのメンバーが受け取ったメッセージをガベッジコレクションで処理します。このプロトコルは、ダイジェストと呼ばれるメンバーのメッセージ番号が含まれる安定したメッセージを送信します。クラスターのすべてのメンバーが他のメンバーのダイジェストを受信した後、メッセージを再送信テーブルから削除することができます。このプロトコルには、汎用属性以外の属性はありません。

信頼できるメッセージの送信

以下のプロトコルは、信頼できるメッセージの配信と、クラスターのすべてのノードに送信されたメッセージの FIFO プロパティーを提供します。信頼できる配信では、すべてのメッセージに番号が付けられ、シーケンス番号が受信されなかった場合に再送信リクエストが送信されるため、送信元が送ったメッセージを損失することはありません。これらのプロトコルには、汎用属性以外の属性はありません。

  • pbcast.NAKACK2
  • pbcast.UNICAST3

非推奨となったプロトコル

以下のプロトコルは非推奨となり、クラス名のみが含まれるプロトコルによって置き換えられました。たとえば、org.jgroups.protocols.ASYM_ENCRYPT を指定する代わりに、プロトコル名は ASYM_ENCRYPT になります。

  • org.jgroups.protocols.ASYM_ENCRYPT
  • org.jgroups.protocols.AUTH
  • org.jgroups.protocols.JDBC_PING
  • org.jgroups.protocols.SYM_ENCRYPT
  • org.jgroups.protocols.TCPGOSSIP
  • org.jgroups.protocols.TCPPING

A.33. Apache HTTP Server の mod_cluster ディレクティブ

mod_cluster コネクターは Apache HTTP Server ベースのロードバランサーです。通信チャネルを使用して、リクエストを Apache HTTP Server からアプリケーションサーバーノードのセットの 1 つに転送します。mod_cluster の設定には以下のディレクティブを指定できます。

注記

mod_cluser は Apache HTTP Server に転送しなければならない URL を自動的に設定するため、ProxyPass ディレクティブを使用する必要はありません。

表A.122 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 ファイルに対応できます。

 
注記

JBoss EAP 7 のセッションのパフォーマンス最適化により、ホットスタンバイノードの設定はサポートされません。

mod_manager

mod_manager ディレクティブのコンテキストは、指定がある場合を除きすべて VirtualHost になります。server config コンテキストは、ディレクティブが VirtualHost 設定の外部になければならないことを示します。そうでない場合、エラーメッセージが表示され、Apache HTTP Server が開始しません。

表A.123 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.34. ModCluster サブシステムの属性

modcluster サブシステムの構造は次のとおりです。

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss-as-mod-cluster_3_0.xsd のスキーマ定義ファイルで確認してください。

表A.124 mod-cluster-config 設定オプション

属性デフォルト説明

advertise

true

アドバタイズが有効になっているかどうか。

advertise-security-key

 

Advertise ロジックのセキュリティーキーが含まれる文字列。

advertise-socket

 

Advertise ソケットに使用するソケットバインディングの名前。

auto-enable-contexts

true

false に設定された場合、コンテキストは無効としてリバースプロキシーと登録されます。 enable-context 操作を使用するか、mod_cluster_manager コンソールを使用するとコンテキストを有効にできます。

balancer

 

登録するリバースプロキシーのバランサーの名前。設定されていない場合、値は ManagerBalancerName ディレクティブで Apache HTTP Server 側に設定され、デフォルトでは mycluster になります。

connector

 

mod_cluster のリバースプロキシーが接続する Undertow リスナーの名前。

excluded-contexts

 

リバースプロキシーでの登録から除外されるコンテキストのリスト。ホストの指定がない場合、localhost がホストと仮定されます。ROOT は web アプリケーションのルートコンテキストを示します。

flush-packets

false

web サーバーへのパケットのフラッシングを有効にするかどうか。

flush-wait

-1

httpd でパケットをフラッシュする前に待機する期間。最大値は 2,147,483,647

load-balancing-group

 

設定された場合、リクエストはロードバランサーの指定のロードバランシンググループに送信されます。

max-attempts

1

リバースプロキシーが指定リクエストのワーカーへの送信を試みる回数。この回数試行した後に送信を断念します。

node-timeout

-1

ワーカーへのプロキシー接続のタイムアウト (秒単位)。mod_cluster はこの期間バックエンド応答を待ち、その経過後にエラーを返します。node-timeout 属性が未定義である場合、httpd ProxyTimeout ディレクティブが使用されます。ProxyTimeout が未定義である場合、httpd Timeout ディレクティブが使用され、デフォルトは 300 秒になります。

ping

10

ping に対する pong 返答を待つ時間 (秒単位)。

proxies

 

socket-binding-groupoutbound-socket-binding によって定義される登録する mod_cluster のプロキシーのリスト。

proxy-list

 

プロキシーのリスト。形式は HOST_NAME:PORT で、カンマで区切られます。非推奨になりました。proxies の使用が推奨されます。

proxy-url

/

MCMP リクエストのベース URL。

session-draining-strategy

DEFAULT

Web アプリケーションのアンデプロイメント中に使用されるセッションドレインストラテジー。有効な値は DEFAULTALWAYS、または NEVER です。

DEFAULT
web アプリケーションが分散可能でない場合のみ、web アプリケーションのアンデプロイ前にセッションをドレインします。
ALWAYS
web アプリケーションが分散可能であっても、web アプリケーションのアンデプロイ前に常にセッションをドレインします。
NEVER
web アプリケーションのアンデプロイ前にセッションをドレインしません。

simple-load-provider

 

動的ロードプロバイダーが存在しない場合に使用する簡単なロードプロバイダー。各クラスターメンバーに負荷係数 1 を割り当て、負荷分散アルゴリズムを適用せずに作業を均等に分散します。

smax

-1

httpd の soft maximum アイドル接続数。

socket-timeout

20

タイムアウトの前およびプロキシーをエラーのように警告する前に、httpd プロキシーから MCMP コマンドへの応答を待つ秒数。

ssl-context

 

mod_cluster によって使用される SSLContext への参照。

status-interval

10

STATUS メッセージがアプリケーションサーバーからリバースプロキシーへ送信される秒数。-1 から 2,147,483,647 までの値が許可されます。

sticky-session

true

あるセッションの後続リクエストを可能な限り同じノードへルーティングするべきかどうか。

sticky-session-force

false

バランサーがリクエストをスタックしたノードへルーティングできない場合に、リバースプロキシーがエラーを返すかどうか。スティッキーセッションが無効な場合は無視されます。

sticky-session-remove

false

フェイルオーバー時にセッション情報を削除します。

stop-context-timeout

10

分散可能なコンテキストの場合は、コンテキストが保留中のリクエストを処理するのを待つ最大時間 (秒単位)。分散可能でないコンテキストの場合は、コンテキストがアクティブなセッションを破棄するのを待つ最大時間 (秒単位)。

ttl

-1

smax を超えるアイドル接続の TTL (Time To Live、秒単位)。-1 から 2,147,483,647 までの値が許可されます。

worker-timeout

-1

httpd で利用可能なワーカーによるリクエスト処理の待機時間のタイムアウト値。-1 から 2,147,483,647 までの値が許可されます。

表A.125 dynamic-load-provider 設定オプション

属性デフォルト説明

decay

2

減退 (Decay)。

history

9

履歴。

表A.126 custom-load-metric 属性オプション

属性デフォルト説明

capacity

1.0

メトリックの容量

class

 

カスタムメトリックのクラス名。

property

 

メトリックのプロパティー。

weight

1

メトリックの重さ。

表A.127 load-metric 属性オプション

属性デフォルト説明

capacity

1.0

メトリックの容量

property

 

メトリックのプロパティー。

type

 

メトリックのタイプ。有効な値は cpumemheapsessionsreceive-trafficsend-trafficrequests、または busyness です。

weight

1

メトリックの重さ。

表A.128 ssl 属性オプション

属性デフォルト説明

ca-certificate-file

 

認証局。

ca-revocation-url

 

認証局の失効リスト。

certificate-key-file

${user.home}/.keystore

証明書のキーファイル。

cipher-suite

 

許可された暗号スイート。

key-alias

 

キーエイリアス。

password

changeit

パスワード。

protocol

TLS

有効な SSL プロトコル。

A.35. mod_jk ワーカープロパティー

workers.properties ファイルは mod_jk がクライアント要求を渡すワーカーの動作を定義します。workers.properties ファイルは、異なるサーブレットコンテナーが存在する場所と、ワークロードをアプリケーションサーバーすべてで分散する方法を定義します。

プロパティーの一般的な構造は worker.WORKER_NAME.DIRECTIVE です。WORKER_NAME は、JBoss EAP undertow サブシステムで設定された instance-id と一致しなければならない一意な名前です。DIRECTIVE はワーカーに適用される設定です。

Apache mod_jk ロードバランサーの設定リファレンス

テンプレートはデフォルトのロードバランサーごとの設定を指定します。ロードバランサーの設定内でテンプレートを上書きできます。

表A.129 グローバルプロパティー

プロパティー説明

worker.list

mod_jk によって使用されるワーカー名のカンマ区切りリスト。

表A.130 必須ディレクティブ

プロパティー説明

type

ワーカーのタイプ。デフォルトのタイプは ajp13 です。他の可能な値は ajp14lbstatus です。これらのディレクティブの詳細は、https://tomcat.apache.org/connectors-doc/reference/workers.html の『Apache Tomcat Connectors Reference』を参照してください。

表A.131 負荷分散ディレクティブ

プロパティー説明

balance_workers

ロードバランサーが管理する必要があるワーカーノードを指定します。同じロードバランサーにディレクティブを複数回使用できます。カンマ区切りのワーカーノード名のリストで構成されます。

sticky_session

同じセッションからのリクエストを常に同じワーカーにルーティングするかどうかを指定します。デフォルトは 1 で、スティッキーセッションが有効になります。スティッキーセッションを無効にするには 0. を設定します。すべてのリクエストが実際にステートレスである場合を除き、スティッキーセッションは通常有効にする必要があります。

表A.132 接続ディレクティブ

プロパティー説明

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 でリッスンする node1 および node2 の 2 つのワーカーノードの間でスティッキーセッションを用いて負荷を分散します。

例: 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.36. security manager サブシステム

security-manager サブサブシステム自体には設定可能な属性はありませんが、deployment-permissions=default という設定可能な属性を持つ子リソースが 1 つあります。

注記

この表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/wildfly-security-manager_1_0.xsd のスキーマ定義ファイルで確認してください。

表A.133 deployment-permissions 設定オプション

属性説明

maximum-permissions

デプロイメントまたは jar に付与できる最大パーミッションセット。

minimum-permissions

デプロイメントまたは jar に付与できる最小パーミッションセット。

A.37. JBoss Core Services からの OpenSSL のインストール

JBoss Core Services OpenSSL のファイルは、ZIP または RPM ディストリビューションからインストールできます。インストールの方法に応じて、以下の手順にしたがってください。

JBoss Core Services OpenSSL ZIP ファイルディストリビューションの使用

注記

ZIP アーカイブの libs/ ディレクトリーへのパスは、Linux の場合は jbcs-openssl-1.0.2h/openssl/lib(64)、Windows の場合は jbcs-openssl-1.0.2h/openssl/bin になります。

  1. お使いのオペレーティングシステムとアーキテクチャーに該当する OpenSSL パッケージを Software Downloads ページからダウンロードします。
  2. ダウンロードした ZIP ファイルをインストールディレクトリーで展開します。
  3. OpenSSL ライブラリーのある場所を JBoss EAP に通知します。

    これを行うには、以下の方法の 1 つを使用します。以下のコマンドでは、必ず JBCS_OPENSSL_PATH を JBoss Core Services OpenSSL ライブラリーへのパスに置き換えてください (例: /opt/rh/jbcs-httpd24/root/usr/lib64)。

    • 以下の引数を使用すると、OpenSSL パスを standalone.conf または domain.conf 設定ファイルの JAVA_OPTS 変数に追加できます。

      JAVA_OPTS="$JAVA_OPTS -Dorg.wildfly.openssl.path=JBCS_OPENSSL_PATH
    • 以下の管理 CLI コマンドを使用すると、OpenSSL パスを指定するシステムプロパティーを定義できます。

      /system-property=org.wildfly.openssl.path:add(value=JBCS_OPENSSL_PATH)
      重要

      使用する方法に関係なく、サーバーを再起動して JAVA_OPTS の値またはシステムプロパティーを有効にする必要があります。サーバーをリロードするだけでは有効にできません。

JBoss Core Services OpenSSL RPM ディストリビューションの使用

  1. システムが JBoss Core Services チャンネルに登録されていることを確認してください。

    1. オペレーティングシステムバージョンとアーキテクチャーの JBoss Core Services の CDN リポジトリー名を決定します。

      • RHEL 6: jb-coreservices-1-for-rhel-6-server-rpms
      • RHEL 7: jb-coreservices-1-for-rhel-7-server-rpms
    2. システムでリポジトリーを有効にします。

      # subscription-manager repos --enable REPO_NAME
    3. 以下のメッセージが表示されたことを確認してください。

      リポジトリー REPO_NAME はこのシステムに対して有効になりました。
  2. このチャンネルから OpenSSL をインストールします。

    # yum install jbcs-httpd24-openssl
  3. インストールの完了後、/opt/rh/jbcs-httpd24/root/usr/lib64 の JBCS OpenSSL ライブラリーを利用できます。x86 アーキテクチャーでは /opt/rh/jbcs-httpd24/root/usr/lib になります。
  4. OpenSSL ライブラリーのある場所を JBoss EAP に通知します。

    これを行うには、以下の方法の 1 つを使用します。以下のコマンドでは、必ず JBCS_OPENSSL_PATH を JBoss Core Services OpenSSL ライブラリーへのパスに置き換えてください (例: /opt/rh/jbcs-httpd24/root/usr/lib64)。

    • サービス設定ファイルの eap7-standalone または eap7-domain 設定の WILDFLY_OPTS 変数を更新できます。

      WILDFLY_OPTS="$WILDFLY_OPTS -Dorg.wildfly.openssl.path=JBCS_OPENSSL_PATH"
    • 以下の管理 CLI コマンドを使用すると、OpenSSL パスを指定するシステムプロパティーを定義できます。

      /system-property=org.wildfly.openssl.path:add(value=JBCS_OPENSSL_PATH)
      重要

      使用する方法に関係なく、サーバーを再起動して WILDFLY_OPTS の値またはシステムプロパティーを有効にする必要があります。サーバーをリロードするだけでは有効にできません。





Revised on 2018-08-29 12:44:36 EDT