Hitachi Application Server V10 定義リファレンス（Windows®用）

3021-3-420-40

前書き

対象製品

適用OS：Windows Server 2008 R2、Windows Server 2012、Windows Server 2012 R2

P-2943-5KA4 Hitachi Application Server 10-11

適用OS：Windows 7 x64、Windows 8 x64、Windows 8.1 x64、Windows 10 x64、Windows Server 2008 R2、Windows Server 2012、Windows Server 2012 R2

P-2943-5FA4 Hitachi Application Server for Developers 10-11

注　このマニュアルで「Windows x86の場合」と表記している個所については、これらの製品ではサポートしていません。

適用OSについては、上記以外にもご利用になれる場合があります。詳細はリリースノートでご確認ください。

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI、Cosminexus、HAモニタ、HiRDB、JP1、uCosminexus、Virtageは、株式会社日立製作所の商標または登録商標です。

IBM、POWERは、世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

IBM、WebSphereは、世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Internet Explorerは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびExcelは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびHyper-Vは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびSQL Serverは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびVisual C++は、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleとJavaは、Oracle Corporation 及びその子会社、関連会社の米国及びその他の国における登録商標です。

RC4は、米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

RSAおよびBSAFEは、米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

UNIXは、The Open Groupの米国ならびに他の国における登録商標です。

W3Cは、World Wide Web Consortiumの商標（多数の国において登録された）です。

Windowsは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Windows Serverは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名、製品名などは、それぞれの会社の商標もしくは登録商標です。

本製品は、米国EMC コーポレーションのRSA BSAFE®ソフトウェアを搭載しています。

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

発行

2017年9月 3021-3-420-40

著作権

Copyright (C) 2014, 2017, Hitachi, Ltd.

Copyright (C) 2013, Oracle and/or its affiliates. All rights reserved.

変更内容

変更内容(3021-3-420-40)

Hitachi Application Server 10-11、Hitachi Application Server for Developers 10-11

追加・変更内容

変更個所

リリースノートのマニュアル訂正を反映した。

−

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

マニュアルの目的

このマニュアルではHitachi Application Serverのシステム基盤の構築で使用する定義ファイル、 Deployment Descriptor（DD）、プロパティー などの形式や定義方法について説明します。このマニュアルを利用することで、Hitachi Application Serverのシステム基盤に対して詳細な設計や設定ができることを目的としています。

対象読者

このマニュアルは次の方を対象読者としています。

システム構築者

アプリケーション開発者

前提知識をそれぞれ次に示します。

システム構築者

WindowsまたはUNIXの操作に関する知識

Application Serverの構築に関する知識

Java EE標準仕様に関する知識

システム構築で使用する周辺環境（データベース、ネットワーク、ジョブ管理など）に関する知識

アプリケーション開発者

Windowsの操作に関する知識

Java EE標準仕様に関する知識

Javaによるプログラム開発に関する知識

EclipseおよびWTPに関する知識

関連マニュアルの表記

関連マニュアル、およびこのマニュアルで使用している関連マニュアル名の表記を次の表に示します。

Hitachi Application Server関連

表記

正式名称

資料番号

ユーザーズガイド

Hitachi Application Server V10 ユーザーズガイド（Windows®用）

3021-3-414

GUIリファレンス

Hitachi Application Server V10 GUIリファレンス（Windows®用）

3021-3-416

コマンドリファレンス

Hitachi Application Server V10 コマンドリファレンス（Windows®用）

3021-3-418

定義リファレンス

Hitachi Application Server V10 定義リファレンス（Windows®用）

3021-3-420

メッセージリファレンス

Hitachi Application Server V10 メッセージリファレンス

3021-3-422

APIリファレンス

Hitachi Application Server V10 APIリファレンス

3021-3-423

HiRDB関連

表記

正式名称

資料番号

HiRDB システム導入・設計ガイド

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（UNIX®用）

3000-6-452

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（Windows®用）

3020-6-452

HiRDB メッセージ

ノンストップデータベース HiRDB Version 9 メッセージ

3020-6-458

JP1関連

表記

正式名称

資料番号

JP1/Automatic Job Management System 導入ガイド

JP1 Version 10 JP1/Automatic Job Management System 3 導入ガイド

3021-3-102

JP1/Automatic Job Management System 設計ガイド

JP1 Version 10 JP1/Automatic Job Management System 3 設計ガイド（システム構築編）

3021-3-103

JP1 Version 10 JP1/Automatic Job Management System 3 設計ガイド（業務設計編）

3021-3-104

JP1/Automatic Job Management System 構築ガイド1

JP1 Version 10 JP1/Automatic Job Management System 3 構築ガイド1

3021-3-105

JP1/Automatic Job Management System 操作ガイド

JP1 Version 10 JP1/Automatic Job Management System 3 操作ガイド

3021-3-109

製品名と機能名の表記

このマニュアルでは、製品名と機能名を次のように表記しています。

表記

製品名と機能名

ADT

Hitachi Application Development Tools

Application Server

Hitachi Application Server

Application Server - Base

Hitachi Application Server - Base

Application Server - Optional License for Java

Hitachi Application Server - Optional License for Java

Application Server for Developers

Hitachi Application Server for Developers

APV

IBM Advanced POWER Virtualization

DAS

Domain Administration Server

ドメイン管理サーバ

Developer's Kit for Java

Hitachi Developer's Kit for Java

Eclipse

Eclipse IDE for Java EE Developers

Excel

Microsoft® Excel

Firefox

Firefox®

HiRDB

HiRDB Version 9

HiRDB Server Version 9

HiRDB/Single Server

HiRDB/Single Server Version 9

Hyper-V

Microsoft® Hyper-V®

HWS

Hitachi Web Server

Web Server

Internet Explorer

Windows® Internet Explorer®

Java EE Server

Hitachi Java EE Server

JP1/AJS3

JP1 Version 10 JP1/Automatic Job Management System 3 - Agent

JP1 Version 10 JP1/Automatic Job Management System 3 - Manager

JP1 Version 10 JP1/Automatic Job Management System 3 - View

JP1/IM

JP1 Version 10 JP1/Integrated Management - Manager

JP1 Version 10 JP1/Integrated Management - View

Microsoft IIS

Microsoft IIS 7.5

Microsoft® Internet Information Services 7.5

Microsoft IIS 8.0

Microsoft® Internet Information Services 8.0

Microsoft IIS 8.5

Microsoft® Internet Information Services 8.5

Microsoft Visual C++

Microsoft® Visual C++®

Oracle

Oracle 11g

Oracle Database 11g

Oracle Database 11g R2

Oracle 12c

Oracle Database 12c

SQL Server

Microsoft® SQL Server

Virtage

Hitachi Virtage

VMware ESX

VMware vSphere® ESX

VMware Horizon View

VMware Horizon®（with View）

VMware vSphere ESXi

VMware vSphere® ESXi™

Windows

Windows Server 2008 R2

Microsoft® Windows Server® 2008 R2 Standard 日本語版

Microsoft® Windows Server® 2008 R2 Enterprise 日本語版

Microsoft® Windows Server® 2008 R2 Datacenter 日本語版

Windows Server 2012

Microsoft® Windows Server® 2012 Standard 日本語版

Microsoft® Windows Server® 2012 Datacenter 日本語版

Windows Server 2012 R2

Microsoft® Windows Server® 2012 R2 Standard 日本語版

Microsoft® Windows Server® 2012 R2 Datacenter 日本語版

Windows 7

Windows 7 x86

Microsoft® Windows® 7 Professional 日本語版(32ビット版)

Microsoft® Windows® 7 Enterprise 日本語版(32ビット版)

Microsoft® Windows® 7 Ultimate 日本語版(32ビット版)

Windows 7 x64

Microsoft® Windows® 7 Professional 日本語版(64ビット版)

Microsoft® Windows® 7 Enterprise 日本語版(64ビット版)

Microsoft® Windows® 7 Ultimate 日本語版(64ビット版)

Windows 8

Windows 8 x86

Windows® 8 Pro 日本語版(32ビット版)

Windows® 8 Enterprise 日本語版(32ビット版)

Windows 8 x64

Windows® 8 Pro 日本語版(64ビット版)

Windows® 8 Enterprise 日本語版(64ビット版)

Windows 8.1 x86

Windows® 8.1 Pro 日本語版(32ビット版)

Windows® 8.1 Enterprise 日本語版(32ビット版)

Windows 8.1 x64

Windows® 8.1 Pro 日本語版(64ビット版)

Windows® 8.1 Enterprise 日本語版(64ビット版)

Windows 10

Windows 10 x64

Windows® 10 Pro 日本語版(64ビット版)

Windows® 10 Enterprise 日本語版(64ビット版)

Windows Server Failover Cluster

Windows Server® Failover Cluster

クラス別統計

日立クラス別統計

パフォーマンストレーサ

Performance Tracer

パフォーマンストレーサー

Windowsに関しては、32ビット版のWindowsをWindows x86、64ビット版のWindowsをWindows x64と表記することがあります。

英略語

このマニュアルで使用している英略語を次に示します。

英略語

英字での表記

ACC

Application Client Container

ACL

Access Control List

AES

Advanced Encryption Standard

API

Application Programming Interface

ASCII

American Standard Code for Information Interchange

BLOB

Binary Large Object

CA

Certificate Authority

CDI

Contexts and Dependency Injection

CGI

Common Gateway Interface

CMP

Container-Managed Persistence

CMT

Container-Managed Transaction

CopyGC

Copy Garbage Collection

CORBA

Common Object Request Broker Architecture

CPU

Central Processing Unit

CRL

Certificate Revocation List

CSR

Certificate Signing Request

CSV

Comma Separated Value

CVS

Concurrent Versions System

DBMS

Database Management System

DCOM

Distributed Component Object Model

DD

Deployment Descriptor

DDE

Dynamic Data Exchange

DER

Distinguished Encoding Rules

DES

Data Encryption Standard

DI

Dependency Injection

DLL

Dynamic Link Library

DMZ

Demilitarized Zone

DN

Distinguished Name

DNS

Domain Name System

DoS

Denial of Service

DSO

Dynamic Shared Object

DTD

Document Type Definition

DTP

Eclipse Data Tools Platform

EAR

Enterprise Archive

ear

EIS

Enterprise Information System

EJB

Enterprise JavaBeans™

EJB QL

EJB™ Query Language

EL

Expression Language

EUC

Extended UNIX Code

FQDN

Fully Qualified Domain Name

FullGC

Full Garbage Collection

G1GC

Garbage First Garbage Collection

GC

Garbage Collection

GMS

Group Management Service

GMT

Greenwich Mean Time

GUI

Graphical User Interface

HA

High Availability

HTML

Hyper Text Markup Language

HTTP

Hyper Text Transfer Protocol

HTTPS

Hyper Text Transfer Protocol Security

I/O

Input/Output

ID

Identifier

IDE

Integrated Development Environment

IEC

International Electrotechnical Commission

IIOP

Internet Inter-Orb Protocol

IIS

Internet Information Services

IMAP

Internet Message Access Protocol

IP

Internet Protocol

IPv6

Internet Protocol Version 6

ISO

International Organization for Standardization

J2EE

J2EE™

Java™ 2 Platform, Enterprise Edition

JAAS

Java™ Authentication and Authorization Service

JACC

Java™ Authorization Service Provider Contract for Containers

JAF

JavaBeans™ Activation Framework Specification

JAR

Java™ Archive

jar

JASPIC

Java™ Authentication Service Provider Interface for Containers

Java

Java™

Java EE

Java™ Platform, Enterprise Edition

Java EE RI

Java EE Reference Implementation

Java HotSpot Client VM

Java HotSpot™ Client Virtual Machine

Java Platform Debugger Architecture

Java™ Platform Debugger Architecture

JPDA

Java SE

Java™ Platform, Standard Edition

Java VM

Java™ Virtual Machine

JVM

JavaMail

JavaMail™

JAX-RPC

Java™ API for XML-based RPC

JAX-RS

Java™ API for RESTful Web Services

JAX-WS

Java™ API for XML-based Web Services

JAXB

Java™ Architecture for XML Binding

JAXP

Java™ API for XML Processing

JAXR

Java™ API for XML Registries

JCA

J2EE™ Connector Architecture

JDBC

Java™ Database Connectivity

JDBC™

JDK

Java™ Development Kit

JDK™

JIS

Japanese Industrial Standards

JMS

Java™ Message Service

JMX

Java™ Management Extensions

JNDI

Java Naming and Directory Interface™

JNI

Java™ Native Interface

JPA

Java™ Persistence API

JSF

JavaServer™ Faces

JavaServer™ Faces Reference Implementation (RI) Version: 1.1_01 FCS

JSON-P

Java™ API for JSON Processing

JSP

JavaServer Pages™

JSP™

JST

Japan Standard Time

JSTL

JavaServer Pages™ Standard Tag Library

JTA

Java™ Transaction API

JVMPI

Java™ Virtual Machine Profiler Interface

JVMTI

Java™ Virtual Machine Tool Interface

KVM

Kernel-based Virtual Machine

LAN

Local Area Network

LDAP

Lightweight Directory Access Protocol

MAC

Message Authentication Code

MIME

Multipurpose Internet Mail Extensions

OASIS

Organization for the Advancement of Structured Information Standards

OMG

Object Management Group

ORB

Object Request Broker

OS

Operating System

OTS

Object Transaction Service

QNAME

Qualified Name

REST

Representational State Transfer

RMI

Remote Method Invocation

RPC

Remote Procedure Call

RSA

Rivest, Shamir and Adleman

SAAJ

SOAP with Attachments API for Java™

SAX

Simple API for XML

SEI

Service Endpoint Interface

Servlet

Java™ Servlet

SHA

Secure Hash Algorithm

SMAP

Source Map

SMTP

Simple Mail Transfer Protocol

SOAP

Simple Object Access Protocol

SSH

Secure Shell

ssh

SSL

Secure Sockets Layer

StAX

Streaming API for XML

TCP

Transmission Control Protocol

TLD

Tag Library Descriptor

TLS

Transport Layer Security

UCS

Universal multi-octet coded Character Set

UDP

User Datagram Protocol

URI

Uniform Resource Identifier

URL

Uniform Resource Locator

URN

Uniform Resource Name

UTC

Coordinated Universal Time

UTF

UCS Transformation Format

UTF-8

8-bit UCS Transformation Format

VM

Virtual Machine

VTL

Velocity Template Language

W3C

World Wide Web Consortium

WAR

Web Archive

war

WBEM

Web-Based Enterprise Management

WSDL

Web Services Description Language

WTP

Eclipse Web Tools Platform

XML

Extensible Markup Language

KB（キロバイト）などの単位表記について

1KB（キロバイト）、1MB（メガバイト）、1GB（ギガバイト）、1TB（テラバイト）、1PB（ペタバイト）はそれぞれ1,024バイト、1,024²バイト、1,024³バイト、1,024⁴バイト、1,024⁵バイトです。

1　定義リファレンスの見方

定義リファレンスを読むために必要な情報について説明しています。

1.1　定義リファレンスの記述形式

定義リファレンスの記述形式について説明しています。

記述で使用する項目

定義リファレンスでは、次に示す項目を使用して記述しています。それぞれの説明では、次の項目のうち必要な項目についてだけ説明しています。

説明

機能について説明しています。

スキーマ

DDファイルのschemaLocation属性、またはDOCTYPE宣言について説明しています。

書式

ファイルや項目の書き方について説明しています。

格納先

ファイルの格納先について説明しています。

要素の階層

DDファイルで指定できる要素の階層について説明しています。

パラメーターの設定対象となるファイル

パラメーターを設定できるファイルについて説明しています。

パラメーターの設定対象となる要素

パラメーターを設定できる要素について説明しています。

指定できる値

指定できる値の型や範囲について説明しています。

初期値

あらかじめシステムで設定されている値について説明しています。

デフォルト値

定義項目や値を設定しない場合に、システムで設定される値について説明しています。

依存関係のある要素または属性

DDファイルで、ほかの要素や属性と依存関係にあるかどうかについて説明しています。

記述できる場所

ディレクティブの記述できる場所について説明しています。記述できる場所には、次のものがあります。

httpsd.conf

VirtualHostブロック、Directoryブロック以外のhttpsd.conf

<VirtualHost>

httpsd.confのVirtualHostブロック

<Directory>

httpsd.confのDirectoryブロック、Locationブロック、Filesブロック

.htaccess

AccessFileNameディレクティブで指定したアクセス制御ファイル

<Location>

httpsd.confのLocationブロック

また、ディレクティブは次に示す順に参照されます。

VirtualHostブロック、Directoryブロック以外のhttpsd.conf

httpsd.confのVirtualHostブロック

httpsd.confのDirectoryブロック

アクセス制御ファイル

httpsd.confのFilesブロック

httpsd.confのLocationブロック

DirectoryブロックのAllowOverrideディレクティブの定義（上書き許可レベル）によって、アクセス制御ファイルで定義しているディレクティブを有効または無効にできます。

上書き許可

AllowOverrideディレクティブで上書きを許可する場合の許可レベルについて説明しています。許可レベルには、AuthConfig、FileInfo、Indexes、Limit、Options、All、Noneがあります。各ディレクティブの説明で.htaccessが指定でき、かつ上書き許可レベルの記述がない場合には、許可レベルはAllになります。

出現パターン

繰り返して指定できるかどうかについて説明しています。

指定できる子要素

要素で指定できる子要素について説明しています。各子要素では、指定できる値、デフォルト値、依存関係、出現パターンについて説明しています。

指定できる属性

要素で指定できる属性について説明しています。各属性では、指定できる値、デフォルト値、依存関係、出現パターンについて説明しています。

property要素のname属性およびvalue属性について

property要素のname属性およびvalue属性は、次の形式で指定します。

<property name="プロパティー名" value=プロパティーの値>

プロパティー名およびプロパティーの値は、「指定できるプロパティー」の説明、またはJava EEの標準仕様を参照してください。

なお、同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効な値として設定されます。

指定できるプロパティー

要素の属性で指定できるプロパティーについて説明しています。各プロパティーでは、指定できる値、デフォルト値、依存関係、出現パターンについて説明しています。

記述例または出力例

ファイルや項目の記述例、出力例について説明しています。

注意事項

ファイルや項目を定義する際の注意事項を説明しています。

フォルダーとパスの表記

このマニュアルでは、OS共通の内容の場合、「フォルダー」を「ディレクトリー」と表記しています。また、「¥」を「/」と表記しています。「ディレクトリー」を「フォルダー」に、「/」を「¥」に置き換えてお読みください。

1.2　定義リファレンスで使用している記号

定義リファレンスで使用している記号の意味について説明しています。

定義リファレンスでは、次の表に示す記号を使用して記述しています。

記号

意味

|

横に並べられた複数の項目に対する項目間の区切りを示し、「または」を意味します。

（例）A｜B

AまたはBを指定することを示します。

{ }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ、記号|で区切られている場合は、そのうちの1つを選択します。

（例）{A|B|C}

A、BまたはCのどれかを指定することを示します。

[ ]

この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には、すべてを省略するか、記号{ }と同じくどれか1つを選択します。

（例1）[A]

「何も指定しない」か「Aを指定する」ことを示します。

（例2）[B|C]

「何も指定しない」か「BまたはCを指定する」ことを示します。

...

記述が省略されていることを示します。また、この記号の直前に示す項目を繰り返し、複数個指定できることを示します

（例1） ABC…

ABCの後ろに記述があり、その記述が省略されていることを示します。

（例2）A, B, B, ...

「AとBの後ろにBを必要な個数分繰り返して指定できる」ことを示します。

項目

斜体で表記されている項目は、該当する要素やファイルなどを指定したり、該当する要素が表示されたりすることを示します。

（例1）プロパティー

プロパティーを記述します。またはプロパティーが表示されます。

（例2）ファイル名

ファイル名を指定します。

1.3　定義リファレンスで使用している構文要素

定義リファレンスで使用している構文要素の意味について説明しています。

定義リファレンスでは、次の表に示す構文要素を使用して記述しています。

構文要素

定義

数字

0〜9

英数字

A〜Z、a〜z、0〜9

注

すべて半角文字を使用してください。

2　Webサーバで使用する定義ファイルおよび定義項目

Webサーバの動作環境を設定するための定義ファイルおよび定義項目を説明しています。

2.1　Webサーバで使用する定義ファイルおよび定義項目の一覧

Webサーバの動作環境を設定するための定義ファイルおよび定義項目の概要を説明しています。

Webサーバで使用する定義ファイル

定義ファイル

概要

詳細説明

2.2　httpsd.conf

Webサーバの動作環境を設定するファイル

Webサーバの動作環境を各種ディレクティブで定義します。システム管理者が管理します。

2.4　mime.types

コンテンツのファイル拡張子とコンテントタイプの関連づけを定義するファイル

コンテンツのファイル拡張子とコンテントタイプ（MIMEタイプ）の関連づけを定義します。システム管理者が管理します。

2.5　アクセス制御ファイル

アクセス制御を定義するアクセス制御ファイル

アクセス制御を定義するファイルです。アクセス制御ファイル（.htaccess）を特定のディレクトリー下に作成すれば、そのディレクトリーに対するアクセス権を設定できます。

Webサーバで使用する定義項目（ディレクティブ）

定義項目（ディレクティブ）

概要

詳細説明

2.3.1　<Directory>

特定のディレクトリーに対するディレクティブの定義

特定のディレクトリーに対してディレクティブを定義する場合に指定します。

2.3.2　<DirectoryMatch>

正規表現で記述した条件を満たすディレクトリーに対するディレクティブの定義

正規表現で記述した条件を満たすディレクトリーに対してディレクティブを定義する場合に指定します。

2.3.3　<Files>

特定のファイルに対するディレクティブの定義

特定のファイルに対してディレクティブを定義する場合に指定します。

2.3.4　<FilesMatch>

正規表現で記述した条件を満たすファイルに対するディレクティブの定義

正規表現で記述した条件を満たすファイルに対してディレクティブを定義する場合に指定します。

2.3.5　<IfModule>

モジュールの存在有無に対するディレクティブの定義

指定したモジュールが組み込まれているとき、ブロック内で指定したディレクティブが有効になります。

2.3.6　<Limit>

特定のHTTPプロトコルメソッドに対するディレクティブの定義

特定のHTTPプロトコルメソッドだけに有効なアクセス制御のディレクティブを定義する場合に指定します。

2.3.7　<Location>

特定のURLに対するディレクティブの定義

特定のURLで示す場所へのリクエストについて、ディレクティブを定義する場合に指定します。

2.3.8　<LocationMatch>

正規表現で記述した条件を満たすURLへのリクエストに対するディレクティブの定義

正規表現で記述した条件を満たすURLへのリクエストについてディレクティブを定義する場合に指定します。

2.3.9　<Proxy>

ロードバランサー構成での振り分け先の定義

リバースプロキシーをmod_proxy_balancerによるロードバランサー構成で使用する場合に、BalancerMemberディレクティブを定義するために指定します。

2.3.10　<VirtualHost>

特定のホスト名またはIPアドレスに対するディレクティブの定義

ホスト名またはIPアドレス[:ポート番号]で示すホストへのリクエストについてディレクティブを定義する場合に指定します。

2.3.11　AccessFileName

アクセス制御ファイルのファイル名の定義

アクセス制御のディレクティブを定義しているファイル（アクセス制御ファイル）のファイル名を定義します。

2.3.12　Action

特定のMIMEタイプまたはハンドラーで指定したコンテンツに対するCGIスクリプトの実行

MIMEタイプまたはハンドラーで指定したコンテンツがWebブラウザーからリクエストされたとき、実行させるスクリプトをCGIスクリプト名で指定します。

2.3.13　AddAlt

ディレクトリーインデックス表示時に拡張子に関連づけてアイコンの代わりに表示する文字列

ディレクトリーインデックス表示時に、拡張子に指定したファイルと関連づけて文字列を表示する場合に指定します。

2.3.14　AddAltByEncoding

ディレクトリーインデックス表示時にMIMEエンコーディングに関連づけてアイコンの代わりに表示する文字列

ディレクトリーインデックス表示時に、アイコンが表示できない環境で、MIMEエンコーディング（x-compressなど）と関連づけて文字列を表示する場合に指定します。

2.3.15　AddAltByType

ディレクトリーインデックス表示時にMIMEタイプに関連づけてアイコンの代わりに表示する文字列

ディレクトリーインデックス表示時に、アイコンが表示できない環境で、MIMEタイプ（text/htmlなど）と関連づけて文字列を表示する場合に指定します。

2.3.16　AddCharset

ファイル拡張子に対する文字セットの指定

ファイル拡張子に対する文字セットを指定します。

2.3.17　AddDefaultCharset

ファイル拡張子に対する文字セットのデフォルト値の指定

ファイル拡張子に対する文字セットのデフォルト値を指定します。

2.3.18　AddDescription

ディレクトリーインデックス整形表示時にファイルに対して表示する説明

ディレクトリーインデックス整形表示時に、ファイル名で指定したファイル拡張子、ワイルドカード表記ファイル名またはパス情報なしの完全なファイル名に対して、説明文として文字列を表示する場合に指定します。

2.3.19　AddEncoding

Webサーバ内の圧縮データをWebブラウザーに表示させるときに必要な拡張子と圧縮形式の関連づけの指定

Webサーバ内の圧縮データをWebブラウザーに表示させるときに必要な拡張子と圧縮形式の関連づけを指定します。

2.3.20　AddHandler

ハンドラーで処理するファイル拡張子の定義

ハンドラーで処理するファイル拡張子を対応づける場合に定義します。

2.3.21　AddIcon

ディレクトリーインデックスの整形表示時のアイコンを拡張子と対応づけて表示

拡張子などにディレクトリーインデックスのアイコンを対応づけて表示する場合に指定します。

2.3.22　AddIconByEncoding

ディレクトリーインデックスの整形表示時のアイコンをMIMEエンコーディングと対応づけて表示

ディレクトリーインデックスの整形表示時のアイコンをMIMEエンコーディングと対応づけて表示する場合に指定します。

2.3.23　AddIconByType

ディレクトリーインデックスの整形表示時のアイコンをMIMEタイプと対応づけて表示

ディレクトリーインデックスの整形表示時のアイコンをMIMEタイプと対応づけて表示する場合に指定します。

2.3.24　AddLanguage

ドキュメントで使用する言語

ドキュメントで使用する言語を指定します。

2.3.25　AddType

TypesConfigディレクティブで指定したファイルに未定義のコンテンツの拡張子とMIMEタイプの関連づけ

TypesConfigディレクティブで指定したファイルに未定義のコンテンツの拡張子とMIMEタイプを関連づけたい場合に指定します。

2.3.26　Alias

URLのファイルシステムのパスへの置き換え

Webブラウザーからリクエストされた特定のURLを別名に置き換える場合に指定します。

2.3.27　AliasMatch

正規表現を使用してURLのファイルシステムのパスへの置き換え

WebブラウザーからリクエストされたURLを別名に置き換える場合に指定します

2.3.28　Allow

Webサーバへアクセスできるクライアントの制限

Webサーバへアクセスできるクライアントを制限する場合に指定します。

2.3.29　AllowOverride

AccessFileNameディレクティブで指定したファイルでのアクセス情報定義の上書き許可

AccessFileNameディレクティブで指定したファイルでアクセス情報定義の上書きを許可するかどうかを設定します。

2.3.30　AuthBasicAuthoritative

ユーザー認証する場合の制御方法

ユーザー認証をする場合の制御方法を指定します。

2.3.31　AuthGroupFile

認証するグループのリストを格納しているファイル名の指定

グループでユーザー認証をする場合、認証するグループのリストを格納しているファイル名を指定します

2.3.32　AuthName

ユーザー認証する場合のrealm名

ユーザー認証する場合のrealm名（Webブラウザーのユーザー認証画面に表示される）を指定します。

2.3.33　AuthType

ユーザー認証する場合の認証制御のタイプ

ユーザー認証する場合の認証制御のタイプを指定します。

2.3.34　AuthUserFile

認証するユーザー名とパスワードのリストを格納しているファイル名の指定

ユーザー名でユーザー認証をする場合、認証するユーザー名とパスワードのリストを格納しているファイル名を指定します。

2.3.35　BalancerMember

リバースプロキシーをロードバランサー構成で使用する場合の転送先のURLの指定

リバースプロキシーをmod_proxy_balancerによるロードバランサー構成で使用する場合に転送先のURLを定義します。

2.3.36　BrowserMatch

Webブラウザーごとの環境変数の設定

Webブラウザーごとに環境変数を設定する場合に指定します。

2.3.37　BrowserMatchNoCase

Webブラウザーごとの環境変数の設定

Webブラウザーごとに環境変数を設定する場合に指定します。

2.3.38　CacheNegotiatedDocs

コンテントネゴシエーションをするリクエストでクライアント側のキャッシュを有効にするかどうかの指定

コンテントネゴシエーションをするリクエストで、クライアント側のキャッシュを有効にするかどうかを指定します。

2.3.39　CustomLog

任意のフォーマットのアクセスログ出力

任意のフォーマットのログをファイルに出力させる場合に指定します。

2.3.40　DefaultIcon

ディレクトリーインデックスで特定のアイコンが設定されていない場合に表示するアイコン

ディレクトリーインデックスで表示するアイコンを指定します。

2.3.41　DefaultLanguage

ドキュメントで使用するデフォルトの言語

ドキュメントで使用するデフォルトの言語を指定します。

2.3.42　Deny

Webサーバへアクセスできるクライアントの制限

Webサーバへアクセスできるクライアントを制限する場合に指定します。

2.3.43　DirectoryIndex

デフォルトとしてクライアントに送信するコンテンツのファイル

Webブラウザーからのリクエストが特定のコンテンツを指定していない場合に、デフォルトとしてクライアントに送信するコンテンツのファイル名を指定します。

2.3.44　DocumentRoot

コンテンツを格納するドキュメントルートディレクトリーの指定

コンテンツを格納するドキュメントルートディレクトリーを絶対パスで指定します。

2.3.45　ErrorDocument

エラーが発生したときにWebブラウザーへ表示するメッセージのカスタマイズ

エラーが発生したときに、Webブラウザーへ表示するメッセージをカスタマイズする場合に指定します。

2.3.46　ErrorLog

エラーログの出力

エラーログを出力するファイル名を指定します。出力するログの内容は、LogLevelディレクティブで選択できます。

2.3.47　ExpiresActive

有効期限機能に関連するレスポンスヘッダーを追加するかどうかの指定

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加するかどうかを指定します。

2.3.48　ExpiresByType

MIMEタイプのドキュメントに対する有効期限の指定

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合に、指定するMIMEタイプのドキュメントに対する有効期限を指定します。

2.3.49　ExpiresDefault

有効期限のデフォルトの指定

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合に、デフォルトの有効期限を指定します。

2.3.50　ExtendedStatus

ステータス情報表示時に各リクエストの拡張ステータス情報を表示するかどうかの指定

server-statusハンドラーによるステータス表示形式で、それぞれのリクエストの拡張ステータス情報を表示するかどうかを指定します。

2.3.51　FileETag

ETagレスポンスヘッダーフィールドを作成するために使用されるファイルの属性値

ETagレスポンスヘッダーフィールドを作成するために使用されるファイル属性値を指定します。

2.3.52　ForceType

特定のディレクトリー下のすべてのコンテンツに対して使用するMIMEタイプ

<Directory>ブロックまたはアクセス制御ファイルに定義し、特定のディレクトリー下のすべてのコンテンツに対して使用するMIMEタイプを指定します。

2.3.53　Header

200番台のステータスコード応答時のレスポンスヘッダーのカスタマイズ

200番台のステータスコード応答時のレスポンスヘッダーをカスタマイズする場合に指定します。リバースプロキシーとして使用する場合、バックエンドのWebサーバが返すステータスコードの値に関係なく、レスポンスヘッダーをカスタマイズします。

2.3.54　HeaderName

ディレクトリーインデックス表示時のヘッダーに付けるコメントを記述したファイルの指定

ディレクトリーインデックス表示時のヘッダーに付けるコメントを記述したファイルのファイル名（パス情報なし）を指定します。

2.3.55　HostnameLookups

ホスト名のルックアップの逆引きをするかどうかの指定

CGIのREMOTE_HOST環境変数のIPアドレスおよびログファイルに出力するクライアントのIPアドレスをホスト名に変換するために、ホスト名のルックアップの逆引きをするかどうかを指定します。

2.3.56　HWSErrorDocumentMETACharset

エラーが発生したときにWebブラウザーへ表示するメッセージに対応した文字セット

エラーが発生したときにWebブラウザーへ表示するメッセージ（以降、エラードキュメントと呼びます）についての文字セットを設定します。

2.3.57　HWSErrorLogClientAddr

エラーログに出力するクライアントアドレスをX-Forwarded-Forヘッダー値に変更

バックエンドサーバで、エラーログに出力するメッセージテキストの"[client クライアントアドレス:ポート番号] "を"[X-Forwarded-For X-Forwarded-Forヘッダー値] "に変更するよう設定します。

2.3.58　HWSGracefulStopLog

計画停止時に強制停止させたリクエスト情報をエラーログファイルに出力するかどうかの指定

計画停止時に、強制停止待ち時間を経過したあとに強制停止させたリクエスト情報を、エラーログファイルに出力するかどうかを指定します。

2.3.59　HWSGracefulStopTimeout

計画停止時に実行中のリクエストを強制的に終了させるまでの待ち時間

計画停止時に、実行中のリクエストを直ちに終了するまでの強制停止待ち時間を秒単位で指定します。

2.3.60　HWSImapMenuCharset

メニュー表示に対する文字セット

メニュー表示に対する文字セットを指定します。

2.3.61　HWSLogSSLVerbose

SSLハンドシェイク処理中にログに出力されるエラーの詳細情報を表示するかどうかの指定

クライアントとサーバ間のSSLハンドシェイク処理中に、ログに出力されるエラーのうちinfoレベルおよびerrorレベルのエラーについて、詳細情報を表示するかどうかを指定します。SSLを有効にする場合には、このディレクティブをOnに設定することを推奨します。

2.3.62　HWSLogTimeVerbose

ログに出力する時間をミリ秒まで表示するかどうかの指定

エラーログとリクエストログの時刻、アクセスログのアクセス時刻、リクエスト処理に掛かった時間（%T）、およびリクエスト処理を開始した時刻（%t）をミリ秒まで表示するかどうかを指定します。

2.3.63　HWSMaxQueueSize

クライアントからのリクエストについての最大待ちリクエスト数

クライアントからのリクエストについての最大待ちリクエスト数を指定します。

2.3.64　HWSPrfId

PRFデーモン起動時にPRF識別子に指定した文字列の指定

PRFデーモン起動時にPRF識別子に指定した文字列を指定します。

2.3.65　HWSPrfSpool

PRFデーモンを使用するときに必要なPRFSPOOL環境変数に設定するディレクトリー名の指定

PRFデーモンを使用するときに必要なPRFSPOOL環境変数に設定するディレクトリー名を指定します。

2.3.66　HWSProxyPassReverseCookie

リバースプロキシー使用時にバックエンドサーバから受信したSet-Cookieヘッダーの変換

リバースプロキシーを使用する場合、リバースプロキシーはバックエンドサーバから受信したSet-Cookieヘッダーを変換します。これは、WebブラウザーがSet-Cookieヘッダーを受信したあとに、リバースプロキシーを経由するバックエンドサーバへのリクエストに対して、Cookieを送信させるために必要になります。

2.3.67　HWSRequestLog

リクエストログの出力

リクエストログを出力するファイル名を指定します。

2.3.68　HWSRequestLogType

リクエストログに出力するトレース種別

HWSRequestLogディレクティブで設定するリクエストログに出力するトレース種別を指定します。

2.3.69　HWSSetEnvIfIPv6

クライアントまたはサーバのIPv6アドレスによる環境変数の設定

クライアントまたはサーバのIPv6アドレスを基に環境変数を定義します。

2.3.70　HWSSuppressModuleTrace

モジュールトレースの出力の抑止

モジュールトレースの出力を抑止するモジュールファイル名および抑止する関数種別を指定します。

2.3.71　HWSTraceIdFile

トレース採取のための共有メモリーIDを格納するファイル名の指定

トレース採取のための共有メモリーIDを格納するファイル名を指定します。

2.3.72　HWSTraceLogFile

サーバプロセスが異常終了した場合に共有メモリーに採取されたトレースを出力するファイル名の指定

サーバプロセスが異常終了した場合に共有メモリーに採取されたトレースを出力するファイル名を指定します。

2.3.73　ImapBase

イメージマップファイルのbase行のデフォルトの指定

イメージマップファイルのbase行のデフォルトを指定します。

2.3.74　ImapDefault

イメージマップファイルのdefault行のデフォルトの指定

イメージマップファイルのdefault行のデフォルトを指定します。

2.3.75　ImapMenu

メニュー表示についての指定

イメージマップファイルの指定値にmapを与えた場合またはイメージマップ画像の(0,0)座標をマウスでポイントした場合のメニュー表示を指定します。座標指定のない形でイメージマップファイルがリクエストされた場合の動作もこの設定に従います。

2.3.76　Include

設定ファイルとして使用するファイルの指定

ファイル名で指定したファイルを設定ファイルとして利用できるようにします。

2.3.77　IndexIgnore

ディレクトリーインデックス表示時にWebブラウザーに表示させないファイル名の指定

ディレクトリーインデックス表示時に、Webブラウザーに表示させないファイル名を指定します。正規表現でも指定できます。

2.3.78　IndexOptions

ディレクトリーインデックスの整形表示機能のオプション

ディレクトリーインデックスの整形表示機能のオプション設定をします。

2.3.79　IndexOrderDefault

ディレクトリーインデックス表示でのデフォルトのファイルの並び順

ディレクトリーインデックス表示での、ファイルの並び順のデフォルトを指定します。

2.3.80　KeepAlive

KeepAlive接続を有効にするかどうかの指定

KeepAlive接続を有効にするかどうかを指定します。

2.3.81　KeepAliveTimeout

KeepAlive接続時のリクエスト待ち時間

KeepAlive接続時の要求待ち時間を秒単位で指定します。

2.3.82　LanguagePriority

クライアントが使用言語の優先度を示さなかった場合の優先順位の指定

使用言語を優先順位の高い順に指定します。

2.3.83　LimitRequestBody

サーバが受信するオブジェクトボディーのサイズの上限

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のオブジェクトボディー（データ）のサイズの上限を指定します。

2.3.84　LimitRequestFields

サーバが受信するHTTPヘッダー数の上限

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のHTTPヘッダー数の上限を指定します。

2.3.85　LimitRequestFieldsize

サーバが受信する1つのHTTPヘッダーのサイズの上限

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合、1つのHTTPヘッダーの、サイズの上限を指定します。

2.3.86　LimitRequestLine

サーバが受信するリクエストラインの長さの上限

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のリクエストライン（メソッド、問い合わせ文字列などを含むURI、HTTPバージョン）の長さの上限を指定します。

2.3.87　Listen

リクエストを受け付けるIPアドレスおよびポート番号

リクエストを受け付けるIPアドレスおよびポート番号を指定します。

2.3.88　ListenBacklog

クライアントからの接続要求の最大の待ち行列数

クライアントからの接続要求の最大の待ち行列数を指定します。

2.3.89　LoadFile

DSOによって組み込むモジュールが参照するコードがあるオブジェクトファイルまたはライブラリー

DSOによって組み込むモジュールが参照するコードがあるオブジェクトファイルまたはライブラリーを指定します。

2.3.90　LoadModule

Webサーバに動的に組み込むモジュール

Webサーバに動的に組み込むモジュールを指定します。

2.3.91　LogFormat

ログのフォーマットにラベル名を定義

ログのフォーマットにラベル名を定義します。ここで定義したラベル名をCustomLogディレクティブで指定できます。

2.3.92　LogLevel

エラーログに出力するエラーのレベル

エラーログに出力するエラーのレベルを指定します。指定したレベルの上位レベルのログを出力します。

2.3.93　MaxKeepAliveRequests

KeepAlive連続接続回数の上限

KeepAlive連続接続回数の上限を指定します。

2.3.94　MultiviewsMatch

コンテントネゴシエーションの対象となる拡張子の種類

コンテントネゴシエーションの対象となる拡張子の種類を指定します。

2.3.95　Options

ユーザーに利用させる機能の制限

ユーザーが利用できる機能を制限する場合に指定します。

2.3.96　Order

AllowディレクティブとDenyディレクティブの指定の評価の順序

AllowディレクティブとDenyディレクティブの指定の評価の順序を指定します。

2.3.97　PassEnv

CGIスクリプトに渡す任意の環境変数

CGIスクリプトに渡す任意の環境変数を指定できます。

2.3.98　PidFile

制御プロセスIDを格納するファイル

制御プロセスIDを格納するファイル名を指定します。

2.3.99　ProxyErrorOverride

バックエンドサーバからのレスポンスがエラーのステータスコードであった場合にレスポンスを上書きするかどうかの指定

バックエンドサーバからのステータスコードが400番台または500番台の場合、レスポンスヘッダーとレスポンスボディーをオーバーライドします。その結果、リバースプロキシーはバックエンドサーバからのレスポンスではなく、自身が生成したレスポンスをクライアントに返します。

2.3.100　ProxyPass

バックエンドサーバに転送するリクエストと転送するアドレス

リバースプロキシーを使用する場合、Webブラウザーからのリクエストとそれを転送するアドレスを指定します。

2.3.101　ProxyPassReverse

バックエンドサーバから受信したLocationヘッダーのURLの変更

リバースプロキシーを使用する場合、バックエンドサーバからのリダイレクトレスポンスのLocationヘッダーで示すURLを変更します。

2.3.102　ProxyPreserveHost

クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送するかどうかの指定

リバースプロキシーを使用する場合、クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送するかどうかを指定します。

2.3.103　ProxyTimeout

バックエンドサーバとの送受信に関する待ち時間の指定

バックエンドサーバとの送受信に関する待ち時間を秒単位で指定します。

2.3.104　ProxyVia

Viaヘッダーの使用の制御

このディレクティブはプロキシーでViaヘッダーの使用を制御する場合に指定します。

2.3.105　QOSCookieDomain

流量制限機能に使用するCookieが有効とされるドメイン

流量制限機能に使用するCookieが有効とされるドメインを指定します。この値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。

2.3.106　QOSCookieExpires

流量制限機能に使用するCookieの有効時間

流量制限機能に使用するCookieの有効時間を秒単位で指定します。このディレクティブで指定した値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。

2.3.107　QOSCookieName

流量制限機能に使用するCookie名

流量制限機能に使用するCookie名を指定します。

2.3.108　QOSCookieSecure

SSLによるアクセス時だけにCookieを送信させるかどうかの指定

クライアントに対し、SSLによるアクセス時だけにCookieを送信させるよう設定します。この値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。

2.3.109　QOSCookieServers

Cookieを送信してきたリクエストだけを処理するときのサーバスレッド数

リクエスト待ち状態のサーバスレッド数が減少した場合に、Cookieを送信してきたリクエストだけを処理するときの、サーバスレッド数を指定します。

2.3.110　QOSRedirect

流量制限機能によって拒否したリクエストのリダイレクト

流量制限機能によって処理が拒否された場合に、クライアントからのリクエストを指定されたパスにリダイレクトさせるときに指定します。

2.3.111　QOSRejectionServers

受信したすべてのリクエストを拒否するときのサーバプロセス数

リクエスト待ち状態のサーバスレッド数が減少し、受信したすべてのリクエストを拒否するようになるときの、サーバスレッド数を指定します。

2.3.112　QOSResponse

流量制限機能によって処理が拒否された場合にレスポンスとして返すコンテンツ

流量制限機能によって処理が拒否された場合に、ステータスコード503とともに返送するコンテンツを指定します。

2.3.113　ReadmeName

ディレクトリーインデックス表示時のReadmeとして付けるコメントを記述したファイルの指定

ディレクトリーインデックス表示時のReadmeとして付けるコメントを記述したファイルのファイル名（パス情報なし）を指定します。

2.3.114　Redirect

クライアントからのリクエストをリダイレクトする場合の指定

旧パスに対するクライアントからのリクエストを、新パスに再リクエスト（リダイレクト）する場合に指定します。

2.3.115　RedirectMatch

正規表現で記述した条件を満たすクライアントからのリクエストをリダイレクトする場合の指定

正規表現で記述した条件を満たすパスに対するクライアントからのリクエストを、新パスに再リクエスト（リダイレクト）する場合に指定します。

2.3.116　RequestHeader

リクエストヘッダーのカスタマイズ

クライアントから受信したヘッダー値をカスタマイズする場合に指定します。

2.3.117　RequestReadTimeout

リクエスト受信開始からリクエストヘッダー受信完了まで、およびリクエストボディーの受信開始から完了までのタイムアウト時間の指定

リクエスト受信開始からリクエストヘッダー受信完了まで、およびリクエストボディーの受信開始から完了までのタイムアウト時間を秒単位で指定します。

2.3.118　Require

アクセス制限の定義

AuthNameディレクティブ、AuthTypeディレクティブ、AuthUserFileディレクティブ（またはAuthGroupFileディレクティブ）と一緒に指定し、アクセス制限を定義します。

2.3.119　Satisfy

コンテンツへのアクセスがユーザー認証とホスト名またはIPアドレスの両方によって制限されている場合のアクセス条件

コンテンツへのアクセスが、ユーザー認証（AuthUserFile、Requireディレクティブなどを指定）とホスト名またはIPアドレス（Allow from、Deny fromディレクティブなどを指定）の両方によって制限されている場合にその関係を設定します。

2.3.120　Script

特定のメソッドに対するCGIスクリプトの実行

指定されたメソッドによるリクエストがあった場合にCGIスクリプト名で示すスクリプトを実行します。

2.3.121　ScriptAlias

CGIプログラムを実行するURLとCGIプログラムが配置されているディレクトリー名の指定

WebブラウザーからURLで指定されたCGIプログラム実行のリクエストに対して、実行するCGIプログラムのあるディレクトリー名を指定します。

2.3.122　ScriptAliasMatch

CGIプログラムを実行するURLに対する正規表現とCGIプログラムが配置されているディレクトリー名の指定

Webブラウザーから指定されたCGIプログラム実行要求のURLが正規表現で記述した条件を満たす場合、指定した新パスのCGIプログラムを実行します。

2.3.123　ScriptInterpreterSource

CGIスクリプトの実行に使用されるインタープリターの指定

CGIスクリプトの実行に使用されるインタープリターを定義します。

2.3.124　ScriptLog

CGIスクリプトのエラーログ出力先

CGIスクリプトのエラーログ出力先のファイルを指定します。

2.3.125　ScriptLogBuffer

リクエストのボディー部のログを採取する場合の最大値

PUT、POSTメソッドによるリクエストのボディー部のログを採取する場合の最大値をバイト単位で指定します。ScriptLogディレクティブでエラーログ出力先のファイルを指定した場合だけ、この指定は有効になります。

2.3.126　ScriptLogLength

CGIスクリプトのエラーログファイルの最大サイズ

CGIスクリプトのエラーログファイルの最大サイズをバイト単位で指定します。ScriptLogディレクティブでエラーログ出力先のファイルを指定した場合だけ指定が有効になります。

2.3.127　SendBufferSize

WebサーバのTCP送信バッファサイズ

WebサーバのTCP送信バッファサイズをバイト数で指定します。

2.3.128　ServerAdmin

サーバ管理者のE-Mailアドレス

サーバ管理者のE-Mailアドレスを指定します。ServerSignatureディレクティブでE-Mailを指定する場合は、必ず指定してください。

2.3.129　ServerAlias

サーバ名に基づくバーチャルホストで使用するホスト名の別名

サーバ名に基づくバーチャルホストで使用するホスト名（ServerName）の別名を指定します。IPv6アドレスに対応したホスト名も指定できます。

2.3.130　ServerName

Webサーバのサーバ名およびポート番号

Webサーバのサーバ名およびポート番号を指定します。

2.3.131　ServerPath

サーバ名に基づくバーチャルホストでHostヘッダーの代わりにパス名を利用して各ホストに接続する場合の指定

サーバ名に基づくバーチャルホストで、Hostヘッダーの代わりにパス名を利用して各ホストに接続する場合に指定します。

2.3.132　ServerRoot

サーバのルートディレクトリーの指定

サーバのルートディレクトリーを絶対パスで指定します。

2.3.133　ServerSignature

Webサーバが作成するエラーメッセージなどのコンテンツのフッターに署名するかどうかの指定

Webサーバが作成するエラーメッセージなどのコンテンツのフッターに署名するかどうかを指定します。

2.3.134　ServerTokens

Serverヘッダーのフォーマット

HTTPレスポンスヘッダーのServerヘッダーのフォーマットを設定します。

2.3.135　SetEnv

CGIスクリプトに渡す環境変数

CGIスクリプトに任意の環境変数を渡す場合に設定する環境変数の値を指定します。このディレクティブを複数指定する場合、同じ環境変数に異なる値は指定できません。

2.3.136　SetEnvIf

クライアントからのリクエストを基に環境変数の定義

クライアントからのリクエスト値が正規表現で表した条件を満たす場合、指定した環境変数を設定します。

2.3.137　SetEnvIfNoCase

クライアントからのリクエストを基に環境変数の定義

クライアントからのリクエスト値が正規表現で表した条件を満たす場合、指定した環境変数を設定します。

2.3.138　SetHandler

ある特定のハンドラーに関連づける場合の指定

指定した<Directory>またはアクセス制御ファイルの範囲すべてのリクエストをハンドラー名で指定したハンドラーに関連づける場合、指定します。

2.3.139　SSLBanCipher

指定した暗号種別でのアクセスを拒否してステータスコード403 Forbiddenを応答する場合の指定

指定した暗号種別でのアクセスを拒否し、クライアントにステータスコード403 Forbiddenを応答します。

2.3.140　SSLCACertificateFile

CAの証明書のファイルの指定

SSLでサーバ認証およびクライアント認証する場合、CA（認証局）の公開鍵（PEM形式）のファイル名を指定します。複数の証明書ファイルを連結させて、1つのファイルに複数の証明書が混在できます。

2.3.141　SSLCertificateFile

SSLで認証する場合のWebサーバの証明書のファイルの指定

SSLで認証する場合、Webサーバの証明書（PEM形式）のファイル名を指定します。

2.3.142　SSLCertificateKeyFile

SSLで認証する場合のWebサーバの秘密鍵のファイルの指定

SSLで認証する場合、Webサーバの秘密鍵のファイル名を指定します。

2.3.143　SSLCertificateKeyPassword

パスワード保護されているサーバ秘密鍵のパスワードを格納するファイルの指定

パスワード保護をされているサーバ秘密鍵のパスワードを格納しておくファイルのパス名を指定します。

2.3.144　SSLCRLAuthoritative

CRLの次回発行日を経過した場合の動作の指定

SSLクライアント認証時に使用するCRLの次回発行日の扱いについて指定します。

2.3.145　SSLCRLDERPath

DER形式のCRLを格納するディレクトリーの指定

DER形式のCRLを格納するディレクトリーを絶対パスで指定します。指定したディレクトリーに必要なCRLを格納して、Webサーバを起動または再起動すると、SSLでのクライアント認証時にCRLを適用できます。SSLCRLPEMPathディレクティブで指定したディレクトリー内のCRLも含め、同じCAから発行されたCRLを複数格納している場合、発行日が最新のCRLを適用します。

2.3.146　SSLCRLPEMPath

PEM形式のCRLを格納するディレクトリーの指定

PEM形式のCRLを格納するディレクトリーを絶対パスで指定します。指定したディレクトリーに必要なCRLを格納して、Webサーバを起動または再起動すると、SSLでのクライアント認証時にCRLを適用できます。SSLCRLDERPathディレクティブで指定したディレクトリー内のCRLも含め、同じCAから発行されたCRLを複数格納している場合、発行日が最新のCRLを適用します。

2.3.147　SSLDenySSL

SSLによるアクセスの禁止

SSLによるアクセスを禁止する場合に指定します。このディレクティブが指定されている場合、SSLEnableディレクティブでSSLを有効にしてもhttpsによるアクセスがステータスコード403 Forbiddenで拒否されます。SSLRequireSSLディレクティブの逆の動作をします。

2.3.148　SSLDisable

SSLを無効にする場合の指定

SSLを無効にします。デフォルト値はSSLEnableディレクティブ（SSLを有効）です。バーチャルホストで特定のホストに対してSSLを無効にする場合などに指定します。

2.3.149　SSLEnable

SSLを有効にする場合の指定

SSLを有効にします。SSLDisableディレクティブを指定しないかぎり、デフォルトで有効になります。

2.3.150　SSLExportCertChainDepth

環境変数SSL_CLIENT_CERT_CHAIN_nにクライアントの証明書を発行したCAからルートCAまでの証明書を設定するときの指定

SSLクライアント認証をする場合、環境変数SSL_CLIENT_CERT_CHAIN_nにクライアントの証明書を発行したCAからルートCAまでの証明書を設定するときに指定します。

2.3.151　SSLExportClientCertificates

環境変数SSL_CLIENT_CERTにクライアント証明書を設定するときの指定

SSLクライアント認証をする場合、環境変数SSL_CLIENT_CERTにクライアント証明書を設定するときに指定します。環境変数SSL_CLIENT_CERTにはDER形式の証明書をBase64エンコーディングした値を設定します。

2.3.152　SSLFakeBasicAuth

クライアント証明書を利用したBasic認証

SSLクライアント認証の機能とあわせて、WebブラウザーでユーザーIDとパスワードを入力することなく、クライアント証明書の提示だけでBasic認証をできるようにします。AuthUserFileディレクティブで指定するファイルにはX509クライアント証明書のSubjectとパスワードを記述します。

2.3.153　SSLProtocol

使用するSSLプロトコルのバージョンの指定

使用するSSLプロトコルのバージョンを指定します。

2.3.154　SSLRequireCipher

指定した暗号種別以外でのアクセスを拒否してステータスコード403 Forbiddenを応答する場合の指定

指定した暗号種別以外でのアクセスを拒否し、クライアントにステータスコード403 Forbiddenを応答します。

2.3.155　SSLRequiredCiphers

SSL通信で使用できる暗号種別の指定

SSL通信で使用できる暗号種別を指定します。ディレクティブに指定した暗号種別とクライアントが使用できる暗号種別との間で一致するものがあれば、SSL通信が確立されHTTPリクエストを受信します。一致するものがない場合は、SSL通信は確立されないでHTTPリクエストを受信しません。

2.3.156　SSLRequireSSL

SSL以外によるアクセスの禁止

SSL以外によるアクセスを禁止する場合に指定します。このディレクティブが指定されている場合、SSLDisableディレクティブでSSLを無効にしてもhttpによるアクセスがステータスコード403 Forbiddenで拒否されます。異なるディレクティブの記述場所で、不用意にSSLを無効にしコンテンツを公開してしまうことを防止します。

2.3.157　SSLSessionCacheSize

セッションキャッシュサイズの上限値

セッションキャッシュサイズの上限値をバイト単位で指定します。0を指定した場合、セッションキャッシュは実施されません。

2.3.158　SSLSessionCacheTimeout

SSLセッションの有効時間

Webサーバ内またはSSLセッション管理キャッシュサーバgcache内で保持されるセッションIDなどのデータの有効時間を秒単位で指定します。

2.3.159　SSLVerifyClient

クライアント認証時の証明書に関する設定

クライアント認証時の証明書に関する設定を指定します。

2.3.160　SSLVerifyDepth

証明書のチェーンを何段階までたどるかの指定

証明書のチェーンを何段階までたどるかを指定します。

2.3.161　ThreadsPerChild

サーバとして起動するスレッド数

サーバとして起動するスレッド数を指定します。指定したスレッド数はサーバの最大同時接続数を示します。

2.3.162　Timeout

Webサーバの送受信の待ち時間

Webサーバの送受信の待ち時間を秒単位で指定します。

2.3.163　TraceEnable

TRACEメソッドによるリクエストを拒否するかどうかの指定

TRACEメソッドによるリクエストを拒否するかどうかを指定します。

2.3.164　TransferLog

ラベル名を指定しないLogFormatディレクティブのフォーマットでのアクセスログ出力

ログを格納するファイルまたはログを出力するプログラムを指定します。ログのフォーマットはラベル名を指定しないLogFormatディレクティブで指定できます。

LogFormatディレクティブでログのフォーマットを指定する場合は、IPv6アドレスやIPv6アドレスに対応したホスト名も出力できます。

LogFormatディレクティブでフォーマットを指定しない場合は、標準のログフォーマットで出力します。

2.3.165　TypesConfig

ファイル拡張子とコンテントタイプの関係を定義する設定ファイルの指定

ファイル拡張子とコンテントタイプ（MIMEタイプ）の関係を定義する設定ファイルを指定します。

2.3.166　UnsetEnv

CGIスクリプトに渡す環境変数からSetEnvディレクティブまたはPassEnvディレクティブで指定した環境変数を削除する場合の指定

CGIスクリプトに渡す環境変数から、SetEnvディレクティブまたはPassEnvディレクティブで指定した環境変数を削除する場合に指定します。

2.3.167　UseCanonicalName

サーバの正式な名前の生成方法の指定

サーバの正式な名前の生成方法を指定します。サーバの正式な名前は、自サーバを参照するURLや環境変数のSERVER_NAMEとSERVER_PORTに設定されます。なお、On、Off、dnsすべての場合で、IPv6アドレスに対応しています。

2.3.168　UserDir

Webブラウザーからの/~ユーザー名/へのリクエストに対して公開するサーバ上の場所の指定

Webブラウザーからの/~ユーザー名/へのリクエストに対して公開するサーバ上の場所をディレクトリー名で指定します。

Webサーバで使用する定義項目（ユーティリティー）

定義項目（ユーティリティー）

概要

詳細説明

2.6.1　rotatelogs

時間によるログの分割

アクセスログやエラーログを一定時間単位に分割して、複数のファイルに出力できます。

2.6.2　rotatelogs2

ファイルサイズによるログの分割

アクセスログやエラーログをログファイルサイズで分割して、複数のファイルにラップアラウンドして出力できます。

2.2　httpsd.conf

Webサーバの動作環境を設定するファイルです。

説明

Webサーバの動作環境を各種ディレクティブで定義します。システム管理者が管理します。

ファイルに指定できる定義およびディレクティブを次に示します。

設定内容

ディレクティブ名

複数指定

httpsd.confファイル内のブロックの定義

<Directory>

○

<DirectoryMatch>

○

<Files>

○

<FilesMatch>

○

<IfModule>

○

<Limit>

○

<Location>

○

<LocationMatch>

○

<Proxy>

○

<VirtualHost>

○

サーバの基本的な定義

ServerName※1、※2

×

ServerAdmin

×

ServerRoot

×

ServerSignature

×

Listen

○

LoadModule

○

LoadFile

○

Include

○

ExtendedStatus

×

ServerTokens

×

FileETag

○

コンテンツを管理するための定義

UserDir

○

DocumentRoot

×

ErrorDocument

○

Webブラウザーからのリクエストについての定義（Alias）

Alias

○

AliasMatch

○

Redirect

○

RedirectMatch

○

MIMEタイプについての定義

TypesConfig

×

AddCharset

○

AddDefaultCharset

×

AddType

○

ForceType

×

HWSErrorDocumentMETACharset

×

コンテントネゴシエーションについての定義

LanguagePriority

○

AddEncoding

○

AddLanguage

○

DefaultLanguage

×

CacheNegotiatedDocs

×

MultiviewsMatch

×

ハンドラーについての定義

AddHandler

○

SetHandler

×

Webサーバの性能についての定義

Timeout

×

RequestReadTimeout

×

ListenBacklog

×

ThreadsPerChild

×

HWSMaxQueueSize

×

SendBufferSize

×

KeepAliveの定義

KeepAlive

×

MaxKeepAliveRequests

×

KeepAliveTimeout

×

リクエストを制限する定義

LimitRequestBody

×

LimitRequestFields

×

LimitRequestFieldsize

×

LimitRequestLine

×

CGI、環境変数の定義

ScriptAlias

○

ScriptAliasMatch

○

UseCanonicalName

×

BrowserMatch

○

BrowserMatchNoCase

○

PassEnv

○

SetEnv

○

UnsetEnv

○

SetEnvIf

○

SetEnvIfNoCase

○

Action

○

Script

○

ScriptInterpreterSource

×

HWSSetEnvIfIPv6

○

ディレクトリーインデックスの表示内容の定義

DirectoryIndex

×

AddIconByEncoding

○

AddIconByType

○

AddIcon

○

DefaultIcon

×

ReadmeName

×

HeaderName

×

IndexIgnore

○

IndexOrderDefault

×

AddAltByEncoding

○

AddAltByType

○

AddAlt

○

AddDescription

○

IndexOptions

○

Webサーバへのアクセスを制御する定義

AccessFileName

×

AllowOverride

×

AuthName

×

AuthType

×

AuthGroupFile

×

AuthUserFile

×

AuthBasicAuthoritative

×

Require

○

Options

×

Order

×

Allow from

○

Deny from

○

Satisfy

×

TraceEnable

×

SSLによる暗号化および認証の定義

SSLRequireSSL

×

SSLEnable

×

SSLDisable※1

×

SSLCertificateFile※2

×

SSLCertificateKeyFile※2

×

SSLCACertificateFile

×

SSLVerifyClient

×

SSLVerifyDepth

×

SSLRequiredCiphers

×

SSLRequireCipher

○

SSLBanCipher

○

SSLDenySSL

×

SSLFakeBasicAuth

×

SSLSessionCacheTimeout

×

SSLSessionCacheSize

×

SSLCRLAuthoritative

×

SSLCRLDERPath

×

SSLCRLPEMPath

×

SSLExportCertChainDepth

×

SSLExportClientCertificates

×

SSLCertificateKeyPassword

×

SSLProtocol

×

Webサーバを運用形態に合わせて複数ホストに見せる定義

ServerAlias

○

ServerPath

×

イメージマップファイルについての定義

ImapDefault

×

ImapBase

×

ImapMenu

×

HWSImapMenuCharset

×

採取するログの定義

HostnameLookups

×

ErrorLog

×

LogLevel

×

LogFormat

○

CustomLog

○

TransferLog

○

PidFile

×

ScriptLog

×

ScriptLogBuffer

×

ScriptLogLength

×

HWSLogSSLVerbose

×

HWSLogTimeVerbose

×

HWSPrfId

×

HWSPrfSpool

×

HWSRequestLog

×

HWSRequestLogType

×

HWSSuppressModuleTrace

○

HWSErrorLogClientAddr

×

採取するトレースの定義

HWSTraceIdFile

×

HWSTraceLogFile

×

リバースプロキシーについての定義

ProxyPass

○

ProxyPassReverse

○

ProxyVia

×

ProxyErrorOverride

×

ProxyPreserveHost

×

ProxyTimeout

×

HWSProxyPassReverseCookie

○

BalancerMember

○

流量制限機能についての定義

QOSCookieDomain

×

QOSCookieExpires

×

QOSCookieName

○

QOSCookieSecure

×

QOSCookieServers

×

QOSRedirect

○

QOSRejectionServers

×

QOSResponse

×

ヘッダーカスタマイズ機能についての定義

Header

○

RequestHeader

○

有効期限設定機能についての定義

ExpiresActive

×

ExpiresByType

○

ExpiresDefault

×

計画停止についての定義

HWSGracefulStopLog

×

HWSGracefulStopTimeout

×

（凡例）

○：指定できる。

×：指定できない。

注※1

Webサーバを起動するために、最低限設定が必要なディレクティブです（SSLを利用しない場合）。

注※2

Webサーバを起動するために、最低限設定が必要なディレクティブです（SSLを利用する場合）。

ディレクティブによっては、記述できる場所が制限されているものがあります。各ディレクティブの記述できる場所については、各ディレクティブの「記述できる場所」に示します。また、ディレクティブの上書きを許可する場合は、AllowOverrideディレクティブで許可レベルを定義する必要があります。各ディレクティブの上書き許可のレベルは、各ディレクティブの「上書きレベル」に示します。

各ディレクティブの「記述できる場所」および「上書き許可」に記載される内容を次に示します。

「記述できる場所」で示される内容

各ディレクティブの記述できる場所は、次のような形式で記載しています。

記述できる場所

説明

httpsd.conf

VirtualHostブロック、Directoryブロック以外のhttpsd.confファイル

<VirtualHost>

httpsd.confファイルのVirtualHostブロック

<Directory>

httpsd.confファイルのDirectoryブロック、Locationブロック、Filesブロック

.htaccess

AccessFileNameディレクティブで指定したアクセス制御ファイル

<Location>

httpsd.confファイルのLocationブロック

また、ディレクティブは次に示す順に参照されます。

VirtualHostブロック、Directoryブロック以外のhttpsd.confファイル

httpsd.confファイルのVirtualHostブロック

httpsd.confファイルのDirectoryブロック

アクセス制御ファイル

httpsd.confファイルのFilesブロック

httpsd.confファイルのLocationブロック

DirectoryブロックのAllowOverrideディレクティブの定義（上書き許可レベル）によって、アクセス制御ファイルで定義しているディレクティブを有効または無効にできます。

「上書き許可」で示される内容

AllowOverrideディレクティブで上書きを許可する場合に、定義する許可レベルを記載しています。

許可レベルの内容は次のとおりです。

AuthConfigレベル

サーバへのアクセス制御関連のディレクティブの上書きを許可します。サーバへのアクセス制御関連のディレクティブには、AuthGroupFile、AuthName、AuthType、AuthUserFile、Requireディレクティブなどが該当します。

FileInfoレベル

コンテンツ管理、MIMEタイプ、暗号化などファイル情報関連のディレクティブの上書きを許可します。ファイル情報関連のディレクティブには、AddType、AddEncoding、AddLanguageディレクティブなどが該当します。

Indexesレベル

ディレクトリーインデックス関連のディレクティブの上書きを許可します。ディレクトリーインデックス関連のディレクティブには、FancyIndexing、AddIcon、AddDescriptionディレクティブなどが該当します。

Limitレベル

ホスト名またはIPアドレスを用いたアクセス制御のディレクティブの上書きを許可します。ホスト名またはIPアドレスを用いたアクセス制御のディレクティブには、Allow from、Deny from、Orderディレクティブが該当します。

Optionsレベル

Optionsディレクティブの上書きを許可します。

Allレベル

すべての上書きを許可します。

Noneレベル

すべての上書きを禁止します。

なお、各ディレクティブの説明で.htaccessが指定でき、かつ上書き許可レベルの記述がない場合には、許可レベルはAllになります。

書式

ディレクティブの記述規則を次に示します。

正規表現

ディレクティブの指定に使用できる正規表現を次に示します。

記号

機能

使用例

使用例の意味

.

任意の1文字。

a...c

aのあとに任意の3文字とcが続く。abcdcは適合する。

*

直前の1文字の0個以上の繰り返し。

ab*cd*

ac、abbbbc、abbbbcdは適合する。

+

直前の1文字の1個以上の繰り返し。

ab*c+

abbbcは適合する。abbbは適合しない。

?

直前の1文字があるかないか。

abbbc?

abbbc、abbbは適合する。

|

選択肢の区切り。

a|bc|d

a、bcまたはd。

¥

直後の特殊文字（. ^$*+?|¥[](){}）の1文字。ただし、¥を表す場合は¥¥¥。

¥.

.と適合する。

¥¥¥

1文字の¥と適合する。

^

行の先頭に適合する。

^ab

abcdeは適合する。

$

行の末尾に適合する。

abc$

aaabcは適合する。

{m}

直前の正規表現のm個の繰り返し。

a{5}

aaaaaが適合する。

{m,}

直前の正規表現のm個以上の繰り返し。

a{3,}

aaa、aaaaは適合する。aaは適合しない。

{m,n}

直前の正規表現のm個以上n個以下の繰り返し。

a{3,5}

aaa、aaaa、aaaaaが適合する。aa、aaaaaaは適合しない。

[文字列]

文字列にある任意の1文字。※

[abc]*または[a-c]*

aaa、bbb、ccc、cba、aabは適合する。

[^文字列]

文字列にない任意の1文字。

[^0-9]

数字以外の1字が適合する。

(文字列)

文字列をグループ化する。

(ab)+

abababが適合する。ababbは適合しない。

aa(xx|yy)bb

aaxxbb、aayybbが適合する。

注※

次の3文字は、[文字列]で特殊な意味を持ちます。

^：[の次に指定して、文字列に含まれないものを示すために用います。

]：文字列の最後を示すために用います。

-：範囲を指定するために用います。

また、これら特殊文字の前の¥は省略されます。

[文字列]で特殊な意味を持つ文字を通常の文字として指定するには、次のようにします。なお、次の4つ以外の特殊文字は、通常の文字として扱われます。

^ ：文字列の先頭以外で指定します。（例）[ab^yz]

]：文字列の先頭に指定します。（例）[]abxy]

-：最後に指定します。（例）[abxy-]

¥：¥¥¥と指定します。（例）[¥¥¥abxy]

ディレクティブに指定するパス情報

ディレクトリー名、ファイル名またはパス名を指定するディレクティブの場合、ディレクティブの種類によって、指定できるパス情報が異なります。

パスの種類には、次のものがあります。各ディレクティブのパス情報は、各ディレクティブで説明します。

絶対パスしか指定できません（ドライブ名を付けた指定も絶対パスに含まれます）。

ServerRootディレクティブの指定値からの相対パスで指定できます（ただし、ServerRootディレクティブの指定が先に必要）。

また、パス情報にネットワーク上のディレクトリーやファイルを指定することはできません。ネットワークを使用したファイルシステム上のディレクトリーやファイルを指定することもできません。

コメント行

設定ファイル中、行の最初に#を付けると、コメント行になります。ただし、ディレクティブを指定したあとに#から始まる文字列を記述しても、#以降をコメントとして扱いません。

コメント行を指定する場合の記述例を次に示します。

正しい例

#Deny from all

#行はコメント行として扱われます。

誤った例

Deny from all    #comment

#commentはディレクティブ指定値として扱われます。コメントとしては扱われません。

格納先

Application Serverのインストールディレクトリー¥httpsd¥conf¥httpsd.conf

記述例

記述例のインストール先は、C:/Hitachi/APServer/httpsdディレクトリーです。

#########################################################################
##
## httpsd.conf - Hitachi Web Server configuration file
##
##  All Rights Reserved. Copyright (C) 2000, 2014, Hitachi, Ltd.
#########################################################################

Listen 80
HWSMaxQueueSize 8192
ThreadsPerChild 50
Timeout 60
KeepAlive On
MaxKeepAliveRequests 100
KeepAliveTimeout 3
HostnameLookups Off

ServerRoot "C:/Hitachi/APServer/httpsd"

ServerName www.example.com
DocumentRoot "C:/Hitachi/APServer/httpsd/htdocs"
#ScriptAlias /cgi-bin/ "C:/Hitachi/APServer/httpsd/cgi-bin/"
DirectoryIndex index.html
UseCanonicalName Off
ServerSignature Off
ServerTokens ProductOnly
TraceEnable Off

LogLevel info
ErrorLog "|¥"¥"C:/Hitachi/APServer/httpsd/sbin/rotatelogs2.exe¥"
 ¥"C:/Hitachi/APServer/httpsd/logs/error¥" 8192 5¥""
#ErrorLog logs/error.log
HWSRequestLog "|¥"¥"C:/Hitachi/APServer/httpsd/sbin/rotatelogs.exe¥"
 ¥"C:/Hitachi/APServer/httpsd/logs/hwsrequest¥" 86400 -fnum 8 -diff 540¥""
#HWSRequestLog logs/hwsrequest.log
LogFormat "%h %l %u %t ¥"%r¥" %>s %b ¥"%{Referer}i¥" ¥"%{User-Agent}i¥" %I %O"
 combinedio
LogFormat "%h %l %u %t ¥"%r¥" %>s %b ¥"%{Referer}i¥" ¥"%{User-Agent}i¥""
 combined
LogFormat "%h %l %u %t ¥"%r¥" %>s %b" common
LogFormat "%{Referer}i -> %U" referer
LogFormat "%{User-agent}i" agent
LogFormat "%h %l %u %t ¥"%r¥" %>s %b %{hws_thread_id}P %{hws_ap_root}n
 %I %O %X %D ¥"%{Referer}i¥" ¥"%{User-Agent}i¥"" hws_trace
LogFormat "%h %l %u %t ¥"%r¥" %>s %b %T %{hws_thread_id}P %{hws_ap_root}n"
 hws_std
HWSLogTimeVerbose On
CustomLog "|¥"¥"C:/Hitachi/APServer/httpsd/sbin/rotatelogs.exe¥"
 ¥"C:/Hitachi/APServer/httpsd/logs/access¥" 86400 -fnum 8 -diff 540¥"" hws_std
#CustomLog logs/access.log hws_std
PidFile logs/httpd.pid
HWSTraceIdFile logs/hws.trcid
HWSTraceLogFile logs/hws.trclog

SSLDisable
#SSLEnable
#SSLCertificateFile "C:/Hitachi/APServer/httpsd/conf/ssl/server/httpsd.pem"
#SSLCertificateKeyFile
 "C:/Hitachi/APServer/httpsd/conf/ssl/server/httpsdkey.pem"
#SSLCertificateKeyPassword
 "C:/Hitachi/APServer/httpsd/conf/ssl/server/.keypasswd"
#SSLCACertificateFile "C:/Hitachi/APServer/httpsd/conf/ssl/cacert/anycert.pem"
#SSLProtocol  SSLv3 TLSv1
#SSLRequiredCiphers RC4-MD5:RC4-SHA:DES-CBC3-SHA:AES128-SHA:AES256-SHA
#SSLVerifyClient 0
#SSLVerifyDepth 3
#SSLSessionCacheTimeout 300
#HWSLogSSLVerbose On

TypesConfig conf/mime.types
AddEncoding x-compress .Z
AddEncoding x-gzip .gz .tgz
AddLanguage ca .ca
AddLanguage cs .cz .cs
AddLanguage da .dk
AddLanguage de .de
AddLanguage el .el
AddLanguage en .en
AddLanguage eo .eo
AddLanguage es .es
AddLanguage et .et
AddLanguage fr .fr
AddLanguage he .he
AddLanguage hr .hr
AddLanguage it .it
AddLanguage ja .ja
AddLanguage ko .ko
AddLanguage ltz .ltz
AddLanguage nl .nl
AddLanguage nn .nn
AddLanguage no .no
AddLanguage pl .po
AddLanguage pt .pt
AddLanguage pt-BR .pt-br
AddLanguage ru .ru
AddLanguage sv .sv
AddLanguage tr .tr
AddLanguage zh-CN .zh-cn
AddLanguage zh-TW .zh-tw
#LanguagePriority ja en ca cs da de el eo es et fr he hr it ko ltz nl nn no pl
 pt pt-BR ru sv tr zh-CN zh-TW

BrowserMatch "Mozilla/2" nokeepalive
BrowserMatch "MSIE 4¥.0b2;" nokeepalive downgrade-1.0 force-response-1.0
BrowserMatch "RealPlayer 4¥.0" force-response-1.0
BrowserMatch "Java/1¥.0" force-response-1.0
BrowserMatch "JDK/1¥.0" force-response-1.0
BrowserMatch "Microsoft Data Access Internet Publishing Provider"
 redirect-carefully
BrowserMatch "MS FrontPage" redirect-carefully
BrowserMatch "^WebDrive" redirect-carefully
BrowserMatch "^WebDAVFS/1.[01234]" redirect-carefully
BrowserMatch "^gnome-vfs/1.0" redirect-carefully
BrowserMatch "^XML Spy" redirect-carefully
BrowserMatch "^Dreamweaver-WebDAV-SCM1" redirect-carefully
BrowserMatch " Konqueror/4" redirect-carefully

Alias /icons/ "C:/Hitachi/APServer/httpsd/icons/"
IndexOptions FancyIndexing
AddIconByEncoding (CMP,/icons/compressed.gif) x-compress x-gzip
AddIconByType (TXT,/icons/text.gif) text/*
AddIconByType (IMG,/icons/image2.gif) image/*
AddIconByType (SND,/icons/sound2.gif) audio/*
AddIconByType (VID,/icons/movie.gif) video/*
AddIcon /icons/binary.gif .bin .exe
AddIcon /icons/binhex.gif .hqx
AddIcon /icons/tar.gif .tar
AddIcon /icons/world2.gif .wrl .wrl.gz .vrml .vrm .iv
AddIcon /icons/compressed.gif .Z .z .tgz .gz .zip
AddIcon /icons/a.gif .ps .ai .eps
AddIcon /icons/layout.gif .html .shtml .htm .pdf
AddIcon /icons/text.gif .txt
AddIcon /icons/c.gif .c
AddIcon /icons/p.gif .pl .py
AddIcon /icons/f.gif .for
AddIcon /icons/dvi.gif .dvi
AddIcon /icons/uuencoded.gif .uu
AddIcon /icons/script.gif .conf .sh .shar .csh .ksh .tcl
AddIcon /icons/tex.gif .tex
AddIcon /icons/bomb.gif core
AddIcon /icons/back.gif ..
AddIcon /icons/hand.right.gif README
AddIcon /icons/folder.gif ^^DIRECTORY^^
AddIcon /icons/blank.gif ^^BLANKICON^^
DefaultIcon /icons/unknown.gif
ReadmeName README.html
HeaderName HEADER.html
IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

<Directory />
        Options None
        AllowOverride None
#       <Limit PUT DELETE>
#               Order deny,allow
#               Deny from all
#       </Limit>
#       SSLRequireSSL
</Directory>

<Directory "C:/Hitachi/APServer/httpsd/htdocs">
        Options None
        AllowOverride None
</Directory>

<FilesMatch "^¥.(ht|key)">
        Order allow,deny
        Deny from all
</FilesMatch>

#<Location /server-status>
#       SetHandler server-status
#       Order deny,allow
#       Deny from all
#       Allow from example.com
#</Location>

#Include "C:/Hitachi/APServer/httpsd/conf/reverse_proxy.conf"
#Include "C:/Hitachi/APServer/httpsd/conf/proxy_balancer.conf"

注意事項

ディレクティブにIPv6アドレスを記述する場合は、「[IPv6アドレス]」のようにIPv6アドレスを[ ]で囲んで指定してください。また、ディレクティブにIPv6アドレスとポート番号を併記する場合は、「[IPv6アドレス]:ポート番号」のようにIPv6アドレスを[ ]で囲み、「:」の後ろにポート番号を指定します。

ただし、次のディレクティブにIPv6アドレスを記述する場合は、IPv6アドレスを[ ]で囲まないで指定してください。

Allow fromディレクティブ

Deny fromディレクティブ

HWSSetEnvIfIPv6ディレクティブ

IPv6アドレスを指定する場合は、グローバルユニキャストアドレスを指定してください。

2.3　httpsd.confに設定する定義項目の詳細

httpsd.confに設定する定義項目について説明しています。

2.3.1　<Directory>

特定のディレクトリーに対してディレクティブを定義する場合に指定します。

説明

特定のディレクトリーに対してディレクティブを定義する場合に指定します。ディレクトリー名にディレクトリー名を指定し、そのディレクトリーとサブディレクトリーだけに有効なディレクティブを定義するブロックを指定できます。

ディレクトリー名は、絶対パスで指定してください。

書式

<Directory ディレクトリー名> ディレクティブ [ディレクティブ ...] </Directory>

記述できる場所

httpsd.conf、<VirtualHost>

記述例

<Directory />                                         ...1.
     Options None                                     ...2.
     AllowOverride None                               ...3.
</Directory>                                          ...4.

<Directory "Application Serverのインストールディレクトリー/httpsd/htdocs">  ...5.
     Options Indexes                                  ...6.
     AllowOverride None                               ...7.
     Order allow,deny                                 ...8.
     Allow from all                                   ...9.
</Directory>                                          ...10.

ルートディレクトリーの定義

機能はすべて無効

すべての上書き禁止

定義終わり

Application Serverのインストールディレクトリー/httpsd/htdocsディレクトリーの定義

ディレクトリーインデックス表示可

すべての上書き禁止

Allowディレクティブの指定をDenyディレクティブの指定より先に評価

すべてのホストからのアクセスを許可

定義終わり

2.3.2　<DirectoryMatch>

正規表現で記述した条件を満たすディレクトリーに対してディレクティブを定義する場合に指定します。

説明

正規表現で記述した条件を満たすディレクトリーに対してディレクティブを定義する場合に指定します。ディレクトリー名を正規表現で指定し、そのディレクトリーとサブディレクトリーだけに有効なディレクティブを定義するブロックを指定できます。

正規表現のディレクトリー名は、絶対パスで指定してください。

書式

<DirectoryMatch 正規表現>・・・</DirectoryMatch>

記述できる場所

httpsd.conf、<VirtualHost>

2.3.3　<Files>

特定のファイルに対してディレクティブを定義する場合に指定します。

説明

特定のファイルに対してディレクティブを定義する場合に指定します。ファイル名にファイル名を指定し、そのファイルだけに有効なディレクティブを定義するブロックを指定できます。

書式

<Files ファイル名> ディレクティブ [ディレクティブ ...] </Files>

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.4　<FilesMatch>

正規表現で記述した条件を満たすファイルに対してディレクティブを定義する場合に指定します。

説明

正規表現で記述した条件を満たすファイルに対してディレクティブを定義する場合に指定します。ファイル名を正規表現で指定し、そのファイルだけに有効なディレクティブを定義するブロックを指定できます。

書式

<FilesMatch 正規表現> ディレクティブ [ディレクティブ ...] </FilesMatch>

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.5　<IfModule>

モジュールの存在有無に対してディレクティブを定義する場合に指定します。

説明

指定したモジュールが組み込まれているとき、ブロック内で指定したディレクティブが有効になります。モジュール名の前に!を付けた場合は、指定したモジュールが組み込まれていないとき、ブロック内で指定したディレクティブが有効になります。ブロック内で指定可能なディレクティブに制限はありません。

モジュール名にLoadModuleディレクティブで組み込まれるモジュールを指定する場合、<IfModule>ディレクティブよりも前に、LoadModuleディレクティブを指定する必要があります。

書式

<IfModule !モジュール名> ディレクティブ [ディレクティブ ...] </IfModule>

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.6　<Limit>

特定のHTTPプロトコルメソッドに対してディレクティブを定義する場合に指定します。

説明

特定のHTTPプロトコルメソッドだけに有効なアクセス制御のディレクティブを定義する場合に指定します。メソッド名は複数指定できます。

指定できるメソッド名

GET、POST、PUT、DELETE、CONNECT、OPTIONS

（HEADはGETに含まれています）

ブロック内に指定できるディレクティブ

Allow from

Deny from

AuthName

AuthType

AuthUserFile

AuthGroupFile

Order

Require

Satisfy

書式

<Limit メソッド名 [メソッド名 ...]> ディレクティブ [ディレクティブ ...] </Limit>

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

記述例

<Directory />
  <Limit PUT DELETE>                    ...1.
    Order deny,allow                    ...2.
    Deny from all                       ...3.
    Allow from .your_domain.com         ...4.
  </Limit>                              ...5.
</Directory>

PUTおよびDELETEメソッドに対する定義

Denyディレクティブの指定を、Allowディレクティブの指定よりも先に評価

すべてのホストからのPUTおよびDELETEメソッドによるアクセスは不可

your_domain.comからのPUTおよびDELETEメソッドによるアクセスを許可

定義終わり

2.3.7　<Location>

特定のURLに対してディレクティブを定義する場合に指定します。

説明

特定のURLで示す場所へのリクエストについて、ディレクティブを定義する場合に指定します。ただし、URLに、?以降（問い合わせ文字列）は指定できません。

書式

<Location URL> ディレクティブ [ディレクティブ ...] </Location>

記述できる場所

httpsd.conf、<VirtualHost>

記述例

  <Location /server-status>             ...1.
       SetHandler server-status         ...2.
       Order deny,allow                 ...3.
       Deny from all                    ...4.
       Allow from .your_domain.com      ...5.
  </Location>                           ...6.

URL /server-statusの定義

このディレクトリーのリクエストはserver-statusハンドラーに関連づける

Denyディレクティブの指定をAllowディレクティブの指定よりも先に評価

すべてのホストからのアクセスは不可

your_domain.comからのアクセスを許可

定義終わり

2.3.8　<LocationMatch>

正規表現で記述した条件を満たすURLへのリクエストに対してディレクティブを定義する場合に指定します。

説明

正規表現で記述した条件を満たすURLへのリクエストについてディレクティブを定義する場合に指定します。ただし、URLに、?以降（問い合わせ文字列）は指定できません。

書式

<LocationMatch 正規表現> ディレクティブ [ディレクティブ ...] </LocationMatch>

記述できる場所

httpsd.conf、<VirtualHost>

2.3.9　<Proxy>

ロードバランサー構成での振り分け先を定義する場合に指定します。

説明

リバースプロキシーをmod_proxy_balancerによるロードバランサー構成で使用する場合に、BalancerMemberディレクティブを定義するために指定します。

URLには、ProxyPassディレクティブで指定したbalancer://で始まるURLと同じ値を指定してください。

重要

このディレクティブを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

mod_proxy_balancerモジュール

LoadModule proxy_balancer_module modules/mod_proxy_balancer.so

mod_lbmethod_byrequestsモジュール

LoadModule lbmethod_byrequests_module modules/mod_lbmethod_byrequests.so

mod_slotmem_shmモジュール

LoadModule slotmem_shm_module modules/mod_slotmem_shm.so

書式

<Proxy URL> ディレクティブ [ディレクティブ ...] </Proxy>

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ProxyPass /examples/ balancer://cluster1/
<Proxy balancer://cluster1/>
        BalancerMember http://IPアドレスA/examples/
        BalancerMember http://IPアドレスB/examples/
</Proxy>

2.3.10　<VirtualHost>

特定のホスト名またはIPアドレスに対してディレクティブを定義する場合に指定します。

説明

ホスト名またはIPアドレス[:ポート番号]で示すホストへのリクエストについてディレクティブを定義する場合に指定します。

なお、IPv6アドレスに対応したホスト名も指定できます。IPアドレスにIPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

書式

<VirtualHost {ホスト名|IPアドレス[:ポート番号]}
 [{ホスト名|IPアドレス[:ポート番号]} ...]>
 ディレクティブ [ディレクティブ ...] </VirtualHost>

記述できる場所

httpsd.conf

記述例

<VirtualHost 172.17.40.30:80>
    :
</VirtualHost>
<VirtualHost [2001::123:4567:89ab:cdef]:80>
    :
</VirtualHost>

2.3.11　AccessFileName

アクセス制御のディレクティブを定義しているファイル（アクセス制御ファイル）のファイル名を定義します。

説明

アクセス制御のディレクティブを定義しているファイル（アクセス制御ファイル）のファイル名を定義します。AllowOverrideディレクティブで許可されていれば、コンテンツリクエスト時に毎回このファイルを参照しアクセス制限がチェックされます。

書式

AccessFileName ファイル名 [ファイル名 ...]

デフォルト値

定義項目の省略

.htaccess

記述できる場所

httpsd.conf、<VirtualHost>

記述例

AccessFileName .htaccess

アクセス制御ファイルのファイル名は、.htaccessです。

2.3.12　Action

特定のMIMEタイプまたはハンドラーで指定したコンテンツに対してCGIスクリプトを実行する場合に指定します。

説明

MIMEタイプまたはハンドラーで指定したコンテンツがWebブラウザーからリクエストされたとき、実行させるスクリプトをCGIスクリプト名で指定します。CGIスクリプト名は、URLで指定します。このディレクティブを複数指定する場合、同じMIMEタイプに異なるCGIスクリプトは指定できません。

書式

Action {MIMEタイプ|ハンドラー} CGIスクリプト名

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

Action image/gif /cgi-bin/images.cgi

2.3.13　AddAlt

ディレクトリーインデックス表示時に、拡張子に関連づけてアイコンの代わりに表示する文字列を指定します。

説明

ディレクトリーインデックス表示時に、拡張子に指定したファイルと関連づけて文字列を表示する場合に指定します。1つの文字列に対して複数の拡張子が指定できます。テキストモードのWebブラウザーのようにアイコン表示ができない環境で、ファイルの属性を表示する場合などに利用できます。

拡張子に指定できるものを次に示します。

ファイル拡張子

ワイルドカード表記のファイル拡張子またはファイル名

ファイル名

このディレクティブを複数指定する場合、同じ拡張子に異なる文字列は指定できません。

書式

AddAlt 文字列 拡張子 [拡張子 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

AddAlt "HTML" htm html

拡張子がhtmまたはhtmlのファイルの場合、文字列"HTML"を表示します。

2.3.14　AddAltByEncoding

ディレクトリーインデックス表示時に、MIMEエンコーディングに関連づけてアイコンの代わりに表示する文字列を指定します。

説明

ディレクトリーインデックス表示時に、アイコンが表示できない環境で、MIMEエンコーディング（x-compressなど）と関連づけて文字列を表示する場合に指定します。1つの文字列に対して複数のMIMEエンコーディングが指定できます。このディレクティブを複数指定する場合、同じMIMEタイプに異なる文字列は指定できません。

書式

AddAltByEncoding 文字列 MIMEエンコーディング [MIMEエンコーディング ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

AddAltByEncoding "gzip" x-gzip

2.3.15　AddAltByType

ディレクトリーインデックス表示時に、MIMEタイプに関連づけてアイコンの代わりに表示する文字列を指定します。

説明

ディレクトリーインデックス表示時に、アイコンが表示できない環境で、MIMEタイプ（text/htmlなど）と関連づけて文字列を表示する場合に指定します。1つの文字列に対して複数のMIMEタイプが指定できます。このディレクティブを複数指定する場合、同じMIMEタイプに異なる文字列は指定できません。

書式

AddAltByType 文字列 MIMEタイプ [MIMEタイプ ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

AddAltByType "plain text" text/plain

2.3.16　AddCharset

ファイル拡張子に対する文字セットを指定します。

説明

ファイル拡張子に対する文字セットを指定します。文字セットはContent-Typeヘッダーにcharset=の値として設定されます。クライアントに対して文字セットを明示する場合に使用します。このディレクティブを複数指定する場合、同じ拡張子に異なる文字列は指定できません。指定する拡張子は、AddTypeディレクティブまたはTypesConfigディレクティブで指定したファイルで、MIMEタイプの関連づけが必要です。

書式

AddCharset 文字セット 拡張子 [拡張子 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddCharset EUC-JP .euc
AddCharset ISO-2022-JP .jis
AddCharset SHIFT_JIS .sjis

2.3.17　AddDefaultCharset

ファイル拡張子に対する文字セットのデフォルト値を指定します。

説明

ファイル拡張子に対する文字セットのデフォルト値を指定します。AddCharsetディレクティブの設定に対するデフォルト値となります。Content-Typeがtext/plain、text/htmlの場合のデフォルトとして設定されます。

書式

AddDefaultCharset [On|Off|文字セット]

指定できる値

On

デフォルト文字セットとしてISO-8859-1を設定します。

Off

文字セットを設定しません。

文字セット

指定した文字セットをデフォルト文字セットとします。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddDefaultCharset ISO-2022-JP

2.3.18　AddDescription

ディレクトリーインデックスの整形表示時に、ファイルに対して表示する説明を指定します。

説明

ディレクトリーインデックス整形表示時に、ファイル名で指定したファイル拡張子、ワイルドカード表記ファイル名またはパス情報なしの完全なファイル名に対して、説明文として文字列を表示する場合に指定します。なお、ファイル名にスラッシュで終わる文字列を指定した場合、*が付けられワイルドカード指定と同様に見なされます。

ファイル名に指定できるものを次に示します。

ファイル拡張子

ワイルドカード表記のファイル名

ファイル名

このディレクティブを複数指定する場合、同じファイル名に異なる文字列は指定できません。

書式

AddDescription "文字列" ファイル名 [ファイル名 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

AddDescription "The planet Mars" /web/pics/mars.gif

2.3.19　AddEncoding

Webサーバ内の圧縮データをWebブラウザーに表示させるときに必要な拡張子と圧縮形式の関連づけを指定します。

説明

Webサーバ内の圧縮データをWebブラウザーに表示させるときに必要な拡張子と圧縮形式の関連づけを指定します。Webブラウザーに圧縮ファイルの展開の情報としてContent-EncodingヘッダーをWebサーバから送信する場合に設定します。このヘッダーを利用した運用は、Webブラウザー側の実装に依存します。このディレクティブを複数指定する場合、同じ拡張子に異なる圧縮形式は指定できません。

書式

AddEncoding 圧縮形式 拡張子

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddEncoding x-compress Z      ...1.
AddEncoding x-gzip gz         ...2.

拡張子がZのファイルの圧縮形式はx-compress

拡張子がgzのファイルの圧縮形式はx-gzip

2.3.20　AddHandler

ハンドラーで処理するファイル拡張子を対応づける場合に定義します。

説明

ハンドラーで処理するファイル拡張子を対応づける場合に定義します。

指定できるハンドラー名を次に示します。このディレクティブを複数指定する場合、同じ拡張子に異なるハンドラー名は指定できません。

cgi-script

CGIスクリプトの実行

imap-file

イメージマップ処理

server-status

ステータスの表示

書式

AddHandler ハンドラー名 拡張子 [拡張子 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddHandler cgi-script .cgi      ...1.
AddHandler imap-file map        ...2.

拡張子.cgiはcgi-scriptハンドラー

拡張子mapはimap-fileハンドラー

2.3.21　AddIcon

ディレクトリーインデックスの整形表示時のアイコンを拡張子と対応づけて表示する場合に指定します。

説明

拡張子などにディレクトリーインデックスのアイコンを対応づけて表示する場合に指定します。文字列には画像表示ができないWebブラウザーの場合に表示する文字を指定します。URLにアイコンの画像ファイルのURLを指定します。自ホスト内の画像ファイルを指定する場合、URLの「http：//IPアドレス」は省略できます。なお、URLの「http：//IPアドレス」を省略しないでIPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

拡張子として指定できるものを次に示します。

ファイル拡張子

ワイルドカード表記のファイル拡張子またはファイル名

ファイル名

拡張子として^^DIRECTORY^^を記述すると、ディレクトリーに対するアイコンを設定できます。また、^^BLANKICON^^と指定すると、ディレクトリーインデックスを表示した場合の、表示内容のヘッダーのインデントを合わせるためのアイコンを設定できます。

このディレクティブを複数指定する場合、同じ拡張子に異なる文字列やURLは指定できません。

書式

AddIcon {(文字列、URL)|URL} 拡張子 [拡張子 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

拡張子が.tarの場合のアイコン定義

AddIcon /icons/tar.gif .tar

拡張子が.html、.shtml、.htm、.pdfの場合のアイコン定義

AddIcon /icons/layout.gif .html .shtml .htm .pdf

拡張子が.txtの場合のアイコン定義

AddIcon /icons/text.gif .txt

親ディレクトリーのアイコン定義

AddIcon /icons/back.gif ..

READMEファイルのアイコン定義

AddIcon /icons/hand.right.gif README

ディレクトリーの場合のアイコン定義

AddIcon /icons/folder.gif ^^DIRECTORY^^

ディレクトリーインデックスのヘッダーのインデントアイコン定義

AddIcon /icons/blank.gif ^^BLANKICON^^

IPv6アドレスを指定する場合のアイコン定義

AddIcon http://[2001::123:4567:89ab:cdef]/icons/text.gif .txt

2.3.22　AddIconByEncoding

ディレクトリーインデックスの整形表示時のアイコンをMIMEエンコーディングと対応づけて表示する場合に指定します。

説明

ディレクトリーインデックスの整形表示時のアイコンをMIMEエンコーディングと対応づけて表示する場合に指定します。文字列には画像表示ができないWebブラウザーの場合に表示する文字を指定します。URLにアイコンの画像ファイルのURLを指定します。自ホスト内の画像ファイルを指定する場合、URLの「http：//IPアドレス」は省略できます。なお、URLの「http：//IPアドレス」を省略しないでIPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

このディレクティブを複数指定する場合、同じMIMEタイプに異なる文字列やURLは指定できません。

書式

AddIconByEncoding {(文字列,URL)|URL} MIMEエンコーディング [MIMEエンコーディング ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

MIMEエンコーディングx-compressおよびx-gzipの場合のアイコン定義

AddIconByEncoding (CMP,/icons/compressed.gif) x-compress x-gzip

2.3.23　AddIconByType

ディレクトリーインデックスの整形表示時のアイコンをMIMEタイプと対応づけて表示する場合に指定します。

説明

ディレクトリーインデックスの整形表示時のアイコンをMIMEタイプと対応づけて表示する場合に指定します。画像表示ができないWebブラウザーの場合に表示する文字は文字列で指定できます。また、URLで表示するアイコンの画像ファイル名の場所を指定できます。なお、URLの「http：//IPアドレス」を省略しないでIPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

このディレクティブを複数指定する場合、同じMIMEタイプに異なるファイル名は指定できません。

書式

AddIconByType {(文字列, URL)|URL} MIMEタイプ [MIMEタイプ ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

MIMEタイプ text/*の場合のアイコン定義

AddIconByType (TXT, /icons/text.gif) text/*

MIMEタイプ image/*の場合のアイコン定義

AddIconByType (IMG, /icons/image2.gif) image/*

MIMEタイプ audio/*の場合のアイコン定義

AddIconByType (SND, /icons/sound2.gif) audio/*

MIMEタイプ video/*の場合のアイコン定義

AddIconByType (VID, /icons/movie.gif) video/*

2.3.24　AddLanguage

ドキュメントで使用する言語を指定します。

説明

ドキュメントで使用する言語を指定します。言語コードはContent-Languageレスポンスヘッダーに設定されます。このディレクティブを指定すると、Webブラウザーの言語設定で言語コードの優先順位（Accept-Languageヘッダー）がリクエストに設定されている場合、Webサーバから送信するコンテンツを選択するコンテントネゴシエーションができます。言語コードはWebブラウザーが送信するヘッダー情報に依存します。基本的には、ISO639に定義されている言語コードに従って指定します。なお、コンテントネゴシエーションを有効にするためには、OptionsディレクティブでMultiViewsオプションを設定しなければなりません。このディレクティブを複数指定する場合、同じ拡張子に異なる言語コードは指定できません。

書式

AddLanguage 言語コード 拡張子

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddLanguage ja .ja                 日本語
AddLanguage en .en                 英語
AddLanguage fr .fr                 フランス語
AddLanguage de .de                 ドイツ語
AddLanguage da .da                 デンマーク語
AddLanguage el .el                 ギリシャ語
AddLanguage it .it                 イタリア語

2.3.25　AddType

TypesConfigディレクティブで指定したファイルに未定義のコンテンツの拡張子とMIMEタイプを関連づけたい場合に指定します。

説明

TypesConfigディレクティブで指定したファイルに未定義のコンテンツの拡張子とMIMEタイプを関連づけたい場合に指定します。このディレクティブを複数指定する場合、同じ拡張子に異なるMIMEタイプは指定できません。

書式

AddType MIMEタイプ 拡張子 [拡張子 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

AddType text/html .shtml

MIMEタイプtext/htmlと拡張子.shtmlを関連づけます。

2.3.26　Alias

ファイルシステムのパスへURLを置き換える場合に指定します。

説明

Webブラウザーからリクエストされた特定のURLを別名に置き換える場合に指定します。ただし、URLには、?以降（問い合わせ文字列）を指定できません。URLで指定されたディレクトリーを、ディレクトリー名で指定したディレクトリーに置き換えて、Webブラウザーに表示します。

次のディレクティブ指定値と重複するURLは指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

Alias /aaa/bbb/ C:/alias/
ProxyPass /aaa/ http://aaa.example.com/

ディレクトリー名は、絶対パスで指定してください。

書式

Alias URL ディレクトリー名

記述できる場所

httpsd.conf、<VirtualHost>

記述例

Alias /icons/ "Application Serverのインストールディレクトリー/httpsd/icons/"

/icons/をApplication Serverのインストールディレクトリー/httpsd/icons/に置き換えます。

2.3.27　AliasMatch

正規表現を使用してファイルシステムのパスへURLを置き換える場合に指定します。

説明

WebブラウザーからリクエストされたURLを別名に置き換える場合に指定します。ただし、URLには、?以降（問い合わせ文字列）を指定できません。

正規表現で記述した条件を満たすURLがWebブラウザーからリクエストされた場合、指定した新パスのコンテンツをWebブラウザーに表示します。正規表現で括弧（）を使用してグループ化している場合、そのi番目のグループの表現にマッチした文字列を、新パスで $iを使用して参照できます。iには1から9までの数字を指定します。

次のディレクティブ指定値と重複する正規表現は指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

AliasMatch ^/aaa/bbb/(.*) C:/alias/$1
ProxyPass /aaa/ http://aaa.example.com/

新パスは、絶対パスで指定してください。また、新パスの文字として、'$'または'&'を含める場合は、その文字の前に'¥'を付加してください。なお、$iを指定する際には、'$'の前に'¥'を付加する必要はありません。

書式

AliasMatch 正規表現 新パス

記述できる場所

httpsd.conf、<VirtualHost>

記述例

AliasMatch ^/html/(.*) "C:/htdocs/html/$1"

"/html/"で始まるリクエストのとき、/html/部分をC:/htdocs/html/に置き換えます。例えば、/html/index.htmlへのアクセスの場合、C:/htdocs/html/index.htmlに置き換えます。

2.3.28　Allow

Webサーバへアクセスできるクライアントを制限する場合に指定します。

説明

Webサーバへアクセスできるクライアントを制限する場合に指定します。ホストにはアクセスを許可するホストのドメイン名、IPアドレス、サブネット、ネットマスクを指定できます。すべてのホストからのアクセスを許可する場合はallを指定します。

また、ホストには、IPv6アドレスに関するドメイン名、アドレスおよびプリフィクス長も指定できます。IPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲まないでください。プリフィクス長は、「IPv6アドレス/プリフィクス長」の形式で指定します。プリフィクス長は10進数で指定してください。

env=環境変数を指定すると、サーバへのアクセスを環境変数で制御できます。BrowserMatch、BrowserMatchNoCase、SetEnvIf、SetEnvIfNoCaseディレクティブとあわせて使用すれば、HTTPリクエストヘッダーフィールドに基づいてアクセスを制限できます。

Allowディレクティブ（アクセス許可）とDenyディレクティブ（アクセス制限）は、Orderディレクティブで評価の順序を設定できます。

ホスト

意味

ドメイン名

ドメイン名で指定したホストからのアクセスを許可する。

IPアドレス

IPアドレスで指定したホストからのアクセスを許可する。

サブネット

サブネット（IPアドレスの最初の1から3バイト）で指定したホストからのアクセスを許可する。

ネットマスク

ネットマスク表記（例:10.1.0.0/255.255.0.0）で指定したホストからのアクセスを許可する。

10.1.0.0/16形式で表記した場合、10.1.0.0/255.255.0.0と同じ意味である。

書式

Allow from {ホスト|all|env=環境変数} [{ホスト|env=環境変数} ...]

記述できる場所

<Directory>、.htaccess

上書き許可

Limitレベル

記述例

（例1）

SetEnvIf User-Agent Mozilla.* access_ok
<Directory /docroot>
    Order deny,allow
    Deny from all
    Allow from env=access_ok
</Directory>

この場合、User-Agentの文字列がMozillaを含むブラウザーからのリクエストだけがアクセスを許可されて、ほかのアクセスは拒否されます。

（例2）

ホストにIPv6アドレスを指定する場合は、次のように指定します。

allow from 2001::123:4567:89ab:cdef

また、プリフィクス長を指定するとき、次の指定はどれも同じ意味となります。

allow from 2001:0:0:89ab::/64
allow from 2001:0:0:89AB::/64
allow from 2001::89ab:0:0:0:0/64
allow from 2001:0000:0000:89ab:0000:0000:0000:0000/64

2.3.29　AllowOverride

AccessFileNameディレクティブで指定したファイルでアクセス情報定義の上書きを許可するかどうかを設定します。

説明

AccessFileNameディレクティブで指定したファイルでアクセス情報定義の上書きを許可するかどうかを設定します。各指示子によって制御できるディレクティブは、各ディレクティブの上書き許可の記述を参照してください。

書式

AllowOverride 指示子 [指示子 ...]

指定できる値

AuthConfig

サーバへのアクセス制御関連のディレクティブの上書きを許可します。サーバへのアクセス制御関連のディレクティブには、AuthGroupFile、AuthName、AuthType、AuthUserFile、Requireディレクティブなどが該当します。

FileInfo

コンテンツ管理、MIMEタイプ、暗号化などファイル情報関連のディレクティブの上書きを許可します。ファイル情報関連のディレクティブには、AddType、AddEncoding、AddLanguageディレクティブなどが該当します。

Indexes

ディレクトリーインデックス関連のディレクティブの上書きを許可します。ディレクトリーインデックス関連のディレクティブには、FancyIndexing、AddIcon、AddDescriptionディレクティブなどが該当します。

Limit

ホスト名またはIPアドレスを用いたアクセス制御のディレクティブの上書きを許可します。ホスト名またはIPアドレスを用いたアクセス制御のディレクティブには、Allow from、Deny from、Orderディレクティブが該当します。

Options

Optionsディレクティブの上書きを許可します。

All

すべての上書きを許可します。

None

すべての上書きを禁止します。

デフォルト値

定義項目の省略

None

記述できる場所

<Directory>

2.3.30　AuthBasicAuthoritative

ユーザー認証をする場合の制御方法を指定します。

説明

ユーザー認証をする場合の制御方法を指定します。

書式

AuthBasicAuthoritative {On|Off}

指定できる値

On

AuthUserFile、AuthGroupFile、Requireディレクティブの設定によるユーザー認証をします。ユーザー未登録またはパスワード不整合の場合は401エラーステータスをWebブラウザーに表示します。

Off

AuthUserFile、AuthGroupFile、Requireディレクティブの設定によるユーザー認証をします。そのとき、パスワード不整合の場合は401エラーステータスをWebブラウザーに表示します。さらに、ユーザー未登録の場合には他製品のモジュール（機能）でユーザー認証をします。

デフォルト値

定義項目の省略

On

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.31　AuthGroupFile

グループでユーザー認証をする場合、認証するグループのリストを格納しているファイル名を指定します。

説明

グループでユーザー認証をする場合、認証するグループのリストを格納しているファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

グループファイルはテキストエディターを使用して次に示すようなフォーマットで作成してください。

グループ名：ユーザー名[ ユーザー名 ...]

任意のグループ名に、ユーザー認証のためのパスワードファイルに登録しているユーザー名を定義します。1行につき1グループで指定します。グループファイルには複数グループを定義できます。同じグループ名の行を複数指定した場合には、同じグループ名に登録されているすべてのユーザー名を含んだ1つのグループが定義されます。

書式

AuthGroupFile ファイル名

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.32　AuthName

ユーザー認証する場合のrealm名（Webブラウザーのユーザー認証画面に表示される）を指定します。

説明

ユーザー認証する場合のrealm名（Webブラウザーのユーザー認証画面に表示される）を指定します。このディレクティブを指定する場合はAuthType、Require、AuthUserFile（またはAuthGroupFile）ディレクティブを必ず指定しなければなりません。ただし、ディレクトリーサービスを利用したユーザー認証を行う場合は、AuthUserFile（またはAuthGroupFile）ディレクティブの指定は必要ありません。

書式

AuthName realm名

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.33　AuthType

ユーザー認証する場合の認証制御のタイプを指定します。

説明

ユーザー認証する場合の認証制御のタイプを指定します。認証タイプ名として"Basic"が指定できます。このディレクティブを指定する場合はAuthName、Require、AuthUserFile（またはAuthGroupFile）ディレクティブを必ず指定しなければなりません。ただし、ディレクトリーサービスを利用したユーザー認証を行う場合は、AuthUserFile（またはAuthGroupFile）ディレクティブの指定は必要ありません。

書式

AuthType 認証タイプ名

指定できる値

Basic

Base64コード変換をします。

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.34　AuthUserFile

ユーザー名でユーザー認証をする場合、認証するユーザー名とパスワードのリストを格納しているファイル名を指定します。

説明

ユーザー名でユーザー認証をする場合、認証するユーザー名とパスワードのリストを格納しているファイル名を指定します。

ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

書式

AuthUserFile ファイル名

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.35　BalancerMember

リバースプロキシーをロードバランサー構成で使用する場合に転送先のURLを指定します。

説明

リバースプロキシーをmod_proxy_balancerによるロードバランサー構成で使用する場合に転送先のURLを定義します。

書式

BalancerMember URL [キー=値 [キー=値 ...]]

指定できる値

URL

転送先のURLを「http://IPアドレス」または「ホスト名[:ポート番号]/」を含む形で指定します。

URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

キー

指定できるキーを次に示します。

キー

意味

loadfactor

リクエストの負荷分散値を指定します。それぞれの転送先に振り分ける比率を、1から100の整数で指定します。

キーが省略された場合のデフォルト値は1です。

route

振り分け先の識別に使用する任意の64バイト未満の文字列を指定します。

このキーを指定する場合は、ProxyPassディレクティブにstickysessionキーの指定も必要です。

timeout

次のバックエンドサーバとの送受信時の待ち時間を指定します。

バックエンドサーバへのリクエスト送信中にデータを送信できなくなった場合の待ち時間

バックエンドサーバへのリクエスト送信後からレスポンス受信までの待ち時間

バックエンドサーバからのレスポンス受信中にデータを受信しなくなった場合の待ち時間

指定できる値は1−65535の範囲です。キーが省略された場合のデフォルト値は、ProxyTimeoutディレクティブ指定値です。

connectiontimeout

バックエンドサーバとの接続時の待ち時間を指定します。

指定できる値は1−65535の範囲です。キーが省略された場合のデフォルト値は、timeoutキー値です。

記述できる場所

<Proxy>

2.3.36　BrowserMatch

Webブラウザーごとに環境変数を設定する場合に指定します。

説明

Webブラウザーごとに環境変数を設定する場合に指定します。設定する値のデフォルト値は1です。環境変数の前に!が付いたときは、その環境変数の設定を解除します。ブラウザー名は正規表現で指定でき、大文字、小文字を区別します。

書式

BrowserMatch "ブラウザー名" 環境変数[=値] [環境変数[=値] ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

記述例

BrowserMatch "Mozilla/2" nokeepalive
BrowserMatch "MSIE 4¥.0b2;" nokeepalive downgrade-1.0 force-response-1.0
BrowserMatch "RealPlayer 4¥.0" force-response-1.0
BrowserMatch "Java/1¥.0" force-response-1.0
BrowserMatch "JDK/1¥.0" force-response-1.0
BrowserMatch "Microsoft Data Access Internet Publishing Provider"
 redirect-carefully
BrowserMatch "^WebDrive" redirect-carefully
BrowserMatch "^WebDAVFS/1.[012]" redirect-carefully
BrowserMatch "^gnome-vfs" redirect-carefully

例で示した環境変数の意味を次に示します。

環境変数

内容

nokeepalive

KeepAlive接続を無効にします。Viaヘッダーがリクエストに付加されている場合は、KeepAlive接続を無効にできません。

downgrade-1.0

HTTP/1.1以上のリクエストを、HTTP/1.0のリクエストとして扱います。

force-response-1.0

HTTP/1.0のリクエストに対して、常にHTTP/1.0のレスポンスを応答します。

redirect-carefully

ディレクトリーへのアクセスでURLの最後に/を付加していなく、かつそれがGETメソッド以外を使用していたとき、クライアントにリダイレクトを要求しません。

2.3.37　BrowserMatchNoCase

Webブラウザーごとに環境変数を設定する場合に指定します。

説明

Webブラウザーごとに環境変数を設定する場合に指定します。設定する値のデフォルト値は1です。環境変数の前に!が付いたときは、その環境変数の設定を解除します。ブラウザー名は正規表現で指定でき、大文字、小文字を区別しません。

書式

BrowserMatchNoCase "ブラウザー名" 環境変数[=値] [環境変数[=値] ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.38　CacheNegotiatedDocs

コンテントネゴシエーションをするリクエストで、クライアント側のキャッシュを有効にするかどうかを指定します。

説明

コンテントネゴシエーションをするリクエストで、クライアント側のキャッシュを有効にするかどうかを指定します。ディレクティブの引数を省略した場合は、Onを指定した場合と同様の動作をします。ディレクティブを設定しない場合は、Offを指定した場合と同様の動作をします。このディレクティブの指定は、HTTP/1.1のリクエストに対しては無効です。

書式

CacheNegotiatedDocs [{On|Off}]

指定できる値

On

キャッシュされるようになります。

Off

Expiresヘッダーが付けられてキャッシュされなくなります。

デフォルト値

定義項目の省略

Off

値の省略

On

記述できる場所

httpsd.conf

2.3.39　CustomLog

任意のフォーマットのログをファイルに出力させる場合に指定します。

説明

任意のフォーマットのログをファイルに出力させる場合に指定します。フォーマットはLogFormatディレクティブで指定するフォーマットと同様です。

このディレクティブを複数指定する場合、同じファイル名は複数指定できません。

書式

CustomLog {ファイル名|パイプ} {"フォーマット"|ラベル名} [env=[!]環境変数]

指定できる値

ファイル名

ログの出力先ファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

パイプ

標準入力からログ情報を受け取るプログラムを"|プログラム名"の形式で指定します。Webサーバはログ情報に含める改行コードをCRLFにして渡します。

パイプで指定されたプログラムは、制御プロセスとWebサーバプロセス用にログ情報を受け取るそれぞれ別のプロセスとして生成されます。これをパイププロセスと呼びます。サービスとしてWebサーバを起動する場合には次の点に注意してください。

制御プロセスのログ情報取得不可

サービスとしてWebサーバを起動した場合には、制御プロセスからのログ情報を受け取るための標準入力はNULデバイスに関連づけられているため、制御プロセス用のパイププロセスは、制御プロセスからのログ情報を受け取ることはできません。制御プロセスからのログ情報とは、Webサーバ起動、停止時のエラーログ情報であり、これらの情報は採取できないことになります。Webサーバ起動後のエラーログ、アクセスログの情報はWebサーバプロセスからのログ情報となりますので、Webサーバプロセス用のパイププロセスで受け取れます。

プログラム作成時の留意点

制御プロセス用のパイププロセスは、NULデバイスからのデータ読み込み処理で、read()のバッファーが小さいと入力データ待ち状態が解除されないことがあります。read()のバッファーを十分大きい値を取るなどしてパイププロセスが入力データ待ち状態にならないようにしてください。

プログラムに引数を指定する場合の注意

プログラム、引数に空白を含む場合には、¥"で囲んでください。

プログラム、引数を¥"で囲む場合には、全体も¥"で囲んでください。

（例）

CustomLog "|
¥"¥"Application Serverのインストールディレクトリー/httpsd/sbin/rotatelogs.exe¥"
¥"Application Serverのインストールディレクトリー/httpsd/logs/access¥" 86400 -diff 540¥""
common

プログラムの引数指定に誤りがある場合の注意

プログラムの引数指定に誤りがある場合、プログラムの起動に失敗しますが、Webサーバは起動します。この場合はログが出力されません。プログラムを指定した場合は、ログファイルが作成され、意図した分割が実施されることを確認してください。

フォーマット

ログフォーマットを指定します。指定できるフォーマット名を次に示します。

表2‒1　フォーマット一覧

フォーマット

意味

%A※1

WebサーバのIPアドレス。

%a※1

クライアントのIPアドレス。

%B

送信バイト数（HTTPヘッダーおよびchunkedエンコーディングによって追加されたデータを除く）。

%b

送信バイト数（HTTPヘッダーおよびchunkedエンコーディングによって追加されたデータを除く）。ただし、0の場合は-（ハイフン）。

%{cookie_name}C

Cookieヘッダー値に含まれるCookie名cookie_nameの値。Cookieヘッダー値に複数のcookie_nameが見つかった場合、すべての値を出力する。

%D

リクエスト処理時間をマイクロ秒で表示。

%{env_name}e

env_nameに指定した環境変数の値。

%f

クライアントが要求したディレクトリーまたはファイル名。

%H

リクエストプロトコル(HTTP/1.0など)。

%h※2

クライアントのホスト名。

%I

リクエストとヘッダーを含む、全受信バイト数。

%{header_name}i

header_nameに指定したリクエストヘッダーの値。

%l

クライアントの識別情報（IdentityCheckディレクティブがOn、かつクライアント上でidentdが動作している場合）。

%m

リクエストメソッド(GET、POSTなど)。

%{note_name}n

note_nameに指定したWebサーバ内モジュールの注記の値。

hws_ap_root：ルートアプリケーション情報

hws_ap_client：クライアントアプリケーション情報

%O

ヘッダーを含む、全送信バイト数。

%{header_name}o

header_nameに指定したレスポンスヘッダーの値。

%P

HTTP通信のリクエストを処理するプロセスID。

%{hws_thread_id}P

HTTP通信のリクエストを処理するスレッドID。

%p

ServerNameディレクティブまたは<VirtualHost>の指定に従ったサーバのポート番号。

%q

問い合わせ文字列。

%r

HTTP通信のリクエストの先頭行。

%s

ステータス（内部リダイレクトされた場合はオリジナルを示す）。

%T

リクエスト処理に掛かった時間（秒）。HWSLogTimeVerboseディレクティブでOnを指定すると、ミリ秒単位まで表示。

%t

リクエスト処理を開始した時刻。HWSLogTimeVerboseディレクティブでOnを指定すると、ミリ秒単位まで表示。

%{format}t

リクエスト処理を開始した時刻。strftime()で定義されているフォーマットをformatに指定する。

%U

URL。

%u

クライアントのユーザー名（ユーザー認証をした場合）。

%V※2

UseCanonicalNameディレクティブの指定に従い、ServerNameディレクティブ指定値、サーバ名またはIPアドレス。

%v

サーバ名。

%X

レスポンス完了時の接続ステータス。

+：レスポンス送信後も接続を維持する。

−：レスポンス送信後に接続を切断する。

×：レスポンス完了前に接続を切断する。

%>s

最終ステータス。

注

フォーマットで示す{ }は選択を意味するものではありません。{ }内の太字はログを採取する変数名を、細字は文字列そのままを記述します。

注※1

フォーマットに%Aまたは%aを指定した場合、IPv6アドレスも出力できます。

注※2

フォーマットに%hまたは%Vを指定した場合、IPv6アドレスに対応したホスト名またはIPv6アドレスも出力できます。

表2‒2　SSL関連のログフォーマット一覧

フォーマット

意味

%{version}c

SSLのバージョン。

%{cipher}c

現在の通信で使用している暗号種別。

%{clientcert}c

SSLクライアント証明書のsubjectのDistinguished Name。

フォーマットの%の後ろにステータスコードを記述できます。

（例）エラーステータスコード400および501の場合、User-Agentリクエストヘッダー値のログを採取する。

 %400,501{User-Agent}i

（例）エラーステータスコード200、304および302の3種類以外の場合、Refererリクエストヘッダー値のログを採取する。

%!200,304,302{Referer}i

また、env=は、指定した環境変数の設定によって、ログの採取を分ける場合に指定します。

（例）gifへのアクセスはgif.logに、gif以外へのアクセスはnongif.logにログを採取する。

SetEnvIf Request-URI ¥.gif$ gif-image
CustomLog logs/gif.log common env=gif-image
CustomLog logs/nongif.log common env=!gif-image

ラベル名

LogFormatディレクティブで定義したラベル名を指定します。

env=環境変数

指定した環境変数が設定されている場合に、ログを採取します。

env=!環境変数

指定した環境変数が設定されていない場合に、ログを採取します。

記述できる場所

httpsd.conf、<VirtualHost>

記述例

CustomLog logs/access.log common
CustomLog logs/ssl.log "%t %{version}c %{cipher}c %{clientcert}c"

2.3.40　DefaultIcon

ディレクトリーインデックスで特定のアイコンが設定されていない場合に表示するアイコンを指定します。

説明

ディレクトリーインデックスで表示するアイコンを指定します。AddIcon、AddIconByTypeおよびAddIconByEncodingディレクティブのどれにも該当しない場合に表示するアイコンのURLを指定します。なお、URLの「http：//IPアドレス」を省略しないでIPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

書式

DefaultIcon URL

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

DefaultIcon /icons/unknown.gif

2.3.41　DefaultLanguage

ドキュメントで使用するデフォルトの言語を指定します。

説明

ドキュメントで使用するデフォルトの言語を指定します。指定した言語コードはContent-Languageレスポンスヘッダーに設定されます。AddLanguageディレクティブの設定に対するデフォルト値となります。デフォルト値が設定されていない場合、Content-Languageレスポンスヘッダーは送信しません。

書式

DefaultLanguage 言語コード

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.42　Deny

Webサーバへアクセスできるクライアントを制限する場合に指定します。

説明

Webサーバへアクセスできるクライアントを制限する場合に指定します。ホストにはアクセスを禁止するホストのドメイン名、IPアドレス、サブネット、ネットマスクを指定できます。すべてのホストからアクセスを禁止する場合は、allを指定します。

また、ホストには、IPv6アドレスに関するドメイン名、アドレスおよびプリフィクス長も指定できます。IPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲まないでください。プリフィクス長は、「IPv6アドレス/プリフィクス長」の形式で指定します。プリフィクス長は10進数で指定してください。

env=環境変数を指定すると、サーバへのアクセスを環境変数で制御できます。BrowserMatch、BrowserMatchNoCase、SetEnvIf、SetEnvIfNoCaseディレクティブとあわせて使用すれば、HTTPリクエストヘッダーフィールドに基づいてアクセスを制限できます。

Allowディレクティブ（アクセス許可）とDenyディレクティブ（アクセス制限）は、Orderディレクティブで評価の順序を設定できます。

ホスト

意味

ドメイン名

ドメイン名で示すホストからのアクセスを禁止する。

IPアドレス

IPアドレスで示すホストからのアクセスを禁止する。

サブネット

サブネット（IPアドレスの最初の1から3バイト）で指定したホストからのアクセスを禁止する。

ネットマスク

ネットマスク表記（例：10.1.0.0/255.255.0.0）で指定したホストからのアクセスを禁止する。

10.1.0.0/16形式で表記した場合10.1.0.0/255.255.0.0と同じ意味である。

書式

Deny from {ホスト|all|env=環境変数} [{ホスト|env=環境変数} ...]

記述できる場所

<Directory>、.htaccess

上書き許可

Limitレベル

2.3.43　DirectoryIndex

Webブラウザーからのリクエストが特定のコンテンツを指定していない場合に、デフォルトとしてクライアントに送信するコンテンツのファイルを指定します。

説明

Webブラウザーからのリクエストが特定のコンテンツを指定していない場合に、デフォルトとしてクライアントに送信するコンテンツのファイル名を指定します。ファイル名を複数指定した場合は、先に指定したファイル名を優先して送信します。

ここで指定したファイルがリクエストされたディレクトリーにない場合、Optionsディレクティブの指定によってWebブラウザーの表示が変わります。

Indexesが有効の場合

WebブラウザーにWebサーバで作成したディレクトリーのインデックスを表示します。

Indexesが無効の場合

ステータスコード403 Forbiddenを応答します。

書式

DirectoryIndex ファイル名 [ファイル名 ...]

デフォルト値

定義項目の省略

index.html

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

DirectoryIndex index.html

ファイル名の指定がないリクエストの場合、ディレクトリーにindex.htmlがあれば表示させます。

2.3.44　DocumentRoot

コンテンツを格納するドキュメントルートディレクトリーを指定します。

説明

コンテンツを格納するドキュメントルートディレクトリーを絶対パスで指定します。ディレクトリー名の終端にはスラッシュ（/）を記述しないでください。

ディレクトリー名は、絶対パスで指定してください。

書式

DocumentRoot ディレクトリー名

デフォルト値

定義項目の省略

ServerRootディレクティブのデフォルト値/htdocs

記述できる場所

httpsd.conf、<VirtualHost>

記述例

DocumentRoot Application Serverのインストールディレクトリー/httpsd/htdocs

2.3.45　ErrorDocument

エラーが発生したときに、Webブラウザーへ表示するメッセージをカスタマイズする場合に指定します。

説明

エラーが発生したときに、Webブラウザーへ表示するメッセージをカスタマイズする場合に指定します。

テキスト

文字列を""で囲み指定します。

ローカルURL

先頭に/を記述して、自サイト内のコンテンツを指定します。

フルURL

「http://」または「https://」で始まるURLを記述し、他サイトのコンテンツを指定します。

このディレクティブに指定できるエラーステータス番号と、テキスト、ローカルURL、フルURLの指定可否について、次に示します。

エラーステータス番号（意味）

テキスト

ローカルURL

フルURL

400 (Bad Request)

○

×

×

401 (Authorization Required)

○

○

×

403 (Forbidden)

○

○

○

404 (Not Found)

○

○

○

405 (Method Not Allowed)

○

○

○

406 (Not Acceptable)

○

○

○

408 (Request Time-out)

×

×

×

410 (Gone)

○

○

○

411 (Length Required)

○

×

×

412 (Precondition Failed)

○

○

○

413 (Request Entity Too Large)

○

○

○

414 (Request-URI Too Large)

○

×

×

416 (Requested Range Not Satisfiable)

○

○

○

417 (Expectation Failed)

○

×

×

500 (Internal Server Error)

○

○

○

501 (Method Not Implemented)

○

○

○

502 (Bad Gateway)

○

○

×

503 (Service Temporarily Unavailable)

○※

○※

○※

506 (Variant Also Negotiates)

○

○

○

（凡例）

○：指定できる。

×：指定できない。

注※

流量制限機能が返すメッセージをカスタマイズする場合は、QOSResponseディレクティブまたはQOSRedirectディレクティブを使用してください。

このディレクティブ指定時には、次の点に留意してください。

このディレクティブを複数指定する場合、同じエラー番号に異なる指定はできません。

CGIプログラム内で設定されたエラーステータスに対しては、メッセージをカスタマイズできません。

ローカルURL、フルURLの指定先でエラーとなる場合は、カスタマイズできません。

ローカルURLの指定先でコンテントネゴシエーションが発生する場合は、エラーとなりカスタマイズできないことがあります。

LoadModuleディレクティブによって動的に接続したモジュール内で設定されたエラーステータスに対しても、そのモジュールの実装方法によってメッセージをカスタマイズできない場合があります。

フルURLの指定時には、ステータスコード302 FoundおよびLocationヘッダーに新パスを設定した応答を返します。通常、ステータスコード302を受けたWebブラウザーは、Locationヘッダーに指定されたアドレスに対して自動的にリダイレクトします。

フルURLの指定時には、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。IPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。

書式

ErrorDocument エラーステータス番号 {テキスト|ローカルURL|フルURL}

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

ErrorDocument 500 "Server Error."
ErrorDocument 404 /missing.html
ErrorDocument 403 http://some.other_server.com/subscription_info.html
ErrorDocument 404 http://[2001::123:4567:89ab:cdef]/missing.html

2.3.46　ErrorLog

エラーログの出力先を指定します。

説明

エラーログを出力するファイル名を指定します。出力するログの内容は、LogLevelディレクティブで選択できます。

ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

ファイル名

エラーログを格納するファイル名を指定します。ServerRootディレクティブ指定値からの相対パスで指定できます。

パイプ

標準入力からエラーログ情報を受け取るプログラムを"|プログラム名"の形式で指定します。

書式

ErrorLog {ファイル名|パイプ}

デフォルト値

定義項目の省略

logs/error.log

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ErrorLog logs/error.log

2.3.47　ExpiresActive

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加するかどうかを指定します。

説明

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加するかどうかを指定します。

重要

このディレクティブを使用するにはmod_expiresモジュールの組み込みが必要です。

LoadModule expires_module modules/mod_expires.so

ExpiresDefaultディレクティブまたはExpiresByTypeディレクティブを指定していない場合は、ExpiresActiveディレクティブにOnが指定されていても、レスポンスにExpiresヘッダーおよびCache-Controlヘッダーは追加されません。

書式

ExpiresActive {On|Off}

指定できる値

On

ExpiresヘッダーおよびCache-Controlヘッダーを追加します。

Off

ExpiresヘッダーおよびCache-Controlヘッダーを追加しません。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.48　ExpiresByType

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合の、MIMEタイプのドキュメントに対する有効期限を指定します。

説明

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合に、指定するMIMEタイプのドキュメントに対する有効期限を指定します。このディレクティブはExpiresActiveディレクティブでOnを指定している場合に有効になります。ExpiresDefaultディレクティブで設定されたデフォルトの有効期限は、この設定によってMIMEタイプ別に上書きされます。

基準時刻をAまたはMで指定し、基準時刻から有効期限までの時間を秒単位で指定します。AまたはMと、時間との間に空白は入りません。

A

クライアントがアクセスした時刻を基準時刻とします。

M

ファイルを最後に修正した時刻を基準時刻とします。

重要

このディレクティブを使用するにはmod_expiresモジュールの組み込みが必要です。

LoadModule expires_module modules/mod_expires.so

グリニッジ標準時（GMT）の2038年1月19日3時14分7秒を超えないように、有効期限を設定してください。

書式

ExpiresByType MIMEタイプ {A|M}時間

指定できる値

0〜2147483647

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

ExpiresByType text/html A604800

2.3.49　ExpiresDefault

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合に、デフォルトの有効期限を指定します。

説明

レスポンスにExpiresヘッダーおよびCache-Controlヘッダーを追加する場合に、デフォルトの有効期限を指定します。このディレクティブはExpiresActiveディレクティブでOnを指定している場合に有効になります。この設定はExpiresByTypeディレクティブによってMIMEタイプごとに上書きされます。

基準時刻をAまたはMで指定し、基準時刻から有効期限までの時間を秒単位で指定します。AまたはMと、時間との間に空白は入りません。

A

クライアントがアクセスした時刻を基準時刻とします。

M

ファイルを最後に修正した時刻を基準時刻とします。

重要

このディレクティブを使用するにはmod_expiresモジュールの組み込みが必要です。

LoadModule expires_module modules/mod_expires.so

グリニッジ標準時（GMT）の2038年1月19日3時14分7秒を超えないように、有効期限を設定してください。

書式

ExpiresDefault {A|M}時間

指定できる値

0〜2147483647

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

ExpiresDefault A604800

2.3.50　ExtendedStatus

ステータス情報表示で、それぞれのリクエストの拡張ステータス情報を表示するかどうかを指定します。

説明

server-statusハンドラーによるステータス表示形式で、それぞれのリクエストの拡張ステータス情報を表示するかどうかを指定します。

書式

ExtendedStatus {On|Off}

指定できる値

On

拡張ステータス情報を表示します。この場合、クライアントのIPアドレスがIPv6アドレスでも表示します。ただし、最大表示数は31バイトです。

Off

拡張ステータス情報を表示しません。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf

2.3.51　FileETag

ETagレスポンスヘッダーフィールドを作成するために使用されるファイルの属性値を指定します。

説明

ETagレスポンスヘッダーフィールドを作成するために使用されるファイル属性値を指定します。このディレクティブが指定されていない場合、ETagレスポンスヘッダーフィールドにはファイルの最終更新時刻およびバイト数が設定されます。

オプションに+-を指定しない場合は、オプションで指定した属性値が使用されます。

オプションに+-を指定する場合は、FileETagディレクティブによって設定された属性値を変更できます。

+

設定されている属性値にオプションで指定した属性値が追加されます。

-

設定されている属性値からオプションで指定した属性値が削除されます。

指定できるオプションの一覧を次に示します。

オプション

意味

Inode

ファイルに割り振られた一意なIDが含まれます。

Mtime

ファイルの最終更新時刻が含まれます。

Size

ファイルのバイト数が含まれます。

All

Inode、Mtime、Sizeのオプションがすべて有効になります。

None

Etagヘッダーが付きません。

重要

FileETagディレクティブのInodeオプションを有効にした場合、負荷分散をしているWebサーバ環境などで、同一のコンテンツを要求するごとに、異なるIDEtagがヘッダーに含まれることがあります。このため、同一コンテンツでありながらそのEtagヘッダーの内容が異なり、ブラウザーやプロキシーでのキャッシングにとって不都合となることがあります。この場合、FileETagディレクティブによって、Inodeオプションを無効にするように指定することで回避できます。

+-を使用しないでこのディレクティブを複数指定すると、最後に指定したディレクティブだけが有効になります。

-を付加した属性値だけを指定した場合は、Allオプションを指定した場合と同じ動作になります。

AllオプションとNoneオプションには、+-を指定できません。

オプションに'-Inode -Mtime -Size'と指定した場合は、このディレクティブを指定していない場合と同じ状態になります。ETagレスポンスヘッダーフィールドにはファイルのinode番号、最終更新時刻およびバイト数が設定されます。

書式

FileETag [{+|-}]オプション [[{+|-}]オプション ...]

デフォルト値

定義項目の省略

MTime Size

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

（例1）

FileETag Inode Mtime Size
FileETag -Inode

この指定では、ファイルの最終更新時刻およびバイト数が属性値として使用されます。

（例2）

FileETag Inode Mtime
FileETag Size

この指定では、ファイルのバイト数が属性値として使用されます。

（例3）

FileETag All
FileETag -Inode -Mtime -Size

この指定では、ファイルの一意なID、最終更新時刻およびバイト数が属性値として使用されます。

2.3.52　ForceType

特定のディレクトリー下のすべてのコンテンツに対して使用するMIMEタイプを指定します。

説明

<Directory>ブロックまたはアクセス制御ファイルに定義し、特定のディレクトリー下のすべてのコンテンツに対して使用するMIMEタイプを指定します。noneを指定すると、それまでのForceTypeディレクティブの指定が無効になります。

書式

ForceType MIMEタイプ

記述できる場所

<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.53　Header

200番台のステータスコード応答時のレスポンスヘッダーをカスタマイズする場合に指定します。

説明

200番台のステータスコード応答時のレスポンスヘッダーをカスタマイズする場合に指定します。リバースプロキシーとして使用する場合、バックエンドのWebサーバが返すステータスコードの値に関係なく、レスポンスヘッダーをカスタマイズします。

なお、レスポンスヘッダーをカスタマイズするにはmod_headersモジュールの組み込みが必要です。

LoadModule headers_module modules/mod_headers.so

書式

Header{{set|append|add}ヘッダー ヘッダー値[env=[!]環境変数]|unset ヘッダー}

指定できる値

set

ヘッダーを設定します。ヘッダーがある場合は、指定したヘッダー値に書き換えます。

append

存在するヘッダーにヘッダー値を追加します。存在するヘッダー値との間は、コンマで区切られます。ヘッダーがない場合は、ヘッダーを設定します。

add

ヘッダーがあっても、別の行にヘッダーを設定します。同じヘッダーを複数行設定する場合に使用します。

unset

指定したヘッダーがある場合、そのヘッダーをすべて削除します。

env=環境変数

指定した環境変数が設定されている場合に、Headerディレクティブで指定した内容を実行します。

env=!環境変数

指定した環境変数が設定されていない場合に、Headerディレクティブで指定した内容を実行します。

ヘッダー値

文字だけから成る文字列、フォーマット指示子を含む文字列または両方から成る文字列を指定できます。

ヘッダー値に空白がある場合は、"（ダブルクォーテーション）で囲む必要があります。

フォーマット指示子を次に示します。

フォーマット

意味

%t

リクエストを受け取った時刻を、1970年1月1日0時0分0秒（GMT：Greenwich Mean Time）から経過した時間で表示する。単位はマイクロ秒。先頭には"t="が付けられる。

%D

リクエスト処理に掛かった時間を表示する。単位はマイクロ秒。先頭には"D="が付けられる。

%{env_name}e

環境変数env_nameの値。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

Header set Cache-Control no-cache

2.3.54　HeaderName

ディレクトリーインデックス表示時のヘッダーに付けるコメントを記述したファイルを指定します。

説明

ディレクトリーインデックス表示時のヘッダーに付けるコメントを記述したファイルのファイル名（パス情報なし）を指定します。HTMLまたはプレーンテキストで記述できます。ただし、AddTypeディレクティブまたはTypesConfigディレクティブで指定したファイルで、MIMEタイプが正しく定義されている必要があります。プレーンテキストでコメントを作成した場合、ディレクトリーインデックス表示のHTMLには<PRE>タグが追加されます。

書式

HeaderName ファイル名

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

HeaderName HEADER.html

各ディレクトリー下のHEADER.htmlの内容をヘッダーに付けます。

2.3.55　HostnameLookups

ホスト名のルックアップの逆引きをするかどうかを指定します。

説明

CGIのREMOTE_HOST環境変数のIPアドレスおよびログファイルに出力するクライアントのIPアドレスをホスト名に変換するために、ホスト名のルックアップの逆引きをするかどうかを指定します。なお、逆引きを使用する場合、レスポンスが遅くなります。

このディレクティブは、IPv6アドレスにも対応しています。

書式

HostnameLookups {On|Off|double}

指定できる値

On

IPアドレスをホスト名に変換します。

Off

IPアドレスをホスト名に変換しません。

double

IPアドレスをホスト名に変換します。その後、再変換し、IPアドレスが正しいかどうかを確認します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>

記述例

HostnameLookups Off

IPアドレスをホスト名に変換しません。

2.3.56　HWSErrorDocumentMETACharset

エラーが発生したときにWebブラウザーへ表示するメッセージに対応した文字セットを指定します。

説明

エラーが発生したときにWebブラウザーへ表示するメッセージ（以降、エラードキュメントと呼びます）についての文字セットを設定します。文字セットは、エラードキュメント中にMETAタグでcharset=の値として設定されます。ErrorDocument ディレクティブで、カスタマイズされたエラードキュメントは、このディレクティブのMETAタグによる文字セットの設定対象とはなりません。

書式

HWSErrorDocumentMETACharset {On|Off|文字セット}

指定できる値

On

文字セットISO-8859-1を設定します。

Off

文字セットを設定しません。

文字セット

指定した文字セットを設定します。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf

記述例

HWSErrorDocumentMETACharset ISO-2022-JP

2.3.57　HWSErrorLogClientAddr

エラーログに出力するクライアントアドレスをX-Forwarded-Forヘッダー値に変更する場合に指定します。

説明

バックエンドサーバで、エラーログに出力するメッセージテキストの"[client クライアントアドレス:ポート番号] "を"[X-Forwarded-For X-Forwarded-Forヘッダー値] "に変更するよう設定します。

ロードバランサーやプロキシーサーバを介してバックエンドサーバがリクエストを受信すると、バックエンドサーバがエラーログに出力する「クライアントIPアドレス:ポート番号」がリクエストを送信したクライアントのIPアドレスではなく、ロードバランサーやプロキシーサーバのIPアドレスになる場合があります。ただし、ロードバランサーやプロキシーサーバの中には接続元のクライアントIPアドレスをX-Forwarded-Forヘッダーに付加する場合があるため、出力内容をX-Forwarded-For X-Forwarded-Forヘッダーの値へ変更することで、接続元のクライアントIPアドレスが出力されるようにします。

注意事項

X-Forwarded-Forヘッダーを受信する前にエラーが発生した場合や、一部のメッセージでは変更できません。

書式

HWSErrorLogClientAddr X-Forwarded-For

指定できる値

X-Forwarded-For

エラーログに出力する"[client クライアントアドレス:ポート番号] "を"[X-Forwarded-For X-Forwarded-Forヘッダー値] "に変更します。

記述できる場所

httpsd.conf

2.3.58　HWSGracefulStopLog

計画停止時に強制停止させたリクエスト情報をエラーログファイルに出力するかどうかを指定します。

説明

計画停止時に、強制停止待ち時間を経過したあとに強制停止させたリクエスト情報を、エラーログファイルに出力するかどうかを指定します。

書式

HWSGracefulStopLog {On|Off}

指定できる値

On

強制停止させたリクエスト情報をエラーログファイルに出力します。

Off

強制停止させたリクエスト情報をエラーログファイルに出力しません。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf

記述例

HWSGracefulStopLog On

2.3.59　HWSGracefulStopTimeout

計画停止時に実行中のリクエストを強制的に終了させるまでの待ち時間を指定します。

説明

計画停止時に、実行中のリクエストを直ちに終了するまでの強制停止待ち時間を秒単位で指定します。なお、0を指定すると、強制停止待ち時間の上限は設定されません。

書式

HWSGracefulStopTimeout 強制停止時間

指定できる値

0−3600

デフォルト値

定義項目の省略

300

記述できる場所

httpsd.conf

記述例

HWSGracefulStopTimeout 600

2.3.60　HWSImapMenuCharset

メニュー表示に対する文字セットを指定します。

説明

次の場合のメニュー表示に対する文字セットを指定します。

イメージマップファイルの指定値にmapを指定した場合

イメージマップ画像の座標(0,0)をマウスでポイントした場合

座標指定のない形でイメージマップファイルがリクエストされた場合

文字セットは、レスポンスのContent-Typeヘッダーでcharset=の値として設定されます。

書式

HWSImapMenuCharset 文字セット

デフォルト値

定義項目の省略

ISO-8859-1

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

HWSImapMenuCharset SHIFT_JIS

2.3.61　HWSLogSSLVerbose

SSLハンドシェイク処理中にログに出力されるエラーの詳細情報を表示するかどうかを指定します。

説明

クライアントとサーバ間のSSLハンドシェイク処理中に、ログに出力されるエラーのうちinfoレベルおよびerrorレベルのエラーについて、詳細情報を表示するかどうかを指定します。SSLを有効にする場合には、このディレクティブをOnに設定することを推奨します。

書式

HWSLogSSLVerbose {On|Off}

指定できる値

On

詳細情報を表示します。

Off

詳細情報を表示しません。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf

2.3.62　HWSLogTimeVerbose

ログに出力する時間をミリ秒まで表示するかどうかを指定します。

説明

エラーログ※とリクエストログの時刻、アクセスログのアクセス時刻、リクエスト処理に掛かった時間（%T）、およびリクエスト処理を開始した時刻（%t）をミリ秒まで表示するかどうかを指定します。

なお、起動および再起動中に出力されるメッセージでは、このディレクティブでOnを指定してもミリ秒まで表示されない場合があります。

注※

ErrorLogディレクティブで指定するエラーログが対象になります。ScriptLogディレクティブで指定するCGIスクリプトのエラーログは対象になりません。

書式

HWSLogTimeVerbose {On|Off}

指定できる値

On

時刻および時間をミリ秒まで表示します。

Off

時刻および時間を秒まで表示します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf

2.3.63　HWSMaxQueueSize

クライアントからのリクエストについての最大待ちリクエスト数を指定します。

説明

クライアントからのリクエストについての最大待ちリクエスト数を指定します。0を指定した場合は、無制限となります。このディレクティブで指定したリクエストキューサイズを超えたクライアントからのリクエストは、サーバ側で切断されます。

書式

HWSMaxQueueSize リクエストキューサイズ

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

8192

記述できる場所

httpsd.conf

2.3.64　HWSPrfId

PRFデーモン起動時にPRF識別子に指定した文字列を指定します。

説明

PRFデーモン起動時にPRF識別子に指定した文字列を指定します。

書式

HWSPrfId 文字列

デフォルト値

定義項目の省略

PRF_ID

記述できる場所

httpsd.conf

2.3.65　HWSPrfSpool

PRFデーモンを使用するときに必要なPRFSPOOL環境変数に設定するディレクトリー名を指定します。

説明

PRFデーモンを使用するときに必要なPRFSPOOL環境変数に設定するディレクトリー名を指定します。

書式

HWSPrfSpool ディレクトリー名

記述できる場所

httpsd.conf

2.3.66　HWSProxyPassReverseCookie

リバースプロキシー使用時に、バックエンドサーバから受信したSet-Cookieヘッダーを変換する場合に指定します。

説明

リバースプロキシーを使用する場合、リバースプロキシーはバックエンドサーバから受信したSet-Cookieヘッダーを変換します。これは、WebブラウザーがSet-Cookieヘッダーを受信したあとに、リバースプロキシーを経由するバックエンドサーバへのリクエストに対して、Cookieを送信させるために必要になります。

パス名

ProxyPassディレクティブと同じパス名を指定します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

HWSProxyPassReverseCookie パス名

記述できる場所

httpsd.conf、<VirtualHost>

2.3.67　HWSRequestLog

リクエストログの出力先を指定します。

説明

リクエストログを出力するファイル名を指定します。リクエストログとは、モジュールトレース、リクエストトレース、I/Oフィルタートレースおよびプロキシートレースの総称です。出力するリクエストログの種別は、HWSRequestLogTypeディレクティブで選択できます。

重要

このディレクティブを省略した場合のモジュールトレース出力先は、ErrorLogディレクティブで指定したファイルになります。モジュールトレースの採取レベルは、LogLevelディレクティブで指定してください。

リクエストトレース、I/Oフィルタートレースおよびプロキシートレースの出力先を、ErrorLogディレクティブで指定したファイルにすることはできません。

書式

HWSRequestLog {ファイル名|パイプ}

指定できる値

ファイル名

リクエストログを出力するファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスを指定できます。

パイプ

標準入力からリクエストログ情報を受け取るプログラムを「 |プログラム名」の形式で指定します。

記述できる場所

httpsd.conf

2.3.68　HWSRequestLogType

リクエストログに出力するトレース種別を指定します。

説明

HWSRequestLogディレクティブで設定するリクエストログに出力するトレース種別を指定します。トレース種別を次に示します。

書式

HWSRequestLogType トレース種別 [トレース種別 ...]

指定できる値

指定できるトレース種別を次に示します。

module-debug

内部モジュールに対するモジュールトレースおよびmodule-info相当のトレースを出力します。ただし、出力量が多いため、デバッグ目的以外では指定しないでください。

module-info

外部モジュールとCGIプログラム実行時のモジュールトレースを出力します。

request

リクエスト処理開始時およびリクエスト処理完了時にトレースを出力します。また、KeepAlive接続の場合は、次のリクエストライン受信完了時にもトレースを出力します。これらのトレースをリクエストトレースと呼びます。

filter

モジュールが実装している入出力フィルター関数の実行契機を示すI/Oフィルタートレースを出力します。ただし、出力量が多いため、デバッグ目的以外では指定しないでください。

proxy

プロキシー機能使用時にプロキシーに関するトレースを出力します。

send-wait

一時的に送信処理ができないときの待機開始時と待機終了時にトレースを出力します。ただし、出力量が多いため、送信性能の調査目的以外では指定しないでください。

none

リクエストログを採取しません。

重要

指定したトレース種別にnoneが含まれている場合、リクエストログを一切採取しません。

デフォルト値

定義項目の省略

module-info request proxy

記述できる場所

httpsd.conf

2.3.69　HWSSetEnvIfIPv6

クライアントまたはサーバのIPv6アドレスによる環境変数を定義する場合に指定します。

説明

クライアントまたはサーバのIPv6アドレスを基に環境変数を定義します。リクエスト値がIPv6アドレスで表した条件を満たす場合、指定した環境変数を設定します。設定する値のデフォルト値は1です。環境変数の前に「!」が付いたときは、その環境変数の設定を解除します。

リクエスト値として、次に示す値を指定できます。

リクエスト値

意味

Remote_Addr

クライアントのIPv6アドレス

Server_Addr

リクエストを受信したサーバのIPv6アドレス

IPv6アドレスは、[ ]で囲まないで指定してください。なお、IPv6アドレスの後ろに、10進数でプリフィクス長も指定できます。プリフィクス長は、「IPv6アドレス/プリフィクス長」の形式で指定します。

書式

HWSSetEnvIfIPv6 リクエスト値 IPv6アドレス 環境変数[=値][環境変数[=値]...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

クライアントのIPv6アドレスが2001:0:0:1230から始まる場合、環境変数IPV6_CLIENTを設定します。

HWSSetEnvIfIPv6 Remote_Addr 2001:0:0:1230::/64 IPV6_CLIENT

2.3.70　HWSSuppressModuleTrace

モジュールトレースの出力を抑止する場合に指定します。

説明

モジュールトレースの出力を抑止するモジュールファイル名および抑止する関数種別を指定します。

all

指定したモジュールが出力するモジュールトレースをすべて抑止します。

hook

指定したモジュールが出力するモジュールトレースのうち、handler関数以外のモジュールトレースを抑止します。

handler

指定したモジュールが出力するモジュールトレースのうち、handler関数のモジュールトレースを抑止します。

モジュールファイル名には、エラーログまたはリクエストログに出力されるモジュールファイル名称を指定します。次の例のモジュールトレースを抑止する場合は、モジュールファイル名に"mod_example.c"を指定します。

（例）

[Mon Dec 18 14:57:14 2006] [info] hws : module --> (mod_example.c[12])(1896)
[Mon Dec 18 14:57:14 2006] [info] hws : module <-- (mod_example.c[12])(1896)(-1)

Webサーバが標準提供している外部モジュールとモジュールファイル名の対応を次に示します。

表2‒3　Webサーバが標準提供している外部モジュールとモジュールファイル名の対応

モジュール名

モジュールファイル名

mod_expires.so

mod_expires.c

mod_headers.so

mod_headers.c

mod_hws_qos.so

mod_hws_qos.c

mod_lbmethod_byrequests.so

モジュールトレースは出力されません。

mod_proxy.so

mod_proxy.c

mod_proxy_balancer.so

mod_proxy_balancer.c

mod_proxy_http.so

モジュールトレースは出力されません。

mod_reqtimeout.so

mod_reqtimeout.c

mod_slotmem_shm.so

モジュールトレースは出力されません。

Webサーバが標準提供している外部モジュール以外を使用する場合は、そのモジュールのトレースが出力されることがあります。また、次のどちらかの場合は、内部モジュールに対するトレースも出力されます。

LogLevelディレクティブにdebugを設定している。

HWSRequestLogTypeディレクティブにmodule-debugを設定している。

なお、このディレクティブは、複数指定できます。同じモジュールファイル名を指定した場合は、あとに指定したものが有効となります。

重要

CGIプログラム実行時のモジュールトレースは抑止できません。

書式

HWSSuppressModuleTrace モジュールファイル名 [all|hook|handler]

記述できる場所

httpsd.conf

記述例

（例1）

HWSSuppressModuleTrace mod_proxy.c

この指定では、プロキシーモジュール内のすべての関数に対するモジュールトレースを抑止します。

（例2）

HWSSuppressModuleTrace mod_proxy.c hook

この指定では、プロキシーモジュール内のhandler以外の関数に対するモジュールトレースを抑止します。

2.3.71　HWSTraceIdFile

トレース採取のための共有メモリーIDを格納するファイル名を指定します。

説明

トレース採取のための共有メモリーIDを格納するファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

このファイルは複数のWebサーバでは共有できません。同一ServerRootディレクティブ指定で複数のWebサーバを起動する場合は、このディレクティブで異なるファイル名を指定する必要があります。

書式

HWSTraceIdFile ファイル名

デフォルト値

定義項目の省略

logs/hws.trcid

記述できる場所

httpsd.conf

2.3.72　HWSTraceLogFile

サーバプロセスが異常終了した場合に共有メモリーに採取されたトレースを出力するファイル名を指定します。

説明

サーバプロセスが異常終了した場合に共有メモリーに採取されたトレースを出力するファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

トレースは複数のファイルにラップアラウンドして出力します。

最大2ファイル出力します。出力するファイルは「指定したファイル名.01」または「指定したファイル名.02」のファイル名になります。Webサーバの起動時には、「指定したファイル名.01」がカレントの出力ファイル名となります。カレントの出力ファイル名が「指定したファイル名.01」のときにトレースをファイルに出力すると、次のカレントのファイル名は「指定したファイル名.02」になります。なお、カレントの出力ファイル名が「指定したファイル名.02」のときにトレースをファイルに出力すると、次のカレントのファイル名は「指定したファイル名.01」になります。

書式

HWSTraceLogFile ファイル名

デフォルト値

定義項目の省略

logs/hws.trclog

記述できる場所

httpsd.conf

2.3.73　ImapBase

イメージマップファイルのbase行のデフォルトを指定します。

説明

イメージマップファイルのbase行のデフォルトを指定します。

書式

ImapBase {map|referer|URL}

指定できる値

map

マップファイルの場所

referer

ドキュメントの場所（イメージマップを表示したHTMLファイルの場所）

URL

指定したURL

URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

デフォルト値

定義項目の省略

map

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.74　ImapDefault

イメージマップファイルのdefault行のデフォルトを指定します。

説明

イメージマップファイルのdefault行のデフォルトを指定します。

書式

ImapDefault {error|nocontent|map|referer|URL}

指定できる値

error

標準のエラーメッセージを表示します（ステータスコード500 Server Errorを応答します）。

nocontent

リクエストを無視します（ステータスコード204 No Contentを応答します）。

map

マップファイル中のURLをメニュー表示します。

referer

ステータスコード302 Foundを応答します。

URL

指定したURLのコンテンツを表示します。

URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

デフォルト値

定義項目の省略

nocontent

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.75　ImapMenu

メニュー表示を指定します。

説明

イメージマップファイルの指定値にmapを与えた場合またはイメージマップ画像の(0,0)座標をマウスでポイントした場合のメニュー表示を指定します。座標指定のない形でイメージマップファイルがリクエストされた場合の動作もこの設定に従います。

書式

ImapMenu {none|formatted|semiformatted|unformatted}

指定できる値

none

メニューは生成しません。このときの動作は、マップファイル中のdefault行の指定に従います。

formatted

ヘッダーおよびリンク一覧を表示します。マップファイル中のコメントは無視されます。

semiformatted

リンク一覧を表示します。マップファイル中のコメントも表示します。

unformatted

マップファイル中にHTMLを記述することで、メニューの形式を自由に設定できます。

デフォルト値

定義項目の省略

formatted

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.76　Include

設定ファイルとして使用するファイルを指定します。

説明

ファイル名で指定したファイルを設定ファイルとして利用できるようにします。

ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。このディレクティブを複数指定する場合、マージされた内容が使用されます。ファイル内に同じディレクティブがある場合、後ろに指定した方で上書きされます。

書式

Include ファイル名

記述できる場所

httpsd.conf

2.3.77　IndexIgnore

ディレクトリーインデックス表示時に、Webブラウザーに表示させないファイル名を指定します。

説明

ディレクトリーインデックス表示時に、Webブラウザーに表示させないファイル名を指定します。正規表現でも指定できます。

書式

IndexIgnore ファイル名 [ファイル名 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

2.3.78　IndexOptions

ディレクトリーインデックスの整形表示機能のオプションを指定します。

説明

ディレクトリーインデックスの整形表示機能のオプション設定をします。オプションの前に+を指定するかまたは+-を省略するとそのオプションが有効になります。デフォルトではすべてのオプションが無効です。指定できるオプションの一覧を次に示します。

表2‒4　オプション一覧

オプション

意味

Charset=文字セット

インデックス表示するページの文字セットを指定します。HeaderNameディレクティブまたはReadmeNameディレクティブで指定したファイルで使用している文字セットが、デフォルトの文字セット（UTF-8）と異なる場合は、このオプションでHeaderNameディレクティブまたはReadmeNameディレクティブで指定したファイルと同じ文字セットを指定してください。このオプションでは、=文字セットを省略できません。また、-Charset指定時も+Charset指定時と同様の動作をします。

オプションが省略された場合のデフォルト値は、UTF-8です。

DescriptionWidth[={文字数|*}]

ファイル説明文エリアの幅を文字数(1文字＝1バイト)で指定します。*を指定した場合はAddDescriptionディレクティブで指定したファイル説明文の最大長に合わせて表示します。このオプションを省略した場合のファイル説明文エリアの幅は、23バイト(ただし、SuppressSize指定時+7、SuppressLastModified指定時+19)です。

-DescriptionWidth指定時は={文字数|*}を省略できます。この場合の表示幅は23バイトです。

オプションが省略された場合のデフォルト値は、23、30、42または49です。

FancyIndexing

ディレクトリーインデックスの整形表示機能を有効にします。

FoldersFirst

ファイルよりディレクトリーを先にインデックス表示する場合に指定します。ただし、FancyIndexingが有効な場合だけです。

IconsAreLinks

ディレクトリーインデックス整形表示時のアイコンをファイルに対するアンカーにします。

IconHeight[=ピクセル数]

ディレクトリーインデックス整形表示時のアイコンの高さをピクセル数で指定します。IconWidthオプションと一緒に指定します。インデックスを表示するHTMLのIMGタグのHEIGHT属性になります。

指定できる値は>0 です。

オプションが省略された場合のデフォルト値は22です。

IconWidth[=ピクセル数]

ディレクトリーインデックス整形表示時のアイコンの幅をピクセルで指定します。IconHeightオプションと一緒に指定します。インデックスを表示するHTMLのIMGタグのWIDTH属性になります。

指定できる値は>0 です。

オプションが省略された場合のデフォルト値は20です。

IgnoreCase

ディレクトリーインデックス整形表示時に、ファイル名およびディレクトリー名の大文字と小文字の区別をしないで並べ替えます。

NameWidth[={文字数|*}]

ファイル名およびディレクトリー名エリアの幅を文字数（1文字＝1バイト）で指定します。*を指定した場合はファイル名およびディレクトリー名の最大長に合わせて表示します。

={文字数|*}を省略する場合は必ず-NameWidthと指定してください。

オプションが省略された場合のデフォルト値は23です。

ScanHTMLTitles

AddDescriptionディレクティブの指定がない場合に、HTMLファイル中の<TITLE>タグを検索し、説明文として表示します。

SuppressColumnSorting

ファイル名、ディレクトリー名、最終更新日時、ファイルサイズおよびファイルの説明文の各カラムでインデックスを並べ替える機能を抑止します。

SuppressDescription

ファイルの説明文を表示しません。

SuppressHTMLPreamble

HeaderNameディレクティブが指定されている場合、HeaderNameディレクティブで指定されたファイルの内容と、自動生成されるHTMLヘッダー部（<HTML>や<TITLE>など）が共に出力されます。このオプションは、HeaderNameディレクティブで指定されたファイルがHTMLで記述されている場合、自動生成されるHTMLヘッダー部の出力を抑制します。

SuppressLastModified

最終更新日時を表示させません。

SuppressSize

ファイルサイズを表示させません。

TrackModified

ディレクトリー表示のためのレスポンスのHTTPレスポンスヘッダーに、Last-Modified値とEtag値を設定します。このオプションを指定すると、クライアントはHEADリクエストでディレクトリーはファイル構成の変更を確認できるため、クライアントのキャッシュ機能を有効に活用できます。このオプションはOSとファイルシステムがstat()をサポートしている場合だけ有効です。

書式

IndexOptions [{+|-}]オプション [[{+|-}]オプション ...]

注意事項

このディレクティブを複数指定する場合、同じファイル名に異なる文字列は指定できません。

IconHeight、IconWidth、NameWidthで=値を指定する場合、-の指定はできません。

設定されたオプションは、httpsd.conf、<VirtualHost>、<Directory>、.htaccessの順で、また、上位ディレクトリーから下位ディレクトリーへ継承します。継承したオプションを最終的にマージして、インデックス整形表示形式を決定します。

httpsd.confで+-を付けてオプションを指定しても無効になります。ただし、httpsd.conf、<VirtualHost>、<Directory>、.htaccessの順で、また、下位ディレクトリーに継承されます。継承されたオプション指定はマージ処理で有効になります。参照順位が下位の指定場所でオプションの指定がある場合または次に示すディレクティブのどれかの指定がある場合、マージ処理が実行されます。

AddAlt

AddAltByEncoding

AddAltByType

AddDescription

AddIcon

AddIconByEncoding

AddIconByType

DefaultIcon

HeaderName

ReadmeName

（例）

httpsd.confファイルにIndexOptions +FancyIndexing +IconsAreLinksを指定した場合、下位の指定場所でインデックス関係のディレクティブ指定がなければFancyIndexing、IconsAreLinksは無効になります。

httpsd.confファイルにIndexOptions +FancyIndexing +IconsAreLinks、かつ下位ディレクトリーのアクセス制御ファイルに、AddDescription "テキストファイル" *.txtを指定した場合、FancyIndexing、IconsAreLinksは有効になります。

+-指定のないCharset、IconHeight、IconWidth、NameWidthディレクティブを指定すると、その指定場所内でそのオプションが指定されている位置より前に指定されている+-付のオプション（Charset、IconHeight、IconWidth、NameWidthを除いて）は無効になります。

（例）

IndexOptions FancyIndexing -IconsAreLinks IconHeight IconWidth

この場合、FancyIndexing、IconHeight、IconWidthディレクティブが有効になります。IconsAreLinksの-指定は継承されません。

指定場所間で同じディレクトリーのインデックスを対象にオプション指定した場合のマージ処理は、参照順位がより後方の指定場所で+-のないオプションを指定すると、先に指定したオプションは無効になります。ただし、IconHeight、IconWidth、NameWidthは無効になりません。

（例1）

httpsd.confファイルの指定

IndexOptions +FancyIndexing +IconsAreLinks

アクセス制御ファイルの指定

IndexOptions FancyIndexing SuppressLastModified

これらを指定した場合、IconsAreLinksは無効になります。FancyIndexing、SuppressLastModifiedは有効になります。

（例2）

httpsd.confファイルの指定

IndexOptions SuppressColumnSorting +FancyIndexing +IconsAreLinks

アクセス制御ファイルの指定

IndexOptions FancyIndexing SuppressLastModified

これらを指定した場合、SuppressColumnSorting、IconsAreLinksは無効になります。また、FancyIndexing、SuppressLastModifiedは有効になります。

指定場所間で、同じディレクトリーのインデックスを対象にオプション指定した場合のマージ処理は、同じオプションに対して+と-の両方を指定すると-指定が有効になります。

（例）

httpsd.confファイルの指定

IndexOptions +FancyIndexing -IconsAreLinks

アクセス制御ファイルの指定

IndexOptions +IconsAreLinks

これらを指定した場合、IconsAreLinksは無効になります。

同じ指定場所で+-を指定しないオプションを指定すると、Charset、IconHeight、IconWidth、NameWidthディレクティブ以外の+-で指定したオプションは無効になります。

（例1）

httpsd.confファイルの指定

IndexOptions +IconsAreLinks FancyIndexing +SuppressLastModified

この場合、IconsAreLinksは無効になります。

（例2）

<VirtualHost>ブロック、<Directory>ブロックまたはアクセス制御ファイルの指定

IndexOptions +IconsAreLinks FancyIndexing +SuppressLastModified

この場合、IconsAreLinks、SuppressLastModifiedは無効になります。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.79　IndexOrderDefault

ディレクトリーインデックス表示での、デフォルトのファイルの並び順を指定します。

説明

ディレクトリーインデックス表示での、ファイルの並び順のデフォルトを指定します。

書式

IndexOrderDefault {Ascending|Descending} {Name|Date|Size|Description}

指定できる値

Ascending

昇順

Descending

降順

Name

ファイル名で並べます。

Date

ファイル更新日付で並べます。

Size

ファイルサイズで並べます。

Description

AddDescriptionディレクティブで指定した説明文で並べます。

デフォルト値

定義項目の省略

Ascending Name

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

2.3.80　KeepAlive

KeepAlive接続を有効にするかどうかを指定します。

説明

KeepAlive接続を有効にするかどうかを指定します。実際にKeepAliveが実行されるのはクライアント側もKeepAliveに対応している場合だけです。KeepAliveはサーバプロセスとクライアントとのコネクションが持続されるので、連続したリクエストのレスポンスが良くなります。反面、サーバプロセスが特定のクライアント専用になるので、Webサーバ全体としてサービス能力が低下することもあります。KeepAliveTimeout、MaxKeepAliveRequestsディレクティブを使用して調整する必要があります。

KeepAliveディレクティブがOnの場合は、レスポンスの送信が完了し、KeepAliveTimeoutディレクティブで指定した時間を経過した後に、Webサーバからコネクション切断要求を行います。また、KeepAliveディレクティブがOffの場合は、レスポンスの送信が完了した直後に、Webサーバからコネクション切断要求を行います。

このコネクション切断要求に対するクライアントの応答によっては、2秒間サーバスレッドが専有されることがあります。

書式

KeepAlive {On|Off}

指定できる値

On

持続型接続（KeepAlive）を有効にします。

Off

持続型接続（KeepAlive）を無効にします。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf

記述例

KeepAlive On

2.3.81　KeepAliveTimeout

KeepAlive接続時のリクエストの待ち時間を指定します。

説明

KeepAlive接続時の要求待ち時間を秒単位で指定します。この時間以上経過しても、クライアントから次のリクエストが来ない場合、コネクションを切断します。KeepAliveはサーバプロセスが特定のクライアントに占有されます。あるWebページから次のWebページへ移る場合に必要とする標準的な時間以上は、タイムアウトにしてコネクションを切断し、サーバプロセスをほかのリクエストの処理に当てるようにします。時間に0を指定した場合は、KeepAlive接続が無効になります。

書式

KeepAliveTimeout 時間

指定できる値

0−65535

デフォルト値

定義項目の省略

5

記述できる場所

httpsd.conf

記述例

KeepAliveTimeout 3

KeepAlive接続時の要求待ち時間は3秒

2.3.82　LanguagePriority

クライアントが使用言語の優先度を示さなかった場合の優先順位を指定します。

説明

使用言語を優先順位の高い順に指定します。コンテントネゴシエーションで、Webブラウザーからのリクエストに言語コードの優先順位（Accept-Languageヘッダー）が含まれていない場合に、ここで指定した優先順位が使用されます。

書式

LanguagePriority 言語コード [言語コード ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

LanguagePriority ja en fr de

優先順位は日本語、英語、フランス語、ドイツ語の順

2.3.83　LimitRequestBody

サーバが受信するオブジェクトボディーのサイズの上限を指定します。

説明

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のオブジェクトボディー（データ）のサイズの上限を指定します。Webブラウザーから<FORM METHOD=POST ACTION=...>によるリクエストを送る場合などにオブジェクトボディーが用いられます。上限値を設定しない場合は、0を指定してください。

書式

LimitRequestBody リクエストボディーサイズ

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

0

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.84　LimitRequestFields

サーバが受信するHTTPヘッダー数の上限を指定します。

説明

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のHTTPヘッダー数の上限を指定します。リクエストのHTTPヘッダー数は、Webブラウザーやリクエストを中継するプロキシーなどの仕様で変わります。上限値を設定しない場合は、0を指定してください。

このディレクティブ指定値を、バーチャルホストに対するリクエストにも適用するには、<VirtualHost>ブロックよりも前に指定する必要があります。

書式

LimitRequestFields ヘッダー数

指定できる値

0−32767

デフォルト値

定義項目の省略

100

記述できる場所

httpsd.conf

2.3.85　LimitRequestFieldsize

サーバが受信する1つのHTTPヘッダーのサイズの上限を指定します。

説明

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合、1つのHTTPヘッダーの、サイズの上限を指定します。リクエストヘッダーのサイズはWebブラウザーやリクエストを中継するプロキシーなどの仕様で変わります。

このディレクティブ指定値を、バーチャルホストに対するリクエストにも適用するには、<VirtualHost>ブロックよりも前に指定する必要があります。

書式

LimitRequestFieldsize ヘッダーサイズ

指定できる値

0−8190

デフォルト値

定義項目の省略

8190

記述できる場所

httpsd.conf

2.3.86　LimitRequestLine

サーバが受信するリクエストラインの長さの上限を指定します。

説明

HTTP通信によって、Webブラウザーが送信してくるリクエストをサーバが受信する場合のリクエストライン（メソッド、問い合わせ文字列などを含むURI、HTTPバージョン）の長さの上限を指定します。Webブラウザーから<FORM METHOD=GET ACTION...>によるリクエストを送る場合などに問い合わせ文字列としてリクエストラインが用いられます。なお、リクエストラインとしてWebブラウザーから何バイト送れるかは、Webブラウザーやリクエストを中継するプロキシーなどの仕様で変わります。

このディレクティブ指定値を、バーチャルホストに対するリクエストにも適用するには、<VirtualHost>ブロックよりも前に指定する必要があります。

書式

LimitRequestLine リクエストライン長

指定できる値

0−8190

デフォルト値

定義項目の省略

8190

記述できる場所

httpsd.conf

2.3.87　Listen

リクエストを受け付けるIPアドレスおよびポート番号を指定します。

説明

リクエストを受け付けるIPアドレスおよびポート番号を指定します。このディレクティブの指定は必須です。

IPアドレスにはIPv6アドレスも指定できます。IPv6アドレスを指定する場合は、IPv6アドレスを[ ]で囲んでください。ただし、IPアドレスを省略してポート番号だけを指定した場合は、IPv4アドレスを使用したリクエストだけを受け付けます。このため、IPv6アドレスを使用する場合は、必ずListenディレクティブにIPv6アドレスを指定してください。

重要

ListenディレクティブのIPアドレスを変更してサーバを再起動する場合、サーバをいったん停止後、起動してください。コマンドなどで再起動を選択すると、サーバの起動に失敗する場合があります。

書式

Listen [IPアドレス:]ポート番号

記述できる場所

httpsd.conf

記述例

Listen 80
Listen [2001::123:4567:89ab:cdef]:8080
Listen [::]:80

2.3.88　ListenBacklog

クライアントからの接続要求の最大の待ち行列数を指定します。

説明

クライアントからの接続要求の最大の待ち行列数を指定します。この指定値はシステムコールlisten( )のバックログ数として設定されます。ただし、指定値の制限値や、実際の待ち行列数の最大値についてはOSによって異なるため、詳細は各OSのlisten( )についてのマニュアルや、各OSのTCP/IP実装の詳細を説明しているドキュメントを参照してください。

書式

ListenBacklog バックログ数

指定できる値

1−2147483647

デフォルト値

定義項目の省略

511

記述できる場所

httpsd.conf

2.3.89　LoadFile

DSOによって組み込むモジュールが参照するコードがあるオブジェクトファイルまたはライブラリーを指定します。

説明

DSOによって組み込むモジュールが参照するコードがあるオブジェクトファイルまたはライブラリーを指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

LoadModuleディレクティブでこのファイルを参照するモジュールを指定する場合、それらがhttpsd.confで使用される前に、このディレクティブを指定する必要があります。

書式

LoadFile ファイル名 [ファイル名 ...]

記述できる場所

httpsd.conf

2.3.90　LoadModule

Webサーバに動的に組み込むモジュールを指定します。

説明

Webサーバに動的に組み込むモジュールを指定します。ライブラリーファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

書式

LoadModule module構造体名 ライブラリーファイル名

記述できる場所

httpsd.conf

記述例

LoadModule hws01_module libexec/mod_hws01.so
LoadModule hws02_module libexec/mod_hws02.so

モジュールhws01_moduleとモジュールhws02_moduleを組み込みます。

2.3.91　LogFormat

ログのフォーマットにラベル名を定義する場合に指定します。

説明

ログのフォーマットにラベル名を定義します。ここで定義したラベル名をCustomLogディレクティブで指定できます。

なお、フォーマットに%Aまたは%aを指定した場合、IPv6アドレスも出力できます。また、フォーマットに%hまたは%Vを指定した場合、IPv6アドレスに対応したホスト名またはIPv6アドレスも出力できます。

ラベル名を付けない場合は、このディレクティブを複数指定できません。

書式

LogFormat "フォーマット" [ラベル名]

デフォルト値

定義項目の省略

"%h %l %u %t ¥"%r¥" %>s %b"

記述できる場所

httpsd.conf、<VirtualHost>

記述例

LogFormat "%h %l %u %t ¥"%r¥" %>s %b ¥"%{Referer}i¥" ¥"%{User-Agent}i¥""
 combined
LogFormat "%h %l %u %t ¥"%r¥" %>s %b" common
LogFormat "%{Referer}i -> %U" referer
LogFormat "%{User-agent}i" agent

2.3.92　LogLevel

エラーログに出力するエラーのレベルを指定します。

説明

エラーログに出力するエラーのレベルを指定します。指定したレベルの上位レベルのログを出力します。ただし、noticeレベルのログはこの指定に関係なく出力されます。また、Webサーバ起動時など、レベル指定の解析終了前に出力されるメッセージは、この指定に関係なく出力される場合があります。

エラーレベルの上位順は、「emerg」、「alert」、「crit」、「error」、「warn」、「notice」、「info」、「debug」です。

書式

LogLevel {debug|info|notice|warn|error|crit|alert|emerg}

指定できる値

emerg

緊急メッセージ

alert

即時処理要求メッセージ

crit

致命的な状態のメッセージ

error

一般的エラーメッセージ

warn

警告レベルメッセージ

notice

標準的だが重要なメッセージ

info

インフォメーションメッセージ、外部モジュールとCGIプログラム実行時のモジュールトレース※

debug

デバッグレベルメッセージ、内部モジュールトレースおよびinfo相当のモジュールトレース※

注※

モジュールトレースは、エラーログではなくリクエストログに出力するよう設定できます。

デフォルト値

定義項目の省略

warn

記述できる場所

httpsd.conf、<VirtualHost>

記述例

LogLevel info

2.3.93　MaxKeepAliveRequests

KeepAlive連続接続回数の上限を指定します。

説明

KeepAlive連続接続回数の上限を指定します。上限値を設定しない場合は0を指定します。KeepAliveはサーバプロセスが特定のクライアントに占有されるので、ほかのクライアントにもサービスの機会を与えるために上限を設けます。

書式

MaxKeepAliveRequests 接続数

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

100

記述できる場所

httpsd.conf

記述例

MaxKeepAliveRequests 100

2.3.94　MultiviewsMatch

コンテントネゴシエーションの対象となる拡張子の種類を指定します。

説明

コンテントネゴシエーションの対象となる拡張子の種類を指定します。

書式

MultiviewsMatch {NegotiatedOnly|Handlers}

指定できる値

NegotiatedOnly

拡張子が文字セット、圧縮形式、言語コード、MIMEタイプと関連づけられたものだけをコンテントネゴシエーションの対象にします。

Handlers

NegotiatedOnlyを指定した場合の対象に加え、ハンドラーと関連づけられた拡張子についてもコンテントネゴシエーションの対象にします。

デフォルト値

定義項目の省略

NegotiatedOnly

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

MultiviewsMatch Handlers

2.3.95　Options

ユーザーに利用させる機能を制限する場合に指定します。

説明

ユーザーが利用できる機能を制限する場合に指定します。

+

オプションで指定した機能の利用を許可します。

-

オプションで指定した機能の利用を禁止します。

オプション

機能

All

MultiViews、SymLinksIfOwnerMatchを除くすべてのオプションが有効です。

ExecCGI

CGIスクリプトの実行を許可します。

Indexes

URLにディレクトリーが指定されたとき、DirectoryIndexディレクティブで指定したファイル（デフォルトはindex.html）がない場合、ディレクトリーのインデックスを表示します。

MultiViews

Content-negotiated Multiviewsをサポートします。

None

すべてのオプションで指定できる機能を無効にします。

+-を使用しないでこのディレクティブを複数指定すると、最後に指定したディレクティブだけが有効になります。

（例1）

Options All
Options ExecCGI

このようにオプションに+-を指定しないディレクティブを2行指定した場合、ユーザーはCGIスクリプトの実行機能だけが利用できます。ディレクトリーインデックスなどの機能は利用できません。

（例2）

httpsd.confファイルの指定

Options All

アクセス制御ファイルの指定

Options ExecCGI

httpsd.confファイルのあとにアクセス制御ファイルが参照されるので、アクセス制御ファイルがあるディレクトリーではCGIスクリプトの実行機能だけが利用できます。

（例3）

Options Indexes ExecCGI

このように1行に+-を指定しないオプションを指定した場合は、指定した機能の両方を利用できます。

書式

Options {+|-}オプション [{+|-}オプション ...]

デフォルト値

定義項目の省略

None

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Optionsレベル

2.3.96　Order

AllowディレクティブとDenyディレクティブの指定の評価の順序を指定します。

説明

AllowディレクティブとDenyディレクティブの指定の評価の順序を指定します。指示子に指定できるものを次に示します。先に評価されたものは、あとに評価されるものに上書きされます。

指示子

意味

deny,allow

Denyディレクティブの指定を、Allowディレクティブの指定より先に評価

allow,deny

Allowディレクティブの指定を、Denyディレクティブの指定より先に評価

mutual-failure

Allowディレクティブに指定され、Denyディレクティブに指定されていないホストだけアクセスを許可

書式

Order 指示子

デフォルト値

定義項目の省略

deny,allow

記述できる場所

<Directory>、.htaccess

上書き許可

Limitレベル

2.3.97　PassEnv

CGIスクリプトに渡す任意の環境変数を指定します。

説明

CGIスクリプトに渡す任意の環境変数を指定できます。

書式

PassEnv 環境変数 [環境変数 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

PassEnv TMP

2.3.98　PidFile

制御プロセスIDを格納するファイルを指定します。

説明

制御プロセスIDを格納するファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

重要

PidFileディレクティブ指定値を変更する場合は、Webサーバを停止してから変更してください。また、WebサーバのプロセスID取得コマンドのFILENAME変数にも同じ値を指定してください。WebサーバのプロセスID取得コマンドのデフォルトの格納先を次に示します。WebサーバのプロセスID取得コマンドは，getpid-webserverで始まるファイルです。

Application Serverのインストールディレクトリー/javaee/glassfish/domains/ドメイン名/server_templates/webserver/bin

書式

PidFile ファイル名

デフォルト値

定義項目の省略

logs/httpd.pid

記述できる場所

httpsd.conf

記述例

PidFile logs/httpd.pid

2.3.99　ProxyErrorOverride

バックエンドサーバからのレスポンスがエラーのステータスコードであった場合にレスポンスを上書きするかどうかを指定します。

説明

バックエンドサーバからのステータスコードが400番台または500番台の場合、レスポンスヘッダーとレスポンスボディーをオーバーライドします。その結果、リバースプロキシーはバックエンドサーバからのレスポンスではなく、自身が生成したレスポンスをクライアントに返します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyErrorOverride {On|Off}

指定できる値

On

バックエンドサーバからのステータスコードが400番台または500番台の場合、レスポンスヘッダーとレスポンスボディーをオーバーライドします。

Off

レスポンスヘッダーとレスポンスボディーをオーバーライドしません。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ProxyErrorOverride On

バックエンドサーバからのステータスコードが400番台または500番台の場合、リバースプロキシーが生成したレスポンスをクライアントに返します。

2.3.100　ProxyPass

バックエンドサーバに転送するリクエストと転送するアドレスを指定します。

説明

リバースプロキシーを使用する場合、Webブラウザーからのリクエストとそれを転送するアドレスを指定します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyPass パス名 {URL|!} [キー=値 [キー=値 ...]]

指定できる値

パス名

Webブラウザーからリバースプロキシーへのリクエストをスラッシュ（/）から始まるURLで指定します。

URL

転送先となるバックエンドサーバのURLを次の文字列を含むどちらかの形で指定します。

"http://IPアドレス[:ポート番号]/"

"http://ホスト名[:ポート番号]/"

URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

mod_proxy_balancerによるロードバランサー構成を使用する場合には、"balancer://クラスター名/"を指定します。クラスター名とは、<Proxy>ディレクティブと対応づけするための任意の文字列です。クラスター名には、/を含めないでください。mod_proxy_balancerによるロードバランサー構成では、<Proxy>ディレクティブとBalancerMemberディレクティブも同時に指定する必要があります。

!

パス名に指定したリクエストをリバースプロキシーへのリクエストとしない場合に指定します。

キー

URLがhttp://で始まる場合、balancer://で始まる場合で指定できるキーが異なります。

それぞれの場合に指定できるキーを次に示します。

URLがhttp://で始まる場合に指定できるキー

キー

値

内容

timeout

1〜65535（単位：秒）

次のバックエンドサーバとの送受信時の待ち時間を指定します。

バックエンドサーバへのリクエスト送信中にデータを送信できなくなった場合の待ち時間

バックエンドサーバへのリクエスト送信後からレスポンス受信までの待ち時間

バックエンドサーバからのレスポンス受信中にデータを受信しなくなった場合の待ち時間

キーが省略された場合のデフォルト値は、ProxyTimeoutディレクティブ指定値です。

connectiontimeout

1〜65535（単位：秒）

バックエンドサーバとの接続時の待ち時間を指定します。

キーが省略された場合のデフォルト値は、timeoutキー値です。

URLがbalancer://で始まる場合に指定できるキー

キー

値

内容

lbmethod

byrequests

ロードバランサーの振り分けアルゴリズムを指定します。

byrequests：リクエスト数による振り分けです。

キーの指定がない場合、byrequestsによる振り分けをします。

stickysession

64バイト未満の文字列

振り分け先を決める際に使用するCookie名を指定します。

このキーを指定する場合は、同時にBalancerMemberディレクティブのrouteキーも指定が必要です。

キーが省略された場合のデフォルト値はありません。

注意事項

!を指定する場合は、URLを指定するProxyPassディレクティブより先に指定してください。

（例）

ProxyPass /abc/def/ !
ProxyPass /abc/ http://backend.example.com/

記述できる場所

httpsd.conf、<VirtualHost>

2.3.101　ProxyPassReverse

バックエンドサーバから受信したLocationヘッダーのURLを変更する場合に指定します。

説明

リバースプロキシーを使用する場合、バックエンドサーバからのリダイレクトレスポンスのLocationヘッダーで示すURLを変更します。Webブラウザーからのリダイレクトによるリクエストをリバースプロキシーを通すリクエストにするためにLocationヘッダーをこのディレクティブの指定値に変更します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyPassReverse パス名 URL

指定できる値

パス名

リダイレクトのリクエスト先であるリバースプロキシーのパス名を、スラッシュ（/）から始まるURLで指定します。

URL

変更対象となるLocationヘッダー中のバックエンドサーバのURLを"http://IPアドレスまたはホスト名[:ポート番号]/"を含む形で指定します。

URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。IPv6アドレスにはさまざまな表記方法がありますので、指定値に注意してください。IPv6アドレスの表記が指定値と一致しない場合、ディレクティブが有効になりません。IPv6アドレスを指定する場合は、バックエンドサーバからの応答のLocationヘッダー値に含まれるIPv6アドレスの表記を確認してください。

mod_proxy_balancerによるロードバランサー構成で使用する場合、ProxyPassディレクティブのURL（balancer://クラスター名/）を指定できます。これを指定した場合、対応するBalancerMemberディレクティブに指定しているURLが実際の変更対象となるURLになります。通常、BalancerMemberディレクティブは複数指定しているので、そのすべてのURLが変更対象となります。

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ProxyPass /examples/ balancer://cluster1/
ProxyPassReverse /examples/ balancer://cluster1/
<Proxy balancer://cluster1/>
        BalancerMember http://IPアドレスA/examples/
        BalancerMember http://IPアドレスB/examples/
</Proxy>

バックエンドサーバからのLocationヘッダーに、http://IPアドレスA/examples/、またはhttp://IPアドレスB/examples/が含まれていた場合に変更対象になります。

2.3.102　ProxyPreserveHost

クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送するかどうかを指定します。

説明

リバースプロキシーを使用する場合、クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送するかどうかを指定します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyPreserveHost {On|Off}

指定できる値

On

クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送します。

Off

クライアントから受信したHostヘッダーの値をProxyPassディレクティブの指定値に従って変更して、バックエンドサーバに転送します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ProxyPreserveHost On

クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送します。

2.3.103　ProxyTimeout

バックエンドサーバとの送受信に関する待ち時間を指定します。

説明

次の待ち時間を秒単位で指定します。

リバースプロキシーを使用している場合の、バックエンドサーバへのリクエスト送信中にデータを送信できなくなった場合の待ち時間

リバースプロキシーを使用している場合の、バックエンドサーバへのリクエスト送信後からレスポンス受信までの待ち時間

リバースプロキシーを使用している場合の、バックエンドサーバからのレスポンス受信中にデータを受信しなくなった場合の待ち時間

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyTimeout 時間

指定できる値

1−65535

デフォルト値

定義項目の省略

Timeoutディレクティブの値

記述できる場所

httpsd.conf、<VirtualHost>

2.3.104　ProxyVia

Viaヘッダーの使用を制御する場合に指定します。

説明

このディレクティブはプロキシーでViaヘッダーの使用を制御する場合に指定します。

なお、リバースプロキシーを使用するには、次のモジュールの組み込みが必要です。

mod_proxyモジュール

LoadModule proxy_module modules/mod_proxy.so

mod_proxy_httpモジュール

LoadModule proxy_http_module modules/mod_proxy_http.so

書式

ProxyVia {on|off|full|block}

指定できる値

on

Viaヘッダーに自ホストの情報を追加します。すでにある情報は変更しません。

off

Viaヘッダーに自ホストの情報を追加しません。すでにある情報は変更しません。

full

コメントとして自ホストのバージョンを付けた情報をViaヘッダーに追加します。すでにある情報は変更しません。

block

Viaヘッダーに自ホストの情報を追加しません。リクエスト中のViaヘッダーは削除します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>

2.3.105　QOSCookieDomain

流量制限機能に使用するCookieが有効とされるドメインを指定します。

説明

流量制限機能に使用するCookieが有効とされるドメインを指定します。この値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。

複数のホストを設定している場合、このディレクティブを設定することでドメイン部分の共通するホスト間でCookieを使用できるようになります。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSCookieDomain ドメイン名

指定できる値

ドメイン名

流量制限機能に使用するCookieが有効とされるドメインを指定します。

ドメイン名には、少なくとも"."が2つ含まれていなければなりません。

なお、IPv6アドレスに対応したドメイン名も指定できます。

（例）

a.example.comとb.example.comの2つのホストを設定している場合、このディレクティブで.example.comと指定すると、2つのホストのどちらにアクセスしても優先度処理が行われます。

記述できる場所

httpsd.conf、<VirtualHost>

2.3.106　QOSCookieExpires

流量制限機能に使用するCookieの有効時間を指定します。

説明

流量制限機能に使用するCookieの有効時間を秒単位で指定します。このディレクティブで指定した値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

メモ

HWS作成モードはWebサーバが作成するCookieを用いて、またユーザー作成モードはWebサーバ以外で作成されたCookieを用いて、セッション管理を実施します。HWS作成モードとユーザー作成モードは、QOSCookieNameディレクティブで指定します。

書式

QOSCookieExpires 値

指定できる値

0−86400

注意事項

QOSCookieNameディレクティブを特定のブロックに指定した場合、上位に指定されているQOSCookieNameディレクティブは継承しません。

（例）

QOSCookieName Cookie1 hws
<Location /loc1>
    QOSCookieName Cookie2 user
</Location>

この場合、"/loc1"から始まるリクエストでは、Cookie名Cookie2の指定が有効になります。"/loc1"以外から始まるリクエストでは、Cookie名Cookie1の指定が有効になります。

QOSCookieNameディレクティブを複数指定する場合は、Cookie名を重複させないでください。重複している場合は、起動エラーになります。

（例）

QOSCookieName Cookie1 hws
QOSCookieName Cookie1 user

この場合、Cookie名が重複しているため起動エラーになります。

HWS作成モードのQOSCookieNameディレクティブを複数指定した場合は、後ろに指定した方が有効になります。

（例）

QOSCookieName Cookie1 hws
QOSCookieName Cookie2 hws

この場合、Cookie名Cookie1の指定は無効になり、Cookie2の指定が有効になります。

デフォルト値

定義項目の省略

300

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.107　QOSCookieName

流量制限機能に使用するCookie名を指定します。

説明

流量制限機能に使用するCookie名を指定します。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSCookieName Cookie名 [{hws|user}]

指定できる値

Cookie名

流量制限機能に使用するCookie名を指定します。Cookie名にセミコロン、コンマ、スペースは使用できません。

ホスト間およびURL間でそれぞれ異なるCookieを利用したセッション管理を行う場合は、別のCookie名を指定する必要があります。

hws

Webサーバが作成するCookieを用いて、セッション管理を実施します。これをHWS作成モードと呼びます。

user

Webサーバ以外の外部モジュールなどで作成されたCookieを用いて、セッション管理を実施します。これをユーザー作成モードと呼びます。

注意事項

QOSCookieNameディレクティブを特定のブロックに指定した場合、上位に指定されているQOSCookieNameディレクティブは継承しません。

（例）

QOSCookieName Cookie1 hws
<Location /loc1>
    QOSCookieName Cookie2 user
</Location>

この場合、"/loc1"から始まるリクエストでは、Cookie名Cookie2の指定が有効になります。"/loc1"以外から始まるリクエストでは、Cookie名Cookie1の指定が有効になります。

QOSCookieNameディレクティブを複数指定する場合は、Cookie名を重複させないでください。重複している場合は、起動エラーになります。

（例）

QOSCookieName Cookie1 hws
QOSCookieName Cookie1 user

この場合、Cookie名が重複しているため起動エラーになります。

HWS作成モードのQOSCookieNameディレクティブを複数指定した場合は、後ろに指定した方が有効になります。

（例）

QOSCookieName Cookie1 hws
QOSCookieName Cookie2 hws

この場合、Cookie名Cookie1の指定は無効になり、Cookie2の指定が有効になります。

デフォルト値

定義項目の省略

hws

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.108　QOSCookieSecure

SSLによるアクセス時だけにCookieを送信させるかどうかを指定します。

説明

クライアントに対し、SSLによるアクセス時だけにCookieを送信させるよう設定します。この値は、HWS作成モードで使用され、ユーザー作成モードでは使用されません。Cookieの確認はSSLの暗号処理の終了後であることに注意してください。

（例）

SSLが有効であるホストと無効であるホストを設定している場合、このディレクティブを設定すると、SSLが有効なホストへのアクセスだけCookieが送信されます。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSCookieSecure {on|off}

指定できる値

on

SSLによるアクセス時だけ、クライアントにCookieを送信させるよう設定します。

off

SSL以外によるアクセス時にも、クライアントにCookieを送信させるよう設定します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.109　QOSCookieServers

Cookieを送信してきたリクエストだけを処理するときのサーバスレッド数を指定します。

説明

リクエスト待ち状態のサーバスレッド数が減少した場合に、Cookieを送信してきたリクエストだけを処理するときの、サーバスレッド数を指定します。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSCookieServers 値

指定できる値

0−ThreadsPerChildディレクティブ指定値

デフォルト値

定義項目の省略

10

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.110　QOSRedirect

流量制限機能によって拒否したリクエストをリダイレクトさせるときに指定します。

説明

流量制限機能によって処理が拒否された場合に、クライアントからのリクエストを指定されたパスにリダイレクトさせるときに指定します。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSRedirect 旧パス 新パス

指定できる値

旧パス

スラッシュから始まるリクエストURLのパスを指定します。ただし、旧パスには、?以降（問い合わせ文字列）を指定できません。

旧パスでリクエストを受けた場合、ステータスコード302とLocationヘッダーに新パスを設定したレスポンスを返します。レスポンスをカスタマイズすることはできません。

新パス

"プロトコル名://ホスト名[:ポート番号]"を含むURLのパスを指定します。また、URLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.111　QOSRejectionServers

受信したすべてのリクエストを拒否するときのサーバスレッド数を指定します。

説明

リクエスト待ち状態のサーバスレッド数が減少し、受信したすべてのリクエストを拒否するようになるときの、サーバスレッド数を指定します。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSRejectionServers 値

指定できる値

0−ThreadsPerChildディレクティブ指定値

デフォルト値

定義項目の省略

1

記述できる場所

httpsd.conf、<VirtualHost>、<Location>

2.3.112　QOSResponse

流量制限機能によって処理が拒否された場合にレスポンスとして返すコンテンツを指定します。

説明

流量制限機能によって処理が拒否された場合に、ステータスコード503とともに返送するコンテンツを指定します。コンテンツはサーバプロセス内にキャッシュされるため、変更する場合にはサーバの再起動が必要です。

なお、流量制限機能を使用するには、mod_hws_qosモジュールの組み込みが必要です。

LoadModule hws_qos modules/mod_hws_qos.so

書式

QOSResponse {file［MIMEタイプ］ファイル名|message テキスト}

指定できる値

file

指定したファイルを、指定したMIMEタイプで返送します。MIMEタイプを省略したときはtext/htmlが設定されます。また、ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

message

指定したテキストを返送します。テキストは先頭に"を記述して文字列を指定します。MIMEタイプにはtext/htmlが設定されます。

記述できる場所

httpsd.conf、<VirtualHost>、<Location>Location

記述例

QOSResponse file "text/html; charset=ISO-8859-1" htdocs/busy.html
QOSResponse message "Server busy.

2.3.113　ReadmeName

ディレクトリーインデックス表示時のReadmeとして付けるコメントを記述したファイルを指定します。

説明

ディレクトリーインデックス表示時のReadmeとして付けるコメントを記述したファイルのファイル名（パス情報なし）を指定します。HTMLまたはプレーンテキストで記述できます。ただし、AddTypeディレクティブまたはTypesConfigディレクティブで指定したファイルで、MIMEタイプが正しく定義されている必要があります。プレーンテキストでコメントを作成した場合、ディレクトリーインデックス表示のHTMLには<PRE>タグが追加されます。

書式

ReadmeName ファイル名

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

Indexesレベル

記述例

ReadmeName README.html

ディレクトリー下のREADME.htmlファイルの内容を表示します。

2.3.114　Redirect

クライアントからのリクエストをリダイレクトする場合に指定します。

説明

旧パスに対するクライアントからのリクエストを、新パスに再リクエスト（リダイレクト）する場合に指定します。

旧パスでリクエストを受けた場合、指定したステータスコードとLocationヘッダーに新パスを設定した応答を返します。通常、300番台のステータスコードを受けたWebブラウザーは、自動的にLocationヘッダーに指定されたアドレスに対してリダイレクトします。

Redirectディレクティブでは、特定のファイルへのリクエストを特定のファイルへリダイレクトするか、特定のディレクトリー下の、任意のパスへのリクエストを特定のディレクトリー下の、同名パスへリダイレクトする指定ができます。特定のディレクトリー下の、任意のパスへのリクエストを、特定のファイルへリダイレクトしたい場合はRedirectMatchディレクティブを使用してください。

書式

Redirect [{permanent|temp|seeother|gone|ステータスコード}] 旧パス 新パス

指定できる値

permanent

ステータスコード301 Moved Permanentlyを応答する場合に指定します。

temp

ステータスコード302 Foundを応答する場合に指定します。

seeother

ステータスコード303 See Otherを応答する場合に指定します。

gone

ステータスコード410 Goneを応答する場合に指定します。新パスは指定できません。

ステータスコード

指定したステータスコードを応答する場合に指定します。

ただし、300番台以外を指定する場合、新パスは指定できません。

旧パス

スラッシュから始まるリクエストURLのパスを指定します。ただし、旧パスには、?以降（問い合わせ文字列）を指定できません。

次のディレクティブ指定値と重複する旧パスは指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

Redirect temp /aaa/bbb/ http://aaa.example.com/
ProxyPass /aaa/ http://aaa.example.com/

新パス

"プロトコル名://ホスト名[:ポート番号]"を含むURLのパスを指定します。また、新パスに指定するURLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

Redirect temp /index.html http://ホスト名:port番号/default.html

/index.htmlに対するリクエストを、ステータスコード302で"http://ホスト名:port番号/default.html"にリダイレクトします。

2.3.115　RedirectMatch

正規表現で記述した条件を満たすクライアントからのリクエストをリダイレクトする場合に指定します。

説明

正規表現で記述した条件を満たすパスに対するクライアントからのリクエストを、新パスに再リクエスト（リダイレクト）する場合に指定します。

正規表現で括弧（）を使用してグループ化している場合、そのi番目のグループの表現にマッチした文字列を、新パスで$iを使用して参照できます。iには1から9までの数字を指定します。正規表現で記述した条件を満たすパスへのリクエストを受信した場合に、指定したステータスコードと、新パスを設定したLocationヘッダーを応答します。通常、300番台のステータスコードを受けたWebブラウザーは、自動的にLocationヘッダーに指定されたアドレスに対して再リクエスト（リダイレクト）します。

書式

RedirectMatch [{permanent|temp|seeother|gone|ステータスコード}] 正規表現 新パス

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

指定できる値

permanent

ステータスコード301 Moved Permanentlyを応答する場合に指定します。

temp

ステータスコード302 Foundを応答する場合に指定します。

seeother

ステータスコード303 See Otherを応答する場合に指定します。

gone

ステータスコード410 Goneを応答する場合に指定します。新パスは指定できません。

ステータスコード

指定したステータスコードを応答する場合に指定します。

ただし、300番台以外を指定する場合、新パスは指定できません。

正規表現

スラッシュから始まるリクエストURLの旧パスを正規表現で指定します。ただし、旧パスには、?以降（問い合わせ文字列）を指定できません。

次のディレクティブ指定値と重複する旧パスは指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

RedirectMatch ^/aaa/bbb/(.*) http://aaa.example.com/$1
ProxyPass /aaa/ http://aaa.example.com/

新パス

"プロトコル名://ホスト名[:ポート番号]"を含むURLのパスを指定します。また、新パスに指定するURLには、IPv6アドレスまたはIPv6アドレスに対応したホスト名も指定できます。

上書き許可

FileInfoレベル

記述例

（例1）

RedirectMatch ^/other/ http://www.example.com/

/other/で始まるすべてのリクエストを、ステータスコード302で"http://www.example.com/"にリダイレクトします。

（例2）

RedirectMatch permanent ^/old/(.*) http://www.example.com/new/$1

"/old/ファイル名"に対するリクエストを、ステータスコード301で"http://www.example.com/new/ファイル名"にリダイレクトします。

2.3.116　RequestHeader

リクエストヘッダーをカスタマイズする場合に指定します。

説明

クライアントから受信したヘッダー値をカスタマイズする場合に指定します。

カスタマイズ機能を使用するためにはモジュールの組み込みが必要です。

なお、リクエストヘッダーをカスタマイズするにはmod_headersモジュールの組み込みが必要です。

LoadModule headers_module modules/mod_headers.so

書式

RequestHeader {{set|append|add}ヘッダー ヘッダー値[env=[!]環境変数]|unset ヘッダー}

指定できる値

set

ヘッダーを設定します。ヘッダーがある場合は、指定したヘッダー値に書き換えます。

append

存在するヘッダーにヘッダー値を追加します。存在するヘッダー値との間は、コンマで区切られます。ヘッダーがない場合は、ヘッダーを設定します。

add

ヘッダーがあっても、別の行にヘッダーを設定します。同じヘッダーを複数行設定する場合に使用します。

unset

指定したヘッダーがある場合、そのヘッダーをすべて削除します。

env=環境変数

指定した環境変数が設定されている場合に、RequestHeaderディレクティブで指定した内容を実行します。

env=!環境変数

指定した環境変数が設定されていない場合に、RequestHeaderディレクティブで指定した内容を実行します。

ヘッダー値

文字だけから成る文字列、フォーマット指示子を含む文字列または両方から成る文字列を指定できます。

ヘッダー値に空白がある場合は、"（ダブルクォーテーション）で囲む必要があります。

フォーマット指示子を次に示します。

フォーマット指示子

意味

%t

リクエストを受け取った時刻を、1970年1月1日0時0分0秒（GMT：Greenwich Mean Time）から経過した時間で表示する。単位はマイクロ秒。先頭には"t="が付けられる。

%D

リクエスト処理に掛かった時間を表示する。単位はマイクロ秒。先頭には"D="が付けられる。

%{env_name}e

環境変数env_nameの値。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

RequestHeader set Host www.example.com

2.3.117　RequestReadTimeout

リクエスト受信開始からリクエストヘッダー受信完了まで、およびリクエストボディーの受信開始から完了までのタイムアウト時間を指定します。

説明

リクエスト受信開始からリクエストヘッダー受信完了まで、およびリクエストボディーの受信開始から完了までのタイムアウト時間を秒単位で指定します。

データの送信が遅いリクエストに対して、サーバのリソースを長時間専有されることを避ける場合に有効です。

なお、タイムアウトを設定するにはmod_reqtimeoutモジュールの組み込みが必要です。

LoadModule reqtimeout_module modules/mod_reqtimeout.so

また、モジュールトレースの出力の抑止を同時に設定することを推奨します。

HWSSuppressModuleTrace mod_reqtimeout.c

書式

RequestReadTimeout タイプ=時間 [タイプ=時間]

指定できる値

タイプ

headerとbodyを指定できます。

header

リクエスト受信開始からリクエストヘッダー受信完了までの経過時間を監視する場合に指定します。

body

リクエストボディーの受信開始から完了までの経過時間を監視する場合に指定します。

時間

リクエスト受信開始からリクエストヘッダー受信完了まで、およびリクエストボディーの受信開始から完了までのタイムアウト時間を秒単位で指定します。

指定できる値は、0〜2147483647です。0を指定するとタイムアウトを設定しません。

デフォルト値

定義項目の省略

20

記述できる場所

httpsd.conf、<VirtualHost>

記述例

(例1)

RequestReadTimeout header=10 body=30

リクエスト受信開始からリクエストヘッダー受信完了までのタイムアウト時間を10秒、リクエストボディーの受信開始から完了までのタイムアウト時間を30秒に設定します。

(例2)

RequestReadTimeout header=0 body=0

タイムアウトを設定しません。

2.3.118　Require

アクセス制限を定義する場合に指定します。

説明

AuthNameディレクティブ、AuthTypeディレクティブ、AuthUserFileディレクティブ（またはAuthGroupFileディレクティブ）と一緒に指定し、アクセス制限を定義します。

書式

Require {user ユーザー名 [ユーザー名 ...]
|group グループ名 [グループ名 ...]|valid-user}

指定できる値

user

AuthUserFileディレクティブで指定したパスワードファイルに登録されているユーザーのうち、ユーザー名で指定したユーザーだけアクセスできます。

group

AuthGroupFileディレクティブで指定したグループファイルに登録されているグループ名で指定したグループに属するユーザーだけがアクセスできます。

valid-user

AuthUserFileディレクティブで指定したパスワードファイルに登録されているすべてのユーザーがアクセスできます。

記述できる場所

<Directory>、.htaccess

上書き許可

AuthConfigレベル

2.3.119　Satisfy

コンテンツへのアクセスがユーザー認証とホスト名またはIPアドレスの両方によって制限されている場合にその関係を指定します。

説明

コンテンツへのアクセスが、ユーザー認証（AuthUserFile、Requireディレクティブなどを指定）とホスト名またはIPアドレス（Allow from、Deny fromディレクティブなどを指定）の両方によって制限されている場合にその関係を設定します。

書式

Satisfy {any|all}

指定できる値

any

そのどちらかの条件を満たしていれば、コンテンツへのアクセスを許可します。

all

そのどちらの条件も満たさなければ、コンテンツへのアクセスを禁止します。

デフォルト値

定義項目の省略

all

記述できる場所

<Directory>、.htaccess

2.3.120　Script

特定のメソッドに対するCGIスクリプトを実行する場合に指定します。

説明

指定されたメソッドによるリクエストがあった場合にCGIスクリプト名で示すスクリプトを実行します。

指定できるメソッド

GET、POST、PUT、DELETE

メソッドは大文字、小文字を区別します。

ただし、GETメソッドの場合、スクリプトは問い合わせ引数があるときだけ（例えば、/foo.html?bar）呼ばれます。

書式

Script メソッド CGIスクリプト名

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>

記述例

Script POST /cgi-bin/search

2.3.121　ScriptAlias

CGIプログラムを実行するURLとCGIプログラムが配置されているディレクトリー名を指定します。

説明

WebブラウザーからURLで指定されたCGIプログラム実行のリクエストに対して、実行するCGIプログラムのあるディレクトリー名を指定します。

書式

ScriptAlias URL ディレクトリー名

指定できる値

URL

CGIプログラムを実行するURLを指定します。

次のディレクティブ指定値と重複するURLは指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

ScriptAlias /aaa/bbb/ C:/alias/
ProxyPass /aaa/ http://aaa.example.com/

ディレクトリー名

CGIプログラムが配置されているディレクトリー名を指定します。

ディレクトリー名は、絶対パスで指定してください。

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ScriptAlias /cgi-bin/ "Application Serverのインストールディレクトリー/httpsd/cgi-bin/"

2.3.122　ScriptAliasMatch

CGIプログラムを実行するURLに対する正規表現とCGIプログラムが配置されているディレクトリー名を指定します。

説明

Webブラウザーから指定されたCGIプログラム実行要求のURLが正規表現で記述した条件を満たす場合、指定した新パスのCGIプログラムを実行します。正規表現で括弧（）を使用してグループ化している場合、そのi番目のグループの表現にマッチした文字列を、新パスで$iを使用して参照できます。iには1から9までの数字を指定します。

新パスは、絶対パスで指定してください。また、新パスの文字として、$または&を含める場合は、その文字の前に¥を付加してください。なお、$iを指定する際には、$の前に¥を付加する必要はありません。

次のディレクティブ指定値と重複する正規表現は指定できません。

ProxyPassのパス名

例えば、次のような指定はできません。

ScriptAliasMatch ^/aaa/bbb/(.*) C:/alias/$1
ProxyPass /aaa/ http://aaa.example.com/

書式

ScriptAliasMatch 正規表現 新パス

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ScriptAliasMatch ^/cgi-bin/(.*)
 "Application Serverのインストールディレクトリー/httpsd/cgi-bin/$1"

2.3.123　ScriptInterpreterSource

CGIスクリプトの実行に使用されるインタープリターを指定します。

説明

CGIスクリプトの実行に使用されるインタープリターを定義します。

書式

ScriptInterpreterSource {registry|script}

指定できる値

registry

レジストリーが検索され、拡張子に関連づけられているプログラムがインタープリターとして使用されます。

script

スクリプト内の#!行で指定されたインタープリターが使用されます。

デフォルト値

定義項目の省略

script

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.124　ScriptLog

CGIスクリプトのエラーログ出力先を指定します。

説明

CGIスクリプトのエラーログ出力先のファイルを指定します。

書式

ScriptLog ファイル名

指定できる値

ファイル名

CGIスクリプトのエラーログの出力先を指定します。

ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

記述できる場所

httpsd.conf

2.3.125　ScriptLogBuffer

リクエストのボディー部のログを採取する場合の最大値を指定します。

説明

PUT、POSTメソッドによるリクエストのボディー部のログを採取する場合の最大値をバイト単位で指定します。ScriptLogディレクティブでエラーログ出力先のファイルを指定した場合だけ、この指定は有効になります。

このディレクティブでの指定値分の領域が、リクエスト処理中に確保されます。そのため、大きい値を指定すると、メモリー確保失敗となって、Webサーバが終了する場合があります。デフォルト値または必要最小限の値を指定することを推奨します。

書式

ScriptLogBuffer バッファー数

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

1024

記述できる場所

httpsd.conf

2.3.126　ScriptLogLength

CGIスクリプトのエラーログファイルの最大サイズを指定します。

説明

CGIスクリプトのエラーログファイルの最大サイズをバイト単位で指定します。ScriptLogディレクティブでエラーログ出力先のファイルを指定した場合だけ指定が有効になります。

書式

ScriptLogLength ファイルサイズ

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

10385760

記述できる場所

httpsd.conf

2.3.127　SendBufferSize

WebサーバのTCP送信バッファサイズをバイト数で指定します。

説明

WebサーバのTCP送信バッファサイズをバイト数で指定します。0を指定した場合、OSのデフォルト値が使用されます。

高速のネットワーク環境では、OSのデフォルト値よりも大きな値を設定することで、レスポンス送信の性能が向上する場合があります。

書式

SendBufferSize 送信バッファサイズ

指定できる値

0、512−2147483647

デフォルト値

定義項目の省略

0

記述できる場所

httpsd.conf

記述例

SendBufferSize 131072

2.3.128　ServerAdmin

サーバ管理者のE-Mailアドレスを指定します。

説明

サーバ管理者のE-Mailアドレスを指定します。ServerSignatureディレクティブでE-Mailを指定する場合は、必ず指定してください。

書式

ServerAdmin E-Mailアドレス

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ServerAdmin www-admin@server.example.com

2.3.129　ServerAlias

サーバ名に基づくバーチャルホストで使用するホスト名の別名を指定します。

説明

サーバ名に基づくバーチャルホストで使用するホスト名（ServerName）の別名を指定します。IPv6アドレスに対応したホスト名も指定できます。

書式

ServerAlias ホスト名 [ホスト名 ...]

記述できる場所

<VirtualHost>

2.3.130　ServerName

Webサーバのサーバ名およびポート番号を指定します。

説明

Webサーバのサーバ名およびポート番号を指定します。

UseCanonicalNameディレクティブ指定値に従い、イメージマップの利用または末尾をスラッシュ（/）で閉じないディレクトリー指定のリクエストなど、Webサーバでリダイレクトが指示された場合のリダイレクト先としてLocationヘッダーに設定されクライアントに返信されるため、クライアントからアクセスできるサーバ名を指定しなければなりません。このディレクティブの指定は必須です。

書式

ServerName サーバ名[:ポート番号]

指定できる値

サーバ名

FQDN（完全修飾ドメイン名）またはIPアドレスで指定します。

サーバ名には、IPv6アドレスまたはIPv6アドレスに対応したFQDNも指定できます。

IPv6アドレスを指定し、かつポート番号を指定する場合は、IPv6アドレスを[ ]で囲んでください。

ポート番号

Webサーバのポート番号を指定します。

ポート番号を省略した場合は、デフォルトのポート番号（SSLが無効の場合は80、SSLが有効の場合は443）が設定されます。

記述できる場所

httpsd.conf、<VirtualHost>

記述例

ServerName www.example.com
ServerName 2001::123:4567:89ab:cdef
ServerName [2001::123:4567:89ab:cdef]
ServerName [2001::123:4567:89ab:cdef]:8080

2.3.131　ServerPath

サーバ名に基づくバーチャルホストで、Hostヘッダーの代わりにパス名を利用して各ホストに接続する場合に指定します。

説明

サーバ名に基づくバーチャルホストで、Hostヘッダーの代わりにパス名を利用して各ホストに接続する場合に指定します。

書式

ServerPath パス名

記述できる場所

<VirtualHost>

2.3.132　ServerRoot

サーバのルートディレクトリーを指定します。

説明

サーバのルートディレクトリーを絶対パスで指定します。

書式

ServerRoot ディレクトリー名

デフォルト値

定義項目の省略

Application Serverのインストールディレクトリー¥httpsd

記述できる場所

httpsd.conf

記述例

ServerRoot "Application Serverのインストールディレクトリー/httpsd"

2.3.133　ServerSignature

Webサーバが作成するエラーメッセージなどのコンテンツのフッターに署名するかどうかを指定します。

説明

Webサーバが作成するエラーメッセージなどのコンテンツのフッターに署名するかどうかを指定します。

書式

ServerSignature {On|Off|Email}

指定できる値

On

ServerTokensディレクティブに従った文字列（「Hitachi Web Server」やバージョン番号など）およびUseCanonicalNameディレクティブ指定値に従ったサーバ名とポート番号を表示します。

Hitachi Web Server 10-00 at www.example.com Port 80

なお、Onを指定した場合、ServerNameディレクティブに指定したIPv6アドレスまたはIPv6アドレスに対応したホスト名を表示できます。

Off

コンテンツのフッターに署名を表示しません。

Email

Onを指定した場合の表示に加えServerAdminディレクティブの指定値をmailtoタグで追加します。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

記述例

ServerSignature On

2.3.134　ServerTokens

Serverヘッダーのフォーマットを指定します。

説明

HTTPレスポンスヘッダーのServerヘッダーのフォーマットを設定します。

メモ

OS種別には、Unix、Win32またはWin64が設定されます。Serverヘッダーの値がどのように利用されるかはクライアントの仕様によります。

書式

ServerTokens {Minimal|OS|Full|ProductOnly}

指定できる値

指定できるServerヘッダーの値を次に示します。

Minimal

Hitachi Web Server バージョン番号

OS

Hitachi Web Server バージョン番号 (OS種別)

Full

Hitachi Web Server バージョン番号 (OS種別) 付加PPで設定された情報

ProductOnly

Hitachi Web Server

デフォルト値

定義項目の省略

Full

記述できる場所

httpsd.conf

記述例

ServerTokens Full

2.3.135　SetEnv

CGIスクリプトに渡す環境変数の値を指定します。

説明

CGIスクリプトに任意の環境変数を渡す場合に設定する環境変数の値を指定します。このディレクティブを複数指定する場合、同じ環境変数に異なる値は指定できません。

書式

SetEnv 環境変数 値

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

SetEnv MY_ENV myenv

2.3.136　SetEnvIf

クライアントからのリクエストを基に環境変数を定義する場合に指定します。

説明

クライアントからのリクエスト値が正規表現で表した条件を満たす場合、指定した環境変数を設定します。

書式

SetEnvIf リクエスト値 正規表現 環境変数[=値] [環境変数[=値] ...]

指定できる値

リクエスト値

HTTPリクエストヘッダーか次の表に示す値を指定できます。先に指定された環境変数をリクエスト値として指定することで環境変数の検査ができます。ただし、この場合の環境変数は、HTTPリクエストヘッダーにも次の表に示す指定値にも一致していない必要があります。

リクエスト値

意味

Remote_Addr

クライアントのIPアドレス

Remote_Host

クライアントのホスト名（リクエストに設定されている場合だけ）

Request_Protocol

リクエストのプロトコル（HTTP/1.1 など）

Request_Method

リクエストのメソッド名（GET、POST、HEADなど）

Request_URI

リクエストのURI

Server_Addr

リクエストを受信したサーバのIPアドレス

このディレクティブを複数指定する場合、同じリクエスト値は複数指定できません。

なお、リクエスト値にRemote_Hostを指定した場合、正規表現にはIPv6アドレスに対応したホスト名も指定できます。また、IPv6を使用した接続に対しては、Remote_AddrとServer_Addrのリクエスト値は使用できません。Remote_AddrとServer_Addrを使用したい場合は、HWSSetEnvIfIPv6ディレクティブで設定してください。

正規表現

条件を指定します。

環境変数

クライアントからのリクエスト値が正規表現で表した条件を満たす場合に設定する環境変数を指定します。

環境変数の前に!を付けると、その環境変数の設定を解除します。

値

環境変数の値を指定します。

設定する値のデフォルト値は1です。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

（例1）

SetEnvIf User-Agent "Mozilla.*" SETENVIF_USER_AGENT=Mozilla

（例2）

SetEnvIf Request_URI "¥.(gif)|(jpg)$" request_is_image

（例3）

IPv4を使用した接続のうち、特定のクライアントに対して環境変数を設定する場合は、次のように指定します。

Listen 123.123.123.123:80
Listen [2001::123:4567:89ab:cdef]:80
<VirtualHost 123.123.123.123:80>
        SetEnvIf Remote_Addr ^234¥.234¥.234¥.234$ IPV4_CLIENT
</VirtualHost>

2.3.137　SetEnvIfNoCase

クライアントからのリクエストを基に環境変数を定義する場合に指定します。

説明

クライアントからのリクエスト値が正規表現で表した条件を満たす場合、指定した環境変数を設定します。

ただし、このディレクティブでは、正規表現の大文字、小文字の区別をしません。また、このディレクティブを複数指定する場合、同じリクエスト値は複数指定できません。

書式

SetEnvIfNoCase リクエスト値 正規表現 環境変数[=値] [環境変数[=値] ...]

指定できる値

リクエスト値

HTTPリクエストヘッダーか次の表に示す値を指定できます。先に指定された環境変数をリクエスト値として指定することで環境変数の検査ができます。ただし、この場合の環境変数は、HTTPリクエストヘッダーにも次の表に示す指定値にも一致していない必要があります。

リクエスト値

意味

Remote_Addr

クライアントのIPアドレス

Remote_Host

クライアントのホスト名（リクエストに設定されている場合だけ）

Request_Protocol

リクエストのプロトコル（HTTP/1.1 など）

Request_Method

リクエストのメソッド名（GET、POST、HEADなど）

Request_URI

リクエストのURI

Server_Addr

リクエストを受信したサーバのIPアドレス

このディレクティブを複数指定する場合、同じリクエスト値は複数指定できません。

なお、リクエスト値にRemote_Hostを指定した場合、正規表現にはIPv6アドレスに対応したホスト名も指定できます。また、IPv6を使用した接続に対しては、Remote_AddrとServer_Addrのリクエスト値は使用できません。Remote_AddrとServer_Addrを使用したい場合は、HWSSetEnvIfIPv6ディレクティブで設定してください。

正規表現

条件を指定します。

ただし、このディレクティブでは、正規表現の大文字、小文字の区別をしません。

環境変数

クライアントからのリクエスト値が正規表現で表した条件を 満たす場合に設定する環境変数を指定します。

環境変数の前に!を付けると、その環境変数の設定を解除します。

値

環境変数の値を指定します。

設定する値のデフォルト値は1です。

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.138　SetHandler

ある特定のハンドラーに関連づける場合に指定します。

説明

指定した<Directory>またはアクセス制御ファイルの範囲すべてのリクエストをハンドラー名で指定したハンドラーに関連づける場合、指定します。ハンドラー名としてnoneを指定すると、それまでのSetHandlerディレクティブの設定が無効になります。

書式

SetHandler ハンドラー名

記述できる場所

<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.139　SSLBanCipher

指定した暗号種別でのアクセスを拒否し、ステータスコード403 Forbiddenを応答する場合に指定します。

説明

指定した暗号種別でのアクセスを拒否し、クライアントにステータスコード403 Forbiddenを応答します。

暗号種別を次に示します。

暗号種別

鍵交換方式

認証方式

対称鍵暗号方式

暗号鍵サイズ(bit)

メッセージ認証アルゴリズム

RC4-MD5

RSA

RSA

RC4

128

MD5

RC4-SHA

RSA

RSA

RC4

128

SHA

AES128-SHA

RSA

RSA

AES

128

SHA

AES128-SHA256

RSA

RSA

AES

128

SHA256

DES-CBC3-SHA

RSA

RSA

DES

168

SHA

AES256-SHA

RSA

RSA

AES

256

SHA

AES256-SHA256

RSA

RSA

AES

256

SHA256

書式

SSLBanCipher 暗号種別 [暗号種別 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.140　SSLCACertificateFile

CAの証明書のファイルを指定します。

説明

SSLでサーバ認証およびクライアント認証する場合、CA（認証局）の公開鍵（PEM形式）のファイル名を指定します。複数の証明書ファイルを連結させて、1つのファイルに複数の証明書が混在できます。

ファイル名は、絶対パスで指定してください。

サーバ認証時の利用

チェーンしたCAで発行されたサーバ証明書を使用して運用する場合、チェーンCAの証明書を設定します。

クライアント認証時の利用

クライアント証明書を発行したCAの証明書を設定します。チェーンされたクライアント証明書の場合、チェーンCAの証明書も設定します。

書式

SSLCACertificateFile ファイル名

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCACertificateFile "Application Serverのインストールディレクトリー
/httpsd/conf/ssl/cacert/anycert.pem"

2.3.141　SSLCertificateFile

SSLで認証する場合、Webサーバの証明書のファイルを指定します。

説明

SSLで認証する場合、Webサーバの証明書（PEM形式）のファイル名を指定します。

ファイル名は、絶対パスで指定してください。

書式

SSLCertificateFile ファイル名

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCertificateFile "Application Serverのインストールディレクトリー
/httpsd/conf/ssl/server/httpsd.pem"

2.3.142　SSLCertificateKeyFile

SSLで認証する場合、Webサーバの秘密鍵のファイルを指定します。

説明

SSLで認証する場合、Webサーバの秘密鍵のファイル名を指定します。

ファイル名は、絶対パスで指定してください。

書式

SSLCertificateKeyFile ファイル名

デフォルト値

定義項目の省略

SSLCertificateFileディレクティブ指定値

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCertificateKeyFile "Application Serverのインストールディレクトリー
/httpsd/conf/ssl/server/httpsdkey.pem"

2.3.143　SSLCertificateKeyPassword

パスワード保護されているサーバ秘密鍵のパスワードを格納するファイルを指定します。

説明

パスワード保護をされているサーバ秘密鍵のパスワードを格納しておくファイルのパス名を指定します。パスワード格納ファイルは、sslpasswdコマンドによって作成します。パス名は絶対パスまたはServerRootディレクティブからの相対パスで指定します。

書式

SSLCertificateKeyPassword パス名

記述できる場所

httpsd.conf、<VirtualHost>

2.3.144　SSLCRLAuthoritative

CRLの次回発行日を経過した場合の動作を指定します。

説明

SSLクライアント認証時に使用するCRLの次回発行日の扱いについて指定します。

書式

SSLCRLAuthoritative {On|Off}

指定できる値

On

SSLクライアント認証時、クライアント証明書に対応するCRLの次回発行日を過ぎていた場合、Webサーバは認証に失敗したとして、クライアントとの接続を拒否します。CRLの正しい運用が必要です。

Off

CRLの次回発行日を無視します。次回発行日を過ぎていてもCRLは有効であると扱うため、CRLに登録されていなければ、クライアントは接続できます。セキュリティーレベルは下がりますが、CRLを正しく運用しなかったときでも、最低限のセキュリティーを維持して、サービスを継続できます。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCRLAuthoritative On

CRLの次回発行日を過ぎている場合、そのCRLを発行したCAが発行した証明書を持つクライアントのアクセスはすべて拒否します。

2.3.145　SSLCRLDERPath

DER形式のCRLを格納するディレクトリーを指定します。

説明

DER形式のCRLを格納するディレクトリーを絶対パスで指定します。指定したディレクトリーに必要なCRLを格納して、Webサーバを起動または再起動すると、SSLでのクライアント認証時にCRLを適用できます。SSLCRLPEMPathディレクティブで指定したディレクトリー内のCRLも含め、同じCAから発行されたCRLを複数格納している場合、発行日が最新のCRLを適用します。ディレクトリー内にDER形式のCRL以外のファイルがある場合、Webサーバは起動しません。

書式

SSLCRLDERPath パス名

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCRLDERPath "Application Serverのインストールディレクトリー/httpsd/conf/ssl/crl/DER"

DER形式のCRLファイルを格納しているディレクトリーを指定します。

2.3.146　SSLCRLPEMPath

PEM形式のCRLを格納するディレクトリーを指定します。

説明

PEM形式のCRLを格納するディレクトリーを絶対パスで指定します。指定したディレクトリーに必要なCRLを格納して、Webサーバを起動または再起動すると、SSLでのクライアント認証時にCRLを適用できます。SSLCRLDERPathディレクティブで指定したディレクトリー内のCRLも含め、同じCAから発行されたCRLを複数格納している場合、発行日が最新のCRLを適用します。ディレクトリー内にPEM形式のCRL以外のファイルがある場合、Webサーバは起動しません。

書式

SSLCRLPEMPath パス名

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLCRLPEMPath "Application Serverのインストールディレクトリー/httpsd/conf/ssl/crl/PEM"

PEM形式のCRLファイルを格納しているディレクトリーを指定します。

2.3.147　SSLDenySSL

SSLによるアクセスを禁止する場合に指定します。

説明

SSLによるアクセスを禁止する場合に指定します。このディレクティブが指定されている場合、SSLEnableディレクティブでSSLを有効にしてもhttpsによるアクセスがステータスコード403 Forbiddenで拒否されます。SSLRequireSSLディレクティブの逆の動作をします。

書式

SSLDenySSL

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.148　SSLDisable

SSLを無効にする場合に指定します。

説明

SSLを無効にします。デフォルト値はSSLEnableディレクティブ（SSLを有効）です。バーチャルホストで特定のホストに対してSSLを無効にする場合などに指定します。

書式

SSLDisable

記述できる場所

httpsd.conf、<VirtualHost>

2.3.149　SSLEnable

SSLを有効にする場合に指定します。

説明

SSLを有効にします。SSLDisableディレクティブを指定しないかぎり、デフォルトで有効になります。

書式

SSLEnable

記述できる場所

httpsd.conf、<VirtualHost>

2.3.150　SSLExportCertChainDepth

環境変数SSL_CLIENT_CERT_CHAIN_nにクライアントの証明書を発行したCAからルートCAまでの証明書を設定するときに指定します。

説明

SSLクライアント認証をする場合、環境変数SSL_CLIENT_CERT_CHAIN_nにクライアントの証明書を発行したCAからルートCAまでの証明書を設定するときに指定します。指定した値がnの最大値になります。このディレクティブはSSLExportClientCertificatesディレクティブを指定している場合だけ有効になります。指定された数のCA証明書がgcacheサーバへキャッシュされるため、CGIまたはServletで必要な数だけをこのディレクティブに指定することでキャッシュを有効に利用できます。ただし、メモリーの制限でキャッシュされた一部の証明書が削除されて取得できなかった場合は、取得できたものだけを環境変数に設定します。

書式

SSLExportCertChainDepth 値

指定できる値

0

環境変数は設定しません。

1〜9

クライアントの証明書に近い方から順に番号が割り当てられ、環境変数を設定します。環境変数にはDER形式の証明書をBase64エンコーディングした値を設定します。1つの証明書をBase64エンコーディングした場合のバイト数は約1KBです。

デフォルト値

定義項目の省略

0

記述できる場所

httpsd.conf、<VirtualHost>

記述例

「ルートCA−下位CA−クライアント証明書」という証明書チェーンの場合

環境変数と証明書の対応は次のようになります。

環境変数

証明書

SSL_CLIENT_CERT

クライアント証明書

SSL_CLIENT_CERT_CHAIN_1

下位CAの証明書

SSL_CLIENT_CERT_CHAIN_2

ルートCAの証明書

この環境変数と証明書チェーンをすべて取得するには、次のようにディレクティブを指定します。

SSLExportClientCertificates
SSLExportCertChainDepth 2

SSLExportCertChainDepthには、2以上の値を指定します。

2.3.151　SSLExportClientCertificates

環境変数SSL_CLIENT_CERTにクライアント証明書を設定するときに指定します。

説明

SSLクライアント認証をする場合、環境変数SSL_CLIENT_CERTにクライアント証明書を設定するときに指定します。環境変数SSL_CLIENT_CERTにはDER形式の証明書をBase64エンコーディングした値を設定します。

書式

SSLExportClientCertificates

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

2.3.152　SSLFakeBasicAuth

クライアント証明書を利用したBasic認証をする場合に指定します。

説明

SSLクライアント認証の機能とあわせて、WebブラウザーでユーザーIDとパスワードを入力することなく、クライアント証明書の提示だけでBasic認証をできるようにします。AuthUserFileディレクティブで指定するファイルにはX509クライアント証明書のSubjectとパスワードを記述します。パスワードは、次に示す値で常に固定とします（"password"を暗号化したもの）。

"{SHA}W6ph5Mm5Pz8GgiULbPgzG37mj9g="

書式

SSLFakeBasicAuth

記述できる場所

httpsd.conf、<VirtualHost>

記述例

hwscertutilコマンドで表示する証明書のSubjectフィールドの値

Subject: EMAIL=username@userhost,CN=username,OU=Software,O=HITACHI,
L=Yokohama-shi,ST=Kanagawa,C=JP

この場合、AuthUserFileディレクティブで指定するファイルは次のように指定します。

/C=JP/ST=Kanagawa/L=Yokohama-shi/O=HITACHI/OU=Software/CN=username
/Email=username@userhost:{SHA}W6ph5Mm5Pz8GgiULbPgzG37mj9g=

LogFormatディレクティブのu指定ではSubjectがロギングされます。

認証に失敗した場合、ステータスコード401 Authorization Requiredを応答します。

2.3.153　SSLProtocol

使用するSSLプロトコルのバージョンを指定します。

説明

使用するSSLプロトコルのバージョンを指定します。

プロトコル名として設定できる値は次のとおりです。

SSLv3

SSLプロトコルバージョン3を使用する。

TLSv1

TLSプロトコルバージョン1.0を使用する。

TLSv11

TLSプロトコルバージョン1.1を使用する。

TLSv12

TLSプロトコルバージョン1.2を使用する。

All

上記すべてのプロトコルを使用する。

書式

SSLProtocol プロトコル名 [プロトコル名 ...]

デフォルト値

定義項目の省略

All

記述できる場所

httpsd.conf、<VirtualHost>

2.3.154　SSLRequireCipher

指定した暗号種別以外でのアクセスを拒否し、ステータスコード403 Forbiddenを応答する場合に指定します。

説明

指定した暗号種別以外でのアクセスを拒否し、クライアントにステータスコード403 Forbiddenを応答します。

暗号種別を次に示します。

暗号種別

鍵交換方式

認証方式

対称鍵暗号方式

暗号鍵サイズ(bit)

メッセージ認証アルゴリズム

RC4-MD5

RSA

RSA

RC4

128

MD5

RC4-SHA

RSA

RSA

RC4

128

SHA

AES128-SHA

RSA

RSA

AES

128

SHA

AES128-SHA256

RSA

RSA

AES

128

SHA256

DES-CBC3-SHA

RSA

RSA

DES

168

SHA

AES256-SHA

RSA

RSA

AES

256

SHA

AES256-SHA256

RSA

RSA

AES

256

SHA256

書式

SSLRequireCipher 暗号種別 [暗号種別 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

2.3.155　SSLRequiredCiphers

SSL通信で使用できる暗号種別を指定します。

説明

SSL通信で使用できる暗号種別を指定します。ディレクティブに指定した暗号種別とクライアントが使用できる暗号種別との間で一致するものがあれば、SSL通信が確立されHTTPリクエストを受信します。一致するものがない場合は、SSL通信は確立されないでHTTPリクエストを受信しません。

暗号種別を次に示します。

暗号種別

鍵交換方式

認証方式

対称鍵暗号方式

暗号鍵サイズ(bit)

メッセージ認証アルゴリズム

RC4-MD5

RSA

RSA

RC4

128

MD5

RC4-SHA

RSA

RSA

RC4

128

SHA

AES128-SHA

RSA

RSA

AES

128

SHA

AES128-SHA256

RSA

RSA

AES

128

SHA256

DES-CBC3-SHA

RSA

RSA

DES

168

SHA

AES256-SHA

RSA

RSA

AES

256

SHA

AES256-SHA256

RSA

RSA

AES

256

SHA256

書式

SSLRequiredCiphers 暗号種別 [:暗号種別 ...]

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLRequiredCiphers RC4-MD5:RC4-SHA:DES-CBC3-SHA:AES128-SHA:AES256-SHA

2.3.156　SSLRequireSSL

SSL以外のアクセスを禁止する場合に指定します。

説明

SSL以外によるアクセスを禁止する場合に指定します。このディレクティブが指定されている場合、SSLDisableディレクティブでSSLを無効にしてもhttpによるアクセスがステータスコード403 Forbiddenで拒否されます。異なるディレクティブの記述場所で、不用意にSSLを無効にしコンテンツを公開してしまうことを防止します。

書式

SSLRequireSSL

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

<VirtualHost 172.17.40.10:443>
 SSLDisable
 ...
 <Directory /secure/dir>
 SSLRequireSSL
 ...
 </Directory>
 </VirtualHost>

172.17.40.10ホストの443ポートに対するhttpアクセスは、/secure/dirディレクトリーへのアクセスを除いてできます。/secure/dirディレクトリーへのhttpアクセスは、ステータスコード403 Forbiddenを応答します。

2.3.157　SSLSessionCacheSize

セッションキャッシュサイズの上限値を指定します。

説明

セッションキャッシュサイズの上限値をバイト単位で指定します。0を指定した場合、セッションキャッシュは実施されません。

maxを指定した場合、上限を設定しません。1SSLセッション当たり、サーバ認証だけする場合約200バイト、クライアント認証もする場合約1キロバイト使用します。

書式

SSLSessionCacheSize {サイズ|max}

指定できる値

0〜2147483647

デフォルト値

定義項目の省略

16777216

記述できる場所

httpsd.conf

記述例

SSLSessionCacheSize 1024

2.3.158　SSLSessionCacheTimeout

SSLセッションの有効時間を指定します。

説明

Webサーバ内またはSSLセッション管理キャッシュサーバgcache内で保持されるセッションIDなどのデータの有効時間を秒単位で指定します。

重要

グリニッジ標準時（GMT）の2038年1月19日3時14分7秒を超えないように、有効時間を設定してください。

書式

SSLSessionCacheTimeout 値

指定できる値

1−2147483647

デフォルト値

定義項目の省略

3600

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLSessionCacheTimeout 3600

2.3.159　SSLVerifyClient

クライアント認証時の証明書に関する設定をする場合に指定します。

説明

クライアント認証時の証明書に関する設定を指定します。

書式

SSLVerifyClient {0|1|2}

指定できる値

0

証明書の要求をしません。

1

クライアントは証明書を提示できます（運用テスト用）。

2

クライアントは証明書を提示しなければなりません。

デフォルト値

定義項目の省略

0

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLVerifyClient 2

2.3.160　SSLVerifyDepth

証明書のチェーンを何段階までたどるかを指定します。

説明

証明書のチェーンを何段階までたどるかを指定します。

クライアント認証に使用するCA証明書のチェーンについて、認証チェックをする段階数を指定します。チェーンされたCAをどこまで信用するかを制限するために使用します。自己署名の証明書は認証しないため、段階数は2以上を指定します。例を次に示します。

（例）

条件1

CA1は、root CAに署名されている。

条件2

証明書1は、root CAに署名されている。

条件3

証明書2は、CA1に署名されている。

SSLVerifyDepthの指定

この場合、証明書1、証明書2とも認証チェックをするためには、SSLVerifyDepthディレクティブに3以上を指定します。また、証明書1は認証チェックし、証明書2は認証チェックをしないようにするにはSSLVerifyDepthディレクティブに2を指定します。

書式

SSLVerifyDepth 段階数

指定できる値

0−10

デフォルト値

定義項目の省略

0

記述できる場所

httpsd.conf、<VirtualHost>

記述例

SSLVerifyDepth 10

2.3.161　ThreadsPerChild

サーバとして起動するスレッド数を指定します。

説明

サーバとして起動するスレッド数を指定します。指定したスレッド数はサーバの最大同時接続数を示します。

書式

ThreadsPerChild スレッド数

指定できる値

1−1024

デフォルト値

定義項目の省略

64

記述できる場所

httpsd.conf

記述例

ThreadsPerChild 50

2.3.162　Timeout

Webサーバの送受信の待ち時間を指定します。

説明

次の待ち時間を秒単位で指定します。0を指定した場合は、待ち時間が0秒になります。

クライアントからのリクエスト受信（コネクション確立後、HTTPプロトコルの受信）中にデータを受信しなくなった場合の待ち時間

クライアントへのレスポンス送信中にデータを送信できなくなった場合の待ち時間

CGIプログラムへのリクエスト送信中にデータを送信できなくなった場合の待ち時間

CGIプログラムへのリクエスト送信後からレスポンス受信までの待ち時間

CGIプログラムからのレスポンス受信中にデータを受信しなくなった場合の待ち時間

CGIプログラムからのレスポンス受信後、入出力用のパイプを閉じるまでの待ち時間

リバースプロキシーを使用している場合の、バックエンドサーバへのリクエスト送信中にデータを送信できなくなった場合の待ち時間

リバースプロキシーを使用している場合の、バックエンドサーバへのリクエスト送信後からレスポンス受信までの待ち時間

リバースプロキシーを使用している場合の、バックエンドサーバからのレスポンス受信中にデータを受信しなくなった場合の待ち時間

リバースプロキシー使用時のバックエンドサーバとの送受信の待ち時間は、ProxyTimeoutディレクティブの値が優先されます。

書式

Timeout 時間

指定できる値

0−65535

デフォルト値

定義項目の省略

60

記述できる場所

httpsd.conf

記述例

Timeout 300

2.3.163　TraceEnable

TRACEメソッドによるリクエストを拒否するかどうかを指定します。

説明

TRACEメソッドによるリクエストを拒否するかどうかを指定します。

書式

TraceEnable {On|Off|extended}

指定できる値

On

TRACEメソッドによるリクエストを許可します。ただし、リクエストボディーが付加されている場合は、413 Request Entity Too Largeを応答します。

Off

TRACEメソッドによるリクエストを拒否します。TRACEメソッドによるリクエストの場合は、ステータスコード403 Forbiddenを応答します。

extended

TRACEメソッドによるリクエストを許可します。リクエストボディーが付加されていても許可します。ただし、リバースプロキシー以外のリクエストボディーサイズの上限は64KBです。

デフォルト値

定義項目の省略

On

記述できる場所

httpsd.conf、<VirtualHost>

記述例

TraceEnable Off

2.3.164　TransferLog

ラベル名を指定しないLogFormatディレクティブのフォーマットでのアクセスログを出力する場合に指定します。

説明

ログを格納するファイルまたはログを出力するプログラムを指定します。ログのフォーマットはラベル名を指定しないLogFormatディレクティブで指定できます。

LogFormatディレクティブでログのフォーマットを指定する場合は、IPv6アドレスやIPv6アドレスに対応したホスト名も出力できます。

LogFormatディレクティブでフォーマットを指定しない場合は、標準のログフォーマットで出力します。

書式

TransferLog {ファイル名|パイプ}

指定できる値

ファイル名

ログを格納するファイル名を指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

パイプ

標準入力からログ情報を受け取るプログラムを"|プログラム名"のフォーマットで指定します。

記述できる場所

httpsd.conf、<VirtualHost>

記述例

TransferLog "|
¥"¥"Application Serverのインストールディレクトリー/httpsd/sbin/rotatelogs.exe¥"
¥"Application Serverのインストールディレクトリー/httpsd/logs/access¥" 86400¥""

rotatelogsプログラムを使用してログを24時間ごとに分割して採取します。

2.3.165　TypesConfig

ファイル拡張子とコンテントタイプの関係を定義する設定ファイルを指定します。

説明

ファイル拡張子とコンテントタイプ（MIMEタイプ）の関係を定義する設定ファイルを指定します。ファイル名には、絶対パスまたはServerRootディレクティブの指定値からの相対パスが指定できます。

設定ファイル内の指定形式は、MIMEタイプ ファイル拡張子 [ファイル拡張子 ...]です。MIMEタイプだけ指定している行は無視します。また、行の最初に#を付けると、コメント行になります。

書式

TypesConfig ファイル名

デフォルト値

定義項目の省略

conf/mime.types

記述できる場所

httpsd.conf

記述例

TypesConfig conf/mime.types

MIMEタイプの設定ファイルはmime.types

2.3.166　UnsetEnv

CGIスクリプトに渡す環境変数から、SetEnvディレクティブまたはPassEnvディレクティブで指定した環境変数を削除する場合に指定します。

説明

CGIスクリプトに渡す環境変数から、SetEnvディレクティブまたはPassEnvディレクティブで指定した環境変数を削除する場合に指定します。

書式

UnsetEnv 環境変数 [環境変数 ...]

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>、.htaccess

上書き許可

FileInfoレベル

記述例

UnsetEnv MY_ENV

2.3.167　UseCanonicalName

サーバの正式な名前の生成方法を指定します。

説明

サーバの正式な名前の生成方法を指定します。サーバの正式な名前は、自サーバを参照するURLや環境変数のSERVER_NAMEとSERVER_PORTに設定されます。なお、On、Off、dnsすべての場合で、IPv6アドレスに対応しています。

書式

UseCanonicalName {On|Off|dns}

指定できる値

On

サーバの正式な名前は、ServerNameディレクティブ指定値から作成され、自サーバを参照するURLや環境変数に設定されます。VirtualHost指定時にIPアドレスを使用する場合は、VirtualHostブロック内でServerNameを指定してください。ブロック内でServerNameを指定していない場合は、IPアドレスからホスト名を取得します。

Off

サーバの正式な名前は、Hostヘッダーによってクライアントから与えられたホスト名称とポート番号から作成され、自サーバを参照するURLや環境変数に設定されます。ただし、Hostヘッダーが与えられない場合は、ServerNameディレクティブ値と、実際のコネクションに使用されているポート番号から作成されます。

dns

Hostヘッダーを持たない古いクライアントのためのオプションです。このオプション指定時には、サーバの正式な名前は、クライアントから与えられたサーバのIPアドレスから逆引きしたホスト名称および実際にコネクションに使用されているポート番号から作成され、自サーバを参照するURLや環境変数に設定されます。

デフォルト値

定義項目の省略

Off

記述できる場所

httpsd.conf、<VirtualHost>、<Directory>

2.3.168　UserDir

Webブラウザーからの/~ユーザー名/へのリクエストに対して公開するサーバ上の場所を指定します。

説明

Webブラウザーからの/~ユーザー名/へのリクエストに対して公開するサーバ上の場所をディレクトリー名で指定します。disabledを指定すると、Webコンテンツを公開しないユーザーを指定できます。

ディレクトリー名は、絶対パスで指定します。

ディレクトリー名

絶対パスで指定した場合

ユーザーディレクトリーの場所を指定します。/~ユーザー名/へのリクエストがあった場合、"ディレクトリー名/ユーザー名"にアクセスします。

disabled

Webブラウザーからの/~ユーザー名/へのリクエストに対して、Webコンテンツを公開しないユーザーを指定します。指定されたユーザー名でのリクエストに対しては、アクセスするディレクトリー名を変換しません。ユーザー名の指定がない場合は、すべてのユーザーについてdisabledを指定したことになります。

重要

複数のUserDirディレクティブでディレクトリー名を指定した場合、あとから指定したものに上書きされます。

disabledに指定するユーザー名は、複数のUserDirディレクティブを用いて指定できます。

書式

UserDir {ディレクトリー名|disabled [ユーザー名 [ユーザー名 ...]]}

デフォルト値

定義項目の省略

disabled

記述できる場所

httpsd.conf、<VirtualHost>

記述例

(例1)

UserDir public_html

ユーザーuser1のホームディレクトリーを/home/user1とすると、リクエストhttp://ホスト名[:ポート番号]/~user1/index.htmlで、/home/user1/public_html/index.htmlにアクセスします。

(例2)

UserDir /home
UserDir disabled user3
UserDir disabled user4 user5

リクエストhttp://ホスト名[:ポート番号]/~user1/index.htmlで、/home/user1/index.htmlにアクセスします。ただし、user3はdisabledが指定されているため、http://ホスト名[:ポート番号]/~user3/index.htmlというリクエストで/home/user3/index.htmlにアクセスできません。user4、user5についてもuser3と同様です。

(例3)

UserDir disabled

すべてのユーザーに対してdisabledを指定します。

2.4　mime.types

コンテンツのファイル拡張子とコンテントタイプの関連づけを定義するファイルです。

説明

コンテンツのファイル拡張子とコンテントタイプ（MIMEタイプ）の関連づけを定義します。システム管理者が管理します。

書式

MIMEタイプ ファイル拡張子 [ファイル拡張子 ...]

格納先

Application Serverのインストールディレクトリー¥httpsd¥conf¥mime.types

2.5　アクセス制御ファイル

アクセス制御を定義するアクセス制御ファイルです。

説明

アクセス制御ファイル（.htaccess）を特定のディレクトリー下に作成すれば、そのディレクトリーに対するアクセス権を設定できます。

アクセス制御ファイルの名称は、AccessFileNameディレクティブで指定します。デフォルトは.htaccessです。

アクセス制御ファイルによるアクセス制御は、Webサーバを再起動することなく、有効になります。ただし、正しく機能させるためには、httpsd.confのAllowOverrideディレクティブを適切な上書き許可レベルに設定する必要があります。

アクセス制御ファイルにパスワードファイルを指定すると、ユーザーがそのディレクトリーにアクセスする場合にユーザー名およびパスワードの入力を要求します。

アクセス制御ファイル（.htaccess）とパスワードファイル（.htpasswd）は1対1である必要はありません。異なるアクセス制御ファイルのAuthUserFileディレクティブに同じパスワードファイルを指定できます。

書式

ディレクティブの記述規則を次に示します。

正規表現

ディレクティブの指定に使用できる正規表現を次に示します。

記号

機能

使用例

使用例の意味

.

任意の1文字。

a...c

aのあとに任意の3文字とcが続く。abcdcは適合する。

*

直前の1文字の0個以上の繰り返し。

ab*cd*

ac、abbbbc、abbbbcdは適合する。

+

直前の1文字の1個以上の繰り返し。

ab*c+

abbbcは適合する。abbbは適合しない。

?

直前の1文字があるかないか。

abbbc?

abbbc、abbbは適合する。

|

選択肢の区切り。

a|bc|d

a、bcまたはd。

¥

直後の特殊文字（. ^$*+?|¥[](){}）の1文字。ただし、¥を表す場合は¥¥¥。

¥.

.と適合する。

¥¥¥

1文字の¥と適合する。

^

行の先頭に適合する。

^ab

abcdeは適合する。

$

行の末尾に適合する。

abc$

aaabcは適合する。

{m}

直前の正規表現のm個の繰り返し。

a{5}

aaaaaが適合する。

{m,}

直前の正規表現のm個以上の繰り返し。

a{3,}

aaa、aaaaは適合する。aaは適合しない。

{m,n}

直前の正規表現のm個以上n個以下の繰り返し。

a{3,5}

aaa、aaaa、aaaaaが適合する。aa、aaaaaaは適合しない。

[文字列]

文字列にある任意の1文字。※

[abc]*または[a-c]*

aaa、bbb、ccc、cba、aabは適合する。

[^文字列]

文字列にない任意の1文字。

[^0-9]

数字以外の1字が適合する。

(文字列)

文字列をグループ化する。

(ab)+

abababが適合する。ababbは適合しない。

aa(xx|yy)bb

aaxxbb、aayybbが適合する。

注※

次の3文字は、[文字列]で特殊な意味を持ちます。

^：[の次に指定して、文字列に含まれないものを示すために用います。

]：文字列の最後を示すために用います。

-：範囲を指定するために用います。

また、これら特殊文字の前の¥は省略されます。

[文字列]で特殊な意味を持つ文字を通常の文字として指定するには、次のようにします。なお、次の4つ以外の特殊文字は、通常の文字として扱われます。

^ ：文字列の先頭以外で指定します。（例）[ab^yz]

]：文字列の先頭に指定します。（例）[]abxy]

-：最後に指定します。（例）[abxy-]

¥：¥¥¥と指定します。（例）[¥¥¥abxy]

ディレクティブに指定するパス情報

ディレクトリー名、ファイル名またはパス名を指定するディレクティブの場合、ディレクティブの種類によって、指定できるパス情報が異なります。

パスの種類には、次のものがあります。各ディレクティブのパス情報は、各ディレクティブで説明します。

絶対パスしか指定できません（ドライブ名を付けた指定も絶対パスに含まれます）。

ServerRootディレクティブの指定値からの相対パスで指定できます（ただし、ServerRootディレクティブの指定が先に必要）。

また、パス情報にネットワーク上のディレクトリーやファイルを指定することはできません。ネットワークを使用したファイルシステム上のディレクトリーやファイルを指定することもできません。

コメント行

設定ファイル中、行の最初に#を付けると、コメント行になります。ただし、ディレクティブを指定したあとに#から始まる文字列を記述しても、#以降をコメントとして扱いません。

コメント行を指定する場合の記述例を次に示します。

正しい例

#Deny from all

#行はコメント行として扱われます。

誤った例

Deny from all    #comment

#commentはディレクティブ指定値として扱われます。コメントとしては扱われません。

IPv6アドレスを指定するときの注意

ディレクティブにIPv6アドレスを記述する場合は、「[IPv6アドレス]」のようにIPv6アドレスを[ ]で囲んで指定してください。また、ディレクティブにIPv6アドレスとポート番号を併記する場合は、「[IPv6アドレス]:ポート番号」のようにIPv6アドレスを[ ]で囲み、「:」の後ろにポート番号を指定します。

ただし、次のディレクティブにIPv6アドレスを記述する場合は、IPv6アドレスを[ ]で囲まないで指定してください。

Allow fromディレクティブ

Deny fromディレクティブ

HWSSetEnvIfIPv6ディレクティブ

IPv6アドレスを指定する場合は、グローバルユニキャストアドレスを指定してください。

格納先

アクセス制御するディレクトリー

記述例

次のようなディレクトリー構成で、各ディレクトリーに対してアクセス制御ファイルにアクセス権を設定します。

[user001のpublic_html]
 |
 +-[auth]--+-.htaccess
 |         +-index.html
 |
 +-[test1]-+-.htaccess
 |         +-.htpasswd (user001/test1)
 |         +-index.html
 |         +-[test11]-+-.htaccess
 |         |          +-.htpasswd (user001/test11)
 |         |          +-index.html
 |         |
 |         +-[test12]-+-index.html
 |                    +-[test121]-+-.htaccess
 |                                +-index.html
 |
 +-[test2]-+-.htaccess
           +-.htpasswd (user001/test21,user002/test22,user003/test23)
           +-.groupfile(mygroup: user001 user002)
           +-index.html

（例1）authディレクトリー下のアクセス権の定義（auth/.htaccessファイル）

IPアドレスが172.18.102.11および172.16.202.4のサーバからのアクセスを拒否します。

Order deny,allow                     ...1.
Deny from 172.18.102.11 172.16.202.4  ...2.

アクセス拒否の定義を先に評価

アクセス拒否の定義

（例2）test1ディレクトリー下のアクセス権の定義（test1/.htaccessファイル）

ユーザー名=user001、パスワード=test1を入力した場合だけ、test1/index.htmlおよびtest1/test12/index.htmlへのアクセスを許可します。

AuthUserFile C:/user001/public_html/test1/.htpasswd      ...1.
AuthName "test1 Directory"                               ...2.
AuthType Basic
<Limit GET POST>                                         ...3.
   Require user user001                                  ...4.
</Limit>

パスワードファイルに登録しているユーザー名（user001）およびパスワード（test1）の定義

realm名の定義

メソッドに対する定義

ユーザー名：user001のアクセスを許可

（例3）test1/test11ディレクトリー下のアクセス権の定義（test1/test11/.htaccessファイル）

ユーザー名=user001、パスワード=test11を入力した場合だけ、test1/test11/index.htmlへのアクセスを許可します。

AuthUserFile C:/user001/public_html/test1/test11/.htpasswd      ...1.
AuthName "test11 Directory"                                     ...2.
AuthType Basic
<Limit GET POST>                                                ...3.
   Require user user001                                         ...4.
</Limit>

パスワードファイルに登録しているユーザー名（user001）およびパスワード（test11）の定義

realm名の定義

メソッドに対する定義

ユーザー名：user001のアクセスを許可

（例4）test1/test12/test121ディレクトリー下のアクセス権の定義（test1/test12/test121/.htaccessファイル）

ユーザー名=user001、パスワード=test1を入力し、WebブラウザーがMSIEの場合だけ、test1/test12/test121/index.htmlへのアクセスを許可します。

Order deny,allow      ...1.
Allow from env=MSIE   ...2.
Deny from all         ...3.

アクセス拒否の定義を先に評価

WebブラウザーがMSIEの場合、アクセスを許可

すべてのホストからのアクセスを拒否

ただし、httpsd.confに次のディレクティブを定義しているものとします。

SetEnvIf User-Agent ".*MSIE.*" MSIE

（例5）test2ディレクトリー下のアクセス権の定義（test2/.htaccessファイル）

mygroupグループのユーザー名、パスワードを入力した場合だけ、test2/index.htmlへのアクセスを許可します。

AuthUserFile C:/user001/public_html/test2/.htpasswd        ...1.
AuthGroupFile C:/user001/public_html/test2/.groupfile      ...2.
AuthName "test2 Directory"                                 ...3.
AuthType Basic
<Limit GET POST>                                           ...4.
   Require group mygroup                                   ...5.
</Limit>

パスワードファイルに登録している次の情報の定義

ユーザー名：user001、パスワード：test21

ユーザー名：user002、パスワード：test22

ユーザー名：user003、パスワード：test23

グループファイルに登録しているグループ名（mygroup）およびmygroupに登録しているユーザー名（user001、user002、user003）の定義

realm名の定義

メソッドに対する定義

グループ名「mygroup」のアクセスを許可

2.6　Webサーバで使用する定義項目（ユーティリティー）の詳細

Webサーバの動作環境を設定するための各種ユーティリティーについて説明しています。

2.6.1　rotatelogs

ログを時間単位に分割して、複数のファイルに出力します。

説明

アクセスログやエラーログを一定時間単位（例えば、24時間ごと）に分割して、複数のファイルに出力できます。rotatelogsプログラムは次のディレクティブに指定できます。

CustomLogディレクティブ

ErrorLogディレクティブ

HWSRequestLogディレクティブ

TransferLogディレクティブ

書式

rotatelogs 分割ログファイルのプレフィックス ログ分割時間間隔
    [-fnum ファイル数] [-diff GMTに対する時差]

分割ログファイルのプレフィックス

分割ログファイルのプレフィックスを絶対パスで指定します。

「プレフィックス.nnnnnnnnnn」というファイルに、ログを採取します。

nnnnnnnnnn：ログ採取開始時刻を表します。ログ採取時刻とは次の式で示す値です。

（（1970年1月1日の0時0分0秒(GMT)を起点とした、ログを出力する時間の通算秒数÷ログ分割時間間隔）の小数点以下を切り捨てた値）×ログ分割時間間隔

ログ分割時間間隔

1つのログファイルを採取する時間間隔を秒単位に指定します。指定した時間が経過するごとに、新規ファイルにログを採取します。

指定できる値

1〜31536000

-fnum ファイル数

分割したログファイルのファイル数を指定します。分割したファイル数がここで指定した数を超えた場合、最も古いファイルから削除します。このオプションを省略した場合、ファイルは削除しません。

指定できる値

1〜256

-diff GMTに対する時差

ログファイルを分割する基準となる時間を、GMTに対する時差として分単位で指定します。指定しないまたは0を指定すると、1970年1月1日0時0分0秒(GMT)が基準時間となります。GMTに対するローカルタイムの差がn時間である場合に、ローカルタイムのm時0分0秒を基準にするときには、(n-m)×60を指定します。JSTの0時0分0秒を基準にする場合には、(+9-0)×60で540を指定します。

指定できる値

-1439〜1439

格納先

Application Serverインストールディレクトリー¥httpsd¥sbin

記述例

ディレクティブに、"|プログラム名"の形式で指定して使用します。ログファイルを定期的に別ファイルに分割して採取します。

24時間ごとに、アクセスログを分割してApplication Serverインストールディレクトリー¥httpsd¥logs¥access.nnnnnnnnnnファイルに採取します。分割時間を日本時間に設定し、日本時間の毎0時にログファイルを分割する場合の指定を次に示します。

TransferLog "|¥"¥"Application Serverインストールディレクトリー/httpsd/sbin/rotatelogs.exe¥" ¥"Application Serverインストールディレクトリー/httpsd/logs/access¥" 86400 -diff 540¥""

ログファイル名：Application Serverインストールディレクトリー¥httpsd¥logs¥access.nnnnnnnnnn

ログ分割時間間隔：86400秒（＝24時間）

注意事項

ログファイルは、そのファイルを開いているプロセスがある間は削除できません。このため、-fnumオプションで指定した値より多いファイルが残ることがあります。例えば、制御プロセスがログを出力したファイルは、制御プロセスが終了するまで削除されません。

起動時に引数誤りなどがあった場合、Webサーバは起動しますがrotatelogsプログラムは起動しません。その際、rotatelogsプログラムではイベントログに、次に示す属性を持ったメッセージを出力します。

種類：エラー

ソース：HitachiWebServer

分類：なし

イベント：3299

説明：rotatelogs.exe: (メッセージ)

このメッセージが出力されていた場合、メッセージ内容に従って引数を見直したあとに、サーバを再起動してください。なお、同じメッセージが複数回出力されることがあります。

-fnumオプションの指定でのログファイルの制御では、Webサーバの再起動時にディレクトリー名またはログファイルのプレフィックスを変更すると、以前に採取したログファイルが削除されません。この場合は運用に応じて削除してください。

Webサーバを起動または再起動してから、指定したログ分割間隔時間が経過した場合、分割したログファイルのプレフィックスに一致するファイルの数が-fnumオプションの指定値を超えると、作成時間の古いログファイルから削除されます。

分割ログファイルのプレフィックスは絶対パスで指定してください。

rotatelogsプログラムの引数指定に誤りがある場合、rotatelogsプログラムの起動に失敗しますが、Webサーバは起動します。この場合はログは出力されません。rotatelogsプログラムを指定した場合は、ログファイルが作成され、意図した分割が実施されることを確認してください。

2.6.2　rotatelogs2

ログをファイルサイズで分割して、複数のファイルに出力します。

説明

アクセスログやエラーログをログファイルサイズで分割して、複数のファイルにラップアラウンドして出力できます。rotatelogs2プログラムは次のディレクティブに指定できます。

CustomLogディレクティブ

ErrorLogディレクティブ

HWSRequestLogディレクティブ

TransferLogディレクティブ

書式

rotatelogs2 ログファイルプレフィックス名 ログファイルサイズ
    ログファイル個数

ログファイルプレフィックス名

出力するログファイルのプレフィックス名を絶対パスで指定します。

出力するログファイルは、プレフィックス.nnnのファイル名となります。

.nnnは、.001からログファイル個数で指定した値までです。

ログファイル個数をnnn面とすると、nnn面のうち、Webサーバ起動時の更新時刻が最新のものが、カレントのログファイルとなります。ログファイルは、ファイル名称のプレフィックスに拡張子.001〜.nnnを付けて区別します。カレントのログファイルの拡張子が.mmmであった場合、カレントのログファイルがいっぱいになると、続きは、.mmm+1 のログファイルをクリアして出力されます。.mmmが.nnnと一致した場合、続きは.001に出力されます。

プレフィックス.indexのインデックス番号格納用ファイルが作成されます。このファイルは.nnn管理用ファイルであり、rotatelogs2プログラムの起動時に作成され、停止時に削除されます。なお、起動エラーの一部などで削除されないことがありますが、以降のWebサーバの動作に影響はありません。

ログファイルサイズ

ログファイルの最大サイズ（単位：KB）を指定します。

ログを出力するタイミングで、最大サイズを超えていると、次のログファイルをクリアして続きが出力されます。

指定できる値

1〜2097151

ログファイル個数

出力するログファイルの最大数を指定します。

最大サイズを超えて次のログファイルに移る場合、それまで処理していたログファイルの拡張子が、最大個数と同じとき、再度.001のファイルから使用します。

指定できる値

1〜256

格納先

Application Serverインストールディレクトリー¥httpsd¥sbin

記述例

ディレクティブに、"|プログラム名"の形式で指定して使用します。

（例）4,096KBごとにエラーログを最大5個採取する場合

ErrorLog "|¥"¥"Application Serverインストールディレクトリー/httpsd/sbin/rotatelogs2.exe¥" ¥"Application Serverインストールディレクトリー/httpsd/logs/errorlog¥" 4096 5¥""

errorlog.001〜errorlog.005の順番にログが出力されます。errorlog.005が4,096KBを超えるとerrorlog.001をクリアして続きが出力されます。Webサーバ起動時に、すでにこれらのログファイルがある場合には、更新時刻の最も新しいログファイルが、出力対象のログファイルとなります。このログファイルのサイズがすでに4,096KBを超えている場合には、次のログファイルをクリアして続きが出力されます。4,096KBを超えない場合は、このファイルの続きに出力されます。

注意事項

インデックス番号格納用ファイルは、rotatelogs2プログラムが動作中の間は、編集や削除をしないでください。編集するとログが正しく出力されないことがあります。

Webサーバの起動時にインデックス番号格納用ファイルプレフィックス.indexと同名のファイルが存在した場合、ファイルは上書きされます。

起動時に引数誤りなどがあった場合、Webサーバは起動しますがrotatelogs2プログラムは起動しません。その際、rotatelogs2プログラムではイベントログに、次に示す属性を持ったメッセージを出力します。

種類：エラー

ソース：HitachiWebServer

分類：なし

イベント：3299

説明：rotatelogs2.exe: (メッセージ)

このメッセージが出力されていた場合、メッセージ内容に従って引数を見直したあとに、サーバを再起動してください。なお、同じメッセージが複数回出力されることがあります。

ログファイルプレフィックス名は、絶対パスで指定してください。

Webサーバ起動時の出力ログファイルは、更新日時が最新のものを対象とするため、誤ってファイルを更新した場合は、正しいファイルへの出力ができなくなります。

ログファイルサイズには、同一秒内に複数のファイルが指定サイズを超えるような、小さいサイズを指定しないでください。このようなサイズを指定した場合には、最も新しいログファイル以外が出力対象となり、正しくローテーションされなくなることがあります。

設定ファイル内に、同一のログファイルプレフィックス名を、複数個所で指定しないでください。複数個所で指定した場合には、最も新しいログファイル以外が出力対象となり、正しくローテーションされなくなることがあります。

rotatelogs2プログラムの引数指定に誤りがある場合、rotatelogs2プログラムの起動に失敗しますが、Webサーバは起動します。この場合はログは出力されません。rotatelogs2プログラムを指定した場合は、ログファイルが作成され、意図した分割が実施されることを確認してください。

3　Java EEサーバで使用するDeployment Descriptor（DD）

Java EEサーバの機能をアプリケーションやリソースに設定するためのファイルや、構成情報を定義するためのファイルを説明しています。

3.1　Java EEサーバで使用するDDの一覧

Java EEサーバで使用するすべてのDDの概要を説明しています。

ファイル

概要

詳細説明

3.2　glassfish-acc.xml

アプリケーションクライアントコンテナーの設定をするためのJava EE RIのDD

アプリケーションクライアントコンテナーに関する、Java EE RI固有の設定をするためのDDです。

3.4　glassfish-application.xml

Java EEアプリケーションの設定をするためのJava EE RIのDD

Java EEアプリケーションに関する、Java EE RI固有の設定をするためのDDです。

3.6　glassfish-application-client.xml

アプリケーションクライアントの設定をするためのJava EE RIのDD

アプリケーションクライアントに関する、Java EE RI固有の設定をするためのDDです。

3.8　glassfish-ejb-jar.xml

EJB-JARの設定をするためのJava EE RIのDD

EJB-JARに関する、Java EE RI固有の設定をするためのDDです。

3.10　glassfish-resources.xml

リソースの設定をするためのJava EE RIのDD

リソースに関する、Java EE RI固有の設定をするためのDDです。

3.12　glassfish-web.xml

Webアプリケーション（WAR）の設定をするためのJava EE RIのDD

Webアプリケーション（WAR）に関する、Java EE RI固有の設定をするためのDDです。

3.14　hitachi-application.xml

Java EEアプリケーションの設定をするための拡張DD

Java EEアプリケーションに関する、Java EE Server独自の設定をするためのDDです。

3.16　hitachi-application-client.xml

アプリケーションクライアントの設定をするための拡張DD

アプリケーションクライアントに関する、Java EE Server独自の設定をするためのDDです。

3.18　hitachi-ejb-jar.xml

EJB-JARの設定をするための拡張DD

EJB-JARに関する、Java EE Server独自の設定をするためのDDです。

3.20　hitachi-ra.xml

リソースの設定をするための拡張DD

リソースに関する、Java EE Server独自の設定をするためのDDです。

3.22　hitachi-web.xml

Webアプリケーション（WAR）の設定をするための拡張DD

Webアプリケーション（WAR）に関する、Java EE Server独自の設定をするためのDDです。

3.2　glassfish-acc.xml

アプリケーションクライアントコンテナーの設定をするためのJava EE RIのDDです。

説明

アプリケーションクライアントコンテナーに関する、Java EE RI固有の設定をするためのDDです。

glassfish-acc.xml のルート要素は client-container です。client-container 要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

スキーマ

<!DOCTYPE client-container PUBLIC
"-//GlassFish.org//
DTD GlassFish Application Server 3.1 Application Client Container//EN"
"http://glassfish.org/dtds/glassfish-application-client-container_1_3.dtd">

格納先

DDファイルは次の場所に格納されます。

domain-dir/config ディレクトリー

domain-dir：ドメインの設定ファイルが格納されているディレクトリーを表します。

要素の階層

client-container
. target-server
.. description
.. security
. auth-realm
.. property
. message-security-config
.. provider-config
... request-policy
... response-policy
... property
. property

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE client-container PUBLIC
"-//GlassFish.org//
DTD GlassFish Application Server 3.1 Application Client Container//EN"
"http://glassfish.org/dtds/glassfish-application-client-container_1_3.dtd">
<client-container>
  <target-server name="vm006248" address="localhost" port="3700"/>
  <message-security-config auth-layer="SOAP">
    <provider-config class-name=
"com.sun.xml.wss.provider.ClientSecurityAuthModule"
provider-id="XWS_ClientProvider" provider-type="client">
       <request-policy auth-source="content"/>
      <response-policy auth-source="content"/>
    </provider-config>
  </message-security-config>
</client-container>

3.3　glassfish-acc.xmlに設定する要素の詳細

glassfish-acc.xmlに設定する要素について説明しています。

3.3.1　/client-container

アプリケーションクライアントコンテナーにJava EE Server固有の設定を定義します。

説明

アプリケーションクライアントコンテナーにJava EE Server固有の設定を定義します。client-container はルート要素です。そのため、glassfish-acc.xml ファイルには、client-container 要素は1つだけ存在します。

出現パターン

1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

send-password

true の場合、クライアント認証資格がサーバに送信される必要があることを指定します。クライアント認証資格がないと、保護された EJB コンポーネントへのすべてのアクセスは例外となります。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.2　/client-container/target-server

対象のサーバインスタンスの IIOP リスナーとロードバランスで使用される IIOP エンドポイントを指定します。

説明

対象のサーバインスタンスの IIOP リスナーとロードバランスで使用される IIOP エンドポイントを指定します。アプリケーションクライアントがデプロイされたサーバインスタンスがクラスターに参加する場合、Java EE Serverは、クラスター内で現在アクティブなすべての IIOP エンドポイントを自動的に検出します。

ただし、エンドポイントの1つで障害が発生した場合に備えて、クライアントはブートストラップ目的で少なくとも 2 つのエンドポイントを指定しておく必要があります。

リスナーまたはエンドポイントは、ホスト：ポートの形式で表されます。ホストは IP アドレスまたはホスト名、ポートはポート番号を表します。

出現パターン

1回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

クライアントコンテナーによってアクセスされるサーバインスタンスの名前を指定します。

型：String

−

−

1回

address

このクライアントがアタッチするサーバのホスト名または IP アドレス（DNSで解決可能）を指定します。

型：String

−

−

1回

port

このクライアントがアタッチするサーバのネーミングサービスのポート番号を指定します。

新しいサーバインスタンスには3700以外のポート番号を割り当ててください。Administration Consoleでポート番号を変更できます。

型：Integer

0〜65535

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.3　/client-container/target-server/description

target-server要素以下に含まれる要素の説明を記述します。

説明

target-server要素以下に含まれる要素の説明を記述します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.3.4　/client-container/target-server/security

対象のサーバインスタンスとの IIOP/SSL 通信のセキュリティーの設定を指定します。

説明

対象のサーバインスタンスとの IIOP/SSL 通信のセキュリティーの設定を指定します。

出現パターン

0回、または1回

3.3.5　/client-container/auth-realm

JAAS 認証レルムのオプションを設定します。

説明

JAAS 認証レルムのオプションを設定します。JAAS は アプリケーションクライアントコンテナー上で使用できます。

認証レルムはプロバイダー固有のプロパティーを要求します。プロバイダー固有のプロパティーは特定の実装が何を必要とするかによって変わります。

依存関係のある要素または属性

auth-realm 要素の使用は、auth-realm 要素の name 属性の値によって決まります。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

このレルムの名称を定義します 。

サポートされているレルムは次のとおりです。

file

ファイルにユーザー情報を格納します。これはApplication Serverを最初にインストールしたときのデフォルトレルムです。

ldap

LDAP ディレクトリーにユーザー情報を格納します。

jdbc

データベースにユーザー情報を格納します。

JDBC レルムでは、サーバはデータベースからユーザークレデンシャルを取得します。Java EE Serverは、データベース情報と設定ファイル内の有効な JDBC レルムオプションを使用します。 ダイジェスト認証の場合、JDBC レルムは jdbcDigestRealm で JAAS コンテキストとして作成される必要があります。

certificate

Java EE Serverセキュリティーコンテキストにユーザー識別を設定します。そして、暗号化されたクライアント証明書から得られるユーザー情報を、ユーザー識別に追加します。

型：String

{file | ldap | jdbc | certificate}

なし

−

1回

class-name

このレルムを実装する Java クラスを定義します。

型：String

{com.sun.enterprise.security.auth.realm.file.FileRealm | com.sun.enterprise.security.auth.realm.certificate.CertificateRealm | com.sun.enterprise.security.auth.realm.jdbc.JDBCRealm | com.sun.enterprise.security.auth.realm.ldap.LDAPRealm | Any customrealm.}

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.6　/client-container/auth-realm/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

なし

−

1回

value

プロパティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.7　/client-container/message-security-config

メッセージセキュリティープロバイダーのための設定をします。

説明

メッセージセキュリティープロバイダーのための設定をします。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。値は SOAP である必要があります。

型：String

−

−

1回

default-provider

特定サーバのメッセージセキュリティープロバイダーに、バインドされていないアプリケーションのために利用される、メッセージセキュリティープロバイダーを指定します。

型：String

−

−

0回、または1回

default-client-provider

特定のクライアントプロバイダーにバインドされていない任意のアプリケーションのために呼び出される、クライアントプロバイダーを指定します。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.8　/client-container/message-security-config/provider-config

メッセージセキュリティープロバイダーのための設定をします。

説明

メッセージセキュリティープロバイダーのための設定をします。

request-policy と response-policy 子要素はオプションですが、 provider-config 要素はこれらを指定しないと動作しません。

プロバイダー固有のプロパティーを設定する場合、property子要素を使用してください。

プロパティーの値は、initialize メソッドが呼び出された際にプロバイダーに渡されます。

出現パターン

1回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

provider-id

プロバイダーIDを指定します。

型：String

−

−

1回

provider-type

プロバイダーが、クライアント、サーバまたはクライアントサーバのどの認証プロバイダーなのかを指定します。

型：String

{client | server | client-server}

−

−

1回

class-name

プロバイダーの Java 実装クラスを指定します。

有効なプロバイダーは次のとおりです。

クライアント認証のプロバイダーは com.sun.enterprise.security.jauth.ClientAuthModule インターフェースを実装する必要があります。

サーバ認証のプロバイダーは com.sun.enterprise.security.jauth.ServerAuthModule インターフェースを実装する必要があります。

クライアントサーバ認証プロバイダーは両方のインターフェースを実装する必要があります。

型：String

次のインターフェースのどちらかまたは両方を実装する任意のクラス（サブクラス）名

com.sun.enterprise.security.jauth.ClientAuthModule

com.sun.enterprise.security.jauth.ServerAuthModule

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.9　/client-container/message-security-config/provider-config/request-policy

認証プロバイダーのリクエスト処理の認証ポリシー要件を定義します。

説明

認証プロバイダーのリクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.10　/client-container/message-security-config/provider-config/response-policy

認証プロバイダーのレスポンス処理の認証ポリシー要件を定義します。

説明

認証プロバイダーのレスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.11　/client-container/message-security-config/provider-config/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.3.12　/client-container/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.4　glassfish-application.xml

Java EEアプリケーションの設定をするためのJava EE RIのDDです。

説明

Java EEアプリケーションに関する、Java EE RI固有の設定をするためのDDです。

glassfish-application.xml のルート要素は glassfish-application です。glassfish-application 要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

スキーマ

<!DOCTYPE glassfish-application PUBLIC "-//GlassFish.org//DTD
GlassFish Application Server 3.1 Java EE Application 6.0//EN"
"http://glassfish.org/dtds/glassfish-application_6_0-1.dtd">

格納先

DDファイルは次の場所に格納されます。

application_ear_name/META-INF ディレクトリー

application_ear_name：アプリケーションのアーカイブ名を表します。

要素の階層

glassfish-application
. web
.. web-uri
.. context-root
. security-role-mapping
.. role-name
.. principal-name
.. group-name
. realm
. ejb-ref
.. ejb-ref-name
.. jndi-name
. resource-ref
.. res-ref-name
.. jndi-name
.. default-resource-principal
... name
... password
. resource-env-ref
.. resource-env-ref-name
.. jndi-name
. service-ref
.. service-ref-name
.. port-info
... service-endpoint-interface
... wsdl-port
.... namespaceURI
.... localpart
... stub-property
.. service-impl-class
.. service-qname
... namespaceURI
... localpart
. message-destination-ref
.. message-destination-ref-name
.. jndi-name
. message-destination
.. message-destination-name
.. jndi-name
. archive-name
. version-identifier

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glassfish-application PUBLIC "-//GlassFish.org//DTD
GlassFish Application Server 3.1 Java EE Application 6.0//EN"
"http://glassfish.org/dtds/glassfish-application_6_0-1.dtd">
<glassfish-application>
    <unique-id>67488732739338240</unique-id>
    <web>
        <web-uri>hello.war</web-uri>
        <context-root>/hello</context-root>
    </web>
</glassfish-application>

3.5　glassfish-application.xmlに設定する要素の詳細

glassfish-application.xmlに設定する要素について説明しています。

3.5.1　/glassfish-application

アプリケーションに Java EE Server固有の設定を定義します。

説明

アプリケーションにJava EE Server固有の設定を定義します。glassfish-application はルート要素です。そのため、 glassfish-application.xml ファイルには、glassfish-application 要素は1つだけ存在します。

出現パターン

1回

3.5.2　/glassfish-application/web

アプリケーションの Web tierの設定をします。

説明

アプリケーションの Web tierの設定をします。

出現パターン

0回以上

3.5.3　/glassfish-application/web/web-uri

アプリケーションの Web URI を含みます。

説明

アプリケーションのWeb URI を含みます。これは application.xml ファイルの対応する要素に一致する必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.4　/glassfish-application/web/context-root

アプリケーションまたはWARファイルとしてパッケージされたWebアプリケーションのWebコンテキストルートを含みます。

説明

アプリケーションまたは WAR ファイルとしてパッケージされたWeb アプリケーションの Web コンテキストルートを含みます。application.xml の対応する要素を上書きします。

ロードバランスを設定する場合、Web モジュールコンテキストルートはサーバインスタンス内で一意である必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

Application.xmlに指定された値

出現パターン

1回

3.5.5　/glassfish-application/security-role-mapping

対応する Java EE XML ファイル内のロールをユーザーまたはグループにマッピングします。

説明

ロールを、現在アクティブなレルム内のユーザーまたはグループにマッピングします。

ロールマッピング要素は、EJB JAR DD（glassfish-ejb-jar.xml）中のrole-name要素で指定されたように、ロールを環境固有のユーザーまたはグループにマッピングします。

ロールマッピング要素がロールをユーザーにマッピングする場合、そのユーザーは現在のレルムに存在し、かつ、認証方法を使用してサーバにログインできる必要があります。

ロールマッピング要素がロールをグループにマッピングする場合、レルムはグループをサポートし、かつ、そのグループは現在のレルムに存在している必要があります。現在のレルムに存在しているグループであるには、レルム内に、そのグループに属するユーザーが少なくとも1人いる必要があります。

出現パターン

0回以上

3.5.6　/glassfish-application/security-role-mapping/role-name

対応するJava EE RIのDDファイルの、security-role 要素内の role-name を含みます。

説明

対応するJava EE RIのDDファイルの、security-role 要素内の role-name を含みます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.7　/glassfish-application/security-role-mapping/principal-name

現在のレルム内のプリンシパル（ユーザー）名を含みます。

説明

現在のレルム内のプリンシパル（ユーザー）名を含みます。Enterprise Bean では、プリンシパルには run-as ロールが指定されている必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

依存関係のある要素または属性

<security-role-mapping><group-name>

出現パターン

group-name が存在しない場合は1回以上、それ以外は0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

class-name

このプリンシパルに対応する、カスタムプリンシパル実装クラスを指定します。

型：String

com.sun.enterprise.deployment.PrincipalImpl

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.5.8　/glassfish-application/security-role-mapping/group-name

現在のレルム内のグループ名を含みます。

説明

現在のレルム内のグループ名を含みます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

依存関係のある要素または属性

<security-role-mapping><principal-name>

出現パターン

principal-name が存在しない場合は1回以上、それ以外は0回以上

3.5.9　/glassfish-application/realm

認証レルムを指定します。

説明

このアプリケーションと関連づけられているすべての認証要求を処理するのに使用されるレルムの名前を指定します。

この要素が指定されない、または設定されたレルムの名前と一致しない場合、デフォルトのレルムが使用されます。

サポートされているレルムは次のとおりです。

file

ファイルにユーザー情報を格納します。これはApplication Serverを最初にインストールした時のデフォルトレルムです。

ldap

LDAP ディレクトリーにユーザー情報を格納します。

jdbc

データベースにユーザー情報を格納します。

JDBC レルムでは、サーバはデータベースからユーザークレデンシャルを取得します。Java EE Serverは、データベース情報と設定ファイル内の有効な JDBC レルムオプションを使用します。ダイジェスト認証の場合、JDBC レルムは jdbcDigestRealm で JAAS コンテキストとして作成される必要があります。

certificate

Java EE Serverセキュリティーコンテキストにユーザー識別を設定します。そして、暗号化されたクライアント証明書から得られるユーザー情報を、ユーザー識別に追加します。

指定できる値

型：String

{file | ldap | jdbc | certificate}

デフォルト値

定義項目の省略

file

出現パターン

0回、または1回

3.5.10　/glassfish-application/ejb-ref

JNDI完全修飾名を、対応するJava EE XMLファイル内のejb-refエントリーにマッピングします。

説明

対応するJava EE RIのDDファイルejb-refエントリー内のejb-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

ejb-ref要素はEJBホームへの参照の宣言に使用されます。

Session BeanまたはEntity Beanに適用します。

出現パターン

0回以上

3.5.11　/glassfish-application/ejb-ref/ejb-ref-name

対応するJava EE RIのDDファイル ejb-refエントリー 内の ejb-ref-name を指定します。

説明

対応するJava EE RIのDDファイルejb-refエントリー 内の ejb-ref-name を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.12　/glassfish-application/ejb-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、JNDI完全修飾名の値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名になります。または、この情報はmdb-resource-adapter要素のactivation-config子要素内に指定されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.13　/glassfish-application/resource-ref

JNDI完全修飾名を、対応するJava EE XMLファイル内のresource-ref要素にマッピングします。

説明

対応するJava EE RIのDDファイルresource-ref要素内のres-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

出現パターン

0回以上

3.5.14　/glassfish-application/resource-ref/res-ref-name

resource-ref要素内の res-ref-name を指定します。

説明

対応するJava EE RIのDDファイル resource-ref要素内の res-ref-name を指定します。res-ref-name 要素は、リソースマネージャー接続ファクトリー参照の名称を指定します。

名称は、Enterprise Bean 内で一意である必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.15　/glassfish-application/resource-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、JNDI完全修飾名の値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名になります。または、この情報はmdb-resource-adapter要素のactivation-config子要素内に指定されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.16　/glassfish-application/resource-ref/default-resource-principal

デフォルトのリソースプリンシパル（ユーザー）を指定します。

説明

デフォルトのリソースプリンシパル（ユーザー）を指定します。この要素が JMS接続ファクトリーのリソースと一緒に使用される場合、名称とパスワードの子要素はMessage Queue ブローカーユーザーリポジトリー内の有効なエントリーである必要があります。

出現パターン

0回、または1回

3.5.17　/glassfish-application/resource-ref/default-resource-principal/name

リソースマネージャーへサインオンするのに使用される、デフォルトのリソースプリンシパル名を指定します。

説明

リソースマネージャーへサインオンするのに使用される、デフォルトのリソースプリンシパル名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.18　/glassfish-application/resource-ref/default-resource-principal/password

デフォルトのリソースプリンシパルのパスワードを指定します。

説明

デフォルトのリソースプリンシパルのパスワードを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.19　/glassfish-application/resource-env-ref

JNDI完全修飾名を、対応する Java EE XML ファイル内のresource-env-refにマッピングします。

説明

対応するJava EE RIのDDファイルresource-env-ref要素内のres-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

出現パターン

0回以上

3.5.20　/glassfish-application/resource-env-ref/resource-env-ref-name

対応するJava EE RIのDDファイル resource-env-ref要素内の res-ref-name の値を指定します。

説明

対応するJava EE RIのDDファイル resource-env-ref要素内の res-ref-name の値を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.21　/glassfish-application/resource-env-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、JNDI完全修飾名の値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名になります。または、この情報はmdb-resource-adapter要素のactivation-config子要素内に指定されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.22　/glassfish-application/service-ref

Web サービス参照のランタイム設定を指定します。

説明

Web サービス参照のランタイム設定を指定します。ランタイム情報は次の場合にだけ必要です。

コンテナー管理対象ポートを解決するためのポートを定義する場合

スタブオブジェクトに、デフォルトのStubプロパティー設定、またはデフォルトのCall プロパティー設定を定義する場合

標準DDの service-ref と関連づけられている URL の代わりに使用される、最終的な WSDL ドキュメントの URL を定義する場合

出現パターン

0回以上

3.5.23　/glassfish-application/service-ref/service-ref-name

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.24　/glassfish-application/service-ref/port-info

Webサービス参照内のポートの情報を指定します。

説明

Webサービス参照内のポートの情報を指定します。service-endpoint-interface もしくは wsdl-port 、または両方が指定される必要があります。両方が指定された場合、wsdl-port は、コンテナーがコンテナー管理対象ポートの選択で選ぶポートを指定します。

出現パターン

0回以上

3.5.25　/glassfish-application/service-ref/port-info/service-endpoint-interface

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.5.26　/glassfish-application/service-ref/port-info/wsdl-port

WSDL ポートを指定します。

説明

WSDL ポートを指定します。

出現パターン

0回、または1回

3.5.27　/glassfish-application/service-ref/port-info/wsdl-port/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.28　/glassfish-application/service-ref/port-info/wsdl-port/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.29　/glassfish-application/service-ref/port-info/stub-property

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。

説明

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。プロパティー名は、JAX-RPC スタブ実装がサポートする任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.5.30　/glassfish-application/service-ref/service-impl-class

生成されたサービス実装クラスの名称を指定します。

説明

生成されたサービス実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.5.31　/glassfish-application/service-ref/service-qname

参照されている WSDL service 要素を指定します。

説明

参照されている WSDL service 要素を指定します。

出現パターン

0回、または1回

3.5.32　/glassfish-application/service-ref/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.33　/glassfish-application/service-ref/service-qname/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.34　/glassfish-application/message-destination-ref

メッセージの物理的な送信先の名称を指定します。

説明

メッセージの物理的な参照を、キュー、トピック、またはほかの物理的な送信先のJNDI名に、直接バインドします。

対応するJava EE RIのDDファイルのメッセージ送信先参照が、論理的なメッセージ送信先へのメッセージ送信先リンクを指定していない場合にだけmessage-destination-refを使用します。

出現パターン

0回以上

3.5.35　/glassfish-application/message-destination-ref/message-destination-ref-name

対応する Java EE RIのDDファイル内に定義された物理的なメッセージ送信先の名称を指定します。

説明

対応するJava EE RIのDDファイル内に定義された物理的なメッセージ送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.36　/glassfish-application/message-destination-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、JNDI完全修飾名の値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.37　/glassfish-application/message-destination

メッセージの論理的な送信先の名称を指定します。

説明

アプリケーション内に定義された論理的なメッセージ送信先の名称を指定します。メッセージ送信先名は、対応するJava EE RIのDDファイル内の対応するメッセージ送信先名と一致します。

対応するJava EE RIのDDファイルのメッセージ送信先参照が、論理的なメッセージ送信先へのメッセージ送信先リンクを指定している場合に使用します。

出現パターン

0回以上

3.5.38　/glassfish-application/message-destination/message-destination-name

対応するJava EE RIのDDファイル内に定義された論理的なメッセージ送信先の名称を指定します。

説明

対応するJava EE RIのDDファイル内に定義された論理的なメッセージ送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.39　/glassfish-application/message-destination/jndi-name

関連づけられているエンティティーのjndi-nameを指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、JNDI完全修飾名の値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名になります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.5.40　/glassfish-application/archive-name

アーカイブファイルの名称を指定します。

説明

アーカイブファイルの名称を指定します。archive-name 要素の値は、display-name が application.xml ファイルに存在しない場合、デフォルトのアプリケーション名を得るのに使用されます。

デフォルトのアプリケーション名は、archive-name の値からファイルの拡張子を除いたものです。例えば、archive-name が app1.ear の場合、デフォルトのアプリケーション名は「app1」になります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.5.41　/glassfish-application/version-identifier

アプリケーションまたはモジュールのバージョン情報を含みます。

説明

アプリケーションまたはモジュールのバージョン情報を含みます。バージョン識別子は、モジュール名またはアプリケーション名の接尾辞です。コロン (:) で名前から区切ります。文字か数字で始まる必要があります。使用できる文字は、英数字のほかに、アンダースコア (_) 、ハイフン (-) およびピリオド (.) です。

次の例では、アプリケーションの有効なバージョン識別子を示します。

アプリケーション名:1

アプリケーション名:BETA-2e

アプリケーション名:3.8

アプリケーション名:patch39875

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.6　glassfish-application-client.xml

アプリケーションクライアントの設定をするためのJava EE RIのDDです。

説明

アプリケーションクライアントに関する、Java EE RI固有の設定をするためのDDです。

glassfish-application-client.xml のルート要素は glassfish-application-client です。glassfish-application-client要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

スキーマ

<!DOCTYPE glassfish-application-client PUBLIC "-//GlassFish.org
//DTD GlassFish Application Server 3.1 Java EE Application Client 6.0//EN"
"http://glassfish.org/dtds/glassfish-application-client_6_0-1.dtd">

格納先

DDファイルは次の場所に格納されます。

client_jar_name/META-INF ディレクトリー

client_jar_name：クライアントアプリケーションのアーカイブ名を表します。

要素の階層

glassfish-application-client
. ejb-ref
.. ejb-ref-name
.. jndi-name
. resource-ref
.. res-ref-name
.. jndi-name
.. default-resource-principal
... name
... password
. resource-env-ref
.. resource-env-ref-name
.. jndi-name
. service-ref
.. service-ref-name
.. port-info
... service-endpoint-interface
... wsdl-port
.... namespaceURI
.... localpart
... stub-property
... call-property
... message-security-binding
.... message-security
..... message
...... operation-name
..... request-protection
..... response-protection
.. call-property
.. wsdl-override
.. service-impl-class
.. service-qname
... namespaceURI
... localpart
. message-destination-ref
.. message-destination-ref-name
.. jndi-name
. message-destination
.. message-destination-name
.. jndi-name
. version-identifier

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glassfish-application-client PUBLIC ""-//GlassFish.org
//DTD GlassFish Application Server 3.1 Application Client 6.0//EN""
"http://glassfish.org/dtds/glassfish-application-client_6_0-1.dtd">
<glassfish-application-client>
    <message-destination-ref>
        <message-destination-ref-name>ClientQueue
</message-destination-ref-name>
        <jndi-name>jms/security_mdb_OutQueue</jndi-name>
    </message-destination-ref>
</glassfish-application-client>

3.7　glassfish-application-client.xmlに設定する要素の詳細

glassfish-application-client.xmlに設定する要素について説明しています。

3.7.1　/glassfish-application-client

アプリケーションクライアントにJava EE Server固有の設定を定義します。

説明

アプリケーションクライアントにJava EE Server固有の設定を定義します。glassfish-application-client はルート要素です。そのため glassfish-application-client.xml ファイルには、glassfish-application-client 要素は1つだけ存在することになります。

出現パターン

1回

3.7.2　/glassfish-application-client/ejb-ref

JNDI完全修飾名を、対応するJava EE XMLファイル内のejb-ref名にマッピングします。

説明

対応するJava EE RIのDDファイルejb-refエントリー内のejb-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

ejb-ref 要素はEJBホームへの参照の宣言に使用されます。ejb-ref 要素はSession BeanまたはEntity Beanに適用します。

出現パターン

0回以上

3.7.3　/glassfish-application-client/ejb-ref/ejb-ref-name

対応するJava EE RIのDDファイル ejb-refエントリー 内の ejb-ref-name を指定します。

説明

対応するJava EE RIのDDファイル ejb-refエントリー 内の ejb-ref-name を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.4　/glassfish-application-client/ejb-ref/jndi-name

リソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。Entity BeanとSession Beanの場合、EJBHomeオブジェクトのグローバルJNDI名を指定します。

Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.5　/glassfish-application-client/resource-ref

JNDI完全修飾名を、対応するJava EE XMLファイル内のresource-ref要素 にマッピングします。

説明

対応するJava EE RIのDDファイルresource-ref要素内のres-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

出現パターン

0回以上

3.7.6　/glassfish-application-client/resource-ref/res-ref-name

resource-ref要素内の res-ref-name を指定します。

説明

対応するJava EE RIのDDファイル resource-ref要素内の res-ref-name を指定します。res-ref-name 要素は、リソースマネージャー接続ファクトリー参照の名称を指定します。

名称は、Enterprise Bean 内で一意である必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.7　/glassfish-application-client/resource-ref/jndi-name

リソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

JMS Message-driven Beanの場合、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.8　/glassfish-application-client/resource-ref/default-resource-principal

リソースの、デフォルトのプリンシパル（ユーザー）を指定します。

説明

リソースの、デフォルトのプリンシパル（ユーザー）を指定します。

この要素が JMS 接続ファクトリーのリソースと一緒に使用される場合、名称とパスワードの子要素はMessage Queue ブローカーユーザーリポジトリー内で、有効なエントリーである必要があります。

出現パターン

0回、または1回

3.7.9　/glassfish-application-client/resource-ref/default-resource-principal/name

リソースマネージャーへサインオンするために使用される、デフォルトのリソースプリンシパル名を指定します。

説明

リソースマネージャーへサインオンするために使用される、デフォルトのリソースプリンシパル名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.10　/glassfish-application-client/resource-ref/default-resource-principal/password

デフォルトのリソースプリンシパルのパスワードを指定します。

説明

デフォルトのリソースプリンシパルのパスワードを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.11　/glassfish-application-client/resource-env-ref

JNDI完全修飾名を、対応するJava EE XMLファイル内のresource-env-refにマッピングします。

説明

対応するJava EE RIのDDファイルresource-env-ref要素内のres-ref-nameを、リソースのJNDI完全修飾名にマッピングします。

出現パターン

0回以上

3.7.12　/glassfish-application-client/resource-env-ref/resource-env-ref-name

対応するJava EE RIのDDファイル resource-env-ref要素内の res-ref-name を指定します。

説明

対応するJava EE RIのDDファイルresource-env-ref要素内の res-ref-name を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.13　/glassfish-application-client/resource-env-ref/jndi-name

リソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。Entity BeanとSession Beanの場合、EJBHome オブジェクトのグローバルJNDI名を指定します。

JNDI完全修飾名は、Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、JNDI完全修飾名は、Message-driven BeanがJMSメッセージを消費する、JMSリソースのJNDI名を指定します。また、この情報はmdb-resource-adapter要素の子要素である、activation-config要素に指定することもできます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.14　/glassfish-application-client/service-ref

Web サービス参照のランタイム設定を指定します。

説明

Web サービス参照のランタイム設定を指定します。

ランタイム情報は次の場合にだけ必要です。

コンテナー管理対象ポートを解決するためのポートを定義する場合

スタブオブジェクトに、デフォルトのStubプロパティー設定、またはデフォルトのCall プロパティー設定を定義する場合

標準DDの service-ref と関連づけられている URL の代わりに使用される、最終的な WSDL ドキュメントの URL を定義する場合

出現パターン

0回以上

3.7.15　/glassfish-application-client/service-ref/service-ref-name

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.16　/glassfish-application-client/service-ref/port-info

Webサービス参照内のポートの情報を指定します。

説明

Webサービス参照内のポートの情報を指定します。

service-endpoint-interface もしくは wsdl-port 、または両方が指定される必要があります。両方が指定された場合、wsdl-port は、コンテナーがコンテナー管理対象ポートの選択で選択可能なポートを指定します。

service-ref内で、同じ wsdl-port 値を2つ以上使用することはできません。

service-endpoint-interface値 がコンテナー管理対象ポートの選択を使用する場合、同じ service-ref 内でほかの port-info 要素には使用できません。

出現パターン

0回以上

3.7.17　/glassfish-application-client/service-ref/port-info/service-endpoint-interface

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.7.18　/glassfish-application-client/service-ref/port-info/wsdl-port

WSDL ポートを指定します。

説明

WSDL ポートを指定します。

出現パターン

0回、または1回

3.7.19　/glassfish-application-client/service-ref/port-info/wsdl-port/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.20　/glassfish-application-client/service-ref/port-info/wsdl-port/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.21　/glassfish-application-client/service-ref/port-info/stub-property

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。

説明

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。プロパティー名は、JAX-RPC スタブ実装がサポートする任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.22　/glassfish-application-client/service-ref/port-info/call-property

Webサービスクライアントに返却される前に javax.xml.rpc.Call オブジェクトに設定される JAX-RPC プロパティーの値を指定します。

説明

Webサービスクライアントに返却される前に javax.xml.rpc.Call オブジェクトに設定される JAX-RPC プロパティーの値を指定します。プロパティー名は、JAX-RPC Call 実装でサポートされる任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.23　/glassfish-application-client/service-ref/port-info/message-security-binding

カスタム認証プロバイダーのバインディングを指定します。

説明

次の方法のどちらか、または両方を使用して、親要素のport-infoに対して、カスタム認証プロバイダーのバインディングを指定します。

特定のプロバイダーにバインドする。

プロバイダーによって課せられるメッセージのセキュリティー要件を指定する。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。

型：String

SOAP

なし

−

1回

provider-id

アプリケーション固有のメッセージのセキュリティー要件を満たすために使用される認証プロバイダーを指定します。この属性を指定しない場合、デフォルトのプロバイダーがメッセージレイヤーに定義されているとき、定義されたプロバイダーが使用されます。さらにデフォルトのプロバイダーも定義されていない場合、message-security-bindingで定義された認証要件は実行されません。

型：String

なし

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.24　/glassfish-application-client/service-ref/port-info/message-security-binding/message-security

メッセージセキュリティー要件を指定します。

説明

メッセージセキュリティー要件を指定します。

2階層上の要素が port-info のため、メッセージセキュリティー要件は参照されたサービスのポートに付属します。

出現パターン

0回以上

3.7.25　/glassfish-application-client/service-ref/port-info/message-security-binding/message-security/message

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

出現パターン

1回以上

3.7.26　/glassfish-application-client/service-ref/port-info/message-security-binding/message-security/message/operation-name

Webサービスの操作のオペレーション名を指定します。

説明

Webサービスの操作のオペレーション名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.7.27　/glassfish-application-client/service-ref/port-info/message-security-binding/message-security/request-protection

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

説明

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.28　/glassfish-application-client/service-ref/port-info/message-security-binding/message-security/response-protection

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

説明

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.29　/glassfish-application-client/service-ref/call-property

Webサービスクライアントに返却される前に javax.xml.rpc.Call オブジェクトに設定される JAX-RPC プロパティーの値を指定します。

説明

Webサービスクライアントに返却される前に javax.xml.rpc.Call オブジェクトに設定される JAX-RPC プロパティーの値を指定します。プロパティー名は、JAX-RPC Call 実装でサポートされる任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.7.30　/glassfish-application-client/service-ref/wsdl-override

最終的な WSDL ドキュメントを示す有効な URL を指定します。

説明

最終的な WSDL ドキュメントを示す有効な URL を指定します。指定しない場合、標準DD内の service-ref と関連づけられている WSDL ドキュメントが使用されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.7.31　/glassfish-application-client/service-ref/service-impl-class

生成されたサービス実装クラスの名称を指定します。

説明

生成されたサービス実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.7.32　/glassfish-application-client/service-ref/service-qname

参照されている WSDL service 要素を指定します。

説明

参照されている WSDL service 要素を指定します。

出現パターン

0回、または1回

3.7.33　/glassfish-application-client/service-ref/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.34　/glassfish-application-client/service-ref/service-qname/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.35　/glassfish-application-client/message-destination-ref

物理的なメッセージ送信先の名称を指定します。

説明

メッセージ送信先の参照を、キュー、トピック、またはほかの物理的送信先の JNDI 名に直接バインドします。

対応するJava EE RIのDDファイル内のメッセージ送信先の参照が、 論理メッセージ送信先 への message-destination-link を指定しない場合だけ使用します。

出現パターン

0回以上

3.7.36　/glassfish-application-client/message-destination-ref/message-destination-ref-name

対応するJava EE RIのDDファイル内に定義された、物理的なメッセージ送信先の名称を指定します。

説明

対応する Java EE RIのDDファイル内に定義された、物理的なメッセージ送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.37　/glassfish-application-client/message-destination-ref/jndi-name

関連づけられているエンティティーのjndi-nameを指定します。

説明

JMS Message-driven Bean の場合、Message-driven Bean が JMS メッセージを消費する、JMS リソースの JNDI 名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.38　/glassfish-application-client/message-destination

論理メッセージ送信先の名称を指定します。

説明

アプリケーション内で定義されている 論理メッセージ送信先の名称を指定します。

この要素の子要素であるmessage-destination-nameは、対応する Java EE RIのDDファイル内の、message-destination-name 要素に合わせて記述してください。

対応するJava EE RIのDDファイル内のメッセージ送信先の参照で、論理メッセージ送信先への message-destination-link要素 を指定している場合に利用してください。

出現パターン

0回以上

3.7.39　/glassfish-application-client/message-destination/message-destination-name

対応するJava EE RIのDDファイル内に定義された論理的なメッセージ送信先の名称を指定します。

説明

対応するJava EE RIのDDファイル内に定義された論理的なメッセージ送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.40　/glassfish-application-client/message-destination/jndi-name

関連づけられているエンティティーのjndi-nameを指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、EJBHomeオブジェクトのグローバルJNDI名を指定します。この指定は、Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

JMS Message-driven Beanの場合、Message-driven BeanがJMSメッセージを消費するJMSリソースのJNDI名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.7.41　/glassfish-application-client/version-identifier

アプリケーションまたはモジュールのバージョン情報を含みます。

説明

アプリケーションまたはモジュールのバージョン情報を含みます。バージョン識別子は、モジュールまたはアプリケーションの接尾辞です。コロン (:) で区切って名前に続けます。アルファベットまたは数字で始まる必要があります。使用できる文字は、英数字、アンダースコア (_) 、ダッシュ (-) およびピリオド (.) です。

アプリケーションの有効なバージョン識別子の例を次に示します。

アプリケーション名:1

アプリケーション名:BETA-2e

アプリケーション名:3.8

アプリケーション名:patch39875

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.8　glassfish-ejb-jar.xml

EJB-JARの設定をするためのJava EE RIのDDです。

説明

EJB-JARに関する、Java EE RI固有の設定をするためのDDです。

glassfish-ejb-jar.xmlのルート要素はglassfish-ejb-jarです。glassfish-ejb-jar要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

スキーマ

<!DOCTYPE glassfish-ejb-jar PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 EJB 3.1//EN"
"http://glassfish.org/dtds/glassfish-ejb-jar_3_1-1.dtd">

格納先

DDファイルは次の場所に格納されます。

ejb_jar_name/META-INFディレクトリー

ejb_jar_name：EJB アプリケーションのアーカイブ名を表します。

要素の階層

glassfish-ejb-jar
. security-role-mapping
. . role-name
. . principal-name
. . group-name
. enterprise-beans
. . name
. . ejb
. . . ejb-name
. . . jndi-name
. . . ejb-ref
. . . . ejb-ref-name
. . . . jndi-name
. . . resource-ref
. . . . res-ref-name
. . . . jndi-name
. . . . default-resource-principal
. . . . . name
. . . . . password
. . . resource-env-ref
. . . . resource-env-ref-name
. . . . jndi-name
. . . service-ref
. . . . service-ref-name
. . . . port-info
. . . . . service-endpoint-interface
. . . . . wsdl-port
. . . . . . namespaceURI
. . . . . . localpart
. . . . . stub-property
. . . . . call-property
. . . . . message-security-binding
. . . . . . message-security
. . . . . . . message
. . . . . . . . java-method
. . . . . . . . . method-name
. . . . . . . . . method-params
. . . . . . . . . . method-param
. . . . . . . . operation-name
. . . . . . . request-protection
. . . . . . . response-protection
. . . . call-property
. . . . wsdl-override
. . . . service-impl-class
. . . . service-qname
. . . . . namespaceURI
. . . . . localpart
. . . message-destination-ref
. . . . message-destination-ref-name
. . . . jndi-name
. . . principal
. . . . name
. . . mdb-connection-factory
. . . . jndi-name
. . . . default-resource-principal
. . . . . name
. . . . . password
. . . jms-durable-subscription-name
. . . jms-max-messages-load
. . . ior-security-config
. . . . transport-config
. . . . . integrity
. . . . . confidentiality
. . . . . establish-trust-in-target
. . . . . establish-trust-in-client
. . . . as-context
. . . . . auth-method
. . . . . realm
. . . . . required
. . . commit-option
. . . cmt-timeout-in-seconds
. . . bean-pool
. . . . steady-pool-size
. . . . resize-quantity
. . . . max-pool-size
. . . . pool-idle-timeout-in-seconds
. . . mdb-resource-adapter
. . . . resource-adapter-mid
. . . . activation-config
. . . . . description
. . . . . activation-config-property
. . . . . . activation-config-property-name
. . . . . . activation-config-property-value
. . . webservice-endpoint
. . . . port-component-name
. . . . endpoint-address-uri
. . . . login-config
. . . . . auth-method
. . . . . realm
. . . . message-security-binding
. . . . . message-security
. . . . . . message
. . . . . . . java-method
. . . . . . . . method-name
. . . . . . . . method-params
. . . . . . . . . method-param
. . . . . . . operation-name
. . . . . . request-protection
. . . . . . response-protection
. . . . transport-guarantee
. . . . service-qname
. . . . . namespaceURI
. . . . . localpart
. . . . tie-class
. . . . servlet-impl-class
. . . . debugging-enabled
. . . . property
. . message-destination
. . . message-destination-name
. . . jndi-name
. . webservice-description
. . . webservice-description-name
. . . wsdl-publish-location
. version-identifier

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glassfish-ejb-jar PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 EJB 3.1//EN"
"http://glassfish.org/dtds/glassfish-ejb-jar_3_1-1.dtd">
<glassfish-ejb-jar>
    <ejb>
        <ejb-name>CustomerEJB</ejb-name>
        <jndi-name>customer</jndi-name>
        <bean-pool>
            <steady-pool-size>10</steady-pool-size>
        </bean-pool>
     </ejb>
</glassfish-ejb-jar>

3.9　glassfish-ejb-jar.xmlに設定する要素の詳細

glassfish-ejb-jar.xmlに設定する要素について説明しています。

3.9.1　/glassfish-ejb-jar

EJB-JAR ファイルに、Java EE Server 固有の設定を定義します。

説明

EJB-JAR ファイルに、Java EE Server 固有の設定を定義します。これはルート要素です。glassfish-ejb-jar.xml ファイルには、glassfish-ejb-jar 要素は1つだけ存在します。

出現パターン

1回

3.9.2　/glassfish-ejb-jar/security-role-mapping

標準DDで指定したロールを、環境固有のユーザーまたはグループにマッピングするための要素です。

説明

ロールを、現在アクティブなレルム内のユーザーまたはグループにマッピングします。

ロールマッピング要素は、EJB JAR role-name エントリーで指定されたように、ロールを環境固有のユーザーまたはグループにマッピングします。ユーザーにマッピングする場合、そのユーザーは現在のレルムに存在する実在のユーザーで、現在の認証方法を使用してサーバにログインできる必要があります。グループにマッピングする場合、レルムはグループをサポートする必要があり、そのグループは現在のレルムに存在する実在のグループである必要があります。

この設定を利用するためには、指定したレルム内の、指定したグループに属するユーザーが最低1人必要です。

出現パターン

0回以上

3.9.3　/glassfish-ejb-jar/security-role-mapping/role-name

標準DDで指定したロール名を指定する要素です。

説明

標準DDで指定したロール名を指定する要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.4　/glassfish-ejb-jar/security-role-mapping/principal-name

現在のレルムのプリンシパル（ユーザー）名を指定します。

説明

現在のレルムのプリンシパル（ユーザー）名を指定します。プリンシパル（ユーザ名）は、EJB-JARで、run-asで指定されたロールである必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

依存関係のある要素または属性

group-name

出現パターン

group-name を使用しない場合は1回以上、それ以外は0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

class-name

このプリンシパルに対応する、カスタムプリンシパル実装クラスを指定します。

型：String

java.security.Principal インターフェースを実装するクラス名（サブクラス名）

org.glassfish.security.common.PrincipalImpl

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.5　/glassfish-ejb-jar/security-role-mapping/group-name

現在のレルムのグループ名を指定します。

説明

ロールにグループをマッピングするとき、レルムのグループ名を指定する要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

依存関係のある要素または属性

principal-name

出現パターン

principal-name を使用しない場合は1回以上、それ以外は0回以上

3.9.6　/glassfish-ejb-jar/enterprise-beans

EJB-JARの実行時の設定をするための要素です。

説明

EJB-JARファイルの実行用の設定を指定するための要素です。

出現パターン

1回

3.9.7　/glassfish-ejb-jar/enterprise-beans/name

enterprise-beans要素の名称を指定します。

説明

enterprise-beans要素の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.8　/glassfish-ejb-jar/enterprise-beans/ejb

EJB-JARに含まれるEnterprise Beanのための、実行時の設定を指定するための要素です。

説明

このEJB-JARに含まれるEnterprise Beanの、実行時の設定をするための要素です。子要素として指定できる要素は、個々のEnterprise Bean種別に、次のようになります。

すべてのタイプの Bean

ejb-name、ejb-ref、resource-ref、resource-env-ref、ior-security-config、jndi-name、message-destination-ref、service-ref

Stateless Session Bean

bean-pool、webservice-endpoint

Stateful Session Bean

webservice-endpoint

Entity Bean

commit-option、bean-pool

Message-driven Bean

mdb-resource-adapter、mdb-connection-factory、jms-durable-subscription-name、jms-max-messages-load、bean-pool

出現パターン

0回以上

3.9.9　/glassfish-ejb-jar/enterprise-beans/ejb/ejb-name

ejb-jar.xml で定義したEnterprise Beanの ejb-name要素の値を指定するための要素です。

説明

ejb-jar.xmlで指定する名称は、対応するejb-jar.xmlの ejb-nameで指定した名称と一致する必要があります。このejb-nameは同一 EJB-JARでユニーク（一意）でなければなりません。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.10　/glassfish-ejb-jar/enterprise-beans/ejb/jndi-name

JNDI完全修飾名を指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの場合、この値はEJBHomeオブジェクトのグローバルJNDI名を指定します。これはEntity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回以上

3.9.11　/glassfish-ejb-jar/enterprise-beans/ejb/ejb-ref

標準DDのejb-ref要素に対してEJBのホームオブジェクトのJNDI完全修飾名のマッピングを定義する要素です。

説明

標準DDで定義した、ejb-ref要素のejb-ref-name子要素で指定した名称を、JNDI完全修飾名とマッピングします。ejb-ref要素は、EJBのホームオブジェクトへの参照の宣言に使用されます。この設定は、Session BeanまたはEntity Beanで利用可能です。

出現パターン

0回以上

3.9.12　/glassfish-ejb-jar/enterprise-beans/ejb/ejb-ref/ejb-ref-name

標準DDのejb-ref要素のejb-ref-nameを指定するための要素です

説明

標準DDで定義したejb-ref要素のejb-ref-nameを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.13　/glassfish-ejb-jar/enterprise-beans/ejb/ejb-ref/jndi-name

ejb-refを定義するEnterprise BeanのJNDI完全修飾名を指定する要素です。

説明

ejb-refで参照を定義するEnterprise BeanのJNDI完全修飾名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.14　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref

標準DDのresource-ref要素に対する参照のマッピングを定義する要素です。

説明

標準DDで定義した、resource-ref要素のres-ref-name子要素で指定した名前を、JNDI完全修飾名とマッピングします。

注意事項

JMS 接続ファクトリーから獲得したコネクションは、現在リリースされているJava EE Serverでは共有できません。ejb-jar.xmlファイルresource-ref 要素のres-sharing-scope要素はJMS接続ファクトリーでは無視されます。resource-refがJava EE ServerのMessage QueueにJMS接続ファクトリーを指定する場合、default-resource-principal（ユーザー名／パスワード）がMessage Queueのユーザーリポジトリーに存在している必要があります。

出現パターン

0回以上

3.9.15　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref/res-ref-name

標準DDで定義したresource-refのres-ref-nameを指定する要素です。

説明

glassfish-ejb-jar.xmlのres-ref-nameで指定する名称は、標準DDで定義したresource-refのres-ref-nameで指定した名称と一致する必要があります。また、このres-ref-nameは、同一EJB-JARでユニーク（一意）でなければなりません。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.16　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref/jndi-name

resource-refを定義するリソースJNDI完全修飾名を指定する要素です。

説明

resource-refで参照を定義するリソースのJNDI完全修飾名を指定するための要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.17　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref/default-resource-principal

リソースで、デフォルトで利用するプリンシパル（ユーザー）を指定します。

説明

デフォルトのリソースプリンシパル（ユーザー）を指定します。

この要素が JMS 接続ファクトリーのリソースと一緒に使用される場合、名称とパスワードの子要素はMessage Queue ブローカーユーザーリポジトリー内の有効なエントリーである必要があります。

出現パターン

0回、または1回

3.9.18　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref/default-resource-principal/name

リソースマネージャーへサインオンするために使用される、デフォルトのユーザー名を指定します。

説明

リソースマネージャーへサインオンするために使用される、デフォルトのユーザー名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.19　/glassfish-ejb-jar/enterprise-beans/ejb/resource-ref/default-resource-principal/password

リソースマネージャーへサインオンするために使用される、デフォルトのユーザ名に対応したパスワードを指定します。

説明

リソースマネージャーへサインオンするために使用される、デフォルトのユーザ名に対応したパスワードを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.20　/glassfish-ejb-jar/enterprise-beans/ejb/resource-env-ref

標準DDのresource-env-ref要素に対する参照のマッピングを定義する要素です。

説明

標準DDで定義した、resource-env-ref要素のres-ref-name子要素で指定した名前を、JNDI完全修飾名とマッピングします。

出現パターン

0回以上

3.9.21　/glassfish-ejb-jar/enterprise-beans/ejb/resource-env-ref/resource-env-ref-name

標準DDで定義したresource-env-refのres-ref-nameを指定する要素です。

説明

glassfish-ejb-jar.xmlのres-ref-nameで指定する名称は、標準DDで定義したres-ref-nameで指定した名称と一致する必要があります。また、このres-ref-nameは、同一EJB-JARでユニーク（一意）でなければなりません。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.22　/glassfish-ejb-jar/enterprise-beans/ejb/resource-env-ref/jndi-name

resource-env-refを定義するリソースJNDI完全修飾名を指定する要素です

説明

resource-env-refで参照を定義するリソースのJNDI完全修飾名を指定するための要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.23　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref

Webサービスの参照のための、実行時設定をする要素です。

説明

実行時設定は、次の場合にだけ必要です。

コンテナーによって管理されるポートの参照を解決する場合。

スタブオブジェクトに、デフォルトのStubの設定、またはデフォルトのCallの設定を定義する場合。

標準DDで、service-ref要素を利用して関連づけられた定義の代わりに、WSDLドキュメントのURLを定義する場合。

出現パターン

0回以上

3.9.24　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/service-ref-name

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.25　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info

Webサービス参照内のポートの情報を指定します。

説明

service-endpoint-interface または wsdl-port、もしくは両方を指定する必要があります。両方が指定された場合、wsdl-port は、コンテナーがコンテナー管理対象ポートの選択で選ぶポートを指定します。同じ wsdl-port 値は、同じ service-ref 内の 1つの port-info 要素でしか使用できません。service-endpoint-interface がコンテナー管理対象ポートの選択を使用する場合、その値は同じ service-ref 内の 1つの port-info 要素でしか使用できません。

出現パターン

0回以上

3.9.26　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/service-endpoint-interface

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.27　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/wsdl-port

WSDL ポートを指定します。

説明

WSDL ポートを指定します。

出現パターン

0回、または1回

3.9.28　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/wsdl-port/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.29　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/wsdl-port/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.30　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/stub-property

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。

説明

Webサービスクライアントに返却される前に javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値を指定します。プロパティー名は、JAX-RPC スタブ実装がサポートする任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

関連するネームエンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.31　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/call-property

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。

説明

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。プロパティー名は、JAX-RPC Call 実装でサポートされる任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.32　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding

カスタム認証プロバイダーのバインディングを定義します。

説明

Webサービスの参照に対する、Web Service Securityの設定を行うための要素です。 port-info要素でバインドするカスタム認証プロバイダーを、次のどれか、または両方の方法を用いて指定します。

特定のカスタム認証プロバイダーを指定する。

カスタム認証プロバイダーによって提供されるメッセージセキュリティ要件を指定する。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。

型：String

SOAP

−

−

1回

provider-id

アプリケーション固有のメッセージのセキュリティー要件を満たすために使用される認証プロバイダーを指定します。この属性を指定しない場合、デフォルトのプロバイダーがメッセージレイヤーに定義されているとき、定義されたプロバイダーが使用されます。さらにデフォルトのプロバイダーも定義されていない場合、message-security-bindingで定義された認証要件は実行されません。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.33　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security

メッセージセキュリティー要件を指定します。

説明

メッセージセキュリティー要件を指定します。

指定されたメッセージセキュリティ要件は、参照されるサービスのポートに対して適用します。

出現パターン

0回以上

3.9.34　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

出現パターン

1回以上

3.9.35　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message/java-method

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件を適用するメソッドを指定します。

出現パターン

0回、または1回

3.9.36　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message/java-method/method-name

メソッド名を指定します。

説明

メソッド名を指定、またはアスタリスク（*）によってすべてのメソッドを指定します。メソッドがオーバーロードされる場合、すべてのメソッドを同じ名称で指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.37　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message/java-method/method-params

メソッド引数を指定します。

説明

メソッドの引数を指定します。

出現パターン

0回、または1回

3.9.38　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message/java-method/method-params/method-param

メソッドの引数の完全修飾名を指定します。

説明

メソッドの引数の完全修飾名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回以上

3.9.39　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/message/operation-name

Webサービスの操作のオペレーション名を指定します。

説明

Webサービスの操作のオペレーション名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.40　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/request-protection

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

説明

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

リクエスト処理の認証ポリシー要件によって要求される認証タイプを指定します。ユーザー名とパスワードを利用する場合はsender、デジタル署名を利用する場合にはcontentを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.41　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/port-info/message-security-binding/message-security/response-protection

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

説明

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

レスポンス処理の認証ポリシー要件によって要求される認証タイプを指定します。ユーザー名とパスワードを利用する場合はsender、デジタル署名を利用する場合にはcontentを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.42　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/call-property

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。

説明

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定できるJAX-RPCプロパティーの値を指定します。プロパティー名は、JAX-RPC Call 実装がサポートする任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.43　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/wsdl-override

最終的な WSDL ドキュメントを示す有効な URL を指定します。

説明

最終的な WSDL ドキュメントを示す有効な URL を指定します。有効な URL を指定しない場合、標準DDのservice-refで指定されたWSDL ドキュメントが使用されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.44　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/service-impl-class

サービス実装クラスの名称を指定します。

説明

サービス実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.45　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/service-qname

Enterprise Beanから参照されるWSDLサービスを指定します。

説明

Enterprise Beanから参照されるWSDLサービスを指定します。

出現パターン

0回、または1回

3.9.46　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.47　/glassfish-ejb-jar/enterprise-beans/ejb/service-ref/service-qname/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.48　/glassfish-ejb-jar/enterprise-beans/ejb/message-destination-ref

物理的なメッセージ送信先の参照を定義するための要素です。

説明

この要素を利用して、メッセージ送信先のQueue、Topic、または他の物理的送信先のJNDI名に、メッセージの送信先の参照をバインドします。

標準DDで、メッセージ送信先の参照として、論理的な message-destination への message-destination-link を指定しない場合にだけ使用します。

出現パターン

0回以上

3.9.49　/glassfish-ejb-jar/enterprise-beans/ejb/message-destination-ref/message-destination-ref-name

標準DDで指定されたmessage-destination-ref-nameを指定する要素です。

説明

標準DDで指定されたmessage-destination-ref-nameを指定する要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.50　/glassfish-ejb-jar/enterprise-beans/ejb/message-destination-ref/jndi-name

参照に対して関連づける、物理的なメッセージ送信先のJNDI名を指定する要素です。

説明

参照に対して関連づける、物理的なメッセージ送信先のJNDI名を指定する要素です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.51　/glassfish-ejb-jar/enterprise-beans/ejb/principal

run-as ロールが指定された Enterprise Bean 内のプリンシパル（ユーザー）名を指定します。

説明

プラットフォームにユーザー名を指定します。

出現パターン

0回、または1回

3.9.52　/glassfish-ejb-jar/enterprise-beans/ejb/principal/name

ユーザーの名称を指定します。

説明

ユーザーの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.53　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-connection-factory

Message-driven Bean に関連づけるConnectionFactoryを指定します。

説明

Message-driven Bean に関連づけるConnectionFactoryを指定します。キューまたはトピックは、Message driven Beanに関連づけるJMSのメッセージ受信タイプと一致している必要があります。

出現パターン

0回、または1回

3.9.54　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-connection-factory/jndi-name

Message-driven Beanに関連づけるConnectionFactoryの参照を取得するためのJNDI完全修飾名を指定します。

説明

Message-driven Beanに関連づけるConnectionFactoryの参照を取得するためのJNDI完全修飾名を指定します。ここで指定するのは、Message-driven Beanに、JMSメッセージを配信するJMSリソースのJNDI名となります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.55　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-connection-factory/default-resource-principal

リソースマネージャーへのデフォルトのサインオン（名称とパスワード）を指定します。

説明

リソースの、デフォルトのプリンシパル（ユーザー）を指定します。

この要素が JMS コネクションファクトリーのリソースと一緒に使用される場合、ユーザー名称とパスワードの子要素は Message Queue ブローカーユーザーリポジトリー内の有効なエントリーである必要があります。

出現パターン

0回、または1回

3.9.56　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-connection-factory/default-resource-principal/name

リソースマネージャーへサインオンするために使用される、デフォルトのリソースプリンシパル名を指定します。

説明

リソースマネージャーへサインオンするために使用される、デフォルトのリソースプリンシパル名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.57　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-connection-factory/default-resource-principal/password

デフォルトのリソースプリンシパルのパスワードを指定します。

説明

デフォルトのリソースプリンシパルのパスワードを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.58　/glassfish-ejb-jar/enterprise-beans/ejb/jms-durable-subscription-name

Message-driven Bean に継続的に関連づけられるサブスクリプションを指定します。

説明

Message-driven Bean に継続的に関連づけられるサブスクリプションを指定します。この要素は、デスティネーションタイプがJMSのTopicで、サブスクリプションの継続性の定義がDurableの場合にだけ指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.59　/glassfish-ejb-jar/enterprise-beans/ejb/jms-max-messages-load

Message-driven Bean による処理で、一度にJMSセッションに読み込む最大メッセージ数を指定します。

説明

Message-driven Bean による処理で、一度にJMSセッションに読み込む最大メッセージ数を指定します。

指定できる値

型：Integer

1〜2147483647

デフォルト値

定義項目の省略

1

出現パターン

0回、または1回

3.9.60　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config

IOR のセキュリティー情報を指定します。

説明

IOR のセキュリティー情報を指定します。

出現パターン

0回、または1回

3.9.61　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/transport-config

トランスポートのセキュリティー情報を指定します。

説明

トランスポートのセキュリティー情報を指定します。

出現パターン

0回、または1回

3.9.62　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/transport-config/integrity

ターゲットが、整合性が保護されたメッセージをサポートするかどうかを指定します。

説明

ターゲットが、整合性が保護されたメッセージをサポートするかどうかを指定します。

指定できる値

型：String

{NONE | SUPPORTED | REQUIRED}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.63　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/transport-config/confidentiality

ターゲットが、プライバシーが保護されたメッセージをサポートするかどうかを指定します。

説明

ターゲットが、プライバシーが保護されたメッセージをサポートするかどうかを指定します。

指定できる値

型：String

{NONE | SUPPORTED | REQUIRED}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.64　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/transport-config/establish-trust-in-target

ターゲットが、クライアントに対して認証できるかどうか指定します。

説明

ターゲットが、クライアントに対して認証できるかどうか指定します。

指定できる値

型：String

{NONE | SUPPORTED | REQUIRED}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.65　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/transport-config/establish-trust-in-client

ターゲットがクライアントを認証できるかどうか指定します。

説明

ターゲットがクライアントを認証できるかどうか指定します。

指定できる値

型：String

{NONE | SUPPORTED | REQUIRED}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.66　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/as-context

クライアントの認証に使用される認証の方法を指定します。

説明

クライアントの認証に使用される認証の方法を指定します。

出現パターン

0回、または1回

3.9.67　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/as-context/auth-method

認証方式を指定します。

説明

認証方式を指定します。値は、USERNAME_PASSWORDの形式で指定します。

指定できる値

型：String

USERNAME_PASSWORD

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.68　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/as-context/realm

ユーザーが認証される、レルムを指定します。

説明

このアプリケーションと関連づけられているすべての認証要求を処理するレルムの名称を指定します。この要素が指定されない、または設定されたレルムの名称と一致しない場合、デフォルトのレルムが使用されます。

サポートされているレルムは次のとおりです。

file

ファイルにユーザー情報を格納します。Application Serverを最初にインストールしたときの、デフォルトのレルムです。

ldap

LDAP ディレクトリーにユーザー情報を格納します。

jdbc

データベースにユーザー情報を格納します。

JDBC レルムでは、サーバはデータベースからユーザークレデンシャルを取得します。Java EE Serverは、データベース情報と設定ファイル内の有効な JDBC レルムオプションを使用します。ダイジェスト認証の場合、JDBC レルムは jdbcDigestRealm で JAAS コンテキストとして作成される必要があります。

certificate

Java EE Serverセキュリティーコンテキストにユーザー識別を設定します。そして、暗号化されたクライアント証明書から得られるユーザー情報を、ユーザー識別に追加します。

指定できる値

型：String

{file | ldap | jdbc | certificate}

デフォルト値

定義項目の省略

file

出現パターン

1回

3.9.69　/glassfish-ejb-jar/enterprise-beans/ejb/ior-security-config/as-context/required

auth-method 要素で指定された認証方式がクライアント認証に使用される必要があるかどうかを指定します。

説明

auth-method 要素で指定された認証方式がクライアント認証に使用される必要があるかどうかを指定します。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

出現パターン

1回

3.9.70　/glassfish-ejb-jar/enterprise-beans/ejb/commit-option

トランザクション完了時に使用されるコミットオプションを指定します。

説明

トランザクション完了時に使用されるコミットオプションを指定します。Java EE Serverでの有効な値は B または C です。Entity Bean に適用されます。

指定できる値

型：String

{B | C}

デフォルト値

定義項目の省略

B

出現パターン

0回、または1回

3.9.71　/glassfish-ejb-jar/enterprise-beans/ejb/cmt-timeout-in-seconds

トランザクションタイムアウト時間を指定します。

説明

各Beanでのトランザクションタイムアウト時間の設定を上書きします。0を指定すると、トランザクションサービスにおけるデフォルトのトランザクションタイムアウト時間が適用されます。正数を指定した場合、新たにCMTのトランザクションを開始したBeanの全てのメソッドで、この値が利用されます。このBeanが、クライアントトランザクションに参加する場合、この値は利用されません

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

0

出現パターン

0回、または1回

3.9.72　/glassfish-ejb-jar/enterprise-beans/ejb/bean-pool

EJBのインスタンスプールの設定を行う要素です。

説明

EJBのインスタンスプールの設定を行う要素です。Stateless Session BeanまたはEntity Bean 、Message-driven Bean で使用されます。

出現パターン

0回、または1回

3.9.73　/glassfish-ejb-jar/enterprise-beans/ejb/bean-pool/steady-pool-size

EJBのインスタンスプールが保持する、Beanの初期値と最少数を指定します。

説明

EJBのインスタンスプールが保持する、Beanの初期値と最少数を指定します。Stateless Session Bean と Message-driven Bean に適用します。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

asadminユーティリティーコマンドのsetサブコマンドで使用する、configs.config.Java EEサーバの構成名.ejb-container.steady-pool-sizeパラメーターで設定されている値

出現パターン

0回、または1回

3.9.74　/glassfish-ejb-jar/enterprise-beans/ejb/bean-pool/resize-quantity

EJBのインスタンスプールに対して、同時に作成または削除されるBeanのインスタンス数を指定します。

説明

次のBeanインスタンスの数を指定します。

プールがsteady-pool-sizeより少ない数のBeanのインスタンスを保持するとき、リクエストを受けると、指定した数のBeanインスタンスが作成されます。

pool-idle-timeout-in-secondsを経過し、利用されていないBeanインスタンスをクリーンアップスレッドが削除するとき、指定した数のBeanインスタンスが削除されます。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

16

出現パターン

0回、または1回

3.9.75　/glassfish-ejb-jar/enterprise-beans/ejb/bean-pool/max-pool-size

EJBのインスタンスプールが保持する、Beanの最大数を指定します。

説明

EJBのインスタンスプールが保持する、Beanの最大数を指定します。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

asadminユーティリティーコマンドのsetサブコマンドで使用する、configs.config.Java EEサーバの構成名ejb-container.max-pool-sizeパラメーターで設定されている値

出現パターン

0回、または1回

3.9.76　/glassfish-ejb-jar/enterprise-beans/ejb/bean-pool/pool-idle-timeout-in-seconds

EJBのインスタンスプールで、アイドル状態で保持される最大時間を指定します。

説明

EJBのインスタンスプールで、アイドル状態で保持される最大時間を指定します。この要素で指定した時間を経過すると、EJBインスタンスプール内のBeanのインスタンスは、パッシベートまたは削除の候補になります。0を指定した場合、Beanインスタンスは経過時間によるパッシベートまたは削除の候補にはなりません。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

600

出現パターン

0回、または1回

3.9.77　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter

Message-driven Beanの実行時の設定をします。

説明

Message-driven Beanの実行時の設定をします。

出現パターン

0回、または1回

3.9.78　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/resource-adapter-mid

リソースアダプターモジュール ID を指定します。

説明

Message-driven Bean にメッセージを配信するリソースアダプターのモジュール ID を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.79　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/activation-config

Message-driven Beanにメッセージを配信するリソースアダプターに渡すactivation-configを指定します。

説明

Message-driven Beanにメッセージを配信するリソースアダプターに渡すactivation-configを指定します。例えば、物理的なJMS送信先の名称といった情報も含まれます。ejb-jar.xmlファイル内のactivation-config要素を上書きすることもできます。

出現パターン

1回以上

3.9.80　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/activation-config/description

activation-config要素の説明を記述します。

説明

activation-config要素の説明を記述します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.81　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/activation-config/activation-config-property

activation-configで設定するプロパティーを指定します。

説明

activation-configで設定するプロパティーを指定します。

出現パターン

1回以上

3.9.82　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/activation-config/activation-config-property/activation-config-property-name

activation-configで設定するプロパティー名称を指定します。

説明

activation-configで設定するプロパティー名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.83　/glassfish-ejb-jar/enterprise-beans/ejb/mdb-resource-adapter/activation-config/activation-config-property/activation-config-property-value

activation-configで設定するプロパティー値を指定します。

説明

activation-configで設定するプロパティー値を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.84　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint

Webサービスエンドポイントの情報を指定します。

説明

Webサービスエンドポイントの情報を指定します。

出現パターン

0回以上

3.9.85　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/port-component-name

EJB モジュール内のポートコンポーネントに一意の名称を指定します。

説明

EJB モジュール内のポートコンポーネントに一意の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.86　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/endpoint-address-uri

自動生成されたエンドポイントのアドレスを指定します。

説明

EJBエンドポイントの要求要素です。完全修飾エンドポイントアドレスにするために、Webサーバルートと組み合わせた相対パスをWebサービスエンドポイントに指定します。これらのすべての場合に、この値は固定のパターンとする必要があります（「＊」は使用できません）。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.87　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/login-config

EJB Web サービスエンドポイントに認証のための設定をします。

説明

EJB Webサービスエンドポイントに認証ためのの設定をします。サーブレットWebサービスエンドポイントの場合は、指定は不要です。サーブレットのセキュリティーの設定はweb.xmlに含まれます。

出現パターン

0回、または1回

3.9.88　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/login-config/auth-method

認証方式を指定します。

説明

認証方式を指定します。

親要素が login-config のため、Webサービスエンドポイントに認証方式を指定します。承認制約によって保護された Web リソースにアクセスするには、設定された認証方式を使用して認証される必要があります。

使用できる認証タイプは次のとおりです。

BASIC

サーバに組み込まれたログインダイアログボックスを使用します。通信プロトコルは HTTP（SSLはオプション）です。SSLを使用しないかぎりユーザークレデンシャルの暗号化はありません。SSLのような何らかの外部のセキュアシステムと一緒に使用しないかぎり、この認証タイプは安全なユーザー認証方法ではないと考えられています。

FORM

アプリケーションが独自のログインページとエラーページを提供します。通信プロトコルは HTTP（SSLはオプション）です。SSLを使用しないと、ユーザークレデンシャルは暗号化されません。

CLIENT-CERT

公開鍵を使用して、サーバがクライアントを認証します。通信プロトコルは HTTPS（HTTP over SSL）です。ユーザークレデンシャルの暗号化は SSL です。

DIGEST

ユーザー名とパスワードに基づいて、サーバがユーザーを認証します。BASIC 認証とは違い、パスワードは決してネットワークを介して送信されません。オプションで、SSLと HTTP Digest を一緒に使用できます。

指定できる値

型：String

{BASIC | DIGEST | FORM | CLIENT-CERT}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.89　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/login-config/realm

ユーザーが認証される、レルムを指定します。

説明

このアプリケーションと関連づけられているすべての認証要求を処理するために使用される、レルムの名称を指定します。この要素が指定されない、または設定されたレルムの名称と一致しない場合、デフォルトのレルムが使用されます。

サポートされるレルムは次のとおりです。

file

ファイルにユーザー情報を格納します。Application Serverを最初にインストールしたときのデフォルトレルムです。

ldap

LDAP ディレクトリーにユーザー情報を格納します。

jdbc

データベースにユーザー情報を格納します。

JDBC レルムでは、サーバはデータベースからユーザークレデンシャルを取得します。Java EE Serverは、データベース情報と設定ファイル内の有効な JDBC レルムオプションを使用します。ダイジェスト認証の場合、JDBC レルムは jdbcDigestRealm で JAAS コンテキストとして作成される必要があります。

certificate

Java EE Serverセキュリティーコンテキストにユーザー識別を設定します。そして、暗号化されたクライアント証明書から得られるユーザー情報を、ユーザー識別に追加します。

指定できる値

型：String

{file | ldap | jdbc | certificate}

デフォルト値

定義項目の省略

file

出現パターン

0回、または1回

3.9.90　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding

カスタム認証プロバイダーのバインディングを指定します。

説明

次の方法のどちらか、または両方を使用して、親要素のwebservice-endpoint に対して、カスタム認証プロバイダーのバインディングを指定します。

特定のプロバイダーにバインドする

プロバイダーによって課せられるメッセージのセキュリティー要件を指定する

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。

型：String

SOAP

−

−

1回

provider-id

アプリケーション固有のメッセージのセキュリティー要件を満たすために使用される認証プロバイダーを指定します。この属性を指定しない場合、デフォルトのプロバイダーがメッセージレイヤーに定義されているとき、定義されたプロバイダーが使用されます。さらにデフォルトのプロバイダーも定義されていない場合、message-security-bindingで定義された認証要件は実行されません。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.91　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security

メッセージセキュリティー要件を指定します。

説明

メッセージセキュリティー要件を指定します。

先祖要素は webservice-endpoint のため、これらの要件はエンドポイントの要求と応答メッセージに関係します。

出現パターン

0回以上

3.9.92　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

出現パターン

1回以上

3.9.93　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message/java-method

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件が適用されるメソッドまたは操作を指定します。

出現パターン

0回、または1回

3.9.94　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message/java-method/method-name

メソッド名を指定します。

説明

メソッド名を指定、またはアスタリスク（*）によってすべてのメソッドを指定します。メソッドがオーバーロードされる場合、すべてのメソッドを同じ名称で指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.95　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message/java-method/method-params

メソッドのパラメーターの完全修飾Java型名を指定します。

説明

メソッドのパラメーターの完全修飾Java型名を指定します。

出現パターン

0回、または1回

3.9.96　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message/java-method/method-params/method-param

メソッドのパラメーターの完全修飾Java型名を指定します。

説明

メソッドのパラメーターの完全修飾Java型名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回以上

3.9.97　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/message/operation-name

Webサービスの操作のオペレーション名を指定します。

説明

Webサービスの操作のオペレーション名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.98　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/request-protection

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

説明

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.99　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/message-security-binding/message-security/response-protection

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

説明

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

sender（ユーザー名とパスワード）またはcontent（デジタル署名）どちらかの、要求される認証のタイプを指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.100　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/transport-guarantee

クライアントとサーバ間の通信が NONE、INTEGRAL、または CONFIDENTIAL であることを指定します。

説明

クライアントとサーバ間の通信に NONE、INTEGRAL、または CONFIDENTIAL を指定します。

NONE

アプリケーションはトランスポート保障を必要としません。

INTEGRAL

アプリケーションは、通信データがクライアントとサーバ間で、伝送中に変更を加えられないような方法でデータ通信することを要求します。

CONFIDENTIAL

アプリケーションは、ほかのエンティティーが送信内容を見ることができない方法で、データ通信することを要求します。

INTEGRAL 、 CONFIDENTIAL を指定した場合は、 SSL の使用を要求されます。

指定できる値

型：String

{NONE | INTEGRAL | CONFIDENTIAL}

デフォルト値

定義項目の省略

NONE

出現パターン

0回、または1回

3.9.101　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/service-qname

参照されている WSDL service 要素を指定します。

説明

参照されている WSDL service 要素を指定します。

出現パターン

0回、または1回

3.9.102　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.103　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/service-qname/localpart

QNAME のローカルパートを指定します。

説明

QNAME のローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.104　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/tie-class

ポートコンポーネントに、自動生成される実装クラスの名称を指定します。

説明

ポートコンポーネントに、自動生成される実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.105　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/servlet-impl-class

自動生成されたサーブレット実装クラスの名称を指定します。

説明

自動生成されたサーブレット実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.106　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/debugging-enabled

Webサービスエンドポイントでデバッグを有効にするかどうかを指定します。

説明

Webサービスエンドポイントでデバッグを有効にするかどうかを指定します。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

true

依存関係のある要素または属性

false

出現パターン

0回、または1回

3.9.107　/glassfish-ejb-jar/enterprise-beans/ejb/webservice-endpoint/property

webservice-endpoint要素のプロパティーを設定します。

説明

webservice-endpoint要素のプロパティーを設定します。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

なし

−

1回

value

プロパティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.9.108　/glassfish-ejb-jar/enterprise-beans/message-destination

論理的なメッセージの送信先の名称を指定します。

説明

論理的なメッセージの送信先の名称を指定します。

message-destination-nameでは、標準DDで指定したmessage-destination-nameを指定する必要があります。

この要素は、メッセージ送信先の参照として、message-destination-linkを指定する場合に使用します。

出現パターン

0回以上

3.9.109　/glassfish-ejb-jar/enterprise-beans/message-destination/message-destination-name

標準DDで指定したmessage-destination-nameを指定します。

説明

標準DDで指定したmessage-destination-nameを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.110　/glassfish-ejb-jar/enterprise-beans/message-destination/jndi-name

論理的なメッセージ送信先のJNDI名を指定します。

説明

論理的なメッセージ送信先のJNDI名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.111　/glassfish-ejb-jar/enterprise-beans/webservice-description

Webサービスの名称と、オプションのWSDLの配置先を指定します。

説明

Webサービスの名称と、オプションのWSDLの配置先を指定します。

出現パターン

0回以上

3.9.112　/glassfish-ejb-jar/enterprise-beans/webservice-description/webservice-description-name

EJB モジュール内の Webサービスに一意の名称を指定します。

説明

EJB モジュール内の Webサービスに一意の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.9.113　/glassfish-ejb-jar/enterprise-beans/webservice-description/wsdl-publish-location

デプロイメント時にWebサービスの WSDL がパブリッシュされるディレクトリーの URL を指定します。

説明

デプロイ時にWebサービスのWSDLが配置されるディレクトリーの URL を指定します。必要なファイルはこのディレクトリーにパブリッシュされ、その場所が、モジュール固有の WSDL ディレクトリー（META-INF/wsdl）に相対となるよう維持されます。

例

webservices.xml ファイルの wsdl-file 要素が次の参照を含む ejb.jar ファイルがあるとします。

META-INF/wsdl/a/Foo.wsdl

glassfish-ejb.jar ファイルが次の要素を含むとします。

<wsdl-publish-location>file:/home/user1/publish</wsdl-publish-location>

最終的な WSDL は /home/user1/publish/a/Foo.wsdl. に保存されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.9.114　/glassfish-ejb-jar/version-identifier

EJBモジュールのバージョン情報を定義します。

説明

EJBモジュールのバージョン情報を定義します。

この要素で指定するバージョン識別子は、EJBモジュールのsuffixとなり、コロン（:）で区切って名前に続けます。バージョン識別子はアルファベットまたは数字で始まる必要があります。

使用できる文字は、英数字、アンダースコア（_）、ダッシュ（-）およびピリオド（.）です。fooというEJBモジュールに対して、有効なバージョン識別子を指定した例を以下に示します。

foo:1

foo:BETA-2e

foo:3.8

foo:patch39875

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.10　glassfish-resources.xml

リソースの設定をするためのJava EE RIのDDです。

説明

リソースに関する、Java EE RI固有の設定をするためのDDです。

glassfish-resources.xmlのルート要素はresourcesです。resources要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

JDBCコネクションプールを作成する場合、接続するデータベースに応じて次の属性を指定します。

HiRDBに接続する場合に指定する属性

属性

値

備考

/resources/jdbc-connection-pool要素のdatasource-classname属性

JP.co.Hitachi.soft.HiRDB.JDBC.PrdbDataSource

※1

JP.co.Hitachi.soft.HiRDB.JDBC.PrdbXADataSource

※2

/resources/jdbc-connection-pool要素のres-type属性

javax.sql.DataSource

※1

javax.sql.XADataSource

※2

/resources/jdbc-connection-pool要素のconnection-validation-method属性

custom-validation

※3

/resources/jdbc-connection-pool要素のvalidation-classname属性

com.hitachi.software.javaee.jca.connectionvalidation.HiRDBConnectionValidation

※3

/resources/jdbc-connection-pool/property要素

name属性の値がdescriptionのvalue属性

ポート番号

※1

環境変数グループ識別子

※2

name属性の値がDBHostNameのvalue属性

HiRDBのホスト名

−

name属性の値がXALocalCommitModeのvalue属性

true

※2、※4

name属性の値がXAOpenStringのvalue属性

環境変数グループ識別子+HiRDB.iniファイルのパス

※2

name属性の値がuserのvalue属性

ユーザー名

−

name属性の値がpasswordのvalue属性

パスワード

−

Oracleに接続する場合に指定する属性

属性

値

備考

/resources/jdbc-connection-pool要素のdatasource-classname属性

oracle.jdbc.pool.OracleDataSource

※1

oracle.jdbc.xa.client.OracleXADataSource

※2

/resources/jdbc-connection-pool要素のres-type属性

javax.sql.DataSource

※1

javax.sql.XADataSource

※2

/resources/jdbc-connection-pool要素のconnection-validation-method属性

custom-validation

※3

/resources/jdbc-connection-pool要素のvalidation-classname属性

org.glassfish.api.jdbc.validation.OracleConnectionValidation

※3

/resources/jdbc-connection-pool/property要素

name属性の値がdatabaseNameのvalue属性

Oracle SID

※5

name属性の値がserverNameのvalue属性

Oracleのホスト名称、またはIPアドレス

※5

name属性の値がportNumberのvalue属性

ポート番号

※5

name属性の値がuserのvalue属性

ユーザー名

−

name属性の値がpasswordのvalue属性

パスワード

−

name属性の値がdriverTypeのvalue属性

thin

※5

name属性の値がurlのvalue属性

jdbc:oracle:thin:@Oracleのホスト名称、またはIPアドレス:ポート番号:Oracle SID

※5

注※1

XAトランザクションを使用しない場合に指定します。

注※2

XAトランザクションを使用する場合に指定します。

注※3

コネクション障害検知を行う場合だけ指定します。

注※4

このオプションは、トランザクションがグローバルトランザクションでないときに、オートコミット機能を有効にするかどうかを設定します。この設定がtrueでない場合、コネクション障害検知機能が正常に動作しません。コネクション障害検知機能を使用する場合、trueを指定します。

注※5

databaseName、serverName、portNumber、driverTypeの4つのプロパティーか、urlのどちらかを指定します。両方を指定した場合、urlが有効になり、それ以外の4つのプロパティーは無視されます。

スキーマ

<!DOCTYPE resources PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 Resource Definitions
//EN" "http://glassfish.org/dtds/glassfish- resources_1_5.dtd">

格納先

DDファイルは次の場所に格納されます。

application_ear_name/META-INF ディレクトリー

application_ear_name：アプリケーションのアーカイブ名を表します。

war_name/WEB-INF ディレクトリー

war_name：Web アプリケーションのアーカイブ名を表します。

ejb_jar_name/META-INF ディレクトリー

ejb_jar_name：EJB アプリケーションのアーカイブ名を表します。

client_jar_name/META-INF ディレクトリー

client_jar_name：クライアントアプリケーションのアーカイブ名を表します。

connector_rar_name/META-INF ディレクトリー

connector_rar_name：リソースアダプターアーカイブのアーカイブ名を表します。

要素の階層

resources
. custom-resource
. . description
. . property
. external-jndi-resource
. . description
. . property
. . . description
. jdbc-resource
. . description
. . property
. . . description
. mail-resource
. . description
. . property
. . . description
. admin-object-resource
. . description
. . property
. . . description
. connector-resource
. . description
. . property
. . . description
. resource-adapter-config
. . property
. . . description
. jdbc-connection-pool
. . description
. . property
. . . description
. connector-connection-pool
. . description
. . security-map
. . . principal
. . . . name
. . . user-group
. . . backend-principal
. . property
. . . description
. work-security-map
. . description
. . principal-map
. . group-map

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE resources PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 Resource Definitions
//EN" "http://glassfish.org/dtds/glassfish- resources_1_5.dtd">
<resources>
       <jdbc-connection-pool>
        <property name="serverName" value="localhost"/>
        <property name="portNumber" value="1527"/>
        <property name="databaseName" value="forest"/>
        <property name="User" value="forest"/>
        <property name="Password" value="forest"/>
        <property name="URL" value="jdbc:oracle://localhost:1527/forest"/>
    </jdbc-connection-pool>
    <jdbc-resource enabled="true" jndi-name="jdbc/forest"
pool-name="oracle_net_forest_forestPool"/>
    <connector-connection-pool associate-with-thread="false"
connection-creation-retry-attempts="0" />
</resources>

3.11　glassfish-resources.xmlに設定する要素の詳細

glassfish-resources.xmlに設定する要素について説明しています。

3.11.1　/resources

エンタープライズアプリケーションのアプリケーションスコープのリソースを定義します。

説明

エンタープライズアプリケーション、Webモジュール、EJBモジュール、リソースアダプターアーカイブ、またはアプリケーションクライアントのモジュールの、アプリケーションスコープのリソースを定義します。これはルート要素です。glassfish-resources.xmlファイルには、リソース要素は1つだけ存在します。

出現パターン

1回

3.11.2　/resources/custom-resource

カスタムリソースを定義します。

説明

サーバ全体のカスタムリソースのオブジェクトファクトリーを指定するカスタムリソースを定義します。このオブジェクトファクトリーは、javax.naming.spi.ObjectFactoryインターフェースを実装します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースのJNDI名を指定します。

型：String

−

−

1回

res-type

リソースタイプの完全修飾名を指定します。

型：String

−

−

1回

factory-class

javax.naming.spi.ObjectFactoryを実装した、ファクトリークラスの完全修飾名を指定します。

型：String

javax.naming.spi.ObjectFactoryインターフェースを実装するファクトリークラス

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.3　/resources/custom-resource/description

custom-resource要素の説明を指定します。

説明

custom-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.4　/resources/custom-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.5　/resources/external-jndi-resource

外部のJNDIリポジトリーに存在するリソースを定義します。

説明

外部のJNDIリポジトリーに存在するリソースを定義します。例えば、一般的なJavaオブジェクトをLDAPサーバに格納できます。外部のJNDIファクトリーは、javax.naming.spi.InitialContextFactoryインターフェースを実装する必要があります。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースの JNDI名を指定します 。

型：String

−

−

1回

jndi-lookup-name

リソースのJNDIルックアップ名を指定します 。

型：String

−

−

1回

res-type

リソースの完全修飾タイプを指定します。

型：String

−

−

1回

factory-class

javax.naming.spi.InitialContextFactoryを実装したファクトリークラスの完全修飾名を指定します。

型：String

javax.naming.spi.InitialContextFactoryインターフェースを実装するファクトリークラス

−

−

1回

enabled

このリソースが実行時に有効であるかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.6　/resources/external-jndi-resource/description

external-jndi-resource要素の説明を指定します。

説明

external-jndi-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.7　/resources/external-jndi-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.8　/resources/external-jndi-resource/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.9　/resources/jdbc-resource

JDBCリソースを定義します。

説明

JDBCリソースを定義します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースの JNDI名を指定します 。

型：String

−

−

1回

pool-name

関連づけられているJDBCコネクションプールの名称を指定します。

型：String

−

−

1回

enabled

このリソースが実行時に有効であるかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.10　/resources/jdbc-resource/description

jdbc-resource要素の説明を指定します。

説明

jdbc-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.11　/resources/jdbc-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.12　/resources/jdbc-resource/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.13　/resources/mail-resource

JavaMailリソースを定義します。

説明

JavaMail（javax.mail.Session）リソースを定義します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースのJNDI名を指定します 。

型：String

−

−

1回

store-protocol

メッセージの受信プロトコルを指定します。

型：String

{imap | pop3 | imaps | pop3s}

imap

−

0回、または1回

store-protocol-class

受信プロトコルのサービスプロバイダー実装クラスを指定します。

型：String

{com.sun.mail.imap.IMAPStore | com.sun.mail.pop3.POP3Store | com.sun.mail.imap.IMAPSSLStore | com.sun.mail.pop3.POP3SSLStore}

com.sun.mail.imap.IMAPStore

−

0回、または1回

transport-protocol

メッセージの送信プロトコルを指定します。

型：String

{smtp | smtps}

smtp

−

0回、または1回

transport-protocol-class

送信プロトコルのサービスプロバイダー実装クラスを指定します。

型：String

{com.sun.mail.smtp.SMTPTransport | com.sun.mail.smtp.SMTPSSLTransport}

com.sun.mail.smtp.SMTPTransport

−

0回、または1回

host

メールサーバのホスト名を指定します。

型：String

−

−

1回

user

メールサーバのユーザー名を指定します。

型：String

−

−

1回

from

メッセージの送信者を示すための電子メールアドレスを指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.14　/resources/mail-resource/description

mail-resource要素の説明を指定します。

説明

mail-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.15　/resources/mail-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

mail-resource要素に対してプロパティーを設定して、JavaMail Sessionオブジェクトでこれらのプロパティーをあとで取得できます。すべてのプロパティー名は接頭文字「mail-」で始まる必要があります。Java EEサーバは、プロパティー名の-（ハイフン）を.（ピリオド）に変更し、プロパティーをMailConfigurationオブジェクト、およびJavaMail Sessionオブジェクトへ保存します。プロパティーの名称が「mail-」で始まらない場合、プロパティーは無視されます。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.16　/resources/mail-resource/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.17　/resources/admin-object-resource

インバウンドのリソースアダプターの管理対象オブジェクトを定義します。

説明

インバウンドのリソースアダプターの管理対象オブジェクトを定義します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースの JNDI名を指定します 。

型：String

−

−

1回

res-type

リソースの完全修飾タイプを指定します。

型：String

−

−

1回

class-name

同一res-typeの実装クラスが複数存在する場合に、対応する実装クラスの名称を指定します。

型：String

−

−

1回

res-adapter

インバウンドのリソースアダプターの名称を指定します。

型：String

−

−

1回

enabled

このリソースが実行時に有効であるかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.18　/resources/admin-object-resource/description

admin-object-resource要素の説明を指定します。

説明

admin-object-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.19　/resources/admin-object-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.20　/resources/admin-object-resource/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.21　/resources/connector-resource

コネクターリソースを定義します。

説明

リソースアダプターの特定のコネクション定義でのコネクションファクトリーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

jndi-name

リソースの JNDI 名を指定します 。

型：String

−

−

1回

pool-name

関連づけられているコネクターコネクションプールの名称を指定します。

型：String

−

−

1回

enabled

このリソースが実行時に有効であるかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.22　/resources/connector-resource/description

connector-resource要素の説明を指定します。

説明

connector-resource要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.23　/resources/connector-resource/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.24　/resources/connector-resource/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.25　/resources/resource-adapter-config

リソースアダプターアーカイブ構成情報を定義します。

説明

リソースアダプターアーカイブ構成情報を定義します。子要素のproperty要素を使用して、リソースアダプターアーカイブ構成情報を設定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

resource-adapter-name

デプロイされたリソースアダプターアーカイブまたはアプリケーションを指定します。リソースアダプターがアプリケーションに組み込まれている場合、名称はアプリケーション名#リソースアダプター名になります。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.26　/resources/resource-adapter-config/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

なし

−

1回

value

プロパティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.27　/resources/resource-adapter-config/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.28　/resources/jdbc-connection-pool

JDBCコネクションプールに関する設定を定義します。

説明

JDBCコネクションプールに関する設定を定義します。

接続するデータベースに応じて指定するオプションについては、コマンドリファレンスのcreate-jdbc-connection-poolを参照してください。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

コネクションプールの名称を指定します。jdbc-resource要素のpool-name属性は、この名称を参照します。

型：String

−

−

1回

datasource-classname

JDBCドライバーのデータソースのクラス名を指定します。このクラスは、javax.sql.DataSource、javax.sql.XADataSource、javax.sql.ConnectionPoolDatasource、またはこれらを組み合わせて実装する必要があります。

型：String

−

−

0回、または1回

res-type

データソースクラスが実装するインターフェースを指定します。

java.sql.Driverを実装するJDBCドライバー、およびjava.sql.Driverを使用するアプリケーションの組み合わせで構成される場合、この属性にjava.sql.Driverを設定します。また、データソースクラスが2つ以上のインターフェースを実装する場合、またはdriver-classnameが指定された場合は、あいまいさを避けるために、この属性を指定する必要があります。この属性が正当な値を持っていて、データソースクラスが示されたインターフェースを実装していない場合、エラーが発生します。

型：String

{javax.sql.DataSource | javax.sql.XADataSource | javax.sql.ConnectionPoolDatasource | java.sql.Driver}

−

−

0回、または1回

driver-classname

データベース製品によって提供されるJDBCドライバーのドライバーのクラス名を指定します。このドライバーは、java.sql.Driverインターフェースを実装する必要があります。

型：String

java.sql.Driverインターフェースを実装するクラス（サブクラス）名

−

−

0回、または1回

ping

コネクションプール生成時にデータベースコネクションの確認を行うことで、誤りのある属性値を特定し警告するかどうかを指定します。

型：Boolean

{true | false}

false

−

0回、または1回

steady-pool-size

コネクションプールの最小コネクション数を指定します 。

型：Integer

0〜2147483647

24

−

0回、または1回

max-pool-size

コネクションプールの最大コネクション数を指定します 。

型：Integer

1〜2147483647

24

−

0回、または1回

max-wait-time-in-millis

コネクション取得を待つ時間（ミリ秒）を指定します。0の場合、リソースが使用できるようになるまで、またはエラーが発生するまで、呼び出し側は無期限にブロックされます。

型：Integer

0〜2147483647

60000

−

0回、または1回

pool-resize-quantity

コネクションプールで保持しているアイドル状態のコネクションを削除する数を指定します。

これは、idle-timeout-in-secondsの間隔で定期的に実行されます。アイドル状態のコネクションとは、idle-timeout-in-secondsの間使用されていないコネクションを指します。プールサイズがsteady-pool-sizeに達すると、コネクションの削除は停止します。

型：Integer

1〜2147483647

2

−

0回、または1回

idle-timeout-in-seconds

コネクションプール内でアイドル状態のコネクションを維持できる最長時間を秒単位で指定します。この時間が過ぎると、コネクションプールはこのコネクションを破棄します。

この属性で指定する時間は、データベースサーバのタイムアウト値よりも短くすることで、アプリケーション内で使用できないコネクションが保持されるのを防止する必要があります。

0を指定した場合、無効になります。

型：Integer

0〜2147483647

300

−

0回、または1回

transaction-isolation-level

プールされたデータベースコネクションのトランザクションアイソレーションレベルを指定します。

read-uncommitted

ダーティーリード、ノンリピータブルリード、およびファントムリードが発生する可能性があります。

read-committed

ダーティーリードは阻止されますが、ノンリピータブルリード、およびファントムリードは発生する可能性があります。

repeatable-read

ダーティーリード、およびノンリピータブルリードは阻止されますが、ファントムリードが発生する可能性があります。

serializable

ダーティーリード、ノンリピータブルリード、およびファントムリードが阻止されます。

型：String

{read-uncommitted | read-committed | repeatable-read | serializable}

JDBCドライバーでのデフォルトのアイソレーションレベル

−

0回、または1回

is-isolation-level-guaranteed

transaction-isolation-levelが明示的に設定された場合にだけ有効になります。trueの場合、プールから取得したコネクションはすべて、任意のアイソレーションレベルを持つことが保障されます。これによって、性能に影響を受けるおそれのあるJDBCドライバーが幾つかあります。ホスト型アプリケーションが、アイソレーションレベルが変更されたコネクションを戻さないと確信する場合にだけ、この属性をfalseに設定します。

型：Boolean

{true | false}

true

−

0回、または1回

is-connection-validation-required

アプリケーションでコネクションを取得する前に、コネクション障害検知を実施するかどうかを指定します。障害検知でコネクションに問題がある場合、コネクションは破棄され、再生成されます。

型：Boolean

{true | false}

false

−

0回、または1回

connection-validation-method

コネクション障害検知の方法を指定します。

auto-commit

Connection#setAutoCommit（Connection#getAutoCommit()）を実行します。

meta-data

Connection#getMetaData()を実行します。

table

validation-table-nameで指定したテーブルに対して、SELECT文を実行します。

custom-validation

validation-classnameで指定したユーザー定義のクラスを使用します。

型：String

{auto-commit | meta-data | table | custom-validation}

table

−

0回、または1回

validation-table-name

使用する検証テーブルの名称を指定し、SELECT文を実行してコネクションを検証します。

型：String

−

−

0回、または1回

validation-classname

カスタムの検証を提供するクラスを指定します。このパラメーターは、connection-validation-methodにcustom-validationが設定されている場合、必須です。Java EE Serverにアクセスできるクラス名を指定する必要があります。

型：String

org.glassfish.api.jdbc.ConnectionValidationインターフェースを実装するクラス（サブクラス）名

−

−

0回、または1回

non-transactional-connections

trueに設定すると、JDBCコネクションプールに作成される非トランザクションコネクションを許可します。これらのコネクションは、トランザクションマネージャーとのトランザクションに自動的には参加しません。

型：Boolean

{true | false}

false

−

0回、または1回

validate-atmost-once-period-in-seconds

コネクション障害検知をする間隔を秒単位で指定します。コネクション障害検知の実施回数を最小限にします。値「0」は、Java EE Serverが接続によるコネクション障害検知の実施回数を最小に抑えようとしないことを示します。すなわち、値「0」はこの属性を無効にします。

型：Integer

0〜2147483647

0

−

0回、または1回

connection-leak-timeout-in-seconds

アプリケーションによる潜在的なコネクションリークを検出します。指定した期間内にアプリケーションがプールに戻さないコネクションは、潜在的なリークと判断され、スタックトレースがログに記録されます。値「0」は、リーク検出を無効にします。0以外の値は、リーク追跡を有効にします。この属性は、アプリケーションからの潜在的なコネクションリークを回避するためにconnection-leak-reclaimと共に使用します。

型：Integer

0〜2147483647

0

−

0回、または1回

connection-leak-reclaim

trueに設定すると、connection-leak-timeout-in-secondsの発生後に、コネクションを再要求します。

型：Boolean

{true | false}

false

−

0回、または1回

connection-creation-retry-attempts

新しいコネクションの作成に失敗した場合に行われる試行の回数を指定します。

型：Integer

0〜2147483647

0

−

0回、または1回

connection-creation-retry-interval-in-seconds

connection-creation-retry-attemptsの値が0より大きい場合に、コネクションの作成を試行する間隔を秒単位で指定します。

型：Integer

0〜2147483647

10

−

0回、または1回

statement-timeout-in-seconds

ステートメントのクエリータイムアウトプロパティーを設定して、異常に長い時間実行されているクエリーを終了させる機能を有効にします。-1を指定するとこの機能は無効になります。アプリケーションが実行したJDBCクエリーが異常に長い時間実行されている場合、タイムアウトをステートメントに明示的に設定しないかぎり、JDBCクエリーは応答なし状態のままになるおそれがあります。この属性は、すべてのクエリーが指定した時間内に完了しない場合、自動的にタイムアウトすることを保証します。ステートメントが作成されると、この属性の指定値に従いqueryTimeoutが設定されます。これは、基本的なJDBCドライバーがStatement、PreparedStatement、CallableStatement、およびResultSetのqueryTimeoutをサポートする場合にだけ機能します。

型：Integer

-1〜2147483647

-1

−

0回、または1回

lazy-connection-enlistment

trueに設定すると、コネクションは、実際に利用されるまでトランザクションに参加しません。falseに設定すると、コネクションが取得された時点で、トランザクションに参加します。

型：Boolean

{true | false}

false

−

0回、または1回

lazy-connection-association

trueに設定すると、物理コネクションは、使用されるまで論理コネクションに関連づけられません。falseに設定すると、物理コネクションは、使用される前でも論理コネクションに関連づけられます。

型：Boolean

{true | false}

false

−

0回、または1回

match-connections

プールから取得したコネクションが、特定の資格を持つかコネクションマッチングを行います。trueに設定すると、コネクションマッチングを有効にします。コネクションが同じ種類の場合、falseに設定できます。複数のユーザークレデンシャルを持つアプリケーションがコネクションプールを使用する場合、match-connectionsをtrueに設定する必要があります。

コネクションプールはリクエストの資格とプール内のコネクションを照合し、一致したコネクションを戻します。新規のリクエストが異なる資格を持つ場合、一致しない未使用のコネクションを自動的に破棄し、新しいコネクションを提供して新規のリクエストを満たします。

この属性は、アプリケーションが1つの資格だけしか使用せず、プールが同じ種類のコネクションを持っているとわかっている場合、trueにする必要はありません。

型：Boolean

{true | false}

false

−

0回、または1回

max-connection-usage-count

コネクションがプールに再利用される回数を指定します。指定した回数だけ再利用されると、コネクションはクローズされます。値「0」は、この機能を無効にします。コネクションを再利用できる最大回数を制限することで、アプリケーションがステートメントを閉じない場合にステートメントリークを回避できます。

型：Integer

0〜2147483647

0

−

0回、または1回

statement-cache-size

LRUキャッシュ方式を使用してキャッシュするステートメント数を指定します。値「0」はステートメントのキャッシュを無効にします。

型：Integer

0〜2147483647

0

−

0回、または1回

pooling

コネクションをプールするかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.29　/resources/jdbc-connection-pool/description

jdbc-connection-pool要素の説明を指定します。

説明

jdbc-connection-pool要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.30　/resources/jdbc-connection-pool/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

この要素には、指定のプロパティー以外に、JDBCドライバーがサポートするDataSourceのプロパティーを指定できます。指定できるプロパティーについては、使用するデータベースのマニュアルを参照してください。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

dynamic-reconfiguration-wait -timeout-in-seconds

コネクションプールの動的再構成を、コネクションプールを使用中のアプリケーションに透過的に有効にするために使用されます。これによって、プールへの属性またはプロパティーの変更を有効にするためにアプリケーションを再起動する必要がなくなります。

処理中のトランザクションのコネクション取得要求は、タイムアウト期間内のコネクション取得要求であるかぎり、トランザクションを完了するために古いプール構成のまま実行することが許可されます。新しいコネクション取得要求はプールの再構成が完了するまで待機し、コネクションは変更されたプール構成を使用して取得されます。

型：Integer

0〜2147483647

−

−

1回

user

データベースに接続するためのユーザー名を指定します。

型：String

−

−

1回

password

データベースに接続するためのパスワードを指定します。

型：String

−

−

1回

databaseName

コネクションプールのデータベースを指定します 。

型：String

−

−

1回

serverName

コネクションプールのデータベースサーバを指定します 。

型：String

−

−

1回

portNumber

データベースサーバがリクエストをリッスンするポートを指定します。

型：Integer

1〜65535

−

−

1回

networkProtocol

通信プロトコルを指定します。

型：String

−

−

1回

roleName

初期SQLロール名を指定します。

型：String

−

−

1回

datasourceName

コネクションプーリングが動作するXADataSourceまたはConnectionPoolDataSourceを指定します。

型：String

−

−

1回

description

説明テキストを指定します。

型：String

−

−

1回

url

コネクションプールのURLを指定します 。このプロパティーは標準プロパティーではありませんが、共通で使用されます。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.31　/resources/jdbc-connection-pool/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.32　/resources/connector-connection-pool

コネクターコネクションプールを定義します。

説明

コネクタコネクションプールに関する設定を定義します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

コネクションプールの名称を指定します。connector-resource要素のpool-name属性は、この名称を参照します。

型：String

−

−

1回

resource-adapter-name

デプロイされたリソースアダプターアーカイブまたはアプリケーションの名称を指定します。デプロイ中に名称が指定されていない場合、.rarファイルの名称が使用されます。リソースアダプターがアプリケーションに組み込まれている場合、名称はアプリケーション名#リソースアダプター名になります。

型：String

−

−

1回

connection-definition-name

ra.xmlファイルのリソースアダプターのconnection-definition要素を特定する一意の名称を指定します。この名称は通常、connection-definition要素のconnectionfactory-interfaceになります。

型：String

−

−

1回

steady-pool-size

コネクションプールの最小コネクション数を指定します。

型：Integer

0〜2147483647

24

−

0回、または1回

max-pool-size

コネクションプールの最大コネクション数を指定します。

型：Integer

1〜2147483647

24

−

0回、または1回

max-wait-time-in-millis

コネクション取得を待つ時間（ミリ秒）を指定します。0の場合、リソースが使用できるようになるまで、またはエラーが発生するまで、呼び出し側は無期限にブロックされます。

型：Integer

0〜2147483647

60000

−

0回、または1回

pool-resize-quantity

コネクションプールで保持しているアイドル状態のコネクションを削除する数を指定します。

これは、idle-timeout-in-secondsの間隔で定期的に実行されます。アイドル状態のコネクションとは、idle-timeout-in-secondsの間使用されていないコネクションを指します。プールサイズがsteady-pool-sizeに達すると、コネクションの削除は停止します。

型：Integer

1〜2147483647

2

−

0回、または1回

idle-timeout-in-seconds

コネクションプール内でアイドル状態のコネクションを維持できる最長時間を秒単位で指定します。この時間が過ぎると、コネクションプールはこのコネクションを破棄します。

型：Integer

1〜2147483647

300

−

0回、または1回

transaction-support

このコネクションプールのトランザクションサポートを指定します。リソースアダプターで定義されたトランザクションサポートを下位互換で上書きし、リソースアダプター以下のトランザクションレベルをサポートするようにします。

XATransaction

XAトランザクションをサポートします。

LocalTransaction

ローカルトランザクションだけをサポートします。

NoTransaction

トランザクションをサポートしません。

型：String

{XATransaction | LocalTransaction | NoTransaction}

−

−

0回、または1回

is-connection-validation-required

アプリケーションでコネクションを取得する前に、コネクション障害検知を実施するかどうかを指定します。障害検知でコネクションに問題がある場合、コネクションは破棄され、再生成されます。

一定間隔のコネクション障害検知については、指定値に依存しないで常に有効になります。

型：Boolean

{true | false}

false

−

0回、または1回

validate-atmost-once-period-in-seconds

最大で1回、コネクション障害検知をする間隔を秒単位で指定します。検証コール数を最小限にします。値「0」を指定すると、検証コール数が無制限になります。

型：Integer

0〜2147483647

0

−

1回

connection-leak-timeout-in-seconds

アプリケーションによる潜在的なコネクションリークを検出します。指定した期間内にアプリケーションがプールに戻さないコネクションは、潜在的なリークと判断され、スタックトレースがログに記録されます。値「0」は、リーク検出を無効にします。0以外の値は、リーク追跡を有効にします。

型：Integer

0〜2147483647

0

−

1回

connection-leak-reclaim

trueに設定した場合、プールは、connection-leak-timeout-in-secondsの発生後にコネクションが再取得されます。

型：Boolean

{true | false}

false

−

1回

connection-creation-retry-attempts

新しいコネクションの作成の試行回数を指定します。

型：Integer

0〜2147483647

0

−

1回

connection-creation-retry-interval-in-seconds

connection-creation-retry-attemptsの値が0より大きい場合に、コネクションの作成を試行する間隔を秒単位で指定します。

型：Integer

0〜2147483647

10

−

1回

lazy-connection-enlistment

trueに設定すると、コネクションは、実際に利用されるまでトランザクションに参加しません。falseに設定すると、コネクションが取得された時点で、トランザクションに参加します。

型：Boolean

{true | false}

false

−

1回

lazy-connection-association

trueに設定した場合、物理コネクションは、使用されるまで論理コネクションに関連づけられません。falseに設定すると、物理コネクションは、使用される前でも論理コネクションに関連づけられます。

型：Boolean

{true | false}

false

−

1回

match-connections

trueに設定した場合、コネクションマッチングを有効にします。コネクションが同じ種類の場合、falseに設定できます。

型：Boolean

{true | false}

true

−

1回

max-connection-usage-count

コネクションがプールに再利用される回数を指定します。コネクションは、指定された回数利用されると、クローズされます。値「0」は、この機能を無効にします。

型：Integer

0〜2147483647

0

−

1回

ping

コネクションプール生成時にデータベースコネクションの確認を行うことで、誤りのある属性値を特定し警告するかどうかを指定します。

型：Boolean

{true | false}

false

−

0回、または1回

pooling

falseに設定した場合、コネクションプーリングを無効にします。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.33　/resources/connector-connection-pool/description

connector-connection-pool要素の説明を指定します。

説明

connector-connection-pool要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.34　/resources/connector-connection-pool/security-map

サーブレットまたはEJBの認証中に受信したプリンシパルを、EISでのプリンシパルにマッピングします。

説明

サーブレットまたはEJBの認証中に受信したプリンシパルを、EISでのプリンシパルにマッピングします。このマッピングは任意です。複数のJava EE Serverのプリンシパルを同じbackend principalにマップできます。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

セキュリティーマッピングの名称を 指定します 。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.35　/resources/connector-connection-pool/security-map/principal

サーバインスタンスでのプリンシパルを定義します。

説明

サーバインスタンスでのプリンシパルを定義します。

出現パターン

1回以上

3.11.36　/resources/connector-connection-pool/security-map/principal/name

サーバインスタンスでのユーザー名を指定します。

説明

サーバインスタンスでのユーザー名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.11.37　/resources/connector-connection-pool/security-map/user-group

指定したプリンシパルが属するグループを指定します。

説明

指定したプリンシパルが属するグループを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回以上

3.11.38　/resources/connector-connection-pool/security-map/backend-principal

EISが必要とするユーザー名およびパスワードを指定します。

説明

エンタープライズ情報システム（EIS）が必要とするユーザー名およびパスワードを指定します。

出現パターン

1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

user-name

EISが必要とするユーザー名を指定します。

型：String

−

−

1回

password

パスワードがある場合、EISが必要とするパスワードを指定します。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.39　/resources/connector-connection-pool/property

プロパティーの名称と値を指定します。

説明

プロパティーの名称と値を指定します。

この要素を使用することで、ManagedConnectionFactoryクラスが保持している設定値をJavaBeans仕様に基づいて上書きできます。

プロパティー名は、ra.xmlのmanagedconnectionfactory-class要素に指定したManagedConnectionFactoryクラスのsetterに対応するJavaBeans仕様に従ったプロパティー名を指定します。

ra.xmlのconfig-property要素とこの要素に同じプロパティーを設定した場合、この要素の設定が優先されます。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

AddressList

MQブローカーのホストとポートの組み合わせのリストを指定します。javax.jms.TopicConnectionFactoryまたはjavax.jms.QueueConnectionFactory型のJMSリソース用です。

型：String

−

−

1回

ClientId

TopicConnectionFactoryクラスのcreateTopicConnectionメソッドを使用して作成されるコネクションに関連づけられるJMSクライアントの識別子を指定します。javax.jms.TopicConnectionFactory型のJMSリソースについては、持続性のあるサブスクリプションの名称は一意で、クライアント識別子の範囲内でだけ有効です。持続性のあるサブスクライバーを作成または再活性化するには、コネクションが有効なクライアント識別子を持っている必要があります。JMSの仕様書情報では、クライアント識別子は一意で、クライアント識別子は一度に1つのアクティブなコネクションでだけ使用できます。

型：String

−

−

1回

UserName

MQブローカーに接続するためのユーザー名を指定します。

javax.jms.TopicConnectionFactoryまたはjavax.jms.QueueConnectionFactory型のJMSリソース用です。

型：String

guest

−

1回

Password

MQブローカーに接続するためのパスワードを指定します。

javax.jms.TopicConnectionFactoryまたはjavax.jms.QueueConnectionFactory型のJMSリソース用です。

型：String

guest

−

1回

ReconnectAttempts

imqAddressList内の各アドレスへのコネクション（または再コネクション）の試行回数を指定します。指定された試行回数に達すると、クライアントランタイムがリスト内の次のアドレスに移動します。値「-1」は、再コネクションの試行回数が無制限であることを示します（クライアントランタイムは、成功するまで、最初のアドレスに接続しようとします）。

型：Integer

-1〜2147483647

6

−

1回

ReconnectInterval

再コネクションを試行する間隔をミリ秒単位で指定します。この間隔は、imqAddressList内の各アドレス、およびリスト内の連続するアドレスへのコネクションの試行に適用されます。間隔が短過ぎる場合、ブローカーが回復するとき間を確保できません。間隔が長過ぎる場合は、再コネクション時に許容できない遅延が発生することがあります。

型：Integer

1〜2147483647

30000

−

1回

ReconnectEnabled

trueの場合、コネクションが失われたとき、クライアントランタイムがMQブローカー（またはimqAddressList内のアドレス）への再コネクションを試行します。

型：Boolean

{true | false}

false

−

1回

AddressListBehavior

コネクションの試行をimqAddressList属性のアドレスの順序（priority）、またはランダムな順序（random）で行うように指定します。

多くのクライアントが同じコネクションファクトリーを使用してコネクションを試行する場合、これらすべてのクライアントが同じアドレスに接続しないよう、ランダムな順序を使用してください。

指定できる値は次のとおりです。

PRIORITY

parallel-brokerの再コネクションを有効にするには、imqAddressListBehavior属性をPRIORITYに設定します。通常、このタイプの再コネクションで指定できるブローカーは2つ以下です。この場合、メッセージは1つのブローカーに送信され、すべてのクライアントが最初のブローカーから2番目のブローカーにフェイルオーバーします。

RANDOM

クラスタ化したブローカーの再コネクションを有効にするには、imqAddressListBehavior属性をRANDOMに設定します。この場合、クライアントランタイムはリスト内のランダムなアドレスに接続しようとするため、クライアントコネクションがブローカークラスター全体に均等に分散されます。

型：String

{priority | random}

priority

−

1回

AddressListIterations

クライアントランタイムが、コネクションを確立（または再確立）するため、imqAddressListを巡回する回数を指定します。値「-1」は、試行回数が無制限であることを示します。

型：Integer

-1〜2147483647

-1

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.40　/resources/connector-connection-pool/property/description

property要素の説明を指定します。

説明

property要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.41　/resources/work-security-map

ワークセキュリティーマップを定義します。

説明

Workインスタンスに関連づけられたプリンシパルと、Java EE Server のサーバインスタンスでのプリンシパルのマッピングを定義します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

ワークセキュリティーマップの一意の名前を 指定します 。

型：String

−

−

1回

resource-adapter-name

デプロイされたリソースアダプターアーカイブまたはアプリケーションの名称を指定します。

リソースアダプターがアプリケーションに埋め込まれている場合には、アプリケーション名/リソースアダプター名となります。

型：String

−

−

1回

enabled

実行時にこのリソースが有効になるかどうかを決定します。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.42　/resources/work-security-map/description

work-security-map要素の説明を指定します。

説明

work-security-map要素の説明を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.11.43　/resources/work-security-map/principal-map

EISでのプリンシパルを、Java EE Server のサーバインスタンスでのプリンシパルにマッピングします。

説明

EISでのプリンシパルを、Java EE Serverのサーバインスタンスでのプリンシパルにマッピングします。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

eis-principal

EISでのプリンシパルを指定します。

型：String

−

−

1回

mapped-principal

Java EE Serverドメインのサーバインスタンスでのプリンシパルを指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.11.44　/resources/work-security-map/group-map

EISグループをJava EE Serverのサーバインスタンスでのグループにマップします。

説明

EISグループをJava EE Serverのサーバインスタンスでのグループにマップします。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

eis-group

EISでのグループを指定します。

型：String

−

−

1回

mapped-group

Java EE Serverのサーバインスタンスでのグループを指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.12　glassfish-web.xml

Webアプリケーション（WAR）の設定をするためのJava EE RIのDDです。

説明

Webアプリケーション（WAR）に関する、Java EE RI固有の設定をするためのDDです。

glassfish-web.xmlのルート要素はglassfish-web-appです。glassfish-web-app要素は、「要素の階層」で示すように、子要素と属性を含みます（それらの子要素と属性の配下にも、さらに、子要素と属性を含むことがあります）。

スキーマ

<!DOCTYPE glassfish-web-app PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">

格納先

DDファイルは次の場所に格納されます。

war_name/WEB-INF ディレクトリー

war_name：Webアプリケーションのアーカイブ名を表します。

要素の階層

glassfish-web-app
. context-root
. security-role-mapping
. . role-name
. . principal-name
. . group-name
. servlet
. . servlet-name
. . principal-name
. . webservice-endpoint
. . . port-component-name
. . . endpoint-address-uri
. . . login-config
. . . . auth-method
. . . message-security-binding
. . . . message-security
. . . . . message
. . . . . . java-method
. . . . . . . method-name
. . . . . . . method-params
. . . . . . . . method-param
. . . . . . operation-name
. . . . . request-protection
. . . . . response-protection
. . . transport-guarantee
. . . service-qname
. . . . namespaceURI
. . . . localpart
. . . tie-class
. . . servlet-impl-class
. . . debugging-enabled
. idempotent-url-pattern
. session-config
. . session-manager
. . . manager-properties
. . . . property
. . . . . description
. . session-properties
. . . property
. . . . description
. . cookie-properties
. . . property
. . . . description
. ejb-ref
. . ejb-ref-name
. . jndi-name
. resource-ref
. . res-ref-name
. . jndi-name
. . default-resource-principal
. . . name
. . . password
. resource-env-ref
. . resource-env-ref-name
. . jndi-name
. service-ref
. . service-ref-name
. . port-info
. . . service-endpoint-interface
. . . wsdl-port
. . . . namespaceURI
. . . . localpart
. . . stub-property
. . . call-property
. . . message-security-binding
. . . . message-security
. . . . . message
. . . . . . java-method
. . . . . . . method-name
. . . . . . . method-params
. . . . . . . . method-param
. . . . . . operation-name
. . . . . request-protection
. . . . . response-protection
. . call-property
. . wsdl-override
. . service-impl-class
. . service-qname
. . . namespaceURI
. . . localpart
. message-destination-ref
. . message-destination-ref-name
. . jndi-name
. class-loader
. . property
. . . description
. jsp-config
. . property
. . . description
. property
. . description
. valve
. . description
. . property
. . . description
. message-destination
. . message-destination-name
. . jndi-name
. webservice-description
. . webservice-description-name
. . wsdl-publish-location
. version-identifier

記述例

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE glassfish-web-app PUBLIC
"-//GlassFish.org//DTD GlassFish Application Server 3.1 Servlet 3.0//EN"
"http://glassfish.org/dtds/glassfish-web-app_3_0-1.dtd">
<glassfish-web-app>
     <session-config>
         <session-manager/>
     </session-config>
     <resource-ref>
         <res-ref-name>mail/Session</res-ref-name>
         <jndi-name>mail/Session</jndi-name>
     </resource-ref>
     <jsp-config/>
</glassfish-web-app>

3.13　glassfish-web.xmlに設定する要素の詳細

glassfish-web.xmlに設定する要素について説明しています。

3.13.1　/glassfish-web-app

Webモジュールに、Java EE Server固有の設定を定義します。

説明

Webモジュールに、Java EE Server固有の設定を定義します。これはルート要素です。したがって、glassfish-web.xmlファイルには、glassfish-web-app要素は1つだけ存在することになります。

出現パターン

1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

httpservlet-security-provider

この属性は、使用アプリケーションのメッセージセキュリティープロバイダーをバインドするのに使用されます。

属性の値を、メッセージセキュリティープロバイダーに割り当てられたプロバイダー名に設定して、アプリケーションに対応するDDファイルのhttpservlet-security-provider 属性を定義します。

例えば、メッセージセキュリティープロバイダーを作成するときにMySAMを使用すると、エントリーはhttpservlet-security-provider="MySAM"になります。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.2　/glassfish-web-app/context-root

アプリケーションまたはWARファイルとしてパッケージされたWebアプリケーションのWebコンテキストルートを含みます。

説明

WARファイルとしてパッケージされたアプリケーションまたはWebアプリケーションのWebコンテキストルートを指定します。application.xmlファイル内の対応する要素を上書きします。

ロードバランスをセットアップ中の場合、Webモジュールコンテキストルートはサーバインスタンス内で一意である必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

<拡張子.warを除いたWARファイル名>

出現パターン

0回、または1回

3.13.3　/glassfish-web-app/security-role-mapping

現在アクティブなレルムのユーザーまたはグループにロールをマップします。

説明

現在アクティブなレルムのユーザーまたはグループにロールをマップします。ロールマッピング要素は、環境固有のユーザーまたはグループにロールをマップします。

ユーザーにマップする場合、現在のレルムに存在し、現在の認証方式を使用してサーバにログインできる実在のユーザーである必要があります。

グループにマップする場合、レルムはグループをサポートし、グループは現在のレルムに存在する実在のグループである必要があります。有用性のため、そのレルムの1人以上のユーザーがそのグループに所属している必要があります。

出現パターン

0回以上

3.13.4　/glassfish-web-app/security-role-mapping/role-name

対応するJava EE RIのDDファイルのsecurity-role要素のrole-nameを指定します。

説明

対応するJava EE RIのDDファイルのsecurity-role要素のrole-nameを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.5　/glassfish-web-app/security-role-mapping/principal-name

現在のレルムのプリンシパル（ユーザー）名を指定します。

説明

現在のレルムのプリンシパル（ユーザー）名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

group-nameがない場合は1回以上、その他の場合は0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

class-name

このプリンシパルに対応する、プリンシパル実装クラスを指定します。

型：String

java.security.Principalインターフェースを実装するクラス（サブクラス）名

com.sun.enterprise.deployment.PrincipalImpl

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.6　/glassfish-web-app/security-role-mapping/group-name

現在のレルムにグループ名を指定します。

説明

現在のレルムにグループ名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

principal-nameがない場合は1回以上、その他の場合は0回以上

3.13.7　/glassfish-web-app/servlet

web.xmlに定義された run-as ロールに使用されるサーブレットのプリンシパル名を指定します。

説明

web.xmlに定義された run-as ロールに使用されるサーブレットのプリンシパル名を指定します。

出現パターン

0回以上

3.13.8　/glassfish-web-app/servlet/servlet-name

web.xmlのservlet-nameに適合するサーブレット名を指定します。

説明

web.xmlのservlet-nameに適合するサーブレット名を指定します。この名称はweb.xmlファイルに存在している必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.9　/glassfish-web-app/servlet/principal-name

現在のレルムのプリンシパル（ユーザー）名を指定します。

説明

現在のレルムのプリンシパル（ユーザー）名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

group-nameがない場合は1回以上、その他の場合は0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

class-name

このプリンシパルに対応する、プリンシパル実装クラスを指定します。

型：String

java.security.Principalインターフェースを実装するクラス（サブクラス）名

com.sun.enterprise.deployment.PrincipalImpl

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.10　/glassfish-web-app/servlet/webservice-endpoint

Webサービスエンドポイントの情報を指定します。

説明

Webサービスエンドポイントについての情報を指定します。

出現パターン

0回以上

3.13.11　/glassfish-web-app/servlet/webservice-endpoint/port-component-name

Webモジュール内にあるポートコンポーネントの一意の名称を指定します。

説明

Webモジュール内にあるポートコンポーネントの一意の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.12　/glassfish-web-app/servlet/webservice-endpoint/endpoint-address-uri

自動生成されたエンドポイントのアドレスを指定します。

説明

Webサーバのルートを組み合わせた相対パスを指定して、Webサービスのエンドポイントの完全修飾エンドポイントアドレスを生成します。

これは、サーブレットのエンドポイントの任意の要素です。

サーブレットのエンドポイントでは、この値は、Webアプリケーションのコンテキストルートの相対値になります。コンテキストルート部分は、同じWebサーバにデプロイされているWebアプリケーションのコンテキストルートと競合しないものとします。

この値は常に、固定パターンでなければなりません（*は指定できません）。

Webサービスのエンドポイントが、エンドポイントを1つだけ実装しているサーブレットで、URLパターンを1つしか持たない場合、Webコンテナーは値をweb.xmlファイルから取得するため、この値を設定する必要はありません。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.13　/glassfish-web-app/servlet/webservice-endpoint/login-config

EJB Webサービスエンドポイントの認証のための設定をします。

説明

EJB Webサービスエンドポイントの認証のための設定をします。サーブレットWebサービスエンドポイントには必要ありません。サーブレットのセキュリティー設定は、web.xmlファイルに含まれます。

出現パターン

0回、または1回

3.13.14　/glassfish-web-app/servlet/webservice-endpoint/login-config/auth-method

認証方式を指定します。

説明

Webサービスのエンドポイントの認証機構を指定します。承認制約によって保護されたWebリソースにアクセスするには、設定された認証方式を使用して認証される必要があります。

使用できる認証タイプは次のとおりです。

BASIC

サーバに組み込まれたログインダイアログボックスを使用します。通信プロトコルはHTTP（SSLはオプション）です。SSLを使用しないかぎりユーザークレデンシャルは暗号化されません。SSLのような何らかの外部のセキュアシステムと一緒に使用しないかぎり、ユーザーの認証方式として安全とはいえません。

FORM

アプリケーションが独自のログインページとエラーページを提供します。通信プロトコルはHTTP（SSLはオプション）です。SSLを使用しないと、ユーザークレデンシャルは暗号化されません。

CLIENT-CERT

サーバは、公開鍵証明書を使用して、クライアントを認証します。通信プロトコルはHTTPS（HTTP over SSL）です。ユーザークレデンシャルの暗号化はSSLです。

DIGEST

ユーザー名とパスワードに基づいて、サーバがユーザーを認証します。BASIC認証とは違い、パスワードは決してネットワークを介して送信されません。オプションで、SSLとHTTP Digestを一緒に使用できます。

指定できる値

型：String

{BASIC | DIGEST | FORM | CLIENT-CERT}

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.15　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding

カスタム認証プロバイダーのバインディングを指定します。

説明

次の方法のどちらか、または両方を使用して、親要素のwebservice-endpointに対して、カスタム認証プロバイダーのバインディングを指定します。

特定のプロバイダーにバインドする。

プロバイダーによって課せられるメッセージのセキュリティー要件を指定する。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。

型：String

SOAP

−

−

1回

provider-id

アプリケーション固有のメッセージのセキュリティー要件を満たすために使用される認証プロバイダーを指定します。この属性を指定しない場合、デフォルトのプロバイダーがメッセージレイヤーに定義されているとき、定義されたプロバイダーが使用されます。さらにデフォルトのプロバイダーも定義されていない場合、message-security-bindingで定義された認証要件は実行されません。

型：String

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.16　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security

メッセージセキュリティー要件を指定します。

説明

メッセージセキュリティー要件を指定します。親の親要素がwebservice-endpointであるため、これらのメッセージセキュリティー要件は、このエンドポイントの要求および応答電文に関連しています。

出現パターン

0回以上

3.13.17　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message

メッセージセキュリティー要件を適用するメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件を適用するメソッドまたは操作を指定します。

出現パターン

1回以上

3.13.18　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message/java-method

メッセージセキュリティー要件を適用するメソッドまたは操作を指定します。

説明

メッセージセキュリティー要件を適用するメソッドまたは操作を指定します。

出現パターン

0回、または1回

3.13.19　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message/java-method/method-name

メソッド名を指定します。

説明

メソッド名を指定、またはアスタリスク（*）によってすべてのメソッドを指定します。メソッドがオーバーロードされる場合、すべてのメソッドを同じ名称で指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.20　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message/java-method/method-params

メソッドのパラメーターの完全修飾Java型名を指定します。

説明

メソッドのパラメーターの完全修飾Java型名を指定します。

出現パターン

0回、または1回

3.13.21　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message/java-method/method-params/method-param

1つのメソッドのパラメーターの完全修飾Java型名を指定します。

説明

1つのメソッドのパラメーターの完全修飾Java型名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回以上

3.13.22　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/message/operation-name

Webサービスの操作のオペレーション名を指定します。

説明

Webサービスの操作のオペレーション名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.23　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/request-protection

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

説明

アプリケーションのリクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

必須の認証タイプを指定します。これは、sender（ユーザー名およびパスワード）認証タイプ、またはcontent（デジタル署名）認証タイプのどちらかになります。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.24　/glassfish-web-app/servlet/webservice-endpoint/message-security-binding/message-security/response-protection

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

説明

アプリケーションのレスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

必須の認証タイプを指定します。これは、sender（ユーザー名およびパスワード）認証タイプ、またはcontent（デジタル署名）認証タイプのどちらかになります。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.25　/glassfish-web-app/servlet/webservice-endpoint/transport-guarantee

クライアントとサーバ間の通信がNONE、INTEGRAL、またはCONFIDENTIALであることを指定します。

説明

クライアントとサーバ間の通信にNONE、INTEGRAL、またはCONFIDENTIALを指定します。

NONE

アプリケーションはトランスポート保障を必要としません。

INTEGRAL

アプリケーションは、通信データがクライアントとサーバ間で、伝送中に変更を加えられないような方法でデータ通信をすることを要求します。

CONFIDENTIAL

アプリケーションは、ほかのエンティティーが送信内容を見ることができない方法で、データ通信することを要求します。

INTEGRAL、CONFIDENTIALを指定した場合は、SSLの使用を要求されます。

指定できる値

型：String

{NONE | INTEGRAL | CONFIDENTIAL}

デフォルト値

定義項目の省略

NONE

出現パターン

0回、または1回

3.13.26　/glassfish-web-app/servlet/webservice-endpoint/service-qname

参照するWSDLサービス要素を指定します。

説明

参照するWSDLサービス要素を指定します。

出現パターン

0回、または1回

3.13.27　/glassfish-web-app/servlet/webservice-endpoint/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.28　/glassfish-web-app/servlet/webservice-endpoint/service-qname/localpart

QNAMEのローカルパートを指定します。

説明

QNAMEのローカル部分を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.29　/glassfish-web-app/servlet/webservice-endpoint/tie-class

ポートコンポーネント用のtie実装クラスの自動生成された名称を指定します。

説明

ポートコンポーネント用のtie実装クラスの自動生成された名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.30　/glassfish-web-app/servlet/webservice-endpoint/servlet-impl-class

生成されたサーブレット実装クラスの自動生成された名称を指定します。

説明

生成されたサーブレット実装クラスの自動生成された名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.31　/glassfish-web-app/servlet/webservice-endpoint/debugging-enabled

デバッグ用のサーブレットをWebサービスエンドポイントに対して有効にするかどうかを指定します。

説明

デバッグ用のサーブレットをWebサービスエンドポイントに対して有効にするかどうかを指定します。

指定できる値

型：String

{true | false}

デフォルト値

定義項目の省略

true

出現パターン

0回、または1回

3.13.32　/glassfish-web-app/idempotent-url-pattern

べき等なリクエストのURLパターンを指定します。

説明

べき等なリクエストのURLパターンを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

url-pattern

URLパターンは、サーブレットの仕様書情報で指定されているマッピングに従うものとします。

指定できるurl-patternの値は、サーブレットの仕様書情報のとおりです。

型：String

指定できるパターンは次のとおりです。

「/」で始まり、「/*」で終わる文字列は、パスのマッピングに使用されます。

「*.」で始まる文字列は、拡張子のマッピングとして使用されます。

「/」だけを含む文字列は、アプリケーションの「デフォルト」のサーブレットを示します。この場合、サーブレットのパスは、リクエストのURIからコンテキストパスを除いたものになります。パス情報はnullです。

その他の文字列はすべて、完全一致にだけ使用されます。

−

−

1回

no-of-retries

ロードバランサーのべき等なリクエストの試行回数を指定します。値「-1」は、試行回数が無制限であることを示します。

型：Integer

-1〜2147483647

-1

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.33　/glassfish-web-app/session-config

セッションの設定をします。

説明

セッションマネージャー、セッションCookie、およびその他のセッションの設定をします。個々のWebモジュールのWebコンテナー設定を上書きします。

出現パターン

0回、または1回

3.13.34　/glassfish-web-app/session-config/session-manager

セッションの設定をします。

説明

セッションの設定をします。

出現パターン

0回、または1回

3.13.35　/glassfish-web-app/session-config/session-manager/manager-properties

セッションマネージャーのプロパティーを指定します。

説明

セッションマネージャーのプロパティーを指定します。

出現パターン

0回、または1回

3.13.36　/glassfish-web-app/session-config/session-manager/manager-properties/property

名称と値を持つプロパティーを指定します。

説明

名前と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

reapIntervalSeconds

期限切れのセッションをチェックする周期を秒単位で指定します。また、maxSessionsの値を超えた場合には、この周期でセッションが非活性化されます。

型：Integer

1〜2147483647

60

−

0回、または1回

maxSessions

キャッシュ内に格納できるセッションの最大数を指定します。キャッシュ内に格納できるセッション数を制限しない場合は、-1に設定します。最大数を超えて上限値を超えて新しいセッションを作成しようとすると、IllegalStateException がスローされます。

型：Integer

-1〜2147483647

-1

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.37　/glassfish-web-app/session-config/session-manager/manager-properties/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.38　/glassfish-web-app/session-config/session-properties

セッションのプロパティーを指定します。

説明

セッションのプロパティーを指定します。

出現パターン

0回、または1回

3.13.39　/glassfish-web-app/session-config/session-properties/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

timeoutSeconds

Webモジュールで作成されたすべてのセッションについて、非アクティブな状態が継続する最長時間のデフォルト値を秒単位で指定します。0またはそれ以下の値に設定した場合、このWebモジュールのセッションは期限切れになることがありません。web.xmlファイルにsession-timeout要素が指定されている場合、session-timeout値はtimeoutSeconds値をオーバーライドします。session-timeoutもtimeoutSecondsも指定されていない場合、timeoutSecondsのデフォルト値が使用されます。

web.xmlのsession-timeout要素は分単位で指定しますが、glassfish-web.xmlのtimeoutSecondsは秒単位で指定します。

型：Integer

-2147483648〜2147483647

asadminユーティリティーコマンドのsetサブコマンドで使用する、configs.config.Java EEサーバの構成名.web-container.session-config.session-properties.timeout-in-secondsパラメーターで設定されている値

−

0回、または1回

enableCookies

trueに設定すると、セッションの追跡にCookieを使用します。

型：Boolean

{true | false}

true

−

0回、または1回

enableURLRewriting

ブラウザーがCookieを受け入れない場合に、URL の書き換えを通したセッションの追跡を提供します。サーブレットやJSPでencodeURLまたはencodeRedirectURLの呼び出しを使用する必要があります。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.40　/glassfish-web-app/session-config/session-properties/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.41　/glassfish-web-app/session-config/cookie-properties

セッションCookieのプロパティーを指定します。

説明

セッションCookieのプロパティーを指定します。web.xmlファイルにCookieの設定が宣言的に定義されている場合、ここで定義したCookieのプロパティーが優先されます。javax.servlet.SessionCookieConfigメソッドを使用して、Cookieの設定がプログラムで定義されている場合、そのCookieの設定がここで定義したCookieのプロパティーより優先されます。

出現パターン

0回、または1回

3.13.42　/glassfish-web-app/session-config/cookie-properties/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

cookieName

Cookieの名称を指定します。

セッションIDを示すHTTP Cookie名を変更する場合、Cookie名にcsfcfcは指定できません。

HTTP Cookie名に使用できる文字には次の条件があります。セッションの不正な動作の原因になることがあるため、条件に合った文字を使用してください。

ASCII文字を使用してください。ただし、次の文字は使用できません。

#、(、)、<、>、@、,、;、:、¥、/、"、[、]、?、=、{、}

空白、または制御文字は使用できません。

文字列の先頭に$は使用できません。

WebアプリケーションでHTTP Cookieを使用する場合、次の名称は指定できません。また、大文字と小文字は区別されません。

HTTPセッションのセッションIDで使用するHTTP Cookieの名称。デフォルトはJSESSIONID。

Java EEサーバ内部で使用するHTTP Cookieの名称csfcfc。

型：String

JSESSIONID

−

0回、または1回

cookiePath

リクエストのパス名に、パス名@name=cookiePathが含まれている場合、Cookieを送信します。/（スラッシュ）に設定すると、ブラウザーはJava EE Serverが提供するすべてのURLに対してCookieを送信します。パスをより狭い範囲のマッピングに設定し、ブラウザーがCookieを送信するリクエストURLを制限できます。

型：String

コンテキストパス

Webモジュールのインストール先

−

0回、または1回

cookieMaxAgeSeconds

Cookieの有効期限を秒単位で設定します。有効期限が設定されていない場合、Cookieの有効期限は切れません。

型：Integer

1〜2147483647

−

−

0回、または1回

cookieDomain

Cookieが有効となるドメインを指定します。

型：String

−

−

0回、または1回

cookieComment

cookieファイル内でセッション追跡Cookieを識別するコメントを指定します。

型：String

−

−

0回、または1回

cookieSecure

そのWebアプリケーションに関連するすべてのJSESSIONID CookieにSecure属性を付与するかどうかを設定します。

指定できる値は次のとおりです。

true

CookieにSecure属性を付与します。

false

CookieにSecure属性を付与しません。

dynamic

Java EEサーバが受けるリクエストがHTTPの場合は、CookieにSecure属性を付与しません。HTTPSの場合は、CookieにSecure属性を付与します。ただし、Java EEサーバが受け付けるリクエストはHTTPだけのため、常にfalseと同様の動作となります。

型：String

{true | false | dynamic}

dynamic

−

0回、または1回

cookieHttpOnly

CookieにHTTPだけがアクセスできるかどうかを指定します。

型：Boolean

{true | false}

−

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.43　/glassfish-web-app/session-config/cookie-properties/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.44　/glassfish-web-app/ejb-ref

対応するJava EE RIのDDファイルのejb-refに、JNDI完全修飾名を割り当てます。

説明

対応するJava EE RIのDDファイルのejb-refエントリー内のejb-ref-nameを、リソースのJNDI完全修飾名に割り当てます。ejb-ref要素は、EJBのホームへの参照を宣言するのに使用されます。

出現パターン

0回以上

3.13.45　/glassfish-web-app/ejb-ref/ejb-ref-name

対応するJava EE RIのDDファイルのejb-refエントリー内のejb-ref-nameを指定します。

説明

対応するJava EE RIのDDファイルのejb-refエントリー内のejb-ref-nameを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.46　/glassfish-web-app/ejb-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。Entity BeanおよびSession Beanに対して、この値はEJBHomeオブジェクトのグローバルJNDI名を指定します。Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.47　/glassfish-web-app/resource-ref

対応するJava EE XMLファイルのresource-refに、JNDI完全修飾名を割り当てます。

説明

対応するJava EE XMLファイルのresource-refに、JNDI完全修飾名を割り当てます。

出現パターン

0回以上

3.13.48　/glassfish-web-app/resource-ref/res-ref-name

リソースマネージャー接続ファクトリー参照の名称を指定します。

説明

リソースマネージャー接続ファクトリー参照の名称を指定します。

対応するJava EE RIのDDファイルのresource-refエントリー内のres-ref-nameを指定してください。

リソースマネージャー接続ファクトリー参照の名称は、Enterprise Bean内で一意の名称である必要があります。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.49　/glassfish-web-app/resource-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの両方に対して、この値はEJBHomeオブジェクトのグローバルJNDI名を指定します。Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.50　/glassfish-web-app/resource-ref/default-resource-principal

デフォルトのリソースプリンシパル（ユーザー）を指定します。

説明

デフォルトのリソースプリンシパル（ユーザー）を指定します。

出現パターン

0回、または1回

3.13.51　/glassfish-web-app/resource-ref/default-resource-principal/name

デフォルトのプリンシパル名を指定します。

説明

リソースマネージャーにサインオンするのに使用されるデフォルトのリソースプリンシパル名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.52　/glassfish-web-app/resource-ref/default-resource-principal/password

デフォルトのリソースプリンシパルのパスワードを指定します。

説明

デフォルトのリソースプリンシパルのパスワードを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.53　/glassfish-web-app/resource-env-ref

対応するJava EE XMLファイルのresource-env-refに、JNDI完全修飾名を割り当てます。

説明

対応するJava EE XMLファイルのresource-env-refに、JNDI完全修飾名を割り当てます。

出現パターン

0回以上

3.13.54　/glassfish-web-app/resource-env-ref/resource-env-ref-name

対応するJava EE RIのDDファイルのresource-env-refエントリー内のres-ref-nameを指定します。

説明

対応するJava EE RIのDDファイルのresource-env-refエントリー内のres-ref-nameを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.55　/glassfish-web-app/resource-env-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity Beanと Session Beanの両方に対して、この値はEJBHomeオブジェクトのグローバルJNDI名を指定します。Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.56　/glassfish-web-app/service-ref

Webサービス参照のランタイム設定を指定します。

説明

Webサービス参照のランタイム設定を指定します。ランタイム情報は、次の条件の場合にだけ必要です。

コンテナー管理対象ポートを解決するために使用するポートを定義する場合

スタブオブジェクトに対してデフォルトのStubプロパティー設定、またはデフォルトのCall プロパティー設定を定義する場合

標準DDのservice-refと関連づけられているWSDLドキュメントの代わりに使用される最終的なWSDLドキュメントのURLを定義する場合

出現パターン

0回以上

3.13.57　/glassfish-web-app/service-ref/service-ref-name

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.58　/glassfish-web-app/service-ref/port-info

Webサービス参照内のポートの情報を指定します。

説明

Webサービス参照内のポートの情報を指定します。

出現パターン

0回以上

3.13.59　/glassfish-web-app/service-ref/port-info/service-endpoint-interface

java:comp/envで始まるWebサービス参照名を指定します。

説明

java:comp/env で始まるWeb サービス参照名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.60　/glassfish-web-app/service-ref/port-info/wsdl-port

WSDLポートを指定します。

説明

WSDLポートを指定します。

出現パターン

0回、または1回

3.13.61　/glassfish-web-app/service-ref/port-info/wsdl-port/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.62　/glassfish-web-app/service-ref/port-info/wsdl-port/localpart

QNAMEのローカルパートを指定します。

説明

QNAMEのローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.63　/glassfish-web-app/service-ref/port-info/stub-property

Webサービスクライアントに返却される前にjavax.xml.rpc.Stubオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。

説明

Webサービスクライアントに返却される前にjavax.xml.rpc.Stubオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。プロパティー名は、JAX-RPC Stub実装がサポートする任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

関連するネームエンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.64　/glassfish-web-app/service-ref/port-info/call-property

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。

説明

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。プロパティー名は、JAX-RPC Call 実装でサポートされる任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.65　/glassfish-web-app/service-ref/port-info/message-security-binding

カスタム認証プロバイダーのバインディングを指定します。

説明

次の方法のどちらか、または両方を使用して、親要素のport-infoに対して、カスタム認証プロバイダーのバインディングを指定します。

特定のプロバイダーにバインドする。

プロバイダーによって課せられるメッセージのセキュリティー要件を指定する。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-layer

認証が行われるメッセージレイヤーを指定します。

型：String

SOAP

なし

−

1回

provider-id

アプリケーション固有のメッセージのセキュリティー要件を満たすために使用される認証プロバイダーを指定します。この属性を指定しない場合、デフォルトのプロバイダーがメッセージレイヤーに定義されているとき、定義されたプロバイダーが使用されます。さらにデフォルトのプロバイダーも定義されていない場合、message-security-bindingで定義された認証要件は実行されません。

型：String

なし

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.66　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security

メッセージのセキュリティー要件を指定します。

説明

メッセージのセキュリティー要件を指定します。

孫要素がport-infoなので、これらの要件は参照されるサービスのポートに関係します。

出現パターン

0回以上

3.13.67　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message

メッセージのセキュリティー要件を適用するメソッドまたは操作を指定します。

説明

メッセージのセキュリティー要件を適用するメソッドまたは操作を指定します。

出現パターン

1回以上

3.13.68　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message/java-method

メッセージのセキュリティー要件を適用するメソッドまたは操作を指定します。

説明

メッセージのセキュリティー要件を適用するメソッドまたは操作を指定します。

出現パターン

0回、または1回

3.13.69　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message/java-method/method-name

メソッド名を指定します。

説明

メソッド名を指定、またはアスタリスク（*）によってすべてのメソッドを指定します。メソッドがオーバーロードされる場合、すべてのメソッドを同じ名称で指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.70　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message/java-method/method-params

methodパラメーターの完全修飾Java型名を指定します。

説明

methodパラメーターの完全修飾Java型名を指定します。

出現パターン

0回、または1回

3.13.71　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message/java-method/method-params/method-param

methodパラメーターの完全修飾Java型名を指定します。

説明

methodパラメーターの完全修飾Java型名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回以上

3.13.72　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/message/operation-name

Webサービスの操作のオペレーション名を指定します。

説明

Webサービスの操作のオペレーション名を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.73　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/request-protection

認証リクエスト処理の認証ポリシー要件を定義します。

説明

認証リクエスト処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

必要な認証のタイプを、sender（ユーザー名とパスワード）またはcontent（デジタル署名）で指定します。

型：String

{content | sender}

−

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.74　/glassfish-web-app/service-ref/port-info/message-security-binding/message-security/response-protection

認証レスポンス処理の認証ポリシー要件を定義します。

説明

認証レスポンス処理の認証ポリシー要件を定義します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

auth-source

必要な認証のタイプを、sender（ユーザー名とパスワード）またはcontent（デジタル署名）で指定します。

型：String

{content | sender}

なし

−

1回

auth-recipient

受信者認証が、コンテンツ認証の前後どちらで起こるのかを指定します。

型：String

{before-content | after-content}

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.75　/glassfish-web-app/service-ref/call-property

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。

説明

Webサービスクライアントに返却される前にjavax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値を指定します。JAX-RPC Call 実装でサポートされる任意のプロパティーを選択できます。

出現パターン

0回以上

指定できる子要素

要素名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

エンティティーの名称を指定します。

型：String

なし

−

1回

value

エンティティーの値を指定します。

型：String

なし

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.76　/glassfish-web-app/service-ref/wsdl-override

最終的なWSDLドキュメントを示す有効なURLを指定します。

説明

指定しない場合、標準DDのservice-refと関連づけられているWSDLドキュメントが使用されます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.77　/glassfish-web-app/service-ref/service-impl-class

生成されたサービス実装クラスの名称を指定します。

説明

生成されたサービス実装クラスの名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.78　/glassfish-web-app/service-ref/service-qname

参照するWSDLサービス要素を指定します。

説明

参照するWSDLサービス要素を指定します。

出現パターン

0回、または1回

3.13.79　/glassfish-web-app/service-ref/service-qname/namespaceURI

名前空間URIを指定します。

説明

名前空間URIを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.80　/glassfish-web-app/service-ref/service-qname/localpart

QNAMEのローカルパートを指定します。

説明

QNAMEのローカルパートを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.81　/glassfish-web-app/message-destination-ref

メッセージの物理的な送信先の名称を指定します。

説明

メッセージの物理的な参照を、キュー、トピック、またはほかの物理的な送信先のJNDI名に、直接バインドします。

対応するJava EE RIのDDファイルのメッセージ送信先参照が、論理的なメッセージ送信先へのメッセージ送信先リンクを指定していない場合にだけmessage-destination-refを使用します。

出現パターン

0回以上

3.13.82　/glassfish-web-app/message-destination-ref/message-destination-ref-name

対応するJava EE RIのDDファイル内に定義されたメッセージの物理的な送信先の名称を指定します。

説明

対応するJava EE RIのDDファイル内に定義されたメッセージの物理的な送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.83　/glassfish-web-app/message-destination-ref/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanとSession Beanの両方に対して、この値はEJBHomeオブジェクトのグローバルJNDI名を指定します。Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.84　/glassfish-web-app/class-loader

クラスローダーの設定情報を指定します。

説明

Webモジュールのクラスローダーを設定します。

出現パターン

0回、または1回

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

extra-class-path

このWebモジュールに対して追加のクラスパスを、コロン区切りリストまたはセミコロン区切りリストで指定します。 絶対パスまたはWebモジュールのルートからの相対パスを指定できます。

型：String

なし

−

0回、または1回

delegate

trueの場合、Webモジュールは標準のクラスローダー委譲モデルに従い、ローカルのクラスローダーを調べる前に、その親クラスローダーに委譲します。EJBコンポーネントにアクセスするWebモジュールの場合、またはWebサービスクライアントやエンドポイントとして動作するWebモジュールの場合、この値をtrueに設定する必要があります。

falseの場合、Webモジュールはサーブレット仕様で指定されている委譲モデルに従い、親クラスローダーを調べる前に、そのクラスローダーを調べます。ほかのモジュールと相互作用しないWebモジュールの場合にだけ、この値をfalseに設定すると安全です。

java.*やjavax.*を含む多くのパッケージでは、委譲の設定に関係なく、クラスまたはリソースの検索、および解決は常に親クラスローダーに委譲されます。この設定は、アプリケーションによってJavaランタイムのコアクラスがオーバーライドされたり、Java EEプラットフォームの一部である仕様のAPIバージョンが変更されたりすることを防ぎます。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.85　/glassfish-web-app/class-loader/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

ignoreHiddenJarFiles

trueの場合、WEB-INF/libディレクトリー内のピリオド（.）で始まるのすべてのJARファイルおよびZIPファイルを、クラスローダーが無視することを指定します。

型：Boolean

{true | false}

false

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.86　/glassfish-web-app/class-loader/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.87　/glassfish-web-app/jsp-config

JSPの設定情報を指定します。

説明

JSPの設定情報を指定します。

出現パターン

0回、または1回

3.13.88　/glassfish-web-app/jsp-config/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

checkInterval

jsp-configのdevelopmentプロパティーがfalseに設定されていて、checkIntervalの時間が0より大きい場合、バックグラウンドでのコンパイルが有効になります。checkIntervalは、JSPファイルに変更があるかどうか確認するための検証の秒単位の間隔です。変更があった場合、JSPファイルを再コンパイルする必要があります。

型：Integer

0〜2147483647

0

−

0回、または1回

classdebuginfo

自動生成されるJavaサーブレットを、デバッグオプション（javacコマンドの-gオプション）を有効にしてコンパイルするかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

classpath

生成されたサーブレットをコンパイルするときに使用するクラスパスを指定します。

型：String

現在のWebアプリケーションに基づくクラスパス

−

0回、または1回

compilerSourceVM

生成されたサーブレットのソースの互換性を提供するJDKリリースを指定します。javacの-source releaseオプションと同じです。

型：String

1.5または5

1.6または6

1.7または7

1.8または8

1.5

−

0回、または1回

compilerTargetVM

サーブレットクラスファイルを生成する対象のJavaプラットフォーム（JVMソフトウェア）バージョンに対して仮想マシンを指定します。javacの-target releaseオプションと同じです。

型：String

1.5または5

1.6または6

1.7または7

1.8または8

1.5

−

0回、または1回

defaultBufferNone

trueの場合、pageディレクティブのbuffer属性のデフォルトはnoneです。

型：Boolean

{true | false}

false

−

0回、または1回

development

trueに設定した場合、JSPファイルに変更があるかどうかのチェックを可能にする、開発モードを有効にします。modification TestInterval プロパティーを使用して、JSPをチェックする頻度を指定します。

型：Boolean

{true | false}

true

−

0回、または1回

dumpSmap

trueに設定した場合、JSR 45デバッグのSMAP情報をファイルにダンプします。suppressSmapの値がtrueの場合、この値をfalseに設定します。

型：Boolean

{true | false}

false

−

0回、または1回

enablePooling

trueに設定した場合、タグハンドラーのプーリングが有効になります。

型：Boolean

{true | false}

true

−

0回、または1回

enableTldValidation

trueに設定した場合、基礎となるスキーマまたはDTDファイルに対して、Webアプリケーションが参照するすべてのTLDファイルを検証します。

型：Boolean

{true | false}

false

−

0回、または1回

errorOnUseBeanInvalidClassAttribute

trueに設定した場合、useBeanアクションのclass属性値がbeanクラスとして有効でない場合にエラーを発行します。

型：Boolean

{true | false}

false

−

0回、または1回

fork

Application Serverが動作しているのとは別のJavaVMを使用して、AntがJSPファイルをコンパイルするかどうかを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

genStrAsByteArray

trueに設定すると、ページがバッファリングされていない場合に、テキスト文字列をバイト列（ページエンコーディングによってエンコードしたバイト列）として生成します。

型：Boolean

{true | false}

true

−

0回、または1回

genStrAsCharArray

trueに設定した場合、テキスト文字列をchar配列として生成します。場合によってはパフォーマンスが向上します。

型：Boolean

{true | false}

false

−

0回、または1回

httpMethods

JspServletがサポートしているHTTPメソッドをコンマ区切りのリストで指定します。

型：String

アスタリスク（*）（すべてのメソッドを指定する場合）

−

0回、または1回

ieClassId

Internet ExplorerのJavaプラグインCOMクラスIDを指定します。<jsp:plugin>タグによって使用されます。

型：String

clsid:8AD9C840-044E-11D1-B3E9-00805F499D93

−

0回、または1回

ignoreJspFragmentErrors

trueに設定した場合、静的にインクルードされたJSPセグメントに関するJSPの事前コンパイルエラーを無視するように、コンパイラーに指示します。最上位のJSPファイルではないが、推奨された.jspfではなく、.jspまたは.jspx拡張子を使用しているJSPセグメントが対象です。

型：Boolean

{true | false}

false

−

0回、または1回

initialCapacity

JSPファイルを対応するサーブレットに変換するHashMapの初期容量を指定します。

型：Integer

0〜2147483647

32

−

0回、または1回

javaEncoding

生成されたJavaサーブレットのエンコーディングを指定します。

このエンコーディングは、サーブレットのコンパイルにも使用されるJavaコンパイラーに渡されます。WebコンテナーはUTF8の使用を試みます。失敗した場合、Javaのエンコーディング値の使用を試みます。

型：String

UTF8

−

0回、または1回

keepgenerated

trueに設定した場合、生成されたJavaファイルを保持します。falseに設定した場合、Javaファイルを削除します。

型：Boolean

{true | false}

true

−

0回、または1回

mappedfile

trueに設定した場合、デバッグを簡単にするために、入力行当たり1つのprint文で静的コンテンツを生成します。

型：Boolean

{true | false}

true

−

0回、または1回

modificationTestInterval

JSPに変更があるかどうかをチェックする頻度を秒単位で指定します。値「0」を指定すると、アクセスするたびにJSPがチェックされます。developmentがtrueに設定されている場合にだけ使用されます。

型：Integer

0〜2147483647

0

−

0回、または1回

reload-interval

JSPファイルに変更があるかどうかをチェックする頻度を秒単位で指定します。この値を0に設定すると、リクエストのたびにJSPファイルの更新の有無がチェックされます。この値を-1に設定すると、JSPの更新と再コンパイルのチェックが無効になります。

型：Integer

-1〜2147483647

0

−

0回、または1回

saveBytecode

trueに設定した場合、生成されたバイトコードは、.classファイルに保存されます。このオプションは、Java compiler APIのJSR 199（Java 6で利用でき、デフォルトとして使用されている）がjavacコンパイルに使用されている場合にだけ有効です。

型：Boolean

{true | false}

jspcの場合はtrue、

その他の場合はfalse

−

0回、または1回

scratchdir

生成されたすべてのコードを格納するために作成される作業ディレクトリーを指定します。

型：String

Application Serverのインストールディレクトリー/javaee/glassfish/nodes/ノード名/サーバインスタンス名/generated/jsp/[アプリケーション名] モジュール名

−

0回、または1回

suppressSmap

trueに設定した場合、JSR 45デバッグのSMAP情報の生成が抑制されます。

型：Boolean

{true | false}

false

−

0回、または1回

trimSpaces

trueに設定した場合、アクションやディレクティブの間のテンプレートテキストの空白を削除します。

型：Boolean

{true | false}

false

−

0回、または1回

usePrecompiled

trueに設定した場合、アクセスされたJSPファイルはコンパイルされません。代わりに、事前コンパイルされたサーブレットクラスが使用されます。JSPファイルが事前コンパイルされていて、対応するサーブレットクラスがWebアプリケーションのWEB-INF/libまたはWEB-INF/classesディレクトリーにバンドルされていると見なされます。

型：Boolean

{true | false}

false

−

0回、または1回

xpoweredBy

trueに設定した場合、生成されたサーブレットによって、X-Powered-Byレスポンスヘッダーが追加されます。

型：Boolean

{true | false}

true

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.89　/glassfish-web-app/jsp-config/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.90　/glassfish-web-app/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

「指定できるプロパティー」のプロパティー名を指定します。

型：String

−

−

1回

value

「指定できるプロパティー」のプロパティーの値（指定できる値）を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

指定できるプロパティー

「指定できる属性」に指定できるプロパティーを次に示します。

プロパティー名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

allowLinking

Webアプリケーション内のシンボリックリンクで表されるリソースをサーバ提供するかどうかを指定します。

trueに設定すると、このWebアプリケーション内のリソース（シンボリックリンク）が提供されます。このプロパティーを仮想サーバに定義することもできます。このプロパティーを定義していない仮想サーバ上のWebアプリケーションは、仮想サーバの値を使用します。

Windowsシステムでこのプロパティーをtrueに設定すると、JSPソースコードが開示されます。

型：Boolean

{true | false}

false

−

0回、または1回

alternatedocroot_n

代替ドキュメントルート（docroot）を指定します。ここでは、nは正の整数です。代替docrootによって、Webアプリケーションは特定のリソースに対するそれぞれのdocroot以外からのリクエストに対応できます。これは、それらのリクエストがWebアプリケーションの代替docrootのURIパターンの1つ（または複数）に一致するかどうかに基づきます。

リクエストが代替docrootのURIパターンと一致する場合、リクエストのURI（Webアプリケーションのコンテキストルートをマイナスしたもの）を代替docrootの物理的な位置（ディレクトリー）に付加することによって、リクエストは代替docrootにマップされます。リクエストが複数のURIパターンに一致する場合、代替docrootは次の優先順位で決定されます。

完全一致

最長パス一致

拡張一致

型：String

−

−

0回、または1回

crossContextAllowed

WebアプリケーションがServletContext.getContext()メソッドを使用してほかのWebアプリケーションのコンテキストにアクセスできるようにするには、trueを指定します。

型：Boolean

{true | false}

true

−

0回、または1回

relativeRedirectAllowed

このWebアプリケーションがHttpServletResponse.sendRedirect()を使用して相対URLをクライアントに送信できるようするには、trueを指定し、Webコンテナーが相対URLを完全なURLに変換しないように指示します。

型：Boolean

{true | false}

false

−

0回、または1回

reuseSessionID

このWebアプリケーション用に生成されたセッションがリクエストで指定されたセッションIDを使用する場合、trueを指定します。

型：Boolean

{true | false}

false

−

0回、または1回

securePagesWithPragma

SSLを使用したWebアプリケーションファイルのダウンロードがInternet Explorerで正しく機能するようにするには、falseを指定します。

特定の仮想サーバ上のすべてのWebアプリケーションに対して、このプロパティーを設定します。

型：Boolean

{true | false}

true

−

0回、または1回

singleThreadedServletPoolSize

Webアプリケーション内の各SingleThreadModel サーブレットに割り当てられるサーブレットインスタンスの最大数を指定します。

型：Integer

1〜2147483647

5

−

0回、または1回

tempdir

Webモジュールが使用する一時ディレクトリーを指定します。この値は、javax.servlet.context.tempdirコンテキスト属性の値を構築するために使用されます。コンパイルされたJSPファイルもこのディレクトリーに配置されます。

型：String

<domain-dir/generated/app-name> または <domain-dir/generated/module-name>

−

0回、または1回

useResponseCTForHeaders

レスポンスヘッダーがデフォルト（UTF-8）ではなくレスポンスのcharsetを使用してエンコードされる場合、trueを指定します。

型：Boolean

{true | false}

false

−

0回、または1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.91　/glassfish-web-app/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.92　/glassfish-web-app/valve

カスタムバルブを指定します。

説明

このWebアプリケーションにカスタムバルブを指定します。特定の仮想サーバ上のすべてのWebアプリケーションに対して、バルブを定義できます。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

バルブに一意の名称を指定します。

型：String

−

−

1回

class-name

バルブの完全修飾クラス名を指定します。バルブクラスは、org.glassfish.web.valve.GlassFishValveインターフェースを実装する必要があります。

ただし、org.apache.catalina.Valveインターフェースを実装している場合は指定できません。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.93　/glassfish-web-app/valve/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.94　/glassfish-web-app/valve/property

名称と値を持つプロパティーを指定します。

説明

名称と値を持つプロパティーを指定します。

出現パターン

0回以上

指定できる属性

属性名

説明

指定できる値

デフォルト値※

依存関係

出現パターン

name

プロパティーの名称を指定します。

型：String

−

−

1回

value

プロパティーの値を指定します。

型：String

−

−

1回

（凡例）

−：該当しません。

注※

定義項目の省略時のデフォルト値です。

3.13.95　/glassfish-web-app/valve/property/description

プロパティーを説明する任意のテキストを指定します。

説明

プロパティーを説明する任意のテキストを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.96　/glassfish-web-app/message-destination

メッセージの論理的な送信先の名称を指定します。

説明

アプリケーション内に定義された論理的なメッセージ送信先の名称を指定します。メッセージ送信先名は、対応するJava EE RIのDDファイル内の対応するメッセージ送信先名と一致します。

対応するJava EE RIのDDファイルのメッセージ送信先参照が、論理的なメッセージ送信先へのメッセージ送信先リンクを指定している場合に使用します。

出現パターン

0回以上

3.13.97　/glassfish-web-app/message-destination/message-destination-name

対応するJava EE RIのDDファイル内に定義されたメッセージの論理的な送信先の名称を指定します。

説明

対応するJava EE RIのDDファイル内に定義されたメッセージの論理的な送信先の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.98　/glassfish-web-app/message-destination/jndi-name

URLリソースまたはリソースのJNDI完全修飾名を指定します 。

説明

URLリソースまたはリソースのJNDI完全修飾名を指定します。

Entity BeanおよびSession Beanに対して、この値はEJB HomeオブジェクトのグローバルJNDI名を指定します。Entity BeanまたはSession Beanがリモートインターフェースを実装している場合にだけ必要です。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.99　/glassfish-web-app/webservice-description

Webサービスの名称と任意のパブリッシュする場所を指定します。

説明

Webサービスの名称と任意のパブリッシュする場所を指定します。

出現パターン

0回以上

3.13.100　/glassfish-web-app/webservice-description/webservice-description-name

Web内のWebサービスに名称を指定します。

説明

Web内でWebサービスに一意の名称を指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

1回

3.13.101　/glassfish-web-app/webservice-description/wsdl-publish-location

デプロイメント中にWebサービスのWSDLをパブリッシュするディレクトリーのURLを指定します。

説明

配備中にWebサービスのWSDLをパブリッシュするディレクトリーのURLを指定します。モジュール固有のWSDLディレクトリー（META-INF/wsdlまたはWEB-INF/wsdl）に対するファイルの相対位置を保持しながら、必要なファイルがこのディレクトリーにパブリッシュされます。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.13.102　/glassfish-web-app/version-identifier

Webアプリケーションのバージョン情報を指定します。

説明

アプリケーションまたはモジュールのバージョン情報を指定します。バージョン識別子は、モジュール名またはアプリケーション名の接尾辞です。コロン（:）で名前から区切ります。文字か数字で始まる必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。

次の例では、アプリケーションの有効なバージョン識別子を示します。

アプリケーション名:1

アプリケーション名:BETA-2e

アプリケーション名:3.8

アプリケーション名:patch39875

指定できる値

型：String

デフォルト値

定義項目の省略

なし

出現パターン

0回、または1回

3.14　hitachi-application.xml

Java EEアプリケーションの設定をするための拡張DDです。

説明

Java EEアプリケーションに関する、Java EE Server独自の設定をするためのDDです。

スキーマ

<!DOCTYPE hitachi-application PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Java EE Application//EN'
'hitachi-application_10_00_00.dtd'>

格納先

EAR のルート/META-INF/hitachi-application.xml

要素の階層

hitachi-application

記述例

<!DOCTYPE hitachi-application PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Java EE Application//EN'
'hitachi-application_10_00_00.dtd'>
<hitachi-application>
</hitachi-application>

注意事項

ここに記載した要素以外に、Java EE RIのDDの要素（glassfish-application.xmlの子要素）を記述できます。

3.15　hitachi-application.xmlに設定する要素の詳細

hitachi-application.xmlに設定する要素について説明しています。

3.15.1　/hitachi-application

ルート要素です。

説明

拡張DD（アプリケーション）のルート要素です。

出現パターン

1回

3.16　hitachi-application-client.xml

アプリケーションクライアントの設定をするための拡張DDです。

説明

アプリケーションクライアントに関する、Java EE Server独自の設定をするためのDDです。

スキーマ

<!DOCTYPE hitachi-application-client PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Java EE Application Client//EN'
'hitachi-application-client_10_00_00.dtd'>

格納先

アプリケーションクライアントJARのルート/META-INF/hitachi-application-client.xml

要素の階層

hitachi-application-client

記述例

<!DOCTYPE hitachi-application-client PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Java EE Application Client//EN'
'hitachi-application-client_10_00_00.dtd'>
<hitachi-application-client>
</hitachi-application-client>

注意事項

ここに記載した要素以外に、Java EE RIのDDの要素（glassfish-application-client.xmlの子要素）を記述できます。

3.17　hitachi-application-client.xmlに設定する要素の詳細

hitachi-application-client.xmlに設定する要素について説明しています。

3.17.1　/hitachi-application-client

ルート要素です。

説明

拡張DD（アプリケーションクライアント）のルート要素です。

出現パターン

1回

3.18　hitachi-ejb-jar.xml

EJB-JARの設定をするための拡張DDです。

説明

EJB-JARに関する、Java EE Server独自の設定をするためのDDです。

スキーマ

<!DOCTYPE hitachi-ejb-jar PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 EJB//EN'
'hitachi-ejb-jar_10_00_00.dtd'>

格納先

EJB-JAR のルート/META-INF/hitachi-ejb-jar.xml

WAR のルート/WEB-INF/hitachi-ejb-jar.xml

要素の階層

hitachi-ejb-jar

記述例

<!DOCTYPE hitachi-ejb-jar PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 EJB//EN'
'hitachi-ejb-jar_10_00_00.dtd'>
<hitachi-ejb-jar>
</hitachi-ejb-jar>

注意事項

ここに記載した要素以外に、Java EE RIのDDの要素（glassfish-ejb-jar.xmlの子要素）を記述できます。

3.19　hitachi-ejb-jar.xmlに設定する要素の詳細

hitachi-ejb-jar.xmlに設定する要素について説明しています。

3.19.1　/hitachi-ejb-jar

ルート要素です。

説明

拡張DD（EJB-JAR）のルート要素です。

出現パターン

1回

3.20　hitachi-ra.xml

リソースの設定をするための拡張DDです。

説明

リソースに関する、Java EE Server独自の設定をするためのDDです。

スキーマ

<!DOCTYPE hitachi-ra PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Connector//EN'
'hitachi-ra_10_00_00.dtd'>

格納先

RARのルート/META-INF/hitachi-ra.xml

要素の階層

hitachi-ra

記述例

<!DOCTYPE hitachi-ra PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Connector//EN'
'hitachi-ra_10_00_00.dtd'>
<hitachi-ra>
</hitachi-ra>

注意事項

ここに記載した要素以外に、Java EE RIのDDの要素（sun-ra.xmlの子要素）を記述できます。

3.21　hitachi-ra.xmlに設定する要素の詳細

hitachi-ra.xmlに設定する要素について説明しています。

3.21.1　/hitachi-ra

ルート要素です。

説明

拡張DD（リソースアダプター）のルート要素です。

出現パターン

1回

3.22　hitachi-web.xml

Webアプリケーション（WAR）の設定をするための拡張DDです。

説明

Webアプリケーション（WAR）に関する、Java EE Server独自の設定をするためのDDです。

スキーマ

<!DOCTYPE hitachi-web PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Servlet//EN'
'hitachi-web_10_00_00.dtd'>

格納先

WAR のルート/WEB-INF/hitachi-web.xml

要素の階層

hitachi-web

記述例

<!DOCTYPE hitachi-web PUBLIC
'-//Hitachi, Ltd.//DTD Hitachi Java EE Server 10.0.0 Servlet//EN'
'hitachi-web_10_00_00.dtd'>
<hitachi-web>
</hitachi-web>

注意事項

ここに記載した要素以外に、Java EE RIのDDの要素（glassfish-web.xmlの子要素）を記述できます。

3.23　hitachi-web.xmlに設定する要素の詳細

hitachi-web.xmlに設定する要素について説明しています。

3.23.1　/hitachi-web

ルート要素です。

説明

拡張DD（WAR）のルート要素です。

出現パターン

1回

3.24　標準DDで設定できる独自のパラメーターの詳細

標準DDで設定できる独自のパラメーターについて説明しています。

3.24.1　jersey.config.server.provider.classnames

JAX-RSのサーブレットに対するリソースとプロバイダーを定義します。

説明

JAX-RSのサーブレットに対するリソースやプロバイダーを指定します。このパラメーターは、init-param要素に設定します。

このパラメーターの設定方法を次に示します。

<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
    <param-name>jersey.config.server.provider.classnames</param-name>
    <param-value>指定値</param-value>
</init-param>

指定値には、1つ以上のクラスパスを指定します。クラスパスを複数指定する場合は、区切り文字を使用します。区切り文字には、半角スペース、「,」「;」「¥n」が使用できます。

JAX-RSのサーバ側で、電文のヘッダーをログに出力したい場合は、指定値にorg.glassfish.jersey.filter.LoggingFilterを指定します。

パラメーターの設定対象となるファイル

web.xml

パラメーターの設定対象となる要素

/web-app/servlet/init-param

指定できる値

org.glassfish.jersey.filter.LoggingFilter

4　Java EE Serverで使用するシステムプロパティー

Java EE Serverの動作環境を設定するためのプロパティーを説明しています。

4.1　Java EE Serverで使用するシステムプロパティーの一覧

Java EE Serverで使用するすべてのシステムプロパティーの概要を説明しています。

ドメイン管理サーバおよびJava EE Serverで使用するシステムプロパティー

システムプロパティー

概要

詳細説明

4.2.1　ASADMIN_LISTENER_PORT

ドメイン管理サーバがインスタンスを管理するためにインスタンスへ接続するHTTPポートまたは HTTPSポートのポート番号の指定

ドメイン管理サーバがインスタンスを管理するためにインスタンスへ接続する HTTP ポートまたは HTTPS ポートのポート番号を指定します。有効な値は1〜65535です。

4.2.2　com.hitachi.software.javaee.util.prf.PRFID

接続先のPRFデーモンのPRF識別子

アプリケーションクライアントの性能解析トレース出力で使用する、PRFデーモンのPRF識別子を指定します。

4.2.3　com.sun.appserv.transaction.nofdsync

トランザクションのステータスファイルの同期を無効に設定

JavaVMオプションにこのシステムプロパティーを設定して、トランザクションのステータスファイルの同期を無効にします。

4.2.4　com.sun.corba.ee.ORBVAAHost

パブリックアドレスのホストの設定

パブリックアドレスのホストを設定します。

4.2.5　com.sun.corba.ee.ORBVAAPort

パブリックアドレスのポートの指定

パブリックアドレスのポートを設定します。

4.2.6　com.sun.enterprise.in-progress-local-transaction.completion-mode

Java EE Serverがシャットダウン時に非XAトランザクションをコミットするかロールバックするかの指定

サーバインスタンスのシャットダウン時に、すべてのデータベースコネクションが切断されます。OracleJDBC では、ドライバーをベースにしたデータベースコネクションが非 XA トランザクションの最中に切断されると、すべての保留中の変更がコミットされます。ほかのデータベースでは、接続が切断された場合、通常、保留中の変更はコミットされないでロールバックされます。

4.2.7　com.sun.jts.dblogging.deletequery

データベースに保存されたトランザクションサービスログを削除する際に使用するSQLの定義

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログを削除する際に使用する SQL を定義します。

4.2.8　com.sun.jts.dblogging.insertquery

トランザクションサービスログを保存する際に使用するSQLの定義

トランザクションマネージャーが、トランザクションサービスログを保存する際に使用する SQL を定義します。

4.2.9　com.sun.jts.dblogging.selectquery

データベースに保存されたトランザクションサービスログを取得する際に使用するSQLの定義

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログを取得する際に使用する SQL を定義します。

4.2.10　com.sun.jts.dblogging.selectservernamequery

データベースに保存されたトランザクションサービスログのサーバ名を取得する際に使用するSQLの定義

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログのサーバ名を取得する際に使用する SQL を定義します。

4.2.11　com.sun.jts.dblogging.use.nontx.connection.for.add

トランザクションを利用しないコネクションを使用したデータベースへのトランザクションサービスログの登録

トランザクションを利用しないコネクションを使用して、データベースにトランザクションサービスログを登録します。

4.2.12　com.sun.xml.ws.spi.db.BindingContextFactory

JAX-WSの製品内部処理で利用するJAXBのバインディングプロバイダーの指定

JAX-WSの製品内部処理で利用するJAXBのバインディングプロバイダーを指定します。

4.2.13　com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump

クライアント側でのJAX-WSのリクエストおよびレスポンスを標準出力する機能の設定

このシステムプロパティーにtrueを設定することで、クライアント側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

4.2.14　com.sun.xml.ws.transport.http.HttpAdapter.dump

サーバ側でのJAX-WSのリクエストおよびレスポンスを標準出力する機能の設定

このシステムプロパティーにtrueを設定することで、サーバ側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

4.2.15　eclipselink.security.usedoprivileged

セキュリティーマネージャーを有効にする環境で、JPA利用するための設定

セキュリティーマネージャーを有効にする環境で、javax.persistence.PersistenceのcreateEntityManagerFactoryメソッドを利用するアプリケーションを使用する場合、このプロパティーをtrueに設定する必要があります。

4.2.16　EXTERNAL-ADDR

クラスターインスタンスの作成時のExternal IPアドレスの設定

クラスターインスタンスの作成時に External IP アドレスを設定します。

4.2.17　GMS-BIND-INTERFACE-ADDRESS-cluster-name

GMS-BIND-INTERFACE-ADDRESS-cluster-nameシステムプロパティーの指定

インスタンスがグループ管理サービスによって管理されていて、マルチホームホストを表すノードに存在する場合、GMS-BIND-INTERFACE-ADDRESS-cluster-name システムプロパティーを指定します。

4.2.18　GMS_LISTENER_PORT-cluster-name

クラスターがグループ管理サービスからのメッセージをリッスンするポート番号の定義

クラスターがグループ管理サービスからのメッセージをリッスンするポート番号を定義します。

4.2.19　HTTP_LISTENER_PORT

HTTP リクエストをリッスンするために使用するポート番号の指定

HTTP リクエストをリッスンするために使用するポート番号を指定します。

4.2.20　HTTP_SSL_LISTENER_PORT

HTTPSリクエストをリッスンするポートのポート番号の指定

HTTPSリクエストをリッスンするのに使用するポートのポート番号を指定します。

4.2.21　IIOP_LISTENER_PORT

IIOP 接続で使われるポートのポート番号の指定

IIOP 接続で使われるポートのポート番号を指定します。

4.2.22　IIOP_SSL_LISTENER_PORT

セキュアIIOP接続で使われるポートのポート番号の指定

セキュア IIOP 接続で使われるポートのポート番号を指定します。

4.2.23　IIOP_SSL_MUTUALAUTH_PORT

クライアント認証を伴うセキュアIIOP接続で使われるポート番号の指定

クライアント認証を伴うセキュア IIOP 接続で使われるポートのポート番号を指定します。

4.2.24　java.security.auth.login.config

ログインモジュールの使用順序と使用条件の指定

ログインモジュールが2つ以上使われる場合、使われる順序とその使用条件を指定します。これは、Java SEが提供するシステムプロパティーです。

4.2.25　java.security.policy

server.policyファイルのロケーションの指定

server.policy ファイルのロケーションを指定します。これは、Java SEが提供するシステムプロパティーです。

4.2.26　JAVA_DEBUGGER_PORT

Java Platform Debugger Architecture (JPDA) デバッガーとの接続に使用されるポート番号の指定

Java Platform Debugger Architecture (JPDA) デバッガーとの接続に使用されるポートのポート番号を指定します。

4.2.27　JMS_PROVIDER_PORT

JMSプロバイダーのポート番号の指定

JMSプロバイダーのポート番号を指定します。

4.2.28　JMX_SYSTEM_CONNECTOR_PORT

JMXコネクターがリッスンするポート番号の指定

JMX コネクターがリッスンするポート番号を指定します。

4.2.29　sun.rmi.dgc.client.gcInterval

定期的に発生するGCの最大間隔の指定

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.server.gcIntervalもあわせて指定する必要があります。

4.2.30　sun.rmi.dgc.server.gcInterval

定期的に発生するGCの最大間隔の指定

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.client.gcIntervalもあわせて指定する必要があります。

アプリケーションクライアントで使用するシステムプロパティー

システムプロパティー

概要

詳細説明

4.3.1　org.glassfish.appclient.acc.maxLoginRetries

許容されるログインのリトライ回数の決定

許容されるログインのリトライ回数を決定します。

4.2　ドメイン管理サーバおよびJava EEサーバで使用するシステムプロパティーの詳細

ドメイン管理サーバおよびJava EEサーバの動作環境を設定するためのプロパティーを説明しています。

4.2.1　ASADMIN_LISTENER_PORT

ドメイン管理サーバがインスタンスを管理するためにインスタンスへ接続する HTTP ポートまたは HTTPS ポートのポート番号を指定します。

説明

ドメイン管理サーバがインスタンスを管理するためにインスタンスへ接続する HTTP ポートまたは HTTPS ポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

24848

デフォルト値

定義項目の省略

4848

記述例

asadmin> set servers.server.pmdsainst.system-property
.ASADMIN_LISTENER_PORT.value=24859

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.2　com.hitachi.software.javaee.util.prf.PRFID

接続先のPRFデーモンのPRF識別子を指定します。

説明

アプリケーションクライアントの性能解析トレース出力で使用する、PRFデーモンのPRF識別子を指定します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

PRF_ID

値の省略

PRF_ID

記述例

appclient -Dcom.hitachi.software.javaee.util.prf.PRFID=MyPrfId Test

4.2.3　com.sun.appserv.transaction.nofdsync

トランザクションのステータスファイルの同期を無効にします。

説明

JavaVMオプションにこのシステムプロパティーを設定して、トランザクションのステータスファイルの同期を無効にします。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.appserv.transaction.nofdsync

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.4　com.sun.corba.ee.ORBVAAHost

パブリックアドレスのホストを設定します。

説明

パブリックアドレスのホストを設定します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.corba.ee.ORBVAAHost=192.155.35.4

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.5　com.sun.corba.ee.ORBVAAPort

パブリックアドレスのポートを設定します。

説明

パブリックアドレスのポートを設定します。

指定できる値

型：Integer

1〜65535

初期値

指定なし

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.corba.ee.ORBVAAPort=9090

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.6　com.sun.enterprise.in-progress-local-transaction.completion-mode

Java EE Serverが、シャットダウン時に、非 XA トランザクション（JTAトランザクションなど）をコミットするかロールバックするかを指定します。

説明

サーバインスタンスのシャットダウン時に、すべてのデータベースコネクションが切断されます。Oracle JDBCドライバーを使用したデータベースコネクションが非 XA トランザクションの最中に切断されると、すべての保留中の変更がコミットされます。ほかのデータベースでは、接続が切断された場合、通常、保留中の変更はコミットされないでロールバックされます。

Java EE Serverが、シャットダウン時に、非 XA トランザクションをコミットするかロールバックするかを明示的に指定するには、create-jvm-options サブコマンドを使用して、com.sun.enterprise.in-progress-local-transaction.completion-mode JVM オプションをコミットまたはロールバックに設定します。

指定できる値

型：String

{commit | rollback}

初期値

rollback

デフォルト値

定義項目の省略

commit も rollback もしません。

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.enterprise.in-progress-local-transaction.completion-mode=rollback

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.7　com.sun.jts.dblogging.deletequery

データベースに保存されたトランザクションサービスログを削除する際に使用するSQLを定義します。

説明

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログを削除する際に使用する SQL を定義します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

delete from txn_log_table where localtid = ? and servername = ?

記述例

asadmin> create-jvm-options --target instance1
'-Dcom.sun.jts.dblogging.deletequery=delete from txn_log_table where localtid =
? and servername = ?'

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.8　com.sun.jts.dblogging.insertquery

トランザクションサービスログを保存する際に使用するSQLを定義します。

説明

トランザクションマネージャーが、トランザクションサービスログを保存する際に使用する SQL を定義します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

insert into txn_log_table values ( ?, ?, ?, ?)

記述例

asadmin> create-jvm-options --target instance1
'-Dcom.sun.jts.dblogging.insertquery=insert into txn_log_table values
( ?, ?, ?, ?)'

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.9　com.sun.jts.dblogging.selectquery

データベースに保存されたトランザクションサービスログを取得する際に使用するSQLを定義します。

説明

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログを取得する際に使用する SQL を定義します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

select * from txn_log_table where servername = ?

記述例

asadmin> create-jvm-options --target instance1
'-Dcom.sun.jts.dblogging.selectquery=
select * from txn_log_table where servername = ?'

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.10　com.sun.jts.dblogging.selectservernamequery

データベースに保存されたトランザクションサービスログのサーバ名を取得する際に使用するSQLを定義します。

説明

トランザクションマネージャーが、データベースに保存されたトランザクションサービスログのサーバ名を取得する際に使用する SQL を定義します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

select distinct servername from txn_log_table where instancename = ?

記述例

asadmin> create-jvm-options --target instance1
'-Dcom.sun.jts.dblogging.selectservernamequery=
select distinct servername from txn_log_table where instancename = ?'

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.11　com.sun.jts.dblogging.use.nontx.connection.for.add

トランザクションを利用しないコネクションを使用して、データベースにトランザクションサービスログを登録します。

説明

トランザクションを利用しないコネクションを使用して、データベースにトランザクションサービスログを登録します。

true

データベースへのトランザクションサービスログの登録に、トランザクションを利用しないコネクションを利用します。次の条件をすべて満たす場合に、このプロパティーをtrueにする必要があります。

トランザクションサービスログをデータベースに保存したい場合

既存のtransactional resourceを使いたい場合

INSERTだけでは、non-transactional connectionを使いたい場合

false

データベースへのトランザクションサービスログの登録に、トランザクションを利用しないコネクションを利用しません。

指定できる値

型：Boolean

{true | false}

初期値

指定なし

デフォルト値

定義項目の省略

false

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.jts.dblogging.use.nontx.connection.for.add=true

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.12　com.sun.xml.ws.spi.db.BindingContextFactory

JAX-WSの製品内部処理で利用するJAXBのバインディングプロバイダーを指定します。

説明

JAX-WSの製品内部処理で利用するJAXBのバインディングプロバイダーを指定します。

com.sun.xml.ws.db.glassfish.JAXBRIContextFactory

JAXBリファレンス実装を指定します。これがデフォルトになります。

com.sun.xml.ws.db.toplink.JAXBContextFactory

Eclipselink MOXy JAXB bindingを指定します。

指定できる値

型：String

{com.sun.xml.ws.db.glassfish.JAXBRIContextFactory | com.sun.xml.ws.db.toplink.JAXBContextFactory}

初期値

指定なし

デフォルト値

定義項目の省略

com.sun.xml.ws.db.glassfish.JAXBRIContextFactory

記述例

asadmin> create-jvm-options --target instance1
-Dcom.sun.xml.ws.spi.db.BindingContextFactory=
com.sun.xml.ws.db.toplink.JAXBContextFactory

注意事項

Java EEサーバで使用するシステムプロパティーです。

このシステムプロパティーで指定したJAXBのデータバインディングプロバイダーは、JAX-WSに関する製品の処理だけで適用されます。

4.2.13　com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump

このシステムプロパティーにtrueを設定することで、クライアント側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

説明

このシステムプロパティーにtrueを設定することで、クライアント側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

指定できる値

型：Boolean

{true | false}

初期値

指定なし

デフォルト値

定義項目の省略

false

記述例

asadmin> create-system-properties --target instance1
com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump=true

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.14　com.sun.xml.ws.transport.http.HttpAdapter.dump

このシステムプロパティーにtrueを設定することで、サーバ側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

説明

このシステムプロパティーにtrueを設定することで、サーバ側で、JAX-WSのリクエストおよびレスポンスを標準出力する機能を有効にします。

指定できる値

型：Boolean

{true | false}

初期値

指定なし

デフォルト値

定義項目の省略

false

記述例

asadmin> create-system-properties --target instance1
com.sun.xml.ws.transport.http.HttpAdapter.dump=true

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.15　eclipselink.security.usedoprivileged

セキュリティーマネージャーを有効にする環境で、JPA利用するための設定をします。

説明

セキュリティーマネージャーを有効にする環境で、javax.persistence.PersistenceのcreateEntityManagerFactoryメソッドを利用するアプリケーションを使用する場合、このプロパティーをtrueに設定する必要があります。

指定できる値

型：Boolean

{true | false}

初期値

指定なし

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1
-Declipselink.security.usedoprivileged=true

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.16　EXTERNAL-ADDR

クラスターインスタンスの作成時にExternal IPアドレスとグループ管理サービスIPアドレスを設定します。

説明

クラスターインスタンスの作成時にExternal IPアドレスとグループ管理サービスIPアドレスを設定します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-system-properties --target instance1 EXTERNAL-ADDR=192.155.35.4

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.17　GMS-BIND-INTERFACE-ADDRESS-cluster-name

インスタンスがグループ管理サービスによって管理されていて、マルチホームホストを表すノードに存在する場合、GMS-BIND-INTERFACE-ADDRESS-cluster-name システムプロパティーを指定します。

説明

インスタンスがグループ管理サービスによって管理されていて、マルチホームホストを表すノードに存在する場合、GMS-BIND-INTERFACE-ADDRESS-cluster-name システムプロパティーを指定します。cluster-nameには、クラスター名を指定します。

指定できる値

型：String

初期値

指定なし

デフォルト値

定義項目の省略

${GMS-BIND-INTERFACE-ADDRESS-cluster-name}

記述例

asadmin> create-system-properties --target instance1
GMS-BIND-INTERFACE-ADDRESS-c1=10.12.152.20

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.18　GMS_LISTENER_PORT-cluster-name

クラスターがグループ管理サービスからのメッセージをリッスンするポート番号を定義します。

説明

クラスターがグループ管理サービスからのメッセージをリッスンするポート番号を定義します。デフォルト値は GMS_LISTENER_PORT-cluster-nameシステムプロパティーへの参照です。cluster-nameには、クラスター名を指定します。

デフォルトではこのシステムプロパティーは設定されていません。この場合、グループ管理サービスは、GMS_TCPSTARTPORTプロパティーと GMS_TCPENDPORT プロパティーで定義された範囲から未使用のポートを選択します。デフォルトではこの範囲は9090〜9200です。ほとんどの場合、デフォルトの動作で十分です。

指定できる値

型：Integer

9090〜9200

初期値

指定なし

デフォルト値

定義項目の省略

9090

記述例

asadmin> create-system-properties --target instance1
GMS_LISTENER_PORT-tcpcluster=9090

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.19　HTTP_LISTENER_PORT

HTTP リクエストをリッスンするために使用するポート番号を指定します。

説明

HTTP リクエストをリッスンするために使用するポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

指定なし

デフォルト値

定義項目の省略

28080

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties HTTP_LISTENER_PORT=58294
pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.20　HTTP_SSL_LISTENER_PORT

HTTPSリクエストをリッスンするのに使用するポートのポート番号を指定します。

説明

HTTPSリクエストをリッスンするのに使用するポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

28181

デフォルト値

定義項目の省略

1043

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties HTTP_SSL_LISTENER_PORT=58297  pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.21　IIOP_LISTENER_PORT

IIOP 接続で使われるポートのポート番号を指定します。

説明

IIOP 接続で使われるポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

23700

デフォルト値

定義項目の省略

3700

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties IIOP_LISTENER_PORT=58300  pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.22　IIOP_SSL_LISTENER_PORT

セキュア IIOP 接続で使われるポートのポート番号を指定します。

説明

セキュア IIOP 接続で使われるポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

23820

デフォルト値

定義項目の省略

1060

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties IIOP_SSL_LISTENER_PORT=58303  pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.23　IIOP_SSL_MUTUALAUTH_PORT

クライアント認証を伴うセキュア IIOP 接続で使われるポートのポート番号を指定します。

説明

クライアント認証を伴うセキュア IIOP 接続で使われるポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

23920

デフォルト値

定義項目の省略

1061

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties IIOP_SSL_MUTUALAUTH_PORT=58306  pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.24　java.security.auth.login.config

ログインモジュールが2つ以上使われる場合、順序とその使用条件を指定します。

説明

ログインモジュールが2つ以上使われる場合、使われる順序とその使用条件を指定します。これは、Java SEが提供するシステムプロパティーです。

指定できる値

型：String

初期値

${com.sun.aas.instanceRoot}/config/login.conf

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1
-Djava.security.auth.login.config=${com.sun.aas.instanceRoot}/config/login.conf

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.25　java.security.policy

server.policy ファイルのロケーションを指定します。

説明

server.policy ファイルのロケーションを指定します。これは、Java SEが提供するシステムプロパティーです。

このシステムプロパティーの値を変更する場合は、次の点に注意してください。

ドメインにあるすべてのサーバインスタンスにserver.policyを適用する場合

このシステムプロパティーの値を変更する必要はありません。

サーバインスタンス単体でserver.policyを適用する場合

次に示すserver.policyファイルを作業用フォルダにコピーした上で、そのファイルパスを指定してください。

Application Serverのインストールディレクトリー/javaee/glassfish/domains/ドメイン名/config/server.policy

なお、server.policyファイルにセキュリティポリシーを追加する場合は、server.policyファイルに設定を追記する形で編集し、既存の設定項目は削除しないでください。

指定できる値

型：String

初期値

${com.sun.aas.instanceRoot}/config/server.policy

デフォルト値

定義項目の省略

なし

記述例

asadmin> create-jvm-options --target instance1 -Djava.security.policy=
${com.sun.aas.instanceRoot}/config/pmd-config/server.policy

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.26　JAVA_DEBUGGER_PORT

Java Platform Debugger Architecture (JPDA) デバッガーとの接続に使用されるポートのポート番号を指定します。

説明

Java Platform Debugger Architecture (JPDA) デバッガーとの接続に使用されるポートのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

29009

デフォルト値

定義項目の省略

29009

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties JAVA_DEBUGGER_PORT=58294 pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.27　JMS_PROVIDER_PORT

JMSプロバイダーのポート番号を指定します。

説明

JMSプロバイダーのポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

27676

デフォルト値

定義項目の省略

27676

記述例

asadmin> set configs.config.clusterpresets
-config.system-property.JMS_PROVIDER_PORT.value=27678

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.28　JMX_SYSTEM_CONNECTOR_PORT

JMX コネクターがリッスンするポート番号を指定します。

説明

JMX コネクターがリッスンするポート番号を指定します。有効な値は1〜65535です。

指定できる値

型：Integer

1〜65535

初期値

28686

デフォルト値

定義項目の省略

8686

記述例

asadmin> create-instance --node localhost-domain1
--systemproperties JMX_SYSTEM_CONNECTOR_PORT=58309  pmdcpinst

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.29　sun.rmi.dgc.client.gcInterval

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.server.gcIntervalもあわせて指定する必要があります。sun.rmi.dgc.server.gcIntervalを同時に指定しない場合、FullGCが意図しないタイミングで発生するおそれがあります。

説明

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.server.gcIntervalもあわせて指定する必要があります。sun.rmi.dgc.server.gcIntervalを同時に指定しない場合、FullGCが意図しないタイミングで発生するおそれがあります。

サーバインスタンスでのsun.rmi.dgc.server.gcIntervalと、sun.rmi.dgc.client.gcIntervalの初期値は、1日（86400000ミリ秒）です。これらのシステムプロパティーでFullGCの発生間隔を広げてもGC発生回数が削減されない場合、Javaヒープが不足していることがあります。この場合は、Javaヒープのチューニングを実施することで改善することがあります。

指定できる値

型：Integer

1〜9223372036854775806

初期値

86400000

デフォルト値

定義項目の省略

3600000

記述例

asadmin> create-system-properties --target instance1
sun.rmi.dgc.client.gcInterval=43200000

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.2.30　sun.rmi.dgc.server.gcInterval

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.client.gcIntervalもあわせて指定する必要があります。sun.rmi.dgc.client.gcIntervalを同時に指定しない場合、FullGCが意図しないタイミングで発生するおそれがあります。

説明

リモートオブジェクトの参照に対して定期的にGCが発生することがあります。このシステムプロパティーでは、定期的に発生するGCの最大間隔を指定します。単位はミリ秒です。sun.rmi.dgc.client.gcIntervalもあわせて指定する必要があります。sun.rmi.dgc.client.gcIntervalを同時に指定しない場合、FullGCが意図しないタイミングで発生するおそれがあります。

サーバインスタンスでのsun.rmi.dgc.server.gcIntervalと、sun.rmi.dgc.client.gcIntervalの初期値は、1日（86400000ミリ秒）です。これらのシステムプロパティーでFullGCの発生間隔を広げてもGC発生回数が削減されない場合、Javaヒープが不足していることがあります。この場合は、Javaヒープのチューニングを実施することで改善することがあります。

指定できる値

型：Integer

1〜9223372036854775806

初期値

86400000

デフォルト値

定義項目の省略

3600000

記述例

asadmin> create-system-properties --target instance1
sun.rmi.dgc.server.gcInterval=43200000

注意事項

Java EEサーバで使用するシステムプロパティーです。

4.3　アプリケーションクライアントで使用するシステムプロパティーの詳細

クライアントプロセスの動作環境を設定するためのプロパティーを説明しています。

4.3.1　org.glassfish.appclient.acc.maxLoginRetries

アプリケーションクライアントコンテナーがインジェクションを行う際に許容されるログインのリトライ数を決定します。

説明

許容されるログインのリトライ回数を決定します。

クライアントのメインクラスに注釈（例えば @Resource ）がある場合、アプリケーションクライアントコンテナーがインジェクションを行う際、リトライループが発生します。

指定できる値

型：Integer

0〜2147483647

初期値

指定なし

デフォルト値

定義項目の省略

3

記述例

asadmin> create-jvm-options -Dorg.glassfish.appclient.acc.maxLoginRetries=5

注意事項

アプリケーションクライアントで使用するシステムプロパティーです。

5　Java EE Serverで使用する定義ファイルおよびプロパティーファイル

Java EE Serverの接続情報や構成定義を設定するためのファイルを説明しています。

5.1　Java EE Serverで使用する定義ファイルおよびプロパティーファイルの一覧

Java EE Serverで使用するすべての定義ファイルおよびプロパティーファイルの概要を説明しています。

Java EE Serverで使用するすべての定義ファイルおよびプロパティーファイル

ファイル

概要

詳細説明

5.2　asenv.bat

Java EE Serverの環境変数定義ファイル

Java EE Server固有の環境変数を保存するファイルです。

5.4　config.properties

ブローカーの構成に関するプロパティーの設定

config.propertiesファイルは、ブローカーの構成に関するプロパティー設定ファイルです。

5.6　das.properties

ノードがドメイン管理サーバに接続するための接続情報を含むファイル

ノードがドメイン管理サーバに接続するための接続情報を含むファイルです。

asenv.batに設定する環境変数

環境変数

概要

詳細説明

5.3.1　AS_ADMIN_READTIMEOUT

asadminプロセスおよびドメイン管理サーバに設定するHTTPリードタイムアウト値の指定

asadminプロセスとドメイン管理サーバ間の通信、およびドメイン管理サーバとサーバインスタンス間の通信に適用する、HTTPリードタイムアウト値（単位：ミリ秒）を指定します。

5.3.2　HJES_ASADMIN_CONSOLE_ENABLED

asadminユーティリティーコマンドのプロセス起動時ログの有効または無効の指定

asadminユーティリティーコマンドのプロセス起動時ログを出力するかどうかを指定します。

5.3.3　HJES_ASADMIN_CONSOLE_FILE_NUMBER

asadminユーティリティーコマンドのプロセス起動時ログファイルの面数

asadminユーティリティーコマンドのプロセス起動時ログのJava EE Server稼働中に保持するログファイルの個数を指定します。

5.3.4　HJES_ASADMIN_CONSOLE_ROTATION_SIZE

asadminユーティリティーコマンドのプロセス起動時ログファイルのサイズ

asadminユーティリティーコマンドのプロセス起動時ログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

5.3.5　HJES_ASADMIN_CONSOLE_ROTATION_TIME

asadminユーティリティーコマンドのプロセス起動時ログファイルの切り替え時刻の指定

asadminユーティリティーコマンドのプロセス起動時ログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

5.3.6　HJES_ASADMIN_JVM_OPTIONS

asadminユーティリティーコマンドのプロセスに適用するJavaVMオプションの指定

asadminユーティリティーコマンドのプロセスに適用するJavaVMオプションを指定します。複数のJavaVMオプションを指定する場合は、半角空白で区切って、オプション全体を""で囲んでください。

5.3.7　HJES_ASADMIN_LOG_DIVISION

asadminユーティリティーコマンドのログ出力先ディレクトリーの分割の有効または無効の指定

asadminユーティリティーコマンドのログを、OSのユーザーアカウントごとにディレクトリーを分けて出力するかどうかを指定します。

5.3.8　HJES_ASADMIN_MAINTENANCE_ENABLED

asadminユーティリティーコマンドの保守ログの有効または無効の指定

asadminユーティリティーコマンドの保守ログを出力するかどうかを指定します。

5.3.9　HJES_ASADMIN_MAINTENANCE_FILE_NUMBER

asadminユーティリティーコマンドの保守ログファイルの面数

asadminユーティリティーコマンドの保守ログのJava EE Server稼働中に保持するログファイルの個数を指定します。

5.3.10　HJES_ASADMIN_MAINTENANCE_LOG_LEVEL

asadminユーティリティーコマンドの保守ログのレベル

asadminユーティリティーコマンドの保守ログのログに出力される内容のレベルを指定します。

5.3.11　HJES_ASADMIN_MAINTENANCE_ROTATION_SIZE

asadminユーティリティーコマンドの保守ログファイルのサイズ

asadminユーティリティーコマンドの保守ログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

5.3.12　HJES_ASADMIN_MAINTENANCE_ROTATION_TIME

asadminユーティリティーコマンドの保守ログファイルの切り替え時刻

asadminユーティリティーコマンドの保守ログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

5.3.13　HJES_ASADMIN_MESSAGE_ENABLED

asadminユーティリティーコマンドのメッセージログの有効または無効の指定

asadminユーティリティーコマンドのメッセージログを出力するかどうかを指定します。

5.3.14　HJES_ASADMIN_MESSAGE_FILE_NUMBER

asadminユーティリティーコマンドのメッセージログファイルの面数

asadminユーティリティーコマンドのメッセージログのJava EE Server稼働中に保持するログファイルの個数を指定します。

5.3.15　HJES_ASADMIN_MESSAGE_LOG_LEVEL

asadminユーティリティーコマンドのメッセージログのレベル

asadminユーティリティーコマンドのメッセージログのログに出力される内容のレベルを指定します。

5.3.16　HJES_ASADMIN_MESSAGE_ROTATION_SIZE

asadminユーティリティーコマンドのメッセージログファイルのサイズ

asadminユーティリティーコマンドのメッセージログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

5.3.17　HJES_ASADMIN_MESSAGE_ROTATION_TIME

asadminユーティリティーコマンドのメッセージログファイルの切り替え時刻

asadminユーティリティーコマンドのメッセージログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

5.3.18　HJES_ASADMIN_STACKTRACE_ENABLED

asadminユーティリティーコマンドのスタックトレースログの有効または無効の指定

asadminユーティリティーコマンドのスタックトレースログを出力するかどうかを指定します。

5.3.19　HJES_ASADMIN_STACKTRACE_FILE_NUMBER

asadminユーティリティーコマンドのスタックトレースログファイルの面数

asadminユーティリティーコマンドのスタックトレースログのJava EE Server稼働中に保持するログファイルの個数を指定します。

5.3.20　HJES_ASADMIN_STACKTRACE_ROTATION_SIZE

asadminユーティリティーコマンドのスタックトレースログファイルのサイズ

asadminユーティリティーコマンドのスタックトレースログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

5.3.21　HJES_ASADMIN_STACKTRACE_ROTATION_TIME

asadminユーティリティーコマンドのスタックトレースログファイルの切り替え時刻

asadminユーティリティーコマンドのスタックトレースログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

5.3.22　HJES_LOGSDIR

Java EE Serverのログファイルの出力先ディレクトリー

Java EE Serverのログファイルの出力先ディレクトリーを変更する場合に指定します。

config.propertiesに設定するプロパティー

プロパティー

概要

詳細説明

5.5.1　imq.authentication.client.response.timeout

認証リクエストに対するクライアントからの応答を待機する時間の秒単位の指定

認証リクエストに対するクライアントからの応答を待機する時間を秒単位で指定します。この値は imq.authentication.client.response.timeout プロパティーで定義されています。

5.5.2　imq.autocreate.destination.limitBehavior

メモリー制限のしきい値に達した場合のブローカー動作の指定

メモリー制限のしきい値に達した場合のブローカー動作を指定します。

5.5.3　imq.autocreate.destination.maxBytesPerMsg

単一メッセージの最大サイズのバイト単位の指定

単一メッセージの最大サイズをバイト単位で指定します。

5.5.4　imq.autocreate.destination.maxNumMsgs

未配信メッセージの最大数の指定

未配信メッセージの最大数を指定します。

5.5.5　imq.autocreate.destination.maxTotalMsgBytes

未配信メッセージの最大の総メモリー量のバイト単位の指定

未配信メッセージの最大の総メモリー量をバイト単位で指定します。

5.5.6　imq.autocreate.destination.useDMQ

デッドメッセージキューへのデッドメッセージの送信の有効または無効の指定

デッドメッセージキューへのデッドメッセージの送信を有効または無効にします。

5.5.7　imq.autocreate.queue

キュー送信先の自動作成の有効または無効の指定

キュー送信先の自動作成を有効または無効にします。

5.5.8　imq.autocreate.queue.maxNumActiveConsumers

アクティブなメッセージコンシューマーの最大数の指定

キュー送信先からのロードバランス配信での、アクティブなメッセージコンシューマーの最大数を指定します。

5.5.9　imq.autocreate.queue.maxNumBackupConsumers

バックアップメッセージコンシューマーの最大数の指定

キュー送信先からのロードバランス配信での、バックアップメッセージコンシューマーの最大数を指定します。

5.5.10　imq.autocreate.topic

トピック送信先の自動作成の有効または無効の指定

トピック送信先の自動作成を有効または無効にします。

5.5.11　imq.autocreate.topic.consumerFlowLimit

トピックコンシューマーに送信できる最大のメッセージ数の指定

単一のバッチで、トピックコンシューマーに送信できる最大のメッセージ数を指定します。

5.5.12　imq.destination.DMQ.truncateBody

メッセージをデッドメッセージキューに保存する前のメッセージボディーの消去の有効または無効の指定

メッセージをデッドメッセージキューに保存する前のメッセージボディーの消去を、有効または無効にします。

5.5.13　imq.hostname

デフォルトのホスト名またはIPアドレスの指定

すべての接続サービスの、デフォルトのホスト名またはIPアドレスを指定します。

5.5.14　imq.persist.file.destination.message.filepool.limit

送信先ファイルプールが保持するファイルの最大数の指定

送信先ファイルプールが保持するファイルの最大数を指定します。

5.5.15　imq.persist.file.message.cleanup

ファイルプール内のファイルの消去の有効または無効の指定

シャットダウン時の、ファイルプール内のファイルの消去を有効または無効にします。

5.5.16　imq.persist.file.message.filepool.cleanratio

ファイルプールにクリーン（空） の状態で保持するファイルの割合の指定

ファイルプールにクリーン （空） の状態で保持するファイルの割合を指定します。

5.5.17　imq.persist.file.message.max_record_size

メッセージ退避ファイルに追加するメッセージの最大サイズの指定

メッセージ退避ファイルに追加するメッセージの最大サイズを指定します。

5.5.18　imq.persist.file.sync.enabled

メモリー内の状態を物理的なストレージデバイスとの同期の有効または無効の指定

メモリーの状態を物理的なストレージデバイスと同期させることを有効または無効にします。

5.5.19　imq.service.activelist

ブローカーの起動時に活性化する接続サービスのリストの指定

ブローカーの起動時に活性化する接続サービスのリストをコンマで区切って指定します。

5.5.20　imq.system.max_count

ブローカーが保持するメッセージの最大数の指定

ブローカーが保持するメッセージの最大数を指定します。

5.5.21　imq.system.max_size

ブローカーが保持するメッセージの最大合計サイズの指定

ブローカーが保持するメッセージの最大合計サイズを指定します。

5.5.22　imq.txn.reapInterval

リーパースレッドのリープまたはクリーンアップする周期の秒単位の指定

リーパースレッドが、コミットされたトランザクションをリープまたはクリーンアップするための周期を秒単位で指定します。

5.5.23　imq.txt.reapLimit

最後にコミットされたトランザクションの最大数の指定

コミットされたトランザクションのリープまたはクリーンアップ時に維持される、最後にコミットされたトランザクションの最大数を指定します。

5.5.24　java.util.logging.FileHandler.count

出力ファイル数の指定

出力ファイルの数を指定します。

5.5.25　java.util.logging.FileHandler.level

ハンドラーのデフォルトレベルの指定

ハンドラーのデフォルトレベルを指定します。

5.5.26　java.util.logging.FileHandler.limit

1つのログファイルに書き込める上限の指定

1つのログファイルに書き込める上限を指定します 。

das.propertiesに設定するプロパティー

プロパティー

概要

詳細説明

5.7.1　agent.das.host

ドメイン管理サーバのホスト名またはIPアドレスの指定

プロパティー設定対象のサーバインスタンスを管理する、ドメイン管理サーバのホスト名、またはIPアドレス指定します。

5.2　asenv.bat

Java EE Serverの環境変数定義ファイルです。

説明

Java EE Server固有の環境変数を保存するファイルです。

このファイルで設定した環境変数は、OSの環境変数（システム環境変数およびユーザー環境変数）よりも優先的に設定されます。

なお、リモートホスト上にノードがある場合、ドメイン管理サーバがノードを操作するためにリモートホスト上でasadminユーティリティーコマンドを実行することがあります。このリモートホスト上のasadminプロセスに環境変数を適用する場合は、リモートホスト上にあるasenv.batに環境変数を設定する必要があります。

書式

Windowsバッチファイル

格納先

Java EE Serverのインストールディレクトリー¥glassfish¥config¥asenv.bat

記述例

set HJES_ASADMIN_MESSAGE_ENABLED=true
set HJES_ASADMIN_MESSAGE_ROTATION_SIZE=8388608
set HJES_ASADMIN_MESSAGE_ROTATION_TIME=121530
set HJES_ASADMIN_MESSAGE_FILE_NUMBER=16

5.3　asenv.batに設定する環境変数の詳細

asenv.batに設定する環境変数について説明しています。

5.3.1　AS_ADMIN_READTIMEOUT

asadminプロセスおよびドメイン管理サーバに設定するHTTPリードタイムアウト値を指定します。

説明

asadminプロセスとドメイン管理サーバ間の通信、およびドメイン管理サーバとサーバインスタンス間の通信に適用する、HTTPリードタイムアウト値（単位：ミリ秒）を指定します。

HTTPリードタイムアウト値に0を指定した場合、コマンド処理時間が長期化すると、そのコマンド処理がasadminユーティリティーコマンドのサブコマンド、およびユーザーリクエストを処理するスレッドを専有してしまうおそれがあります。このため、HTTPリードタイムアウト値に0（タイムアウトの無効）を指定することは推奨しません。

指定できる値

型：Integer

0〜2147483647の整数値

0 を指定すると、HTTPリードタイムアウトは設定されません（0は非推奨の値です）。

デフォルト値

定義項目の省略

900000

値の省略

900000

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

AS_ADMIN_READTIMEOUT=900000

5.3.2　HJES_ASADMIN_CONSOLE_ENABLED

asadminユーティリティーコマンドのプロセス起動時ログの有効または無効を指定します。

説明

asadminユーティリティーコマンドのプロセス起動時ログを出力するかどうかを指定します。

指定できる値

型：boolean(ignore)

{true | false}

デフォルト値

定義項目の省略

true

値の省略

true

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_CONSOLE_ENABLED=true

5.3.3　HJES_ASADMIN_CONSOLE_FILE_NUMBER

asadminユーティリティーコマンドのプロセス起動時ログファイルの面数を指定します。

説明

asadminユーティリティーコマンドのプロセス起動時ログのJava EE Server稼働中に保持するログファイルの個数を指定します。

指定できる値

型：Integer

1〜64の整数値

デフォルト値

定義項目の省略

8

値の省略

8

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_CONSOLE_FILE_NUMBER=16

5.3.4　HJES_ASADMIN_CONSOLE_ROTATION_SIZE

asadminユーティリティーコマンドのプロセス起動時ログファイルのサイズ（単位：バイト）を指定します。

説明

asadminユーティリティーコマンドのプロセス起動時ログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

指定できる値

型：Integer

4096〜16777216の整数値

デフォルト値

定義項目の省略

16777216

値の省略

16777216

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_CONSOLE_ROTATION_SIZE=8388608

5.3.5　HJES_ASADMIN_CONSOLE_ROTATION_TIME

asadminユーティリティーコマンドのプロセス起動時ログファイルの切り替え時刻を指定します。

説明

asadminユーティリティーコマンドのプロセス起動時ログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

指定できる値

型：String

"HHMMSS"形式で000000〜235959の範囲

デフォルト値

定義項目の省略

000000

値の省略

000000

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_CONSOLE_ROTATION_TIME=121530

5.3.6　HJES_ASADMIN_JVM_OPTIONS

asadminユーティリティーコマンドのプロセスに適用するJavaVMオプションを指定します。

説明

asadminユーティリティーコマンドのプロセスに適用するJavaVMオプションを指定します。 複数のJavaVMオプションを指定する場合は、半角空白で区切って、オプション全体を""で囲んでください。

指定できる値

型：String

デフォルト値

定義項目の省略

なし

値の省略

なし

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

JavaVMオプションを単独で指定する場合

HJES_ASADMIN_JVM_OPTIONS=-Xmx512m

JavaVMオプションを複数指定する場合

HJES_ASADMIN_JVM_OPTIONS="-Xmx512m -XX:+HitachiThreadDumpToStdout"

5.3.7　HJES_ASADMIN_LOG_DIVISION

asadminユーティリティーコマンドのログ出力先ディレクトリーを分割するかどうかを指定します。

説明

asadminユーティリティーコマンドのログを、OSのユーザーアカウントごとにディレクトリーを分けて出力するかどうかを指定します。

指定できる値

型：boolean(ignore)

{true | false}

デフォルト値

定義項目の省略

false

値の省略

false

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_LOG_DIVISION=true

5.3.8　HJES_ASADMIN_MAINTENANCE_ENABLED

asadminユーティリティーコマンドの保守ログの有効または無効を指定します。

説明

asadminユーティリティーコマンドの保守ログを出力するかどうかを指定します。

指定できる値

型：boolean(ignore)

{true | false}

デフォルト値

定義項目の省略

true

値の省略

true

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MAINTENANCE_ENABLED=true

5.3.9　HJES_ASADMIN_MAINTENANCE_FILE_NUMBER

asadminユーティリティーコマンドの保守ログファイルの面数を指定します。

説明

asadminユーティリティーコマンドの保守ログのJava EE Server稼働中に保持するログファイルの個数を指定します。

指定できる値

型：Integer

1〜64の整数値

デフォルト値

定義項目の省略

8

値の省略

8

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MAINTENANCE_FILE_NUMBER=16

5.3.10　HJES_ASADMIN_MAINTENANCE_LOG_LEVEL

asadminユーティリティーコマンドの保守ログのレベルを指定します。

説明

asadminユーティリティーコマンドの保守ログのログに出力される内容のレベルを指定します。

指定できる値

型：Integer

1〜2

デフォルト値

定義項目の省略

1

値の省略

1

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MAINTENANCE_LOG_LEVEL=2

5.3.11　HJES_ASADMIN_MAINTENANCE_ROTATION_SIZE

asadminユーティリティーコマンドの保守ログファイルのサイズ（単位：バイト）を指定します。

説明

asadminユーティリティーコマンドの保守ログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

指定できる値

型：Integer

4096〜16777216の整数値

デフォルト値

定義項目の省略

16777216

値の省略

16777216

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MAINTENANCE_ROTATION_SIZE=8388608

5.3.12　HJES_ASADMIN_MAINTENANCE_ROTATION_TIME

asadminユーティリティーコマンドの保守ログファイルの切り替え時刻を指定します。

説明

asadminユーティリティーコマンドの保守ログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

指定できる値

型：String

"HHMMSS"形式で000000〜235959の範囲

デフォルト値

定義項目の省略

000000

値の省略

000000

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MAINTENANCE_ROTATION_TIME=121530

5.3.13　HJES_ASADMIN_MESSAGE_ENABLED

asadminユーティリティーコマンドのメッセージログの有効または無効を指定します。

説明

asadminユーティリティーコマンドのメッセージログを出力するかどうかを指定します。

指定できる値

型：boolean(ignore)

{true | false}

デフォルト値

定義項目の省略

true

値の省略

true

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MESSAGE_ENABLED=true

5.3.14　HJES_ASADMIN_MESSAGE_FILE_NUMBER

asadminユーティリティーコマンドのメッセージログファイルの面数を指定します。

説明

asadminユーティリティーコマンドのメッセージログのJava EE Server稼働中に保持するログファイルの個数を指定します。

指定できる値

型：Integer

1〜64の整数値

デフォルト値

定義項目の省略

8

値の省略

8

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MESSAGE_FILE_NUMBER=16

5.3.15　HJES_ASADMIN_MESSAGE_LOG_LEVEL

asadminユーティリティーコマンドのメッセージログのレベルを指定します。

説明

asadminユーティリティーコマンドのメッセージログのログに出力される内容のレベルを指定します。

指定できる値

型：Integer

1〜3

デフォルト値

定義項目の省略

2

値の省略

2

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MESSAGE_LOG_LEVEL=3

5.3.16　HJES_ASADMIN_MESSAGE_ROTATION_SIZE

asadminユーティリティーコマンドのメッセージログファイルのサイズ（単位：バイト）を指定します。

説明

asadminユーティリティーコマンドのメッセージログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

指定できる値

型：Integer

4096〜16777216の整数値

デフォルト値

定義項目の省略

16777216

値の省略

16777216

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MESSAGE_ROTATION_SIZE=8388608

5.3.17　HJES_ASADMIN_MESSAGE_ROTATION_TIME

asadminユーティリティーコマンドのメッセージログファイルの切り替え時刻を指定します。

説明

asadminユーティリティーコマンドのメッセージログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

指定できる値

型：String

"HHMMSS"形式で000000〜235959の範囲

デフォルト値

定義項目の省略

000000

値の省略

000000

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_MESSAGE_ROTATION_TIME=121530

5.3.18　HJES_ASADMIN_STACKTRACE_ENABLED

asadminユーティリティーコマンドのスタックトレースログの有効または無効を指定します。

説明

asadminユーティリティーコマンドのスタックトレースログを出力するかどうかを指定します。

指定できる値

型：boolean(ignore)

{true | false}

デフォルト値

定義項目の省略

true

値の省略

true

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_STACKTRACE_ENABLED=true

5.3.19　HJES_ASADMIN_STACKTRACE_FILE_NUMBER

asadminユーティリティーコマンドのスタックトレースログファイルの面数を指定します。

説明

asadminユーティリティーコマンドのスタックトレースログのJava EE Server稼働中に保持するログファイルの個数を指定します。

指定できる値

型：Integer

1〜64 の整数値

デフォルト値

定義項目の省略

8

値の省略

8

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_STACKTRACE_FILE_NUMBER=16

5.3.20　HJES_ASADMIN_STACKTRACE_ROTATION_SIZE

asadminユーティリティーコマンドのスタックトレースログファイルのサイズ（単位：バイト）を指定します。

説明

asadminユーティリティーコマンドのスタックトレースログのログ出力先ファイルを切り替えるサイズ（単位：バイト）を指定します。

指定できる値

型：Integer

4096〜16777216の整数値

デフォルト値

定義項目の省略

16777216

値の省略

16777216

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_STACKTRACE_ROTATION_SIZE=8388608

5.3.21　HJES_ASADMIN_STACKTRACE_ROTATION_TIME

asadminユーティリティーコマンドのスタックトレースログファイルの切り替え時刻を指定します。

説明

asadminユーティリティーコマンドのスタックトレースログのログ出力先ファイルを切り替える時刻を"HHMMSS"形式で指定します。

指定できる値

型：String

"HHMMSS"形式で000000〜235959の範囲

デフォルト値

定義項目の省略

000000

値の省略

000000

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_ASADMIN_STACKTRACE_ROTATION_TIME=121530

5.3.22　HJES_LOGSDIR

Java EE Serverのログファイルの出力先ディレクトリーを指定します。

説明

Java EE Serverのログファイルの出力先ディレクトリーを変更する場合に指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

Java EE Serverのインストールディレクトリー/logs

値の省略

Java EE Serverのインストールディレクトリー/logs

上書き許可

上書きできます。

出現パターン

0回、または1回

記述例

HJES_LOGSDIR=/home/user/logs

5.4　config.properties

config.propertiesファイルは、ブローカーの構成に関するプロパティー設定ファイルです。

説明

config.propertiesファイルは、ブローカーの構成に関するプロパティー設定ファイルです。

ブローカーは、インスタンス設定ファイルを起動時にだけ読み込みます。

ブローカーの設定への変更を適用するには、ブローカーをシャットダウンしてから再起動する必要があります。

config.propertiesファイル（または任意の設定ファイル）のプロパティー定義で使用される構文は次のとおりです。

propertyName=value [ [,value1] ... ]

格納先

プロパティー設定ファイルは次の場所に格納されます。

IMQ_VARHOME/instances/instanceName/props/config.properties

IMQ_VARHOME

環境変数です。

記述例

imq.system.max_count=50000

5.5　config.propertiesに設定するプロパティーの詳細

config.propertiesに設定するプロパティーについて説明しています。

5.5.1　imq.authentication.client.response.timeout

認証リクエストに対するクライアントからの応答を待機する時間を秒単位で指定します。

説明

認証リクエストに対するクライアントからの応答を待機する時間を秒単位で指定します。この値は imq.authentication.client.response.timeout プロパティーで定義されています。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

180

5.5.2　imq.autocreate.destination.limitBehavior

メモリー制限のしきい値に達した場合のブローカー動作を指定します。

説明

メモリー制限のしきい値に達した場合のブローカー動作を指定します。

有効な値は次のとおりです。

FLOW_CONTROL

プロデューサーの速度を落とします。

REMOVE_OLDEST

最も古いメッセージを消去します。

REMOVE_LOW_PRIORITY

最も優先度の低いメッセージをその有効期間に従って消去します。メッセージの作成・送信を行っているクライアントには通知されません。

REJECT_NEWEST

最も新しいメッセージを拒否します。メッセージが持続する場合だけ、例外としてメッセージの作成・送信を行っているクライアントに通知します。

FLOW_CONTROL が指定されても、メッセージ数は imq.system.max_count を超過することがあります。この場合ブローカーは、送信先が満杯で新しいメッセージが拒否されることを示すために、ResourceAllocationException を生成します。

値が REMOVE_OLDEST または REMOVE_LOW_PRIORITY であり、さらに imq.autocreate.destination.useDMQ プロパティーが true の場合、超過したメッセージはデッドメッセージキューに移動されます。

指定できる値

型：String

{FLOW_CONTROL | REMOVE_OLDEST | REMOVE_LOW_PRIORITY | REJECT_NEWEST}

デフォルト値

定義項目の省略

REJECT_NEWEST

5.5.3　imq.autocreate.destination.maxBytesPerMsg

単一メッセージの最大サイズをバイト単位で指定します。

説明

単一メッセージの最大サイズをバイト単位で指定します。

値は、次の接尾辞を使用して、バイト単位、キロバイト単位、メガバイト単位で表現できます。

b

バイト

k

キロバイト（1,024バイト）

m

メガバイト（1,024 × 1,024 = 1,048,576バイト）

接尾辞のない値はバイト単位になります。値「0」と「-1」は、メッセージサイズが無制限であることを示します。

指定できる値

型：String

デフォルト値

定義項目の省略

10k

記述例

imq.autocreate.destination.maxBytesPerMsg=<例>

例：
■ 1600：1600バイト
■ 1600b：1600バイト
■ 16k：16キロバイト（= 16,384 バイト）
■ 16m：16メガバイト（= 16,777,216 バイト）
■ -1：無制限

5.5.4　imq.autocreate.destination.maxNumMsgs

未配信メッセージの最大数を指定します。

説明

未配信メッセージの最大数を指定します。

指定できる値

型：Integer

1〜2147483647

デフォルト値

定義項目の省略

100000

注意事項

フロー制御が有効な場合（imq.autocreate.destination.limitBehavior = FLOW_CONTROL）、ブローカーがメッセージ受信のフローを停止するのに間に合わないで、指定されたメッセージ数の制限を超過する場合があります。その場合、imq.autocreate.destination.maxNumMsgs に指定した値は、厳しく制限するものではなく、単なるヒントとして使われます。

しかし、未配信メッセージ数が imq.system.max_count を超えた場合、ブローカーは、送信先が満杯で新しいメッセージが拒否されることを示すために、ResourceAllocationException を生成します。

5.5.5　imq.autocreate.destination.maxTotalMsgBytes

未配信メッセージの最大の総メモリー量をバイト単位で指定します。

説明

未配信メッセージの最大の総メモリー量をバイト単位で指定します。

構文は imq.autocreate.destination.maxBytesPerMsgに同じです。値は、次の接尾辞を使用して、バイト単位、キロバイト単位、メガバイト単位で表現できます。

b

バイト

k

キロバイト（1,024バイト）

m

メガバイト（1,024 × 1,024 = 1,048,576バイト）

接尾辞のない値はバイト単位になります。値「0」と「-1」は、メッセージサイズが無制限であることを示します。

指定できる値

型：String

デフォルト値

定義項目の省略

10m

記述例

imq.autocreate.destination.maxTotalMsgBytes=<例>

例：
■ 1600：1600バイト
■ 1600b：1600バイト
■ 16k：16キロバイト（= 16,384 バイト）
■ 16m：16メガバイト（= 16,777,216 バイト）
■ -1：無制限

5.5.6　imq.autocreate.destination.useDMQ

デッドメッセージキューへのデッドメッセージの送信を有効または無効にします。

説明

デッドメッセージキューへのデッドメッセージの送信を有効または無効にします。false を指定した場合、デッドメッセージは廃棄されます。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

true

5.5.7　imq.autocreate.queue

キュー送信先の自動作成を有効または無効にします。

説明

キュー送信先の自動作成を有効または無効にします。

true を指定した場合、メッセージコンシューマーまたはメッセージプロデューサーが存在しない送信先にアクセスしようとすると、ブローカーは自動的に物理送信先を作成します。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

true

注意事項

キュー送信先だけに使用できます。

5.5.8　imq.autocreate.queue.maxNumActiveConsumers

キュー送信先からのロードバランス配信での、アクティブなメッセージコンシューマーの最大数を指定します。

説明

キュー送信先からのロードバランス配信での、アクティブなメッセージコンシューマーの最大数を指定します。

値「0」と「-1」は、コンシューマー数が無制限であることを示します。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1

注意事項

キュー送信先だけに使用できます。

5.5.9　imq.autocreate.queue.maxNumBackupConsumers

キュー送信先からのロードバランス配信での、バックアップメッセージコンシューマーの最大数を指定します。

説明

キュー送信先からのロードバランス配信での、バックアップメッセージコンシューマーの最大数を指定します。

値「-1」は、コンシューマー数が無制限であることを示します。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

0

注意事項

キュー送信先だけに使用できます。

5.5.10　imq.autocreate.topic

トピック送信先の自動作成を有効または無効にします。

説明

トピック送信先の自動作成を有効または無効にします。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

true

注意事項

トピック送信先だけに使用できます。

5.5.11　imq.autocreate.topic.consumerFlowLimit

単一のバッチで、トピックコンシューマーに送信できる最大のメッセージ数を指定します。

説明

単一のバッチで、トピックコンシューマーに送信できる最大のメッセージ数を指定します。

値「0」または「-1」は、メッセージ数が無制限であることを示します。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

1000

注意事項

Java EE Serverクラスターで、JMSリソースアダプター（jmsra）がメッセージを消費するために使われている場合、このシステムプロパティーは使用できません。

トピック送信先だけに使用できます。

5.5.12　imq.destination.DMQ.truncateBody

メッセージをデッドメッセージキューに保存する前のメッセージボディーの消去を、有効または無効にします。

説明

メッセージをデッドメッセージキューに保存する前のメッセージボディーの消去を、有効または無効にします。

指定された値が true の場合、メッセージヘッダーとプロパティーデータだけが保存されます。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

5.5.13　imq.hostname

すべての接続サービスの、デフォルトのホスト名またはIPアドレスを指定します。

説明

すべての接続サービスの、デフォルトのホスト名またはIPアドレスを指定します。

指定できる値

型：String

デフォルト値

定義項目の省略

すべての使用可能な IP アドレス

5.5.14　imq.persist.file.destination.message.filepool.limit

送信先ファイルプールが保持するファイルの最大数を指定します。

説明

送信先ファイルプールが保持するファイルの最大数を指定します。

この制限を超えるファイルは削除されます。ブローカーは、この制限に基づき追加するファイルを作成したり、ファイルを削除したりします。

制限値が高いほど、ブローカーは持続データを速く処理できます。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

100

5.5.15　imq.persist.file.message.cleanup

シャットダウン時の、ファイルプール内のファイルの消去を有効または無効にします。

説明

シャットダウン時の、ファイルプール内のファイルの消去を有効または無効にします。

このプロパティーの値に true を指定すると、ファイルストア用のディスクスペースを節約できます。ただし、ブローカーのシャットダウンが遅くなります。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

5.5.16　imq.persist.file.message.filepool.cleanratio

ファイルプールにクリーン（空） の状態で保持するファイルの割合を指定します。

説明

ファイルプールにクリーン （空） の状態で保持するファイルの割合を指定します。

この値が高いほど、ファイルプールに必要なディスクスペースが少なくなりますが、操作時にファイルを消去するために多くのオーバーヘッドが必要になります。

指定できる値

型：Integer

0〜100

デフォルト値

定義項目の省略

0

5.5.17　imq.persist.file.message.max_record_size

メッセージ退避ファイルに追加するメッセージの最大サイズを指定します。

説明

メッセージ退避ファイルに追加するメッセージの最大サイズを指定します。

このサイズを超えるメッセージは、別の専用ファイルに格納されます。

値は、次の接尾辞を使用して、バイト単位、キロバイト単位、メガバイト単位で表現できます。

b

バイト

k

キロバイト（1,024バイト）

m

メガバイト（1,024 × 1,024 = 1,048,576 バイト）

接尾辞のない値はバイト単位になります。

指定できる値

型：String

デフォルト値

定義項目の省略

1m

記述例

imq.persist.file.message.max_record_size=<例>

例：
■ 1600：1600バイト
■ 1600b：1600バイト
■ 16k：16キロバイト（= 16,384 バイト）
■ 16m：16メガバイト（= 16,777,216 バイト）

5.5.18　imq.persist.file.sync.enabled

メモリー内の状態を物理的なストレージデバイスと同期させることを有効または無効にします。

説明

メモリーの状態を物理的なストレージデバイスと同期させることを有効または無効にします。

このプロパティーの値に true に指定すると、システムダウンによるデータの損失はなくなりますが、パフォーマンスが下がります。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

5.5.19　imq.service.activelist

ブローカーの起動時に活性化する接続サービスのリストをコンマで区切って指定します。

説明

ブローカーの起動時に活性化する接続サービスのリストをコンマで区切って指定します。

利用可能な接続サービスは次のとおりです。

jms

ssljms

httpjms

httpsjms

admin

ssladmin

ブローカーのimq.service.activelistプロパティーを設定すると、これらの接続サービスの一部または全部を実行するように設定できます。このプロパティーの値は、ブローカーが起動するときに活性化する接続サービスのリストです。このプロパティーを明示的に指定しない場合、デフォルトでは、jmsとadminサービスが活性化されます。

指定できる値

型：String

[[jms] | [ssljms] | [httpjms] | [httpsjms] | [admin] | [ssladmin]]

デフォルト値

定義項目の省略

jms,admin

5.5.20　imq.system.max_count

ブローカーが保持するメッセージの最大数を指定します。

説明

ブローカーが保持するメッセージの最大数を指定します。

値「0」と「-1」は、メッセージ数が無制限であることを示します。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1

5.5.21　imq.system.max_size

ブローカーが保持するメッセージの最大合計サイズを指定します。

説明

ブローカーが保持するメッセージの最大合計サイズを指定します。

値は、次の接尾辞を使用して、バイト単位、キロバイト単位、メガバイト単位で表現できます。

b

バイト

k

キロバイト（1,024バイト）

m

メガバイト（1,024 × 1,024 = 1,048,576 バイト）

値「0」と「-1」は、メッセージ数が無制限であることを示します。

指定できる値

型：String

デフォルト値

定義項目の省略

-1

5.5.22　imq.txn.reapInterval

リーパースレッドが、コミットされたトランザクションをリープまたはクリーンアップする周期を秒単位で指定します。

説明

リーパースレッドが、コミットされたトランザクションをリープまたはクリーンアップするための周期を秒単位で指定します。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

900

5.5.23　imq.txt.reapLimit

コミットされたトランザクションのリープまたはクリーンアップ時に維持される、最後にコミットされたトランザクションの最大数を指定します。

説明

コミットされたトランザクションのリープまたはクリーンアップ時に維持される、最後にコミットされたトランザクションの最大数を指定します。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

0

5.5.24　java.util.logging.FileHandler.count

出力ファイルの数を指定します。

説明

出力ファイルの数を指定します。

1つのファイルが所定の上限サイズに達すると、そのファイルは閉じられ、新しいファイルが開きます。

古いファイルには新たに名称がつけられます。その際、元のファイル名に「0」、「1」、「2」などといった値が付け加えられます。デフォルトでは、IOライブラリーでバッファリングが有効になっていますが、それぞれのログレコードは完了時にフラッシュされます。

指定できる値

型：Integer

1〜2147483647

デフォルト値

定義項目の省略

8

5.5.25　java.util.logging.FileHandler.level

ハンドラーのデフォルトレベルを指定します。

説明

ハンドラーのデフォルトレベルを指定します。

ロギングLevelオブジェクトは順序づけされており、順序づけされた整数を使って指定できます。所定のレベルでロギングを有効にすると、すべての上位のレベルでもロギングが有効になります。

値をOFFに指定すると、 ロギングを無効にできます。

指定できる値

型：String

{SEVERE(最高値) | WARNING | INFO | CONFIG | FINE | FINER | FINEST | ALL | OFF}

デフォルト値

定義項目の省略

ALL

5.5.26　java.util.logging.FileHandler.limit

1つのログファイルに書き込める上限を指定します （単位はバイト）。

説明

1つのログファイルに書き込める上限を指定します （単位はバイト）。 この値を0にすると、無制限になります 。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

16777216

5.6　das.properties

ノードがドメイン管理サーバに接続するための接続情報を含むファイルです。

説明

ノードがドメイン管理サーバに接続するための接続情報を含むファイルです。

格納先

プロパティーは次の場所に格納されます。

Application Serverのインストールディレクトリー/javaee/glassfish/nodes/node-name/agent/config/das.properties

5.7　das.propertiesに設定するプロパティーの詳細

das.propertiesに設定するプロパティーについて説明しています。

5.7.1　agent.das.host

ドメイン管理サーバのホスト名、またはIPアドレスを指定します。

説明

プロパティー設定対象のサーバインスタンスを管理する、ドメイン管理サーバのホスト名、またはIPアドレス指定します。

指定できる値

型：String

ドメイン管理サーバのホスト名、またはIPアドレス

初期値

localhost

デフォルト値

定義項目の省略

localhost

6　Java EE標準APIで設定できるJava EE Server独自のプロパティー

Java EE標準APIで設定できるJava EE Server独自のプロパティーを説明しています。

6.1　Java EE標準APIで設定できるJava EE Server独自のプロパティーの一覧

Java EE標準APIで設定できるJava EE Server独自のプロパティーの概要について説明しています。

JavaMailでSMTPサーバに接続するためのプロパティー

プロパティー

概要

詳細説明

6.2.1　mail.smtp.allow8bitmime

サーバ側での8BITMIME拡張サポートの指定

このプロパティーにtrueを指定し、サーバが8BITMIME拡張をサポートしている場合に、quoted-printableエンコーディング、またはBase64エンコーディングを使用するメッセージのテキスト部分は、8-bitエンコーディングへ変換されます。

6.2.2　mail.smtp.auth

AUTHコマンドを使用したユーザー認証の指定

mail.smtp.authにtrueを指定すると、AUTHコマンドを使用してユーザー認証をします。

6.2.3　mail.smtp.connectiontimeout

ソケットのコネクションタイムアウト値の指定

mail.smtp.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。

6.2.4　mail.smtp.ehlo

EHLOコマンドによるサインオンの指定

mail.smtp.ehloにfalseを指定すると、EHLOコマンドによるサインオンを行いません。

6.2.5　mail.smtp.localhost

SMTP HELOコマンドまたはEHLOコマンドで使用するローカルホストの名前の指定

mail.smtp.localhostでは、SMTP HELOコマンドまたはEHLOコマンドで使用する、ローカルホストの名前を指定します。

6.2.6　mail.smtp.sendpartial

有効なアドレスへのメール送信の指定

trueを指定した場合、メッセージに有効なアドレスと無効なアドレスが混在しているときは、メッセージが送信され、SendFailedException例外で部分障害が通知されます。

6.2.7　mail.smtp.ssl.protocols

SSL接続で使用できるSSLプロトコルの指定

mail.smtp.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。

6.2.8　mail.smtp.timeout

ソケットの読み込みタイムアウト値の指定

mail.smtp.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。

6.2.9　mail.smtp.writetimeout

ソケットの書き込みタイムアウト値の指定

mail.smtp.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。

JavaMailでIMAPサーバに接続するためのプロパティー

プロパティー

概要

詳細説明

6.3.1　mail.imap.connectiontimeout

ソケットのコネクションタイムアウト値の指定

mail.imap.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。

6.3.2　mail.imap.fetchsize

部分フェッチサイズの指定

mail.imap.fetchsizeでは、部分フェッチサイズをバイト単位で指定します。

6.3.3　mail.imap.peek

ボディー部分のフェッチ時にメッセージへのSEENフラグ設定の防止

mail.imap.peekにtrueを指定すると、ボディー部分をフェッチするときにIMAP PEEKオプションを使用して、メッセージにSEENフラグが設定されるのを防ぎます。

6.3.4　mail.imap.ssl.protocols

SSL接続で使用できるSSLプロトコルの指定

mail.imap.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。

6.3.5　mail.imap.statuscachetimeout

STATUSコマンドの応答をキャッシュするタイムアウト値の指定

mail.imap.statuscachetimeoutでは、STATUSコマンドの応答をキャッシュするタイムアウト値をミリ秒単位で指定します。

6.3.6　mail.imap.timeout

ソケットの読み込みタイムアウト値の指定

mail.imap.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。

6.3.7　mail.imap.writetimeout

ソケットの書き込みタイムアウト値の指定

mail.imap.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。

6.2　JavaMailでSMTPサーバに接続するためのプロパティーの詳細

JavaMailでSMTPサーバに接続するためのプロパティーを説明しています。

6.2.1　mail.smtp.allow8bitmime

mail.smtp.allow8bitmimeにtrueを指定すると、サーバでは8BITMIME拡張（8ビット転送）がサポートされます。

説明

このプロパティーにtrueを指定し、サーバが8BITMIME拡張をサポートしている場合に、quoted-printableエンコーディング、またはBase64エンコーディングを使用するメッセージのテキスト部分は、8-bitエンコーディングへ変換されます。ただし、変換対象のメッセージのテキスト部分は、8-bitテキストに関するRFC 2045の規定に準拠している必要があります。デフォルト値はfalseです。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.allow8bitmime", "true");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.2　mail.smtp.auth

mail.smtp.authにtrueを指定すると、AUTHコマンドを使用してユーザー認証をします。デフォルト値はfalseです。

説明

mail.smtp.authにtrueを指定すると、AUTHコマンドを使用してユーザー認証をします。デフォルト値はfalseです。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.auth", "true");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.3　mail.smtp.connectiontimeout

mail.smtp.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。

説明

mail.smtp.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、java.net.Socketクラスで実装されます。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.connectiontimeout", "30");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.4　mail.smtp.ehlo

mail.smtp.ehloにfalseを指定すると、EHLOコマンドによるサインオンを行いません。

説明

mail.smtp.ehloにfalseを指定すると、EHLOコマンドによるサインオンを行いません。デフォルト値はtrueです。通常、EHLOコマンドでサインオンに失敗した場合、代替にHELOコマンドによってサインオンを行います。このプロパティーは、EHLOコマンドをまったく失敗しないサーバ、またはEHLOコマンドが正しく実装されないサーバに対してだけ使用します。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

true

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.ehlo", "false");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.5　mail.smtp.localhost

mail.smtp.localhostでは、SMTP HELOコマンドまたはEHLOコマンドで使用する、ローカルホストの名前を指定します。

説明

mail.smtp.localhostでは、SMTP HELOコマンドまたはEHLOコマンドで使用する、ローカルホストの名前を指定します。デフォルト値は、InetAddress.getLocalHost().getCanonicalHostName()メソッドの戻り値です。JDKおよびネーミングサービスが正しく設定されている場合、ローカルホストの名前を指定する必要はありません。

指定できる値

型：String

デフォルト値

定義項目の省略

java.net.InetAddress.getLocalHost().getCanonicalHostName()メソッドの戻り値

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.localhost", "localhost");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.6　mail.smtp.sendpartial

mail.smtp.sendpartialにtrueを指定した場合、メッセージに無効なアドレスが含まれているときは、有効なアドレスにだけメールが送信されます。このとき、すべての無効なアドレスには、部分障害としてSendFailedException例外が通知されます。falseを指定した場合は、どのアドレスにもメッセージは送信されません。

説明

trueを指定した場合、メッセージに有効なアドレスと無効なアドレスが混在しているときは、メッセージが送信され、SendFailedException例外で部分障害が通知されます。falseを指定した場合、メッセージに無効なアドレスが存在するときは、どの受信者（アドレス）にもメッセージは送信されません。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.sendpartial", "true");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.7　mail.smtp.ssl.protocols

mail.smtp.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。

説明

mail.smtp.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。プロパティー値には、javax.net.ssl.SSLSocket.setEnabledProtocolsメソッドに設定できるトークンの一覧を空白で区切って指定します。

指定できる値

型：String

指定できる値については、JDKのドキュメントを参照してください。

デフォルト値

定義項目の省略

TLSv1.1およびTLSv1.2

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.ssl.protocols", "TLSv1 TLSv1.1");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.8　mail.smtp.timeout

mail.smtp.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。

説明

mail.smtp.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、java.net.Socketクラスで実装されます。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.timeout", "30");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.2.9　mail.smtp.writetimeout

mail.smtp.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。

説明

mail.smtp.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、接続ごとにjava.util.concurrent.ScheduledExecutorServiceクラスで実装されます。java.util.concurrent.ScheduledExecutorServiceクラスでは、タイムアウト値を超えた場合にソケットを閉じるためのスレッドをスケジュールします。mail.smtp.writetimeout使用時のオーバーヘッドは、1接続当たり1スレッドです。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.smtp.writetimeout", "30");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.3　JavaMailでIMAPサーバに接続するためのプロパティーの詳細

JavaMailでIMAPサーバに接続するためのプロパティーを説明しています。

6.3.1　mail.imap.connectiontimeout

mail.imap.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。

説明

mail.imap.connectiontimeoutでは、ソケットのコネクションタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、java.net.Socketクラスで実装されます。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.connectiontimeout", "30");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

6.3.2　mail.imap.fetchsize

mail.imap.fetchsizeでは、部分フェッチサイズをバイト単位で指定します。デフォルト値は16キロバイトです。

説明

mail.imap.fetchsizeでは、部分フェッチサイズをバイト単位で指定します。デフォルト値は16キロバイトです。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

16384

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.fetchsize", "1000");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

6.3.3　mail.imap.peek

mail.imap.peekにtrueを指定すると、ボディー部分をフェッチするときにIMAP PEEKオプションを使用して、メッセージにSEENフラグが設定されるのを防ぎます。

説明

mail.imap.peekにtrueを指定すると、ボディー部分をフェッチするときにIMAP PEEKオプションを使用して、メッセージにSEENフラグが設定されるのを防ぎます。デフォルト値はfalseです。このオプションは、IMAPMessageクラスのsetPeekメソッドを使用して、メッセージごとにオーバーライドできます。

指定できる値

型：Boolean

{true | false}

デフォルト値

定義項目の省略

false

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.peek", "true");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

6.3.4　mail.imap.ssl.protocols

mail.imap.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。

説明

mail.imap.ssl.protocolsでは、SSL接続で使用できるSSLプロトコルを指定します。プロパティー値には、javax.net.ssl.SSLSocket.setEnabledProtocolsメソッドに設定できるトークンの一覧を空白で区切って指定します。

指定できる値

型：String

指定できる値については、JDKのドキュメントを参照してください。

デフォルト値

定義項目の省略

TLSv1.1およびTLSv1.2

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.ssl.protocols", "TLSv1  TLSv1.1");
Session session = Session.getDefaultInstance(properties);
Message message = new MimeMessage(session);
message.setSubject(sentDate);
Transport.send(message);

6.3.5　mail.imap.statuscachetimeout

mail.imap.statuscachetimeoutでは、STATUSコマンドの応答をキャッシュするタイムアウト値をミリ秒単位で指定します。

説明

mail.imap.statuscachetimeoutでは、STATUSコマンドの応答をキャッシュするタイムアウト値をミリ秒単位で指定します。デフォルト値は1000（1秒）です。この値が0の場合は、キャッシュしません。

指定できる値

型：Integer

0〜2147483647

デフォルト値

定義項目の省略

1000

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.statuscachetimeout", "30");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

6.3.6　mail.imap.timeout

mail.imap.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。

説明

mail.imap.timeoutでは、ソケットの読み込みタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、java.net.Socketクラスで実装されます。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.timeout", "30");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

6.3.7　mail.imap.writetimeout

mail.imap.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。

説明

mail.imap.writetimeoutでは、ソケットの書き込みタイムアウト値をミリ秒単位で指定します。このタイムアウト値は、接続ごとにjava.util.concurrent.ScheduledExecutorServiceクラスで実装されます。java.util.concurrent.ScheduledExecutorServiceクラスでは、タイムアウト値を超えた場合にソケットを閉じるためのスレッドをスケジュールします。mail.imap.writetimeout使用時のオーバーヘッドは、1接続当たり1スレッドです。デフォルト値は-1です。タイムアウト値に-1もしくは0を指定、またはこのプロパティーを省略した場合、タイムアウトは設定されません。

指定できる値

型：Integer

-1〜2147483647

デフォルト値

定義項目の省略

-1（タイムアウトは設定されません）

記述例

Properties properties = new Properties();
properties.setProperty("mail.imap.writetimeout", "30");
Session session = Session.getDefaultInstance(properties);
Store store = session.getStore("imap");
store.connect("user", "password");
messages = folder.getMessages();

7　JavaVMで使用するオプションとプロパティー

JavaVMをチューニングするためのオプションとプロパティーを説明しています。

7.1　JavaVMで使用するオプションとプロパティーの一覧

JavaVMで使用するすべてのオプションとプロパティーの概要を説明しています。また、JavaVMで使用する環境変数の概要も説明しています。

注意事項

ここで説明しているJavaVMのオプションおよびプロパティーのデフォルト値は、サーバのデフォルト値とは異なる場合があります。

各サーバのデフォルト値については、マニュアルユーザーズガイドのcreate-jvm-optionsサブコマンドを使用してJavaVM オプションを変更するに関する説明を参照してください。

一覧表示で使用するJavaVMオプション

オプション

概要

詳細説明

7.2.1　-XX:+Hitachi

JavaVM拡張オプションの一覧の表示

JavaVM拡張オプションを一覧表示します。

拡張スレッドダンプ機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.3.1　-XX:[+|-]HitachiThreadDump

拡張スレッドダンプ情報の出力

拡張スレッドダンプ情報を出力するかどうかを指定します。

7.3.2　-XX:[+|-]HitachiThreadDumpToStdout

拡張スレッドダンプの標準出力への出力

拡張スレッドダンプを標準出力へ出力するかどうかを指定します。

7.3.3　-XX:[+|-]HitachiThreadDumpWithBlockCount

拡張スレッドダンプのスレッド情報へのスレッドが処理をブロックした回数と待ち状態になった回数の出力

拡張スレッドダンプのスレッド情報に、スレッドが処理をブロックした回数と待ち状態になった回数を出力するかどうかを指定します。

7.3.4　-XX:[+|-]HitachiThreadDumpWithCpuTime

拡張スレッドダンプのスレッド情報へのユーザーCPU時間とカーネルCPU時間の出力

拡張スレッドダンプのスレッド情報に、ユーザーCPU時間とカーネルCPU時間を出力するかどうかを指定します。

7.3.5　-XX:[+|-]HitachiThreadDumpWithHashCode

拡張スレッドダンプのスレッド情報へのハッシュコードの出力

拡張スレッドダンプのスレッド情報にハッシュコードを出力するかどうかを指定します。

JavaVMログファイルで使用するJavaVMオプション

オプション

概要

詳細説明

7.4.1　-XX:HitachiJavaLog

JavaVMログファイルのプリフィクスおよびログファイルの出力先ディレクトリーの指定

JavaVMログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

7.4.2　-XX:HitachiJavaLogFileSize

JavaVMログファイルの1ファイル当たりの最大ファイルサイズの指定

ログファイルの単純増加を防ぐため、1ファイルの最大ファイルサイズを指定します。最大ファイルサイズを超えた場合は、そのファイルへは出力しません。

7.4.3　-XX:[+|-]HitachiJavaLogNoMoreOutput

ログファイル作成時に入出力エラーが発生した場合のログ情報の出力方法の指定

ログファイル作成時に入出力エラーが発生した場合に、ログ情報の出力方法について指定します。なお、どちらを指定した場合も、JavaVMの処理は継続されます。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

7.4.4　-XX:HitachiJavaLogNumberOfFile

JavaVMログファイルの作成する最大ファイル数の指定

ログファイルの単純増加を防ぐため、作成する最大ファイル数を指定します。

7.4.5　-XX:[+|-]JavaLogAsynchronous

ログファイルの非同期出力機能の有効または無効の設定

ログファイルの非同期出力機能の有効、無効を指定します。

7.4.6　-XX:[+|-]JavaLogHeaderOutput

JavaVMログファイルオープン時のヘッダー情報の出力

JavaVMログファイルのオープン時にヘッダー情報を出力するかどうかを指定します。ヘッダー情報は、1行目にJavaVMのバージョン情報、2行目に起動コマンドライン情報で構成されます。-XX:HitachiJavaLogFileSizeオプションで1ファイルの最大ファイルサイズを指定する場合は、出力されるヘッダー情報のサイズを考慮して指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

7.4.7　-XX:JavaLogRotationTime

JavaVMログファイルのローテーション時刻の指定

JavaVMログファイルのローテーション方式がシフト方式の場合に、出力先ファイルを切り替える時刻をこのオプションで指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。このオプションに指定した時刻になったタイミングで、JavaVMログファイルを切り替えます。

7.4.8　-XX:JavaLogRotationType

JavaVMログファイルのローテーション方式の指定

JavaVMログファイルのローテーション方式を指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

7.4.9　-XX:[+|-]StandardLogToHitachiJavaLog

JavaVMの標準出力と標準エラー出力の内容のJavaVMログファイルへの出力

JavaVMからの標準出力と標準エラーへの出力結果をJavaVMログファイルに出力します。障害発生時のトラブルシュートのためにこの機能を使用します。通常の運用では使用しません。

詳細時間出力で使用するJavaVMオプション

オプション

概要

詳細説明

7.5.1　-XX:[+|-]HitachiOutputMilliTime

JavaVMログファイルに出力する日時のミリ秒までの出力

ミリ秒までの時間を出力するかどうかを指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

拡張verbosegc機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.6.1　-XX:[+|-]HitachiCommaVerboseGC

拡張verbosegc情報のCSV形式での出力

拡張verbosegc情報をCSV形式で出力するかどうかを指定します。

7.6.2　-XX:[+|-]HitachiVerboseGC

GCが発生した場合に拡張verbosegc情報のJavaVMログファイルへの出力

GCが発生した時の拡張verbosegc情報を出力するかどうかを指定します。

7.6.3　-XX:[+|-]HitachiVerboseGCCpuTime

拡張verbosegc情報へのユーザーCPU時間とカーネルCPU時間の出力

拡張verbosegc情報にCPU利用時間を出力するかどうかを指定します。

7.6.4　-XX:HitachiVerboseGCIntervalTime

拡張verbosegc情報を秒単位で出力する時間の間隔の指定

拡張verbosegc情報を出力する時間（秒）の間隔を指定します。

7.6.5　-XX:[+|-]HitachiVerboseGCPrintCause

GCの要因内容の出力

GCの要因内容を出力するかどうかを指定します。

7.6.6　-XX:[+|-]HitachiVerboseGCPrintDate

拡張verbosegc情報へのGC開始日時の出力

拡張verbosegc情報にGC開始日時を出力するかどうかを指定します。

7.6.7　-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit

java.io.File.deleteOnExit()の呼び出しでJavaVMが確保した累積のヒープサイズとメソッドの呼び出し回数のJavaVMログファイルへの出力

java.io.File.deleteOnExit()を呼び出したことによってJavaVMが確保した累積のヒープサイズとメソッドの呼び出し回数を、JavaVMログファイルに出力するかどうかを指定します。

7.6.8　-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory

JavaVM内部で管理しているヒープ情報のJavaVMログファイルへの出力

JavaVM内部で管理しているヒープ情報をJavaVMログファイルに出力するかどうかを指定します。

7.6.9　-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution

Survivor領域の年齢分布のJavaVMログファイルへの出力

-XX:+PrintTenuringDistribution指定時に出力されるSurvivor領域の年齢分布をJavaVMログファイルへ出力するかどうかを指定します。

7.6.10　-XX:[+|-]HitachiVerboseGCPrintThreadCount

Javaスレッドの数のJavaVMログファイルへの出力

Javaスレッドの数を監視するために、Javaスレッドの数をJavaVMログファイルに出力するかどうかを指定します。

コードキャッシュ領域情報出力機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.7.1　-XX:CodeCacheInfoPrintRatio

コードキャッシュ領域の使用率のしきい値の指定

コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージを出力する契機となる、コードキャッシュ領域の使用率を指定します。

7.7.2　-XX:[+|-]PrintCodeCacheFullMessage

JavaメソッドのJITコンパイル対象時にコードキャッシュ領域が枯渇したときのメッセージのJavaVMログファイルへの出力

JavaメソッドがJITコンパイルの対象になった場合、コードキャッシュ領域が枯渇していたときに、メッセージをJavaVMログファイルに出力するかどうかを指定します。

7.7.3　-XX:[+|-]PrintCodeCacheInfo

コードキャッシュ領域の使用量の出力としきい値に達したことを知らせるメッセージのJavaVMログファイルへの出力の指定

コードキャッシュ領域の使用量を出力するかどうかを指定します。また、使用量がしきい値に達したことを知らせるメッセージをJavaVMログファイルに出力するかどうかを指定します。

OutOfMemoryError発生時の拡張機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.8.1　-XX:[+|-]HitachiOutOfMemoryAbort

OutOfMemoryError発生時に強制終了する機能の有効または無効の設定

OutOfMemoryErrorが発生した場合、標準出力にメッセージを出力して強制終了します。

7.8.2　-XX:[+|-]HitachiOutOfMemoryAbortThreadDump

OutOfMemoryError発生時のスレッドダンプの出力

OutOfMemoryError発生時にスレッドダンプを出力します。ただし、J2SEクラスライブラリーでCヒープ不足の場合は、スレッドダンプの出力による再度のCヒープ不足発生を避けるため、スレッドダンプは出力しません。

7.8.3　-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

OutOfMemoryError発生時に出力するスレッドダンプログファイルへのクラス別統計情報の出力

-XX:+HitachiOutOfMemoryAbortThreadDumpで出力するスレッドダンプログファイルにクラス別統計情報を出力するかどうかを指定します。

なお、G1GCを使用している場合、この機能は使用できません。G1GC使用時にこの機能を有効にするオプションを指定した場合、指定内容は反映されないで、この機能は無効となります。

7.8.4　-XX:[+|-]HitachiOutOfMemoryCause

OutOfMemoryError発生時の発生要因種別の出力

OutOfMemoryError発生時の発生要因種別を出力するかどうかを指定します。

7.8.5　-XX:[+|-]HitachiOutOfMemorySize

OutOfMemoryError発生時に要求したメモリーのサイズの出力

OutOfMemoryError発生時に要求したメモリーのサイズを出力します。

7.8.6　-XX:[+|-]HitachiOutOfMemoryStackTrace

OutOfMemoryError発生時の例外情報とスタックトレースのJavaVMログファイルへの出力

OutOfMemoryError発生時に、例外情報とスタックトレースをJavaVMログファイルに出力するかどうかを指定します。

7.8.7　-XX:HitachiOutOfMemoryStackTraceLineSize

OutOfMemoryError発生時に出力するスタックトレース1行の文字数のバイト数での指定

OutOfMemoryError発生時に、出力するスタックトレース1行の文字数をバイト数で指定します。

クラスライブラリートレース機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.9.1　-XX:[+|-]HitachiJavaClassLibTrace

クラスライブラリーのスタックトレースの出力

システム全体に影響を与えるメソッドが使用された場合、これらのAPIのスタックトレースを、JavaVMログファイルへ出力します。

7.9.2　-XX:HitachiJavaClassLibTraceLineSize

クラスライブラリーのスタックトレースの1行の文字数のバイト数での指定

-XX:+HitachiJavaClassLibTraceオプションを指定した場合に出力される、クラスライブラリーのスタックトレースの1行の文字数をバイト数で指定します。

ローカル変数情報出力機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.10.1　-XX:HitachiCallToString

ローカル変数オブジェクトに対して取得したStringオブジェクトの文字列の出力

適用範囲に該当するクラスのローカル変数オブジェクトに対して取得したStringオブジェクトの文字列を、変数値を表現する文字列として出力します。

7.10.2　-XX:[+|-]HitachiLocalsInStackTrace

スレッドダンプ出力時のスタックトレースへの各メソッドのローカル変数情報の追加出力

スレッドダンプ出力時のスタックトレースに、各メソッドのローカル変数情報を追加して出力します。

7.10.3　-XX:[+|-]HitachiLocalsInThrowable

スタックトレース中のメソッドのローカル変数情報の出力

java.lang.Throwable.fillInStackTraceメソッド実行時に、スタックトレース中のメソッドのローカル変数情報を収集します。

7.10.4　-XX:[+|-]HitachiLocalsSimpleFormat

ローカル変数情報の出力フォーマットの1変数1行で出力する簡易出力フォーマットへの変更

ローカル変数情報の出力フォーマットを、1変数1行で出力する簡易出力フォーマットに変更します。

7.10.5　-XX:[+|-]HitachiTrueTypeInLocals

ローカル変数情報への実際のオブジェクト型名の出力

ローカル変数情報収集時に、クラスまたは配列型のローカル変数について、実際に代入されているオブジェクトの型名を出力します。

明示管理ヒープ機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.11.1　-XX:ExplicitMemoryAutoReclaimTargetBlockRatio

明示管理ヒープ機能の自動解放処理で設定している解放率の上限値の指定

明示管理ヒープ機能の自動解放処理で設定している解放率の上限値を指定します。解放率とは、自動解放処理で選択した量に対する、実際に自動解放処理で解放した量の割合を指します。

7.11.2　-XX:ExplicitMemoryExcludeClassListFile

明示管理ヒープ機能適用除外設定ファイルのファイルパスの指定

明示管理ヒープ機能適用除外クラス指定機能で利用する、明示管理ヒープ機能適用除外設定ファイルのファイルパスを指定します。このファイルに記述されているクラスには、明示管理ヒープ機能が適用されません。

7.11.3　-XX:ExplicitMemoryFullGCPolicy

FullGC発生時の参照関係に基づくオブジェクトのJavaヒープからExplicitメモリーブロックへの移動の制御

FullGC発生時に、参照関係に基づくオブジェクトのJavaヒープからExplicitメモリーブロックへの移動を制御するかどうかを指定します。このオプションを使用すると、FullGC発生時にExplicitヒープへ移動していたオブジェクトを、Tenured領域へ移動できます。

7.11.4　-XX:ExplicitMemoryNotExcludeClassListFile

明示管理ヒープ機能適用除外無効設定ファイルのファイルパスの指定

明示管理ヒープ機能適用除外クラス指定機能で利用する、明示管理ヒープ機能適用除外無効設定ファイルのファイルパスを指定します。明示管理ヒープ機能適用除外設定ファイルに記述されていても、このファイルに記述されているクラスには、明示管理ヒープ機能適用除外クラス指定機能が適用されません。

7.11.5　-XX:[+|-]ExplicitMemoryUseExcludeClass

明示管理ヒープ機能適用除外クラス指定機能の有効または無効の設定

明示管理ヒープ機能適用除外クラス指定機能の有効、無効を指定します。

7.11.6　-XX:[+|-]HitachiAutoExplicitMemory

Explicitメモリーブロックの自動配置機能の有効または無効の設定

Explicitメモリーブロックの自動配置機能の有効、無効を指定します。

7.11.7　-XX:HitachiAutoExplicitMemoryFile

Explicitメモリーブロックの自動配置機能で利用する自動配置設定ファイルのパスの指定

Explicitメモリーブロックの自動配置機能で利用する自動配置設定ファイルのパスを指定します。

7.11.8　-XX:HitachiExplicitHeapMaxSize

Explicitヒープ全体の最大サイズの指定

Explicitヒープ全体の最大サイズを指定します。

7.11.9　-XX:[+|-]HitachiExplicitMemoryAutoReclaim

明示管理ヒープ機能の自動解放機能の有効または無効の設定

明示管理ヒープ機能の自動解放機能を利用するかどうか指定します。

7.11.10　-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim

HTTPセッションで利用するExplicitヒープの省メモリー化機能の有効または無効の設定

HTTPセッションで利用するExplicitヒープの省メモリー化機能の有効、無効を指定します。

7.11.11　-XX:[+|-]HitachiExplicitMemoryCompatibleToV8

Explicitメモリーブロックの確保方法を08-00と同様にするかどうかの指定

Explicitメモリーブロックを確保する方法を、08-00と同様にするかどうか指定します。08-50以降の新機能を利用しないで、08-00で動作するアプリケーションをそのまま08-50で動作させる場合、このオプションを有効にします。

7.11.12　-XX:HitachiExplicitMemoryJavaLog

明示管理ヒープ機能のログファイルのプリフィクスおよびログファイルの出力先ディレクトリーの指定

明示管理ヒープ機能のログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

7.11.13　-XX:HitachiExplicitMemoryJavaLogFileSize

明示管理ヒープ機能のログファイルの1ファイル当たりの最大ファイルサイズのバイト単位での指定

1ファイルの最大ファイルサイズをバイト単位で設定します。

7.11.14　-XX:HitachiExplicitMemoryJavaLogNumberOfFile

明示管理ヒープ機能のログファイルを作成する最大ファイル数の指定

ログファイルの単純増加を防ぐため、作成する最大ファイル数を指定します。

7.11.15　-XX:HitachiExplicitMemoryLogLevel

明示管理ヒープ機能のイベントログのレベルの指定

明示管理ヒープ機能のイベントログのレベルを指定します。

7.11.16　-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst

Explicitメモリーブロックの解放処理でのオブジェクトの移動先のTenured領域への変更

Explicitメモリーブロックの解放処理でのオブジェクトの移動先を指定します。

7.11.17　-XX:[+|-]HitachiUseExplicitMemory

明示管理ヒープ機能の有効または無効の設定

明示管理ヒープ機能の有効、無効を指定します。

リソースの上限値指定で使用するJavaVMオプション

オプション

概要

詳細説明

7.12.1　-XX:HitachiJITCompileMaxMemorySize

JITコンパイル時に確保するCヒープのメモリーサイズの上限値の指定

JITコンパイル時に確保するCヒープのメモリーサイズの上限値を指定します。

7.12.2　-XX:HitachiThreadLimit

スレッド数の上限値の指定

スレッド数の上限値を指定します。

JITコンパイラー稼働継続機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.13.1　-XX:[+|-]JITCompilerContinuation

JITコンパイラー稼働継続機能の有効または無効の設定

JITコンパイラー稼働継続機能を有効にするかどうかを指定します。

Javaアプリケーションプログラムの実行で使用するJavaVMオプション

オプション

概要

詳細説明

7.14.1　-Xhras

Javaアプリケーションプログラムの実行

javaコマンド、またはjavawコマンド実行時にこのオプションを設定すると、Javaアプリケーションプログラムが実行できます。

圧縮オブジェクトポインター機能で使用するJavaVMオプション

オプション

概要

詳細説明

7.15.1　-XX:[+|-]UseCompressedOops

圧縮オブジェクトポインター機能の有効または無効の設定

圧縮オブジェクトポインター機能の有効、無効を指定します。

ファイナライズ滞留解消機能で使用するJavaVMプロパティー

プロパティー

概要

詳細説明

7.16.1　JP.co.Hitachi.soft.jvm.autofinalizer

ファイナライズ滞留解消機能の有効または無効の設定

ファイナライズ滞留解消機能の有効、無効を指定します。

ユーザー拡張性能解析トレースで使用するJavaVMプロパティー

プロパティー

概要

詳細説明

7.17.1　jvm.userprf.Enable

ユーザー拡張性能解析トレースの有効または無効の設定

ユーザー拡張性能解析トレースを有効にするかどうかを指定します。

7.17.2　jvm.userprf.ExtendedSetting

ユーザー拡張性能解析トレース設定ファイルの記述形式の指定

ユーザー拡張性能解析トレース設定ファイルの記述形式に、次の方式を有効にするかどうかを指定します。

7.17.3　jvm.userprf.File

ユーザー拡張性能解析トレース設定ファイルのファイルパスの指定

ユーザー拡張性能解析トレース設定ファイルのファイルパスを指定します。

7.17.4　jvm.userprf.Limit

ユーザー拡張性能解析トレースの対象となるメソッド数の上限値の指定

ユーザー拡張性能解析トレースの対象となるメソッド数の上限値を指定します。

7.17.5　jvm.userprf.LineNumber

メソッドの最後に実行した行の行番号のトレース情報への出力

メソッドが正常に終了した場合、メソッドの最後に実行した行の行番号をトレース情報に出力するかどうかを指定します。

7.17.6　jvm.userprf.LogLevel

ユーザー拡張性能解析トレースのトレース出力レベルの指定

ユーザー拡張性能解析トレースのトレース情報のオプション情報（OPT）に出力する、トレース対象のメソッド名の出力レベルを指定します。

7.17.7　jvm.userprf.ThrowableName

例外またはエラーのクラス名のトレース情報への出力

メソッドが異常終了した場合、例外またはエラーのクラス名をトレース情報のオペレーション情報（OPR）に出力するかどうかを指定します。

7.17.8　jvm.userprf.ThrowableNameEditMethod

例外またはエラーのクラス名が文字数制限32文字を超えた場合の名前の編集方法の指定

例外またはエラーのクラス名が32文字を超える場合のクラス名の編集方法を指定します。例外またはエラーのクラス名が32文字以内であれば、このプロパティーの指定に関係なく、すべての文字がトレース情報に出力されます。

7.17.9　jvm.userprf.Trace

ユーザー拡張性能解析トレース設定ファイルで指定したクラスファイルの書き換えの成功ログの出力

ユーザー拡張性能解析トレース設定ファイルで指定したクラスファイルの書き換えの成功ログを出力するかどうかを指定します。

Application Serverで使用するJava HotSpot VMのオプション

オプション

概要

詳細説明

7.18.1　-agentlib:hndlwrap2

Windowsログオフ時のJavaVMの実行の継続

JDKのバージョンが6以降の環境でWindowsをログオフしたとき、JavaVMの実行を継続するかどうか設定します。

7.18.2　-agentlib:libname

ネイティブエージェントライブラリーのロード

ネイティブエージェントライブラリーlibnameをロードします。

7.18.3　-XX:CompressedClassSpaceSize

Compressed Class Spaceの最大値の指定

Compressed Class Spaceの最大値を指定します。

7.18.4　-XX:ConcGCThreads

Concurrent Markingの処理を並列実行するスレッド数の指定

G1GCが有効な場合に、Concurrent Markingの処理を並列実行するスレッドの数を指定します。

7.18.5　-XX:MaxGCPauseMillis

G1GCのGCによるアプリケーション停止時間の目標時間の指定

G1GCのGCによるアプリケーション停止時間の目標時間をミリ秒（ms）単位で指定します。

7.18.6　-XX:MaxMetaspaceSize

Metaspace領域の最大値の指定

Metaspace領域の最大値を指定します。

7.18.7　-XX:MaxTenuringThreshold

CopyGC実行時にFrom空間とTo空間でJavaオブジェクトを入れ替える回数のしきい値の指定

CopyGC実行時に、From空間とTo空間でJavaオブジェクトを入れ替える回数のしきい値を指定します。指定した回数を超えて入れ替え対象になったJavaオブジェクトは、Tenured領域に移動されます。

7.18.8　-XX:MetaspaceSize

Metaspace領域に起因するFullGCの基準値の指定

Metaspace領域に起因するFullGCの基準値を指定します。

7.18.9　-XX:NewRatio

New領域に対するTenured領域の割合の指定

New領域に対するTenured領域の割合を指定します。

7.18.10　-XX:ParallelGCThreads

G1GCを並列実行するスレッドの数の指定

G1GCを並列実行するスレッドの数を指定します。

7.18.11　-XX:ReservedCodeCacheSize

コードキャッシュ領域の最大サイズの指定

コードキャッシュ領域の最大サイズを指定します。

7.18.12　-XX:SurvivorRatio

Survivor領域のFrom空間とTo空間に対するEden領域の割合の指定

New::Survivor領域のFrom空間とTo空間に対するNew::Eden領域の割合を指定します。

7.18.13　-XX:TargetSurvivorRatio

GC実行後のSurvivor領域内でJavaオブジェクトが占める割合の目標値の指定

GC実行後のNew::Survivor領域内でJavaオブジェクトが占める割合の目標値（0〜100（単位：%））を指定します。

7.18.14　-XX:[+|-]UseG1GC

G1GCの実行

G1GCを実行するかどうかを指定します。

このオプションは、ほかのGC方式を選択するオプション（UseSerialGC、HitachiUseExplicitMemory）と同時に指定できません。

7.18.15　-XX:[+|-]UseSerialGC

SerialGCの実行

SerialGCを実行するかどうかを指定します。

7.18.16　-verbose:information-type

information-typeに指定した情報の出力

information-typeに指定した情報を出力します。

7.18.17　-Xloggc:file

GCイベントが発生するたびにfileへのログの出力

-verbose:gcと同様にGCイベントが発生するたびに報告しますが、そのデータをfileに記録します。-verbose:gcを指定したときに報告される情報のほかに、報告される各イベントの先頭に、最初のGCイベントからの経過時間（秒単位）が付け加えられます。

7.18.18　-Xms

Javaヒープの初期サイズの指定

Javaヒープの初期サイズを指定します。

7.18.19　-Xmx

Javaヒープの最大サイズの指定

Javaヒープの最大サイズを指定します。

7.18.20　-Xprof

実行中のプログラムのプロファイルを生成してプロファイリングデータの標準出力への出力

このオプションを指定した場合、実行中のプログラムのプロファイルを生成し、プロファイリングデータを標準出力に出力します。このオプションは、プログラム開発用のユーティリティーとして提供されています。本番稼働システムでの使用を目的としたものではありません。

7.18.21　-Xss

1スタック領域の最大サイズの指定

1スタック領域の最大サイズを指定します。

JavaVM で使用する環境変数

環境変数

概要

詳細説明

7.19.1　JAVA_HRAS

javaコマンドを実行可能にするための環境変数

javaコマンド実行時にこの環境変数を設定すると、Application Serverと連携しないJavaアプリケーションプログラムが実行できます。

7.19.2　JAVACOREDIR

スレッドダンプファイルの出力先ディレクトリーの指定

スレッドダンプファイルを出力する場合の、出力先ディレクトリーをバッチファイルで指定します。

7.19.3　JAVAW_HRAS

javawコマンドを実行可能にするための環境変数

javawコマンド実行時にこの環境変数を設定すると、Application Serverと連携しないJavaアプリケーションプログラムが実行できます。

7.2　一覧表示で使用するJavaVMオプション

JavaVMオプションの一覧を表示するオプションを説明しています。

7.2.1　-XX:+Hitachi

JavaVM拡張オプションの一覧を表示します。

説明

JavaVM拡張オプションを一覧表示します。

このオプションは、Javaプログラムを実行しません。また、Java EEサーバの起動オプションに指定した場合、Java EEサーバは起動されません。

書式

-XX:+Hitachi

指定できる値

型：String

-XX:+Hitachi

デフォルト値

定義項目の省略

なし

出力例

-XX:[+|-]HitachiVerboseGC
    print GC log in detail
-XX:[+|-]HitachiCommaVerboseGC
    output GC log separated by ","
-XX:HitachiVerboseGCIntervalTime=<time>
    set interval for printing GC log
-XX:[+|-]HitachiVerboseGCPrintCause
    add GC cause to GC log
-XX:[+|-]HitachiVerboseGCPrintDate
    add date to GC log
-XX:[+|-]HitachiVerboseGCCpuTime
    add CPU time spent by GC to GC log
-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution
    add tenuring age info. to GC log
-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory
    add JVM Internal Memory to GC log
-XX:[+|-]HitachiVerboseGCPrintThreadCount
    add thread count to GC log
-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit
    add memory size and called count by java.io.File#deleteOnExit to GC log
-XX:[+|-]JavaLogAsynchronous
    enable output asynchronous javalog
-XX:HitachiJITCompileMaxMemorySize=<size>
    set max memory size of JIT compiler
-XX:[+|-]JITCompilerContinuation
    continue JIT compilation when failure occurs
-XX:HitachiThreadLimit=<num>
    set maximum number of threads
-XX:[+|-]HitachiOutOfMemoryStackTrace
    print stack trace when OutOfMemoryError occurs
-XX:[+|-]HitachiOutOfMemoryCause
    print cause of OutOfMemoryError
-XX:[+|-]HitachiOutOfMemorySize
    print requested allocation size when OutOfMemoryError occurs
-XX:HitachiOutOfMemoryStackTraceLineSize=<size>
    set stack trace line size
-XX:[+|-]HitachiOutOfMemoryAbort
    abort when OutOfMemoryError occurs
-XX:[+|-]HitachiOutOfMemoryAbortThreadDump
    print thread dump before abort at OOM
-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf
    print Java heap profiling data before abort at OOM
-XX:[+|-]HitachiJavaClassLibTrace
    print java class library trace when specific API called
-XX:HitachiJavaClassLibTraceLineSize=<size>
    set java class library trace line size
-XX:[+|-]HitachiOutputMilliTime
    use milliseconds precision timer for javalog
-XX:[+|-]HitachiLocalsInThrowable
    output locals info. in Throwable#printStackTrace
-XX:[+|-]HitachiLocalsInStackTrace
    output locals info. in thread dump
-XX:[+|-]HitachiLocalsSimpleFormat
    change output format of locals info. to simpler one
-XX:[+|-]HitachiTrueTypeInLocals
    add true type name to locals info
-XX:HitachiCallToString=<range>
    specify range of locals targets to which apply toString method call
-XX:[+|-]HitachiThreadDump
    print expand thread dump
-XX:[+|-]HitachiThreadDumpToStdout
    print expand thread dump to stdout
-XX:[+|-]HitachiThreadDumpWithHashCode
    add hashCode value for thread object to expand thread dump
-XX:[+|-]HitachiThreadDumpWithCpuTime
    add CPU time spent by thread to expand thread dump
-XX:[+|-]HitachiThreadDumpWithBlockCount
    add blocked count and waited count of thread to expand thread dump
-XX:HitachiJavaLog:[<file>]
    set log filename
-XX:JavaLogRotationType:[WRAP|SHIFT]
    specify type of javalog rotation
-XX:JavaLogRotationTime:<time>
    specify time of javalog rotation
-XX:[+|-]JavaLogHeaderOutput
    output header information in javalog
-XX:HitachiJavaLogFileSize=<size>
    set maximum size of log file
-XX:HitachiJavaLogNumberOfFile=<value>
    set maximum number of log file
-XX:[+|-]HitachiJavaLogNoMoreOutput
    cease to output log when file output error occurs
-XX:[+|-]HitachiUseExplicitMemory
    use explicit memory
-XX:HitachiExplicitHeapMaxSize=<size>
    set maximum size of explicit heap
-XX:[+|-]HitachiExplicitMemoryAutoReclaim
    use explicit memory auto reclaim
-XX:[+|-]HitachiAutoExplicitMemory
    use explicit memory auto creation
-XX:HitachiAutoExplicitMemoryFile:[<file>]
    set explicit memory auto creation file
-XX:[+|-]HitachiExplicitMemoryCompatibleToV8
    maintain compatibility with version 08-00 specification of explicit
memory instead of new features
-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst
    move Java objects to tenured area before new area in reclaim
-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim
    enable auto reclaiming of reference explicit memory
-XX:HitachiExplicitMemoryLogLevel:[none|normal|verbose|debug]
    set explicit memory log level
-XX:HitachiExplicitMemoryJavaLog:[<file>]
    set explicit memory log filename
-XX:HitachiExplicitMemoryJavaLogFileSize=<size>
    set maximum size of explicit memory log file
-XX:HitachiExplicitMemoryJavaLogNumberOfFile=<value>
    set maximum number of explicit memory log file
-XX:ExplicitMemoryFullGCPolicy=<value>
    set full GC policy when using explicit memory
-XX:[+|-]ExplicitMemoryUseExcludeClass
    use explicit memory exclude class
-XX:ExplicitMemoryExcludeClassListFile:[<file>]
    set explicit memory exclude class list file
-XX:ExplicitMemoryNotExcludeClassListFile:[<file>]
    set explicit memory not exclude class list file
-XX:ExplicitMemoryAutoReclaimTargetBlockRatio=<value>
    set ratio of auto reclaim target block
-XX:[+|-]PrintCodeCacheInfo
    print code cache information
-XX:CodeCacheInfoPrintRatio=<value>
    set tuning parameter of code cache monitoring threshold
-XX:[+|-]PrintCodeCacheFullMessage
    print message when code cache is full
-Xhras
    use utility for stand-alone programming in executing java command
-XX:[+|-]StandardLogToHitachiJavaLog
    save JVM output to javalog

7.3　拡張スレッドダンプ機能で使用するJavaVMオプション

拡張スレッドダンプの出力を設定するためのオプションを説明しています。

7.3.1　-XX:[+|-]HitachiThreadDump

拡張スレッドダンプ情報を出力します。

説明

拡張スレッドダンプ情報を出力するかどうかを指定します。

スレッドダンプは、標準出力、および次に示すファイルに出力されます。

スレッドダンプ出力先

デフォルトでは、JavaVM実行時のカレントディレクトリーです。環境変数JAVACOREDIRを指定することで、出力先を変更できます。

スレッドダンプ出力ファイル名

javacoreプロセス番号.YYMMDDhhmmss※.txt

注※

YY：年（西暦で下2桁）、MM：月（2桁）、DD：日（2桁）

hh：時間（24時間表記）、mm：分（2桁）、ss：秒（2桁）

スレッドダンプ情報の構成を、次に示します。

表7‒1　スレッドダンプ情報の構成

出力情報

内容

ヘッダー

スレッドダンプを開始した日付および時刻、JavaVMバージョン情報、起動コマンドラインを出力します。

システム設定

次の情報を出力します。

JDKの実行環境のインストールディレクトリー

JDKを構成するライブラリーのインストールディレクトリー

システムクラスパス

Javaコマンドオプション

動作環境

次の情報を出力します。

ホスト名

OSバージョン

CPU情報

メモリー情報

次の情報を出力します。

メモリー使用状況

物理メモリー使用量

仮想メモリー使用量

ページング使用量

Javaヒープ情報

Javaヒープの各世代のメモリー使用状況を出力します。

JavaVM内部メモリーマップ情報

JavaVM自身の確保しているメモリーの領域情報を出力します。

JavaVM内部メモリーサイズ情報

JavaVM自身の確保しているメモリーのサイズ情報を出力します。

アプリケーション情報

次の情報を出力します。

シグナルハンドラー

環境変数

カレントディレクトリー情報

ライブラリー情報

ローディングされているライブラリーの情報を出力します。

スレッド情報

<スレッド1>

:

<スレッドn>

スレッドごとにスレッド情報を出力します。現存する全スレッドのスタックトレースを出力します。

Javaモニターダンプ

Javaモニターオブジェクトの一覧を表示します。スレッド間の排他待ちの状況を確認できます。

JNIグローバル参照数の情報

JavaVMが保持しているJNIのグローバル参照の数を出力します。

JNIグローバル参照は、次の場合に作成されます。

JavaVMが自身の起動や実行のために必要な場合。

JNIがサポートするNewGlobalRef関数を発行した場合。

Explicitヒープ情報

Explicitヒープ情報では、Explicitヒープ全体での利用状況を出力します。Explicitヒープ利用の有無に関係なく、-XX:+HitachiUseExplicitMemoryが有効の場合は必ず出力されます。

Explicitメモリーブロック情報

Explicitメモリーブロック情報では、次の情報を出力します。ただし、Explicitメモリーブロックが1つも存在しない場合は何も出力されません。

Explicitメモリーブロックごとの利用状況

オブジェクト統計情報（eheapprofコマンド実行時に出力）

オブジェクト解放率情報（-freeratioオプションを指定したeheapprofコマンド実行時に出力）

フッター

スレッドダンプを終了した日付および時刻を出力します。

各スレッドダンプ情報の出力形式を、次に示します。

ヘッダー

EEE MMM dd hh:mm:ss yyyy※

Full thread dump Java HotSpot(TM) Client VM (1.5.0_05-b05-CDK0850-ビルド日 ¥
mixed mode)
起動コマンドライン
...

注※

EEEは曜日、MMMは月、ddは日を表します。また、hhは時間、mmは分、ssは秒、yyyyは年（西暦）を表します。

システム設定

System Properties
-----------------
Java Home Dir  : JDK実行環境のインストールディレクトリー
Java DLL Dir   : JDKを構成するライブラリーのインストールディレクトリー
Sys Classpath  : システムクラスパス
User Args      :
Javaコマンドオプション1
Javaコマンドオプション2
...

動作環境

Operating Environment
---------------------
Host    : ホスト名:IPアドレス
OS      : OSバージョン
CPU     : CPU種別, 利用可能CPU数/システム全体のCPU数

メモリー情報

Memory Status
-------------
  Memory in use   : メモリー使用状況(単位：パーセント)
  Physical memory : 物理メモリー使用量※ free
  Virtual memory  : 仮想メモリー使用量※ free
  Paging file     : ページング使用量※ free

注※

利用可能サイズ/総サイズの形式で表示されます（単位：バイト）。

Javaヒープ情報（SerialGCの場合）

Heap Status
-----------
def new generation   max 最大の容量, total 現在の容量, ¥
used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/total)
                      [領域先頭アドレス, コミット済み領域の末尾アドレス, ¥
予約済み領域の末尾アドレス)
  eden space 現在の容量,  使用率% used [領域先頭アドレス, ¥
使用中領域の先頭アドレス, 予約済み領域の末尾アドレス)
  from space 現在の容量,   使用率% used [領域先頭アドレス, ¥
使用中領域の先頭アドレス, 予約済み領域の末尾アドレス)
  to   space 現在の容量,   使用率% used [領域先頭アドレス, ¥
使用中領域の先頭アドレス, 予約済み領域の末尾アドレス)
tenured generation   max 最大の容量, total 現在の容量, ¥
used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/total)
                      [領域先頭アドレス, コミット済み領域の末尾アドレス, ¥
予約済み領域の末尾アドレス)
   the space 現在の容量,  使用率% used [領域先頭アドレス, ¥
使用中領域の先頭アドレス, 次の空きブロックの先頭アドレス, ¥
予約済み領域の末尾アドレス)
Metaspace       max 最大の容量, capacity ¥
Metaspaceのコミット済みのメモリー領域からフリー領域を除いた合計サイズ, ¥
committed Metaspaceのコミット済みの合計メモリーサイズ, ¥
reserved 予約済みのメモリーサイズ, used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/committed)
  class space    max 最大の容量, capacity ¥
Metaspaceのコミット済みのメモリー領域からフリー領域を除いた合計サイズ, ¥
committed Metaspaceのコミット済みの合計メモリーサイズ, ¥
reserved 予約済みのメモリーサイズ, used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/committed)
                [領域の先頭アドレス, 使用中領域の先頭アドレス, ¥
コミット済み領域の末尾アドレス, 予約済み領域の末尾アドレス)

注

容量およびメモリーサイズの単位はキロバイトです。

-XX:MaxMetaspaceSizeオプションを指定していない場合、Metaspace領域の最大値は無制限です。Metaspace領域の場合、最大の容量には「unlimited」、最大の容量に対する使用率には「-%」が出力されます。

class spaceは、64ビット版のJava VMで圧縮オブジェクトポインター機能を使用し、かつCompressed Class Spaceを使用している場合にだけ出力されます。

Metaspace領域の値は、Compressed Class Spaceを含むMetaspace領域全体の合計値です。

Javaヒープ情報（G1GCの場合）

Heap Status
-----------
 garbage-first heap   total Javaヒープ領域の容量, ¥
used Javaヒープ領域の使用量 [Javaヒープ領域の先頭アドレス, ¥
Javaヒープ領域のコミット済みの末尾アドレス, ¥
Javaヒープ領域の予約済みの末尾アドレス)
  region size 1リージョンのサイズ, New領域の使用中のリージョン数 young ¥
(New領域の使用量), Survivor領域の使用中のリージョン数 survivors ¥
(Survivor領域の使用量)
 Metaspace       max 最大の容量, capacity ¥
Metaspaceのコミット済みのメモリー領域からフリー領域を除いた合計サイズ, ¥
committed Metaspaceのコミット済みの合計メモリーサイズ, ¥
reserved 予約済みのメモリーサイズ, used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/committed)
  class space    max 最大の容量, capacity ¥
Metaspaceのコミット済みのメモリー領域からフリー領域を除いた合計サイズ, ¥
committed Metaspaceのコミット済みの合計メモリーサイズ, ¥
reserved 予約済みのメモリーサイズ, used 使用中のメモリーサイズ ¥
(最大の容量に対する使用率% used/max, 現在の容量に対する使用率% used/committed)
                [領域の先頭アドレス, 使用中領域の先頭アドレス, ¥
コミット済み領域の末尾アドレス, 予約済み領域の末尾アドレス)

注

容量の単位はキロバイトです。

JavaVM内部メモリーマップ情報

JVM Internal Memory Map
-----------------------
メモリー確保関数:address = 開始アドレス - 終了アドレス (size:サイズ)

注

メモリー確保関数：mmap()かmalloc()のどちらかが出力されます。

開始アドレス：メモリー領域の開始アドレスが16進で出力されます。

終了アドレス：メモリー領域の終了アドレスが16進で出力されます。

サイズ：確保しているメモリー領域のサイズが出力されます（単位：バイト）。

JavaVM内部メモリーサイズ情報

JVM Internal Memory Status
--------------------------
  Heap Size      :確保しているメモリーサイズ※
  Alloc Size     :使用中のメモリーサイズ※
  Free Size      :未使用のメモリーサイズ※

注※

単位：バイト

アプリケーション情報

Application Environment
-----------------------
Signal Handlers -
  SIGINT         :シグナルハンドラー情報
  SIGILL         :シグナルハンドラー情報
...
  SIGBREAK       :シグナルハンドラー情報
  SIGABRT        :シグナルハンドラー情報

Environment Variables -
環境変数=値
...
Current Directory -

C:¥Program Files¥Hitachi¥APServer¥CC¥...

ライブラリー情報

Loaded Libraries
----------------
Dynamic libraries :
開始アドレス-終了アドレス   コマンド
開始アドレス-終了アドレス   ライブラリー
...

スレッド情報

Stack Trace
-----------

"スレッド名" #スレッド識別子 daemon prio=優先度 os_prio=OS優先度 ¥
jid=ハッシュ値 tid=スレッドID nid=native ID status ¥
[開始アドレス..終了アドレス]
    java.lang.Thread.State: スレッドの現在のステータス
    stack=[スタック開始アドレス..YellowPageアドレス..RedPageアドレス..¥
スタック終了アドレス]
    [user cpu time=ユーザー時間ms, kernel cpu time=カーネル時間ms] ¥
[blocked count=ブロック回数, waited count=待機回数]
         at クラス名.メソッド名(メソッド情報)
...

出力内容を説明します。

出力項目

出力内容

スレッド名

Threadクラスのコンストラクターに指定されたスレッド名称が出力されます。

スレッド識別子

Javaスレッドが作成されたときに生成される一意の数字が出力されます。

この値は、java.lang.Thread.getId()で取得できる値と同じです。

daemon

デーモンスレッドである場合に、daemonと出力されます。

優先度

Thread#setPriorityで設定された優先度が出力されます。

OS優先度

OSレベルの優先度が出力されます。優先順位が設定できないOSの場合は、0が出力されます。

ハッシュ値

System.identityHashCode()を呼び出して得られる値と同一の値が8桁の16進数で出力されます。

スレッドID

スレッドオブジェクトのメモリー上のアドレスが出力されます。

nativeID

OSレベルのスレッドIDが出力されます。

status

スレッドの状態が出力されます。出力される内容を次に示します。

runnable：実行中または実行可能なスレッド

in Object.wait()、waiting for monitor entryまたはwaiting on condition：モニターロック待ちのスレッド

sleeping：中断状態のスレッド

開始アドレス

Javaフレームの最高位スタックアドレスが16進数で出力されます。

終了アドレス

JavaLockのある最高位スタックアドレスが16進数で出力されます。

スレッドの現在のステータス

スレッドの現在のステータスを表すメッセージが出力されます。メッセージの内容はjava.lang.Thread.State列挙型に対応します。

スタック開始アドレス

スタック開始アドレスが16進数で出力されます。

YellowPageアドレス

スタックYellowガードページ先頭アドレスが16進数で出力されます。

RedPageアドレス

スタックRedガードページ先頭アドレスが16進数で出力されます。

スタック終了アドレス

スタック終了アドレスが16進数で出力されます。

ユーザー時間

スレッド開始からのユーザー時間がミリ秒単位で出力されます。

カーネル時間

スレッド開始からのカーネル時間がミリ秒単位で出力されます。

ブロック回数

スレッド開始から、処理がブロックされた回数が出力されます。

待機回数

スレッド開始から、処理が待ち状態になった回数が出力されます。

クラス名

クラス名が出力されます。

メソッド名

メソッド名が出力されます。

メソッド情報

次のメソッド情報が出力されます。

Native Method

ネイティブメソッドの場合に出力されます。

ファイル名：行番号

Javaメソッドで行番号付きでコンパイルされている場合に出力されます。

Unknown Source

Javaメソッドで行番号なしでコンパイルされている場合に出力されます。

Javaモニターダンプ

Java monitor
------------
ロックオブジェクト@ハッシュコード オーナー情報
   待機状態:待機スレッド数
      待機スレッド情報

出力内容を説明します。

出力項目

出力内容

ロックオブジェクト

ロック対象オブジェクトのクラス名が出力されます。

ハッシュコード

Object.hashCodeで得られるハッシュコードが出力されます。

オーナー情報

owner "スレッド名"スレッドID

オーナーがある場合に出力されます。

no owner

オーナーがない場合に出力されます。

待機状態

... waiting to enter

メソッド実行待ちの場合に出力されます。

... waiting to be notified

通知待ちの場合に出力されます。

待機スレッド数

スレッド数が出力されます。

待機スレッド情報

「"スレッド名>" スレッドID」の形式で出力されます。

JNIグローバル参照数の情報

JNI Information
---------------
JNI global references: JNIグローバル参照数

出力内容を説明します。

出力項目

出力内容

JNIグローバル参照数

JavaVMが保持しているグローバル参照の数が出力されます。

注

JNIグローバル参照はJavaVMの内部でも再利用されるため、JNIがサポートするDeleteGlobalRef関数を発行してJNIグローバル参照を削除しても、数値は減少しません。また、NewGlobalRef関数を発行してJNIグローバル参照を新規作成しても、JavaVMが再利用したJNIグローバル参照を割り当てた場合は数値は増加しません。

Explicitヒープ情報およびExplicitメモリーブロック情報

Explicit Heap Status
--------------------
 max EH_MAX, total EH_TOTAL, used EH_USED, garbage EH_GARB (EH_PER1 used/max, ¥
EH_PER2 used/total, EH_PER3 garbage/used), EM_NUMS spaces exist

 Explicit Memories(EM_MGR_PTR)

  ""EM_NAME"" eid=EID(EM_PTR)/EM_TYPE, total EM_TOTAL, ¥
used EM_USED, garbage EM_GARB (EM_PER1 used/total, EM_PER2 garbage/used, ¥
FL_BLOCKS blocks) EM_STAT
    deployed objects
    ________________Size__Instances__FreeRatio__Class________________
                   ISIZE       INUM     FRATIO CNAME
                   ...
                  AISIZE      AINUM total

...

注意事項を次に示します。

Explicitヒープ情報とExplicitメモリーブロック情報の間には、空行が1行あります。

Explicitメモリーブロック情報の出力順序（どのExplicitメモリーブロックから出力するか）は未定義とします。

EM_NAMEの前には、半角2文字分の空白があります。

deployed objectsの前には、半角4文字分の空白があります。

ISIZEは、_________________Size_の""e""に行末をそろえて記載しています。

INUMは、__Instancesの最後""s""に行末をそろえて記載しています。

FRATIOは、__FreeRatio__の""o""に行末をそろえて記載しています。

CNAMEは、__Class________________の最初から2つ目の""_""に行頭をそろえて記載しています。

最後の行には空行が1行あります。したがって、Explicitメモリーブロックごとの出力の間には空行が1行あります。

フッター

Full thread dump completed.   EEE MMM dd hh:mm:ss yyyy※

注※

EEEは曜日、MMMは月、ddは日を表します。また、hhは時間、mmは分、ssは秒、yyyyは年（西暦）を表します。

拡張スレッドダンプ情報との比較を、次に示します。

表7‒2　標準スレッドダンプと拡張スレッドダンプの出力情報の比較

出力情報

標準スレッドダンプ

拡張スレッドダンプ

ヘッダー

×

○

システム設定

×

○

動作環境

×

○

メモリー情報

×

○

Javaヒープ情報

○

○

JavaVM内部メモリーマップ情報

×

○

JavaVM内部メモリーサイズ情報

×

○

アプリケーション情報

×

○

ライブラリー情報

×

○

スレッド情報

○

○※1

Javaモニターダンプ

×

○

JNIグローバル参照数の情報

○

○

Explicitヒープ情報

×

○※2

Explicitメモリーブロック情報

×

○※2

クラス別統計情報

×

○※3

フッター

×

○

スレッドダンプ出力先

標準出力

標準出力※4

JavaVMログファイル

（凡例）

○：出力します。

×：出力しません。

注※1

スタックの開始および終了のアドレス情報などを出力します。

注※2

-XX:+HitachiUseExplicitMemoryオプションが有効の場合に出力します。

注※3

スレッドダンプの出力契機がjheapprofコマンドの場合に出力します。

注※4

-XX:+HitachiThreadDumpToStdoutオプションが指定された場合に出力します。

書式

-XX:[+|-]HitachiThreadDump

指定できる値

型：String

-XX:+HitachiThreadDump

-Xrsオプションが指定されていない場合、スレッドダンプ出力時に拡張スレッドダンプ情報を出力します。

-XX:-HitachiThreadDump

スレッドダンプ出力時に標準のスレッドダンプ情報を出力します。

デフォルト値

定義項目の省略

-XX:+HitachiThreadDump

出力例

Thu Nov 06 13:56:20 2014

Full thread dump Java HotSpot(TM) 64-Bit Server VM
(25.20-b23-HJDK1010-20141105 mixed mode)
E:¥home¥Binary¥Image¥jdk¥bin¥java.exe  -Xhras -Xms256m -Xmx512m
-XX:+UseCompressedOops -XX:MaxMetaspaceSize=128m Test

System Properties
-----------------
Java Home Dir   : E:¥home¥Binary¥Image¥jdk¥jre
Java DLL Dir    : E:¥home¥Binary¥Image¥jdk¥jre¥bin
Sys Classpath   : E:¥home¥Binary¥Image¥jdk¥jre¥lib¥resources.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥rt.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥sunrsasign.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥jsse.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥jce.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥charsets.jar;
E:¥home¥Binary¥Image¥jdk¥jre¥lib¥jfr.jar;E:¥home¥Binary¥Image¥jdk¥jre¥classes
User Args       :
-Djava.class.path=.
-XX:+HitachiVerboseGC
-XX:+HitachiOutputMilliTime
-XX:+HitachiOutOfMemoryStackTrace
-XX:+HitachiJavaClassLibTrace
-XX:+HitachiLocalsInStackTrace
-XX:+HitachiLocalsSimpleFormat
-XX:+HitachiOutOfMemoryAbort
-XX:-HitachiThreadDumpToStdout
-Xms256m
-Xmx512m
-XX:+UseCompressedOops
-XX:MaxMetaspaceSize=128m
-Dsun.java.command=Test
-Dsun.java.launcher=SUN_STANDARD

Operating Environment
---------------------
Host    : WINDOWS64PC:10.255.255.255
OS      : Microsoft Windows Server 2008 R2 , 64 bit 6.1.7601 Service Pack 1
CPU     : amd64 8664 (Level 6, Rev. 0x2d07), 8/8 active

Memory Status
-------------
        Memory in use   : 72%
        Physical memory : 2387939328 / 8589402112 free
        Virtual memory  : 8794114576384 / 8796092891136 free
        Paging file     : 11622756352 / 17292402688 free

Heap Status
-----------
 def new generation   max 157248K, total 78656K, used 6995K (4.4% used/max,
8.9% used/total)
                      [0x00000000e0000000, 0x00000000e5550000,
0x00000000eaaa0000)
  eden space 69952K,  10% used [0x00000000e0000000, 0x00000000e06d4e18,
0x00000000e4450000)
  from space 8704K,   0% used [0x00000000e4450000, 0x00000000e4450000,
0x00000000e4cd0000)
  to   space 8704K,   0% used [0x00000000e4cd0000, 0x00000000e4cd0000,
 0x00000000e5550000)
 tenured generation   max 349568K, total 174784K, used 0K (0.0% used/max,
0.0% used/total)
                      [0x00000000eaaa0000, 0x00000000f5550000,
0x0000000100000000)
   the space 174784K,   0% used [0x00000000eaaa0000, 0x00000000eaaa0000,
0x00000000eaaa0200, 0x00000000f5550000)
 Metaspace        max 131072K, capacity 4492K, committed 4864K,
reserved 1056768K, used 3738K, (2.9% used/max, 76.9% used/committed)
  class space     max 1048576K, capacity 388K, committed 512K,
reserved 1048576K, used 378K, (0.0% used/max, 74.0% used/committed)
                  [0x0000000011c90000, 0x0000000011cf1000, 0x0000000011d10000,
0x0000000051c90000)

JVM Internal Memory Map
-----------------------
        mmap()   : address = 0x0000000001bb0000 - 0x0000000001bf0000
(size:262144)
        mmap()   : address = 0x0000000001c00000 - 0x0000000001c40000
(size:262144)
        mmap()   : address = 0x00000000024e0000 - 0x0000000002560000
(size:524288)
        mmap()   : address = 0x0000000052490000 - 0x00000000525d0000
(size:1310720)
        mmap()   : address = 0x00000000525f0000 - 0x00000000526b0000
(size:786432)
        mmap()   : address = 0x0000000052800000 - 0x0000000052840000
(size:262144)
        mmap()   : address = 0x0000000052990000 - 0x00000000529d0000
(size:262144)
        mmap()   : address = 0x0000000052db0000 - 0x0000000052e30000
(size:524288)

JVM Internal Memory Status
--------------------------
        Heap Size  : 4358144
        Alloc Size : 3820000
        Free Size  : 538144

Application Environment
-----------------------
Signal Handlers -
        SIGINT          : 0x000000006ab67470
        SIGILL          : default
        SIGFPE          : default
        SIGSEGV         : default
        SIGTERM         : 0x000000006ab67470
        SIGBREAK        : default
        SIGABRT         : default

Environment Variables -
ALLUSERSPROFILE=C:¥ProgramData
APPDATA=C:¥Users¥guest¥AppData¥Roaming
CLIENTNAME=WIN-WINDOWS64PC
CommonProgramFiles=C:¥Program Files¥Common Files
CommonProgramFiles(x86)=C:¥Program Files (x86)¥Common Files
CommonProgramW6432=C:¥Program Files¥Common Files
COMPUTERNAME=WINDOWS64PC
ComSpec=C:¥Windows¥system32¥cmd.exe
COSMINEXUS_HNTRLIB_HOME=C:¥Program Files¥Hitachi¥HNTRLib2
COSMINEXUS_HOME=C:¥Program Files¥Hitachi¥Cosminexus
DXSDK_DIR=C:¥Program Files (x86)¥Microsoft DirectX 9.0 SDK (Summer 2004)¥
FP_NO_HOST_CHECK=NO
HOMEDRIVE=C:
HOMEPATH=¥Users¥guest
LOCALAPPDATA=C:¥Users¥guest¥AppData¥Local
LOGONSERVER=¥¥WINDOWS64PC
NUMBER_OF_PROCESSORS=8
OS=Windows_NT
Path=C:¥cygwin¥bin;C:¥Windows¥system32;C:¥Windows
PATHEXT=.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC
PRFSPOOL=C:¥Program Files¥Hitachi¥Cosminexus¥PRF¥spool
PROCESSOR_ARCHITECTURE=AMD64
PROCESSOR_IDENTIFIER=Intel64 Family 6 Model 45 Stepping 7, GenuineIntel
PROCESSOR_LEVEL=6
PROCESSOR_REVISION=2d07
ProgramData=C:¥ProgramData
ProgramFiles=C:¥Program Files
ProgramFiles(x86)=C:¥Program Files (x86)
ProgramW6432=C:¥Program Files
PROMPT=$P$G
PSModulePath=C:¥Windows¥system32¥WindowsPowerShell¥v1.0¥Modules¥
PUBLIC=C:¥Users¥Public
REPLAY_TEST=1
SESSIONNAME=RDP-Tcp#4
SystemDrive=C:
SystemRoot=C:¥Windows
TEMP=C:¥Users¥guest¥AppData¥Local¥Temp¥16
TMP=C:¥Users¥guest¥AppData¥Local¥Temp¥16
USERDOMAIN=WINDOWS64PC
USERNAME=guest
USERPROFILE=C:¥Users¥guest
VS100COMNTOOLS=c:¥Program Files (x86)¥Microsoft Visual Studio 10.0¥Common7¥
Tools¥
WINDBG=C:¥Program Files¥Debugging Tools for Windows (x64)¥windbg.exe
windir=C:¥Windows
windows_tracing_flags=3
windows_tracing_logfile=C:¥BVTBin¥Tests¥installpackage¥csilogfile.log

Current Directory -
        E:¥home¥guest

Loaded Libraries
----------------
Dynamic libraries:
0x000000013f250000 - 0x000000013f270000 	E:¥home¥Binary¥Image¥jdk¥bin¥
java.exe
0x0000000077890000 - 0x0000000077a39000 	C:¥Windows¥SYSTEM32¥ntdll.dll
0x0000000077670000 - 0x000000007778f000 	C:¥Windows¥system32¥
kernel32.dll
0x000007fefd980000 - 0x000007fefd9ec000 	C:¥Windows¥system32¥
KERNELBASE.dll
0x000007fefddb0000 - 0x000007fefde8b000 	C:¥Windows¥system32¥ADVAPI32.dll
0x000007feff360000 - 0x000007feff3ff000 	C:¥Windows¥system32¥msvcrt.dll
0x000007feff840000 - 0x000007feff85f000 	C:¥Windows¥SYSTEM32¥sechost.dll
0x000007feff0c0000 - 0x000007feff1ed000 	C:¥Windows¥system32¥RPCRT4.dll
0x0000000077790000 - 0x000000007788a000 	C:¥Windows¥system32¥USER32.dll
0x000007fefefc0000 - 0x000007feff027000 	C:¥Windows¥system32¥GDI32.dll
0x000007feff030000 - 0x000007feff03e000 	C:¥Windows¥system32¥LPK.dll
0x000007feff210000 - 0x000007feff2d9000 	C:¥Windows¥system32¥USP10.dll
0x000007fefc1f0000 - 0x000007fefc3e4000 	C:¥Windows¥WinSxS¥amd64_
microsoft.windows.common-controls_6595b64144ccf1df_6.0.7601.17514_none_
fa396087175ac9ac¥COMCTL32.dll
0x000007feff2e0000 - 0x000007feff351000 	C:¥Windows¥system32¥SHLWAPI.dll
0x000000006e1e0000 - 0x000000006e2b1000 	E:¥home¥Binary¥Image¥jdk¥bin¥
MSVCR100.dll
0x000007fefdd80000 - 0x000007fefddae000 	C:¥Windows¥system32¥IMM32.DLL
0x000007feff9f0000 - 0x000007feffaf9000 	C:¥Windows¥system32¥MSCTF.dll
0x000000006dfe0000 - 0x000000006e0b1000 	E:¥home¥Binary¥Image¥jdk¥jre¥
bin¥msvcr100.dll
0x000000006a8c0000 - 0x000000006b13f000 	E:¥home¥Binary¥Image¥jdk¥jre¥
bin¥server¥jvm.dll
0x000007fef8ff0000 - 0x000007fef8ff9000 	C:¥Windows¥system32¥WSOCK32.dll
0x000007fefdba0000 - 0x000007fefdbed000 	C:¥Windows¥system32¥WS2_32.dll
0x000007fefde90000 - 0x000007fefde98000 	C:¥Windows¥system32¥NSI.dll
0x000007fefa870000 - 0x000007fefa8ab000 	C:¥Windows¥system32¥WINMM.dll
0x0000000077a50000 - 0x0000000077a57000 	C:¥Windows¥system32¥PSAPI.DLL
0x000007fef6bc0000 - 0x000007fef6bcf000 	E:¥home¥Binary¥Image¥jdk¥jre¥
bin¥verify.dll
0x000007fef6a20000 - 0x000007fef6a4b000 	E:¥home¥Binary¥Image¥jdk¥jre¥
bin¥java.dll
0x000007fef6850000 - 0x000007fef6866000 	E:¥home¥Binary¥Image¥jdk¥jre¥
bin¥zip.dll
0x000007fefc400000 - 0x000007fefc415000 	C:¥Windows¥system32¥NLAapi.dll
0x000007fef9080000 - 0x000007fef9095000 	C:¥Windows¥system32¥napinsp.dll
0x000007fefcfc0000 - 0x000007fefd015000 	C:¥Windows¥System32¥mswsock.dll
0x000007fefce40000 - 0x000007fefce9b000 	C:¥Windows¥system32¥DNSAPI.dll
0x000007fef9070000 - 0x000007fef907b000 	C:¥Windows¥System32¥winrnr.dll
0x000007fefbb30000 - 0x000007fefbb57000 	C:¥Windows¥system32¥IPHLPAPI.DLL
0x000007fefbb20000 - 0x000007fefbb2b000 	C:¥Windows¥system32¥WINNSI.DLL
0x000007fefb8b0000 - 0x000007fefb903000 	C:¥Windows¥System32¥fwpuclnt.dll
0x000007fefa190000 - 0x000007fefa198000 	C:¥Windows¥system32¥rasadhlp.dll
0x000007fefe230000 - 0x000007fefefb8000 	C:¥Windows¥system32¥SHELL32.dll
0x000007fefdf40000 - 0x000007fefe143000 	C:¥Windows¥system32¥ole32.dll
0x000007fefd790000 - 0x000007fefd79f000 	C:¥Windows¥system32¥profapi.dll

Stack Trace
-----------
"JavaLogRotationTimer" #12 daemon prio=5 os_prio=0 jid=<N/A>
tid=0x0000000052622000 nid=0x2bb78 in Object.wait()
[0x00000000540df000..0x00000000540df520]
   java.lang.Thread.State: TIMED_WAITING (on object monitor)
  stack=
[0x00000000540e0000..0x0000000053fe4000..0x0000000053fe1000..0x0000000053fe0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=1, waited count=2]
	at java.lang.Object.wait(Native Method)
	- waiting on <0x00000000e0087358> (a java.util.TaskQueue)
	  locals:
	    (java.lang.Object) this = <0x00000000e0087358>
	    (long) [arg1] = 36223964
	at java.util.TimerThread.mainLoop(Timer.java:552)
	- locked <0x00000000e0087358> (a java.util.TaskQueue)
	  locals:
	    (java.util.TimerThread) this = <0x00000000e00876d0>
	    (java.util.TimerTask) task = <0x00000000e00ecc18>
	    (boolean) taskFired = false
	    (long) currentTime = 1415249776949
	    (long) executionTime = 1415286000913
	at java.util.TimerThread.run(Timer.java:505)
	  locals:
	    (java.util.TimerThread) this = <0x00000000e00876d0>

"Service Thread" #11 daemon prio=9 os_prio=0 jid=<N/A> tid=0x000000005261b000
nid=0x1d04c runnable [0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x0000000053ba0000..0x0000000053aa4000..0x0000000053aa1000..0x0000000053aa0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"C1 CompilerThread3" #10 daemon prio=9 os_prio=2 jid=<N/A>
tid=0x000000005258e800 nid=0x3ad64 waiting on condition
[0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x0000000053a30000..0x0000000053934000..0x0000000053931000..0x0000000053930000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"C2 CompilerThread2" #9 daemon prio=9 os_prio=2 jid=<N/A>
tid=0x0000000052581800 nid=0x1eaa8 waiting on condition
[0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x00000000538d0000..0x00000000537d4000..0x00000000537d1000..0x00000000537d0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"C2 CompilerThread1" #8 daemon prio=9 os_prio=2 jid=<N/A>
tid=0x0000000052575800 nid=0x3cf68 waiting on condition
[0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x0000000053710000..0x0000000053614000..0x0000000053611000..0x0000000053610000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"C2 CompilerThread0" #7 daemon prio=9 os_prio=2 jid=<N/A>
tid=0x000000005256e800 nid=0x3f304 waiting on condition
[0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x00000000534b0000..0x00000000533b4000..0x00000000533b1000..0x00000000533b0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"Attach Listener" #6 daemon prio=5 os_prio=2 jid=<N/A> tid=0x000000005256c000
nid=0xb93c runnable [0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x00000000532c0000..0x00000000531c4000..0x00000000531c1000..0x00000000531c0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"Signal Dispatcher" #5 daemon prio=9 os_prio=2 jid=<N/A> tid=0x0000000052569800
nid=0x1b6ac waiting on condition [0x0000000000000000..0x0000000000000000]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x0000000052990000..0x0000000052894000..0x0000000052891000..0x0000000052890000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]

"FinalizerWatcherThread" #4 daemon prio=5 os_prio=0 jid=<N/A>
tid=0x000000005253f000 nid=0x6f70 waiting on condition
[0x00000000530ef000..0x00000000530ef530]
   java.lang.Thread.State: TIMED_WAITING (sleeping)
  stack=
[0x00000000530f0000..0x0000000052ff4000..0x0000000052ff1000..0x0000000052ff0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=0]
	at java.lang.Thread.sleep(Native Method)
	  locals:
	    (long) [arg1] = 60000
	at java.lang.ref.Finalizer$FinalizerWatcherThread.run
(Finalizer.java:300)
	  locals:
	    (java.lang.ref.Finalizer$FinalizerWatcherThread)
this = <0x00000000e0063700>
	    (int) interval = 60000
	    (java.lang.String) prop = (null)
	    (java.lang.Object) oldObj = (null)
	    (java.lang.Object) newObj = (null)
	    (long) length = 0

"Finalizer" #3 daemon prio=8 os_prio=1 jid=<N/A> tid=0x0000000002559800
nid=0xd50c in Object.wait() [0x0000000052f2e000..0x0000000052f2f240]
   java.lang.Thread.State: WAITING (on object monitor)
  stack=
[0x0000000052f30000..0x0000000052e34000..0x0000000052e31000..0x0000000052e30000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=3, waited count=2]
	at java.lang.Object.wait(Native Method)
	- waiting on <0x00000000e0006460> (a java.lang.ref.ReferenceQueue$Lock)
	  locals:
	    (java.lang.Object) this = <0x00000000e0006460>
	    (long) [arg1] = 0
	at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:143)
	- locked <0x00000000e0006460> (a java.lang.ref.ReferenceQueue$Lock)
	  locals:
	    (java.lang.ref.ReferenceQueue) this = <0x00000000e0006440>
	    (long) timeout [arg1] = 0
	    (java.lang.ref.Reference) r = (null)
	at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:159)
	  locals:
	    (java.lang.ref.ReferenceQueue) this = <0x00000000e0006440>
	at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:222)
	  locals:
	    (java.lang.ref.Finalizer$FinalizerThread) this = <0x00000000e0006510>
	    (sun.misc.JavaLangAccess) jla = <0x00000000e0063218>

"Reference Handler" #2 daemon prio=10 os_prio=2 jid=<N/A>
tid=0x0000000002551000 nid=0xd6b8 in Object.wait()
[0x0000000052daf000..0x0000000052daf3d0]
   java.lang.Thread.State: WAITING (on object monitor)
  stack=
[0x0000000052db0000..0x0000000052cb4000..0x0000000052cb1000..0x0000000052cb0000]
  [user cpu time=0ms, kernel cpu time=0ms] [blocked count=0, waited count=1]
	at java.lang.Object.wait(Native Method)
	- waiting on <0x00000000e0005ed0> (a java.lang.ref.Reference$Lock)
	  locals:
	    (java.lang.Object) this = <0x00000000e0005ed0>
	    (long) [arg1] = 0
	at java.lang.Object.wait(Object.java:502)
	  locals:
	    (java.lang.Object) this = <0x00000000e0005ed0>
	at java.lang.ref.Reference$ReferenceHandler.run(Reference.java:157)
	- locked <0x00000000e0005ed0> (a java.lang.ref.Reference$Lock)
	  locals:
	    (java.lang.ref.Reference$ReferenceHandler)
this = <0x00000000e0005f50>

"main" #1 prio=5 os_prio=0 jid=<N/A> tid=0x0000000001bba800
nid=0x25244 waiting on condition [0x000000000281e000..0x000000000281fa00]
   java.lang.Thread.State: TIMED_WAITING (sleeping)
  stack=
[0x0000000002820000..0x0000000002724000..0x0000000002721000..0x0000000002720000]
  [user cpu time=140ms, kernel cpu time=31ms] [blocked count=0, waited count=0]
	at java.lang.Thread.sleep(Native Method)
	  locals:
	    (long) [arg1] = 5000
	at Test.main(Test.java:5)
	  locals:
	    (java.lang.String[]) args [arg1] = <0x00000000e00f00f0>
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	  locals:
	    (java.lang.reflect.Method) [arg1] = <0x00000000e00f0170>
	    (java.lang.Object) [arg2] = (null)
	    (java.lang.Object[]) [arg3] = <0x00000000e00f01c8>
	at sun.reflect.NativeMethodAccessorImpl.invoke
(NativeMethodAccessorImpl.java:62)
	  locals:
	    (sun.reflect.NativeMethodAccessorImpl) this = <0x00000000e00f0250>
	    (java.lang.Object) obj [arg1] = (null)
	    (java.lang.Object[]) args [arg2] = <0x00000000e00f01c8>
	at sun.reflect.DelegatingMethodAccessorImpl.invoke
(DelegatingMethodAccessorImpl.java:43)
	  locals:
	    (sun.reflect.DelegatingMethodAccessorImpl)
this = <0x00000000e00f02d8>
	    (java.lang.Object) obj [arg1] = (null)
	    (java.lang.Object[]) args [arg2] = <0x00000000e00f01c8>
	at java.lang.reflect.Method.invoke(Method.java:483)
	  locals:
	    (java.lang.reflect.Method) this = <0x00000000e00f0170>
	    (java.lang.Object) obj [arg1] = (null)
	    (java.lang.Object[]) args [arg2] = <0x00000000e00f01c8>
	    (sun.reflect.MethodAccessor) ma = <0x00000000e00f02d8>
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.execJava(Java_hras.java:53)
	  locals:
	    (JP.co.Hitachi.soft.jvm.tools.Java_hras)
this = <0x00000000e00f00d8>
	    (java.lang.ClassLoader) loader = <0x00000000e0080f58>
	    (java.lang.Class) klazz = <0x00000000e00ef170>
	    (java.lang.reflect.Method) m = <0x00000000e00f0170>
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.main(Java_hras.java:40)
	  locals:
	    (java.lang.String[]) args [arg1] = <0x00000000e00efd68>
	    (java.lang.String) className [arg2] = <0x00000000e00efd38>

"VM Thread" os_prio=2 tid=0x0000000002549800 nid=0xdfc runnable

"VM Periodic Task Thread" os_prio=2 tid=0x000000005261f000
nid=0x240a4 waiting on condition

Java monitor
------------
java.util.TaskQueue@0x00000000e0087358 no owner
    waiting to be notified: 1
        "JavaLogRotationTimer" 0x0000000052622000
java.lang.ref.ReferenceQueue$Lock@0x00000000e0006460 no owner
    waiting to be notified: 1
        "Finalizer" 0x0000000002559800
java.lang.ref.Reference$Lock@0x00000000e0005ed0 no owner
    waiting to be notified: 1
        "Reference Handler" 0x0000000002551000

JNI Information
---------------
JNI global references: 7

Full thread dump completed.   Thu Nov 06 13:56:20 2014

注意事項

環境変数JAVACOREDIRで指定したディレクトリーへの出力に失敗した場合、カレントディレクトリーに出力されます。

カレントディレクトリーへの出力に失敗した場合、標準エラー出力に出力されます。なお、この場合、スレッドダンプは標準出力に出力されません。

次に示すオプションの[+|-]指定が「-」の場合、スレッド情報の一部が出力されないのでご注意ください。

オプション名称

出力されない情報

-XX:[+|-]HitachiThreadDumpWithHashCode

ハッシュ値

-XX:[+|-]HitachiThreadDumpWithCpuTime

ユーザー時間、カーネル時間

-XX:[+|-]HitachiThreadDumpWithBlockCount

ブロック回数、待機回数

7.3.2　-XX:[+|-]HitachiThreadDumpToStdout

拡張スレッドダンプを標準出力へ出力します。

説明

拡張スレッドダンプを標準出力へ出力するかどうかを指定します。

このオプションの指定に関係なく、次のメッセージは出力されます。また、拡張スレッドダンプはJavaVMログファイルへ出力されます。

Writing Java core to ファイル名※... OK

注※

絶対パス

前提オプション

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiThreadDumpToStdout

指定できる値

型：String

-XX:+HitachiThreadDumpToStdout

拡張スレッドダンプを標準出力およびスレッドダンプ出力ファイルに出力します。

-XX:-HitachiThreadDumpToStdout

拡張スレッドダンプを標準出力に出力しません。スレッドダンプ出力ファイルだけに出力します。

デフォルト値

定義項目の省略

-XX:+HitachiThreadDumpToStdout

注意事項

環境変数JAVACOREDIRで指定したディレクトリーへの出力に失敗した場合、カレントディレクトリーに出力されます。

カレントディレクトリーへの出力に失敗した場合、標準エラー出力に出力されます。なお、この場合、スレッドダンプは標準出力に出力されません。

次に示すオプションの[+|-]指定が「-」の場合、スレッド情報の一部が出力されないのでご注意ください。

オプション名称

出力されない情報

-XX:[+|-]HitachiThreadDumpWithHashCode

ハッシュ値

-XX:[+|-]HitachiThreadDumpWithCpuTime

ユーザー時間、カーネル時間

-XX:[+|-]HitachiThreadDumpWithBlockCount

ブロック回数、待機回数

7.3.3　-XX:[+|-]HitachiThreadDumpWithBlockCount

拡張スレッドダンプのスレッド情報に、スレッドが処理をブロックした回数と待ち状態になった回数を出力します。

説明

拡張スレッドダンプのスレッド情報に、スレッドが処理をブロックした回数と待ち状態になった回数を出力するかどうかを指定します。

なお、ハッシュコードは、Javaプログラムを実行しているスレッドに対して出力されます。JavaVMの内部動作用スレッドに対しては出力されません。

前提オプション

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiThreadDumpWithBlockCount

指定できる値

型：String

-XX:+HitachiThreadDumpWithBlockCount

拡張スレッドダンプのスレッド情報に、スレッドが処理をブロックした回数と待ち状態になった回数を出力します。

-XX:-HitachiThreadDumpWithBlockCount

拡張スレッドダンプのスレッド情報に、スレッドが処理をブロックした回数と待ち状態になった回数を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiThreadDumpWithBlockCount

注意事項

環境変数JAVACOREDIRで指定したディレクトリーへの出力に失敗した場合、カレントディレクトリーに出力されます。

カレントディレクトリーへの出力に失敗した場合、標準エラー出力に出力されます。なお、この場合、スレッドダンプは標準出力に出力されません。

次に示すオプションの[+|-]指定が「-」の場合、スレッド情報の一部が出力されないのでご注意ください。

オプション名称

出力されない情報

-XX:[+|-]HitachiThreadDumpWithHashCode

ハッシュ値

-XX:[+|-]HitachiThreadDumpWithCpuTime

ユーザー時間、カーネル時間

-XX:[+|-]HitachiThreadDumpWithBlockCount

ブロック回数、待機回数

7.3.4　-XX:[+|-]HitachiThreadDumpWithCpuTime

拡張スレッドダンプのスレッド情報に、ユーザーCPU時間とカーネルCPU時間を出力します。

説明

拡張スレッドダンプのスレッド情報に、ユーザーCPU時間とカーネルCPU時間を出力するかどうかを指定します。

なお、ユーザーCPU時間とカーネルCPU時間は、Javaプログラムを実行しているスレッドに対して出力されます。JavaVMの内部動作用スレッドに対しては出力されません。

前提オプション

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiThreadDumpWithCpuTime

指定できる値

型：String

-XX:+HitachiThreadDumpWithCpuTime

拡張スレッドダンプのスレッド情報に、スレッド開始からのユーザーCPU時間とカーネルCPU時間を出力します。

-XX:-HitachiThreadDumpWithCpuTime

拡張スレッドダンプのスレッド情報に、スレッド開始からのユーザーCPU時間とカーネルCPU時間を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiThreadDumpWithCpuTime

注意事項

環境変数JAVACOREDIRで指定したディレクトリーへの出力に失敗した場合、カレントディレクトリーに出力されます。

カレントディレクトリーへの出力に失敗した場合、標準エラー出力に出力されます。なお、この場合、スレッドダンプは標準出力に出力されません。

次に示すオプションの[+|-]指定が「-」の場合、スレッド情報の一部が出力されないのでご注意ください。

オプション名称

出力されない情報

-XX:[+|-]HitachiThreadDumpWithHashCode

ハッシュ値

-XX:[+|-]HitachiThreadDumpWithCpuTime

ユーザー時間、カーネル時間

-XX:[+|-]HitachiThreadDumpWithBlockCount

ブロック回数、待機回数

7.3.5　-XX:[+|-]HitachiThreadDumpWithHashCode

拡張スレッドダンプのスレッド情報にハッシュコードを出力します。

説明

拡張スレッドダンプのスレッド情報にハッシュコードを出力するかどうかを指定します。

なお、ハッシュコードは、Javaプログラムを実行しているスレッドに対して出力されます。JavaVMの内部動作用スレッドに対しては出力されません。

前提オプション

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiThreadDumpWithHashCode

指定できる値

型：String

-XX:+HitachiThreadDumpWithHashCode

拡張スレッドダンプのスレッド情報にハッシュコードを出力します。

-XX:-HitachiThreadDumpWithHashCode

拡張スレッドダンプのスレッド情報にハッシュコードを出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiThreadDumpWithHashCode

注意事項

環境変数JAVACOREDIRで指定したディレクトリーへの出力に失敗した場合、カレントディレクトリーに出力されます。

カレントディレクトリーへの出力に失敗した場合、標準エラー出力に出力されます。なお、この場合、スレッドダンプは標準出力に出力されません。

次に示すオプションの[+|-]指定が「-」の場合、スレッド情報の一部が出力されないのでご注意ください。

オプション名称

出力されない情報

-XX:[+|-]HitachiThreadDumpWithHashCode

ハッシュ値

-XX:[+|-]HitachiThreadDumpWithCpuTime

ユーザー時間、カーネル時間

-XX:[+|-]HitachiThreadDumpWithBlockCount

ブロック回数、待機回数

7.4　JavaVMログファイルで使用するJavaVMオプション

標準のJavaVMよりも多くのトラブルシュート情報を出力するためのオプションを説明しています。

7.4.1　-XX:HitachiJavaLog

JavaVMログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

説明

JavaVMログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

同じカレントディレクトリーで複数のJavaVMプロセスを同時に実行した場合や、-XX:HitachiJavaLog:オプションで同じログ出力先を指定した複数のJavaVMプロセスを同時に実行した場合、JavaVMログファイルに情報が正しく出力されません。複数のJavaVMプロセスを実行する場合は、-XX:HitachiJavaLog:オプションでプロセスごとにログ出力先が異なるようにパスを指定してください。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:HitachiJavaLog:文字列

指定できる値

文字列

型：String

プリフィクスおよびパスを指定します。このオプションを指定しない場合、文字列には、"javalog"が設定されます。プリフィクス以下のファイル名称は、JavaVMログファイルのローテーション方式によって異なります。

JavaVMログファイルのローテーション方式がラップアラウンド方式の場合、ログファイル名は、文字列??.log（??は01〜99の通し番号）で生成されます。例えば、文字列に"Samp"を指定すると、ログファイル名はSamp01.logになります。

JavaVMログファイルのローテーション方式がシフト方式の場合、出力対象となるカレントログファイルとバックアップファイルが生成されます。カレントログファイルは文字列.log、バックアップログファイルは文字列??.log（??は01〜98の通し番号）で生成されます。例えば、文字列に"Samp"を指定すると、カレントログファイル名はSamp.log、カレントログファイルがバックアップされると、バックアップログファイル名はSamp01.logになります。

プリフィクスおよびパスには次の3種類の指定ができます。

プリフィクスを指定する場合

指定した文字列のファイル名でカレントディレクトリーに出力されます。

パスを指定する場合

文字列にディレクトリーを指定した場合、そのディレクトリーにデフォルトの"javalog"でファイルが作成されます。

パスとプリフィクスを同時に指定する場合

文字列にディレクトリーとプリフィクスを指定した場合、そのディレクトリーにファイルが作成されます。例えば、文字列に"d:¥temp¥Samp"を指定すると、d:¥tempディレクトリーに、ラップアラウンド方式ではSamp01.log、シフト方式ではSamp.logが生成されます。

デフォルト値

定義項目の省略

-XX:HitachiJavaLog:javalog

7.4.2　-XX:HitachiJavaLogFileSize

JavaVMログファイルの1ファイル当たりの最大ファイルサイズを指定します。

説明

ログファイルの単純増加を防ぐため、1ファイルの最大ファイルサイズを指定します。最大ファイルサイズを超えた場合は、そのファイルへは出力しません。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:HitachiJavaLogFileSize=整数値

指定できる値

整数値

型：Integer

8192〜2147483647の範囲で整数値（単位：バイト）を指定します。範囲外の値が指定された場合は8192が設定されます。負の値を指定した場合はエラーとなります。

デフォルト値

定義項目の省略

ラップアラウンド方式の場合

-XX:HitachiJavaLogFileSize=256k

シフト方式の場合

-XX:HitachiJavaLogFileSize=128M

7.4.3　-XX:[+|-]HitachiJavaLogNoMoreOutput

ログファイル作成時に入出力エラーが発生した場合の、ログ情報の出力方法を指定します。

説明

ログファイル作成時に入出力エラーが発生した場合に、ログ情報の出力方法について指定します。なお、どちらを指定した場合も、JavaVMの処理は継続されます。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiExplicitMemoryLogLevel:none以外

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:[+|-]HitachiJavaLogNoMoreOutput

指定できる値

型：String

-XX:+HitachiJavaLogNoMoreOutput

ログファイル出力時にファイル入出力エラーが発生した場合、次のメッセージを標準エラー出力に出力し、ログ情報の出力を停止します。

Java logfile output failed.(errno=エラーとなった入出力関数名:エラー番号)

-XX:-HitachiJavaLogNoMoreOutput

ログファイル出力時にファイル入出力エラーが発生した場合、次のメッセージを標準エラー出力に出力し、ログ情報の出力先を標準エラー出力に変更して出力を継続します。

Java logfile output failed.(errno=エラーとなった入出力関数名:エラー番号)
Changing output to stderr

デフォルト値

定義項目の省略

-XX:+HitachiJavaLogNoMoreOutput

7.4.4　-XX:HitachiJavaLogNumberOfFile

JavaVMログファイルの作成する最大ファイル数を指定します。

説明

ログファイルの単純増加を防ぐため、作成する最大ファイル数を指定します。

ローテーション方式がラップアラウンド方式で最大ファイル数を超えた場合は、再度最初に作成したファイルへ出力します。

ローテーション方式がシフト方式で最大ファイル数を超えた場合は、いちばん古いバックアップファイルを削除します。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:HitachiJavaLogNumberOfFile=整数値

指定できる値

整数値

型：Integer

1〜99の範囲で指定します。100以上の値が指定された場合は99が、0が指定された場合は1が設定されます。負の値を指定した場合はエラーとなります。

デフォルト値

定義項目の省略

ラップアラウンド方式の場合

-XX:HitachiJavaLogNumberOfFile=4

シフト方式の場合

-XX:HitachiJavaLogNumberOfFile=8

7.4.5　-XX:[+|-]JavaLogAsynchronous

ログファイルの非同期出力機能の有効または無効を設定します。

説明

ログファイルの非同期出力機能の有効、無効を指定します。

ログファイルの非同期出力機能使用時、-XX:HitachiOutOfMemoryStackTraceLineSizeオプション、または-XX:HitachiJavaClassLibTraceLineSizeオプションに、4096より大きな値を指定した場合は、出力するスタックトレース1行の文字数に4096バイトが指定されたものとして動作します。指定したバイト数が確保できない場合は警告メッセージが出力され、スタックトレースは出力されません。また、1行の文字数が指定した文字数を超えた場合、「at」以降の文字列の前半部分を削除して、指定された文字数分出力します。

書式

-XX:[+|-]JavaLogAsynchronous

指定できる値

型：String

-XX:+JavaLogAsynchronous

ログファイルの非同期出力機能を有効にします。

-XX:-JavaLogAsynchronous

ログファイルの非同期出力機能を無効にします。

デフォルト値

定義項目の省略

-XX:-JavaLogAsynchronous

7.4.6　-XX:[+|-]JavaLogHeaderOutput

JavaVMログファイルのオープン時にヘッダー情報を出力します。

説明

JavaVMログファイルのオープン時にヘッダー情報を出力するかどうかを指定します。ヘッダー情報は、1行目にJavaVMのバージョン情報、2行目に起動コマンドライン情報で構成されます。-XX:HitachiJavaLogFileSizeオプションで1ファイルの最大ファイルサイズを指定する場合は、出力されるヘッダー情報のサイズを考慮して指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

ローテーション方式がシフト方式の場合、JavaVMの起動時にJavaVMログファイルを追記モードでオープンします。そのため、JavaVMの開始と停止を繰り返すと、JavaVMの実行ごとに出力されたログ情報が、1つのJavaVMログファイルに書き込まれます。このオプションが有効な場合は、ヘッダー情報でJavaVMが起動したタイミングを確認でき、JavaVMの実行ごとに出力されたログ情報を切り分けられますが、このオプションが無効な場合は、JavaVMの実行ごとに出力されたログ情報の切り分けが難しくなります。そのため、このオプションは有効にすることをお勧めします。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiExplicitMemoryLogLevel:none以外

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:[+|-]JavaLogHeaderOutput

指定できる値

型：String

-XX:+JavaLogHeaderOutput

JavaVMログファイルのオープン時にヘッダー情報を出力します。

-XX:-JavaLogHeaderOutput

JavaVMログファイルのオープン時にヘッダー情報を出力しません。

デフォルト値

値の省略

-XX:+JavaLogHeaderOutput

出力例

[JVM]<Fri May 30 19:27:24 2014>Java HotSpot(TM) 64-Bit Server VM
(24.51-b03-HJDK1000-20140529) for windows-amd64 JRE
(1.7.0_51-b13-HJDK1000-20140529), built on May 29 2014 16:04:41 by "Java"
with unknown MS VC++:1600
[JVM]Command : C:¥Hitachi¥APServer¥jdk¥bin¥java.exe
-Djava.class.path=. -XX:+HitachiVerboseGC HelloWorld

7.4.7　-XX:JavaLogRotationTime

JavaVMログファイルのローテーション時刻を指定します。

説明

JavaVMログファイルのローテーション方式がシフト方式の場合に、出力先ファイルを切り替える時刻をこのオプションで指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。このオプションに指定した時刻になったタイミングで、JavaVMログファイルを切り替えます。このオプションの指定がない場合、または範囲外の値が指定された場合は、デフォルトの00時00分00秒になったタイミングでログファイルを切り替えます。 ラップアラウンド方式（-XX:JavaLogRotationType:WRAP）の場合、時刻による出力先ファイルの切り替えは動作しません。

OSのリソースの負荷や、GC実行中でスレッドが停止状態の場合など、状況によっては、出力先ファイルを切り替えるタイミングが、指定した時刻よりも数ミリ秒〜数秒遅れることがあります。切り替え時刻が遅れた場合でも、次回は指定した時刻になったタイミングで切り替えるため、切り替えタイミングの遅れが蓄積されていくことはありません。

また、バックアップログとカレントログファイルに出力するログ情報の出力時間についても、切り替えタイミングの遅れによって誤差が出ます。例えば、このオプションに000000（00時00分00秒）を指定した場合、2ファイルにわたって00時00分00秒前後のログ情報が出力されることがあります。ログファイルの非同期出力機能を使用した場合、ログ出力専用のスレッドで非同期にログファイルへ出力するため、この切り替え時間とログ情報の出力時間の誤差が出るおそれがあります。

出力先ファイルの切り替えは、毎日指定した時刻に実行されますが、指定した時刻が現時刻よりも前であった場合は、翌日の同時刻にJavaVMログファイルを切り替えます。例えば、このオプションに144500（14時45分00秒）を指定して、2014/2/12 15:00:00にjavaを起動した場合、2014/2/13 14:45:00にJavaVMログファイルを切り替えます。

前提オプション

次のオプションを指定します。

-XX:JavaLogRotationType:SHIFT

書式

-XX:JavaLogRotationTime:適用範囲

指定できる値

適用範囲

型：Integer

時刻を指定します。時刻は000000〜235959のHHMMSS形式で指定します。コロンなどの区切り文字は入れないで、数字6文字で指定してください。範囲外の不正な時刻値が指定された場合は、デフォルト値が設定されます。

デフォルト値

定義項目の省略

-XX:JavaLogRotationTime:000000

値の省略

-XX:JavaLogRotationTime:000000

7.4.8　-XX:JavaLogRotationType

JavaVMログファイルのローテーション方式を指定します。

説明

JavaVMログファイルのローテーション方式を指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:+JITCompilerContinuation

-XX:+StandardLogToHitachiJavaLog

書式

-XX:JavaLogRotationType:文字列

指定できる値

文字列

型：String

WRAP

JavaVMログファイルのローテーション方式にラップアラウンド方式を設定します。

SHIFT

JavaVMログファイルのローテーション方式にシフト方式を設定します。

このオプションを指定しない場合、または｢WRAP｣、 ｢SHIFT｣以外の値を指定した場合、デフォルトのシフト方式が設定されます。

デフォルト値

定義項目の省略

-XX:JavaLogRotationType:SHIFT

値の省略

-XX:JavaLogRotationType:SHIFT

7.4.9　-XX:[+|-]StandardLogToHitachiJavaLog

JavaVMの標準出力と標準エラー出力の内容をJavaVMログファイルに出力します。

説明

JavaVMからの標準出力と標準エラーへの出力結果をJavaVMログファイルに出力します。障害発生時のトラブルシュートのためにこの機能を使用します。通常の運用では使用しません。

この機能を有効にした場合、JavaVMの標準出力と標準エラー出力の内容をJavaVMログファイルにも併せて出力します。

出力形式

[id]<date>stdout

出力項目

出力内容

id

識別子です。標準出力の場合は[STO]、標準エラー出力の場合は[STE]を出力します。

date

ログ出力開始時間です。-XX:+HitachiOutputMilliTimeオプションが指定されている場合は、ミリ秒単位まで出力します。

stdout

標準出力または標準エラー出力のメッセージ内容です。

出力したメッセージの内容が次の場合、上記の出力形式と異なる形式で出力します。

出力したメッセージ文字列が2,000バイトを超えていて、かつ文字列の最後に改行（¥n）がある場合、次の行に空行を出力します。

出力対象のメッセージ文字列の途中に改行がある場合、改行したあとのメッセージには識別子やログ出力開始時間を出力しません。

書式

-XX:[+|-]StandardLogToHitachiJavaLog

指定できる値

型：String

-XX:+StandardLogToHitachiJavaLog

JavaVMが標準出力や標準エラーに出力するメッセージをJavaVMログファイルに出力します。

-XX:-StandardLogToHitachiJavaLog

JavaVMが標準出力や標準エラーに出力するメッセージをJavaVMログファイルに出力しません。

オプションを複数指定した場合は、最後に指定した値が適用されます。

デフォルト値

定義項目の省略

-XX:-StandardLogToHitachiJavaLog

出力例

[STO]<Fri Jun 19 11:31:40 2015>VM option '+StandardLogToHitachiJavaLog'
[STO]<Fri Jun 19 11:31:40 2015>VM option '+PrintVMOptions'
[STE]<Fri Jun 19 11:31:40 2015>Invalid initial young generation size: -Xmn0k

7.5　詳細時間出力で使用するJavaVMオプション

JavaVMログに出力する時間の形式を設定するためのオプションを説明しています。

7.5.1　-XX:[+|-]HitachiOutputMilliTime

JavaVMログファイルに出力する日時を、ミリ秒まで出力します。

説明

ミリ秒までの時間を出力するかどうかを指定します。このオプションの設定は、JavaVMログファイルと明示管理ヒープのログファイルの両方が対象となります。

前提オプション

次のどれかを指定します。

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJITCompileMaxMemorySize=数値（数値が1以上の場合）

-XX:HitachiExplicitMemoryLogLevel:none以外

-XX:+JITCompilerContinuation

-XX:+PrintCodeCacheInfo

-XX:+PrintCodeCacheFullMessage

-XX:+StandardLogToHitachiJavaLog

書式

-XX:[+|-]HitachiOutputMilliTime

指定できる値

型：String

-XX:+HitachiOutputMilliTime

JavaVMログファイルに出力する日時に、ミリ秒まで出力します。

-XX:-HitachiOutputMilliTime

JavaVMログファイルに出力する日時に、秒まで出力します。

デフォルト値

定義項目の省略

-XX:-HitachiOutputMilliTime

出力例

拡張verbosegc情報の出力

[VGC]<Fri Feb 06 14:09:04.661 2015>[GC 5339K->3061K(8256K), 0.0019990 secs]
[DefNew::Eden: 2688K->0K(2688K)][DefNew::Survivor: 0K->64K(64K)]
[Tenured: 2651K->2997K(5504K)]
[Metaspace: 9753K(10808K, 10880K)->9753K(10808K, 10880K)]
[class space: 3612K(3708K, 3712K)->3612K(3708K, 3712K)]
[cause:ObjAllocFail][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 8685K, 14240K, 0K][TC: 10][DOE: 0K, 0][CCI: 791K, 49152K, 2496K]

OutOfMemoryError発生時の出力

[OOM][Thread: 0x00957820]<Wed Mar 17 00:47:00.662 2004>
[java.lang.OutOfMemory Error :(C Heap) :340]

クラスライブラリートレースの出力

[CLT][Thread: 0x00286348]<Wed Mar 17 00:47:00.662 2004>
[CLT][Thread: 0x00286348] at java.lang.Shutdown.halt0(Native Method)
[CLT][Thread: 0x00286348] at java.lang.Shutdown.halt(Shutdown.java:145)

JITコンパイラー稼働継続機能（JITコンパイル失敗情報）

[JCC][Thread: 0x05432c00]<Thu Nov 15 17:10:40.347 2012>
[Method: chosa_cmp.func(Ljava/lang/String;)V][Fail: 3][JITCT: 1]

JavaVMの標準出力のJavaVMログファイルへの出力機能

[STO]<Mon Jun 22 12:09:45.676 2015>VM option '+HitachiOutputMilliTime'
[STO]<Mon Jun 22 12:09:45.676 2015>VM option '+PrintVMOptions'
[STO]<Mon Jun 22 12:09:45.677 2015>VM option '+StandardLogToHitachiJavaLog'
[STE]<Mon Jun 22 12:09:45.677 2015>Invalid initial young generation size: -Xmn0k

7.6　拡張verbosegc機能で使用するJavaVMオプション

GC発生時に出力する拡張verbosegc情報の出力を設定するためのオプションを説明しています。

7.6.1　-XX:[+|-]HitachiCommaVerboseGC

拡張verbosegc情報をCSV形式で出力します。

説明

拡張verbosegc情報をCSV形式で出力するかどうかを指定します。

前提オプション

-XX:+HitachiVerboseGC

出力形式（SerialGCの場合）

-XX:-HitachiVerboseGCIntervalTimeオプション指定時の出力形式

id,date,full_count,copy_count,gc_kind,gc_info,gc_time,eden_info,
survivor_info,tenured_info,metaspace_info,classspace_info,cause_info,
user_cpu,system_cpu,jvm_alloc_size,mmap_total_size,malloc_total_size,
thread_count,doe_alloc_size,called_count,cc_used_size,cc_max_size,cc_info

出力内容を次に説明します。

出力項目

出力内容

id

JavaVMログファイル識別子。

date

GC開始日時。-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

full_count

FullGC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

copy_count

CopyGC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

gc_kind

GC種別。FullGCまたはGCが出力されます。

gc_info

GC情報。次の形式で出力されます。単位はキロバイトです。

GC前の領域長,GC後の領域長,領域サイズ

gc_time

GC経過時間。単位は秒です。

eden_info

Eden情報。次の形式で出力されます。単位はキロバイトです。

GC前の領域長,GC後の領域長,領域サイズ

survivor_info

Survivor情報。次の形式で出力されます。単位はキロバイトです。

GC前の領域長,GC後の領域長,領域サイズ

tenured_info

Tenured情報。次の形式で出力されます。単位はキロバイトです。

GC前の領域長,GC後の領域長,領域サイズ

metaspace_info

Metaspace情報。次の形式で出力されます。単位はキロバイトです。

GC前のMetaspace領域の使用サイズ,GC前のMetaspace領域のcapacityサイズ,GC前のMetaspace領域のcommitサイズ,GC後のMetaspace領域の使用サイズ,GC後のMetaspace領域のcapacityサイズ,GC後のMetaspace領域のcommitサイズ

classspace_info

Compressed Class Space情報。次の形式で出力されます。単位はキロバイトです。

GC前のCompressed Class Spaceの使用サイズ,GC前のCompressed Class Spaceのcapacityサイズ,GC前のCompressed Class Spaceのcommitサイズ,GC後のCompressed Class Spaceの使用サイズ,GC後のCompressed Class Spaceのcapacityサイズ,GC後のCompressed Class Spaceのcommitサイズ

圧縮オブジェクトポインター機能を使用していない場合、それぞれのサイズには0が出力されます。

cause_info

GC要因番号。

-XX:-HitachiVerboseGCPrintCauseオプションが指定された場合、出力されません。

user_cpu

GCスレッドがユーザーモードで費やしたCPU時間。単位は秒です。

CPU時間の取得に失敗した場合はunknownと表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

system_cpu

GCスレッドがカーネルモードで費やしたCPU時間。単位は秒です。

CPU時間の取得に失敗した場合はunknownと表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

jvm_alloc_size

JavaVM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。単位はキロバイトです。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

mmap_total_size

JavaVM内部で管理している領域のうち、VirtualAllocで割り当てたCヒープの総サイズ。単位はキロバイトです。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

malloc_total_size

JavaVM内部で管理している領域のうち、mallocで割り当てたCヒープ総サイズ。単位はキロバイトです。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

thread_count

Javaスレッドの数。

-XX:-HitachiVerboseGCPrintThreadCountオプションが指定された場合、出力されません。

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。単位はキロバイトです。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

-XX:-HitachiVerboseGCPrintDeleteOnExitが指定された場合、出力されません。

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_info

保守情報。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

-XX:+HitachiVerboseGCPrintTenuringDistributionオプション指定時の出力形式

id, date, size, value, max_value, total_age1, total_age2, total_agen

出力内容を次に説明します。

出力項目

出力内容

id

PTD（JavaVMログファイル識別子）。

date

GC開始日時。

size

GC後のSurvivor領域内オブジェクト目標サイズ。

value

次のCopyGCでTenured領域に昇格するJavaオブジェクトの年齢のしきい値。

この値は、-XX:MaxTenuringThreshold=valueオプションと、Survivor領域のメモリーサイズ、および、-XX:TargetSurvivorRatio=valueオプションに設定した値を基に、CopyGCごとに動的に設定されます。

value値以上の年齢のJavaオブジェクトが、次のCopyGCでTenured領域に昇格します。

max_value

CopyGCでTenured領域に昇格するJavaオブジェクトの年齢のしきい値（value値）の最大値（MaxTenuringThresholdオプションの指定値）。

value値は、CopyGCごとに動的に設定されますが、max_value値を超えることはありません。

また、年齢がmax_value値以上のJavaオブジェクトは、次のCopyGCで、必ず、Tenured領域に昇格します。

total_age1

1歳のオブジェクトのバイト数の合計。

total_age2

1歳から2歳までのオブジェクトのバイト数の合計。

total_agen

1歳からn歳までのオブジェクトのバイト数の合計。

nがmax_valueに近ければ寿命の長いオブジェクトが存在するということになります。

出力形式（G1GCの場合）

JavaVMログファイルには、GCに関するログとConcurrent Markingに関するログが出力されます。Concurrent Markingは、アプリケーションと並行で処理を実行するため、1回のConcurrent Markingに関するログは複数行に分かれて出力されます。

GCに関するログの出力形式

id,date,gc_kind,gc_info,gc_time,gc_status,eden_info,survivor_info,tenured_info,
humongous_info,free_info,metaspace_info,classspace_info,cause_info,
region_size,target_time,predicted_time,target_size,reclaimable_info,user_cpu,
system_cpu,jvm_alloc_size,mmap_total_size,malloc_total_size,thread_count,
doe_alloc_size,called_count,cc_used_size,cc_max_size,cc_info

Concurrent Markingに関するログの出力形式

id,date,cm_event,user_cpu,sys_spu

出力内容を次に説明します。

分類

出力項目

出力内容

GCに関するログ

id

VG1（JavaVMログファイル識別子）。

date

GCの 開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

gc_kind

GCまたはConcurrent Markingの種別。"FullGC"、"Mixed GC"、"Young GC"、"Young GC(initial-mark)"、"CM Remark"、"CM Cleanup"が出力されます。

gc_info

Java ヒープ領域のメモリー情報 。次の形式で出力されます。単位はキロバイトです。

GC前のJavaヒープ領域の使用サイズ,GC前のJavaヒープ領域の使用サイズ※,GC前のJavaヒープ領域の領域サイズ※,GC後のJavaヒープ領域の使用サイズ,GC後のJavaヒープ領域の使用サイズ※,GC後のJavaヒープ領域の領域サイズ※

gc_time

GCによるアプリケーション停止時間 。単位は秒です。

gc_status

GCの状態。

To 空間あふれが発生した場合、"to exhausted"が出力されます。

上記以外の場合、"-"が出力されます。

GCの種別ごとに、出力されるGCの状態を次に示します。

gc_kindが"Young GC"、"Young GC(initial-mark)"または"Mixed GC"の場合

"-"または"to exhausted"が出力されます。

gc_kindが上記以外の場合

"-"が出力されます。

eden_info

Eden 領域のメモリー情報。 次の形式で出力されます。単位はキロバイトです。

GC前のEden領域の使用サイズ※,GC前のEden領域が取得できる最大の領域サイズ※,GC後のEden領域の使用サイズ※,GC後のEden領域が取得できる最大の領域サイズ※

Eden領域が取得できる最大の領域サイズは、「New領域の領域サイズ-Survivor領域の使用サイズ」を指します。

survivor_info

Survivor領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のSurvivor領域の使用サイズ※,GC後のSurvivor領域の使用サイズ※

tenured_info

Tenured領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のTenured領域の使用サイズ※,GC後のTenured領域の使用サイズ※

humongous_info

Humongous領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のHumongous領域の使用サイズ※,GC後のHumongous領域の使用サイズ※

free_info

Free領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のFree領域の使用サイズ※,GC後のFree領域の使用サイズ※

metaspace_info

Metaspace情報。次の形式で出力されます。単位はキロバイトです。

GC前のMetaspace領域の使用サイズ,GC前のMetaspace領域のcapacityサイズ,GC前のMetaspace領域のcommitサイズ,GC後のMetaspace領域の使用サイズ,GC後のMetaspace領域のcapacityサイズ,GC後のMetaspace領域のcommitサイズ

classspace_info

Compressed Class Space情報。次の形式で出力されます。単位はキロバイトです。

GC前のCompressed Class Spaceの使用サイズ,GC前のCompressed Class Spaceのcapacityサイズ,GC前のCompressed Class Spaceのcommitサイズ,GC後のCompressed Class Spaceの使用サイズ,GC後のCompressed Class Spaceのcapacityサイズ,GC後のCompressed Class Spaceのcommitサイズ

圧縮オブジェクトポインター機能を使用していない場合、それぞれのサイズには0が出力されます。

cause_info

GC要因番号。

-XX:-HitachiVerboseGCPrintCauseオプションが指定された場合、出力されません。

region_size

1リージョンのサイズ。単位はキロバイトです。

target_time

GCによるアプリケーション停止時間の目標時間。単位は秒です。

目標時間は、-XX:+ MaxGCPauseMillisオプションで指定できます。

predicted_time

JavaVMが予測したGCによるアプリケーション停止時間。単位は秒です。

GCの種別が"Full GC"、"CM Remark"または"CM Cleanup"の場合、JavaVMは予測しないため、0が出力されます。

target_size

Mixed GCでGC対象となったTenured領域のサイズ。単位はキロバイトです。

GCの種別が"Mixed GC"以外の場合、0が出力されます。

reclaimable_info

予測回収サイズ情報。次の形式で出力されます。

予測回収サイズ,予測回収率

予測回収サイズの単位はキロバイトです。予測回収率は小数点以下第2位までが出力されます。

なお、予測回収サイズ情報は、Concurrent Marking終了直後のYoung GCまたはMixed GCの場合に出力されます。ほかの場合、JavaVMは予測しないため、0が出力されます。

user_cpu

すべてのGCスレッドがユーザーモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

system_cpu

すべてのGCスレッドがカーネルモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

jvm_alloc_size

JavaVM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

mmap_total_size

JavaVM内部で管理している領域のうち、VirtualAllocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

malloc_total_size

JavaVM内部で管理している領域のうち、mallocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

thread_count

Javaスレッドの数。

-XX:-HitachiVerboseGCPrintThreadCountオプションが指定された場合、出力されません。

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_info

保守情報。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

Concurrent Markingに関するログ

id

VCM（JavaVMログファイル識別子）。

date

Concurrent Marking開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

cm_event

Concurrent Markingの状態。

Concurrent Root Region Scan Start

Concurrent Root Region Scanが開始されました。

Concurrent Root Region Scan End

Concurrent Root Region Scanが終了しました。

Concurrent Mark Start

Concurrent Markが開始されました。

Concurrent Mark End

Concurrent Markが終了しました。

Concurrent Mark Stop

Concurrent Markを中止しました。

Concurrent Cleanup Start

Concurrent Cleanupが開始されました。

Concurrent Cleanup End

Concurrent Cleanupが終了しました。

user_cpu

すべてのGCスレッドがユーザーモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

Concurrent Markingの状態が"Concurrent Mark Start"の場合、0が出力されます。

sys_cpu

すべてのGCスレッドがカーネルモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

Concurrent Markingの状態が"Concurrent Mark Start"の場合、0が出力されます。

注※

サイズは、 領域のサイズを1リージョンのサイズで切り上げ、1リージョンのサイズの倍数で表した値となります。

cause_infoに出力されるGC要因番号を次に示します。

表7‒3　GC要因一覧

要因番号

要因内容

説明

GCの種類

G1GC以外

G1GC

0

ObjAllocFail

オブジェクトの領域確保失敗によってGCが発生しました。

○

○

1

System.gc

java.lang.System.gcメソッド呼び出しによってGCが発生しました。

○

○

3

DelayedGC

JNIやJVMTIによって保留されていたGCが起動されました。

○

○

4

JavaGCCommand

javagcコマンドによってGCが発生しました。

○

○

6

JHeapProfCommand

jheapprofコマンドによってGCが発生しました。

○

×

8

EMReclaimFail

Explicitメモリーの明示解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

9

EMMigrateFail

Explicitメモリーの自動解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

10

JVMTIForceGC

JVMTI関数ForceGarbageCollection()によってGCが発生しました。

○

○

11

PromotionFail

CopyGCの昇格失敗によってGCが発生しました。

○

×

12

EMJavaGCCommand

javagcコマンドによるExplicitメモリーブロックの解放によってGCが発生しました。

○

○

13

EHeapProfCommand

eheapprofコマンドによってGCが発生しました。

○

○

14

G1HumAllocFail

G1GC 使用時、Humongous用の領域確保のために GC が発生しました。

×

○

15

G1EvacuationPause

G1GC 使用時にエバキュエーションが発生しました。

×

○

16

Concurrent Marking

GC は発生していないが、アプリケーションを停止して実行するConcurrent Marking 処理をログに出力しました。

×

○

17

EvacuationFail

G1GC 使用時にエバキュエーションの 失敗による GC が発生しました。

×

○

18

MetaspaceAllocFail

Metaspaceの領域確保失敗によってGCが発生しました。

○

○

19

LastMetaspaceGC

MetaspaceのOutOfMemoryを出す前の最後のGCが発生しました。

○

○

（凡例）

○：出力します。

×：出力しません。

書式

-XX:[+|-]HitachiCommaVerboseGC

指定できる値

型：String

-XX:+HitachiCommaVerboseGC

拡張verbosegc情報の出力を、CSVファイルで取得できるようにコンマ形式で出力します。

拡張verbosegc情報に出力される括弧（丸括弧()、角括弧[]、山括弧<>）およびコロン（:）をすべて削除し、コンマ（,）で区切った数値または文字列を出力します。

-XX:-HitachiCommaVerboseGC

拡張verbosegc情報を通常形式で出力します。

デフォルト値

定義項目の省略

-XX:-HitachiCommaVerboseGC

出力例

出力例1

SerialGCの場合に-XX:HitachiVerboseGCIntervalTimeオプションが指定されているとき

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例2

SerialGCの場合に-XX:+HitachiVerboseGCPrintTenuringDistributionオプションが指定されているとき

PTD,Wed May 28 11:45:23 2008,5467547,30,31,1357527,1539661

出力例3

G1GCの場合

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

7.6.2　-XX:[+|-]HitachiVerboseGC

GCが発生した場合、拡張verbosegc情報をJavaVMログファイルに出力します。

説明

GCが発生した時の拡張verbosegc情報を出力するかどうかを指定します。

出力形式（SerialGCの場合）

[id] <date> (Skip Full:full_count, Copy:copy_count)
[gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info]
[Tenured: tenured_info][Metaspace: Metaspace_info]
[class space: class_space_info] [cause:cause_info] [User: user_cpu secs]
[Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size]
[TC: thread_count][DOE: doe_alloc_size, called_count]
[CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

出力内容を次に説明します。

出力項目

出力内容

id

VGC（JavaVMログファイル識別子）。

date

GC開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

full_count

FullGC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

copy_count

CopyGC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

gc_kind

GC種別。"FullGC"、"GC"が出力されます。

gc_info

GC情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

gc_time

GC経過時間。

Eden

Edenの種別。"DefNew::Eden"が出力されます。

eden_info

Eden情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Survivor

Survivorの種別。"DefNew::Survivor"が出力されます。

survivor_info

Survivor情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Tenured

Tenuredの種別。"Tenured"が出力されます。

tenured_info

Tenured情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Metaspace_info

Metaspace領域のメモリー情報。次の形式で出力されます。

GC前のMetaspace領域の使用サイズK(GC前のMetaspace領域のcapacityサイズK, GC前のMetaspace領域のcommitサイズK)->GC後のMetaspace領域の使用サイズK(GC後のMetaspace領域のcapacityサイズK, GC後のMetaspace領域のcommitサイズK)

classspace_info

Compressed Class Spaceのメモリー情報。次の形式で出力されます。

GC前のCompressed Class Spaceの使用サイズK(GC前のCompressed Class SpaceのcapacityサイズK, GC前のCompressed Class SpaceのcommitサイズK)->GC後のCompressed Class Spaceの使用サイズK(GC後のCompressed Class SpaceのcapacityサイズK, GC後のCompressed Class SpaceのcommitサイズK)

圧縮オブジェクトポインター機能を使用していない場合、出力されません。

cause_info

GC要因内容。

-XX:-HitachiVerboseGCPrintCauseオプションが指定された場合、出力されません。

user_cpu

GCスレッドがユーザーモードで費やしたCPU時間。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

system_cpu

GCスレッドがカーネルモードで費やしたCPU時間。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

jvm_alloc_size

JavaVM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

mmap_total_size

JavaVM内部で管理している領域のうち、VirtualAllocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

malloc_total_size

JavaVM内部で管理している領域のうち、mallocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

thread_count

Javaスレッドの数。

-XX:-HitachiVerboseGCPrintThreadCountオプションが指定された場合、出力されません。

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_info

保守情報。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

出力形式（G1GCの場合）

JavaVMログファイルには、GCに関するログとConcurrent Markingに関するログが出力されます。Concurrent Markingは、アプリケーションと並行で処理を実行するため、1回のConcurrent Markingに関するログは複数行に分かれて出力されます。

GCに関するログの出力形式

[id]<date>[gc_kind gc_info, gc_time secs][Status:gc_status]
[G1GC::Eden: eden_info][G1GC::Survivor: survivor_info]
[G1GC::Tenured: tenured_info][G1GC::Humongous: humongous_info]
[G1GC::Free: free_info][Metaspace: Metaspace_info]
[class space: class_space_info][cause:cause_info][RegionSize: region_sizeK]
[Target: target_time secs][Predicted: predicted_time secs]
[TargetTenured: target_sizeK][Reclaimable: reclaimable_info]
[User: user_cpu secs][Sys: system_cpu secs]
[IM: jvm_alloc_sizeK, mmap_total_sizeK, malloc_total_sizeK][TC: thread_count]
[DOE: doe_alloc_sizeK, called_count][CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

Concurrent Markingに関するログの出力形式

[id]<date>[cm_event][User: user_cpu secs][Sys: sys_cpu secs]

出力内容を次に説明します。

分類

出力項目

出力内容

GCに関するログ

id

VG1（JavaVMログファイル識別子）。

date

GCまたはConcurrent Markingの 開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

gc_kind

GCまたはConcurrent Markingの種別。"FullGC"、"Mixed GC"、"Young GC"、"Young GC(initial-mark)"、"CM Remark"、"CM Cleanup"が出力されます。

gc_info

Java ヒープ領域のメモリー情報 。次の形式で出力されます。単位はキロバイトです。

GC前のJavaヒープ領域の使用サイズK/GC前のJavaヒープ領域の使用サイズ※K(GC前のJavaヒープ領域の領域サイズ※K)->GC後のJavaヒープ領域の使用サイズK/GC後のJavaヒープ領域の使用サイズ※K(GC後のJavaヒープ領域の領域サイズ※K)

gc_time

GCによるアプリケーション停止時間 。単位は秒です。

gc_status

GCの状態。

To 空間あふれが発生した場合、"to exhausted"が出力されます。

上記以外の場合、"-"が出力されます。

GCの種別ごとに、出力されるGCの状態を次に示します。

gc_kindが"Young GC"、"Young GC(initial-mark)"または"Mixed GC"の場合

"-"または"to exhausted"が出力されます。

gc_kindが上記以外の場合

"-"が出力されます。

eden_info

Eden 領域のメモリー情報。 次の形式で出力されます。単位はキロバイトです。

GC前のEden領域の使用サイズ※K(GC前のEden領域が取得できる最大の領域サイズ※K)->GC後のEden領域の使用サイズ※K(GC後のEden領域が取得できる最大の領域サイズ※K)

Eden領域が取得できる最大の領域サイズは、「New領域の領域サイズ-Survivor領域の使用サイズ」を指します。

survivor_info

Survivor領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のSurvivor領域の使用サイズ※K->GC後のSurvivor領域の使用サイズ※K

tenured_info

Tenured領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のTenured領域の使用サイズ※K->GC後のTenured領域の使用サイズ※K

humongous_info

Humongous領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のHumongous領域の使用サイズ※K->GC後のHumongous領域の使用サイズ※K

free_info

Free領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のFree領域の使用サイズ※K->GC後のFree領域の使用サイズ※K

Metaspace_info

Metaspace領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のMetaspace領域の使用サイズK(GC前のMetaspace領域のcapacityサイズK, GC前のMetaspace領域のcommitサイズK)->GC後のMetaspace領域の使用サイズK(GC後のMetaspace領域のcapacityサイズK, GC後のMetaspace領域のcommitサイズK)

classspace_info

Compressed Class Spaceのメモリー情報。次の形式で出力されます。単位はキロバイトです。

GC前のCompressed Class Spaceの使用サイズK(GC前のCompressed Class SpaceのcapacityサイズK, GC前のCompressed Class SpaceのcommitサイズK)->GC後のCompressed Class Spaceの使用サイズK(GC後のCompressed Class SpaceのcapacityサイズK, GC後のCompressed Class SpaceのcommitサイズK)

圧縮オブジェクトポインター機能を使用していない場合、出力されません。

cause_info

GC要因内容。

-XX:-HitachiVerboseGCPrintCauseオプションが指定された場合、出力されません。

region_size

1リージョンのサイズ。単位はキロバイトです。

target_time

GCによるアプリケーション停止時間の目標時間。単位は秒です。

目標時間は、-XX:+MaxGCPauseMillisオプションで指定できます。

predicted_time

JavaVMが予測したGCによるアプリケーション停止時間。単位は秒です。

GCまたはConcurrent Markingの種別が"Full GC"、"CM Remark"または"CM Cleanup"の場合、JavaVMは予測しないため、0が出力されます。

target_size

Mixed GCでGC対象となったTenured領域のサイズ。単位はキロバイトです。

GCまたはConcurrent Markingの種別が"Mixed GC"以外の場合、0が出力されます。

reclaimable_info

予測回収サイズ情報。次の形式で出力されます。

予測回収サイズK(予測回収率%)

予測回収サイズの単位はキロバイトです。予測回収率は小数点以下第2位までが出力されます。

なお、予測回収サイズ情報は、Concurrent Marking終了直後のYoung GCまたはMixed GCの場合に出力されます。ほかの場合、JavaVMは予測しないため、0が出力されます。

user_cpu

すべてのGCスレッドがユーザーモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

system_cpu

すべてのGCスレッドがカーネルモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

jvm_alloc_size

JavaVM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

mmap_total_size

JavaVM内部で管理している領域のうち、VirtualAllocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

malloc_total_size

JavaVM内部で管理している領域のうち、mallocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

thread_count

Javaスレッドの数。

-XX:-HitachiVerboseGCPrintThreadCountオプションが指定された場合、出力されません。

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_info

保守情報。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

Concurrent Markingに関するログ

id

VCM（JavaVMログファイル識別子）。

date

Concurrent Marking開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

cm_event

Concurrent Markingの状態。

Concurrent Root Region Scan Start

Concurrent Root Region Scanが開始されました。

Concurrent Root Region Scan End

Concurrent Root Region Scanが終了しました。

Concurrent Mark Start

Concurrent Markが開始されました。

Concurrent Mark End

Concurrent Markが終了しました。

Concurrent Mark Stop

Concurrent Markを中止しました。

Concurrent Cleanup Start

Concurrent Cleanupが開始されました。

Concurrent Cleanup End

Concurrent Cleanupが終了しました。

user_cpu

すべてのGCスレッドがユーザーモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

Concurrent Markingの状態が"Concurrent Mark Start"の場合、0が出力されます。

sys_cpu

すべてのGCスレッドがカーネルモードで費やしたCPU時間の合計。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、"unknown"と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

Concurrent Markingの状態が"Concurrent Mark Start"の場合、0が出力されます。

注※

サイズは、 領域のサイズを1リージョンのサイズで切り上げ、1リージョンのサイズの倍数で表した値となります。

cause_infoに出力されるGC要因内容を次に示します。

表7‒4　GC要因一覧

要因番号

要因内容

説明

GCの種類

G1GC以外

G1GC

0

ObjAllocFail

オブジェクトの領域確保失敗によってGCが発生しました。

○

○

1

System.gc

java.lang.System.gcメソッド呼び出しによってGCが発生しました。

○

○

3

DelayedGC

JNIやJVMTIによって保留されていたGCが起動されました。

○

○

4

JavaGCCommand

javagcコマンドによってGCが発生しました。

○

○

6

JHeapProfCommand

jheapprofコマンドによってGCが発生しました。

○

×

8

EMReclaimFail

Explicitメモリーの明示解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

9

EMMigrateFail

Explicitメモリーの自動解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

10

JVMTIForceGC

JVMTI関数ForceGarbageCollection()によってGCが発生しました。

○

○

11

PromotionFail

CopyGCの昇格失敗によってGCが発生しました。

○

×

12

EMJavaGCCommand

javagcコマンドによるExplicitメモリーブロックの解放によってGCが発生しました。

○

○

13

EHeapProfCommand

eheapprofコマンドによってGCが発生しました。

○

○

14

G1HumAllocFail

G1GC 使用時、Humongous用の領域確保のために GC が発生しました。

×

○

15

G1EvacuationPause

G1GC 使用時にエバキュエーションが発生しました。

×

○

16

Concurrent Marking

GC は発生していないが、アプリケーションを停止して実行するConcurrent Marking 処理をログに出力しました。

×

○

17

EvacuationFail

G1GC 使用時にエバキュエーションの 失敗による GC が発生しました。

×

○

18

MetaspaceAllocFail

Metaspaceの領域確保失敗によってGCが発生しました。

○

○

19

LastMetaspaceGC

MetaspaceのOutOfMemoryを出す前の最後のGCが発生しました。

○

○

（凡例）

○：出力します。

×：出力しません。

書式

-XX:[+|-]HitachiVerboseGC

指定できる値

型：String

-XX:+HitachiVerboseGC

GCが発生した場合、拡張verbosegc情報をJavaVMログファイルに出力します。

GCの内部領域であるEden、Survivor、Tenured、Metaspace種別の情報を拡張verbosegc情報として出力します。

-XX:-HitachiVerboseGC

GCが発生した場合、拡張verbosegc情報をJavaVMログファイルに出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiVerboseGC

出力例

出力例1

SerialGCの場合に-XX:HitachiVerboseGCIntervalTimeオプションが指定されているとき

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2

G1GCの場合

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

7.6.3　-XX:[+|-]HitachiVerboseGCCpuTime

拡張verbosegc情報にユーザーCPU時間とカーネルCPU時間を出力します。

説明

拡張verbosegc情報にCPU利用時間を出力するかどうかを指定します。

前提オプション

-XX:+HitachiVerboseGC

書式

-XX:[+|-]HitachiVerboseGCCpuTime

指定できる値

型：String

-XX:+HitachiVerboseGCCpuTime

拡張verbosegc情報に、GCの開始から終了までで、GC実行スレッドのユーザーモードおよびカーネルモードに費やされたプロセッサ時間を出力します。

-XX:-HitachiVerboseGCCpuTime

拡張verbosegc情報に、GCの開始から終了までで、GC実行スレッドのユーザーモードおよびカーネルモードに費やされたプロセッサ時間を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCCpuTime

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

7.6.4　-XX:HitachiVerboseGCIntervalTime

拡張verbosegc情報を出力する時間（秒）の間隔を指定します。

説明

拡張verbosegc情報を出力する時間（秒）の間隔を指定します。

オプションを指定した場合

拡張verbosegc情報をGCごとに出力するのではなく、指定された時間を超えた次のGCを出力します。このとき、前回の出力から今回の出力までの間に発生した、次に示すGCの回数も出力します。これらは必ず出力されます。

表7‒5　回数を出力するGCの一覧

文字列

意味

Full

FullGCをスキップした回数

Copy

CopyGCをスキップした回数

オプションを指定しない場合

0秒がデフォルトで設定され、GC発生ごとに拡張verbosegc情報を出力します。

前提オプション

-XX:+HitachiVerboseGC

書式

-XX:HitachiVerboseGCIntervalTime=整数値

指定できる値

整数値

型：Integer

0〜2147483647の範囲の整数値（単位：秒）を指定します。範囲外の値が指定された場合は0が設定されます。負の値を指定した場合はエラーとなります。

デフォルト値

定義項目の省略

-XX:HitachiVerboseGCIntervalTime=0

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

7.6.5　-XX:[+|-]HitachiVerboseGCPrintCause

GCの要因内容を出力します。

説明

GCの要因内容を出力するかどうかを指定します。

前提オプション

-XX:+HitachiVerboseGC

-XX:+HitachiCommaVerboseGCオプションが指定されている場合は、次に示す要因番号が出力されます。

表7‒6　GC要因一覧

要因番号

要因内容

説明

GCの種類

G1GC以外

G1GC

0

ObjAllocFail

オブジェクトの領域確保失敗によってGCが発生しました。

○

○

1

System.gc

java.lang.System.gcメソッド呼び出しによってGCが発生しました。

○

○

3

DelayedGC

JNIやJVMTIによって保留されていたGCが起動されました。

○

○

4

JavaGCCommand

javagcコマンドによってGCが発生しました。

○

○

6

JHeapProfCommand

jheapprofコマンドによってGCが発生しました。

○

×

8

EMReclaimFail

Explicitメモリーの明示解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

9

EMMigrateFail

Explicitメモリーの自動解放によるJavaヒープへのオブジェクト移動が発生してJavaヒープがあふれました。

○

×

10

JVMTIForceGC

JVMTI関数ForceGarbageCollection()によってGCが発生しました。

○

○

11

PromotionFail

CopyGCの昇格失敗によってGCが発生しました。

○

×

12

EMJavaGCCommand

javagcコマンドによるExplicitメモリーブロックの解放によってGCが発生しました。

○

○

13

EHeapProfCommand

eheapprofコマンドによってGCが発生しました。

○

○

14

G1HumAllocFail

G1GC 使用時、Humongous用の領域確保のために GC が発生しました。

×

○

15

G1EvacuationPause

G1GC 使用時にエバキュエーションが発生しました。

×

○

16

Concurrent Marking

GC は発生していないが、アプリケーションを停止して実行するConcurrent Marking 処理をログに出力しました。

×

○

17

EvacuationFail

G1GC 使用時にエバキュエーションの 失敗による GC が発生しました。

×

○

18

MetaspaceAllocFail

Metaspaceの領域確保失敗によってGCが発生しました。

○

○

19

LastMetaspaceGC

MetaspaceのOutOfMemoryを出す前の最後のGCが発生しました。

○

○

（凡例）

○：出力します。

×：出力しません。

書式

-XX:[+|-]HitachiVerboseGCPrintCause

指定できる値

型：String

-XX:+HitachiVerboseGCPrintCause

GCの要因内容を、拡張verbosegc情報の行末に出力します。

-XX:-HitachiVerboseGCPrintCause

拡張verbosegc情報を通常形式で出力します。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCPrintCause

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

7.6.6　-XX:[+|-]HitachiVerboseGCPrintDate

拡張verbosegc情報にGC開始日時を出力します。

説明

拡張verbosegc情報にGC開始日時を出力するかどうかを指定します。

前提オプション

-XX:+HitachiVerboseGC

書式

-XX:[+|-]HitachiVerboseGCPrintDate

指定できる値

型：String

-XX:+HitachiVerboseGCPrintDate

拡張verbosegc情報の各出力行の先頭にGC開始日時を出力します。

-XX:-HitachiVerboseGCPrintDate

拡張verbosegc情報の各出力行の先頭にGC開始日時を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCPrintDate

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

7.6.7　-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit

java.io.File.deleteOnExit()を呼び出したことによってJavaVMが確保した累積のヒープサイズとメソッドの呼び出し回数を、JavaVMログファイルへ出力します。

説明

java.io.File.deleteOnExit()を呼び出したことによってJavaVMが確保した累積のヒープサイズとメソッドの呼び出し回数を、JavaVMログファイルに出力するかどうかを指定します。

java.io.File.deleteOnExit()は、呼び出すたびに指定されたファイルのパス情報をヒープに確保しますが、確保した領域はプロセスの終了まで解放しないため、メモリーの圧迫につながるおそれがあります。-XX:+HitachiVerboseGCPrintDeleteOnExitオプションを指定すると、JavaVMがjava.io.File.deleteOnExit()を呼び出して確保したヒープサイズをログに出力して監視できるようになります。また、java.io.File.deleteOnExit()の呼び出し状況を把握するための補助的な情報として、メソッドの呼び出し回数も同時に出力できます。

出力した情報は、障害発生時、java.io.File.deleteOnExit()の呼び出しによって確保されたヒープサイズを把握してメモリー不足の原因を調査するために役立てられます。また、運用開始前の開発やテスト段階で、java.io.File.deleteOnExit()の呼び出しによって確保したヒープサイズの増加の推移を確認して、運用時にメモリーを圧迫する予兆がないかを事前確認するためにも利用できます。

なお、エラーが発生した場合は、エラーメッセージが出力されます。

前提オプション

-XX:+HitachiVerboseGC

出力形式

JavaVMログファイルの出力形式を次に示します。

[id] <date> (Skip Full:full_count, Copy:copy_count)
[gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info]
[Tenured: tenured_info][Metaspace: Metaspace_info]
[class space: class_space_info][cause:cause_info] [User: user_cpu secs]
[Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size]
[TC: thread_count][DOE: doe_alloc_size, called_count]

このオプションによって出力される項目と出力内容を次に示します。

出力項目

出力内容

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

エラーが発生した場合のエラーメッセージの出力形式を次に示します。

[DOE]<date>Error occurred during processing of java.io.File.deleteOnExit's
heap size output function. (<保守情報>)
[DOE]java.io.File.deleteOnExit's heap size output function stopped.

エラーメッセージの出力内容を次に示します。

出力項目

出力内容

DOE

java.io.File.deleteOnExit()のヒープサイズ出力機能でエラーが発生したことを示す識別子。

date

エラーが発生した日時。

書式

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit

指定できる値

型：String

-XX:+HitachiVerboseGCPrintDeleteOnExit

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズと、メソッドの呼び出し回数を出力します。

-XX:-HitachiVerboseGCPrintDeleteOnExit

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズと、メソッドの呼び出し回数を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCPrintDeleteOnExit

出力例

JavaVMログファイルの出力例を次に示します。

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

エラーメッセージの出力例を次に示します。

出力例

[DOE]<Wed Jan 27 13:03:36 2010> Error occurred during processing of
java.io.File.deleteOnExit's heap size output function.
(FindClass:java.lang.String)
[DOE]java.io.File.deleteOnExit's heap size output function stopped.

注意事項

次の場合は、java.io.File.deleteOnExit()を呼び出しても累積のヒープサイズ、メソッドの呼び出し回数がカウントされません。

java.io.File.deleteOnExit()を呼び出した場合にSecurityException例外が発生したとき（この例外はセキュリティーマネージャーのSecurityManager.checkDelete()がファイルへの削除アクセスを許可しない場合に発生します。この場合、メソッドの入り口で例外が挙がり、ヒープは確保されません）。

Application Serverのバッチアプリケーション実行基盤で作成されたアプリケーションから呼び出した場合。

同一のパス名文字列で作成したFileインスタンスを使用してjava.io.File.deleteOnExit()を呼び出したとき。

この機能が出力するヒープサイズを確認する際には、次の点に注意してください。

java.io.File.deleteOnExit()が確保するヒープの種類はJavaヒープです。

ヒープサイズはキロバイト単位で出力され、1キロバイト未満は切り捨てられます。java.io.File.deleteOnExit()の1回の呼び出しで確保するヒープサイズは、ファイルパスの長さに応じて数十バイトから100バイト程度であるため、呼び出しごとにヒープサイズの出力結果が増加しないことがあります。この場合、メソッドの呼び出し回数からメソッドの実行を確認できます。

7.6.8　-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory

JavaVM内部で管理しているヒープ情報をJavaVMログファイルへ出力します。

説明

JavaVM内部で管理しているヒープ情報をJavaVMログファイルに出力するかどうかを指定します。

Cヒープ領域のうち、次の2種類の方法で取得したヒープ領域は、JavaVM内部で管理する方式で管理されています。

mmapで取得したCヒープ領域

mallocで取得したCヒープ領域

-XX:+HitachiVerboseGCPrintJVMInternalMemoryオプションを有効にした場合、mmapで取得したCヒープの総サイズ（mmap_total_size）と、mallocで取得したCヒープの総サイズ（malloc_total_size）を出力できます。また、これらの割り当て済みの領域のうち、使用中の領域のサイズの合計値（jvm_alloc_size）も出力できます。

前提オプション

-XX:+HitachiVerboseGC

出力形式

[id] <date> (Skip Full:full_count, Copy:copy_count)
[gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info]
[Tenured: tenured_info][Metaspace: Metaspace_info]
[class space: class_space_info][cause:cause_info] [User: user_cpu secs]
[Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size]

このオプションによって出力される項目と出力内容を次に示します。

出力項目

出力内容

jvm_alloc_size

JavaVM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。

mmap_total_size

JavaVM内部で管理している領域のうち、VirtualAllocで割り当てたCヒープの総サイズ。

malloc_total_size

JavaVM内部で管理している領域のうち、mallocで割り当てたCヒープの総サイズ。

書式

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory

指定できる値

型：String

-XX:+HitachiVerboseGCPrintJVMInternalMemory

JavaVM内部で管理しているヒープ情報をJavaVMログファイルへ出力します。

-XX:-HitachiVerboseGCPrintJVMInternalMemory

JavaVM内部で管理しているヒープ情報をJavaVMログファイルへ出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCPrintJVMInternalMemory

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

注意事項

このオプションを有効にする場合は、拡張VerboseGC機能のほかに独自のメモリー管理機能が有効になっている必要があります。

7.6.9　-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution

Survivor領域の年齢分布をJavaVMログファイルへ出力します。

説明

-XX:+PrintTenuringDistribution指定時に出力されるSurvivor領域の年齢分布をJavaVMログファイルへ出力するかどうかを指定します。

前提オプション

-XX:+HitachiVerboseGC

関連オプション

-XX:+PrintTenuringDistribution

-XX:+HitachiVerboseGCPrintDate

-XX:+HitachiCommaVerboseGC

出力形式

[id]<date>[Desired survivor:size bytes][New threshold:value]
[MaxTenuringThreshold: max_value][age1:total_age1][age2:total_age2]...
[agen:total_agen]

出力内容を次に説明します。

出力項目

出力内容

id

PTD（JavaVMログファイル識別子）。

date

GC開始日時。

size

GC後のSurvivor領域内オブジェクト目標サイズ。

value

次のCopyGCでTenured領域に昇格するJavaオブジェクトの年齢のしきい値。

この値は、-XX:MaxTenuringThreshold=valueオプションと、Survivor領域のメモリーサイズ、および、-XX:TargetSurvivorRatio=valueオプションに設定した値を基に、CopyGCごとに動的に設定されます。

value値以上の年齢のJavaオブジェクトが、次のCopyGCでTenured領域に昇格します。

max_value

CopyGCでTenured領域に昇格するJavaオブジェクトの年齢のしきい値（value値）の最大値（MaxTenuringThresholdオプションの指定値）。

value値は、CopyGCごとに動的に設定されますが、max_value値を超えることはありません。

また、年齢がmax_value値以上のJavaオブジェクトは、次のCopyGCで、必ず、Tenured領域に昇格します。

total_age1

1歳のオブジェクトのバイト数の合計。

total_age2

1歳から2歳までのオブジェクトのバイト数の合計。

total_agen

1歳からn歳までのオブジェクトのバイト数の合計。

nがmax_valueに近ければ寿命の長いオブジェクトが存在するということになります。

書式

-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution

指定できる値

型：String

-XX:+HitachiVerboseGCPrintTenuringDistribution

-XX:+PrintTenuringDistribution指定時に出力されるSurvivor領域の年齢分布をJavaVMログファイルへ出力します。

-XX:-HitachiVerboseGCPrintTenuringDistribution

-XX:+PrintTenuringDistribution指定時に出力されるSurvivor領域の年齢分布をJavaVMログファイルへ出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiVerboseGCPrintTenuringDistribution

出力例

[PTD]<Wed Jan 28 17:47:10 2009>[Desired survivor:32768 bytes][New threshold:30]
[MaxTenuringThreshold:30][age1:6872][age2:9632][age3:25632]

注意事項

このオプションを指定した場合、 CopyGC発生時のログの出力量が、指定しない場合と比較して倍以上に増えます。

そのため、このオプションはチューニングの時にだけ使用してください。

7.6.10　-XX:[+|-]HitachiVerboseGCPrintThreadCount

Javaスレッドの数をJavaVMログファイルへ出力します。

説明

Javaスレッドの数を監視するために、Javaスレッドの数をJavaVMログファイルに出力するかどうかを指定します。

スレッドは、スタックに使用するためのメモリーをCヒープとして個々で確保します。このため、スレッド数が多くなると、Cヒープの確保量もスレッド数に比例して多くなります。-XX:+HitachiVerboseGCPrintThreadCountオプションを指定することで、Javaスレッドの数を監視できるようになり、Cヒープの確保量の把握ができるようになります。

なお、スレッド数がOSで設定するスレッド数の上限値に達した場合、それ以上スレッドを作成できないことがあります。

前提オプション

-XX:+HitachiVerboseGC

出力形式

[id] <date> (Skip Full:full_count, Copy:copy_count)
[gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info]
[Tenured: tenured_info][Metaspace: Metaspace_info]
[class space: class_space_info] [cause:cause_info] [User: user_cpu secs]
[Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size]
[TC: thread_count]

このオプションによって出力される項目と出力内容を次に示します。

出力項目

出力内容

thread_count

Javaスレッドの数。

書式

-XX:[+|-]HitachiVerboseGCPrintThreadCount

指定できる値

型：String

-XX:+HitachiVerboseGCPrintThreadCount

Javaスレッドの数を出力します。

-XX:-HitachiVerboseGCPrintThreadCount

Javaスレッドの数を出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiVerboseGCPrintThreadCount

出力例

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

7.7　コードキャッシュ領域情報出力機能で使用するJavaVMオプション

コードキャッシュ領域情報の出力を設定するためのオプションを説明しています。

7.7.1　-XX:CodeCacheInfoPrintRatio

コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージを出力する契機となる、コードキャッシュ領域の使用率を指定します。

説明

コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージを出力する契機となる、コードキャッシュ領域の使用率を指定します。

ここで指定した使用率を基に、次の計算式でしきい値が計算されます。

コードキャッシュ領域の最大サイズ×-XX:CodeCacheInfoPrintRatioオプションの値÷100

コードキャッシュ領域は、JITコンパイルによって生成されたJITコンパイルコードが格納される領域です。JavaVMは、呼び出し回数やループ回数が多いJavaメソッドをJITコンパイルして実行することで、処理の高速化を行います。

コードキャッシュ領域の最大サイズは、ReservedCodeCacheSizeオプションに指定します。ReservedCodeCacheSizeオプションには、デフォルト値以上の値を指定してください。

また、コードキャッシュ領域が枯渇していた場合、または枯渇するおそれがある場合は、コードキャッシュ領域の拡張を検討してください。JITコンパイルコードのサイズは計算で見積もることができません。そのため、Javaアプリケーション実行環境でコードキャッシュ領域の使用量を実測し、システムが使用するコードキャッシュ領域（32ビット版で最大500キロバイト、64ビット版で最大2メガバイト）の使用量を考慮した上で、コードキャッシュ領域の最大サイズを見積もってください。

前提オプション

-XX:+PrintCodeCacheInfo

書式

-XX:CodeCacheInfoPrintRatio=整数値

指定できる値

整数値

型：Integer

0〜100の範囲で整数値（単位：％）を指定します。範囲外の値が指定された場合は80が設定されます。

デフォルト値

定義項目の省略

-XX:CodeCacheInfoPrintRatio=80

注意事項

コードキャッシュ領域の使用量がしきい値に達した状態で推移している場合、JavaメソッドがJITコンパイルされてもメッセージは出力されません。

一方、コードキャッシュ領域の使用量がしきい値未満まで下がったあと、JavaメソッドがJITコンパイルされたことによって再びコードキャッシュ領域の使用量がしきい値に達した場合には、メッセージが出力されます。

システムが使用するコードキャッシュ領域は32ビット版で最大500キロバイト、64ビット版で最大2メガバイトです。そのため、システムのコードキャッシュ領域の使用量によっては、コードキャッシュ領域を最大サイズまで使用していない場合でも、コードキャッシュ領域が枯渇することがあります。

また、コードキャッシュ領域の使用量のしきい値に大きな値を指定している場合、メッセージを出力する前にコードキャッシュ領域が枯渇する場合があります。コードキャッシュ領域が枯渇する前にメッセージを出力したいときは、「コードキャッシュ領域の最大サイズ−しきい値」の値が4メガバイト以上になるように、-XX:CodeCacheInfoPrintRatio（コードキャッシュ領域使用率指定オプション）の値を指定してください。

7.7.2　-XX:[+|-]PrintCodeCacheFullMessage

JavaメソッドがJITコンパイルの対象になった場合、コードキャッシュ領域が枯渇していたときに、メッセージをJavaVMログファイルへ出力します。

説明

JavaメソッドがJITコンパイルの対象になった場合、コードキャッシュ領域が枯渇していたときに、メッセージをJavaVMログファイルに出力するかどうかを指定します。コードキャッシュ領域は、JITコンパイルによって生成されたJITコンパイルコードが格納される領域です。JavaVMは、呼び出し回数やループ回数が多いJavaメソッドをJITコンパイルして実行することで、処理の高速化を行います。

前提オプション

-XX:+HitachiVerboseGC

出力形式

メッセージの出力形式を次に示します。

[cc_id]<cc_date>CodeCache is full. Compiler has been disabled.
[cc_used_sizeK, cc_max_sizeK, cc_infoK]

メッセージの出力内容を次に示します。

出力項目

出力内容

cc_id

CCI（JavaVMログファイル識別子）。

cc_date

JavaメソッドがJITコンパイルの対象になった日時。

cc_used_size

JavaメソッドがJITコンパイルの対象になったときのコードキャッシュ領域の使用サイズ。単位はキロバイトです。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

cc_info

保守情報。

書式

-XX:[+|-]PrintCodeCacheFullMessage

指定できる値

型：String

-XX:+PrintCodeCacheFullMessage

JavaメソッドがJITコンパイルの対象になった場合、コードキャッシュ領域が枯渇していたときにメッセージを出力します。メッセージは一度だけ出力されます。

-XX:-PrintCodeCacheFullMessage

JavaメソッドがJITコンパイルの対象になった場合、コードキャッシュ領域が枯渇してもメッセージを出力しません。

デフォルト値

定義項目の省略

-XX:+PrintCodeCacheFullMessage

出力例

メッセージの出力例を次に示します。

[CCI]<Wed Dec 26 14:38:29 2012>CodeCache is full. Compiler has been disabled.
[49151K, 49152K, 49152K]

注意事項

システムが使用するコードキャッシュ領域は32ビット版で最大500キロバイト、64ビット版で最大2メガバイトです。そのため、システムのコードキャッシュ領域の使用量によっては、コードキャッシュ領域を最大サイズまで使用していない場合でも、コードキャッシュ領域が枯渇することがあります。

7.7.3　-XX:[+|-]PrintCodeCacheInfo

コードキャッシュ領域の使用量を出力するかどうかを指定します。また、使用量がしきい値に達したことを知らせるメッセージをJavaVMログファイルに出力するかどうかを指定します。

説明

コードキャッシュ領域の使用量を出力するかどうかを指定します。また、使用量がしきい値に達したことを知らせるメッセージをJavaVMログファイルに出力するかどうかを指定します。コードキャッシュ領域は、JITコンパイルによって生成されたJITコンパイルコードが格納される領域です。JavaVMは、呼び出し回数やループ回数が多いJavaメソッドをJITコンパイルして実行することで、処理の高速化を行います。

このオプションを有効にすると、GC発生時、コードキャッシュ領域の使用量が拡張verbosegc情報に出力されます。また、コードキャッシュ領域の使用量がしきい値に達したとき、メッセージが出力されます。

しきい値は「コードキャッシュ領域の最大サイズ×-XX:CodeCacheInfoPrintRatioオプションの値÷100」です。コードキャッシュ領域の最大サイズは、-XX:ReservedCodeCacheSizeオプションに指定します。

-XX:-HitachiVerboseGCオプションを指定している場合でも、javagcコマンドの-vオプションや-sオプションによって出力する拡張verbosegc情報には、コードキャッシュ領域の使用量が出力されます。

前提オプション

-XX:+HitachiVerboseGC

関連オプション

-XX:+HitachiCommaVerboseGC

-XX:CodeCacheInfoPrintRatio

出力形式

コードキャッシュ領域の使用量の出力形式を次に示します。

[id] <date> (Skip Full:full_count, Copy:copy_count)
[gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info]
[Tenured: tenured_info][Metaspace: metaspace_info]
[class space: class_space_info] [cause:cause_info] [User: user_cpu secs]
[Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size]
[TC: thread_count][DOE: doe_alloc_size, called_count]
[CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

このオプションによって出力される項目と出力内容を次に示します。

出力項目

出力内容

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

cc_info

保守情報。

コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージの出力形式を次に示します。

[cc_id]<cc_date>CodeCache usage has exceeded the threshold.
[cc_used_sizeK, cc_max_sizeK, cc_infoK]

メッセージの出力内容を次に示します。

出力項目

出力内容

cc_id

CCI（JavaVMログファイル識別子）。

cc_date

JITコンパイルを実行した日時。

cc_used_size

JITコンパイル後のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

cc_info

保守情報。

書式

-XX:[+|-]PrintCodeCacheInfo

指定できる値

型：String

-XX:+PrintCodeCacheInfo

コードキャッシュ領域の使用量を出力します。

また、コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージを出力します。

-XX:-PrintCodeCacheInfo

コードキャッシュ領域の使用量を出力しません。

また、コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージを出力しません。

デフォルト値

定義項目の省略

-XX:+PrintCodeCacheInfo

出力例

コードキャッシュ領域の使用量の出力例を次に示します。

出力例1（-XX:+HitachiVerboseGCオプションのSerialGCの場合）

[VGC]<Thu Oct 02 10:38:53.658 2014>(Skip Full:1,Copy:0)
[Full GC 770K->682K(8064K), 0.0050003 secs][DefNew::Eden: 88K->0K(2304K)]
[DefNew::Survivor: 0K->0K(256K)][Tenured: 681K->682K(5504K)]
[Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)]
[cause:System.gc][User: 0.0000000 secs][Sys: 0.0000000 secs]
[IM: 11944K, 12448K, 0K][TC: 22][DOE: 0K, 0][CCI: 1173K, 245760K, 2496K]

出力例2（-XX:+HitachiVerboseGCオプションのG1GCの場合）

GCに関するログ

[VG1]<Thu Oct 02 10:38:56.193 2014>
[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-]
[G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K]
[G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K]
[G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)]
[class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc]
[RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs]
[TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs]
[Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0]
[CCI: 1172K, 245760K, 2496K]

Concurrent Markingに関するログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start]
[User: 0.0000000 secs][Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End]
[User: 0.0126134 secs][Sys: 0.0146961 secs]
[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs]
[Sys: 0.0000000 secs]
[VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs]
[Sys: 0.2495800 secs]

出力例3（-XX:+HitachiCommaVerboseGCオプションのSerialGCの場合）

VGC,Thu Oct 02 10:38:52.442 2014,1,0,0,Full GC,770,682,8064,0.0040002,88,0,2304,
0,0,256,681,682,5504,3634,3634,4492,3634,3634,4492,356,356,388,356,356,388,1,0.
0000000,0.0000000,11913,12448,0,22,0,0,1173,245760,2496

出力例4（-XX:+HitachiCommaVerboseGCオプションのG1GCの場合）

GCに関するログ

VG1,Thu Oct 02 10:38:54.920 2014,Full GC,753,2048,8192,678,1024,8192,0.0064767,
-,1024,2048,0,2048,0,0,1024,1024,0,0,6144,7168,3634,3634,4492,3634,3634,4492,
356,356,388,356,356,388,1,1024,0.2000000,0.0000000,0,0,0.00,0.0000000,
0.0000000,20459,21920,0,35,0,0,1171,245760,2496

Concurrent Markingに関するログ

VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark Start,0.0000000,0.0000000
VCM,Fri Jul 26 21:35:50 2013,Concurrent Mark End,0.0124532,0.0245698

コードキャッシュ領域の使用量がしきい値に達したことを知らせるメッセージの出力例を次に示します。

出力例

[CCI]<Wed Dec 26 14:27:53 2012>CodeCache usage has exceeded the threshold.
[39358K, 49152K, 39360K]

注意事項

コードキャッシュ領域の使用量がしきい値に達した状態で推移している場合、JavaメソッドがJITコンパイルされてもメッセージは出力されません。

一方、コードキャッシュ領域の使用量がしきい値未満まで下がったあと、JavaメソッドがJITコンパイルされたことによって再びコードキャッシュ領域の使用量がしきい値に達した場合には、メッセージが出力されます。

システムが使用するコードキャッシュ領域は32ビット版で最大500キロバイト、64ビット版で最大2メガバイトです。そのため、システムのコードキャッシュ領域の使用量によっては、コードキャッシュ領域を最大サイズまで使用していない場合でも、コードキャッシュ領域が枯渇することがあります。

また、コードキャッシュ領域の使用量のしきい値に大きな値を指定している場合、メッセージを出力する前にコードキャッシュ領域が枯渇する場合があります。コードキャッシュ領域が枯渇する前にメッセージを出力したいときは、「コードキャッシュ領域の最大サイズ−しきい値」の値が4メガバイト以上になるように、-XX:CodeCacheInfoPrintRatio（コードキャッシュ領域使用率指定オプション）の値を指定してください。

7.8　OutOfMemoryError発生時の拡張機能で使用するJavaVMオプション

OutOfMemory発生時の出力情報や動作に関する設定をするためのオプションを説明しています。

7.8.1　-XX:[+|-]HitachiOutOfMemoryAbort

OutOfMemoryError発生時に強制終了する機能の有効または無効を設定します。

説明

次の原因でOutOfMemoryErrorが発生した場合、標準出力にメッセージを出力して強制終了します。

Javaヒープ不足の場合

Metaspace不足の場合

Compressed Class Space不足の場合

J2SEクラスライブラリー中でのCヒープ不足の場合

なお、JavaVM処理中にCヒープ不足となった場合には、このオプションの指定に関係なく、強制停止します。

強制終了時のJavaVMの終了コード

1

書式

-XX:[+|-]HitachiOutOfMemoryAbort

指定できる値

型：String

-XX:+HitachiOutOfMemoryAbort

OutOfMemoryError発生時に強制終了します。

-XX:-HitachiOutOfMemoryAbort

OutOfMemoryError発生時に強制終了しません。

デフォルト値

定義項目の省略

-XX:-HitachiOutOfMemoryAbort

出力例

java.lang.OutOfMemoryError occurred.
JavaVM aborted because of specified -XX:+HitachiOutOfMemoryAbort options.

注意事項

-XX:+HitachiOutOfMemoryStackTraceオプションが指定されている場合は、JavaVMログファイルにスタックトレースを出力したあとに終了します。

このオプションが指定されている場合、java.io.File.deleteOnExitメソッドやjava.lang.Runtime.addShutdownHookメソッドで登録している、JavaVM終了時の処理は実行されないで強制終了します。

7.8.2　-XX:[+|-]HitachiOutOfMemoryAbortThreadDump

OutOfMemoryError発生時にスレッドダンプを出力します。

説明

OutOfMemoryError発生時にスレッドダンプを出力します。ただし、J2SEクラスライブラリーでCヒープ不足の場合は、スレッドダンプの出力による再度のCヒープ不足発生を避けるため、スレッドダンプは出力しません。

スレッドダンプの出力先は環境変数JAVACOREDIR、または-XX:+HitachiThreadDumpToStdoutオプションで指定します。

前提オプション

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump

指定できる値

型：String

-XX:+HitachiOutOfMemoryAbortThreadDump

OutOfMemoryError発生時にスレッドダンプを出力します。

-XX:+HitachiOutOfMemoryAbortオプションが指定されている場合に、このオプションは指定できます。

-XX:-HitachiOutOfMemoryAbortThreadDump

OutOfMemoryError発生時にスレッドダンプを出力しません。

デフォルト値

定義項目の省略

-XX:+HitachiOutOfMemoryAbortThreadDump

7.8.3　-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

OutOfMemoryError発生時に出力するスレッドダンプログファイルに、クラス別統計情報を出力します。

説明

-XX:+HitachiOutOfMemoryAbortThreadDumpで出力するスレッドダンプログファイルにクラス別統計情報を出力するかどうかを指定します。

なお、G1GCを使用している場合、この機能は使用できません。G1GC使用時にこの機能を有効にするオプションを指定した場合、指定内容は反映されないで、この機能は無効となります。

前提オプション

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryAbortThreadDump

-XX:+HitachiThreadDump

書式

-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

指定できる値

型：String

-XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

-XX:+HitachiOutOfMemoryAbortThreadDumpで出力するスレッドダンプログファイルにクラス別統計情報を出力します。

-XX:-HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

-XX:+HitachiOutOfMemoryAbortThreadDumpで出力するスレッドダンプログファイルにクラス別統計情報を出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

出力例

Java Heap Profile
-----------------------
________________Size__Instances__Class________________
              856560          5 [Ljava.io.ObjectStreamField;
              113488          2 java.lang.ThreadGroup
              113280          2 [Ljava.lang.Thread;
              108264          2 java.io.PrintStream
...
                  64          1 classA
...
                  32          1 classB
...
                  16          1 classD
...
                  16          1 classC
...

7.8.4　-XX:[+|-]HitachiOutOfMemoryCause

OutOfMemoryError発生時の発生要因種別を出力します。

説明

OutOfMemoryError発生時の発生要因種別を出力するかどうかを指定します。

出力される要因種別を次に示します。

表7‒7　例外発生要因種別一覧

項番

要因メッセージ

説明

1

C Heap

Cヒープ確保時の例外

2

Java Heap

Javaヒープ確保時の例外

3

Meta Space

Metaspace確保時の例外

4

Compressed Class Space

Compressed Class Space確保時の例外

5

Unknown

上記例外を特定できない場合

6

Thread Limit

スレッド数の上限値設定機能（-XX:HitachiThreadLimitオプション）を指定した場合に、作成したスレッド数が指定した上限値を超えたときの例外

書式

-XX:[+|-]HitachiOutOfMemoryCause

指定できる値

型：String

-XX:+HitachiOutOfMemoryCause

OutOfMemoryError発生時に、例外発生要因種別をJavaVMログファイルに出力します。

-XX:+HitachiOutOfMemoryStackTraceオプションが指定されている場合は、このオプションも設定されます。

-XX:-HitachiOutOfMemoryCause

OutOfMemoryError発生時に、例外発生要因種別をJavaVMログファイルに出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiOutOfMemoryCause

出力例

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>[java.lang.OutOfMemoryError
:(C Heap) : unable to create thread : 340 threads exist]

7.8.5　-XX:[+|-]HitachiOutOfMemorySize

OutOfMemoryError発生時に要求したメモリーのサイズを出力します。

説明

OutOfMemoryError発生時に要求したメモリーのサイズを出力します。

書式

-XX:[+|-]HitachiOutOfMemorySize

指定できる値

型：String

-XX:+HitachiOutOfMemorySize

OutOfMemoryError発生時に、要求したメモリーサイズをバイト単位で出力します。

-XX:+HitachiOutOfMemoryStackTraceオプションが指定されている場合は、このオプションも設定されます。

-XX:-HitachiOutOfMemorySize

OutOfMemoryError発生時に、要求したメモリーサイズを出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiOutOfMemorySize

出力例

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>
[java.lang.OutOfMemoryError :　 requested 1024 bytes. (Java Heap) :
20 threads exist]

注意事項

次の場合、要求したメモリーサイズが取り出せません。

Javaのメモリー確保機能を使用してなくて、明示的にOutOfMemoryErrorをスローした（J2SEクラスライブラリーがスローするものを含みます）場合。

（例）

throw new OutOfMemoryError();

クラスロード時のverifierがOutOfMemoryErrorを発生させた場合。

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>
[java.lang.OutOfMemoryError :　 requested size unknown. (Unknown) :
10 threads exist]

7.8.6　-XX:[+|-]HitachiOutOfMemoryStackTrace

OutOfMemoryError発生時に、例外情報とスタックトレースをJavaVMログファイルへ出力します。

説明

OutOfMemoryError発生時に、例外情報とスタックトレースをJavaVMログファイルに出力するかどうかを指定します。

出力形式

[id] [Thread:thread_id]<date>[java.lang.OutOfMemoryError :
requested size bytes (cause) : reason : thread_count threads exist]
[id] [Thread:thread_id] stack_trace

出力内容を次に説明します。

出力項目

出力内容

id

OOM（JavaVMログファイル識別子）。

thread_id

スレッドID（スレッドダンプに出力されているtid）。

date

OutOfMemory例外発生日時。

size

確保しようとしたメモリーのサイズ（単位：バイト）が出力されます。-XX:-HitachiOutOfMemorySizeオプションが指定されている場合、出力されません。

なお、次の場合は要求したメモリーサイズが取り出せません。これらの場合は、サイズとして「unknown」が出力されます。

Javaのメモリー確保機能を使用しないで、明示的にOutOfMemoryErrorをスローした場合

標準クラスライブラリーによってスローされるものも含みます。例えば、「throw new OutOfMemoryError();」などの処理によってスローされた場合、メモリーサイズは出力できません。

クラスロード時のverifierによってOutOfMemoryErrorが発生した場合

cause

例外発生要因種別※。ただし、-XX:-HitachiOutOfMemoryCauseオプションが指定されている場合は出力されません。

reason

例外発生理由。スレッドの作成に失敗した場合に出力されます。

thread_count

OutOfMemoryError発生時のスレッド数。作成に失敗したスレッド数も含みます。

stack_trace

スタックトレース

注※

例外発生要因種別を次に示します。

表7‒8　例外発生要因種別一覧

項番

要因メッセージ

説明

1

C Heap

Cヒープ確保時の例外

2

Java Heap

Javaヒープ確保時の例外

3

Meta Space

Metaspace確保時の例外

4

Compressed Class Space

Compressed Class Space確保時の例外

5

Unknown

上記例外を特定できない場合

6

Thread Limit

スレッド数の上限値設定機能（-XX:HitachiThreadLimitオプション）を指定した場合に、作成したスレッド数が指定した上限値を超えたときの例外

書式

-XX:[+|-]HitachiOutOfMemoryStackTrace

指定できる値

型：String

-XX:+HitachiOutOfMemoryStackTrace

OutOfMemoryError発生時に、例外情報とスタックトレースをJavaVMログファイルに出力します。

スタックトレースは1スタックごとにバッファーに格納し、コード変換したあとに出力します。スタックトレースの出力は、OutOfMemoryErrorがスローされるたびに行われるため、OutOfMemoryErrorをキャッチして再スローした場合には複数回出力されます。なお、スレッド作成時にOutOfMemoryErrorとなった場合は、スタックトレースは出力されません。

-XX:-HitachiOutOfMemoryStackTrace

OutOfMemoryError発生時に、スタックトレースをJavaVMログファイルに出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiOutOfMemoryStackTrace

出力例

[OOM][Thread: 0x00062fd0] <Wed Mar 17 00:41:17 2004>
[java.lang.OutOfMemoryError :requested 400000 bytes.(C Heap):
unable to create thread : 1500 threads exist]
[OOM][Thread: 0x00062fd0] at java.lang.Thread.start(Native Method)
[OOM][Thread: 0x00062fd0] at sub1.<init>(Thread0012.java:22)
[OOM][Thread: 0x00062fd0] at Thread0012.test01(Thread0012.java:73)
[OOM][Thread: 0x00062fd0] at Thread0012.main(Thread0012.java:57)

注意事項

JavaVM自身で作成するスレッドが、メモリー不足によってスレッドの作成に失敗した場合は、例外情報だけが出力されます。スタックトレースは出力されません。

7.8.7　-XX:HitachiOutOfMemoryStackTraceLineSize

OutOfMemoryError発生時に、出力するスタックトレース1行の文字数をバイト数で指定します。

説明

OutOfMemoryError発生時に、出力するスタックトレース1行の文字数をバイト数で指定します。オプションの指定がない場合は、1024バイトがデフォルトで設定されます。指定したバイト数が確保できない場合は警告メッセージが出力され、スタックトレースは出力されません。また、1行の文字数が指定した文字数を超えた場合、「at」以降の文字列の前半部分を削除して、指定された文字数分出力します。

なお、-XX:+JavaLogAsynchronousオプションを指定している場合、このオプションには4096が設定されます。

前提オプション

-XX:+HitachiOutOfMemoryStackTrace

書式

-XX:HitachiOutOfMemoryStackTraceLineSize=整数値

指定できる値

整数値

型：Integer

1024〜2147483647の範囲で整数値（単位：バイト）を指定します。範囲外の値が指定された場合は1024が設定されます。負の値を指定した場合はエラーとなります。

デフォルト値

定義項目の省略

-XX:HitachiOutOfMemoryStackTraceLineSize=1024

7.9　クラスライブラリートレース機能で使用するJavaVMオプション

クラスライブラリーのスタックトレースの出力情報に関する設定をするためのオプションを説明しています。

7.9.1　-XX:[+|-]HitachiJavaClassLibTrace

クラスライブラリーのスタックトレースを出力します。

説明

次に示すシステム全体に影響を与えるメソッドが使用された場合、これらのAPIのスタックトレースを、JavaVMログファイルへ出力します。

java.lang.System.gc

java.lang.System.exit

java.lang.System.runFinalizersOnExit

java.lang.Runtime.exit

java.lang.Runtime.halt

java.lang.Runtime.runFinalizersOnExit

出力形式

[id] [Thread:thread_id]<date>
[id] [Thread:thread_id] stack_trace

出力項目

出力内容

id

CLT（JavaVMログファイル識別子）。

thread_id

スレッドID（スレッドダンプに出力されているtid）。

date

クラスライブラリー使用日時。

stack_trace

スタックトレース。

書式

-XX:[+|-]HitachiJavaClassLibTrace

指定できる値

型：String

-XX:+HitachiJavaClassLibTrace

クラスライブラリーのスタックトレースを出力します。

-XX:-HitachiJavaClassLibTrace

クラスライブラリーのスタックトレースを出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiJavaClassLibTrace

出力例

出力例1

[CLT][Thread: 0x00286348]<Thu Oct 21 14:55:50 2004>
[CLT][Thread: 0x00286348] at java.lang.Shutdown.halt0(Native Method)
[CLT][Thread: 0x00286348] at java.lang.Shutdown.halt(Shutdown.java:145)
[CLT][Thread: 0x00286348] at java.lang.Shutdown.exit(Shutdown.java:222)
[CLT][Thread: 0x00286348] at java.lang.Runtime.exit(Runtime.java:90)
[CLT][Thread: 0x00286348] at java.lang.System.exit(System.java:715)
[CLT][Thread: 0x00286348] at J250048_02.main(J250048_02.java:4)

出力例2

[CLT][Thread: 0x009c4000]<Tue Oct 09 15:36:18 2012>
[CLT][Thread: 0x009c4000] at java.lang.Runtime.outputJavaClassLibTrace
(Native Method)
[CLT][Thread: 0x009c4000] at java.lang.Runtime.runFinalizersOnExit
(Runtime.java:378)
[CLT][Thread: 0x009c4000] at java.lang.System.runFinalizersOnExit
(System.java:978)
[CLT][Thread: 0x009c4000] at Program.main(Program.java:8)

7.9.2　-XX:HitachiJavaClassLibTraceLineSize

クラスライブラリーのスタックトレースの1行の文字数をバイト数で指定します。

説明

-XX:+HitachiJavaClassLibTraceオプションを指定した場合に出力される、クラスライブラリーのスタックトレースの1行の文字数をバイト数で指定します。

なお、-XX:+JavaLogAsynchronousオプションを指定している場合、このオプションには4096が設定されます。

前提オプション

-XX:+HitachiJavaClassLibTrace

書式

-XX:HitachiJavaClassLibTraceLineSize=整数値

指定できる値

整数値

型：Integer

1024〜2147483647の範囲で整数値（単位：バイト）を指定します。範囲外の値が指定された場合は1024が設定されます。

デフォルト値

定義項目の省略

-XX:HitachiJavaClassLibTraceLineSize=1024

出力例

[CLT][Thread: 0x00286c58]<Thu Oct 21 14:56:24 2004>
[CLT][Thread: 0x00286c58] at java.lang.Runtime.gc(Native Method)
[CLT][Thread: 0x00286c58] at java.lang.System.gc(System.java:737)
[CLT][Thread: 0x00286c58] at mple.func_012345678〜省略〜xyz(Sample.java:9)
[CLT][Thread: 0x00286c58] at Sample.main(Sample.java:5)

1行の文字数が指定したバイト数を超える場合、「at」以降の文字列の前半部分が削除されます。出力例の場合、4行目のSampleの前半が削除されてmpleとなります。

7.10　ローカル変数情報出力機能で使用するJavaVMオプション

ローカル変数情報の出力を設定するためのオプションを説明しています。

7.10.1　-XX:HitachiCallToString

該当するクラスのローカル変数オブジェクトに対して取得したStringオブジェクトの文字列を、変数値を表現する文字列として出力します。

説明

適用範囲に該当するクラスのローカル変数オブジェクトに対して取得したStringオブジェクトの文字列を、変数値を表現する文字列として出力します。

なお、ローカル変数に格納されているオブジェクトがない場合、またはJavaVM内部のオブジェクトの場合は、出力されません。

前提オプション

-XX:+HitachiLocalsInThrowable

書式

-XX:HitachiCallToString=適用範囲

指定できる値

適用範囲

型：String

minimalを指定します。

java.langパッケージ内の次に示すクラスが対象になります。

String

StringBuffer

Boolean

Byte

Character

Short

Integer

Long

Float

Double

なお、空文字（""）を指定した場合も、minimalと同じです。

デフォルト値

定義項目の省略

-XX:HitachiCallToString=minimal

出力例

次のJavaプログラム例を使用した出力例（簡易出力フォーマット）を、次に示します。

Javaプログラム例

class Example3 {
    public static void main(String[] args) {
        Example3 e3 = new Example3();
        e3.method();  // 4行目
    }

    void method() {
        String l1 = "local 1";
        StringBuffer l2 = new StringBuffer(l1);
        l2.append(" + local 2");
        Boolean l3 = new Boolean(false);
        Character l4 = new Character('X');
        Long l5 = new Long(Long.MIN_VALUE);  // long型の最小値
        Object l6 = new Thread();
        Object[] l7 = new Thread[10];

        try {
          <例外発生!>  // 18行目
        } catch (Exception e) {
          e.printStackTrace();
        }
    }

    public String toString() {
        return "I am an Example3 instance.";
    }
}

出力例1

-XX:HitachiCallToString=minimalの場合

  at Example3.method(Example3.java:18)
    locals:
      (Example3) this = <0xaa07db58>
      (java.lang.String) l1 = <0xae173a28> "local 1"
      (java.lang.StringBuffer) l2 = <0xaa07dca0> "local 1 + local 2"
      (java.lang.Boolean) l3 = <0xaa07de18> "false"
      (java.lang.Character) l4 = <0xaa07df68> "X"
      (java.lang.Long) l5 = <0xaa07e078> "-9223372036854775808"
      (java.lang.Object) l6 = <0xaa07e1a8>
      (java.lang.Object[]) l7 = <0xaa07e298>
  at Example3.main(Example3.java:4)
    locals:
...

注意事項

ローカル変数情報を完全に収集するためには、javacでclassファイルを生成する際に、-gオプションまたは-g:varsオプションを付加してclassファイル内にローカル変数情報を埋め込んでおく必要があります。-gオプションまたは-g:varsオプションを付加しないで作成されたclassファイルについては、収集可能な範囲でローカル変数情報が出力されます。

7.10.2　-XX:[+|-]HitachiLocalsInStackTrace

スレッドダンプ出力時のスタックトレースに、各メソッドのローカル変数情報を追加して出力します。

説明

スレッドダンプ出力時のスタックトレースに、各メソッドのローカル変数情報を追加して出力します。

書式

-XX:[+|-]HitachiLocalsInStackTrace

指定できる値

型：String

-XX:+HitachiLocalsInStackTrace

スレッドダンプ出力時のスタックトレースに、ローカル変数情報を出力します。

-XX:-HitachiLocalsInStackTrace

スレッドダンプ出力時のスタックトレースに、ローカル変数情報を出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiLocalsInStackTrace

出力例

次のJavaプログラム例を使用した出力例を、次に示します。

Javaプログラム例

class Example2 {
    public static void main(String[] args) {
        Example2 e2 = new Example2();
        e2.method();  // 4行目
    }

    synchronized void method() {
        int l1 = 1;
        float l2 = 2.0f;
        String l3 = "local 3";
        Character l4 = new Character('X');
        Object l5 = new Thread();
        Object[] l6 = new Thread[10];

        <ここでスレッドダンプ出力!>  // 15行目
    }
}

出力例

-XX:+HitachiLocalsSimpleFormatオプションおよび-XX:+HitachiTrueTypeInLocalsオプションが指定されている場合

"main" #1 prio=5 os_prio=0 jid=<N/A> tid=0x0000000000297800 nid=0x11500
runnable [0x0000000002a8f000..0x0000000002a8f6c0]
   java.lang.Thread.State: RUNNABLE
  stack=
[0x0000000002a90000..0x0000000002994000..0x0000000002991000..0x0000000002990000]
  [user cpu time=3790ms, kernel cpu time=78ms] [blocked count=0, waited count=0]
 at Example2.method(Unknown Source)
 - locked <0x00000000120d03a8> (a Example2)
   locals:
     (Example2) this = <0x00000000120d03a8>
     (int) l1 = 1
     (float) l2 = 2
     (java.lang.String) l3 = <0x00000000120d03b8>
     (java.lang.Character) l4 = <0x00000000120d0600>
     (java.lang.Object) l5 = <0x00000000120d07f8>
     (java.lang.Object[]) l6 = <0x00000000120d0bc8>
 at Example2.main(Unknown Source)
   locals:
     (java.lang.String[]) args [arg1] = <0x00000000120d0390>
     (Example2) e2 = <0x00000000120d03a8>

注意事項

ローカル変数情報を完全に収集するためには、javacでclassファイルを生成する際に、-gオプションまたは-g:varsオプションを付加してclassファイル内にローカル変数情報を埋め込んでおく必要があります。-gオプションまたは-g:varsオプションを付加しないで作成されたclassファイルについては、収集可能な範囲でローカル変数情報が出力されます。

一般にスタックトレース情報の収集を行うスレッドと収集対象のスレッドは一致しません。このため、情報収集を行うためには、対象スレッドを停止させる必要があり、toStringメソッドを呼び出すことはできません。このため、-XX:HitachiCallToStringオプションの指定は無効になります。

制御構造が複雑で行数が多いメソッドのローカル変数情報を出力する場合、解析に時間が掛かるため、拡張スレッドダンプの出力やスレッドスタックトレースの取得に時間が掛かることがあります。

7.10.3　-XX:[+|-]HitachiLocalsInThrowable

スタックトレース中のメソッドのローカル変数情報を出力します。

説明

java.lang.Throwable.fillInStackTraceメソッド実行時に、スタックトレース中のメソッドのローカル変数情報を収集します。

出力形式

    locals:
      name: name
      type: type
      value: value
...

1行目に「locals:」という見出しが出力されます。

2行目以降は、収集できた各ローカル変数の情報が1行ずつ出力されます。

出力されるローカル変数の情報を次に示します。

変数名

型名（基本型名、クラス名または配列型名）

変数値を表現する文字列

なお、各ローカル変数の出力内容は、空行で区切られています。

出力項目

出力内容

name

ローカル変数名。

メソッドに渡される引数の場合は、変数名に続いて[arg***]（***は引数番号）が表示されます。

type

ローカル変数の型名（基本型名、クラス名または配列型名）。

value

ローカル変数の値を表現する文字列。

基本型

値をそのまま文字列化したもの

クラスまたは配列型

変数値がnullの場合：(null)

それ以外の場合：オブジェクトの存在するアドレス

値表現の最大文字列長は64文字です。これを超える場合は64文字目までを出力したあと、「...」という文字列が出力されます。クラスまたは配列型の場合、次の追加オプションを指定することでより詳細な表現が追加できます。

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:HitachiCallToString

書式

-XX:[+|-]HitachiLocalsInThrowable

指定できる値

型：String

-XX:+HitachiLocalsInThrowable

スタックトレース中のメソッドのローカル変数情報を出力します。

ただし、java.lang.StackOverflowError発生時には、このオプションは無視されます。

-XX:-HitachiLocalsInThrowable

スタックトレース中のメソッドのローカル変数情報を出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiLocalsInThrowable

出力例

次のJavaプログラム例を使用した出力例を、次に示します。

Javaプログラム例

class Example1 {
    public static void main(String[] args) {
        Example1 e1 = new Example1();
        Object obj = new Object();
        e1.method(1, 'Q', obj);  // 5行目
    }

    void method(int l1, char l2, Object l3) {
        float l4 = 4.0f;
        boolean l5 = true;
        double l6 = Double.MAX_VALUE; // double型の最大値
        Object[] l7 = new Object[10];

        try {
          <例外発生!>  // 15行目
        } catch (Exception e) {
          e.printStackTrace();
        }
    }
}

出力例1

すべてのローカル変数情報が出力される場合

  at Example1.method(Example1.java:15)
    locals:
      name: this
      type: Example1
      value: <0x922f42d0>

      name: l1 [arg1]
      type: int
      value: 1

      name: l2 [arg2]
      type; char
      value: 'Q'

      name: l3 [arg3]
      type: java.lang.Object
      value: <0xaf112f08>

      name: l4
      type: float
      value: 4

      name: l5
      type: boolean
      value: true

      name: l6
      type: double
      value: 1.79769E+308

      name: l7
      type: java.lang.Object[]
      value: <0x922f42d8>

  at Example1.main(Example1.java:5)
    locals:
...

出力例2

ローカル変数情報が存在しない場合

-gオプションまたは-g:varsオプションを付加しないでclassファイルを生成した場合

-gオプションまたは-g:varsオプションを付加して生成したclassファイルの、nativeメソッドの場合

  at Example1.method(Example1.java:15)
    locals:
      name: this
      type: Example1
      value: <0x922f42d0>

      name: [arg1]
      type: int
      value: 1

      name: [arg2]
      type; char
      value: 'Q'

      name: [arg3]
      type: java.lang.Object
      value: <0xaf112f08>

  at Example1.main(Example1.java:5)
    locals:
...

注意事項

ローカル変数情報を完全に収集するためには、javacでclassファイルを生成する際に、-gオプションまたは-g:varsオプションを付加してclassファイル内にローカル変数情報を埋め込んでおく必要があります。-gオプションまたは-g:varsオプションを付加しないで作成されたclassファイルについては、収集可能な範囲でローカル変数情報が出力されます。

-gオプションまたは-g:varsオプションを付加して生成されたclassファイルでも、nativeメソッドの場合はローカル変数情報が存在しません。

JITコンパイラーがメソッドをJITコンパイルする際、最適化の一環として、不要と判断したローカル変数を除去することがあります。

（例）int not_used = 12345などの宣言および初期化以降未使用のローカル変数

この場合、例外発生時点のローカル変数情報には、次の値が出力されます。

型名

出力情報

boolean型

false

char型

'¥0'

byte型

short型

int型

long型

float型

double型

0

クラス型

配列型

(null)

制御構造が複雑で行数が多いメソッドのローカル変数情報を出力する場合、解析に時間が掛かるため、例外発生時の例外オブジェクト生成処理に時間が掛かることがあります。

java.lang.ThreadクラスのgetStackTraceメソッドを使用して取得した、カレントスレッドのスタックトレースにローカル変数情報を出力するためには、例外発生時のスタックトレースにローカル変数情報を出力する、例外発生時のローカル変数情報収集オプション（-XX:+HitachiLocalsInThrowable）が必要になります。

7.10.4　-XX:[+|-]HitachiLocalsSimpleFormat

ローカル変数情報の出力フォーマットを、1変数1行で出力する簡易出力フォーマットに変更します。

説明

ローカル変数情報の出力フォーマットを、1変数1行で出力する簡易出力フォーマットに変更します。

前提オプション

-XX:+HitachiLocalsInThrowable

-XX:+HitachiLocalsInStackTrace

出力形式

    locals:
      (type) name = value
      (type) name = value
...

出力内容を次に示します。

出力項目

出力内容

name

ローカル変数名。

メソッドに渡される引数の場合は、変数名に続いて[arg***]（***は引数番号）が表示されます。

type

ローカル変数の型名（基本型名、クラス名または配列型名）。

value

ローカル変数の値を表現する文字列。

基本型

値をそのまま文字列化したもの

クラスまたは配列型

変数値がnullの場合：(null)

それ以外の場合：オブジェクトの存在するアドレス

値表現の最大文字列長は64文字です。これを超える場合は64文字目までを出力したあと、「...」という文字列が出力されます。クラスまたは配列型の場合、次の追加オプションを指定することでより詳細な表現が追加できます。

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:HitachiCallToString

書式

-XX:[+|-]HitachiLocalsSimpleFormat

指定できる値

型：String

-XX:+HitachiLocalsSimpleFormat

ローカル変数情報出力を、簡易フォーマットで出力します。

-XX:-HitachiLocalsSimpleFormat

ローカル変数情報出力を、通常フォーマットで出力します。

デフォルト値

定義項目の省略

-XX:-HitachiLocalsSimpleFormat

出力例

次のJavaプログラム例を使用した出力例を、次に示します。

Javaプログラム例

class Example1 {
    public static void main(String[] args) {
        Example1 e1 = new Example1();
        Object obj = new Object();
        e1.method(1, 'Q', obj);  // 5行目
    }

    void method(int l1, char l2, Object l3) {
        float l4 = 4.0f;
        boolean l5 = true;
        double l6 = Double.MAX_VALUE; // double型の最大値
        Object[] l7 = new Object[10];

        try {
          <例外発生!>  // 15行目
        } catch (Exception e) {
          e.printStackTrace();
        }
    }
}

出力例

  at Example1.method(Example1.java:15)
    locals:
      (Example1) this = <0x922f42d0>
      (int) l1 [arg1] = 1
      (char) l2 [arg2] = 'Q'
      (java.lang.Object) l3 [arg3] = <0xaf112f08>
      (float) l4 = 4
      (boolean) l5 = true
      (double) l6 = 1.79769E+308
      (java.lang.Object[]) l7 = <0x922f42d8>
  at Example1.main(Example1.java:5)
    locals:
...

7.10.5　-XX:[+|-]HitachiTrueTypeInLocals

ローカル変数情報に、実際のオブジェクト型名を出力します。

説明

ローカル変数情報収集時に、クラスまたは配列型のローカル変数について、実際に代入されているオブジェクトの型名を出力します。変数値を表現する文字列の後ろの丸括弧内に表示されます。

なお、ローカル変数に格納されているクラスまたは配列型のオブジェクトがJavaVM内部のオブジェクトの場合は、"internal type"と出力されます。

前提オプション

-XX:+HitachiLocalsInThrowable

-XX:+HitachiLocalsInStackTrace

書式

-XX:[+|-]HitachiTrueTypeInLocals

指定できる値

型：String

-XX:+HitachiTrueTypeInLocals

ローカル変数情報に、実際のオブジェクト型名を出力します。

-XX:-HitachiTrueTypeInLocals

ローカル変数情報に、実際のオブジェクト型名を出力しません。

デフォルト値

定義項目の省略

-XX:-HitachiTrueTypeInLocals

出力例

次のJavaプログラム例を使用した出力例を、次に示します。

Javaプログラム例

class Example3 {
    public static void main(String[] args) {
        Example3 e3 = new Example3();
        e3.method();  // 4行目
    }

    void method() {
        String l1 = "local 1";
        StringBuffer l2 = new StringBuffer(l1);
        l2.append(" + local 2");
        Boolean l3 = new Boolean(false);
        Character l4 = new Character('X');
        Long l5 = new Long(Long.MIN_VALUE);  // long型の最小値
        Object l6 = new Thread();
        Object[] l7 = new Thread[10];

        try {
          <例外発生!>  // 18行目
        } catch (Exception e) {
          e.printStackTrace();
        }
    }

    public String toString() {
        return "I am an Example3 instance.";
    }
}

出力例

-XX:+HitachiLocalsSimpleFormatオプションおよび-XX:HitachiCallToString=fullが指定されている場合

  at Example3.method(Example3.java:18)
    locals:
      (Example3) this = <0xaa07db58> "I am an Example3 instance." (Example3)
      (java.lang.String) l1 = <0xae173a28> "local 1" (java.lang.String)
      (java.lang.StringBuffer) l2 = <0xaa07dca0> "local 1 + local 2"
      (java.lang.StringBuffer)
      (java.lang.Boolean) l3 = <0xaa07de18> "false" (java.lang.Boolean)
      (java.lang.Character) l4 = <0xaa07df68> "X" (java.lang.Character)
      (java.lang.Long) l5 = <0xaa07e078> "-9223372036854775808" (java.lang.Long)
      (java.lang.Object) l6 = <0xaa07e1a8> "Thread[Thread-0,5,main]"
      (java.lang.Thread)
      (java.lang.Object[]) l7 = <0xaa07e298> "[Ljava.lang.Thread;@26e431"
      (java.lang.Thread[])
  at Example3.main(Example3.java:4)
    locals:
...

7.11　明示管理ヒープ機能で使用するJavaVMオプション

FullGCの発生を抑止する機能（明示管理ヒープ機能）を使用するためのオプションを説明しています。

7.11.1　-XX:ExplicitMemoryAutoReclaimTargetBlockRatio

明示管理ヒープ機能の自動解放処理で設定している解放率の上限値を指定します。

説明

このオプションは、Explicitヒープのチューニング、および自動配置機能によるExplicitヒープに配置するオブジェクトの選定を実施したあと、自動解放処理を繰り返し実行しても、Explicitヒープ領域の利用済みサイズが単調増加を続ける場合に使用するオプションです。Explicitメモリーブロックの自動解放処理では、自動解放処理対象のExplicitメモリーブロックを選択します。しかし、オブジェクトの参照関係によっては、1つのExplicitメモリーブロックを選択しただけではオブジェクトが削除できないで、複数のExplicitメモリーブロックを選択しなければ削除できない場合があります。このような場合に、このオプションを使用して、自動解放処理の対象とする選択量を増やします。

明示管理ヒープ機能の自動解放処理で設定している解放率の上限値を指定します。 解放率とは、自動解放処理で選択した量に対する、実際に自動解放処理で解放した量の割合を指します。

明示管理ヒープ機能では、自動解放処理の対象とする選択量を決定するために、過去の自動解放処理の解放率を使用しています。この解放率によって、Explicitヒープへの流入量に対して自動解放処理の対象とする選択量を調節し、Explicitヒープが単調増加しないようにしています。ただし、自動解放処理の対象とする選択量を増やすと、自動解放処理時間が長くなります。自動解放処理実行中は、FullGCと同様にアプリケーションの実行が停止します。そのため、自動解放処理時間が長くなり過ぎないように、自動解放処理の対象とする選択量に上限を設けています。

0を指定すると、このオプションを指定しない場合と同じ上限値となります。100を指定すると、過去の自動解放処理で設定している解放率の上限値を最大に引き上げます。ただし、自動解放処理の動作上、100を指定しても、Explicitヒープ内のすべてのオブジェクトが自動解放処理の対象となるわけではありません。

前提オプション

-XX:+HitachiUseExplicitMemory

-XX:+HitachiExplicitMemoryAutoReclaim

書式

-XX:ExplicitMemoryAutoReclaimTargetBlockRatio=整数値

指定できる値

整数値

型：Integer

0〜100の整数（単位：%）で指定します。

デフォルト値

定義項目の省略

-XX:ExplicitMemoryAutoReclaimTargetBlockRatio=0

値の省略

次のメッセージを標準エラーに出力して、JavaVMをリターンコード1で終了します。

Improperly specified VM option 'ExplicitMemoryAutoReclaimTargetBlockRatio='
Error: Could not create the Java Virtual Machine.
Error: A fatal exception has occurred. Program will exit.

7.11.2　-XX:ExplicitMemoryExcludeClassListFile

明示管理ヒープ機能適用除外設定ファイルのファイルパスを指定します。

説明

明示管理ヒープ機能適用除外クラス指定機能で利用する、明示管理ヒープ機能適用除外設定ファイルのファイルパスを指定します。このファイルに記述されているクラスには、明示管理ヒープ機能が適用されません。

JavaVM起動時に、このオプションに指定したファイルパスのファイルを明示管理ヒープ機能適用除外設定ファイルとして読み込みます。なお、このオプションを省略、または空文字を指定した場合は、デフォルトのファイルパスのファイルを明示管理ヒープ機能適用除外設定ファイルとして読み込みます。

前提オプション

-XX:+HitachiUseExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

関連オプション

-XX:ExplicitMemoryFullGCPolicy

-XX:+HitachiAutoExplicitMemory

-XX:ExplicitMemoryNotExcludeClassListFile

書式

-XX:ExplicitMemoryExcludeClassListFile:文字列

指定できる値

文字列

型：String

JavaVMプロセスのカレントディレクトリーからの相対パス、または絶対パスを指定します。パスはディレクトリー名を含めて指定できます。

なお、指定できる明示管理ヒープ機能適用除外設定ファイルは1つだけです。また、ファイルの文字エンコーディングには、ASCIIコードを使用してください。

デフォルト値

定義項目の省略

-XX:ExplicitMemoryExcludeClassListFile:<空文字>

<空文字>の場合に読み込まれるファイルパスを次に示します。

JDKのインストールディレクトリー¥usrconf¥exmemexcludeclass.cfg

注意事項

指定されたファイルがオープンできない、または読み込めない場合は、明示管理ヒープ機能のイベントログにワーニングメッセージを出力し、デフォルトパスにある設定ファイルを読み込みます。デフォルトパスにあるファイルをオープンできない、または読み込めない場合は、明示管理ヒープ機能適用除外クラス指定機能は有効になりません。

指定されたファイルの記述フォーマットに誤りがある場合は、明示管理ヒープ機能のイベントログにワーニングメッセージを出力して、次の行から構文解析処理を継続します。

明示管理ヒープ機能適用除外設定ファイルと、明示管理ヒープ機能適用除外無効設定ファイルの両方に、同じのクラス名が記述されていた場合は、明示管理ヒープ機能適用除外無効設定ファイルの指定が優先されます。この場合、そのクラスに対する明示管理ヒープ機能適用除外クラス指定機能は、無効になります。

7.11.3　-XX:ExplicitMemoryFullGCPolicy

FullGC発生時に、参照関係に基づくオブジェクトのJavaヒープからExplicitメモリーブロックへの移動を制御します。

説明

FullGC発生時に、参照関係に基づくオブジェクトのJavaヒープからExplicitメモリーブロックへの移動を制御するかどうかを指定します。このオプションを使用すると、FullGC発生時にExplicitヒープへ移動していたオブジェクトを、Tenured領域へ移動できます。

前提オプション

-XX:+HitachiUseExplicitMemory

関連オプション

-XX:+HitachiAutoExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

書式

-XX:ExplicitMemoryFullGCPolicy=数値

指定できる値

数値

型：Integer

0または1を指定します。範囲外の値が指定された場合は0が設定されます。

0を指定すると、FullGC発生時、Explicitメモリーブロック内にあるオブジェクトから参照されているJavaヒープ内のオブジェクトは、Explicitメモリーブロックへ移動します。

1を指定すると、FullGC発生時、Explicitメモリーブロック内にあるオブジェクトから参照されているJavaヒープ内のオブジェクトは、Explicitメモリーブロックへ移動しません。New領域にあるオブジェクトはTenured領域へ移動します。

デフォルト値

定義項目の省略

-XX:ExplicitMemoryFullGCPolicy=0

7.11.4　-XX:ExplicitMemoryNotExcludeClassListFile

明示管理ヒープ機能適用除外無効設定ファイルのファイルパスを指定します。

説明

明示管理ヒープ機能適用除外クラス指定機能で利用する、明示管理ヒープ機能適用除外無効設定ファイルのファイルパスを指定します。明示管理ヒープ機能適用除外設定ファイルに記述されていても、このファイルに記述されているクラスには、明示管理ヒープ機能適用除外クラス指定機能が適用されません。

JavaVM起動時に、このオプションに指定したファイルパスのファイルを明示管理ヒープ機能適用除外無効設定ファイルとして読み込みます。なお、このオプションを省略、または空文字を指定した場合は、デフォルトのファイルパスのファイルを明示管理ヒープ機能適用除外無効設定ファイルとして読み込みます。

前提オプション

-XX:+HitachiUseExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

関連オプション

-XX:ExplicitMemoryFullGCPolicy

-XX:HitachiAutoExplicitMemory

-XX:ExplicitMemoryExcludeClassListFile

書式

-XX:ExplicitMemoryNotExcludeClassListFile:文字列

指定できる値

文字列

型：String

JavaVMプロセスのカレントディレクトリーからの相対パス、および絶対パスを指定します。パスはディレクトリー名を含めて指定できます。

なお、指定できる明示管理ヒープ機能適用除外設定ファイルは1つだけです。また、ファイルの文字エンコーディングには、ASCIIコードを使用してください。

デフォルト値

定義項目の省略

-XX:ExplicitMemoryNotExcludeClassListFile:<空文字>

<空文字>の場合に読み込まれるファイルパスを次に示します。

JDKのインストールディレクトリー¥usrconf¥exmemnotexcludeclass.cfg

注意事項

指定されたファイルがオープンできない、または読み込めない場合は、明示管理ヒープ機能のイベントログにワーニングメッセージを出力し、デフォルトパスにある設定ファイルを読み込みます。デフォルトパスにあるファイルをオープンできない、または読み込めない場合は、明示管理ヒープ機能適用除外クラス指定機能は無効になりません。

指定されたファイルの記述フォーマットに誤りがある場合は、明示管理ヒープ機能のイベントログにワーニングメッセージを出力して、次の行から構文解析処理を継続します。

明示管理ヒープ機能適用除外設定ファイルと、明示管理ヒープ機能適用除外無効設定ファイルの両方に、同じのクラス名が記述されていた場合は、明示管理ヒープ機能適用除外無効設定ファイルの指定が優先されます。この場合、そのクラスに対する明示管理ヒープ機能適用除外クラス指定機能は、無効になります。

7.11.5　-XX:[+|-]ExplicitMemoryUseExcludeClass

明示管理ヒープ機能適用除外クラス指定機能の有効または無効を設定します。

説明

明示管理ヒープ機能適用除外クラス指定機能の有効、無効を指定します。明示管理ヒープ機能適用除外クラス指定機能を有効にすると、次のファイルに記述されているクラスには、明示管理ヒープ機能が適用されません。このため、ファイルに記述されているクラスのオブジェクトは、Explicitヒープではなく、Tenured領域に移動します。

JDKのインストールディレクトリー¥jre¥lib¥explicitmemory¥sysexmemexcludeclass.cfg

JDKのインストールディレクトリー¥usrconf¥exmemexcludeclass.cfg

前提オプション

-XX:+HitachiUseExplicitMemory

関連オプション

-XX:+HitachiAutoExplicitMemory

-XX:ExplicitMemoryFullGCPolicy

-XX:ExplicitMemoryExcludeClassListFile

-XX:ExplicitMemoryNotExcludeClassListFile

書式

-XX:[+|-]ExplicitMemoryUseExcludeClass

指定できる値

型：String

-XX:+ExplicitMemoryUseExcludeClass

明示管理ヒープ機能適用除外クラス指定機能を有効にします。

-XX:-ExplicitMemoryUseExcludeClass

明示管理ヒープ機能適用除外クラス指定機能を無効にします。

デフォルト値

定義項目の省略

-XX:-ExplicitMemoryUseExcludeClass

注意事項

明示管理ヒープ機能適用除外クラス指定機能を有効にすると、Explicitメモリーブロックへのオブジェクト移動制御機能も有効になります。

JavaVM内のクラス（java.lang、java.utilなど）は、明示管理ヒープ機能適用除外クラスとして指定できません。

7.11.6　-XX:[+|-]HitachiAutoExplicitMemory

Explicitメモリーブロックの自動配置機能の有効または無効を設定します。

説明

Explicitメモリーブロックの自動配置機能の有効、無効を指定します。有効にした場合、32-bit版、64-bit版に関係なく、JavaVM起動時にあらかじめ必要とするExplicitメモリーブロックを確保するようになります。ただし、起動時にメモリー空間に連続領域が確保できない環境の場合、JavaVMが起動できないため、注意が必要です。

なお、このオプションを有効にした場合、Explicitメモリーブロックの最小サイズは16キロバイトになります。無効に指定した場合、Explicitメモリーブロックの最小サイズは64キロバイトになります。

前提オプション

-XX:+HitachiUseExplicitMemory

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:-HitachiExplicitMemoryCompatibleToV8

関連オプション

-XX:HitachiAutoExplicitMemoryFile

書式

-XX:[+|-]HitachiAutoExplicitMemory

指定できる値

型：String

-XX:+HitachiAutoExplicitMemory

明示管理ヒープ機能の自動配置機能を有効にします。

-XX:-HitachiAutoExplicitMemory

明示管理ヒープ機能の自動配置機能を無効にします。

デフォルト値

定義項目の省略

-XX:-HitachiAutoExplicitMemory

7.11.7　-XX:HitachiAutoExplicitMemoryFile

Explicitメモリーブロックの自動配置機能で利用する自動配置設定ファイルのパスを指定します。

説明

Explicitメモリーブロックの自動配置機能で利用する自動配置設定ファイルのパスを指定します。

前提オプション

-XX:+HitachiAutoExplicitMemory

書式

-XX:HitachiAutoExplicitMemoryFile:文字列

指定できる値

文字列

型：String

JavaVMプロセスのカレントディレクトリーからの相対パス、および絶対パスを指定します。パスはディレクトリー名を含めて指定できます。

なお、指定できる自動配置設定ファイルは1つだけです。

1文字以上の文字列を指定した場合、明示管理ヒープ自動配置設定のデフォルト設定およびこのオプションで指定したファイルの設定が有効になります。

デフォルト値

定義項目の省略

-XX:HitachiAutoExplicitMemoryFile:<空文字>

注意事項

クラス名、およびメソッドの引数は、java.langパッケージのクラスも含め、すべて完全修飾クラス名で記述してください。

（誤った例）

String

（正しい例）

java.lang.String

ジェネリックス（総称）を用いたクラス名は記述できません。パラメーター化されていないクラス名（raw型）を記述してください。

（誤った例）

java.util.HashMap<java.lang.String, java.lang.Object>

（正しい例）

java.util.HashMap

ネストしたクラスは、「.」ではなく「$」で区切った名前を記述してください。

（誤った例）

java.util.AbstractMap.SimpleEntry

（正しい例）

java.util.AbstractMap$SimpleEntry

コンストラクターは、クラス名と同じメソッド名、または<init>と記述してください。MyMainクラスのコンストラクターの場合は次のように記述してください。

（例）

MyMain.MyMain()またはMyMain.<init>()

クラス名と同じ名前のメソッドが存在する場合、コンストラクターを指定しているのか、メソッドを指定しているのか判別できません。そのため、コンストラクター、およびメソッドの両方を指定したものとして扱われます。

（例）

MyMain.MyMain(int) # MyMainクラスのint引数を持つコンストラクターと# MyMain(int)メソッドの両方を生成点とする

静的初期化子は、<clinit>と記述してください。MyMainクラスの静的初期化子の場合、次のように記述します。

（例）

MyMain.<clinit>()

フィールド宣言時の代入によるオブジェクトの生成を生成点に指定する場合、生成点にデフォルトコンストラクターを記述します。

ユーザー指定オブジェクトの完全修飾クラス名に配列を指定することはできません。

（例）

java.lang.String[]

存在しないクラス名、メソッド名、およびバイトコードを持たないメソッド（nativeメソッドおよびabstractメソッド）を含む行が存在する場合、その行は存在しないものとして扱います。

ユーザー指定オブジェクトのクラス名にJ2SEの内部クラスを指定した場合、明示管理ヒープ機能が適切なクラス名に読み替えることがあります。例えば、java.util.HashMap$Entryをjava.util.HashMapに読み替えます。

7.11.8　-XX:HitachiExplicitHeapMaxSize

Explicitヒープ全体の最大サイズを指定します。

説明

Explicitヒープ全体の最大サイズを指定します。

前提オプション

-XX:+HitachiUseExplicitMemory

書式

-XX:HitachiExplicitHeapMaxSize=整数値

指定できる値

整数値

型：Integer

単位を使って、次に示す範囲で整数値（単位：バイト）を指定します。

32ビット版のJavaVMの場合

1〜2³¹-1（2147483647）

64ビット版のJavaVMの場合

1〜2⁶³-1（9223372036854775807）

使用できる単位を次に示します。なお、大文字・小文字は区別されません。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

設定した値が有効な値の範囲に含まれていない場合、次のメッセージを標準出力に出力してJavaVMをリターンコード1で終了します。

Invalid maximum explicit heap size: -XX:HitachiExplicitHeapMaxSize=[指定した値]
Could not create the Java virtual machine.

デフォルト値

定義項目の省略

-XX:HitachiExplicitHeapMaxSize=64m

7.11.9　-XX:[+|-]HitachiExplicitMemoryAutoReclaim

明示管理ヒープ機能の自動解放機能の有効または無効を設定します。

説明

明示管理ヒープ機能の自動解放機能を利用するかどうか指定します。

前提オプション

-XX:-HitachiExplicitMemoryCompatibleToV8

関連オプション

-XX:+HitachiAutoExplicitMemory

書式

-XX:[+|-]HitachiExplicitMemoryAutoReclaim

指定できる値

型：String

-XX:+HitachiExplicitMemoryAutoReclaim

明示管理ヒープ機能の自動解放機能を有効にします。

-XX:-HitachiExplicitMemoryAutoReclaim

明示管理ヒープ機能の自動解放機能を無効にします。

デフォルト値

定義項目の省略

-XX:+HitachiExplicitMemoryAutoReclaim

7.11.10　-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim

HTTPセッションで利用するExplicitヒープの省メモリー化機能の有効または無効を設定します。

説明

HTTPセッションで利用するExplicitヒープの省メモリー化機能の有効、無効を指定します。

無効にした場合は、Application Serverが作成したExplicitメモリーブロックの自動解放の自動予約をしません。

有効にした場合は、自動配置設定ファイルで作成されたExplicitメモリーブロックに加えて、HTTPセッションオブジェクトを配置するためにApplication Serverが作成したExplicitメモリーブロックに対して自動解放の自動予約をします。これによって、必要なExplicitヒープサイズを減少させることができます。

ただし、有効にした場合、稼働情報の出力内容に注意が必要です。

表7‒9　稼働情報ファイルの出力内容が異なる項目

稼働情報の種類

項目（ヘッダーファイルに出力される文字列）

省メモリー化機能を有効にした場合

省メモリー化機能を無効にした場合

HTTPセッションで取得したExplicitメモリーブロックの個数

HTTPSessionEMemoryBlockCount.HighWaterMark

HTTPSessionEMemoryBlockCount.LowWaterMark

HTTPSessionEMemoryBlockCount.Current

内部動作を反映した値が出力されるため、システムで有効なHTTPセッション数とは異なる値が出力されます。

システムで有効なHTTPセッション数が出力されます。

アプリケーションで利用するExplicitヒープ領域のサイズ

ApplicationEHeapSize.HighWaterMark

ApplicationEHeapSize.LowWaterMark

この機能が自動解放対象としたExplicitメモリーのサイズ＋自動配置機能で利用するExplicitメモリーのサイズの合計サイズとなります。

自動配置機能で利用されるExplicitメモリーのサイズが出力されます。

前提オプション

-XX:+HitachiExplicitMemoryAutoReclaim

書式

-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim

指定できる値

型：String

-XX:+HitachiExplicitMemoryAutoRefReclaim

HTTPセッションで利用するExplicitヒープの省メモリー化機能を有効にします。

-XX:-HitachiExplicitMemoryAutoRefReclaim

HTTPセッションで利用するExplicitヒープの省メモリー化機能を無効にします。

デフォルト値

定義項目の省略

-XX:-HitachiExplicitMemoryAutoRefReclaim

7.11.11　-XX:[+|-]HitachiExplicitMemoryCompatibleToV8

Explicitメモリーブロックを確保する方法を、08-00と同様にするかどうかを指定します。

説明

Explicitメモリーブロックを確保する方法を、08-00と同様にするかどうか指定します。08-50以降の新機能を利用しないで、08-00で動作するアプリケーションをそのまま08-50で動作させる場合、このオプションを有効にします。

なお、このオプションを利用する場合、明示管理ヒープの自動解放機能は無効になります。

前提オプション

-XX:+HitachiUseExplicitMemory

関連オプション

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:+HitachiAutoExplicitMemory

書式

-XX:[+|-]HitachiExplicitMemoryCompatibleToV8

指定できる値

型：String

-XX:+HitachiExplicitMemoryCompatibleToV8

08-00と同様の方法でExplicitメモリーブロックを確保します。

-XX:-HitachiExplicitMemoryCompatibleToV8

08-00と異なる方法でExplicitメモリーブロックを確保します。

デフォルト値

定義項目の省略

-XX:-HitachiExplicitMemoryCompatibleToV8

7.11.12　-XX:HitachiExplicitMemoryJavaLog

明示管理ヒープ機能のログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

説明

明示管理ヒープ機能のログファイルのプリフィクスおよびログファイルの出力先ディレクトリーを指定します。

同じカレントディレクトリーで複数のJavaVMプロセスを同時に実行した場合や、-XX:HitachiExplicitMemoryJavaLog:オプションで同じログ出力先を設定した複数のJavaVMプロセスを同時に実行した場合、明示管理ヒープ機能のログファイルに情報が正しく出力されません。複数のJavaVMプロセスを実行する場合は、-XX:HitachiExplicitMemoryJavaLog:オプションでプロセスごとにログ出力先が異なるようにパスを設定してください。

関連オプション

-XX:HitachiJavaLog

書式

-XX:HitachiExplicitMemoryJavaLog:文字列

指定できる値

文字列

型：String

プリフィクスおよびパスを指定します。このオプションを指定しない場合、文字列には、"ehjavalog"が設定されます。プリフィクス以下のファイル名称は、明示管理ヒープ機能のログファイルのローテーション方式によって異なります。

明示管理ヒープ機能のログファイルのローテーション方式がラップアラウンド方式の場合、ログファイル名は、文字列??.log（??は01〜99の通し番号）で生成されます。例えば、文字列に"Samp"を指定すると、ログファイル名はSamp01.logになります。

明示管理ヒープ機能のログファイルのローテーション方式がシフト方式の場合、出力対象となるカレントログファイルとバックアップファイルが生成されます。カレントログファイルは文字列.log、バックアップログファイルは文字列??.log（??は01〜98の通し番号）で生成されます。例えば、文字列に"Samp"を指定すると、カレントログファイル名はSamp.log、カレントログファイルがバックアップされると、バックアップログファイル名はSamp01.logになります。

プリフィクスおよびパスには次の3種類の指定ができます。

プリフィクスを指定する場合

指定した文字列のファイル名でカレントディレクトリーに出力されます。

パスを指定する場合

文字列にディレクトリーを指定した場合、そのディレクトリーにデフォルトの"ehjavalog"でファイルが作成されます。

パスとプリフィクスを同時に指定する場合

文字列にディレクトリーとプリフィクスを指定した場合、そのディレクトリーにファイルが作成されます。例えば、文字列に"d:¥temp¥Samp"を指定すると、d:¥tempディレクトリーに、ラップアラウンド方式ではSamp01.log、シフト方式ではSamp.logが生成されます。

デフォルト値

定義項目の省略

-XX:HitachiExplicitMemoryJavaLog:ehjavalog

7.11.13　-XX:HitachiExplicitMemoryJavaLogFileSize

明示管理ヒープ機能のログファイルの1ファイル当たりの最大ファイルサイズをバイト単位で指定します。

説明

1ファイルの最大ファイルサイズをバイト単位で設定します。

関連オプション

-XX:HitachiJavaLogFileSize

書式

-XX:HitachiExplicitMemoryJavaLogFileSize=整数値

指定できる値

整数値

型：Integer

8192〜2147483647の範囲で整数値（単位：バイト）を指定します。

範囲外の値が指定された場合は8192が設定されます。

デフォルト値

定義項目の省略

ラップアラウンド方式の場合

-XX:HitachiExplicitMemoryJavaLogFileSize=256k

シフト方式の場合

-XX:HitachiExplicitMemoryJavaLogFileSize=128M

注意事項

自然数以外の値が指定された場合は、定義していないオプションを指定した場合と同様の動作になります。

7.11.14　-XX:HitachiExplicitMemoryJavaLogNumberOfFile

明示管理ヒープ機能のログファイルを作成する最大ファイル数を指定します。

説明

ログファイルの単純増加を防ぐため、作成する最大ファイル数を指定します。

ローテーション方式がラップアラウンド方式で最大ファイル数を超えた場合は、再度最初に作成したファイルへ出力します。

ローテーション方式がシフト方式で最大ファイル数を超えた場合は、いちばん古いバックアップファイルを削除します。

関連オプション

-XX:HitachiJavaLogNumberOfFile

書式

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=整数値

指定できる値

整数値

型：Integer

1〜99の範囲で指定します。

ただし、100以上の値が指定された場合は99、0が指定された場合は1となります。

デフォルト値

定義項目の省略

ラップアラウンド方式の場合

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=4

シフト方式の場合

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=8

注意事項

自然数以外の値が指定された場合は、定義していないオプションを指定した場合と同様の動作になります。

7.11.15　-XX:HitachiExplicitMemoryLogLevel

明示管理ヒープ機能のイベントログのレベルを指定します。

説明

明示管理ヒープ機能のイベントログのレベルを指定します。

前提オプション

-XX:+HitachiUseExplicitMemory

書式

-XX:HitachiExplicitMemoryLogLevel:適用範囲

指定できる値

適用範囲

型：String

none

明示管理ヒープ機能のイベントログを出力しません。

normal

通常運用での指定を想定しています。Explicitヒープの状態を定期的（GCごと）に出力します。また、Explicitヒープの状態が大きく変化するイベント時に出力します。

verbose

normalの内容に加え、Explicitヒープの状態が変化するイベント時に出力します。ログ量がnormalよりも多くなります。

debug

verboseの内容に加え、一部のイベント発生時の詳細な情報を出力します。ログ量が大量になるため、パフォーマンスが著しく低下します。

デフォルト値

定義項目の省略

-XX:HitachiExplicitMemoryLogLevel:none

注意事項

none、normal、verbose、debug以外の値が指定された場合、次のメッセージを標準出力に出力してJavaVMをリターンコード1で終了します。

Invalid explicit heap log level: -XX:HitachiExplicitMemoryLogLevel:適用範囲
Could not create the Java virtual machine.
(log levels: none normal verbose debug)

7.11.16　-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst

Explicitメモリーブロックの解放処理でのオブジェクトの移動先を、Tenured領域に変更します。

説明

Explicitメモリーブロックの解放処理でのオブジェクトの移動先を指定します。

前提オプション

-XX:HitachiUseExplicitMemory

書式

-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst

指定できる値

型：String

-XX:+HitachiExplicitMemoryMoveToTenuredFirst

Explicitメモリーブロックの解放処理でのオブジェクトの移動先が、Tenured領域になります。

-XX:-HitachiExplicitMemoryMoveToTenuredFirst

Explicitメモリーブロックの解放処理でのオブジェクトの移動先が、New領域になります。

デフォルト値

定義項目の省略

-XX:+HitachiExplicitMemoryMoveToTenuredFirst

注意事項

このオプションが有効になっている場合、解放処理が実行されるときに被参照のオブジェクトは、Tenured領域へ移動します。

参照元のオブジェクトが一時的に短命なオブジェクトの場合、このオプションを無効とし、Explicitメモリーブロック内の被参照のオブジェクトをNew領域に移動することで、次回のCopyGCの際に参照元オブジェクトと同時に回収できます。そうすることによって、このオプションが無効となっている場合に、Tenured領域の利用済みサイズが上昇することを防げます。

ただし、次の点に注意が必要です。

CopyGC頻度の増加

Explicitメモリーブロック解放時に、被参照のオブジェクトをNew領域に移動するため、移動したオブジェクトがNew領域を消費します。その結果、次回のCopyGCまでの間隔が短くなり、スループットの低下や、オブジェクトの加齢速度が上昇するおそれがあります。

Tenured領域に移動するオブジェクトがNew領域と明示管理ヒープ領域間で循環

複数のExplicitメモリーブロック内のオブジェクトから参照されるオブジェクト（例えばアプリケーション共通のデータ定義）が存在する場合、そのオブジェクトは長寿命オブジェクトとなります。そのため、このオプションが有効な場合に、オブジェクトがExplicitメモリーブロックへ移動したあと、そのExplicitメモリーブロックの解放処理が実行される際にTenured領域へ移動し、オブジェクトの寿命（アプリケーションの終了時など）までTenured領域に存在し続けることになります。

一方、このオプションが有効な場合に、Explicitメモリーブロックの解放処理が実行される際にNew領域へ移動し、その後しきい値までのCopyGCが実行されると、別のExplicitメモリーブロックへ移動します。この繰り返しによって、オブジェクトがNew領域と明示管理ヒープ領域を循環し、CopyGCやExplicitメモリーブロックの解放処理のオーバーヘッドが増大するおそれがあります。

7.11.17　-XX:[+|-]HitachiUseExplicitMemory

明示管理ヒープ機能の有効または無効を設定します。

説明

明示管理ヒープ機能の有効、無効を指定します。なお、明示管理ヒープ機能を有効にする場合は、-Xmsと-Xmxの指定値が同じであることを推奨します。

関連オプション

-Xms

-Xmx

書式

-XX:[+|-]HitachiUseExplicitMemory

指定できる値

型：String

-XX:+HitachiUseExplicitMemory

明示管理ヒープ機能を有効にします。

-XX:-HitachiUseExplicitMemory

明示管理ヒープ機能を無効にします。

デフォルト値

定義項目の省略

-XX:-HitachiUseExplicitMemory

注意事項

-XX:+UseG1GCオプションを指定している場合、このオプションは指定できません。これらのオプションと同時に指定した場合、メッセージが標準出力に出力されて、JavaVMがリターンコード1で終了します。

7.12　リソースの上限値指定で使用するJavaVMオプション

リソースの上限値を設定するためのオプションを説明しています。

7.12.1　-XX:HitachiJITCompileMaxMemorySize

JITコンパイル時に確保するCヒープのメモリーサイズの上限値を指定します。

説明

JITコンパイル時に確保するCヒープのメモリーサイズの上限値を指定します。JITコンパイルによって確保するCヒープのメモリーが指定値を超えた場合、JavaVMログファイルにログを出力するとともに、以降のJITコンパイルを抑制します。JITコンパイル処理の対象となっていたJavaメソッドは、以降、インタープリターでだけ実行されるようになります。なお、JITコンパイルが抑制された場合でも、JavaVMは強制終了しないで、処理を続行します。

0を指定した場合、JITコンパイル時に確保するメモリーは上限値で制限されません。

なお、JITコンパイルはJavaVMの内部スレッド（JITコンパイラースレッド）で実行されます。JITコンパイラースレッドは2つあるため、このオプションで指定した上限値を2で割った値が、1つのJITコンパイラースレッドに対する上限値となります。

また、このオプションで上限値を設定した場合も、実際に使用できるCヒープがそれよりも少ないときには、上限値に達する前にCヒープ不足が発生することがあります。この場合、JavaVMは強制終了します。

前提オプション

-server

出力形式

[id][Thread: thread_id]<date>["thread_name" exceeded max memory size.]
[current_sizeK->new_sizeK/limit_size_per_threadK/limit_sizeK]
[compile_target][byte_code_size]

出力内容を次に説明します。

出力項目

出力内容

id

JMS（JavaVMログファイル識別子）。

thread_id

JITコンパイルを抑制したJITコンパイラースレッドのスレッドID。

date

JITコンパイルを抑制した日時。

-XX:+HitachiOutputMilliTimeオプションが指定された場合、ミリ秒単位で出力されます。

thread_name

JITコンパイルを抑制したJITコンパイラースレッドのスレッド名。

current_size

JITコンパイルを抑制したJITコンパイラースレッドの、現在のメモリー確保サイズ（単位：キロバイト）。

new_size

JITコンパイルを抑制したJITコンパイラースレッドの、現在のメモリー確保サイズと追加で確保しようとしたサイズの合計値（単位：キロバイト）。

limit_size_per_thread

1つのJITコンパイラースレッドの上限値（単位：キロバイト）。

limit_size

JITコンパイラースレッド全体の上限値（単位：キロバイト）。

compile_target

JITコンパイル処理の対象となっていたJavaメソッド。

byte_code_size

JITコンパイル処理の対象となっていたJavaメソッドのバイトコードのサイズ（単位：バイト）。

書式

-XX:HitachiJITCompileMaxMemorySize=整数値

指定できる値

整数値

型：Integer

JITコンパイル時に確保するメモリーの上限値を指定します。単位はバイトです。単位文字として、「k」（キロ）、「m」（メガ）、「g」（ギガ）も指定できます。指定できる範囲は次のとおりです。範囲外の値を指定した場合は、0が指定されます。

32ビット版のJavaVMの場合

0〜2³²-1（4294967295）

64ビット版のJavaVMの場合

0〜2⁶⁴-1（18446744073709551615）

0を指定した場合は、JITコンパイル時に確保するメモリーは上限値で制限されません。JITコンパイル中にCヒープ不足が発生した場合、JavaVMは強制終了します。

デフォルト値

定義項目の省略

-XX:HitachiJITCompileMaxMemorySize=0

出力例

オプションとして「-XX:HitachiJITCompileMaxMemorySize=536870912」を指定して、1つのJITコンパイラースレッドに対して262145キロバイトのCヒープを確保した場合に、上限値に達したときの出力例を示します。

[JMS][Thread: 0x03bf1150]<Wed Feb 24 14:33:58 2010>
["CompilerThread0" exceeded  max memory size.][262143K->262145K/262144K/524288K]
[test1.func][213]

注意事項

JITコンパイル時に確保するメモリーが、このオプションで指定した上限値を超えて、JITコンパイルが抑制されると、アプリケーションのスループットが低下します。

自然数以外の値が指定された場合は、定義していないオプションを指定した場合と同様の動作になります。

7.12.2　-XX:HitachiThreadLimit

スレッド数の上限値を指定します。

説明

スレッド数の上限値を指定します。スレッド数の上限値が指定値を超えた場合に、OutOfMemoryError例外がスローされます。ただし、JavaVMが起動する前に上限値を超えた場合、例外はスローされません。また、スレッド数には、アプリケーションがJNIなどを使用してJavaVMの管理外の範囲で作成したスレッド数は含みません。0を指定した場合、上限値は設定されません。

なお、-XX:+HitachiOutOfMemoryAbortオプションと同時に指定した場合、このオプションの機能によってOutOfMemoryError例外がスローされた場合、JavaVMの強制終了は実行されません。

また、-XX:+HitachiOutOfMemoryStackTraceオプションと同時に指定した場合、例外メッセージがJavaVMログファイルに出力されます。

出力形式

Could not create "name" thread. Threadlimit Exceeded. num threads exist.

このメッセージは、java.lang.Throwable.getMessage()で取得できます。また、メッセージ全体が半角128文字以上になった場合は、メッセージの末尾が省略されます。

出力項目

出力内容

name

作成に失敗したスレッド名。

num

現時点でのスレッド数。

-XX:+HitachiOutOfMemoryStackTraceオプションが指定されている場合、JavaVMログファイルに例外情報とスタックトレースを出力できます。例外発生要因種別は、"Thread Limit"となります。例外発生要因種別を次に示します。

表7‒10　例外発生要因種別一覧

項番

要因メッセージ

説明

1

C Heap

Cヒープ確保時の例外

2

Java Heap

Javaヒープ確保時の例外

3

Meta Space

Metaspace確保時の例外

4

Compressed Class Space

Compressed Class Space確保時の例外

5

Unknown

上記例外を特定できない場合

6

Thread Limit

スレッド数の上限値設定機能（-XX:HitachiThreadLimitオプション）を指定した場合に、作成したスレッド数が指定した上限値を超えたときの例外

書式

-XX:HitachiThreadLimit=整数値

指定できる値

整数値

型：Integer

スレッド数の上限値を0〜2147483647の範囲で整数値（単位：スレッド数）を指定します。範囲外の値が指定された場合は0が設定されます。負の値を指定した場合はエラーとなります。

デフォルト値

定義項目の省略

-XX:HitachiThreadLimit=0

出力例

Could not create "Thread-1" thread. Threadlimit Exceeded. 9 threads exist.

この例は、mainスレッドによってjava.lang.Thread.startが呼び出され、この機能によって例外をスローした場合に、java.lang.Throwable.getMessage()でメッセージを取り出したメッセージの例です。

注意事項

上限値に小さな値を設定すると、起動前に例外をスローします。Java EEサーバが使用するスレッド数より小さな値を設定しないでください。

7.13　JITコンパイラー稼働継続機能で使用するJavaVMオプション

JITコンパイル失敗時のJavaVMの動作を設定するためのオプションを説明しています。

7.13.1　-XX:[+|-]JITCompilerContinuation

JITコンパイラー稼働継続機能の有効または無効を設定します。

説明

JITコンパイラー稼働継続機能を有効にするかどうかを指定します。

JITコンパイルがアプリケーションを構成するメソッドの論理矛盾で失敗しても、アプリケーションを正常に継続できるようにするためには、この機能を有効にすることをお勧めします。

JITコンパイラー稼働継続機能を有効にした場合、JITコンパイルがアプリケーションを構成するメソッドの論理矛盾で失敗しても、JavaVMはJavaVMログファイルにこの機能のログを出力して、処理を続行します。この場合、JITコンパイルに失敗したメソッドでは、以降のコンパイルはインタープリター方式で実行されるようになります。アプリケーションを構成しているメソッドのうち、JITコンパイルに失敗したメソッド以外のメソッドはJITコンパイルで実行されるため、アプリケーションは正常に継続されます。ただし、JITコンパイルが6回以上失敗すると、JavaVMはエラーリポートファイル、およびメモリーダンプまたはcoreダンプを出力して、強制終了します。

JITコンパイラー稼働継続機能を無効にした場合、JITコンパイルがアプリケーションを構成するメソッドの論理矛盾で失敗すると、JavaVMはエラーリポートファイル、およびメモリーダンプまたはcoreダンプを出力して、強制終了します。

前提オプション

-server

-XX:+HitachiVerboseGC

出力形式

[id]

注

[id]以降にはJITコンパイラー稼働継続機能のログが出力されます。

出力内容を次に説明します。

出力項目

出力内容

id

JCC（JavaVMログファイル識別子）。

書式

-XX:[+|-]JITCompilerContinuation

指定できる値

型：String

-XX:+JITCompilerContinuation

JITコンパイラー稼働継続機能を有効にします。

-XX:-JITCompilerContinuation

JITコンパイラー稼働継続機能を無効にします。

デフォルト値

定義項目の省略

-XX:+JITCompilerContinuation

出力例

[JCC][Thread: 0x05432c00]<Thu Nov 15 17:10:40 2012>[Method: jit_sample.func()V]
[Fail: 3][JITCT: 1]
[JCC][Thread: 0x05432c00][PC: 0x083aff9a][Lib: D:¥work¥jdk¥jre¥bin¥server¥
jvm.dll+0x3aff9a][VM: Java HotSpot(TM) Server VM
(20.8-b03-CDK0950-20121115 mixed mode windows-x86 )]
[JCC][Thread: 0x05432c00][EAX=0x00000000, EBX=0x00618128, ECX=0x00000000,
 EDX=0x05485340]
[JCC][Thread: 0x05432c00][ESP=0x0566d3c0, EBP=0x0566d3c4, ESI=0x00618278,
 EDI=0x00000000]
[JCC][Thread: 0x05432c00][EIP=0x083aff9a, EFLAGS=0x00010202]
[JCC][Thread: 0x05432c00][siginfo: read 0x00000000]
[JCC][Thread: 0x05432c00][Unlock: MethodCompileQueue_lock]
[JCC][Thread: 0x05432c00][NewJITCT: 0x05438800][JITCT: 2]
[JCC][Thread: 0x05432c00][Free: "ResourceArea" 524288 bytes.]
[JCC][Thread: 0x05432c00][stop]
[JCC][Fail: 1][date: Thu Nov 15 10:10:40 2012][Method: jit_sample.func1
(Ljava/lang/String;)V][PC: 0x083ff00a]
[Lib: D:¥work¥jdk¥jre¥bin¥server¥jvm.dll+0x3ff00a]
[JCC][Fail: 2][date: Thu Nov 15 11:11:16 2012][Method: jit_sample.func2()V]
[PC: 0x083afe3a][Lib: D:¥work¥jdk¥jre¥bin¥server¥jvm.dll+0x3afe3a]

7.14　Javaアプリケーションプログラムの実行で使用するJavaVMオプション

javaコマンド、またはjavawコマンドで、Javaアプリケーションプログラムを実行する際に使用するオプションを説明しています。

7.14.1　-Xhras

javaコマンド、およびjavawコマンドに対して有効なオプションです。Javaアプリケーションプログラムの実行を行います。

説明

重要

Application Serverの実行環境（アプリケーション開発環境以外の環境）で、Application Serverと関連しないJavaプログラムを使用する場合に、このオプションを使用するときは、別途、Application Server - Optional License for Javaを購入してください。

javaコマンド、またはjavawコマンド実行時にこのオプションを設定すると、Javaアプリケーションプログラムが実行できます。実行時には、自動的にJavaVMの稼働情報を出力する、次のオプションが指定されます。

-XX:+HitachiJavaClassLibTrace

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutputMilliTime

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiVerboseGC

なお、Javaアプリケーションプログラムは、javaコマンド、java_hrasコマンド、またはjavawコマンドで実行できます。それぞれの実行方法を次に示します。

javaコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVA_HRASを設定して実行する

これら以外の方法で実行すると、コマンドの実行に失敗し、次のメッセージが出力されます。

Java command cannot be used except in some special cases.
When starting a Java program, use the java_hras command, etc.
Depending on the Java program executed,
it might be necessary to purchase the other product.

java_hrasコマンドの実行方法

Application Serverのインストールディレクトリー/jdk/jre/bin/下のjava_hrasコマンドを実行します。

java_hrasコマンドは、javaコマンドと同等の機能を持つコマンドです。java_hrasコマンドでは、javaコマンドの-Xhrasオプションや環境変数JAVA_HRASは指定不要です。

javawコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVAW_HRASを設定して実行する

これら以外の方法で実行すると、コマンドの実行に失敗し、次のメッセージが出力されます。

Javaw command cannot be used except in some special cases.
When starting a Java program, use the java_hras command, etc.
Depending on the Java program executed,
it might be necessary to purchase the other product.

書式

-Xhras

デフォルト値

定義項目の省略

なし

注意事項

このオプション以外のオプションを指定する場合は、このオプションよりあとに指定してください。

7.15　圧縮オブジェクトポインター機能で使用するJavaVMオプション

Javaオブジェクトのサイズを圧縮して管理することで、JavaVM実行時のJavaヒープ領域およびExplicitヒープ領域の使用サイズを削減する機能を使用するためのオプションを説明しています。

7.15.1　-XX:[+|-]UseCompressedOops

圧縮オブジェクトポインター機能の有効または無効を設定します。

説明

圧縮オブジェクトポインター機能の有効、無効を指定します。圧縮オブジェクトポインター機能は、Javaオブジェクトのサイズを圧縮して管理することで、JavaVM実行時のJavaヒープ領域、およびExplicitヒープ領域の使用サイズを削減します。なお、 Explicitヒープ領域は、明示管理ヒープ機能が有効な場合にだけ該当します。

この機能を有効にするには、次の条件を満たしていることが前提となります。

64ビット版のJavaVMを使用していること

Javaヒープ領域およびExplicitヒープ領域の指定サイズの合計値が32ギガバイト未満であること

JavaVM起動時、Javaヒープ領域およびExplicitヒープ領域の指定サイズの合計値が、32ギガバイト以上の場合は、JavaVMは次のメッセージを標準出力に出力し、圧縮オブジェクトポインター機能を無効とします。

Java HotSpot(TM) 64-Bit Server VM warning: Max heap size too large for
Compressed Oops

書式

-XX:[+|-]UseCompressedOops

指定できる値

型：String

-XX:+UseCompressedOops

JavaVMは、Javaヒープ領域およびExplicitヒープ領域にあるJavaオブジェクトのサイズを圧縮して管理します。

-XX:-UseCompressedOops

JavaVMは、Javaヒープ領域およびExplicitヒープ領域にあるJavaオブジェクトのサイズを圧縮しません。

デフォルト値

定義項目の省略

-XX:-UseCompressedOops

7.16　ファイナライズ滞留解消機能で使用するJavaVMプロパティー

JavaVM内でファイナライズ処理が滞留している状態を検知して、滞留しているファイナライズ処理を解消する機能を使用するためのプロパティーを説明しています。

7.16.1　JP.co.Hitachi.soft.jvm.autofinalizer

ファイナライズ滞留解消機能の有効または無効を設定します。

説明

ファイナライズ滞留解消機能の有効、無効を指定します。

true、false以外の値が設定された場合、デフォルト値になります。

書式

JP.co.Hitachi.soft.jvm.autofinalizer={true | false}

指定できる値

型：boolean

true

Java起動時に、FinalizerThreadを監視するファイナライズ処理監視スレッドを生成します。

false

FinalizerThreadを監視するファイナライズ処理監視スレッドは生成しません。

デフォルト値

定義項目の省略

JP.co.Hitachi.soft.jvm.autofinalizer=true

出力例

ファイナライズ処理の滞留を検知して、ファイナライズ処理監視スレッドを新たに生成する場合

# FinalizerWatcherThread: Create: create secondary finalizer thread.
[queue length = 128] <Mon May 26 18:00:36 JST 2008>

生成したファイナライズ処理監視スレッドが終了した場合

# FinalizerWatcherThread: Finish: secondary finalizer thread is finished.
<Mon May 26 20:12:26 JST 2008>

7.17　ユーザー拡張性能解析トレースで使用するJavaVMプロパティー

ユーザー拡張性能解析トレースの動作や出力情報に関する設定をするためのプロパティーを説明しています。

7.17.1　jvm.userprf.Enable

ユーザー拡張性能解析トレースの有効または無効を設定します。

説明

ユーザー拡張性能解析トレースを有効にするかどうかを指定します。

前提プロパティーはありません。

書式

jvm.userprf.Enable={true | false}

指定できる値

型：Boolean

true

ユーザー拡張性能解析トレースを有効にします。

false

ユーザー拡張性能解析トレースを無効にします。

true、false以外を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.Enable=false

値の省略

jvm.userprf.Enable=false

記述例

-Djvm.userprf.Enable=true

注意事項

このプロパティーにtrueを指定した場合、ユーザー拡張性能解析トレースは自動的にユーザー拡張性能解析トレース設定ファイルを読み込みます。事前にjvm.userprf.Fileプロパティーでユーザー拡張性能解析トレース設定ファイルを設定してください。

7.17.2　jvm.userprf.ExtendedSetting

ユーザー拡張性能解析トレース設定ファイルの記述形式を指定します。

説明

ユーザー拡張性能解析トレース設定ファイルの記述形式に、次の方式を有効にするかどうかを指定します。

パッケージ名とクラス名を指定する方式

パッケージ名だけを指定する方式

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.ExtendedSetting={true | false}

指定できる値

型：Boolean

true

ユーザー拡張性能解析トレース設定ファイルに、次の方式で記述できます。

パッケージ名とクラス名を指定する方式

パッケージ名だけを指定する方式

false

ユーザー拡張性能解析トレース設定ファイルに、次の方式は記述できません。

パッケージ名とクラス名を指定する方式

パッケージ名だけを指定する方式

true、false以外を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.ExtendedSetting=false

値の省略

jvm.userprf.ExtendedSetting=false

記述例

-Djvm.userprf.ExtendedSetting=true

注意事項

このプロパティーにfalseを指定して、trueで有効になる方式でユーザー拡張性能解析トレース設定ファイルに記述した場合、ユーザー拡張性能解析トレース設定ファイルのフォーマットエラーになります。

7.17.3　jvm.userprf.File

ユーザー拡張性能解析トレース設定ファイルのファイルパスを指定します。

説明

ユーザー拡張性能解析トレース設定ファイルのファイルパスを指定します。

ユーザー拡張性能トレースは、このプロパティーに指定したファイルパスのファイルをユーザー拡張性能解析トレース設定ファイルとして読み込みます。なお、このプロパティーを指定していない場合、デフォルトのファイルパスのファイルをユーザー拡張性能解析トレース設定ファイルとして読み込みます。

ユーザー拡張性能解析トレース設定ファイルに記述されたメソッドが、ユーザー拡張性能解析トレースのトレース対象となります。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.File=文字列

指定できる値

文字列

型：String

ユーザー拡張性能解析トレース設定ファイルのファイルパスを指定します。

指定できるファイルパスは1つだけです。

カレントディレクトリーからの相対パスおよび絶対パスがパス文字列として有効です。

デフォルト値

定義項目の省略

JDKのインストールディレクトリー¥usrconf¥userprf.cfg

値の省略

ファイルが存在しないワーニングメッセージをJavaVMログファイルに出力します。

記述例

-Djvm.userprf.File=/test/setting.txt

注意事項

ユーザー拡張性能解析トレース設定ファイルを読み込むときの文字エンコーディングは、JDKの動作プラットフォームのデフォルトエンコーディングです。文字エンコーディングがデフォルトエンコーディング以外の場合、デフォルトエンコーディングで記述されているものとして処理されます。

サーバごとにユーザー拡張性能解析トレースを異なる設定にする場合は、サーバごとにユーザー拡張性能解析トレース設定ファイルを用意して、このプロパティーでサーバごとのファイルパスを指定してください。

指定されたファイルパスのファイルが読み込めない場合や読み込んだ設定が有効でない場合、ユーザー拡張性能解析トレース設定ファイルの読み込み時のログがJavaVMログファイルに出力されます。

7.17.4　jvm.userprf.Limit

ユーザー拡張性能解析トレースの対象となるメソッド数の上限値を指定します。

説明

ユーザー拡張性能解析トレースの対象となるメソッド数の上限値を指定します。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.Limit=整数値

指定できる値

整数値

型：Integer

0〜2147483647までの整数値で指定します。それ以外を指定した場合はデフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.Limit=2147483647

値の省略

jvm.userprf.Limit=2147483647

記述例

-Djvm.userprf.Limit=100

注意事項

ユーザー拡張性能解析トレース設定ファイルで指定したメソッドのうち、このプロパティーで指定した値のメソッド数までがトレースの対象になります。指定したメソッドがこのプロパティーで指定した値をはじめて超えたとき、ログメッセージがJavaVMログファイルに出力されます。

7.17.5　jvm.userprf.LineNumber

メソッドの最後に実行した行の行番号をトレース情報へ出力します。

説明

メソッドが正常に終了した場合、メソッドの最後に実行した行の行番号をトレース情報に出力するかどうかを指定します。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.LineNumber={true | false}

指定できる値

型：Boolean

true

トレース情報のオペレーション情報（OPR）に、メソッドの最後に実行した行の行番号を出力します。

false

メソッドの最後に実行した行の行番号をトレース情報に出力しません。

true、false以外を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.LineNumber=false

値の省略

jvm.userprf.LineNumber=false

記述例

-Djvm.userprf.LineNumber=true

注意事項

javacコマンドの-gオプションで行番号のデバッグ情報を生成しない場合は、このプロパティーにtrueを指定しても行番号は出力されません。

7.17.6　jvm.userprf.LogLevel

ユーザー拡張性能解析トレースのトレース出力レベルを指定します。

説明

ユーザー拡張性能解析トレースのトレース情報のオプション情報（OPT）に出力する、トレース対象のメソッド名の出力レベルを指定します。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.LogLevel={class | package | method | signature}

指定できる値

型：String

class

クラス名

package

完全修飾クラス名

method

完全修飾クラス名＋メソッド名

signature

完全修飾クラス名＋メソッド名＋メソッドの引数の型

なお、jvm.userprf.ThrowableNameプロパティーにtrueを指定している場合、このプロパティーの指定によってメソッドの異常出口で、次のようにオペレーション情報（OPR）が出力されます。

classを指定した場合：例外またはエラーのクラス名

package、methodまたはsignatureを指定した場合：例外またはエラーの完全修飾クラス名

デフォルト値

定義項目の省略

jvm.userprf.LogLevel=class

値の省略

jvm.userprf.LogLevel=class

記述例

パッケージ名「com.sample」、クラス名「ClassA」、およびメソッド名「methodA」のトレース情報を、完全修飾クラス名＋メソッド名でトレース情報のオプション情報（OPT）に出力する場合の記述例を次に示します。

-Djvm.userprf.LogLevel=method

トレース情報には次のように出力されます。

com.sample.ClassA.methodA

7.17.7　jvm.userprf.ThrowableName

例外またはエラーのクラス名をトレース情報へ出力します。

説明

メソッドが異常終了した場合、例外またはエラーのクラス名をトレース情報のオペレーション情報（OPR）に出力するかどうかを指定します。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.ThrowableName={true | false}

指定できる値

型：Boolean

true

例外またはエラーのクラス名をトレース情報に出力します。

false

例外またはエラーのクラス名をトレース情報に出力しません。

true、false以外を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.ThrowableName=false

値の省略

jvm.userprf.ThrowableName=false

記述例

-Djvm.userprf.ThrowableName=true

注意事項

このプロパティーにtrueを指定した場合、jvm.userprf.ThrowableNameEditMethodプロパティーに指定した編集方法でクラス名が出力されます。

7.17.8　jvm.userprf.ThrowableNameEditMethod

例外またはエラーのクラス名が文字数制限32文字を超えた場合の名前の編集方法を指定します。

説明

例外またはエラーのクラス名が32文字を超える場合のクラス名の編集方法を指定します。例外またはエラーのクラス名が32文字以内であれば、このプロパティーの指定に関係なく、すべての文字がトレース情報に出力されます。

前提プロパティー

jvm.userprf.Enable=true

jvm.userprf.ThrowableName=true

書式

jvm.userprf.ThrowableNameEditMethod={FRONT_CUT | BACK_CUT | CENTER_CUT}

指定できる値

型：String

FRONT_CUT

例外またはエラーのクラス名の後方32文字が出力されます。なお、文字の先頭には省略を示す「*」が付与されます。

BACK_CUT

例外またはエラーのクラス名の前方32文字が出力されます。なお、文字の末尾には省略を示す「*」が付与されます。

CENTER_CUT

例外またはエラーのクラス名の前方16文字と後方16文字が出力されます。なお、文字の前方16文字と後方16文字の間に、省略を示す「*」が付与されます。

上記以外の文字列を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.ThrowableNameEditMethod=FRONT_CUT

値の省略

jvm.userprf.ThrowableNameEditMethod=FRONT_CUT

記述例

パッケージ名が「com.sample」、クラス名が「Class0123456789012345678901234567890」の例外で終了するとき、例外のクラス名または完全修飾クラス名の前方32文字をトレース情報のオペレーション情報（OPR）に出力する場合の記述例を次に示します。

-Djvm.userprf.ThrowableNameEditMethod=BACK_CUT

jvm.userprf.LogLevelプロパティーの指定によって、トレース情報のオペレーション情報（OPR）には次のように出力されます。

classを指定した場合

Class012345678901234567890123456*

package、methodまたはsignatureを指定した場合

com.sample.Class0123456789012345*

7.17.9　jvm.userprf.Trace

ユーザー拡張性能解析トレース設定ファイルで指定したクラスファイルの書き換えの成功ログを出力します。

説明

ユーザー拡張性能解析トレース設定ファイルで指定したクラスファイルの書き換えの成功ログを出力するかどうかを指定します。

前提プロパティー

jvm.userprf.Enable=true

書式

jvm.userprf.Trace={true | false}

指定できる値

型：Boolean

true

ユーザー拡張性能解析トレースの対象クラスの書き換えの成功ログを出力します。

false

ユーザー拡張性能解析トレースの対象クラスの書き換えの成功ログを出力しません。

true、false以外を指定した場合、デフォルト値となります。

デフォルト値

定義項目の省略

jvm.userprf.Trace=false

値の省略

jvm.userprf.Trace=false

記述例

-Djvm.userprf.Trace=true

注意事項

ユーザー拡張性能解析トレースの対象クラスの書き換えに失敗した場合は、このプロパティーの指定に関係なく、ログメッセージがJavaVMログファイルに出力されます。

7.18　Application Serverで使用するJava HotSpot VMのオプション

Java HotSpot VMに関する設定をするためのオプションを説明しています。

7.18.1　-agentlib:hndlwrap2

JDKのバージョンが6以降の環境でWindowsをログオフしたとき、JavaVMの実行を継続します。

説明

JDKのバージョンが6以降の環境でWindowsをログオフしたとき、JavaVMの実行を継続するかどうか設定します。

このオプションは、ほかのJVMTIプログラムと同時に使用できません。使用した場合は保証しません。使用した場合の動作は、JVMTIの動作に依存します。

デフォルト値

定義項目の省略

なし

7.18.2　-agentlib:libname

ネイティブエージェントライブラリーをロードします。

説明

ネイティブエージェントライブラリーlibnameをロードします。

書式

-agentlib:libname[=options]

指定できる値

入力は制限されません。

デフォルト値

定義項目の省略

なし

7.18.3　-XX:CompressedClassSpaceSize

Compressed Class Spaceの最大値を指定します。

説明

Compressed Class Spaceの最大値を指定します。

圧縮オブジェクトポインター機能が有効な場合、Compressed Class SpaceがMetaspace領域内に作成されます。

この場合、それぞれの領域には、次の情報が配置されます。

Compressed Class Space

Javaヒープ内のオブジェクトから参照されるクラス情報

Metaspace領域（Compressed Class Space以外）

上記以外のメソッド情報など

前提オプション

-XX:+UseCompressedOops

書式

-XX:CompressedClassSpaceSize=size

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

指定できる範囲は1024k〜3gの整数値です。

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x64 [server]の場合

-XX:CompressedClassSpaceSize=1G

（凡例）

[server]：Java HotSpot Server VMが使用されることを示します。

注意事項

このオプションは、Windows x86ではサポートしていません。

7.18.4　-XX:ConcGCThreads

Concurrent Markingの処理を並列実行するスレッド数を指定します。

説明

G1GCが有効な場合に、Concurrent Markingの処理を並列実行するスレッドの数を指定します。

JavaVM起動時に、このオプションに指定した数のConcurrent Marking処理用スレッドが作成されて、処理が実行されます。このオプションを省略した場合は、次の式で算出された数のConcurrent Marking処理用スレッドが作成されます。

Max((ParallelGCThreads※+2)/4,1)

注

小数点以下は切り捨てです。Max(A,B)は、AとBのうちから大きい方の値を選択することを示します。

注※

ParallelGCThreadsは、-XX:ParallelGCThreadsに指定した値です。

このオプションを指定する場合は、次の点に注意してください。

1を指定するとスレッド1つで並列実行することになるため、実行性能が下がります。

実行環境で作成できるスレッド数を超える値を指定した場合は、JavaVM起動時にConcurrent Marking処理用スレッドの作成に失敗するため、JavaVMを起動できません。

Concurrent Marking処理用スレッドのスレッド数は、GCスレッド数を超えて作成できません。GCスレッド数を超える値を指定した場合は、次のメッセージが標準出力に出力され、JavaVMの起動に失敗します。

Error occurred during initialization of VM
Can't have more ConcGCThreads than ParallelGCThreads.

有効な範囲外の値を指定した場合、次のメッセージが標準出力に出力され、JavaVMがリターンコード1で終了します。

Invalid number of concurrent marking threads: -XX:ConcGCThreads=[指定値]

前提オプション

-XX:+UseG1GC

関連オプション

-XX:ParallelGCThreads

書式

-XX:ConcGCThreads=整数値

指定できる値

整数値

型：Integer

0〜1000の整数で指定します。

デフォルト値

定義項目の省略

Max((ParallelGCThreads+2)/4,1)

値の省略

Max((ParallelGCThreads+2)/4,1)

7.18.5　-XX:MaxGCPauseMillis

G1GCのGCによるアプリケーション停止時間の目標時間をミリ秒単位で指定します。

説明

G1GCのGCによるアプリケーション停止時間の目標時間をミリ秒（ms）単位で指定します。

書式

-XX:MaxGCPauseMillis=整数値

指定できる値

型：Integer

1〜4294967295の整数で指定します。

デフォルト値

定義項目の省略

-XX:MaxGCPauseMillis=200

7.18.6　-XX:MaxMetaspaceSize

Metaspace領域の最大値を指定します。

説明

Metaspace領域の最大値を指定します。

Metaspace領域はロードされたクラス情報が格納される領域です。

Metaspace領域のサイズは、アプリケーションで必要なクラス情報のサイズから見積もることができます。見積もった値は、-XX:MetaspaceSizeオプション、および-XX:MaxMetaspaceSizeオプションに指定します。Metaspace領域のサイズを正しく指定することで、Metaspace領域のOutOfMemoryErrorの発生を防ぐことができます。また、-XX:MetaspaceSizeオプションと-XX:MaxMetaspaceSizeオプションに同じ値を指定することで、Metaspace領域に起因するFullGCの発生を抑止できます。

Metaspace領域のメモリー使用量は、アプリケーションが実際に使用しているサイズです。このため、-XX:MetaspaceSizeオプション、および-XX:MaxMetaspaceSizeオプションに指定した値のメモリーは使用されません。この特性から、Metaspace領域は次のようなチューニングもできます。

Metaspace領域のOutOfMemoryErrorの発生リスクを下げる

Metaspace領域の使用量が見積もり値以上に増加すると、Metaspace領域のOutOfMemoryErrorが発生することがあります。この発生リスクを下げるため、次のオプションには、見積もり時に余裕を持った値を指定してください。

-XX:MaxMetaspaceSize

-XX:CompressedClassSpaceSize

Metaspace領域の使用量がこれらのオプションの指定値を超えるまで、Metaspace領域のOutOfMemoryErrorは発生しません。

Metaspace領域に起因するFullGCの発生リスクを下げる

Metaspace領域の使用量が見積もり値以上に増加すると、Metaspace領域に起因するFullGCが発生することがあります。この発生リスクを下げるため、次のオプションには、見積もり時に余裕を持った値を指定してください。

-XX:MetaspaceSize

-XX:MaxMetaspaceSize

-XX:CompressedClassSpaceSize

Metaspace領域の使用量がこれらのオプションの指定値を超えるまで、Metaspace領域に起因するFullGCは発生しません。

書式

-XX:MaxMetaspaceSize=size

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

指定できる範囲は次のとおりです。

32ビット版のJava VMの場合

256K〜2³²-1の整数値

64ビット版のJava VMの場合

256K〜2⁶⁴-1の整数値

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:MaxMetaspaceSize=2³²-1

Windows x86 [server]の場合

-XX:MaxMetaspaceSize=2³²-1

Windows x64 [server]の場合

-XX:MaxMetaspaceSize=2⁶⁴-1

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.7　-XX:MaxTenuringThreshold

CopyGC実行時に、From空間とTo空間でJavaオブジェクトを入れ替える回数のしきい値を指定します。

説明

CopyGC実行時に、From空間とTo空間でJavaオブジェクトを入れ替える回数のしきい値を指定します。指定した回数を超えて入れ替え対象になったJavaオブジェクトは、Tenured領域に移動されます。

このオプションの有効範囲は、0〜デフォルト値です。範囲外の値を指定した場合、しきい値を超えた場合にTenured領域へ移動する機能は無効になります。

書式

-XX:MaxTenuringThreshold=value

指定できる値

value

型：Integer

自然数の値を指定します。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:MaxTenuringThreshold=14

Windows x86 [server]の場合

-XX:MaxTenuringThreshold=14

Windows x64 [server]の場合

-XX:MaxTenuringThreshold=14

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.8　-XX:MetaspaceSize

Metaspace領域に起因するFullGCの基準値を指定します。

説明

Metaspace領域に起因するFullGCの基準値を指定します。

Metaspace領域はロードされたクラス情報が格納される領域です。

Metaspace領域のサイズは、アプリケーションで必要なクラス情報のサイズから見積もることができます。見積もった値は、-XX:MetaspaceSizeオプション、および-XX:MaxMetaspaceSizeオプションに指定します。Metaspace領域のサイズを正しく指定することで、Metaspace領域のOutOfMemoryErrorの発生を防ぐことができます。また、-XX:MetaspaceSizeオプションと-XX:MaxMetaspaceSizeオプションに同じ値を指定することで、Metaspace領域に起因するFullGCの発生を抑止できます。

Metaspace領域のメモリー使用量は、アプリケーションが実際に使用しているサイズです。このため、-XX:MetaspaceSizeオプション、および-XX:MaxMetaspaceSizeオプションに指定した値のメモリーは使用されません。この特性から、Metaspace領域は次のようなチューニングもできます。

Metaspace領域のOutOfMemoryErrorの発生リスクを下げる

Metaspace領域の使用量が見積もり値以上に増加すると、Metaspace領域のOutOfMemoryErrorが発生することがあります。この発生リスクを下げるため、次のオプションには、見積もり時に余裕を持った値を指定してください。

-XX:MaxMetaspaceSize

-XX:CompressedClassSpaceSize

Metaspace領域の使用量がこれらのオプションの指定値を超えるまで、Metaspace領域のOutOfMemoryErrorは発生しません。

Metaspace領域に起因するFullGCの発生リスクを下げる

Metaspace領域の使用量が見積もり値以上に増加すると、Metaspace領域に起因するFullGCが発生することがあります。この発生リスクを下げるため、次のオプションには、見積もり時に余裕を持った値を指定してください。

-XX:MetaspaceSize

-XX:MaxMetaspaceSize

-XX:CompressedClassSpaceSize

Metaspace領域の使用量がこれらのオプションの指定値を超えるまで、Metaspace領域に起因するFullGCは発生しません。

書式

-XX:MetaspaceSize=size

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

指定できる範囲は次のとおりです。

32ビット版のJava VMの場合

256K〜2³²-1の整数値

64ビット版のJava VMの場合

256K〜2⁶⁴-1の整数値

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:MetaspaceSize=12M

Windows x86 [server]の場合

-XX:MetaspaceSize=16M

Windows x64 [server]の場合

-XX:MetaspaceSize=16M

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.9　-XX:NewRatio

New領域に対するTenured領域の割合を指定します。

説明

New領域に対するTenured領域の割合を指定します。

valueが2の場合は、New領域とTenured領域の割合が、1:2になります。

「New領域の使用中サイズ≧Tenured領域の空き領域サイズ」になるとFullGCが発生します。このオプションに1を指定すると、FullGCが多発するので注意してください。

書式

-XX:NewRatio=value

指定できる値

value

型：Integer

自然数の値を指定します。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:NewRatio=2

Windows x86 [server]の場合

-XX:NewRatio=2

Windows x64 [server]の場合

-XX:NewRatio=2

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.10　-XX:ParallelGCThreads

G1GCを並列実行するスレッドの数を指定します。

説明

G1GCを並列実行するスレッドの数を指定します。-XX:+UseG1GCを指定したときに有効になります。なお、このオプションは、デフォルト値で使用することを推奨します。変更する場合は、実際にJavaVMを動作させて測定した値を基に、最適な値を算出してから変更してください。

JavaVM起動時に、このオプションに指定した数のGCスレッドが作成され、処理が実行されます。

このオプションに0を指定した場合は、デフォルト値が適用されます。

指定時には、次の点に注意してください。

1を指定するとスレッド1つで並列実行することになるため、実行性能が下がります。

実行環境で作成できるスレッド数を超える値を指定した場合は、JavaVM起動時にGCスレッドの作成に失敗するため、JavaVMを起動できません。

有効な範囲外の値を指定した場合、メッセージが標準出力に出力され、JavaVMがリターンコード1で終了します。

G1GCの場合、このオプションの値を大きくすると、Evacuation処理用のスレッド数が増えます。このため、Evacuation処理に割り当てられるリソースが増加し、スループットが低下することがあります。このオプションの値を変更した場合、性能の要件を満たしているかどうかを確認してください。

書式

-XX:ParallelGCThreads=value

指定できる値

value

型：Integer

自然数の値を指定します。

デフォルト値

定義項目の省略

実行環境の論理CPU数が8以下の場合

-XX:ParallelGCThreads=CPU数

実行環境の論理CPU数が9以上の場合

-XX:ParallelGCThreads=(8＋(CPU数−8)×(5÷8))※

注※

小数点以下は切り捨ての値になります。

例えば、4CPUの場合は、「ParallelGCThreads＝4」でデフォルト値は4になります。また、72CPUの場合は、「ParallelGCThreads＝8＋(72−8)×(5÷8)＝48」でデフォルト値は48になります。

7.18.11　-XX:ReservedCodeCacheSize

コードキャッシュ領域の最大サイズを指定します。

説明

コードキャッシュ領域の最大サイズを指定します。

書式

-XX:ReservedCodeCacheSize=整数値

指定できる値

整数値

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:ReservedCodeCacheSize=32M

Windows x86 [server]の場合

-XX:ReservedCodeCacheSize=48M

Windows x64 [server]の場合

-XX:ReservedCodeCacheSize=48M

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.12　-XX:SurvivorRatio

Survivor領域のFrom空間とTo空間に対するEden領域の割合を指定します。

説明

New::Survivor領域のFrom空間とTo空間に対するNew::Eden領域の割合を指定します。

valueに8を設定した場合は、New::Eden領域、From空間、To空間の割合が、8:1:1になります。

書式

-XX:SurvivorRatio=value

指定できる値

value

型：Integer

自然数の値を指定します。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:SurvivorRatio=8

Windows x86 [server]の場合

-XX:SurvivorRatio=8

Windows x64 [server]の場合

-XX:SurvivorRatio=8

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.13　-XX:TargetSurvivorRatio

GC実行後のSurvivor領域内でJavaオブジェクトが占める割合の目標値を指定します。

説明

GC実行後のNew::Survivor領域内でJavaオブジェクトが占める割合の目標値（0〜100（単位：%））を指定します。

書式

-XX:TargetSurvivorRatio=value

指定できる値

value

型：Integer

自然数の値を指定します。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-XX:TargetSurvivorRatio=50

Windows x86 [server]の場合

-XX:TargetSurvivorRatio=50

Windows x64 [server]の場合

-XX:TargetSurvivorRatio=50

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.14　-XX:[+|-]UseG1GC

G1GCを実行します。

説明

G1GCを実行するかどうかを指定します。

このオプションは、ほかのGC方式を選択するオプション（UseSerialGC、HitachiUseExplicitMemory）と同時に指定できません。

書式

-XX:[+|-]UseG1GC

指定できる値

型：String

-XX:+UseG1GC

G1GCを実行します。

-XX:-UseG1GC

G1GCを実行しません。

デフォルト値

定義項目の省略

-XX:-UseG1GC

7.18.15　-XX:[+|-]UseSerialGC

SerialGCを実行します。

説明

SerialGCを実行するかどうかを指定します。

書式

-XX:[+|-]UseSerialGC

指定できる値

型：String

-XX:+UseSerialGC

SerialGCを実行します。

-XX:-UseSerialGC

SerialGCを実行しません。

デフォルト値

定義項目の省略

-XX:+UseSerialGC

注意事項

Application ServerのGCは、SerialGC（UseSerialGC）またはG1GC（UseG1GC）を選択できます。これらのGCを同時に指定しないようにしてください。同時に指定した場合は、Javaプロセスが起動できません。

-XX:+UseSerialGCと-XX:+UseG1GCの両方が指定された場合は、エラーメッセージを標準エラー出力に出力して、コマンドの起動に失敗します。JNI経由の場合、JNI_CreateJavaVMがJNI_ERR(-1)を返します。

7.18.16　-verbose:information-type

information-typeに指定した情報を出力します。

説明

information-typeに指定した情報を出力します。

書式

-verbose:information-type

指定できる値

information-type

型：String

class

クラスがロードされるたびにクラスに関する情報を出力します。

gc

GCイベントが発生するたびに報告します。

jni

ネイティブメソッドの使用およびそのほかのJava Native Interface（JNI）アクティビティーに関する情報を報告します。

デフォルト値

定義項目の省略

なし

7.18.17　-Xloggc:file

GCイベントが発生するたびに、fileにログを出力します。

説明

-verbose:gcと同様にGCイベントが発生するたびに報告しますが、そのデータをfileに記録します。-verbose:gcを指定したときに報告される情報のほかに、報告される各イベントの先頭に、最初のGCイベントからの経過時間（秒単位）が付け加えられます。

書式

-Xloggc:file

指定できる値

入力は制限されません。

デフォルト値

定義項目の省略

なし

7.18.18　-Xms

Javaヒープの初期サイズを指定します。

説明

Javaヒープの初期サイズを指定します。

書式

-Xmssize

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-Xms5120K

Windows x86 [server]の場合

-Xms5120K

Windows x64 [server]の場合

-Xms7.8m

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.19　-Xmx

Javaヒープの最大サイズを指定します。

説明

Javaヒープの最大サイズを指定します。

書式

-Xmxsize

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-Xmx64M

Windows x86 [server]の場合

-Xmx64M

Windows x64 [server]の場合

-Xmx83M

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.18.20　-Xprof

実行中のプログラムのプロファイルを生成し、プロファイリングデータを標準出力へ出力します。

説明

このオプションを指定した場合、実行中のプログラムのプロファイルを生成し、プロファイリングデータを標準出力に出力します。このオプションは、プログラム開発用のユーティリティーとして提供されています。本番稼働システムでの使用を目的としたものではありません。

デフォルト値

定義項目の省略

なし

7.18.21　-Xss

1スタック領域の最大サイズを指定します。

説明

1スタック領域の最大サイズを指定します。

書式

-Xsssize

指定できる値

size

型：Integer

自然数の値を次に示す単位を使って指定します。

キロ「k」

メガ「m」

ギガ「g」

テラ「t」

なお、大文字・小文字は区別されません。

デフォルト値

定義項目の省略

Windows x86 [client]の場合

-Xss320K

Windows x86 [server]の場合

-Xss320K

Windows x64 [server]の場合

-Xss1M

（凡例）

[client]：Java HotSpot Client VMが使用されることを示します。

[server]：Java HotSpot Server VMが使用されることを示します。

7.19　JavaVMで使用する環境変数

システムで使用できるJavaVMの環境変数を説明しています。

7.19.1　JAVA_HRAS

javaコマンドを実行可能にするための環境変数です。

説明

Application Serverの実行環境（アプリケーション開発環境以外の環境）で、Application Serverと関連しないJavaプログラムを使用する場合に、この環境変数を使用するときは、別途、Application Server - Optional License for Javaを購入してください。

javaコマンド実行時にこの環境変数を設定すると、Application Serverと連携しないJavaアプリケーションプログラムが実行できます。実行時には、自動的にJavaVMの稼働情報を出力する、次のオプションが指定されます。

-XX:+HitachiJavaClassLibTrace

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutputMilliTime

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiVerboseGC

この環境変数を設定しない場合、コマンドの実行に失敗し、次のメッセージが出力されます。

Java command cannot be used except in some special cases.
When starting a Java program, use the java_hras command, etc.
Depending on the Java program executed,
it might be necessary to purchase the other product.

なお、Application Serverと連携しないJavaアプリケーションプログラムは、javaコマンド、java_hrasコマンド、またはjavawコマンドで実行できます。それぞれの実行方法を次に示します。

javaコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVA_HRASを設定して実行する

java_hrasコマンドの実行方法

Application Serverのインストールディレクトリー/jdk/jre/bin/下のjava_hrasコマンドを実行します。

java_hrasコマンドは、javaコマンドと同等の機能を持つコマンドです。java_hrasコマンドでは、javaコマンドの-Xhrasオプションや環境変数JAVA_HRASは指定不要です。

javawコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVAW_HRASを設定して実行する

指定できる値

入力は制限されません。

デフォルト値

定義項目の省略

なし

値の省略

空文字も有効になります。

7.19.2　JAVACOREDIR

スレッドダンプファイルの出力先ディレクトリーを指定します。

説明

スレッドダンプファイルを出力する場合の、出力先ディレクトリーをバッチファイルで指定します。

前提オプション

-XX:+HitachiThreadDump

書式

set JAVACOREDIR=スレッドダンプファイルの出力先ディレクトリー

指定できる値

スレッドダンプファイルの出力先ディレクトリー

型：String

デフォルトでは、スレッドダンプファイルはカレントディレクトリーに出力されます。

カレントディレクトリーを次に示します。

Application Serverのインストールディレクトリー/javaee/glassfish/nodes/ノード名/サーバインスタンス名/config

デフォルト値

定義項目の省略

なし

値の省略

カレントディレクトリー

記述例

スレッドダンプをC:¥home¥user¥threaddumpに出力します。

set JAVACOREDIR=C:¥home¥user¥threaddump

注意事項

JAVACOREDIRで指定したディレクトリーへのスレッドダンプファイルの出力に失敗した場合は、カレントディレクトリーにスレッドダンプファイルを出力します。

カレントディレクトリーへの出力も失敗した場合は、標準エラー出力だけにスレッドダンプを出力します。この場合は、標準出力にはスレッドダンプは出力されません。

7.19.3　JAVAW_HRAS

javawコマンドを実行可能にするための環境変数です。

説明

Application Serverの実行環境（アプリケーション開発環境以外の環境）で、Application Serverと関連しないJavaプログラムを使用する場合に、この環境変数を使用するときは、別途、Application Server - Optional License for Javaを購入してください。

javawコマンド実行時にこの環境変数を設定すると、Application Serverと連携しないJavaアプリケーションプログラムが実行できます。実行時には、自動的にJavaVMの稼働情報を出力する、次のオプションが指定されます。

-XX:+HitachiJavaClassLibTrace

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutputMilliTime

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiVerboseGC

この環境変数を設定しない場合、コマンドの実行に失敗し、次のメッセージが出力されます。

Javaw command cannot be used except in some special cases.
When starting a Java program, use the java_hras command, etc.
Depending on the Java program executed,
it might be necessary to purchase the other product.

なお、Application Serverと連携しないJavaアプリケーションプログラムは、javaコマンド、java_hrasコマンド、またはjavawコマンドで実行できます。それぞれの実行方法を次に示します。

javaコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVA_HRASを設定して実行する

java_hrasコマンドの実行方法

Application Serverのインストールディレクトリー/jdk/jre/bin/下のjava_hrasコマンドを実行します。

java_hrasコマンドは、javaコマンドと同等の機能を持つコマンドです。java_hrasコマンドでは、javaコマンドの-Xhrasオプションや環境変数JAVA_HRASは指定不要です。

javawコマンドの実行方法

次のどちらかの方法で実行します。

-Xhrasオプションを指定して実行する

環境変数JAVAW_HRASを設定して実行する

指定できる値

入力は制限されません。

デフォルト値

定義項目の省略

なし

値の省略

空文字も有効になります。

8　JavaVMで使用する定義ファイル

明示管理ヒープ機能や、ユーザー拡張性能解析トレースの設定で使用する定義ファイルを説明しています。

8.1　JavaVMで使用する定義ファイルの一覧

明示管理ヒープ機能や、ユーザー拡張性能解析トレースの設定で使用する定義ファイルの概要を説明しています。

JavaVMで使用する定義ファイル

定義ファイル

概要

詳細説明

8.2　exmemexcludeclass.cfg

Explicitヒープへ移動させたくないオブジェクトのクラスを指定する設定ファイル（明示管理ヒープ機能適用除外設定ファイル）

Explicitヒープへ移動させたくないオブジェクトのクラスを指定します。この設定ファイルに指定したクラスのオブジェクトは、GCが発生しても、Explicitヒープへ移動しません。昇格するタイミングでTenured領域へ移動します。

8.3　exmemnotexcludeclass.cfg

明示管理ヒープ機能適用除外設定ファイルに指定したクラスのうち適用除外設定を無効にしたいクラスを指定する設定ファイル（明示管理ヒープ機能適用除外無効設定ファイル）

明示管理ヒープ機能適用除外設定ファイルに指定したクラスのうち、適用除外設定を無効にしたいクラスを指定します。このファイルに指定したクラスのオブジェクトは、GCが発生すると、Explicitヒープへ移動します。

8.4　userprf.cfg

ユーザー拡張性能解析トレースで使用するユーザー拡張性能解析トレース設定ファイル

ユーザー拡張性能解析トレースのトレース対象メソッドの情報は、ユーザー拡張性能解析トレース設定ファイルを使って設定します。

8.2　exmemexcludeclass.cfg

Explicitヒープへ移動させたくないオブジェクトのクラスを指定する設定ファイルのことです。この設定ファイルを明示管理ヒープ機能適用除外設定ファイルといいます。

説明

Explicitヒープへ移動させたくないオブジェクトのクラスを指定します。この設定ファイルに指定したクラスのオブジェクトは、GCが発生しても、Explicitヒープへ移動しません。昇格するタイミングでTenured領域へ移動します。

明示管理ヒープ機能適用除外設定ファイルには、システムで提供しているファイルがあります。明示管理ヒープ機能適用除外クラス指定機能を有効にすると、システムで提供している設定ファイル（sysexmemexcludeclass.cfg）が使用されます。システムで提供している設定ファイルのほかに、明示管理ヒープ機能の適用対象から除外するクラスを追加したい場合は、格納先に示すファイルパスにある設定ファイルを更新するか、または新たな設定ファイルを作成してください。なお、新たに設定ファイルを作成した場合は、-XX:ExplicitMemoryExcludeClassListFileオプションにファイルパスを指定してください。

システムで提供している設定ファイルのファイルパスを次に示します。

JDKのインストールディレクトリー¥jre¥lib¥explicitmemory¥sysexmemexcludeclass.cfg

この設定ファイルに指定したクラスに対して適用除外設定を無効にする制御は、明示管理ヒープ機能適用除外無効設定ファイルで指定できます。明示管理ヒープ機能適用除外無効設定ファイルの指定は、この設定ファイルの指定よりも優先されます。

パッケージ「com.sample」を例に、各設定ファイルの指定と明示管理ヒープ機能の適用範囲について説明します。パッケージ「com.sample」には、ClassAとClassBの2つのクラスがあります。各設定ファイルを次のように指定します。

明示管理ヒープ機能適用除外設定ファイルの指定例

com.sample.*

明示管理ヒープ機能適用除外無効設定ファイルの指定例

com.sample.ClassB

明示管理ヒープ機能適用除外設定ファイルの指定には、ClassAとClassBの両方が含まれています。しかし、明示管理ヒープ機能適用除外無効設定ファイルの指定が優先されるため、次の図のように、明示管理ヒープ機能の適用が除外されるのはClassAだけとなり、ClassBには明示管理ヒープ機能が適用されます。

書式

配列型以外の場合

指定したクラスの完全修飾クラス名#コメント
...
指定したクラスの完全修飾クラス名

配列型の場合

配列の次元数分の"["※L指定したクラスの完全修飾クラス名;

注※

多次元配列のときは、「[」を次元数分続けて指定します。3次元配列の場合は「[[[」となります。

（例）aaa.bbb.Myclassクラスの1次元配列の場合

[Laaa.bbb.Myclass;

この設定ファイルの記述規則を次に示します。

クラス名は1行に1つずつ記述します。

1行に記述できる文字数は1,024文字までです。この文字数は空文字やコメントを含みます。1行に1,025文字以上記述すると、パースに失敗してワーニングメッセージを出力し、その行を無視して読み込み処理を続けます。

クラス名は、「パッケージ名.*」と指定すると省略できます。Java言語のimport宣言の「*」とは異なり、サブパッケージのクラスも対象となります。

行末は、改行文字（「¥n」もしくは「0x0A」）または復帰文字（「¥r」もしくは「0x0D」）が１文字以上続いたものとなります。

空白文字は、半角スペース文字（「0x20」）またはタブ文字（「¥t」もしくは「0x09」）となります。なお、設定ファイルに空白文字を記述した場合は無視されます。

コメントは、「#」で始まり、「#」から行末までの間の文字すべてをコメントとします。

格納先

JDKのインストールディレクトリー¥usrconf¥exmemexcludeclass.cfg

記述例

ここで説明する記述例は、パッケージ名が「com.sample」で、次の図に示すクラス構造とします。

図8‒1　クラス構造の例

完全修飾クラス名で指定する場合

完全修飾クラス名で指定する場合の明示管理ヒープ機能適用除外設定ファイルの記述例を次に示します。

com.sample.aaa.ClassA
com.sample.aaa.ClassC
com.sample.ddd.ClassD

この例では、ClassAクラス、ClassCクラス、およびClassDクラスのオブジェクトがTenured領域へ移動します。

クラス名を省略して指定する場合

クラス名を省略して指定する場合の明示管理ヒープ機能適用除外設定ファイル、および明示管理ヒープ機能適用除外無効設定ファイルの記述例を次に示します。

明示管理ヒープ機能適用除外設定ファイルの記述例

com.sample.*

明示管理ヒープ機能適用除外無効設定ファイルの記述例

com.sample.aaa.ClassB
com.sample.ddd.ClassE

この例では、明示管理ヒープ機能適用除外設定ファイルの記述から、同一パッケージ内のクラスだけでなく、サブパッケージに存在するクラスも含めすべてのクラスがTenured領域への移動対象となります。しかし、明示管理ヒープ機能適用除外無効設定ファイルの記述から、ClassBクラスとClassEクラスのオブジェクトがExplicitメモリーブロックへの移動対象となります。このため、ClassAクラス、ClassCクラス、およびClassDクラスのオブジェクトがTenured領域へ移動します。

完全修飾クラス名で指定するか、またはクラス名を省略して指定するかは、設定ファイルの記述量が少ない方で指定することをお勧めします。記述例はどちらも同じ制御となります。この場合は、クラス名を省略して指定する方が望ましい記述です。

8.3　exmemnotexcludeclass.cfg

明示管理ヒープ機能適用除外設定ファイルに指定したクラスのうち、適用除外設定を無効にしたいクラスを指定する設定ファイルのことです。この設定ファイルを明示管理ヒープ機能適用除外無効設定ファイルといいます。

説明

明示管理ヒープ機能適用除外設定ファイルに指定したクラスのうち、適用除外設定を無効にしたいクラスを指定します。このファイルに指定したクラスのオブジェクトは、GCが発生すると、Explicitヒープへ移動します。

明示管理ヒープ機能の適用対象から除外されているクラスを無効にしたい場合は、格納先に示すファイルパスにある設定ファイルを更新するか、または新たな設定ファイルを作成してください。システムで提供している明示管理ヒープ機能適用除外設定ファイル（sysexmemexcludeclass.cfg）に指定されているクラスも設定を無効にできます。なお、新たに設定ファイルを作成した場合は、-XX:ExplicitMemoryNotExcludeClassListFileオプションにファイルパスを指定してください。

この設定ファイルの指定は、明示管理ヒープ機能適用除外設定ファイルの指定よりも優先されます。

パッケージ「com.sample」を例に、各設定ファイルの指定と明示管理ヒープ機能の適用範囲について説明します。パッケージ「com.sample」には、ClassAとClassBの2つのクラスがあります。各設定ファイルを次のように指定します。

明示管理ヒープ機能適用除外設定ファイルの指定例

com.sample.*

明示管理ヒープ機能適用除外無効設定ファイルの指定例

com.sample.ClassB

明示管理ヒープ機能適用除外設定ファイルの指定には、ClassAとClassBの両方が含まれています。しかし、明示管理ヒープ機能適用除外無効設定ファイルの指定が優先されるため、次の図のように、明示管理ヒープ機能の適用が除外されるのはClassAだけとなり、ClassBには明示管理ヒープ機能が適用されます。

書式

配列型以外の場合

指定したクラスの完全修飾クラス名#コメント
...
指定したクラスの完全修飾クラス名

配列型の場合

配列の次元数分の"["※L指定したクラスの完全修飾クラス名;

注※

多次元配列のときは、「[」を次元数分続けて指定します。3次元配列の場合は「[[[」となります。

（例）aaa.bbb.Myclassクラスの1次元配列の場合

[Laaa.bbb.Myclass;

この設定ファイルの記述規則を次に示します。

クラス名は1行に1つずつ記述します。

1行に記述できる文字数は1,024文字までです。この文字数は空文字やコメントを含みます。1行に1,025文字以上記述すると、パースに失敗してワーニングメッセージを出力し、その行を無視して読み込み処理を続けます。

クラス名は、「パッケージ名.*」と指定すると省略できます。Java言語のimport宣言の「*」とは異なり、サブパッケージのクラスも対象となります。

行末は、改行文字（「¥n」もしくは「0x0A」）または復帰文字（「¥r」もしくは「0x0D」）が１文字以上続いたものとなります。

空白文字は、半角スペース文字（「0x20」）またはタブ文字（「¥t」もしくは「0x09」）となります。なお、設定ファイルに空白文字を記述した場合は無視されます。

コメントは、「#」で始まり、「#」から行末までの間の文字すべてをコメントとします。

格納先

JDKのインストールディレクトリー¥usrconf¥exmemnotexcludeclass.cfg

記述例

ここで説明する記述例は、パッケージ名が「com.sample」で、次の図に示すクラス構造とし、明示管理ヒープ機能適用除外設定ファイルでは、クラス名を省略して指定するとします。

図8‒2　クラス構造の例

明示管理ヒープ機能適用除外設定ファイルの記述例

com.sample.*

明示管理ヒープ機能適用除外無効設定ファイルの記述例

com.sample.aaa.ClassB
com.sample.ddd.ClassE

この例では、明示管理ヒープ機能適用除外設定ファイルの記述から、同一パッケージ内のクラスだけでなく、サブパッケージに存在するクラスも含めすべてのクラスがTenured領域への移動対象となります。しかし、明示管理ヒープ機能適用除外無効設定ファイルの記述から、ClassBクラスとClassEクラスのオブジェクトがExplicitメモリーブロックへの移動対象となります。このため、ClassAクラス、ClassCクラス、およびClassDクラスのオブジェクトがTenured領域へ移動します。

注意事項

この設定ファイルは、明示管理ヒープ機能適用除外設定ファイルに指定されたクラスの中で明示管理ヒープ機能適用除外設定を無効にするクラスを指定する設定ファイルであり、Explicitメモリーブロックへ移動するクラスを指定する設定ファイルではありません。

8.4　userprf.cfg

ユーザー拡張性能解析トレースで使用するユーザー拡張性能解析トレース設定ファイルのことです。

説明

ユーザー拡張性能解析トレースのトレース対象メソッドの情報は、ユーザー拡張性能解析トレース設定ファイルを使って設定します。

書式

指定形式,識別ID,サブクラスフラグ[,[イベントID][,[トレース取得レベル]]]
[#コメント]

注

クラス名およびパッケージ名が一致するすべてのメソッドを対象とする場合、jvm.userprf.ExtendedSettingプロパティーの値をtrueに設定してください。

ユーザー拡張性能解析トレース設定ファイルの記述項目を次に示します。

記述項目

内容

指定形式

トレース対象メソッドを指定します。

指定形式は次のどれかの形式で指定します。

メソッド名と引数の型が一致するメソッドをトレースの対象とする場合

パッケージ名.クラス名.メソッド名(メソッドの引数の型名)

メソッド名が一致するメソッドをトレースの対象とする場合

パッケージ名.クラス名.メソッド名(*)

クラス名が一致するすべてのメソッドをトレースの対象とする場合

パッケージ名.クラス名

パッケージ名が一致するすべてのメソッドをトレースの対象とする場合

パッケージ名.*

指定形式の項目について説明します。

パッケージ名

トレース対象メソッドのクラスまたはインターフェースのパッケージ名を指定します。

クラス名

トレース対象メソッドのクラス名またはインターフェース名を指定します。クラス名の代わりにインターフェース名を指定し、かつ、サブクラスフラグにtrueを指定した場合、そのインターフェースを実装しているメソッドがトレース対象となります。

メソッド名

トレース対象メソッドの名前を指定します。

メソッドの引数の型名

トレース対象メソッドの引数の型を完全修飾名で指定します。

識別ID

トレース対象メソッドを識別するための文字列を指定します。

使用できる文字はASCII文字で0x21（!）から0x7e（~）までです。ただし、0x22（"）、0x23（#）、および0x2c（,）は指定できません。

識別IDはPRFトレースファイルに出力されます。なお、PRFトレースファイルに出力される文字数は32文字までです。33文字目以降は省略されて、33文字目に*が出力されます。

トレース対象メソッドが定義されているクラスにサブクラスが存在し、そのサブクラスでトレース対象メソッドがオーバーライドされていない場合、スーパークラスのトレース対象メソッドに対して指定された識別IDが出力されます。

サブクラスフラグ

指定したメソッドのクラスまたはインターフェースと継承関係にあるクラスのメソッドをトレース対象に含めるかどうかをtrueまたはfalseで指定します。

trueを指定した場合、指定したメソッドと、それをオーバーライドしているメソッドがトレース対象となります。

falseを指定した場合、指定したメソッドだけがトレース対象となり、指定したメソッドをオーバーライドしているメソッドはトレース対象となりません。

イベントID

トレース情報を取得するポイント（トレース取得ポイント）を16進数（0xae02〜0xae7eおよび0xc000〜0xcffe）の値で指定します。デフォルト値は0xae00です。

メソッドの入口で出力されるトレース情報にはこの値が出力され、メソッドの出口で出力されるトレース情報にはこの値+1が出力されます。

トレース取得レベル

トレース対象メソッドのトレース取得レベルに、A、B、C、またはそれぞれの小文字のどれかを指定します。デフォルト値はAです。

A：標準レベル

B：詳細レベル

C：保守レベル

トレース取得レベルはcprflevelコマンドのPRFトレース取得レベルと同じです。トレース対象メソッドはすべてJava VMレイヤのレベルを参照します。

コメント

コメントは「#」で始まり、「#」から行末までの間の文字すべてをコメントとします。

ユーザー拡張性能解析トレース設定ファイルの記述規則を次に示します。

記述にはシングルバイト文字だけが使用できます。

空白文字は、半角スペース文字（「0x20」）またはタブ文字（「¥t」もしくは「0x09」）となります。なお、ユーザー拡張性能解析トレース設定ファイルの読み込みでは空白文字は無視されます。

トレース対象メソッドは1行に1つずつ記述します。

1行に指定できる文字数は2,048文字までです。この文字数には空白やコメントを含みます。

行末は改行文字（「¥n」もしくは「0x0A」）または復帰文字（「¥r」もしくは「0x0D」）が1文字以上続いたものとなります。

ユーザー拡張性能解析トレース設定ファイルの記述に誤りがある場合、誤りの内容を示すメッセージが出力されます。また、各項目に無効な値を記述した場合、誤りの内容を示すメッセージが出力され、その行の設定は無効になります。

ユーザー拡張性能解析トレースでユーザー拡張性能解析トレース設定ファイルの読み込み時に出力されるログ情報を次の表に示します。

出力形式

出力内容

説明

[UPR※1]<DATE>Setting file not found.<file=FILEPATH>

DATE※2

ユーザー拡張性能解析トレース設定ファイルの読み込みに失敗した日時。

FILEPATH

読み込みに失敗したユーザー拡張性能解析トレース設定ファイルの絶対パス。

デフォルト、またはjvm.userprf.Fileプロパティーで指定したユーザー拡張性能解析トレース設定ファイルが存在しません。

[UPR※1]<DATE>Failed to open setting file.<file=FILEPATH>

DATE※2

ユーザー拡張性能解析トレース設定ファイルの読み込みに失敗した日時。

FILEPATH

読み込みに失敗したユーザー拡張性能解析トレース設定ファイルの絶対パス。

ユーザー拡張性能解析トレース設定ファイルのオープンまたは読み込みができません。

[UPR※1]<DATE>Failed to parse setting file.<file=FILEPATH><line=LINE>

DATE※2

ユーザー拡張性能解析トレース設定ファイルの誤りを検出した日時。

FILEPATH

ユーザー拡張性能解析トレース設定ファイルの絶対パス。

LINE

ユーザー拡張性能解析トレース設定ファイルの行番号。

ユーザー拡張性能解析トレース設定ファイルの内容に記述フォーマット上の誤りがあります。

[UPR※1]<DATE>Event ID is invalid value.<file=FILEPATH><eventID=EventID>

DATE※2

ユーザー拡張性能解析トレース設定ファイルの誤りを検出した日時。

FILEPATH

ユーザー拡張性能解析トレース設定ファイルの絶対パス。

EventID

ユーザー拡張性能解析トレース設定ファイルに指定したイベントID。

ユーザー拡張性能解析トレース設定ファイルのイベントIDが有効な値の範囲外です。

[UPR※1]<DATE>No valid settings in setting file.<file=FILEPATH>

DATE※2

ユーザー拡張性能解析トレース設定ファイルに有効な設定がないことを検出した日時。

FILEPATH

ユーザー拡張性能解析トレース設定ファイルの絶対パス。

ユーザー拡張性能解析トレース設定ファイルに有効な設定がありません。

[UPR※1]<DATE>User Extended PRF started successfully.<file=FILEPATH>

DATE※2

ユーザー拡張性能解析トレース設定ファイルの読み込みに成功した日時。

FILEPATH

有効に読み込みが行われたユーザー拡張性能解析トレース設定ファイルの絶対パス。

ユーザー拡張性能解析トレース設定ファイルが正常に読み込まれ、ユーザー拡張性能解析トレースが有効になりました。

注※1

ユーザー拡張性能解析トレースが出力したログであることを示す識別子です。

注※2

拡張verbosegc情報と同じ形式で出力します。

ユーザー拡張性能解析トレースでは、JavaVM内のクラスやApplication Server内のクラスはトレース対象のメソッドに指定できません。次のパッケージが該当します。

java以下

javax以下

com.hitachi以下

JP.co.Hitachi以下

そのため、jvm.userprf.ExtendedSettingプロパティーを指定して、パッケージ名指定をする場合は、アプリケーションのクラスだけが含まれるようにパッケージ名を記述してください。

次のメソッドはトレース対象のメソッドに指定できません。

存在しないパッケージ名、クラス名、およびメソッド名

nativeメソッド

abstractメソッド

JavaVM内のクラス、およびそのクラスのメソッド

（例）javaおよびjavaxで始まるパッケージのクラス

-Xbootclasspathで指定したクラス、およびそのクラスのメソッド

製品内のクラス

次のメソッドは次の記述でトレース対象のメソッドに指定できます。

コンストラクターは、クラス名と同じメソッド名、または<init>で指定できます。

（例）MyMainクラスのコンストラクターの場合、次のように指定します。

MyMain.MyMain()またはMyMain.<init>()

コンストラクターではないクラス名と同じ名前のメソッドを指定した場合は、コンストラクターを指定しているのか、メソッドを指定しているのか判別できないためコンストラクターとメソッドがトレースの対象となります。

引数が可変長であるメソッドを指定する場合は、可変長の引数を配列として記述してください。

（例）引数が可変長であるメソッドの指定

正しい指定例：com.sample.Test.method(java.lang.String[])

誤った指定例：com.sample.Test.method(java.lang.String...)

ネストクラスは、「.」ではなく「$」で区切った名前を指定してください。

（例）ネストクラスの指定

正しい指定例：com.sample.Test$NestClass

誤った指定例：com.sample.Test.NestClass

ジェネリックスではなく、パラメーター化されていないクラス名（raw型）であれば指定できます。

（例）ジェネリックスではないクラスの指定

正しい指定例：com.sample.Test.method()

誤った指定例：com.sample.Test<java.lang.String,java.lang.Object>.method()

指定形式のクラス名にクラス名を指定した場合とインターフェース名を指定した場合ではトレース対象メソッドが異なります。

クラスまたはインターフェースの指定によるトレース対象メソッドを次の表に示します。

クラスまたはインターフェース

トレース対象メソッド

サブクラスフラグにfalseを指定した場合

サブクラスフラグにtrueを指定した場合

クラス

指定したクラスのメソッド

指定したクラスのメソッドと、そのメソッドをオーバーライドしているメソッド

インターフェース

なし

指定したインターフェースを直接実装しているクラス※1と間接実装しているクラス※2のメソッド、およびそのメソッドをオーバーライドしているメソッド

注※1

クラスの宣言時にimplementsを使用して指定したインターフェースを実装しているクラスです。

注※2

指定したインターフェースを直接実装しているクラスのサブクラス、または指定したインターフェースを継承しているインターフェースを直接実装しているクラスです。

ユーザー拡張性能解析トレース設定ファイルの記述形式の例を次に示します。

com.sample.Test.method(),TEST1,false,0xae02,A
com.sample.Test.method(),TEST1,false,0xae02
com.sample.Test.method(),TEST1,false,0xae02,
com.sample.Test.method(),TEST1,false,,A
com.sample.Test.method(),TEST1,false
com.sample.Test.method(),TEST1,false,
com.sample.Test.method(),TEST1,false,,

格納先

JDKのインストールディレクトリー¥usrconf¥userprf.cfg

記述例

ここで説明する記述例は、パッケージ名が「com.sample」で、次の図に示すクラス構造を持っているアプリケーションとします。

図8‒3　アプリケーションのクラス構造の例

メソッド名と引数の型が一致するメソッドをトレースの対象とする場合のユーザー拡張性能解析トレース設定ファイルの記述例を次に示します。

サブクラスフラグがfalseの場合

com.sample.ClassA.methodA1(java.lang.String,java.lang.Object),1000,false

サブクラスフラグがfalseの場合、記述したメソッド名と引数の型が一致するメソッドがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassAクラスのmethodA1(String,Object)

トレース対象メソッドに対してイベントIDの設定を省略しているため、トレース対象となったメソッドが呼び出されると、イベントIDとしてメソッドの入口で0xae00、メソッドの出口で0xae01のデフォルト値が出力されます。また、識別IDに「1000」を設定しているため、識別IDとして「1000」が出力されます。

サブクラスフラグがtrueの場合

com.sample.ClassA.methodA2(),2000,true

サブクラスフラグがtureの場合、メソッド名と引数の型が記述と一致するメソッドに加えて、記述したメソッドをオーバーライドしているメソッドもトレース対象となります。

トレース対象のメソッドを次に示します。

ClassAクラスのmethodA2()

ClassAクラスのmethodA2()をオーバーライドしているClassBクラスのmethodA2()

トレース対象メソッドに対してイベントIDの設定を省略しているため、トレース対象となったメソッドが呼び出されると、イベントIDとしてメソッドの入口で0xae00、メソッドの出口で0xae01のデフォルト値が出力されます。また、識別IDに「2000」を設定しているため、トレース対象のすべてのメソッドに識別IDとして「2000」が出力されます。

メソッド名が一致するメソッドをトレースの対象とする場合のユーザー拡張性能解析トレース設定ファイルの記述例を次に示します。

サブクラスフラグがfalseの場合

com.sample.ClassA.methodA1(*),methodA1,false,0xae30

サブクラスフラグがfalseの場合、記述したメソッド名と一致するメソッドのすべてがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassAクラスのmethodA1(String,Object)

ClassAクラスのmethodA1(int)

トレース対象となったメソッドが呼び出されると、イベントIDとしてメソッドの入口で0xae30、メソッドの出口で0xae31が出力されます。また、トレース対象のすべてのメソッドに識別IDとして「methodA1」が出力されます。

サブクラスフラグがtrueの場合

com.sample.ClassA.methodA1(*),methodA1,true,0xae30

サブクラスフラグがtrueの場合、記述したメソッド名と一致するメソッドのすべてがトレース対象となります。また、記述したメソッドに加えて、記述したメソッドをオーバーライドしているメソッドもトレース対象となります。

トレース対象のメソッドを次に示します。

ClassAクラスのmethodA1(String,Object)とmethodA1(int)

ClassAクラスのmethodA1(String,Object)をオーバーライドしているClassBクラスのmethodA1(String,Object)

ClassBクラスのmethodA1(String,Object)をオーバーライドしているClassCクラスのmethodA1(String,Object)

トレース対象となったメソッドが呼び出されると、イベントIDとしてメソッドの入口で0xae30、メソッドの出口で0xae31が出力されます。また、トレース対象のすべてのメソッドに識別IDとして「methodA1」が出力されます。

メソッドと引数を省略して、クラス名が一致するすべてのメソッドをトレースの対象とする場合のユーザー拡張性能解析トレース設定ファイルの記述例を次に示します。

サブクラスフラグがfalseの場合

com.sample.ClassA,TEST01,false

サブクラスフラグがfalseの場合、記述したクラス名（ClassAクラス）のすべてのメソッドがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassAクラスのmethodA1(String,Object)、methodA1(int)、およびmethodA2()

トレース対象となったメソッドが呼び出されると、イベントIDが省略されているため、メソッド入口で0xae00、メソッド出口で0xae01が出力されます。また、これらすべてのメソッドに識別IDとして「TEST01」が出力されます。

サブクラスフラグがtrueの場合

com.sample.ClassB,TEST02,true

サブクラスフラグがtrueの場合、記述したクラス名（ClassBクラス）のすべてのメソッドと、そのメソッドをオーバーライドしているメソッドのすべてがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassBクラスのmethodA1(String,Object)

ClassBクラスのmethodA2()

ClassBクラスのmethodB1()

ClassBクラスのmethodA1(String,Object)をオーバーライドしているClassCクラスのmethodA1(String,Object)

トレース対象となったメソッドが呼び出されると、イベントIDが省略されているため、メソッド入口で0xae00、メソッド出口で0xae01が出力されます。また、これらすべてのメソッドに識別IDとして「TEST02」が出力されます。

クラス名とメソッド名と引数を省略して、パッケージ名が一致するすべてのクラスのすべてのメソッドをトレースの対象とする場合のユーザー拡張性能解析トレース設定ファイルの記述例を次に示します。

重要

この指定ではサブパッケージも対象に含まれます。トレース対象となった場合、対象となったメソッドが呼び出されるとトレースが出力されます。

com.sampleパッケージにサブパッケージがある場合、そのサブパッケージのすべてのクラスのすべてのメソッドもトレース対象となります。

サブクラスフラグがfalseの場合

com.sample.*,6000,false

サブクラスフラグがfalseの場合、記述したパッケージ（com.sample）にあるすべてのクラスのすべてのメソッドがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassA、ClassB、ClassC、ClassDのすべてのメソッド

トレース対象となったメソッドが呼び出されると、イベントIDが省略されているため、メソッド入口で0xae00、メソッド出口で0xae01が出力されます。また、これらすべてのメソッドに識別IDとして「6000」が出力されます。

サブクラスフラグがtrueの場合

com.sample.*,6000,true

サブクラスフラグがtrueの場合、記述したパッケージ（com.sample）にあるすべてのクラスのすべてのメソッドと、そのメソッドをオーバーライドしているメソッドのすべてがトレース対象となります。

トレース対象のメソッドを次に示します。

ClassA、ClassB、ClassC、ClassDのすべてのメソッドと、そのメソッドをオーバーライドしているすべてのメソッド

トレース対象となったメソッドが呼び出されると、イベントIDが省略されているため、メソッド入口で0xae00、メソッド出口で0xae01が出力されます。また、これらすべてのメソッドに識別IDとして「6000」が出力されます。

注意事項

ユーザー拡張性能解析トレース設定ファイルで、同じメソッドに対して複数行で異なるイベントIDまたは識別IDを指定した場合、ユーザー拡張性能解析トレース設定ファイルの前方に記述された設定が優先されます。

ユーザー拡張性能解析トレース設定ファイルで、複数のメソッドを対象とする記述をした場合、対象となるすべてのメソッドが同一イベントIDまたは識別IDで出力されます。その場合、出力されるメソッド名が出力できる文字数を超えるとメソッドを特定できないことがあります。メソッドを1つに特定できるように記述してください。

トレース対象にインターフェースを指定した場合、サブクラスフラグにtrueを指定してください。インターフェースにはトレース対象となるメソッドが存在しないため、サブクラスフラグにfalseを指定するとトレース情報は出力されません。

複数のメソッドをユーザー拡張解析トレースの対象とする指定形式は、アプリケーションの動作を把握したい場合などに限り指定してください。ユーザー拡張性能解析トレース設定ファイルの記述で、サブクラスフラグにtrueを指定した場合や、メソッド名が一致するメソッドをトレースの対象とする指定形式で指定した場合、ユーザーが意図しない多くのメソッドがユーザー拡張性能解析トレースの対象となり、性能劣化要因の特定が困難になることがあります。性能劣化要因の特定のためには、ユーザー拡張性能解析トレース設定ファイルのサブクラスフラグにfalseを指定する、またはメソッド名と引数の型が一致するメソッドをトレースの対象とする指定形式で指定するなどで、ユーザー拡張性能解析トレースの対象を限定することを推奨します。

索引

数字

1スタック領域の最大サイズの指定[1]

1つのメソッドのパラメーターの完全修飾Java型名の指定[1]

1つのログファイルに書き込める上限の指定[1]

200番台のステータスコード応答時のレスポンスヘッダーのカスタマイズ[1]

A

AccessFileNameディレクティブで指定したファイルでのアクセス情報定義の上書き許可[1]

activation-configで設定するプロパティー値の指定[1]

activation-configで設定するプロパティーの指定[1]

activation-configで設定するプロパティー名称の指定[1]

activation-config要素の説明の記述[1]

admin-object-resource要素の説明の指定[1]

AllowディレクティブとDenyディレクティブの指定の評価の順序[1]

asadminプロセスおよびドメイン管理サーバに設定するHTTPリードタイムアウト値の指定[1]

asadminユーティリティーコマンドのスタックトレースログの有効または無効の指定[1]

asadminユーティリティーコマンドのスタックトレースログファイルの切り替え時刻[1]

asadminユーティリティーコマンドのスタックトレースログファイルのサイズ[1]

asadminユーティリティーコマンドのスタックトレースログファイルの面数[1]

asadminユーティリティーコマンドのプロセス起動時ログの有効または無効の指定[1]

asadminユーティリティーコマンドのプロセス起動時ログファイルの切り替え時刻の指定[1]

asadminユーティリティーコマンドのプロセス起動時ログファイルのサイズ[1]

asadminユーティリティーコマンドのプロセス起動時ログファイルの面数[1]

asadminユーティリティーコマンドのプロセスに適用するJavaVMオプションの指定[1]

asadminユーティリティーコマンドの保守ログの有効または無効の指定[1]

asadminユーティリティーコマンドの保守ログのレベル[1]

asadminユーティリティーコマンドの保守ログファイルの切り替え時刻[1]

asadminユーティリティーコマンドの保守ログファイルのサイズ[1]

asadminユーティリティーコマンドの保守ログファイルの面数[1]

asadminユーティリティーコマンドのメッセージログの有効または無効の指定[1]

asadminユーティリティーコマンドのメッセージログのレベル[1]

asadminユーティリティーコマンドのメッセージログファイルの切り替え時刻[1]

asadminユーティリティーコマンドのメッセージログファイルのサイズ[1]

asadminユーティリティーコマンドのメッセージログファイルの面数[1]

asadminユーティリティーコマンドのログ出力先ディレクトリーの分割の有効または無効の指定[1]

auth-method要素で指定された認証方式がクライアント認証に使用される必要があるかどうかの指定[1]

AUTHコマンドを使用したユーザー認証の指定[1]

C

CAの証明書のファイルの指定[1]

CGIスクリプトに渡す環境変数[1]

CGIスクリプトに渡す環境変数からSetEnvディレクティブまたはPassEnvディレクティブで指定した環境変数を削除する場合の指定[1]

CGIスクリプトに渡す任意の環境変数[1]

CGIスクリプトのエラーログ出力先[1]

CGIスクリプトのエラーログファイルの最大サイズ[1]

CGIスクリプトの実行に使用されるインタープリターの指定[1]

CGIプログラムを実行するURLとCGIプログラムが配置されているディレクトリー名の指定[1]

CGIプログラムを実行するURLに対する正規表現とCGIプログラムが配置されているディレクトリー名の指定[1]

Compressed Class Spaceの最大値の指定[1]

Concurrent Markingの処理を並列実行するスレッド数の指定[1]

connector-connection-pool要素の説明の指定[1]

connector-resource要素の説明の指定[1]

Cookieを送信してきたリクエストだけを処理するときのサーバスレッド数[1]

CopyGC実行時にFrom空間とTo空間でJavaオブジェクトを入れ替える回数のしきい値の指定[1]

CRLの次回発行日を経過した場合の動作の指定[1]

custom-resource要素の説明の指定[1]

D

DER形式のCRLを格納するディレクトリーの指定[1]

DSOによって組み込むモジュールが参照するコードがあるオブジェクトファイルまたはライブラリー[1]

E

EHLOコマンドによるサインオンの指定[1]

EISが必要とするユーザー名およびパスワードの指定[1]

EISグループのJava EE Serverのサーバインスタンスでのグループへのマップ[1]

EISでのプリンシパルのJava EE Serverのサーバインスタンスでのプリンシパルのマッピング[1]

EJB Webサービスエンドポイントの認証のための設定[1], [2]

ejb-jar.xmlで定義したEnterprise Beanのejb-name要素の値の指定[1]

EJB-JARに含まれるEnterprise Beanのための実行時の設定を指定するための要素[1]

EJB-JARの実行時の設定をするための要素[1]

EJB-JARの設定をするためのJava EE RIのDD[1]

EJB-JARの設定をするための拡張DD[1]

ejb-ref要素のejb-ref-nameの指定[1]

ejb-refを定義するEnterprise BeanのJNDI完全修飾名の指定[1]

EJBのインスタンスプールが保持する、Beanの最大数の指定[1]

EJBのインスタンスプールが保持するBeanの初期値と最小数の指定[1]

EJBのインスタンスプールで、アイドル状態で保持される最大時間の指定[1]

EJBのインスタンスプールに対して、同時に作成または削除されるBeanのインスタンス数の指定[1]

EJBのインスタンスプールの設定[1]

EJBのホームオブジェクトのJNDI完全修飾名のマッピングの定義[1]

EJBモジュール内のWebサービスの名称の指定[1]

EJBモジュール内のポートコンポーネントに一意の名称の指定[1]

EJBモジュールのバージョン情報の定義[1]

Enterprise Beanから参照されているWSDLサービスの指定[1]

enterprise-beans要素の名称の指定[1]

ETagレスポンスヘッダーフィールドを作成するために使用されるファイルの属性値[1]

Explicitヒープ全体の最大サイズの指定[1]

Explicitヒープへ移動させたくないオブジェクトのクラスを指定する設定ファイル（明示管理ヒープ機能適用除外設定ファイル）[1]

Explicitメモリーブロックの解放処理でのオブジェクトの移動先のTenured領域への変更[1]

Explicitメモリーブロックの確保方法を08-00と同様にするかどうかの指定[1]

Explicitメモリーブロックの自動配置機能で利用する自動配置設定ファイルのパスの指定[1]

Explicitメモリーブロックの自動配置機能の有効または無効の設定[1]

external-jndi-resource要素の説明の指定[1]

F

FullGC発生時の参照関係に基づくオブジェクトのJavaヒープからExplicitメモリーブロックへの移動の制御[1]

G

G1GCのGCによるアプリケーション停止時間の目標時間の指定[1]

G1GCの実行[1]

G1GCを並列実行するスレッドの数の指定[1]

GCイベントが発生するたびにfileへのログの出力[1]

GCが発生した場合に拡張verbosegc情報のJavaVMログファイルへの出力[1]

GC実行後のSurvivor領域内でJavaオブジェクトが占める割合の目標値の指定[1]

GCの要因内容の出力[1]

GMS-BIND-INTERFACE-ADDRESS-cluster-nameシステムプロパティーの指定[1]

H

HTTPSリクエストをリッスンするポートのポート番号の指定[1]

HTTPセッションで利用するExplicitヒープの省メモリー化機能の有効または無効の設定[1]

HTTP リクエストをリッスンするために使用するポート番号の指定[1]

I

IIOP 接続で使われるポートのポート番号の指定[1]

information-typeに指定した情報の出力[1]

IORのセキュリティー情報の指定[1]

J

JAAS認証レルムのオプションの設定[1]

Java EE Serverがシャットダウン時に非XAトランザクションをコミットするかロールバックするかの指定[1]

Java EE Server 固有の設定の定義[1]

Java EE Serverで使用するすべてのシステムプロパティーの概要[1]

Java EE Serverで使用するすべての定義ファイルの概要[1]

Java EE Serverで使用するすべてのプロパティーファイルの概要[1]

Java EE Serverの環境変数定義ファイル[1]

Java EE Serverのログファイルの出力先ディレクトリー[1]

Java EEアプリケーションの設定をするためのJava EE RIのDD[1]

Java EEアプリケーションの設定をするための拡張DD[1]

Java EEサーバで使用するすべてのDDの概要[1]

Java EE標準APIで設定できるJava EE Server独自のプロパティーの概要[1]

Java Platform Debugger Architecture (JPDA) デバッガーとの接続に使用されるポート番号の指定[1]

java:comp/envで始まるWebサービス参照名の指定[1], [2], [3], [4], [5], [6], [7], [8]

java.io.File.deleteOnExit()の呼び出しでJavaVMが確保した累積のヒープサイズとメソッドの呼び出し回数のJavaVMログファイルへの出力[1]

JavaMailリソースの定義[1]

JavaVM拡張オプションの一覧の表示[1]

JavaVMで使用するオプションの概要[1]

JavaVMで使用する環境変数の概要[1]

JavaVMで使用する定義ファイルの概要[1]

JavaVMで使用するプロパティーの概要[1]

JavaVM内部で管理しているヒープ情報のJavaVMログファイルへの出力[1]

JavaVMの標準出力と標準エラー出力の内容のJavaVMログファイルへの出力[1]

JavaVMログファイルオープン時のヘッダー情報の出力[1]

JavaVMログファイルに出力する日時のミリ秒までの出力[1]

JavaVMログファイルの1ファイル当たりの最大ファイルサイズの指定[1]

JavaVMログファイルの作成する最大ファイル数の指定[1]

JavaVMログファイルのプリフィクスおよびログファイルの出力先ディレクトリーの指定[1]

JavaVMログファイルのローテーション時刻の指定[1]

JavaVMログファイルのローテーション方式の指定[1]

javawコマンドを実行可能にするための環境変数[1]

javax.xml.rpc.Callオブジェクトに設定されるJAX-RPCプロパティーの値の指定[1], [2], [3], [4]

javax.xml.rpc.Call オブジェクトに設定される JAX-RPC プロパティーの値の指定[1], [2]

javax.xml.rpc.Stubオブジェクトに設定されるJAX-RPCプロパティーの値の指定[1], [2], [3]

javax.xml.rpc.Stub オブジェクトに設定される JAX-RPC プロパティーの値の指定[1]

Javaアプリケーションプログラムの実行[1]

javaコマンドを実行可能にするための環境変数[1]

Javaスレッドの数のJavaVMログファイルへの出力[1]

Javaヒープの最大サイズの指定[1]

Javaヒープの初期サイズの指定[1]

JavaメソッドのJITコンパイル対象時にコードキャッシュ領域が枯渇したときのメッセージのJavaVMログファイルへの出力[1]

JAX-RSのサーブレットに対するリソースとプロバイダーの定義[1]

JAX-WSの製品内部処理で利用するJAXBのバインディングプロバイダーの指定[1]

jdbc-connection-pool要素の説明の指定[1]

jdbc-resource要素の説明の指定[1]

JDBCコネクションプールに関する設定の定義[1]

JDBCリソースの定義[1]

JITコンパイラー稼働継続機能の有効または無効の設定[1]

JITコンパイル時に確保するCヒープのメモリーサイズの上限値の指定[1]

JMSプロバイダーのポート番号の指定[1]

JMXコネクターがリッスンするポート番号の指定[1]

JNDI完全修飾名のejb-refへのマッピング[1]

JNDI完全修飾名のejb-ref名へのマッピング[1]

JNDI完全修飾名のresource-env-refへのマッピング[1], [2]

JNDI完全修飾名のresource-refへのマッピング[1], [2]

JNDI完全修飾名の指定[1]

JSPの設定情報の指定[1]

K

KeepAlive接続時のリクエスト待ち時間[1]

KeepAlive接続を有効にするかどうかの指定[1]

KeepAlive連続接続回数の上限[1]

M

mail-resource要素の説明の指定[1]

Message-driven Bean に継続的に関連づけられるサブスクリプションの指定[1]

Message-driven Bean が一度にJMSセッションに読み込む最大メッセージ数の指定[1]

Message-driven Beanに関連づけるConnectionFactoryの参照を取得するためのJNDI完全修飾名の指定[1]

Message-driven Beanに関連づけるConnectionFactoryの指定[1]

Message-driven Beanにメッセージを配信するリソースアダプターに渡すactivation-configの指定[1]

Message-driven Beanの実行時の設定[1]

Metaspace領域に起因するFullGCの基準値の指定[1]

Metaspace領域の最大値の指定[1]

methodパラメーターの完全修飾Java型名の指定[1], [2]

MIMEタイプのドキュメントに対する有効期限の指定[1]

N

New領域に対するTenured領域の割合の指定[1]

O

OutOfMemoryError発生時に強制終了する機能の有効または無効の設定[1]

OutOfMemoryError発生時に出力するスタックトレース1行の文字数のバイト数での指定[1]

OutOfMemoryError発生時に出力するスレッドダンプログファイルへのクラス別統計情報の出力[1]

OutOfMemoryError発生時に要求したメモリーのサイズの出力[1]

OutOfMemoryError発生時のスレッドダンプの出力[1]

OutOfMemoryError発生時の発生要因種別の出力[1]

OutOfMemoryError発生時の例外情報とスタックトレースのJavaVMログファイルへの出力[1]

P

PEM形式のCRLを格納するディレクトリーの指定[1]

PRFデーモン起動時にPRF識別子に指定した文字列の指定[1]

PRFデーモンを使用するときに必要なPRFSPOOL環境変数に設定するディレクトリー名の指定[1]

property要素の説明の指定[1], [2], [3], [4], [5], [6], [7], [8]

Q

QNAMEのローカルパートの指定[1], [2], [3], [4], [5], [6], [7], [8]

QNAME のローカルパートの指定[1], [2]

R

resource-env-ref要素に対する参照のマッピングの定義[1]

resource-env-refを定義するリソースJNDI完全修飾名の指定[1]

resource-ref要素内のres-ref-nameの指定[1], [2]

resource-ref要素に対する参照のマッピングの定義[1]

resource-refを定義するリソースJNDI完全修飾名の指定[1]

run-asロールが指定されたEnterprise Bean内のプリンシパル（ユーザー）名の指定[1]

S

SerialGCの実行[1]

server.policy ファイルのロケーションの指定[1]

Serverヘッダーのフォーマット[1]

SMTP HELOコマンドまたはEHLOコマンドで使用するローカルホストの名前の指定[1]

SSL以外によるアクセスの禁止[1]

SSLセッションの有効時間[1]

SSL接続で使用できるSSLプロトコルの指定（IMAPサーバ接続の場合）[1]

SSL接続で使用できるSSLプロトコルの指定（SMTPサーバ接続の場合）[1]

SSL通信で使用できる暗号種別の指定[1]

SSLで認証する場合のWebサーバの証明書のファイルの指定[1]

SSLで認証する場合のWebサーバの秘密鍵のファイルの指定[1]

SSLによるアクセス時だけにCookieを送信させるかどうかの指定[1]

SSLによるアクセスの禁止[1]

SSLハンドシェイク処理中にログに出力されるエラーの詳細情報を表示するかどうかの指定[1]

SSLを無効にする場合の指定[1]

SSLを有効にする場合の指定[1]

STATUSコマンドの応答をキャッシュするタイムアウト値の指定[1]

Survivor領域のFrom空間とTo空間に対するEden領域の割合の指定[1]

Survivor領域の年齢分布のJavaVMログファイルへの出力[1]

T

target-server要素以下に含まれる要素の説明の記述[1]

TRACEメソッドによるリクエストを拒否するかどうかの指定[1]

TypesConfigディレクティブで指定したファイルに未定義のコンテンツの拡張子とMIMEタイプの関連づけ[1]

U

URLのファイルシステムのパスへの置き換え[1]

URLリソースまたはリソースのJNDI完全修飾名の指定[1], [2], [3], [4], [5], [6], [7], [8], [9]

V

Viaヘッダーの使用の制御[1]

W

web.xmlに定義されたrun-asロールに使用されるサーブレットのプリンシパル名の指定[1]

web.xmlのservlet-nameに適合するサーブレット名の指定[1]

webservice-endpoint要素のプロパティーの設定[1]

Webアプリケーション（WAR）の設定をするためのJava EE RIのDD[1]

Webアプリケーション（WAR）の設定をするための拡張DD[1]

Webアプリケーションのバージョン情報の指定[1]

Webサーバが作成するエラーメッセージなどのコンテンツのフッターに署名するかどうかの指定[1]

Webサーバ内の圧縮データをWebブラウザーに表示させるときに必要な拡張子と圧縮形式の関連づけの指定[1]

Webサーバへアクセスできるクライアントの制限[1], [2]

Webサーバに動的に組み込むモジュール[1]

WebサーバのTCP送信バッファサイズ[1]

Webサーバのサーバ名およびポート番号[1]

Webサーバの送受信の待ち時間[1]

Webサーバの動作環境を設定するための定義ファイルおよび定義項目の概要[1]

Webサーバの動作環境を設定するファイル[1]

Webサービスエンドポイントでデバッグを有効にするかどうかの指定[1]

Webサービスエンドポイントの情報の指定[1], [2]

Webサービス参照内のポート情報の指定[1]

Webサービス参照内のポートの情報の指定[1], [2], [3]

Webサービス参照のランタイム設定の指定[1], [2], [3]

Webサービスの参照のための実行時設定[1]

Webサービスの操作のオペレーション名の指定[1], [2], [3], [4], [5]

Webサービスの名称とオプションのWSDLの配置先の指定[1]

Webサービスの名称と任意のパブリッシュする場所の指定[1]

Web内のWebサービスの名称を指定[1]

Webブラウザーからの/~ユーザー名/へのリクエストに対して公開するサーバ上の場所の指定[1]

Webブラウザーごとの環境変数の設定[1], [2]

Webモジュール内にあるポートコンポーネントの一意の名称の指定[1]

WebモジュールへのJava EE Server固有の設定の定義[1]

WebアプリケーションのWebコンテキストルート[1], [2]

Windowsログオフ時のJavaVMの実行の継続[1]

work-security-map要素の説明の指定[1]

WSDL ポートの指定[1], [2], [3]

WSDLポートの指定[1]

あ

アーカイブファイルの名称の指定[1]

アクセス制御ファイルのファイル名の定義[1]

アクセス制御を定義するアクセス制御ファイル[1]

アクセス制限の定義[1]

アクティブなメッセージコンシューマーの最大数の指定[1]

アクティベーションコンフィグレーションプロパティーの指定[1]

圧縮オブジェクトポインター機能の有効または無効の設定[1]

アプリケーションクライアントコンテナーの設定をするためのJava EE RIのDD[1]

アプリケーションクライアントコンテナーへのJava EE Server固有の設定の定義[1]

アプリケーションクライアントの設定をするためのJava EE RIのDD[1]

アプリケーションクライアントの設定をするための拡張DD[1]

アプリケーションクライアントへのJava EE Server固有の設定の定義[1]

アプリケーションスコープのリソースの定義[1]

アプリケーションにJava EE Server固有の設定の定義[1]

アプリケーションの Web tierの設定[1]

アプリケーションのWeb URI[1]

アプリケーションのリクエスト処理の認証ポリシー要件の定義[1], [2], [3], [4]

アプリケーションのレスポンス処理の認証ポリシー要件の定義[1], [2], [3], [4]

アプリケーションまたはモジュールのバージョン情報[1], [2]

ある特定のハンドラーに関連づける場合の指定[1]

い

イメージマップファイルのbase行のデフォルトの指定[1]

イメージマップファイルのdefault行のデフォルトの指定[1]

インバウンドのリソースアダプターの管理対象オブジェクトの定義[1]

え

エラーが発生したときにWebブラウザーへ表示するメッセージに対応した文字セット[1]

エラーが発生したときにWebブラウザーへ表示するメッセージのカスタマイズ[1]

エラーログに出力するエラーのレベル[1]

エラーログに出力するクライアントアドレスをX-Forwarded-Forヘッダー値に変更[1]

エラーログの出力[1]

か

外部のJNDIリポジトリーに存在するリソースの定義[1]

拡張verbosegc情報のCSV形式での出力[1]

拡張verbosegc情報へのGC開始日時の出力[1]

拡張verbosegc情報へのユーザーCPU時間とカーネルCPU時間の出力[1]

拡張verbosegc情報を秒単位で出力する時間の間隔の指定[1]

拡張スレッドダンプ情報の出力[1]

拡張スレッドダンプのスレッド情報へのスレッドが処理をブロックした回数と待ち状態になった回数の出力[1]

拡張スレッドダンプのスレッド情報へのハッシュコードの出力[1]

拡張スレッドダンプのスレッド情報へのユーザーCPU時間とカーネルCPU時間の出力[1]

拡張スレッドダンプの標準出力への出力[1]

カスタム認証プロバイダーのバインディングの指定[1], [2], [3], [4]

カスタム認証プロバイダーのバインディングの定義[1]

カスタムバルブの指定[1]

カスタムリソースの定義[1]

環境変数SSL_CLIENT_CERT_CHAIN_nにクライアントの証明書を発行したCAからルートCAまでの証明書を設定するときの指定[1]

環境変数SSL_CLIENT_CERTにクライアント証明書を設定するときの指定[1]

関連づけられているエンティティーのjndi-nameの指定[1], [2], [3]

き

キュー送信先の自動作成の有効または無効の指定[1]

許容されるログインのリトライ回数の決定[1]

く

クライアントが使用言語の優先度を示さなかった場合の優先順位の指定[1]

クライアントから受信したHostヘッダーの値をそのままバックエンドサーバに転送するかどうかの指定[1]

クライアントからの接続要求の最大の待ち行列数[1]

クライアントからのリクエストについての最大待ちリクエスト数[1]

クライアントからのリクエストを基に環境変数の定義[1], [2]

クライアントからのリクエストをリダイレクトする場合の指定[1]

クライアント側でのJAX-WSのリクエストおよびレスポンスを標準出力する機能の設定[1]

クライアント証明書を利用したBasic認証[1]

クライアントとサーバ間の通信の指定[1], [2]

クライアント認証時の証明書に関する設定[1]

クライアント認証を伴うセキュアIIOP接続で使われるポート番号の指定[1]

クライアントの認証に使用される認証の方法の指定[1]

クライアントまたはサーバのIPv6アドレスによる環境変数の設定[1]

クラスターインスタンスの作成時のExternal IPアドレスとグループ管理サービスIPアドレスの設定[1]

クラスターがグループ管理サービスからのメッセージをリッスンするポート番号の定義[1]

クラスライブラリーのスタックトレースの1行の文字数のバイト数での指定[1]

クラスライブラリーのスタックトレースの出力[1]

クラスローダーの設定情報の指定[1]

け

計画停止時に強制停止させたリクエスト情報をエラーログファイルに出力するかどうかの指定[1]

計画停止時に実行中のリクエストを強制的に終了させるまでの待ち時間[1]

現在アクティブなレルムのユーザーまたはグループへのロールのマップ[1]

現在のレルム内のグループ名[1]

現在のレルム内のプリンシパル（ユーザー）名[1]

現在のレルムにグループ名を指定[1]

現在のレルムのグループ名の指定[1]

現在のレルムのプリンシパル（ユーザー）名の指定[1], [2], [3]

こ

コードキャッシュ領域の最大サイズの指定[1]

コードキャッシュ領域の使用率のしきい値の指定[1]

コードキャッシュ領域の使用量の出力としきい値に達したことを知らせるメッセージのJavaVMログファイルへの出力の指定[1]

コネクターコネクションプールの定義[1]

コネクターリソースの定義[1]

コンテンツのファイル拡張子とコンテントタイプの関連づけを定義するファイル[1]

コンテンツへのアクセスがユーザー認証とホスト名またはIPアドレスの両方によって制限されている場合のアクセス条件[1]

コンテンツを格納するドキュメントルートディレクトリーの指定[1]

コンテントネゴシエーションをするリクエストでクライアント側のキャッシュを有効にするかどうかの指定[1]

コンテントネゴシエーションの対象となる拡張子の種類[1]

さ

サーバインスタンスでのプリンシパルの定義[1]

サーバインスタンスでのユーザー名の指定[1]

サーバが受信する1つのHTTPヘッダーのサイズの上限[1]

サーバが受信するHTTPヘッダー数の上限[1]

サーバが受信するオブジェクトボディーのサイズの上限[1]

サーバが受信するリクエストラインの長さの上限[1]

サーバ側での8BITMIME拡張サポートの指定[1]

サーバ側でのJAX-WSのリクエストおよびレスポンスを標準出力する機能の設定[1]

サーバ管理者のE-Mailアドレス[1]

サーバとして起動するスレッド数[1]

サーバの正式な名前の生成方法の指定[1]

サーバのルートディレクトリーの指定[1]

サーバプロセスが異常終了した場合に共有メモリーに採取されたトレースを出力するファイル名の指定[1]

サーバ名に基づくバーチャルホストでHostヘッダーの代わりにパス名を利用して各ホストに接続する場合の指定[1]

サーバ名に基づくバーチャルホストで使用するホスト名の別名[1]

サービス実装クラスの名称の指定[1]

サーブレットまたはEJBの認証中に受信したプリンシパルのEISでのプリンシパルへのマッピング[1]

最後にコミットされたトランザクションの最大数の指定[1]

最終的な WSDL ドキュメントを示す有効な URL の指定[1]

最終的なWSDLドキュメントを示す有効なURLの指定[1], [2]

サインオンするために使用されるデフォルトのユーザー名の指定[1]

サインオンするために使用されるデフォルトのユーザ名に対応したパスワードの指定[1]

参照されているWSDL service要素の指定[1], [2], [3]

参照するWSDLサービス要素の指定[1], [2]

参照に対して関連づける、物理的なメッセージ送信先のJNDI名の指定[1]

し

時間によるログの分割[1]

実行中のプログラムのプロファイルを生成してプロファイリングデータの標準出力への出力[1]

指定した暗号種別以外でのアクセスを拒否してステータスコード403 Forbiddenを応答する場合の指定[1]

指定した暗号種別でのアクセスを拒否してステータスコード403 Forbiddenを応答する場合の指定[1]

自動生成されたエンドポイントのアドレスの指定[1], [2]

自動生成されたサーブレット実装クラスの名称の指定[1]

受信したすべてのリクエストを拒否するときのサーバスレッド数[1]

出力ファイル数の指定[1]

使用するSSLプロトコルのバージョンの指定[1]

証明書のチェーンを何段階までたどるかの指定[1]

す

スタックトレース中のメソッドのローカル変数情報の出力[1]

ステータス情報表示時に各リクエストの拡張ステータス情報を表示するかどうかの指定[1]

スレッド数の上限値の指定[1]

スレッドダンプ出力時のスタックトレースへの各メソッドのローカル変数情報の追加出力[1]

スレッドダンプファイルの出力先ディレクトリーの指定[1]

せ

正規表現で記述した条件を満たすURLへのリクエストに対するディレクティブの定義[1]

正規表現で記述した条件を満たすクライアントからのリクエストをリダイレクトする場合の指定[1]

正規表現で記述した条件を満たすディレクトリーに対するディレクティブの定義[1]

正規表現で記述した条件を満たすファイルに対するディレクティブの定義[1]

正規表現を使用してURLのファイルシステムのパスへの置き換え[1]

制御プロセスIDを格納するファイル[1]

整合性が保護されたメッセージをターゲットがサポートするかどうかの指定[1]

生成されたサービス実装クラスの名称の指定[1], [2], [3]

生成されたサーブレット実装クラスの自動生成された名称の指定[1]

セキュアIIOP接続で使われるポートのポート番号の指定[1]

セキュリティーマネージャーを有効にする環境で、JPA利用するための設定[1]

セッションCookieのプロパティーの指定[1]

セッションキャッシュサイズの上限値[1]

セッションの設定[1], [2]

セッションのプロパティーの指定[1]

セッションマネージャーのプロパティーの指定[1]

接続先のPRFデーモンのPRF識別子[1]

設定ファイルとして使用するファイルの指定[1]

そ

送信先ファイルプールが保持するファイルの最大数の指定[1]

ソケットの書き込みタイムアウト値の指定（IMAPサーバ接続の場合）[1]

ソケットの書き込みタイムアウト値の指定（SMTPサーバ接続の場合）[1]

ソケットのコネクションタイムアウト値の指定（IMAPサーバ接続の場合）[1]

ソケットのコネクションタイムアウト値の指定（SMTPサーバ接続の場合）[1]

ソケットの読み込みタイムアウト値の指定（IMAPサーバ接続の場合）[1]

ソケットの読み込みタイムアウト値の指定（SMTPサーバ接続の場合）[1]

た

ターゲットがクライアントに対して認証できるかどうかの指定[1]

ターゲットがクライアントを認証できるかどうかの指定[1]

対応するJava EE RIのDDで定義された物理的なメッセージ送信先の名称の指定[1]

対応するJava EE RIのDDファイルresource-env-ref要素内のres-ref-nameの指定[1]

対応するJava EE RIのDDファイルで定義された物理的なメッセージ送信先の名称の指定[1]

対応するJava EE RIのDDファイルで定義されたメッセージの物理的な送信先の名称の指定[1]

対応するJava EE RIのDDファイルで定義されたメッセージの論理的な送信先の名称の指定[1]

対応するJava EE RIのDDファイルで定義された論理的なメッセージ送信先の名称の指定[1], [2]

対応するJava EE RIのDDファイルのejb-ref-nameの指定[1], [2], [3]

対応するJava EE RIのDDファイルのejb-refへのJNDI完全修飾名の割り当て[1]

対応するJava EE RIのDDファイルのres-ref-nameの値の指定[1]

対応するJava EE RIのDDファイルのres-ref-nameの指定[1]

対応するJava EE RIのDDファイルのrole-name[1]

対応するJava EE RIのDDファイルのrole-nameの指定[1]

対応するJava EE XMLファイル内のロールのユーザーまたはグループへのマッピング[1]

対応するJava EE XMLファイルのresource-refへのJNDI完全修飾名の割り当て[1]

対応するJava EE XMLファイルのresource-env-refへのJNDI完全修飾名の割り当て[1]

対象のサーバインスタンスとのIIOP/SSL通信のセキュリティーの設定の指定[1]

対象のサーバインスタンスのIIOPリスナーとロードバランスで使用される IIOPエンドポイントの指定[1]

単一メッセージの最大サイズのバイト単位の指定[1]

て

定期的に発生するGCの最大間隔の指定[1], [2]

定義リファレンスで使用している記号[1]

定義リファレンスで使用している構文要素[1]

定義リファレンスの記述形式[1]

ディレクトリーインデックスで特定のアイコンが設定されていない場合に表示するアイコン[1]

ディレクトリーインデックスの整形表示機能のオプション[1]

ディレクトリーインデックスの整形表示時にファイルに対して表示する説明[1]

ディレクトリーインデックスの整形表示時のアイコンをMIMEエンコーディングと対応づけて表示[1]

ディレクトリーインデックスの整形表示時のアイコンをMIMEタイプと対応づけて表示[1]

ディレクトリーインデックスの整形表示時のアイコンを拡張子と対応づけて表示[1]

ディレクトリーインデックス表示時にMIMEエンコーディングに関連づけてアイコンの代わりに表示する文字列[1]

ディレクトリーインデックス表示時にMIMEタイプに関連づけてアイコンの代わりに表示する文字列[1]

ディレクトリーインデックス表示時にWebブラウザーに表示させないファイル名の指定[1]

ディレクトリーインデックス表示時に拡張子に関連づけてアイコンの代わりに表示する文字列[1]

ディレクトリーインデックス表示時のReadmeとして付けるコメントを記述したファイルの指定[1]

ディレクトリーインデックス表示時のヘッダーに付けるコメントを記述したファイルの指定[1]

ディレクトリーインデックス表示でのデフォルトのファイルの並び順[1]

データベースに保存されたトランザクションサービスログのサーバ名を取得する際に使用するSQLの定義[1]

データベースに保存されたトランザクションサービスログを削除する際に使用するSQLの定義[1]

データベースに保存されたトランザクションサービスログを取得する際に使用するSQLの定義[1]

デッドメッセージキューへのデッドメッセージの送信の有効または無効の指定[1]

デバッグ用のサーブレットをWebサービスエンドポイントに対して有効にするかどうかの指定[1]

デフォルトで利用するプリンシパル（ユーザー）の指定[1]

デフォルトとしてクライアントに送信するコンテンツのファイル[1]

デフォルトのプリンシパル（ユーザー）の指定[1]

デフォルトのプリンシパル名の指定[1]

デフォルトのホスト名またはIPアドレスの指定[1]

デフォルトのリソースプリンシパル（ユーザー）の指定[1], [2]

デフォルトのリソースプリンシパルのパスワードの指定[1], [2], [3], [4]

デフォルトのリソースプリンシパル名の指定[1]

デプロイメント中にWebサービスのWSDLをパブリッシュするディレクトリーのURLの指定[1]

デプロイメント時にWebサービスのWSDLがパブリッシュされるディレクトリーのURLの指定[1]

と

ドキュメントで使用する言語[1]

ドキュメントで使用するデフォルトの言語[1]

特定のHTTPプロトコルメソッドに対するディレクティブの定義[1]

特定のMIMEタイプまたはハンドラーで指定したコンテンツに対するCGIスクリプトの実行[1]

特定のURLに対するディレクティブの定義[1]

特定のディレクトリーに対するディレクティブの定義[1]

特定のディレクトリー下のすべてのコンテンツに対して使用するMIMEタイプ[1]

特定のファイルに対するディレクティブの定義[1]

特定のホスト名またはIPアドレスに対するディレクティブの定義[1]

特定のメソッドに対するCGIスクリプトの実行[1]

トピックコンシューマーに送信できる最大のメッセージ数の指定[1]

トピック送信先の自動作成の有効または無効の指定[1]

ドメイン管理サーバがインスタンスを管理するためにインスタンスへ接続するHTTPポートまたは HTTPSポートのポート番号の指定[1]

ドメイン管理サーバのホスト名またはIPアドレスの指定[1]

トランザクション完了時に使用されるコミットオプションの指定[1]

トランザクションサービスログを保存する際に使用するSQLの定義[1]

トランザクションタイムアウト時間の指定[1]

トランザクションのステータスファイルの同期を無効に設定[1]

トランザクションを利用しないコネクションを使用したデータベースへのトランザクションサービスログの登録[1]

トランスポートのセキュリティー情報の指定[1]

トレース採取のための共有メモリーIDを格納するファイル名の指定[1]

な

名前空間URIの指定[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

に

任意のフォーマットのアクセスログ出力[1]

認証するグループのリストを格納しているファイル名の指定[1]

認証するユーザー名とパスワードのリストを格納しているファイル名の指定[1]

認証プロバイダーのリクエスト処理の認証ポリシー要件の定義[1]

認証プロバイダーのレスポンス処理の認証ポリシー要件の定義[1]

認証方式の指定[1], [2], [3]

認証リクエスト処理の認証ポリシー要件の定義[1]

認証リクエストに対するクライアントからの応答を待機する時間の秒単位の指定[1]

認証レスポンス処理の認証ポリシー要件の定義[1]

認証レルムの指定[1]

ね

ネイティブエージェントライブラリーのロード[1]

の

ノードがドメイン管理サーバに接続するための接続情報を含むファイル[1]

は

パスワード保護されているサーバ秘密鍵のパスワードを格納するファイルの指定[1]

バックアップメッセージコンシューマーの最大数の指定[1]

バックエンドサーバから受信したLocationヘッダーのURLの変更[1]

バックエンドサーバからのレスポンスがエラーのステータスコードであった場合にレスポンスを上書きするかどうかの指定[1]

バックエンドサーバとの送受信に関する待ち時間の指定[1]

バックエンドサーバに転送するリクエストと転送するアドレス[1]

パブリックアドレスのポートの指定[1]

パブリックアドレスのホストの設定[1]

ハンドラーで処理するファイル拡張子の定義[1]

ハンドラーのデフォルトレベルの指定[1]

ひ

標準DDで指定されたmessage-destination-ref-nameの指定[1]

標準DDで指定したmessage-destination-nameの指定[1]

標準DDで指定したロール名の指定[1]

標準DDで指定したロールを環境固有のユーザーまたはグループにマッピングするための要素[1]

標準DDで定義したresource-env-refのres-ref-nameの指定[1]

標準DDで定義したresource-refのres-ref-nameの指定[1]

ふ

ファイナライズ滞留解消機能の有効または無効の設定[1]

ファイル拡張子とコンテントタイプの関係を定義する設定ファイルの指定[1]

ファイル拡張子に対する文字セットの指定[1]

ファイル拡張子に対する文字セットのデフォルト値の指定[1]

ファイルサイズによるログの分割[1]

ファイルプール内のファイルの消去の有効または無効の指定[1]

ファイルプールにクリーン（空） の状態で保持するファイルの割合の指定[1]

物理的なメッセージ送信先の参照の定義[1]

物理的なメッセージ送信先の名称の指定[1]

部分フェッチサイズの指定[1]

プライバシーが保護されたメッセージをターゲットがサポートするかどうかの指定[1]

プリンシパルが属するグループの指定[1]

ブローカーが保持するメッセージの最大合計サイズの指定[1]

ブローカーが保持するメッセージの最大数の指定[1]

ブローカーの起動時に活性化する接続サービスのリストの指定[1]

ブローカーの構成に関するプロパティーの設定[1]

プロパティーの名称と値の指定[1], [2], [3], [4], [5], [6], [7], [8], [9]

プロパティーを説明する任意のテキストの指定[1], [2], [3], [4], [5], [6], [7], [8]

へ

べき等なリクエストのURLパターンの指定[1]

ほ

ポートコンポーネントに自動生成される実装クラスの名称の指定[1]

ポートコンポーネント用のtie実装クラスの自動生成された名称の指定[1]

ホスト名のルックアップの逆引きをするかどうかの指定[1]

ボディー部分のフェッチ時にメッセージへのSEENフラグ設定の防止[1]

み

未配信メッセージの最大数の指定[1]

未配信メッセージの最大の総メモリー量のバイト単位の指定[1]

め

明示管理ヒープ機能適用除外クラス指定機能の有効または無効の設定[1]

明示管理ヒープ機能適用除外設定ファイルに指定したクラスのうち適用除外設定を無効にしたいクラスを指定する設定ファイル（明示管理ヒープ機能適用除外無効設定ファイル）[1]

明示管理ヒープ機能適用除外設定ファイルのファイルパスの指定[1]

明示管理ヒープ機能適用除外無効設定ファイルのファイルパスの指定[1]

明示管理ヒープ機能のイベントログのレベルの指定[1]

明示管理ヒープ機能の自動解放機能の有効または無効の設定[1]

明示管理ヒープ機能の自動解放処理で設定している解放率の上限値の指定[1]

明示管理ヒープ機能の有効または無効の設定[1]

明示管理ヒープ機能のログファイルの1ファイル当たりの最大ファイルサイズのバイト単位での指定[1]

明示管理ヒープ機能のログファイルのプリフィクスおよびログファイルの出力先ディレクトリーの指定[1]

明示管理ヒープ機能のログファイルを作成する最大ファイル数の指定[1]

名称と値を持つプロパティーの指定[1], [2], [3], [4], [5], [6], [7], [8], [9], [10]

メソッドの最後に実行した行の行番号のトレース情報への出力[1]

メソッドのパラメーターの完全修飾Java型名の指定[1], [2], [3]

メソッドの引数の完全修飾名の指定[1]

メソッド名の指定[1], [2], [3], [4]

メッセージセキュリティープロバイダーのための設定[1], [2]

メッセージセキュリティー要件が適用されるメソッドまたは操作の指定[1], [2], [3], [4], [5]

メッセージセキュリティー要件の指定[1], [2], [3], [4]

メッセージセキュリティー要件を適用するメソッドまたは操作の指定[1], [2]

メッセージ退避ファイルに追加するメッセージの最大サイズの指定[1]

メッセージのセキュリティー要件の指定[1]

メッセージのセキュリティー要件を適用するメソッドまたは操作の指定[1], [2]

メッセージの物理的な送信先の名称の指定[1], [2]

メッセージの論理的な送信先の名称の指定[1], [2]

メッセージをデッドメッセージキューに保存する前のメッセージボディーの消去の有効または無効の指定[1]

メニュー表示に対する文字セット[1]

メニュー表示についての指定[1]

メメソッド引数の指定[1]

メモリー制限のしきい値に達した場合のブローカー動作の指定[1]

メモリー内の状態を物理的なストレージデバイスとの同期の有効または無効の指定[1]

も

モジュールトレースの出力の抑止[1]

モジュールの存在有無に対するディレクティブの定義[1]

ゆ

有効期限機能に関連するレスポンスヘッダーを追加するかどうかの指定[1]

有効期限のデフォルトの指定[1]

有効なアドレスへのメール送信の指定[1]

ユーザー拡張性能解析トレース設定ファイルで指定したクラスファイルの書き換えの成功ログの出力[1]

ユーザー拡張性能解析トレース設定ファイルの記述形式の指定[1]

ユーザー拡張性能解析トレース設定ファイルのファイルパスの指定[1]

ユーザー拡張性能解析トレースで使用するユーザー拡張性能解析トレース設定ファイル[1]

ユーザー拡張性能解析トレースの対象となるメソッド数の上限値の指定[1]

ユーザー拡張性能解析トレースのトレース出力レベルの指定[1]

ユーザー拡張性能解析トレースの有効または無効の設定[1]

ユーザーが認証される、レルムの指定[1]

ユーザーに利用させる機能の制限[1]

ユーザー認証する場合のrealm名[1]

ユーザー認証する場合の制御方法[1]

ユーザー認証する場合の認証制御のタイプ[1]

ユーザーの名称を指定[1]

ら

ラベル名を指定しないLogFormatディレクティブのフォーマットでのアクセスログ出力[1]

り

リーパースレッドのリープまたはクリーンアップする周期の秒単位の指定[1]

リクエスト受信開始からリクエストヘッダー受信完了までのタイムアウト時間の指定[1]

リクエストのボディー部のログを採取する場合の最大値[1]

リクエストヘッダーのカスタマイズ[1]

リクエストボディーの受信開始から完了までのタイムアウト時間の指定[1]

リクエストログに出力するトレース種別[1]

リクエストログの出力[1]

リクエストを受け付けるIPアドレスおよびポート番号[1]

リソースアダプターアーカイブ構成情報の定義[1]

リソースアダプターモジュールIDの指定[1]

リソースのJNDI完全修飾名の指定[1], [2], [3]

リソースの設定をするためのJava EE RIのDD[1]

リソースの設定をするための拡張DD[1]

リソースマネージャー接続ファクトリー参照の名称の指定[1]

リソースマネージャーへのサインオンに使用するデフォルトのリソースプリンシパル名の指定[1], [2]

リソースマネージャーへのデフォルトのサインオン（名称とパスワード）の指定[1]

リバースプロキシー使用時にバックエンドサーバから受信したSet-Cookieヘッダーの変換[1]

リバースプロキシーをロードバランサー構成で使用する場合の転送先のURLの指定[1]

流量制限機能に使用するCookieが有効とされるドメイン[1]

流量制限機能に使用するCookieの有効時間[1]

流量制限機能に使用するCookie名[1]

流量制限機能によって拒否したリクエストのリダイレクト[1]

流量制限機能によって処理が拒否された場合にレスポンスとして返すコンテンツ[1]

る

ルート要素(hitachi-application.xml)[1]

ルート要素(hitachi-application-client.xml)[1]

ルート要素(hitachi-ejb-jar.xml)[1]

ルート要素(hitachi-ra.xml)[1]

ルート要素(hitachi-web.xml)[1]

れ

例外またはエラーのクラス名が文字数制限32文字を超えた場合の名前の編集方法の指定[1]

例外またはエラーのクラス名のトレース情報への出力[1]

レルムの指定[1]

ろ

ローカル変数オブジェクトに対して取得したStringオブジェクトの文字列の出力[1]

ローカル変数情報の出力フォーマットの1変数1行で出力する簡易出力フォーマットへの変更[1]

ローカル変数情報への実際のオブジェクト型名の出力[1]

ロードバランサー構成での振り分け先の定義[1]

ログインモジュールの使用順序と使用条件の指定[1]

ログに出力する時間をミリ秒まで表示するかどうかの指定[1]

ログのフォーマットにラベル名を定義[1]

ログファイル作成時に入出力エラーが発生した場合のログ情報の出力方法の指定[1]

ログファイルの非同期出力機能の有効または無効の設定[1]

論理的なメッセージ送信先のJNDI名の指定[1]

論理的なメッセージの送信先の名称を指定[1]

論理メッセージ送信先の名称の指定[1]

わ

ワークセキュリティーマップの定義[1]

マニュアル発行元

株式会社 日立製作所

〒100-8280　東京都千代田区丸の内一丁目6番6号