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

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

注記

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

表A.59 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.60 application-security-domain 属性

属性デフォルト説明

enable-jacc

false

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

enable-jaspi

true

関連付けられたデプロイメントに JASPI 認証を有効にします。

http-authentication-factory

 

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

integrated-jaspi

true

統合 JASPI を使用するべきかどうか。JASPI 認証時に true に設定すると、アイデンティティーはデプロイメントによって参照される SecurityDomain からロードされます。false に設定されると、アドホックアイデンティティーが代わりに作成されます。

override-deployment-config

false

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

referencing-deployments

 

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

security-domain

 

デプロイメントによって使用される SecurityDomain

single-sign-on 属性

表A.61 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.62 buffer-cache 属性

属性デフォルト説明

buffer-size

1024

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

buffers-per-region

1024

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

max-regions

10

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

バイトバッファープールの属性

表A.63 byte-buffer-pool 属性

属性デフォルト説明

buffer-size

 

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

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

この属性のパフォーマンス調整は、JBoss EAP の『パフォーマンスチューニングガイド』の「バッファープールの設定」を参照してください。

direct

 

このバッファーがダイレクトまたはヒーププールであることを示すブール値。指定のない場合は、システムで使用できる RAM を基にして値が設定されます。

  • 使用できる RAM が < 64MB の場合、値は false に設定されます。
  • 使用できる RAM が >= 64MB の場合、値は true に設定されます。

ダイレクトプールには対応するヒーププールがあることにも注意してください。

leak-detection-percent

0

漏えい検出に割り当てられるバッファーの割合 (パーセント)。

max-pool-size

 

プールの保持するバッファーの最大数。この制限を超えるバッファーを割り当てすることができますが、プールが満杯の場合は保持されません。

thread-local-cache-size

12

スレッドごとのキャッシュのサイズ。これは最大サイズで、スレッドが実際にバッファーを割り当てる場合にスマートサイズを使用してバッファーをスレッドにのみ保持します。

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

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

servlet-container 属性

表A.64 servlet-container 属性

属性デフォルト説明

allow-non-standard-wrappers

false

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

default-buffer-cache

default

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

default-cookie-version

0

アプリケーションによって作成されるクッキーに使用するデフォルトのクッキーバージョン。

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

属性デフォルト説明

session-timeout

 

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

user-agents

 

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

jsp 属性
注記

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

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

表A.67 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.68 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.69 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.70 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.71 custom-filter 属性

属性デフォルト説明

class-name

 

HttpHandler のクラス名。

module

 

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

parameters

 

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

error-page フィルター

エラーページ。

表A.72 error-page 属性

属性デフォルト説明

code

 

エラーページコード。

path

 

エラーページパス。

expression-filter フィルター

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

表A.73 expression-filter 属性

属性デフォルト説明

expression

 

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

module

 

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

gzip フィルター

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

mod-cluster フィルター

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

表A.74 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.75 balancer 属性

属性デフォルト説明

max-attempts

 

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

sticky-session

 

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

sticky-session-cookie

 

セッションクッキー名。

sticky-session-force

 

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

sticky-session-path

 

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

sticky-session-remove

 

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

wait-worker

 

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

load-balancing-group 属性

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

表A.76 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.77 context 属性

属性デフォルト説明

requests

 

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

status

 

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

request-limit フィルター

表A.78 request-limit 属性

属性デフォルト説明

max-concurrent-requests

 

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

queue-size

 

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

response-header フィルター

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

表A.79 response-header 属性

属性デフォルト説明

header-name

 

ヘッダー名。

header-value

 

ヘッダーの値

rewrite フィルター

表A.80 rewrite 属性

属性デフォルト説明

redirect

false

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

target

 

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

ハンドラーの属性

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

file 属性

表A.81 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.82 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.83 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.84 server 属性

属性デフォルト説明

default-host

default-host

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

servlet-container

default

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

ajp-listener 属性

表A.85 ajp-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

allow-unescaped-characters-in-url

false

URL でエスケープされていない文字を許可するかどうか。true に設定されていると、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を処理します。false に設定されている場合、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を HTTP Bad Request 400 応答コードで拒否します。

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.86 host 属性

属性デフォルト説明

alias

 

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

default-response-code

404

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

default-web-module

ROOT.war

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

disable-console-redirect

false

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

queue-requests-on-start

true

true に設定すると、リクエストはこのホストに対して開始時にキューに置かれます。false に設定された場合、代わりにデフォルトの応答コードが返されます。

filter-ref 属性

表A.87 filter-ref 属性

属性デフォルト説明

predicate

 

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

priority

1

フィルターの順序を定義します。小さい数字は、同じコンテキストの他の大きな数字よりも先にサーバーがハンドラーチェーンに含まれるよう指示します。値の範囲は、フィルターが最初に処理されることを示す 1 からフィルターが最後に処理されることを示す 2147483647 までになります。

location 属性

表A.88 location 属性

属性デフォルト説明

handler

 

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

filter-ref 属性

表A.89 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.90 access-log 属性

属性デフォルト説明

directory

${jboss.server.log.dir}

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

extended

false

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

pattern

common

アクセスログパターン。この属性に利用できるオプションの詳細は、『開発ガイド』の「提供される Undertow ハンドラー」を参照してください。

注記

リクエストの処理にかかった時間を出力するよう 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

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

console-access-log 属性

表A.91 console-access-log 属性

属性デフォルト説明

attributes

{remote-host={},remote-user={},date-time={},request-line={},response-code={},bytes-sent={}}

コンソールアクセスログ出力に含めるログデータおよびデフォルトデータ設定のカスタマイズを指定します。

include-host-name

false

JSON 構造の出力にホスト名を含めるかどうかを指定します。true に設定した場合、構造化データのキーは "hostName" で、その値は console-access-log が設定されたホストの名前になります。

metadata

 

コンソールアクセスログの出力に含めるカスタムメタデータを指定します。

predicate

 

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

worker

default

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

http-invoker Attributes

表A.92 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.93 single-sign-on 属性

属性デフォルト説明

cookie-name

JSESSIONIDSSO

クッキーの名前。

domain

 

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

http-only

false

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

path

/

クッキーのパス。

secure

false

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

http-listener 属性

表A.94 http-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

allow-unescaped-characters-in-url

false

URL でエスケープされていない文字を許可するかどうか。true に設定されていると、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を処理します。false に設定されている場合、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を HTTP Bad Request 400 応答コードで拒否します。

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 アドレスおよびホスト名を設定するかどうか。

proxy-protocol

false

PROXY プロトコルを使用して接続情報を送信するかどうか。true に設定された場合、リスナーは The PROXY protocol Versions 1 & 2 仕様によって定義される PROXY プロトコルバージョン 1 を使用します。このオプションは、同じプロトコルをサポートするロードバランサーの背後になるリスナーにのみ有効にする必要があります。

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.95 https-listener 属性

属性デフォルト説明

allow-encoded-slash

false

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

allow-equals-in-cookie-value

false

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

allow-unescaped-characters-in-url

false

URL でエスケープされていない文字を許可するかどうか。true に設定されていると、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を処理します。false に設定されている場合、リスナーはエスケープ処理されていない ASCII でない文字が含まれる URL を HTTP Bad Request 400 応答コードで拒否します。

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 アドレスの偽装が可能になります。

proxy-protocol

false

PROXY プロトコルを使用して接続情報を送信するかどうか。true に設定された場合、リスナーは The PROXY protocol Versions 1 & 2 仕様によって定義される PROXY プロトコルバージョン 1 を使用します。このオプションは、同じプロトコルをサポートするロードバランサーの背後になるリスナーにのみ有効にする必要があります。

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 が発生します。


このページには機械翻訳が使用されている場合があります (詳細はこちら)。