uCosminexus Application Server

Definition Reference Guide

3020-3-Y16-20(E)

Contents

Notices

Summary of amendments

Preface

1. Files Overview

1.1 File types

1.2 Format for describing the files

1.3 Precautions during file editing

2. Files Used in J2EE Servers

2.1 List of files used in J2EE servers

2.2 hitachi_web.properties (Web application property file for J2EE servers)

2.3 usrconf.cfg (Option definition file for J2EE servers)

2.4 usrconf.properties (User property file for J2EE servers)

2.5 server.policy (Security policy file for J2EE servers)

2.6 criticalList.cfg (Protected areas list file)

3. Files Used in Batch Servers

3.1 List of files used in batch servers

3.2 usrconf.cfg (Option definition file for batch servers)

3.3 usrconf.properties (User property file for batch servers)

3.4 server.policy (Security policy file for batch servers)

3.5 criticalList.cfg (Protected areas list file)

3.6 usrconf.cfg (Option definition file for batch applications)

3.7 usrconf.properties (User property file for batch applications)

4. Files Used by the Smart Composer Functionality

4.1 List of files used by the Smart Composer functionality

4.2 cmxserver.properties (server setting properties file)

4.3 .cmxrc (client setting properties file)

4.4 cmxclient.properties (common client setting properties file)

4.5 lb.properties (load balancer definition properties file)

4.6 Easy Setup definition file

4.6.1 Overview

4.6.2 Contents specified in the Easy Setup definition file

4.6.3 Defining a Web system

4.6.4 Defining a load balancer

4.6.5 Defining cookie switching

4.6.6 Defining a virtual server

4.6.7 Defining a physical tier

4.6.8 Defining a service unit

4.6.9 Defining a logical server

4.6.10 Defining a logical server configuration

4.6.11 Defining a host

4.7 Configuration change definition files

4.8 Logical server reference definition file

4.9 Host definition file for scale out

4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files

4.10.1 Tags that can be specified in the system for executing J2EE applications

4.10.2 Tags that can be specified in the system for executing batch applications

4.11 System configuration patterns and defined logical servers

4.11.1 Building a system for executing J2EE applications

4.11.2 Building a system for executing batch applications

4.12 Parameters applicable to all logical servers

4.12.1 Parameters common to all logical servers

4.13 Parameters applicable to logical Web servers

4.13.1 Parameters used for setting up the definitions for the Web server

4.13.2 Parameters that set up the redirector action definition for Cosminexus HTTP Server

4.13.3 Parameters used for setting up the worker definition

4.13.4 Parameters for setting the log output method of Cosminexus HTTP Server

4.14 Parameters applicable to logical J2EE servers

4.14.1 Parameters used for setting up the user properties for the J2EE server

4.14.2 Parameters used for setting up the option definitions for the J2EE server

4.14.3 Parameters applicable to the JavaVM system properties for the J2EE server

4.14.4 Extension parameters of J2EE server

4.14.5 Parameters used for setting up the user properties for the batch server

4.14.6 Parameters used for setting up the option definitions for the batch server

4.14.7 Parameters applicable to the JavaVM system properties for the batch server

4.14.8 Extension parameters of the batch server

4.14.9 Parameters used for setting up the Management Agent properties

4.14.10 Parameters used for setting up the properties for issuing Management events

4.14.11 Parameters used for setting up JP1 integration

4.14.12 Parameters used for setting up the usage of SecurityManager

4.14.13 Parameters that set up the usage for integrated user management

4.14.14 Parameters that set up the files to be used in the JavaVM startup parameters

4.15 Parameters applicable to logical performance tracers

4.16 Parameters applicable to logical SFO servers

4.16.1 Parameters used for setting up the user properties for the SFO server

4.16.2 Parameters used for setting up the option definitions for the SFO server

4.16.3 Parameters applicable to the JavaVM system properties for the SFO server

4.16.4 Extension parameters of SFO server

4.16.5 Parameters used for setting up the Management Agent properties

4.16.6 Parameters used for setting up the properties for issuing Management events

4.16.7 Parameters used for setting up JP1 integration

4.17 Parameters applicable to the logical CTM domain manager

4.18 Parameters applicable to the logical CTM

4.19 Parameters applicable to the logical Smart Agent

4.20 Parameters applicable to the logical user server

4.21 Parameters applicable to the Logical Naming Service

5. Files Used in Server Management Commands

5.1 List of files used in server management commands

5.2 usrconf (Option definition file for server management commands for UNIX)

5.3 usrconf.bat (Option definition file for server management commands for Windows)

5.4 usrconf.properties (System property file for server management commands)

6. Files Used with JPA

6.1 List of files used in Cosminexus JPA Provider

6.2 persistence.xml

6.2.1 Details of persistence.xml

6.2.2 Cosminexus JPA Provider-specific properties that can be specified in the <property> tag

6.3 O/R mapping files

6.3.1 Elements below entity-mappings

6.3.2 Elements below persistence-unit-metadata

6.3.3 Elements below table-generator

6.3.4 Elements below named-query

6.3.5 Elements below named-native-query

6.3.6 Elements below sql-result-set-mapping

6.3.7 Elements below mapped-superclass

6.3.8 Elements below entity

6.3.9 Elements under embeddable

6.3.10 Other elements

6.4 Query hint

7. Files Used in Cosminexus JMS Provider

7.1 List of files used in Cosminexus JMS Provider

7.2 admin.properties (Management command properties file)

7.3 commonconfig.properties (CJMSP broker common properties file)

7.4 config.properties ( CJMSP broker individual properties file)

8. Files Used with CTM

8.1 List of files used in CTM

8.2 CTM user environment variable definition file

8.3 CTM command option file

9. Files Used in Web Server Integration

9.1 List of files used in Web server integration

9.2 isapi_redirect.conf (Redirector action definition file for Microsoft IIS)

9.3 mod_jk.conf (Redirector action definition file for Cosminexus HTTP Server)

9.4 uriworkermap.properties (Mapping definition file for Microsoft IIS)

9.5 workers.properties (Worker definition file)

10. Files Used with Cosminexus Manager

10.1 List of files used with Cosminexus Manager

10.2 adminagent.properties (Administration Agent property file)

10.3 AdminAgentrc (Setup file for automatic start of Administration Agent)

10.4 adminagentuser.cfg (Option definition file for Administration Agent )

10.5 adminagent.xml (Administration Agent settings file)

10.6 mngagent.actual-server-name.properties (Management Agent property file)

10.7 mserver.properties (Management Server environment settings file)

10.8 mserver.cfg (Management Server option definition file)

10.9 mserverenv.cfg (Management Server environment variable definition file)

10.10 manager.cfg (Manager settings file)

10.11 maction.properties (Property file for execution of Management actions)

10.12 Property file for issuing Management events

10.13 Message ID list file for issuing Management events

10.14 Definition files to be saved for the Management Server management files

10.15 .mngsvrutilrc (Client-side definition file of the mngsvrutil command)

10.16 mngsvrutil.properties (Server-side definition file of the mngsvrutil command)

10.17 mngsvrutilcl.properties (Client-side shared definition file of the mngsvrutil command)

10.18 .mngsvrmonitorrc (Settings file of the monitor startup command for JP1/IM integration)

10.19 System log message mapping file for JP1/IM integration

10.19.1 mserver.jp1event.system.mapping.properties (Message mapping file for Management Server)

10.19.2 manager.jp1event.system.mapping.properties (Message mapping file for J2EE server sharing)

10.19.3 manager.Logical-server-name.jp1event.system.mapping.properties (Message mapping file for individual J2EE servers)

10.19.4 Conversion to JP1 events

10.20 setup.cfg (Setup file for the Setup Wizard)

10.21 Logical user server definition file

11. Files Used in Virtual Systems (INTENTIONALLY DELETED)

11.1 (INTENTIONALLY DELETED)

12. Files Used in Log Operations

12.1 List of files used in log operations

12.2 Definition file for snapshot log collection

13. Files Used for Setting Audit Log (INTENTIONALLY DELETED)

13.1 (INTENTIONALLY DELETED)

14. Files Used in Java Applications

14.1 List of files used in the Java applications

14.2 usrconf.cfg (Option definition file for Java applications)

14.3 usrconf.properties (User property file for Java applications)

14.4 System properties specified in the Java application

14.5 Property setup file for the user log of Java applications

15. Files Used in Web Applications

15.1 List of files used in Web applications

15.2 Compilation exclusion list file

15.3 Execution result list file

16. Options for Invoking JavaVM

16.1 List of JavaVM extension options

16.2 Details of JavaVM extension options

-XX:+Hitachi (List display option)

-XX:[+|-]HitachiThreadDump (Option to output the extended thread dump information)

-XX:[+|-]HitachiThreadDumpToStdout (Option for preventing the standard output of extended thread dump)

-XX:[+|-]HitachiThreadDumpWithHashCode (Hash code output option of the extended thread dump)

-XX:[+|-]HitachiThreadDumpWithCpuTime (CPU usage time output option of the extended thread dump)

-XX:[+|-]HitachiThreadDumpWithBlockCount (Block count output option of the extended thread dump)

-XX:HitachiJavaLog (Option for specifying the prefix of log file name)

-XX:HitachiJavaLogFileSize (Option for specifying the maximum log file size)

-XX:[+|-]HitachiJavaLogNoMoreOutput (Option specified when the log file input/ output error occurs)

-XX:HitachiJavaLogNumberOfFile (Option for specifying the maximum number of log files)

-XX:[+|-]HitachiOutputMilliTime (Detailed time output option)

-XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output)

-XX:[+|-]HitachiCommaVerboseGC (Option for CSV output)

-XX:HitachiVerboseGCIntervalTime (Option for specifying the output interval of extended verbosegc information)

-XX:[+|-]HitachiVerboseGCPrintCause (Option to output the cause of garbage collection)

-XX:[+|-]HitachiVerboseGCPrintDate (Option to output the date of extended verbosegc information)

-XX:[+|-]HitachiVerboseGCCpuTime (Option to output the CPU usage time of the extended verbosegc information)

-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution (Age distribution output option of Survivor area)

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory (Option to output the C heap information)

-XX:[+|-]HitachiVerboseGCPrintThreadCount (Option to output the number of threads)

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit (Heap size output option used by java.io.File.deleteOnExit())

-XX:[+|-]PrintCodeCacheInfo (Option for the output of the code cache area information)

-XX:CodeCacheInfoPrintRatio (Option for specifying the usage rate of the code cache area)

-XX:[+|-]PrintCodeCacheFullMessage (Option for the output of the code cache area depletion message)

-XX:[+|-]HitachiOutOfMemoryCause (Option to output the causes of exception)

-XX:[+|-]HitachiOutOfMemoryStackTrace (Option for stack trace output)

-XX:HitachiOutOfMemoryStackTraceLineSize (Option for specifying the line size of stack trace)

-XX:[+|-]HitachiOutOfMemorySize (Option to output the memory size)

-XX:[+|-]HitachiOutOfMemoryAbort (Forced termination option)

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump (Option to output the thread dump)

-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf(Class-wise statistical information output option)

-XX:[+|-]HitachiOutOfMemoryHandling (OutOfMemory handling option)

-XX:HitachiOutOfMemoryHandlingMaxThrowCount (Option for setting up the maximum occurrence count)

-XX:[+|-]HitachiJavaClassLibTrace (Option to output the stack trace of class library)

-XX:HitachiJavaClassLibTraceLineSize (Option to specify the line size of stack trace for the class library)

-XX:[+|-]HitachiLocalsInThrowable (Option for collecting the local variable information when an exception occurs)

-XX:[+|-]HitachiLocalsInStackTrace (Option to output the local variable when the thread dump is output)

-XX:[+|-]HitachiLocalsSimpleFormat (Option for changing the output format of the local variable information)

-XX:[+|-]HitachiTrueTypeInLocals (Option to output the true type name of the local variable information)

-XX:HitachiCallToString (Option to output the local variable information)

-XX:[+|-]HitachiFullCore (Release system resource option)

-XX:[+|-]HitachiReserveSwapSpace (Reserve swap area option)

-XX:[+|-]HitachiUseExplicitMemory (Explicit Memory Management functionality option)

-XX:HitachiExplicitHeapMaxSize (Option for specifying the maximum size of the Explicit memory block)

-XX:HitachiExplicitMemoryLogLevel (Option for specifying the log output level of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLog (Option for specifying the log file output location of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLogFileSize (Option for specifying the maximum log file size of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLogNumberOfFile (Option for specifying the maximum number of log files of the Explicit Memory Management functionality)

-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst(Explicit release function option of Explicit Memory Management function)

-XX:[+|-]HitachiExplicitMemoryAutoReclaim (Automatic release function option of explicit memory management)

-XX:[+|-]HitachiExplicitMemoryCompatibleToV8 (Version compatibility setting option of Explicit Memory Management function)

-XX:[+|-]HitachiAutoExplicitMemory (Automatic allocation function option of Explicit Memory Management function)

-XX:HitachiAutoExplicitMemoryFile (Option for specifying the file path of the automatic allocation function of the Explicit Memory Management function)

-XX:ExplicitMemoryFullGCPolicy (Option for controlling the transfer of objects to the Explicit memory block of the Explicit Memory Management functionality)

-XX:[+|-]ExplicitMemoryUseExcludeClass (Option for the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality)

-XX:ExplicitMemoryExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality exclusion setup file)

-XX:ExplicitMemoryNotExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality non-exclusion setup file)

-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim (Memory usage reduction option for Explicit heap used in an HTTP session)

-XX:HitachiJITCompileMaxMemorySize (Option for specifying the maximum memory allocated for JIT compilation)

-XX:[+|-]JITCompilerContinuation (Option for the JIT compiler continuation functionality)

-XX:HitachiThreadLimit (Option for specifying the maximum number of threads)

16.3 Properties used in JavaVM

jvm.userprf.Enable

jvm.userprf.ExtendedSetting

jvm.userprf.File

jvm.userprf.Limit

jvm.userprf.Trace

jvm.userprf.LineNumber

jvm.userprf.ThrowableName

jvm.userprf.ThrowableNameEditMethod

jvm.userprf.LogLevel

16.4 Default values of the Java HotSpot VM options that can be specified in Cosminexus

16.5 Java HotSpot VM options that can be specified in Cosminexus

16.6 List of environment variables used in JavaVM

16.7 Details of environment variables used in JavaVM

JAVACOREDIR

Appendixes

A. Extended MIB object definition file

A.1 Tables in the extended MIB object definition file

B. DD (web.xml) for Web applications

B.1 Relationship between extension and MIME type

C. Parameters that can be specified in the logical server configuration (for compatibility)

C.1 Parameters that can be commonly specified for each logical server (for compatibility)

C.2 Parameters that can be specified in the logical Web server (For compatibility)

C.3 Parameters that can be specified in the logical J2EE server (For compatibility)

C.4 Parameters that can be specified in the logical SFO server (For compatibility)

Index

[Trademarks]

All Rights Reserved. Copyright (C) 2012, 2015, Hitachi, Ltd.

Notices

Relevant program products

See the uCosminexus Application Server HTTP Server User Guide.

Export restrictions

If you export this product, please check all restrictions (for example, Japan's Foreign Exchange and Foreign Trade Law, and USA export control laws and regulations), and carry out all required procedures.
If you require more information or clarification, please contact your Hitachi sales representative.

Trademarks

AIX is a trademark of International Business Machines Corporation in the United States, other countries, or both.
AMD is a trademark of Advanced Micro Devices, Inc.
F5, F5 Networks, BIG-IP, and iControl are trademarks or registered trademarks of F5 Networks, Inc. in the U.S. and certain other countries.
All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries.
CORBA is a registered trademark of Object Management Group, Inc. in the United States.
GIF is the name of a format developed by CompuServe Inc. in the United States and/or other countries.
gzip is the software distributed by FSF(Free Software Foundation) in the United States and/or other countries.
HP-UX is a product name of Hewlett-Packard Development Company, L.P. in the U.S. and other countries.
IIOP is a trademark of Object Management Group, Inc. in the United States.
Intel is a trademark of Intel Corporation in the U.S. and/or other countries.
Internet Explorer is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
OMG, CORBA, IIOP, UML, Unified Modeling Language, MDA, and Model Driven Architecture are either registered trademarks or trademarks of Object Management Group, Inc. in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle Corporation and/or its affiliates.
Red Hat is a trademark or a registered trademark of Red Hat Inc. in the United States and other countries.
SOAP is an XML-based protocol for sending messages and making remote procedure calls in a distributed environment.
All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc., in the United States and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.
UNIX is a registered trademark of The Open Group in the United States and other countries.
VisiBroker is a trademark or registered trademark of Micro Focus IP Development Limited or its subsidiaries or affiliated companies in the United Kingdom, United States, and other countries.
Win32 is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Eclipse is an open development platform for tools integration provided by Eclipse Foundation, Inc., an open source community for development tool providers.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
The other company names and product names are either trademarks or registered trademarks of the respective companies. Throughout this document Hitachi has attempted to distinguish trademarks from descriptive terms by writing the name with the capitalization used by the manufacturer, or by writing the name with initial capital letters. Hitachi cannot attest to the accuracy of this information. Use of a trademark in this document should not be regarded as affecting the validity of the trademark.

Microsoft product name abbreviations

This manual uses the following abbreviations for Microsoft product names:

Abbreviation | Full name or meaning
Active Directory | Microsoft(R) Active Directory(R)
Microsoft IIS | Microsoft IIS 7.0 | Microsoft(R) Internet Information Services 7.0
Microsoft IIS 7.5 | Microsoft(R) Internet Information Services 7.5
Windows | Windows Server 2008 | Windows Server 2008 x86 | Microsoft(R) Windows Server(R) 2008 Standard 32-bit
Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit
Windows Server 2008 x64 | Microsoft(R) Windows Server(R) 2008 Standard
Microsoft(R) Windows Server(R) 2008 Enterprise
Windows Server 2008 R2 | Microsoft(R) Windows Server(R) 2008 R2 Standard
Microsoft(R) Windows Server(R) 2008 R2 Enterprise
Microsoft(R) Windows Server(R) 2008 R2 Datacenter
Windows Server 2012 | Windows Server 2012 Standard | Microsoft(R) Windows Server(R) 2012 Standard
Windows Server 2012 Datacenter | Microsoft(R) Windows Server(R) 2012 Datacenter
Windows XP | Microsoft(R) Windows(R) XP Professional Operating System
Windows Vista | Windows Vista Business | Microsoft(R) Windows Vista(R) Business (32-bit)
Windows Vista Enterprise | Microsoft(R) Windows Vista(R) Enterprise (32-bit)
Windows Vista Ultimate | Microsoft(R) Windows Vista(R) Ultimate (32-bit)
Windows 7 | Windows 7 x86 | Microsoft(R) Windows(R) 7 Professional (32-bit)
Microsoft(R) Windows(R) 7 Enterprise (32-bit)
Microsoft(R) Windows(R) 7 Ultimate (32-bit)
Windows 7 x64 | Microsoft(R) Windows(R) 7 Professional (64-bit)
Microsoft(R) Windows(R) 7 Enterprise (64-bit)
Microsoft(R) Windows(R) 7 Ultimate (64-bit)
Windows 8 | Windows 8 x86 | Windows(R) 8 Pro (32-bit)
| Windows(R) 8 Enterprise (32-bit)
Windows 8 x64 | Windows(R) 8 Pro (64-bit)
| Windows(R) 8 Enterprise (64-bit)

Note that Windows 32 bit and Windows 64 bit are sometimes respectively referred to as Windows x86 and Windows x64.

Restrictions

Information in this document is subject to change without notice and does not represent a commitment on the part of Hitachi. The software described in this manual is furnished according to a license agreement with Hitachi. The license agreement contains all of the terms and conditions governing your use of the software and documentation, including all warranty rights, limitations of liability, and disclaimers of warranty.
Material contained in this document may describe Hitachi products not available or features not available in your country.
No part of this material may be reproduced in any form or by any means without permission in writing from the publisher.
Printed in Japan.

Issued

Aug. 2015: 3020-3-Y16-20(E)

Copyright

All Rights Reserved. Copyright (C) 2012, 2015, Hitachi, Ltd.

Summary of amendments

The following table lists changes in this manual (3020-3-Y16-20(E)) and product changes related to this manual.

Changes | Location
Add a description for the file to be used in the CTM. | 8

The following table lists changes in the manual 3020-3-Y16-10(E) for uCosminexus Application Server 09-50, uCosminexus Application Server(64) 09-50, uCosminexus Client 09-50, uCosminexus Developer 09-50, uCosminexus Service Architect 09-50, uCosminexus Service Platform 09-50, uCosminexus Service Platform(64) 09-50 and product changes related to that manual:

Changes

The following keys are added to usrconf.properties (user property file for J2EE servers):

ejbserver.deploy.annotations.load_libjars.enabled

vbroker.ce.iiop.ccm.htc.readerPerConnection

vbroker.ce.iiop.ccm.htc.threadStarter

vbroker.se.iiop_tp.proxyHost

vbroker.se.iiop_ts.proxyHost

webserver.eadssfo.application.cache.name

webserver.eadssfo.check_size.mode

webserver.eadssfo.client.retry.count

webserver.eadssfo.client.retry.interval

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.address

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.port

webserver.eadssfo.eads.client.node.list

webserver.eadssfo.eads.connection.buffersize

webserver.eadssfo.eads.connection.retry

webserver.eadssfo.eads.connection.timeout

webserver.eadssfo.eads.connectionPool.poolsize

webserver.eadssfo.eads.logger.commDump.enable

webserver.eadssfo.eads.logger.commTrace.enable

webserver.eadssfo.eads.logger.commTrace.filenum

webserver.eadssfo.eads.logger.commTrace.filesize

webserver.eadssfo.eads.logger.dir

webserver.eadssfo.eads.logger.message.console.enable

webserver.eadssfo.eads.logger.message.filenum

webserver.eadssfo.eads.logger.message.filesize

webserver.eadssfo.enabled

webserver.eadssfo.exclude.url_patterns

webserver.eadssfo.session.cache.name

webserver.eadssfo.session_read_only.url_patterns

webserver.session.cookie_config.http_only

webserver.session.cookie_config.name

webserver.session.tracking_mode

The description was changed for the following keys in usrconf.properties (user property file for J2EE servers):

webserver.container.server_id.name

webserver.container.server_id.value

webserver.session.server_id.value

BIG-IP v11 was added as an available load balancer.

The following parameters are added to the files used with the Smart Composer functionality (properties that can be specified for the logical J2EE server):

ejbserver.logger.rotationTime

ejbserver.logger.rotationStyle

ejbserver.logger.channels.define.DevelopmentLogFile.filenum

ejbserver.logger.channels.define.DevelopmentLogFile.filesize

ejbserver.logger.DevelopmentLogFile.level

ejbserver.deploy.annotations.load_libjars.enabled

https.protocols

https.cipherSuites

webserver.session.cookie_config.name

webserver.session.cookie_config.http_only

webserver.session.tracking_mode

webserver.eadssfo.enabled

webserver.eadssfo.check_size.mode

webserver.eadssfo.application.cache.name

webserver.eadssfo.session.cache.name

webserver.eadssfo.exclude.url_patterns

webserver.eadssfo.session_read_only.url_patterns

webserver.eadssfo.client.retry.count

webserver.eadssfo.client.retry.interval

webserver.eadssfo.eads.client.node.list

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.address

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.port

webserver.eadssfo.eads.logger.dir

webserver.eadssfo.eads.logger.message.filesize

webserver.eadssfo.eads.logger.message.filenum

webserver.eadssfo.eads.logger.message.console.enable

webserver.eadssfo.eads.logger.commDump.enable

webserver.eadssfo.eads.logger.commTrace.filesize

webserver.eadssfo.eads.logger.commTrace.filenum

webserver.eadssfo.eads.logger.commTrace.enable

webserver.eadssfo.eads.connection.buffersize

webserver.eadssfo.eads.connectionPool.poolsize

webserver.eadssfo.eads.connection.timeout

webserver.eadssfo.eads.connection.retry

The description was changed for the following parameters in the files used with the Smart Composer functionality (properties that can be specified for the logical J2EE server):

webserver.container.server_id.value

webserver.session.server_id.value

The following parameter is added to adminagent.properties (Administration Agent property file):

adminagent.prftrace_dir

The following key is added to tier.properties (tier-wise property file):

tier.startup.no

The description about collecting the data sent for definitions is added in the definition file for collecting the snapshot log.

The following variables are added to the available variables in the definition file for collecting the snapshot log:

&{ctm.RegOption}

&{ctm.TSCGwOption}

${adminagent.prftrace_dir}

The following options are added for the functionality to output the code cache area information:

-XX:[+|-]PrintCodeCacheInfo

-XX:CodeCacheInfoPrintRatio

-XX:[+|-]PrintCodeCacheFullMessage

The object control option (-XX:ExplicitMemoryFullGCPolicy) is added to the Explicit memory block of the Explicit Memory Management functionality.

An option (-XX:[+|-]JITCompilerContinuation) is added to the functionality for JIT compiler continuation.

The following options are added to the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality:

-XX:[+|-]ExplicitMemoryUseExcludeClass

-XX:ExplicitMemoryExcludeClassListFile

-XX:ExplicitMemoryNotExcludeClassListFile

The following methods are added to the -XX:[+|-]HitachiJavaClassLibTrace option:

java.lang.System.runFinalizersOnExit

java.lang.Runtime.runFinalizersOnExit

The code cache area information is added to the output format and examples for output of the -XX:[+|-]HitachiVerboseGC and -XX:[+|-]HitachiCommaVerboseGC options.

The following contents are added to the cause of garbage collection for the -XX:[+|-]HitachiVerboseGCPrintCause option:

EMJavaGC Command

EHeapProf Command

A description is added for the object release ratio of the Explicit memory block output to the extended thread dump.

jvm.userprf.ExtendedSetting is added to the properties used with JavaVM.

The -XX:ReservedCodeCacheSize option is added to the Java HotSpot VM options.

The description of notes has been moved from Release Notes.

In addition to the above changes, minor editorial corrections have been made.

Preface

For details on the prerequisites before reading this manual, see the manual uCosminexus Application Server Overview.

1. Files Overview

This chapter describes the file types used with Application Server, formats for describing the files, and precautions for editing the files.

This chapter also describes the files specifying the server-related definition information, among the files used with Application Server.

For details on the property files used for J2EE application settings, see 3. Property Files Used for J2EE Application Settings, and for details on defining the resource property files, see 4. Property Files Used for Resource Settings, in the uCosminexus Application Server Application and Resource Definition Reference Guide.

Organization of this chapter

1.1 File types

1.2 Format for describing the files

1.3 Precautions during file editing

1.1 File types

With Application Server, the files to be used differ depending upon the types of applications to be executed. This manual classifies the files in the following five types:

Files used in systems executing J2EE applications

Files used in systems executing batch applications

Files used in systems executing the Java applications

Files used in systems executing Web applications

Files used in systems executing Web Services

The following table describes each file.

Table 1-1 Files used in systems executing J2EE applications

File types
File description
Manual
Reference

Files used in J2EE servers
When you use a J2EE server, these files are used for specifying the JavaVM properties and invocation options of the J2EE server.
Examples: usrconf.properties, usrconf.cfg#
This manual
Chapter 2

Files used by the Smart Composer functionality (Server setup property files)
These files are used for specifying the systems built using the Smart Composer functionality commands.
Examples: cmxserver.properties, .cmxrc
Chapter 4

Files used in server management commands
These files are used for specifying the JavaVM properties while server management commands are being executed, and the operations of the server management commands.
Examples: usrconf, usrconf.bat
Chapter 5

Files used with JPA
When you use the Cosminexus JPA Provider functionality, these files are used for specifying the persistence unit settings, the cache functionality, and the pessimistic lock functionality of the entity object.
Examples: persistence.xml, O/R mapping file
Chapter 6

Files used with Cosminexus JMS Provider
When using the Cosminexus JMS Provider functionality, these files are used for specifying the connection service and message routing service.
Examples: commonconfig.properties, config.properties
Chapter 7

Files used with CTM
When you perform request scheduling and load balancing using CTM, these files are used for specifying the command options and environment variables that are used with CTM.
Example: CTM user environment variable definition file.
Note that you can use CTM only in the products in which Cosminexus Component Transaction Monitor is included in the component software. For details about products that you can use, see 2.2.1 Relationship of products and component software in the manual uCosminexus Application Server & BPM/ESB Platform Overview.
Chapter 8

Files used in Web server integration
When you use Cosminexus HTTP Server or Microsoft IIS for Web server integration, these files are used to specify the operations of the redirector and the worker.
Examples: mod_jk.conf, workers.properties
Chapter 9

Files used with Cosminexus Manager
These files are used to specify the properties to administer the management domain, environment variables and the location for collecting logs.
Examples: adminagent.properties, mserver.properties
Chapter 10

Files used in a virtual system
When building Application Server on a virtual server, these files are used to specify the connection properties for load balancing units, and client common settings properties of the virtual server manager.
Examples: tierlb.properties, vmiclient.properties
Chapter 11

Files used in log operations
When you collect Application Server logs, these files are used to specify the location to collect the snapshot log.
Example: snapshotlog.conf
Chapter 12

Files used when setting the audit log
When setting up the audit log, these files are used to specify the log files to output the audit log.
Example: auditlog.properties
Chapter 13

Files used in integrated user management
When you use the integrated user management functionality, these files are used to specify the information about the JAAS-compliant user management and single sign-on functionality.
Examples: jaas.conf, ua.conf
uCosminexus Application Server Security Management Guide
Chapter 12

#

For details about the product JavaVM (called JavaVM hereafter) extension option specified in the option definition file (usrconf.cfg) of J2EE servers, see 16. Options for Invoking JavaVM.

Table 1-2 Files used in the system executing batch applications

File types
File description
Reference

Files used in batch servers
When you use a batch server, these files are used to specify the JavaVM properties and invocation options.
Examples: usrconf.properties, usrconf.cfg#
Chapter 3

Files used by the Smart Composer functionality (Server setup property files)
These files are used for specifying the execution environment of the Smart Composer functionality commands and the default values for common arguments.
Examples: cmxserver.properties, .cmxrc
Chapter 4

Files used in server management commands
These files are used for specifying the JavaVM properties while server management commands are being executed, and the operations of the server management commands.
Examples: usrconf, usrconf.bat
Chapter 5

Files used with Cosminexus Manager
These files are used to specify the properties to administer the management domain, environment variables and the location for collecting logs.
Examples: adminagent.properties, mserver.properties
Chapter 10

Files used in log operations
When you collect Application Server logs, these files are used to specify the location to collect the snapshot log.
Example: snapshotlog.conf
Chapter 12

Files used when setting the audit log
When setting up the audit log, these files are used to specify the log files to output the audit log.
Example: auditlog.properties
Chapter 13

#

For details about the JavaVM extension option specified in the option definition file (usrconf.cfg) of batch servers, see 16. Options for Invoking JavaVM.

Table 1-3 File used in the system executing Java applications

File types
File description
Reference

Files used in Java applications
When you use Java applications, these files are used for specifying the JavaVM properties and invocation options.
Examples: usrconf.properties, usrconf.cfg#
Chapter 14

#

For details about the JavaVM extension option specified in the option definition file (usrconf.cfg) of Java applications, see 16. Options for Invoking JavaVM.

Table 1-4 Files used in the system executing Web applications

File types | File description | Reference
Files used in Web applications | When you start the application and the JSP file included in the application is to be compiled, these files are used for specifying the files that are not to be compiled and the files that output the execution result. | Chapter 15

Table 1-5 Files used in the systems executing Web Services

File types
File description
Reference location
Reference section

Files used in Web Services
These files are used to specify the settings for the common system operations or process-specific operations.
Example: cjwconf.properties, cjrconf.properties
uCosminexus Application Server Web Service Development Guide
10.1, 13.1

1.2 Format for describing the files

This section explains the format for describing the files and symbols used in the description.

Organization of this section

(1) Format for describing the files

(2) Symbols used in syntax

(1) Format for describing the files

Chapter 2 and proceeding chapters use the following format to describe the files:

Format

Shows the coding format of the file.

File storage location

Describes the location for storing the file.

Functionality

Explains the functionality of the file.

Specifiable keys

Explains the keys that can be specified in the file.

Specifiable parameters

Explains the parameters that can be specified in the file.

Examples of coding

Shows an example of coding of the file contents.

Precautions

Explains the points to remember when you set up or use the file.

Reference note

Not all of the above items are explained for each file. Additional file-specific information is also provided for some files.

(2) Symbols used in syntax

The following table lists and describes the symbols and syntax elements used in file description.

Table 1-6 Symbols used in the file description

Symbol
Convention

|
In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example:
A|B|C means A, or B, or C.

[ ]
In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example:
[A] means that you can specify A or nothing.
[B|C] means that you can specify B, or C, or nothing.

{ }
In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. For example:
{A|B|C} means only one of A, or B, or C.

...
In syntax explanations, ... indicate that description is omitted.
ABC... means that there is a description after ABC, and this description is omitted.
Alternatively, in syntax explanations, an ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:
<Property>...means that you can specify as many properties as necessary.

< >
In syntax explanations, angle brackets indicate a variable.
For example:
<Property> means that the user enters a property name or a property name is displayed.
<File name> means that the user enters a file name.

Note:

Use single-byte characters for all the symbols.

1.3 Precautions during file editing

This section describes the precautions you must take when editing files with Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista. The description assumes that the system drive is the C drive.

To update the definition file

The definition file provided with the Application Server must be updated with administrator permission. If a user who does not have administrator permission updates the definition file, the definition file present in the directory under C:\Program Files is not updated. The file updated by a user who does not have administrator permission is saved in the following directory:

C:\Users\user-name\AppData\Local\VirtualStore

The application server is invoked with administrator permission, so the contents of the definition file updated by a user who does not have administrator permission are ignored.

To use the Unicode supplementary characters

The characters added with Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, or Windows Vista include the Unicode supplementary characters. You cannot use the Unicode supplementary characters in the definition file used with Application Server.

Examples of definitions in which the Unicode supplementary characters cannot be used are as follows:

Names of EAR, WAR, JAR, EJB-JAR, servlet, JSP, class, method, argument, and variables

Various definitions in a DD

Apart from the above, setup values of various definition files

Moreover, if the characters that cannot be encoded during execution are output to a log file, the characters are not output correctly.

2. Files Used in J2EE Servers

This chapter describes the storage location, functionality, and format of the files used in J2EE servers and the keys that you can specify in the files.

Organization of this chapter

2.1 List of files used in J2EE servers

2.2 hitachi_web.properties (Web application property file for J2EE servers)

2.3 usrconf.cfg (Option definition file for J2EE servers)

2.4 usrconf.properties (User property file for J2EE servers)

2.5 server.policy (Security policy file for J2EE servers)

2.6 criticalList.cfg (Protected areas list file)

2.1 List of files used in J2EE servers

The following table lists the files used in J2EE servers:

Table 2-1 List of files used in J2EE servers

File name | Classification | Overview | Reference
hitachi_web.properties | Web application property file for J2EE servers | Specify Web application specific properties. | 2.2
usrconf.cfg | Option definition file for J2EE servers | Specify the invocation options of the JavaVM that execute the J2EE servers. | 2.3
usrconf.properties | User property file for J2EE servers | Specify the system properties of the JavaVM that execute the J2EE servers. | 2.4
server.policy | Security policy file for J2EE servers | Specify the security policy of the JavaVM that executes the J2EE servers. | 2.5
criticalList.cfg | Protected area list file | Set the classes that prohibit method cancellation in the protected area. | 2.6

2.2 hitachi_web.properties (Web application property file for J2EE servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(1) Format

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

If a path containing space is specified in the value, the path need not be enclosed with double quotation mark (").

(2) File storage location

In Windows
Web-application-web-inf-directory\

In UNIX
Web-application-web-inf-directory/

(3) Functionality

Specify Web application specific properties. You specify the system property settings of the entire J2EE server in the usrconf.properties file. If you specify the same key in usrconf.properties and WEB-INF/hitachi_web.properties, the value in WEB-INF/hitachi_web.properties is given priority.

(4) Specifiable keys

The specifiable keys and default values are described below. If you specify an invalid value in these keys, the operations may not produce the desired results.

Key name
Contents
Default value

webserver.jsp.keepgenerated
Specify whether to store the Java files obtained as a result of JSP file compilation.

If you specify true:

The Java files will be stored.

If you specify false:

The Java files will not be stored.

false

webserver.xml.validate
Specify whether to check if the tag library descriptor (TLD file) is written as per the schema coded in DTD.

If you specify true:

Tag library descriptor will be checked.

If you specify false:

Tag library descriptor will not be checked.

true

(5) Examples of coding

webserver.jsp.keepgenerated=false
webserver.xml.validate=true

2.3 usrconf.cfg (Option definition file for J2EE servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) JavaVM options that can be specified in add.jvm.arg

(6) Examples of coding

(7) Notes

(1) Format

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

You cannot code with a character encoding that is different from the runtime character encoding.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the invocation options of the JavaVM that execute the J2EE servers.

If you change the contents of this file while the J2EE server is running, the changes become effective only when the J2EE server is started next.

(4) Specifiable keys

The following table describes the specifiable keys and the default values: VR is the version of Application Server on which parameters are introduced or changed.

Table 2-2 Specifiable keys and default values in usrconf.cfg (J2EE servers)

Key name
Contents
Default
VR

add.jvm.arg
This key invokes JavaVM by using the specified option.
If you want to specify the system properties, do not use the -D option, but specify the properties in the usrconf.properties file.
When specifying multiple options, use the same key name and specify multiple times as follows:
(Example of specification)
add.jvm.arg= -Xms256m
add.jvm.arg= -Xmx512m
You cannot specify multiple options as shown in the following example. If you specify the options as shown below, the initialization of JavaVM will fail.
(Example of specification)
add.jvm.arg=-Xms256m -Xmx512m
For details about the JavaVM options that you can specify in add.jvm.arg, see 2.3(5)(a) JavaVM options that can be specified in the add.jvm.arg key of the J2EE server.
For details about default values, see 2.3(5)(b) Default values of the JavaVM options in J2EE servers.
--

add.class.path
Specify JAR for the container extension library.
If a path containing space is specified in the value, the path need not be enclosed with double quotation mark (").
Also, values specified in double quotations are not valid.
None
--

add.library.path#1
Specify the shared library for JNI only when the container extension library uses JNI.
None
--

cpp.library.version
Specify the version of libstdc++ library used in the process. Note that this key is used in Linux.
The following string can be specified:

6:

Use the libstdc++.so.6 library.

Only 6 can be specified with version 09-00 or later.
This key will be invalid when specified on platforms other than Red Hat Enterprise Linux.
6
--

ejb.public.directory
Start a J2EE server using the specified directory as the working directory of J2EE server. The current directory of J2EE server is as follows:

In Windows
Cosminexus-working-directory\ejb\server-name

In UNIX
Cosminexus-working-directory/ejb/server-name

Specify an absolute path for the directory name. The characters that you can specify include, single-byte alphanumeric characters, underscores (_), or hyphens (-). You can specify the path length in the range calculated using the estimation formula of the Application Server working directory. For details on the work directory of J2EE servers, see Appendix C.1 Work directory of J2EE servers in the uCosminexus Application Server System Setup and Operation Guide.

In Windows
Cosminexus-installation-directory\CC\server\public

In UNIX
/opt/Cosminexus/CC/server/public

--

ejb.server.corefilenum (in UNIX)
Specify an integer value from 0 to 16 for the number of core files that remain when a J2EE server is restarted. Note that this key is used for UNIX.
Among the following target core files, the specified number of files, starting from the one with the latest creation time, is left behind and all the other files are deleted. Generally, specify 1 as the number of core files output when a J2EE server is down.

Target core files

Cosminexus-working-directory/ejb/server-name/core*

To delete all the core files when you restart the J2EE server, specify 0.

In the case of manual operations, or when you intend to use the Management Server, specify 1 or more.

Among the target core files, those core files that may be overwritten or deleted during restart, are renamed.

In Linux (settings with process ID)

core.core-generated-process-ID -> core.core-generated-process-ID.core-file-creation-date-and-time

For cases other than the above

core -> core.core-file-creation-date-and-time

The format of core-file-creation-date-and-time is yymmddHHMMSS.
When the process of renaming or deleting a core file fails, a message KDJE40047-E is output, the process of starting the J2EE server is cancelled and terminates abnormally.
Note the following:

When a file having the same name as that of the target core file is created, the file created by the user will be deleted.

The core files are deleted when a J2EE server is restarted, therefore, sometimes more core files may be output than the defined number of files until the J2EE server restarts.

Keep a check on the disk capacity, as the defined number + n number of core files is left on the disk. (n: the number of core files output by a J2EE server until the server is restarted).

1
--

ejb.server.log.directory
Use the specified directory as the output destination of the log file#². Specify the path length from 1 to 200 bytes. In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk.
When specifying this key, create a directory to output log before starting the server. If you specify a directory that does not exist, the message KDJE40024-E is output when the J2EE server starts up, and then the server is terminated abnormally.
Make sure that you do not specify the same directory as the log output destination directory for another J2EE server or Web container server (compatible functionality). If you specify the same directory, the operation will not produce the desired results.
Note that if you specify this key and output the log to a directory other than the working directory, the log files in the change destination directory are not deleted when you uninstall the server. If you want to delete the log files, delete them manually.

In Windows
Cosminexus-working-directory\ejb\server-name\logs

In UNIX
Cosminexus-working-directory/ejb/server-name/logs

--

ejb.server.log.mode
Specify the output format of the log file.
The following strings can be specified:

6
The Version 6 compatible mode will be assumed. Output the log file for maintenance in the same directory as in Version 6 and earlier.

7
The Version 7 mode will be assumed.

If you change from Version 6 compatible mode to Version 7 mode, or from Version 7 mode to Version 6 compatible mode, do not move the maintenance log file to the output destination of each mode. After changing the output mode of the log file, if required, delete the maintenance log file that was used before changing the output destination.#2
7
--

ejb.server.log.stdout.filesize
Specify an integer from 4096 to 2147483647​ (unit: byte) as the upper-limit for the size of the cjstdout.log file.
1048576​
--

ejb.server.log.stderr.filesize
Specify an integer from 4096 to 2147483647​ (unit: byte) as the upper-limit for the size of the cjstderr.log file.
1048576​
--

jvm.type
Specify the type of JavaVM to be used. You can specify one of the following values:

server
Java HotSpot Server VM is used.

client
Java HotSpot Client VM is used.

In a development environment where the J2EE servers or the J2EE applications start and stop frequently, performance may be improved by specifying "client". In the case of an error in the specified value, the key searches for JavaVM in the order of "server" -> "client". At this time, the message KDJE40020-W is output.
server
--

Legend:

--: Indicates a version earlier than the version 08-00.

#1

If both the add.library.path and OS environment variables (such as LIBPATH) are set up when executing the cjstartsv command or cjstartweb command, the add.library.path settings have a higher priority.

#2

The log files listed below will be changed:

Types of log
Contents
Log collection directory and log file names

Message log
Operation log

In Windows
ejb.server.log.directory-key-value\cjmessage?.log

In UNIX
ejb.server.log.directory-key-value/cjmessage?.log

Log operation log

In Windows
ejb.server.log.directory-key-value\cjlogger.log

In UNIX
ejb.server.log.directory-key-value/cjlogger.log

User log
Web servlet log

In Windows
ejb.server.log.directory-key-value\web_servlet?.log

In UNIX
ejb.server.log.directory-key-value/web_servlet?.log

User output log

In Windows
ejb.server.log.directory-key-value\user_out?.log

In UNIX
ejb.server.log.directory-key-value/user_out?.log

User error log

In Windows
ejb.server.log.directory-key-value\user_err?.log

In UNIX
ejb.server.log.directory-key-value/user_err?.log

JavaVM maintenance information and garbage collection log

In Windows
ejb.server.log.directory-key-value\javalog??.log

In UNIX
ejb.server.log.directory-key-value/javalog??.log

Event log
Event log for the Explicitly Memory Management functionality of JavaVM

In Windows
ejb.server.log.directory-key-value\ehjavalog??.log

In UNIX
ejb.server.log.directory-key-value/ehjavalog??.log

Exception log
Exception information in the case of failure

In Windows
ejb.server.log.directory-key-value\cjexception?.log

In UNIX
ejb.server.log.directory-key-value/cjexception?.log

Log for maintenance
Maintenance information

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjmaintenance?.log

In UNIX
ejb.server.log.directory-key-value/cjmaintenance?.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjmaintenance?.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjmaintenance?.log

Console messages

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjconsole?.log

In UNIX
ejb.server.log.directory-key-value/cjconsole?.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjconsole?.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjconsole?.log

Maintenance information of EJB container

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjejbcontainer?.log

In UNIX
ejb.server.log.directory-key-value/cjejbcontainer?.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjejbcontainer?.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjejbcontainer?.log

Maintenance information of Web container

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjwebcontainer?.log

In UNIX
ejb.server.log.directory-key-value/cjwebcontainer?.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjwebcontainer?.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjwebcontainer?.log

Standard output information of the invocation process

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjstdout.log

In UNIX
ejb.server.log.directory-key-value/cjstdout.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjstdout.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjstdout.log

Backup of standard output information of the invocation process

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjstdout_save.log

In UNIX
ejb.server.log.directory-key-value/cjstdout_save.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjstdout_save.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjstdout_save.log

Standard error information of the invocation process

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjstderr.log

In UNIX
ejb.server.log.directory-key-value/cjstderr.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjstderr.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjstderr.log

Backup of standard error information of the invocation process

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cjstderr_save.log

In UNIX
ejb.server.log.directory-key-value/cjstderr_save.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cjstderr_save.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cjstderr_save.log

Termination process information

Version 6 compatible mode

In Windows
ejb.server.log.directory-key-value\cj_shutdown?.log

In UNIX
ejb.server.log.directory-key-value/cj_shutdown?.log

Version 7 mode

In Windows
ejb.server.log.directory-key-value\CC\maintenance\cj_shutdown?.log

In UNIX
ejb.server.log.directory-key-value/CC/maintenance/cj_shutdown?.log

Maintenance log of resource adapter
--

In Windows
ejb.server.log.directory-key-value\connectors\display-name-of-resource-adapter?.log

In UNIX
ejb.server.log.directory-key-value/connectors/display-name-of-resource-adapter?.log

TPBroker trace
Trace information of TPBroker

In Windows
In ejb.server.log.directory-key-value\TPB

In UNIX
In ejb.server.log.directory-key-value/TPB

Legend:

--: Not applicable

(5) JavaVM options that can be specified in add.jvm.arg

This section describes the JavaVM options that you can specify in add.jvm.arg and the default values for J2EE servers.

(a) JavaVM options that can be specified in the add.jvm.arg key of the J2EE server

This section describes the JavaVM options that you can specify in the add.jvm.arg key of the J2EE server. JavaVM options include the options that can be specified as per the standards and the JavaVM extension options. Also, the default values of JavaVM options depend on the server to be used. For details on the JavaVM extension options, see 16.1 List of JavaVM extension options. For details about Java HotSpot VM options, see 16.5 Java HotSpot VM options that can be specified in Cosminexus.

The following are the Java HotSpot VM options that you can specify in add.jvm.arg of the J2EE server:

-agentlib:libname[=options]

-Dproperty

-verbose:[class|gc|jni]

-Xloggc:file

-Xmssize

-Xmxsize

-Xmnsize

-Xsssize

-Xprof

-Xrunhprof[:help]|[:option=value, ...]

-XrunlibraryName

-Xdebug

-XX:NewRatio=value

-XX:PermSize=value

-XX:MaxPermSize=value

-XX:SurvivorRatio=value

-XX:[+|-]PrintTenuringDistribution

-XX:TargetSurvivorRatio=value

-XX:MaxTenuringThreshold=value

-Xrunhndlwrap

-agentlib:hndlwrap2

(b) Default values of the JavaVM options in J2EE servers

This section describes the default values of JavaVM options for J2EE servers:

-Xms256m

-Xmx512m

-XX:PermSize=128m

-XX:MaxPermSize=128m

-XX:NewRatio=2

-XX:SurvivorRatio=8

-XX:HitachiJavaLog:<ejb.server.log.directory>

-XX:HitachiJavaLogFileSize=4m

-XX:+HitachiOutOfMemoryStackTrace

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJavaClassLibTraceLineSize =1024

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiVerboseGC

-XX:+HitachiVerboseGCPrintCause

-XX:+HitachiOutputMilliTime

-XX:+HitachiUseExplicitMemory

-XX:HitachiExplicitHeapMaxSize=64m

-XX:HitachiExplicitMemoryLogLevel:normal

-XX:HitachiExplicitMemoryJavaLog:<ejb.server.log.directory>

-XX:HitachiExplicitMemoryJavaLogFileSize=4m

-XX:-HitachiAutoExplicitMemory

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:-HitachiExplicitMemoryCompatibleToV8

-XX:+HitachiOutOfMemoryHandling

(6) Examples of coding

In Windows

# java vm options
add.jvm.arg=-Xms256m
add.jvm.arg=-Xmx512m
add.jvm.arg=-XX:PermSize=128m
add.jvm.arg=-XX:MaxPermSize=128m
add.jvm.arg=-XX:+HitachiVerboseGC
add.jvm.arg=-XX:HitachiVerboseGCIntervalTime=600

# ejb public directory
ejb.public.directory=c:\workdir

# ejb.server.log.directory
ejb.server.log.directory=c:\logdir\servername

In UNIX

# java vm options
add.jvm.arg=-Xms256m
add.jvm.arg=-Xmx512m
add.jvm.arg=-XX:PermSize=128m
add.jvm.arg=-XX:MaxPermSize=128m
add.jvm.arg=-XX:+HitachiVerboseGC
add.jvm.arg=-XX:HitachiVerboseGCIntervalTime=600

# ejb public directory
ejb.public.directory=/opt/workdir

# ejb.server.log.directory
ejb.server.log.directory=/CClogs/server/servername

# ejb.server.corefilenum
ejb.server.corefilenum=3

(7) Notes

The environment variable CLASSPATH that is set at the command prompt is not passed to the J2EE servers, but the other environment variables (such as PATH) are passed.

Do not use a character encoding that is different from the OS locale. If UTF-8 is used in the OS locale, do not use UTF-8 with BOM.

If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.

The JavaVM options that are not specified in the usrconf.cfg become the default JavaVM values.

You cannot specify the following properties for -D:

java.endorsed.dirs

java.security.policy

java.class.path

java.library.path

Among the values specified in the add.class.path key, there are some values for which the <cosminexus.home> tag is used to specify the JAR files for the container extension library. These values indicate the installation destination of Application Server, so you do not need to change the contents coded for the add.class.path key. Note that when you add the container extension library to the add.class.path key, the installation and uninstallation operations might not be guaranteed. Therefore, do not use the <cosminexus.home> tag.

2.4 usrconf.properties (User property file for J2EE servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Keys reserved in a J2EE servers

(5) Keys for customization of J2EE servers

(6) Examples of coding

(1) Format

J2SE property file format.

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.

If the format does not conform to Java specifications, the J2EE server might fail to start.
(Example) When the format contains an invalid Unicode escape sequence (the string after \u is not an appropriate Unicode hexadecimal value).

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the system properties of the JavaVM that execute the J2EE servers.

If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.

If you change the contents of this file while the J2EE server is running, the changes become effective only when the J2EE server is started next.

(4) Keys reserved in a J2EE servers

A J2EE server internally uses the keys beginning with the following prefixes. As a result, the keys beginning with these prefixes must not be used in applications.

ejbserver.*

webserver.*

appclient.*

j2eeserver.*

(5) Keys for customization of J2EE servers

You can customize the operations of the J2EE servers by setting the values in the following system property keys.

The keys are classified and described as follows:

Keys beginning with cosminexus.jpa

Keys beginning with ejbserver.application

Keys beginning with ejbserver.client

Keys beginning with ejbserver.commonj

Keys beginning with ejbserver.compiler

Keys beginning with ejbserver.connectionpool

Keys beginning with ejbserver.connector

Keys beginning with ejbserver.container

Keys beginning with ejbserver.ctm

Keys beginning with ejbserver.deploy

Keys beginning with ejbserver.distributedtx

Keys beginning with ejbserver.DynamicStubLoading

Keys beginning with ejbserver.ejb

Keys beginning with ejbserver.ext

Keys beginning with ejbserver.http

Keys beginning with ejbserver.instrumentation

Keys beginning with ejbserver.jca

Keys beginning with ejbserver.jndi

Keys beginning with ejbserver.jpa

Keys beginning with ejbserver.jta

Keys beginning with ejbserver.logger

Keys beginning with ejbserver.management

Keys beginning with ejbserver.manager

Keys beginning with ejbserver.naming

Keys beginning with ejbserver.rmi

Keys beginning with ejbserver.server

Keys beginning with ejbserver.stateful

Keys beginning with ejbserver.stdoutlog

Keys beginning with ejbserver.watch

Keys beginning with ejbserver.webj2ee

Keys beginning with https

Keys beginning with java

Keys beginning with vbj

Keys beginning with vbroker

Keys beginning with webserver.application

Keys beginning with webserver.connector

Keys beginning with webserver.container

Keys beginning with webserver.context

Keys beginning with webserver.dbsfo

Keys beginning with webserver.eadssfo

Keys beginning with webserver.errorpage

Keys beginning with webserver.http

Keys beginning with webserver.jsp

Keys beginning with webserver.logger

Keys beginning with webserver.servlet

Keys beginning with webserver.session

Keys beginning with webserver.static

Keys beginning with webserver.work

Keys beginning with webserver.xml

(a) Keys beginning with cosminexus.jpa

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

cosminexus.jpa.logging.level.operation.category
Specify the log level for each category of the JPA provider operation log, when you are using the JPA functionality of the J2EE server. The category name and log level are case sensitive.
If this key is not specified, the log is not output to the operation log. Since this affects the security and performance, take care when you specify the output level settings.

If you specify Off:

The log is not output to the JPA provider operation log.

If you specify Information:

The JPA operation information is output to the JPA provider operation log.

If you specify Detail:

The detailed JPA operation information and the information that was output to Information is output to the JPA provider operation log.

Off
08-00

cosminexus.jpa.exception.logging.sql#
Specify whether the exception message will include the SQL statement that caused the exception, when the JPA provider executes the SQL statement and receives an exception from the database.

If you specify Off:

The SQL statement executed by the JPA provider and the value specified for the ? parameter (place holder) is not included in the exception message.

If you specify Information:

The SQL statement executed by the JPA provider is included in the exception message.

If you specify Detail:

The SQL statement executed by the JPA provider and the value specified for the ? parameter (place holder) is included in the exception message.

Off
08-00

#

The values specified in this property are also applied to the contents output to the exception log.

For Information and Detail, the contents of the SQL statement and the ? parameter (place holder) is also output to the exception log; and therefore, you consider the security. Specify the values as and when required for development and maintenance.

When handling binary data, the hash value of the binary object is output to the ? parameter (place holder).

Before you complete the preparation for issuing an SQL statement, if a failure occurs in acquiring a connection due to communication errors, you might not be able to acquire value of the ? parameter (place holder).

(b) Keys beginning with ejbserver.application

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.application.InitTermProcessClasses
When using the container extension library, specify the class name of server start/stop hook. When specifying multiple classes, demarcate them with a comma (,). Do not insert a space between the comma (,) and the class name. When a J2EE server is started, the server start hook method of the server start/stop hook functionality is invoked in the specified order. When a J2EE server is shutdown, the server stop hook method of the server start/stop hook functionality is invoked in the reverse order of the specified order.
None
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.appname
Specify a single-byte character set of 0 to 16 bytes for the default application name that is output to the AppName field. If the value of the AppName field is not specified in the program, the value of this property is output to the AppName field.
If the definition of the usable character sets is fulfilled, but the length of the value exceeds the limit, a warning message is output, the data exceeding the limit is truncated, and the data up to the restricted length is used.
If you specify the string "null", this string is treated as a null character string "", and nothing is displayed in the appname field. You cannot specify the display of a "null" string in appname, from this property.
user_app
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.count
Specify an integer in the following range for the number of log files:

When CJMessageFileHandler is used:

2 to 16

When CJMPMessageFileHandler is used:

2 to 64

The value keeps increasing up to the number of files specified here and once the specified number is reached, the next number returns to the starting number "1".
If an old log file or a user file with the same name exists, the existing file is overwritten.
2
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.encoding
Specify a value from 0 to 1024 bytes for the encoding of the strings to be output. If you do not specify any value, the default encoding is used.
If the specified value exceeds the range, or if you specify a "null" string, it is treated as if encoding is not specified (default value in encoding is used). You cannot use an encoder named "null".
In JavaVM, specify the character set that changes java.nio.charset.Charset.isSupported (String charsetName) to true. For the character sets that can be specified in encoding as well as the character strings to be specified, follow the specifications, such as java.nio.charset.Charset of Java standard API. Examples of specified values are as follows:

US-ASCII: 7-bit ASCII (Basic Latin block of ISO646-US/Unicode charset)

ISO-8859-1: ISO Latin Alphabet No. 1 (ISO-LATIN-1)

UTF-8: 8-bit UCS conversion format

SJIS: Shift-JIS, Japanese

EUC_JP: JIS X 0201, 0208, 0212, EUC encoding, Japanese

MS932: Windows Japanese (Specification for Windows)

JIS0201: JIS X 0201, Japanese

JIS0208: JIS X 0208, Japanese

JIS0212: JIS X 0212, Japanese

Do not perform any unnecessary encoding since it will lead to performance degradation.
null
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.filter
Specify the filter to be used with its full name, including the package name. Specify the value as a class character set from 0 to 4096 bytes.
Create the filter specified here using the Reflection functionality and use it for the handler of the specified handler name.
If the specified value exceeds the range, it is assumed that the filter is not specified. Furthermore, if you specify a "null" string, it is again treated as no filter is to be used.
Do not create a filter with the name "null".
null
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.formatter
Specify the formatter that you will use along with its full name, including the package name. Specify the value as a class character set from 0 to 4096 bytes.
The values that can be specified are as follows:

When connecting to the CJMessageFileHandler class

Specify either com.hitachi.software.ejb.application.userlog.CJSimpleFormatter, or a user-created Formatter class.

Do not specify Java2-1.4 standard SimpleFormatter and XMLFormatter in CJMessageFileHandler (the separator is a linefeed, therefore, the message record is not displayed in one line). When specifying a user-created Formatter class, a formatter that will create a message without control codes such as linefeed, needs to be created.

When connecting to the Handler class of Java2-1.4:

There are no specific rules.

Create the filter that is specified here using the Reflection functionality and use it for the handler of the specified handler name.
If the specified value exceeds the range, it is assumed that the formatter is not specified. Furthermore, if you specify a "null" string, it is treated as no formatter is to be used. Do not create a formatter with the name "null".
null
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.level
Specify single-byte alphabets for the upper-limit of log collection level. You specify a value defined in the Java constant. This option is case-sensitive.
Only messages of a level lower than the value specified here are output to the log. The specifiable levels are as follows:

OFF: A special level used for logging off

SEVERE: Message level indicating a severe problem

WARNING: Message level indicating a potential problem

INFO: Message level for providing messages as information

CONFIG: Message level of static configuration messages

FINE: Message level for providing the trace information

FINER: Trace level 2 (higher than FINE)

FINEST: Trace level 3 (higher than FINER)

ALL: Collects the log of all messages

OFF and ALL are special levels. For example, if you specify OFF for a logger and handler, the log will not get collected at all, irrespective of the log level. If you specify ALL, the log of all levels is output.
SEVERE
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.limit
Specify an integer in the following range (units: bytes) for the capacity of a log file:

When CJMessageFileHandler is used:

8192 to 2147483647​

When CJMPMessageFileHandler is used:

8192 to 16777216​

Keep incrementing the capacity up to the capacity specified in this key and once the specified capacity is reached, the log file will switch to the next log file.
In the case of HNTRLib2, since the capacity check is done before writing the messages, there are times when the actual maximum capacity exceeds the set value by a maximum of approximately 4200 bytes (this is because messages are written if even one byte does not match the specified capacity).
For example, if you specify 8192 in this key and when the area currently being used by out1.log is 8000 bytes, the free space is 192 bytes and if a message of 4000 bytes is output, the message is output to out1.log. As a result, the size of out1.log will exceed the upper-limit value.
1048576​
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.msgid
Specify a single-byte character set from 0 to 21 bytes for the default message ID that is output to the MsgID field. If the value of MsgID is not specified in the program, the value of this property is output to the MsgID field.
If the definition of the usable character sets is fulfilled, but the length of the value exceeds the limit, a warning message is output, the data exceeding the limit is truncated, and the data up to the restricted length is used.
If you specify "null", it is treated as a null character string "", and nothing is displayed in the msgid field. You cannot specify the display of a "null" string in msgid, from this property.
0001
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.path
Specify a value from 1 to 255 bytes for the prefix of a log file name. Specify the path as a relative path#2. Do not specify a single-byte numeric value at the end of the path name.
The value obtained by adding "xx (an integer between 1 to 16).log" to the prefix specified in this key forms the name of the trace information file.
The single-byte alphanumeric characters specified in the path are not case-sensitive. Specify the length of the path value, such that the total of the following A + B + C values is within the range of the value:

A (In Windows): log-output-destination-root(value of ejb.server.log.directory)\user\ (The default is Cosminexus-working-directory\ejb\J2EE-server-name\logs\user\)

A (In UNIX): log-output-destination-root(value of ejb.server.log.directory)/user/ (The default is Cosminexus-working-directory/ejb/J2EE-server-name/logs/user/)

B: Length of the prefix specified by the user

C: Six characters of "xx.log"

Apart from the above, note the following when specifying the path:

Double-byte codes of native cannot be used in the Properties file, therefore, acquire and specify the Unicode strings by using native2ascii.

Do not specify as an absolute path. Do not use ".\" ("./" in Unix) of a relative path.

If the path includes Japanese characters, JavaVM needs to be running in an environment where the locale settings enable the processing of Japanese characters.

You cannot set the same path as another handler. If you set the same path, the handler is not created.

user_log
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.separator
Use the CJSimpleFormatter and specify a single byte character set from 0 to 1024 bytes for the separator that is used to output the message. You can use the separator as a character string.
If the definition of the usable character sets is fulfilled, but the length of the value exceeds the limit, a warning message is output, the data exceeding the limit is truncated, and the data up to the restricted length is used.
In the case of output in the HNTRLib2 format, do not specify the following control characters in the message:

In Windows: "\r" and "\n"

In UNIX: "/r" and "/n"

If these characters are specified, the output contents are misaligned and the record is not output in one line. If you specify "null", it is treated as a null character string "". As a result, "null" string cannot be used as a separator. You cannot specify the display of a "null" string in the separator, from this property.
| (Stroke)
--

ejbserver.application.userlog.loggers
This is a property that declares the name of the logger to be used. Specify a value from 0 to 65535 bytes. You can specify multiple logger names by demarcating with a comma (,). If you demarcate with a semicolon (;) immediately after the logger name, you can also specify the resource bundle name for regional correspondence used in that logger.
Hitachi recommends that the logger name be a name based on the package name or the class name of the subsystem that is demarcated with a dot (.), such as java.net or javax.swing.#3 Do not use a comma (,) or a semicolon (;) in the logger name.
If multiple class names are defined and the length of the specified value exceeds the range, only those class names whose length is within the range and which fulfill the rules of the value are set.
The logger with the name declared in this key is processed as a logger built in the CJLogManager class (the logger is built when a J2EE server is started).
The loggers that are not specified in this key are not generated automatically; therefore, create the loggers as per the codes.
None
--

ejbserver.application.userlog.Logger.logger-name#3.filter
This property specifies the filter used in the logger with its full name, including the package name. Specify the value as a class character set from 0 to 4096 bytes.
The logger with the specified logger name creates the filter specified in this key by using the Reflection functionality and uses the filter to select messages.
If the specified value exceeds the range, it is assumed that the filter is not specified. Furthermore, if you specify a "null" string, it is treated as no filter is to be used. Do not create a filter with the name "null".
Null
--

ejbserver.application.userlog.Logger.logger-name#3.handlers
This property is used to connect the handler class (addHandler(Handler)) to the specified logger name. To create the handler class using the Reflection functionality, specify a value from 0 to 65535 bytes for the handler class with a full name containing the package name. You can specify multiple handler classes by demarcating with a comma (,).
You can specify the following handler classes:

com.hitachi.software.ejb.application.userlog.CJMessageFileHandler

com.hitachi.software.ejb.application.userlog.CJMPMessageFileHandler

java.util.logging.ConsoleHandler

java.util.logging.FileHandler

java.util.logging.SocketHandler

java.util.logging.StreamHandler

java.util.logging.MemoryHandler

Full name including the package name of the unique Handler class created by the user

In a CJLogHandler node, specify the handler name by demarcating with a semicolon (;) after the handler class name, initialize the handler with the specified handler name, create the handler class, and then connect to the logger. In the Java2-1.4 standard Logging class, even if you specify the handler name by demarcating with a semicolon (;), this key becomes disabled. For details about how to set the Java2-1.4 standard Logging class, follow the specifications of the corresponding class.
Specify a class character set of 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name.
If multiple class names are defined and the length of the specified value exceeds the range, only those class names whose length is within the range and which fulfill the rules of the value are set.
If the logger name is not specified in ejbserver.application.userlog.loggers, the logger is not created.
None
--

ejbserver.application.userlog.Logger.logger-name#3.level
Specify single-byte alphabets for the log output level of the logger or "null". This option is case-sensitive. To output a log message, you need to clear the log output level of the logger and the output level of the handler used for the output. The values that can be specified are as follows:

Values that can be specified in ejbserver.application.userlog.CJLogHandler.handler-name.level

"null"

If you specify "null" as the name, initialize the logger level with null. If the logger level is initialized to null, that logger will inherit the level of its parent logger.
SEVERE
--

ejbserver.application.userlog.Logger.logger-name#3.useParentHandlers
Specify single-byte alphabets for whether the log record is to be transmitted from the logger that received the log record to the handler that is connected to the parent logger. Specify true if the log record is to be transmitted and false if it is not to be transmitted.
The log output level that passes through this logger affects only the level of the handler that is connected to the parent logger (If the level of the parent logger is OFF and the level of the handler that is connected to the parent logger is ALL, all messages are displayed).
true
--

Legend:

--: Indicates a version earlier than the version 08-00.

Note:

You can specify the following values in the respective character sets used in the property definitions of the user log functionality (other than the ejbserver.application.InitTermProcessClasses key):

Class character sets (character sets used in defining the class name)
Single-byte alphanumeric characters (a-z, A-Z, 0-9), periods (.), dollar signs ($) and underscores (_)

Single-byte character sets
Single-byte alphanumeric characters (a-z, A-Z, 0-9), periods (.), dollar signs ($), underscores (_), hyphens (-), strokes (|), colons (:), ampersands (&), at marks (@), hash marks (#), and percent signs (%)

If the specified value is invalid, such that it does not fulfill the conditions of the character sets that can be used or is not within the range of the values that can be specified, a warning message is output and a valid default value is used at that point. The valid default value at that point implies the value of the key when the handler-name=default, or the default value of the 'Default values' column.

#1

Use the handler name to differentiate between the property values. Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name. If you specify default, handler name indicates a property that is recognized as the common default value by all CJLogHandler.

#2

Use the following rules for the source of the output destination:

ejb.server.log.directory-value\user or ejb.server.log.directory-value/user

For the value of ejb.server.log.directory, follow the specifications of ejb.server.log.directory. The default value of ejb.server.log.directory of J2EE servers is as follows:

In Windows
Cosminexus-working-directory\ejb\J2EE-server-name\user\user-specified-value

In UNIX
Cosminexus-working-directory/ejb/J2EE-server-name/user/user-specified-value

#3

You specify the logger name when the instances of the logger are acquired with Logger.getLogger (logger-name). The logger name is appended with a dot (.) and must be declared beforehand in ejbserver.application.userlog.loggers property. For details on the logger name, follow the specifications of java.util.logging.Logger.

Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the logger name. If you specify default, logger name indicates a property that is recognized as the common default value by all CJLogHandler.

The properties identified by the logger names are used for initializing the logger class of the user log functionality.

If a logger name ends with .handlers, there may be confusion when the properties of ejbserver.application.userlog.Logger.logger-name.handlers are specified, and therefore, Hitachi recommends that you do not end a logger name with ".handlers".

(c) Keys beginning with ejbserver.client

The following table lists the specifiable key. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Contents | Default value | VR
ejbserver.client.ctm.RequestPriority | Specify an integer from 1 to 8 as the priority for extracting the requests accumulated in the queues within CTM. Smaller the value higher is the priority. If the specified value is wrong or omitted, 4 will be set. | 4 | --

Legend:

--: Indicates a version earlier than the version 08-00.

(d) Keys beginning with ejbserver.commonj

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Contents | Default value | VR
ejbserver.commonj.WorkManager.non_daemon_work_threads | Specify an integer from 1 to 65535 for the maximum pool size of the thread pool for executing a short-lived Work in WorkManager. | 10 | 08-50

(e) Keys beginning with ejbserver.compiler

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.compiler.jvm.maxHeapSize
Specify the maximum value of the heap size of the javac command that is invoked when a J2EE application is started.
Specify the value in the format that is accepted by the -Xmx and -Xms options of the java command. If you specify the value in any other format, the operation may not produce the desired results.
Specify as follows:

Specify a value from 2048 to 4294966272​. Specify a value that is greater than the value specified in ejbserver.compiler.jvm.minHeapSize.

When specifying in kilobytes, add the character 'k' or 'K'.

When specifying in megabytes, add the character 'm' or 'M'.

This property is valid for the Application Server version 09-00-01 or earlier. Even if this property is specified for the Application Server version 09-00-02 or later, the specification is ignored.

256m
--

ejbserver.compiler.jvm.minHeapSize
Specify the initial value of the heap size of the javac command that is invoked when a J2EE application is started.
Specify the value in the format that is accepted by the -Xmx and -Xms options of the java command. If you specify the value in any other format, the operation may not produce the desired results.
Specify as follows:

Specify a value from 1024 to the value specified by -Xmx.

To specify in kilobytes, add the character 'k' or 'K'.

To specify in megabytes, add the character 'm' or 'M'.

This property is valid for the Application Server version 09-00-01 or earlier. Even if this property is specified for the Application Server version 09-00-02 or later, the specification is ignored.
32m
--

Legend:

--: Indicates a version earlier than the version 08-00.

(f) Keys beginning with ejbserver.connectionpool

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.connectionpool.applicationAuthentication.disabled
Specify whether to enable the functionality for optimizing container management sign-on.

If you specify true:

Container management sign-on will be optimized. If you specify true, you cannot use sign-on by application management.

If you specify false:

Container management sign-on will not be optimized. You can use sign-on by container management as well as sign-on by application management.

If you use a resource adapter other than DB Connector, you cannot specify true in this property.
false
--

ejbserver.connectionpool.association.enabled
Specify whether to enable the connection association functionality in the 1.4 mode.

If you specify true:

The connection association functionality will be enabled.

If you specify false:

The connection association functionality will be disabled.

false
--
3.14 Functionality for performance tuning in Common Container Functionality Guide

ejbserver.connectionpool.association.enabledDespiteUnshareableSetting
Specify whether to perform connection association when Unshareable is specified in res-sharing-scope of the standard DD for servlets and Enterprise Beans.

If you specify true:

Connection association will be performed even if Unshareable is specified in res-sharing-scope of the standard DD for servlets and Enterprise Beans. However, ejbserver.connectionpool.association.enabled=true needs to be specified.

If you specify false:

Connection association will not be performed if Unshareable is specified in res-sharing-scope of the standard DD for servlets and Enterprise Beans.

Note the following point when an application that has operated normally on Application Server versions earlier than 06-50 version is executed with Cosminexus 06-50 or later versions:
If the connection association functionality is expected to be running in the application even when Unshareable is specified in res-sharing-scope (particularly, when two or more connections are acquired in local transactions), true must be specified.
Do not specify this key, when developing a new application.
false
--

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled
Specify the operations of connection sharing when a connection is acquired multiple times outside the transactions managed by Application Server, in 1.4 mode. When NoTransaction is specified in the transaction support level of a resource adapter, connection sharing is not performed.

If you specify true:

Connection will be shared. Connection will not be shared if Unshareable is specified in res-sharing-scope of the standard DD for servlets and Enterprise Beans, even if you specify true.

If you specify false:

Connection will not be shared outside the transactions managed by Application Server.

false
--

ejbserver.connectionpool.validation.timeout
Specify the timeout value for the functionality to detect connection failure and the timeout value (unit: seconds) for deleting connections using the functionality to adjust the number of connections as an integer from 1 to 2147483647​.
5
08-00

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

(g) Keys beginning with ejbserver.connector

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.connector.logwriter.filenum
Specify an integer from 1 to 16 for the number of log files of a resource adapter.
4
--

ejbserver.connector.logwriter.filesize
Specify an integer from 4096 to 2147483647​ (units: bytes) for the size of the log files of a resource adapter.
2097152​
--

ejbserver.connector.statementpool.clear.backcompat
Specify the contents for initializing the statements when the statements are reused in the statement pooling functionality.

If you specify true:

The following contents are initialized:

- Parameters

- SQL command list

- All the warnings reported for a Statement object

If you specify false:

The following contents are initialized:

- Parameters

- SQL command list

- All the warnings reported for a Statement object

- Number of lines that must be fetched from a database

- Restricted value for maximum number of bytes of the ResultSet column storing the character or binary values

- Restricted value for maximum number of lines that can include the ResultSet object

- Query timeout

true
08-70

Legend:

--: Indicates a version earlier than the version 08-00.

(h) Keys beginning with ejbserver.container

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.container.audit_trail.enabled
Specify whether to enable the database audit trail linkage functionality.

If you specify true:

The database audit trail linkage functionality is enabled.

If you specify false:

The database audit trail linkage functionality is disabled.

false
--

ejbserver.container.bmp.backcompatible
Specify operation lock control of an Entity Bean (BMP).

If you specify true:

The lock in the EJB container will be controlled.

If you specify false:

The lock in the EJB container will not be controlled.

To enable the changes in this property, once delete the J2EE application that is being started and then re-create or re-import it.
false
--

ejbserver.container.ejbhome.sessionbean.reconnect.enabled
Specify whether to enable the reconnection of EJB home object functionality.

If you specify true:

The reconnection of EJB home object functionality is enabled.

When you specify true, always specify the port number in the vbroker.se.iiop_tp.scm.iiop_tp.listener.port property.

If you specify false:

The reconnection of EJB home object functionality is disabled.

false
--

ejbserver.container.passivate.scan.interval
Specify an integer from 0 to 2147483​ (units: seconds) for the interval to invoke the thread for monitoring the timeout and pool status of an Enterprise Bean.
When 0 is specified, monitoring is not performed.
The thread for monitoring the timeout and pool status of an Enterprise Bean executes the following processing at the interval specified here:

Deletes the Stateful Session Bean and Entity Bean instances with the lapsed timeout periods.

Gradually deletes the pooled instances exceeding the minimum value for the Stateless Session Bean and Entity Bean pools.

0
--
2.11 Setting up timeout in the EJB container in EJB Container Functionality Guide

ejbserver.container.rebindpolicy
Specify re-connection and re-sending of requests in the EJB client, in the case of a communication failure when invoking the EJB method.

VB_TRANSPARENT:

Re-connects and resends the requests.

NO_RECONNECT:

Does not re-connect and does not resend the requests.

In such a case, since there is no re-connection when the connection is disconnected due to communication failure, the object reference cannot be re-used.

VB_TRANSPARENT
--
2.13 Invoking the EJB remote interface in EJB Container Functionality Guide

ejbserver.container.security.disabled
Specify whether to enable the functionality for controlling the access of Enterprise Bean. For details about the functionality used for controlling the access of Enterprise Beans, see 2.10 Access control for Enterprise Bean in the manual uCosminexus Application Server EJB Container Functionality Guide.
This property is not related to the security policy specified in server.policy (security policy file for J2EE servers).

If you specify true:

The functionality that controls the access of Enterprise Beans will be disabled. In this case, the security definition at the EJB level and the application level is disabled, and absolutely no check is performed for the method execution permission during EJB execution.

If you specify false:

The functionality that controls the access of Enterprise Beans will be enabled.

false
--

ejbserver.container.remove.scan.interval
Specify an integer from 0 to 153722867280912​ (units: minutes) for the interval to invoke the thread for monitoring the timeout of an activated Stateful Session Bean.
When you specify either 0 or a value below 0, the timeout is not monitored.
If you specify a value greater than 153722867280912​, 153722867280912​ is set.
If you specify a non-numeric value, the default value will be set.
5
--

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

(i) Keys beginning with ejbserver.ctm

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.ctm.ActivateTimeOut
This property is necessary for using the CTM functionality. When you deploy a J2EE application that uses the CTM functionality, the J2EE server activates the schedule queue. At this point, specify a value from 0 to 2147483647​ for the standby time (units: seconds). If you specify 0, the standby time continues infinitely and when if you do not specify a value, 180 (seconds) is set.
180
--

ejbserver.ctm.CTMDomain
This property is necessary for using the CTM functionality. Specify an alphanumeric character from 1 to 31 or an underscore (_) for the CTM domain name to which the J2EE server belongs. You cannot specify a CTM domain name beginning with 'CTM' or 'ctm'. If you do not specify a value, "CTMDOMAIN" is set.
CTMDOMAIN
--

ejbserver.ctm.CTMID
This property is necessary for using the CTM functionality. Specify an alphanumeric character from 1 to 31, an underscore (_), or a period (.) for the CTM identifier of the CTM daemon that controls the J2EE server. You can, however, use a period (.) only when specifying the identifier as an IP address.
You cannot specify a CTM identifier beginning with 'CTM' or 'ctm'. You also cannot specify a name that is same as the CTM domain name. If you do not specify a value, the IP address is set.
IP-address
--

ejbserver.ctm.CTMMyHost
This property is necessary for using the CTM functionality. Specify the host name or the IP address used by CTM in a node-switching environment, wherein multi-home or IP address is inherited. Specify a string of 1 to 64 characters for the host name or IP address.
If you do not specify a value, the host name that can be acquired by the hostname command is set.
If you specify this property without specifying the ejbserver.ctm.CTMID property, the IP address specified in this property becomes the default CTM identifier.
host-name-acquired-by-hostname-command
--

ejbserver.ctm.DeactivateTimeOut
When un-deploying the J2EE applications that use the CTM functionality, the J2EE server passivates the schedule queue. Specify a value from 0 to 2147483647​ (units: seconds) for the standby time (awaiting completion of the running requests) at that point. If you specify 0, the standby time continues infinitely and when if you do not specify a value, 180 (seconds) is set.
If you attempt to stop an application via CTM when the application contains some running requests, it is not possible to perform forced termination, and therefore, do not specify 0.
180
--

ejbserver.ctm.enabled
Specify whether to use the CTM functionality.

If you specify true:

CTM functionality will be used. CTM can only be used in products including Cosminexus Component Transaction Monitor in the component software. For details about the products that can be used, see 2.2.1 Relationship of products and component software in the manual uCosminexus Application Server & BPM/ESB Platform Overview.

Establish a connection with CTM, and perform initialization when a J2EE server is started. If this is successful, the J2EE server is started when the CTM functionality is in a usable state.

In the case of failure in connecting to CTM and initializing, invocation of the J2EE server fails.

If you specify false:

CTM functionality will not be used.

When a J2EE server is started, since a connection is not established with CTM and initialization is not performed, the J2EE server is not invoked when CTM is in a usable state. In this state, you cannot deploy the applications that use CTM. If you want to invoke the J2EE server when the CTM functionality is not in a usable state, specify false.

If the version is upgraded from version 07-50 or earlier versions when this property is omitted, you must set up the following values manually depending on the Application Server edition before upgrade:

For Application Server Enterprise:

true

For other editions:

false

In version 09-00 or later versions:

false

In version 09-00 or earlier versions:

true

--

ejbserver.ctm.QueueLength
A J2EE server generates the CTM queue, when J2EE applications that use the CTM functionality are deployed. Specify a value from 1 to 32767 for the length of the CTM queue at this point. If you do not specify a value, the length during the generation of the CTM queue maintained in the CTM daemon (length specified by the -CTMMaxRequestCount option) becomes valid. When the CTM queue is shared, since the CTM queue is already created, the already created length becomes valid instead of the specified value.
None
--

ejbserver.ctm.useGlobalJNDI
Switches the default lookup name used when no optional name is specified for Enterprise Bean in a configuration using the CTM functionality.

If you specify true:

A Portable Global JNDI name beginning with java:global/ is used.

If you specify false:

A Global JNDI name beginning with HITACHI_EJB/ is used.

false
09-00

Legend:

--: Indicates a version earlier than the version 08-00.

(j) Keys beginning with ejbserver.deploy

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.deploy.annotations.load_libjars.enabled
Specifies whether library JAR annotations will be read when a J2EE application is deployed.

If true is specified:

The library JAR annotations will be read.

If false is specified:

The library JAR annotations will not be read.

This key is used to restrict the memory usage when you import applications containing a library JAR with a large number of classes and in which the library JAR annotations are not required.

Notes:

If the library JAR annotations are not read, you cannot use the annotations of the classes included in the library JAR. For example, if a class included in a library JAR is specified as an interceptor in a class within an Enterprise-Bean application, the annotations of the invocation destination class (such as @PostConstract) are disabled. Therefore, do not operate an invocation destination class as an interceptor.

The annotation read before you set up this property is stored during import operation. Therefore, after you change the settings, you must stop, delete, and then re-import the application.

true
09-50
12.3 Classes to be loaded and the class path required for loading in Common Container Functionality Guide

ejbserver.deploy.app.stopforcibly.disabled
Specify whether to disable forced termination of a J2EE application.

If you specify true:

Forced termination of a J2EE application will be disabled.

If you specify false:

Forced termination of a J2EE application will be enabled.

false
--

ejbserver.deploy.annotations.load_check.enabled
Specify whether to ignore the exceptions occurred when loading the classes for acquiring the annotation information.

If you specify true:

An error will occur and the processing will be interrupted.

If you specify false:

The exception log will be acquired and the processing will continue.

(For new installation)
false

(For update, from the version earlier than 07-60)
true

08-00
12.3 Classes to be loaded and the class path required for loading in Common Container Functionality Guide

ejbserver.deploy.context.check_interval
Specify an integer (units: seconds) from 0 to 2147483647​ for the interval to detect an update in the application setup file.
If you specify a numeric character other than 0 and 1 to 2147483647​, automatic reloading is performed. Only command reload is accepted.
0
--

ejbserver.deploy.context.reload_scope

app:

The reload functionality is used in EJB application, servlet, and JSP.

jsp:

The reload functionality is used in JSPs.

none

The reload functionality is not used.

web:

The reload functionality is used in JSPs.

Other than above:

The default value is specified.

app
--

ejbserver.deploy.context.update.interval
Specify an integer (units: seconds) from 0 to 2147483647​ for the standby time for update of an application setup file.
If you specify a numeric character other than 0 or 1 to 2147483647​, it is assumed that there is no standby time.
0
--

ejbserver.deploy.exclusive.lockAliveInterval
Specify an integer (units: seconds) from 1 to 2147483647​ for the maximum standby time until the receipt of the next response sent from a command after the completion of server processing.
The commands affected by this property are those classified as update, reference and privilege, from among the commands used in a J2EE server. The commands classified into update, reference and privilege can be checked in the list of commands used in J2EE servers. For details on the commands used in a J2EE server, see 2. Commands to be used in J2EE Server in the uCosminexus Application Server Command Reference Guide.
If you specify an invalid value, a warning message is output and the default value will be set.
If there is no communication from the command side even after the specified time, the server assumes invalid termination of the command and forcibly cancels command exclusion.
The standby time is the total of the time that a command requires to go to and return from the servers and the processing time of the command.
60
--

ejbserver.deploy.resourcefile.scramble.enabled
Specify whether to scramble the DD files related to DataSource, JavaMail, and ResourceAdapter that are expanded below the working directory. Even if the value of this property is switched and the J2EE server is started, the status of the DD files of the resource that is already imported or deployed does not change, as long as the definition information is not updated.

If you specify true:

Scrambling will be performed.

If you specify false:

Scrambling will not be performed.

false
--

ejbserver.deploy.session.work.directory
Output the session information file of a Web application in the directory present below the set ejbserver.deploy.session.work.directory-property-value\web\context-root-name.

In Windows
Cosminexus-installation-directory\CC\server\repository\server-name

In UNIX
Cosminexus-installation-directory/CC/server/repository/server-name

--

ejbserver.deploy.stub.generation.scope
Specify the target range for generating the classes required for communication, such as stub. Specify ejb during new installation and app during upgradation.

ejb:

Generate classes required for communication, such as stub, from the home interface and component interface specified in DD of EJB-JAR.

app:

Generate classes required for communication, such as stub, from the classes that inherit java.rmi.Remote of EJB-JAR and WAR.

Other than above:

The KDJE42257-W message is output and default value is specified, when the server is started.

ejb
--

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

(k) Keys beginning with ejbserver.distributedtx

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.distributedtx.enableXidReuseOptimization
Specify whether to optimize the reuse of XID in the 1.4 mode.

If you specify true:

XID will be reused and optimized.

You can improve the transaction management performance by setting true, when two or more connections of the same resource manager are not used from within the transaction.

If you specify false, or you do not specify a property, or if you specify an invalid value:

XID will not be reused.

false
--

ejbserver.distributedtx.ots.recoverFailMessageCount
Specify after how many retries in scanning unconcluded transactions would the KFCB40139-W message be displayed. Specify the value using an integer from 0 to 2147483647​.
Application Server scans unconcluded transactions for the resource manager participating in a transaction during transaction recovery executed when a J2EE server starts or when a communication failure occurs while a transaction is being concluded. If scanning fails, the Application Server continues to retry infinitely until the scanning process is successful; however, when the scanning of unconcluded transactions executed for resource adapters continues and fails for the number of times specified in this property, the KFCB40139-W message is displayed.
Note that the unconcluded transactions are re-scanned every 5 seconds.
If you specify 0, the KFCB40139-W message is not displayed even if the scanning of the unconcluded transactions fails several times. If you specify 1, the KFCB40139-W message is displayed if scanning fails once. (The KFCB40139-W message is not displayed when scanning fails on the second and subsequent attempts. However, if the scanning is successful once, or if the J2EE server is stopped, the count is reset. In this case, the KFCB40139-W message is displayed when the scanning fails once the next time).
If you specify a value of 1 or more in this property, you can identify the inability to connect to a participating resource manager at an early stage. However, when you perform an operation in which a resource is started after starting the Application Server, the KFCB40139-W message might be displayed even for a normal operation.
0
08-70

ejbserver.distributedtx.ots.status.directory1#
Specify the directory for saving the backup of the status file of in-process transaction service and the status file used as maintenance data. You use a forward slash (/) as the path delimiter. If you specify a relative path, it indicates the path from the following directory:

In Windows:

Cosminexus-working-directory\ejb\server-name

In UNIX:

Cosminexus-working-directory/ejb/server-name

otsstatus
--
3.4 Managing transactions in Common Container Functionality Guide

ejbserver.distributedtx.ots.status.directory2#
When replicating the status file of in-process transaction service, specify a directory that stores the backup of spare status files and the spare status files used as maintenance data. You use a forward slash (/) as the path delimiter.
If you specify a relative path, the path will be from the execution directory of J2EE applications.
You must specify a different directory to avoid overlapping with other J2EE servers or J2EE application processes running on the same machine.
If you do not specify this property, a spare status file will not be created, and therefore, the status file does not get replicated.
None
--
3.4 Managing transactions in Common Container Functionality Guide

ejbserver.distributedtx.recovery.completionCheckOnStopping.timeout
Specify a number from -1 to 2147483647​ (units: seconds) for the timeout value to check whether the running transaction is complete, which is performed when using a global transaction and stopping the J2EE server and when using the Transacted Delivery functionality and stopping the J2EE application. However, the timeout does not occur in the following cases:

When -1 is specified

When an invalid string is specified

When this key is not specified

In the above cases, the termination of the J2EE server or J2EE application is postponed infinitely, until it can be confirmed that there are no unconcluded transactions as recognized by the J2EE server or the resource manager.
If you specify an integer from 0 to 2147483647​, the transaction completion check times out when the specified time (seconds) elapses and the J2EE server or J2EE application stops even if it cannot be confirmed that there are no unconcluded transactions.
To guarantee ACID of transactions when an application is running, you need to specify the settings where the timeout will not occur. You can specify the timeout settings, when convenience is given priority over ACID of transactions, during development of an application.
-1 (no timeout)
--

ejbserver.distributedtx.recovery.port
Specify an integer from 1 to 65535 for the fixed port number used for transaction recovery when a global transaction is used in 1.4 mode. If you specify an invalid value or if the specified port is already being used, the invocation process is interrupted. If a light transaction is invoked considering it as valid, this property is ignored.
20302
--

ejbserver.distributedtx.rollbackClientTxOnSystemException
Specify whether to mark an invoked client transaction for roll back, when a system exception occurs.

If you specify true:

The client transaction will be marked for roll back.

If you specify false:

The client transaction will not be marked for roll back.

If you do not specify the property or if you specify an invalid value, false will be set.
This property is enabled only in either of the following two cases, when the J2EE server is running in the 1.4 mode: When you start a client transaction, invoke the EJB (that implements the remote interface of J2EE server) by using the optimization for local invocation, and start a new transaction on the invoked EJB when you do not start the client transaction.
false (true, in the case of overwrite installation from 1.4 mode)
--

ejbserver.distributedtx.XATransaction.enabled
Specify whether to use a global transaction in the 1.4 mode.

If you specify true:

The light transaction functionality will be disabled and global transaction can be used.

If you specify false:

The light transaction functionality will be enabled and the environment will be optimized to the local transaction. The global transaction, however, cannot be used.

false
--

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

Note:

In the status file of in-process transaction service, a host name or an IP address is incorporated as the identification information of the J2EE server. As a result, you need to stop the J2EE server to change the host name or the IP address. Change the host name or IP address of the storage directory of status file, when customizing the operation settings of the J2EE server. For details about customization of the operation setup for J2EE servers, see 3.15.13 Settings in execution environment in the manual uCosminexus Application Server Common Container Functionality Guide.

(l) Keys beginning with ejbserver.DynamicStubLoading

The following table lists the specifiable key. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.DynamicStubLoading.Enabled
Specify whether to use dynamic class loading.

If you specify false:

Dynamic class loading will not function. Download the stub of EJB object, the stub of EJBHome object, or the stub of business interface reference, and specify in the user class path of the EJB client.

If you specify true:

Dynamic class loading will function. You need not specify the stub of EJB object, the stub of EJBHome object, or the stub of business interface reference, in the user class path of the EJB client.

false
--

Legend:

--: Indicates a version earlier than the version 08-00.

(m) Keys beginning with ejbserver.ejb

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.ejb.cmp20.cmr.use.existing_table
This option uses the existing CMR table during deployment. Generally, a CMR table is generated during deployment so there is no need to use the existing CMR table. However, when recovering from an error, specify this option temporarily.

If you specify false:

If a CMR table already exists during deployment, it will result in an error.

If you specify true:

The existing CMR table will be used during deployment.

false
--

ejbserver.ejb.timerservice.maxCallbackThreads
Specify an integer from 1 to 100 for the maximum number of threads that call back the timeout method in TimerService, in the entire J2EE server.
1
--

ejbserver.ejb.timerservice.retryCount
Specify an integer from 0 to 2147483646​ for the maximum frequency for retrying to call back the timeout method in TimerService.
1
--

ejbserver.ejb.timerservice.retryInterval
Specify an integer (units: seconds) from 1 to 604800 for the interval for retrying to call back the timeout method in TimerService.
5
--

Legend:

--: Indicates a version earlier than the version 08-00.

(n) Keys beginning with ejbserver.ext

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.ext.method_observation.interval
If this property is set, it implies:

Specify whether to use the functionality for monitoring the J2EE application execution time.

Specify an integer (units: seconds) from 0 to 86400 as the time interval for monitoring whether a request that is being processed has timed out and the time interval for canceling the timed out request (method).

If you specify 0:

The functionality for monitoring the J2EE application execution time is not used. The timeout is also not monitored.

If you specify a valid value other than 0:

The functionality for monitoring the J2EE application execution time is used. The timeout and method cancellation are executed with different threads, in the specified time interval.

If you specify an invalid value other than the above:

The default value is specified.

0
--
5. Operating the J2EE Applications in Operation, Monitoring, and Linkage Guide

Legend:

--: Indicates a version earlier than the version 08-00.

(o) Keys beginning with ejbserver.http

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.http.port
Specify an integer from 1 to 65535 for the port number of the simple Web server.
You cannot specify a port number that is already being used in or secured for another application. Furthermore, do not specify the same value in port numbers of the ports to be used to communicate with the Web server in multiple J2EE servers. The cjstartsv command cannot start up multiple J2EE servers in which identical port numbers are specified.
8080
--

Legend:

--: Indicates a version earlier than the version 08-00.

(p) Keys beginning with ejbserver.instrumentation

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.instrumentation.enabled
Specify whether to integrate with the Management Server.

If you specify true:

Integration with the Management Server will become possible.

If you specify false:

Integration with the Management Server will not be possible.

true
--

Legend:

--: Indicates a version earlier than 08-00.

(q) Keys beginning with ejbserver.jca

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Contents | Default value | VR
ejbserver.jca.adapter.tp1.bind_host | Specify the IP address or host name used for communication (receipt and dispatch) in the TP1 inbound integrated function. However, if you cannot resolve the address when the host name is specified, use the default value. | Valid local address selected automatically by the system | 08-50

(r) Keys beginning with ejbserver.jndi

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.jndi.cache
Specify whether to perform caching in naming.
Specify ON if caching is to be performed, and OFF if caching is not to be performed.
on
--

ejbserver.jndi.cache.interval
Specify the interval (units: seconds) to clear a cache, when caching is done in naming.
If you specify a value other than a number from 1 to 2147483647​, the cache is not cleared.
0
--

ejbserver.jndi.cache.interval.clear.option
Decide the operations to be performed in the cache area of naming, after the lapse of the interval.

If you specify refresh:

Clear the entire cache area.

If you specify check:

Clear the invalid cache. If you use CTM, the object reference of the EJB home object in the cached global COBRA Naming Service will not be cleared as an invalid cache, even when you stop the application. For details, see 2.8.4 Notes on caching in naming in the manual uCosminexus Application Server Common Container Functionality Guide.

refresh
--

ejbserver.jndi.cache.reference
Specify whether to use the caching functionality of DataSource object.

If you specify ON:

The caching functionality of DataSource object is enabled and the same instance is returned when there is a search request.

If you specify Off or an invalid string:

The operation is performed as normal and a different instance is returned for each search process.

off
--

ejbserver.jndi.global.enabled
Specify whether to register an object using the Portable Global JNDI name for the naming service, when starting the application.

If you specify true:

The object will be registered using the Portable Global JNDI name.

If you specify false:

The object will not be registered using the Portable Global JNDI name.

true
09-00

ejbserver.jndi.namingservice.group.specify-group-name.providerurls
Specify the root position of naming services belonging to each group, with a provider URL.
In specify-group-name, specify the group name that has been specified in ejbserver.jndi.namingservice.group.list.
Code the provider URL by using the URL schema "corbaname".

Specification format:

provider-URL[;provider-URL]*
None
--

ejbserver.jndi.namingservice.group.list
Define the group of logical naming service that is to be searched during the round-robin search. The group name to be specified consists of alphanumeric characters (A-Z, a-z, 0-9) or underscores (_), and can be clearly identified in ejbserver.jndi.namingservice.group.list.

Specification format:

specify-group-name(;specify-group-name)*

Note that * indicates iteration.
None
--

ejbserver.jndi.request.timeout
Specify an integer from 0 to 86400 for the timeout period (units: seconds) of communication with the naming service. If you specify 0, or if this property is not specified, the timeout does not occur. If a value greater than 86400 is set, a warning message is output and the timeout does not occur.
0
--

Legend:

*: Indicates iteration of the part within brackets (()).

--: Indicates a version earlier than the version 08-00.

(s) Keys beginning with ejbserver.jpa

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.jpa.defaultJtaDsName
Specify the default JTA data source references. This property is used when jta-data-source is not specified in persistence.xml or when a space is specified.
None
08-00

ejbserver.jpa.defaultNonJtaDsName
Specify the default non-JTA data source references. This property is used when non-jta-data-source is not specified in persistence.xml or when a space is specified.
None
08-00

ejbserver.jpa.defaultProviderClassName
This property specifies the default JPA provider class name. This property is used when provider is not specified in persistence.xml or when a space is specified.
com.hitachi.software.jpa.PersistenceProvider
08-00

ejbserver.jpa.disable#
Specify this property when using the JPA functionality of Application Server.

If you specify true:

The JPA functionality of Application Server is disabled.

If you specify false:

The JPA functionality of Application Server is enabled.

false
08-20

ejbserver.jpa.overrideJtaDsName
Specify the JTA data source references that will be used with a higher priority than the values specified in jta-data-source in persistence.xml and the values specified in ejbserver.jpa.defaultJtaDsName.
None
08-00

ejbserver.jpa.overrideNonJtaDsName
Specify the non-JTA data source references that will be used with a higher priority than the values specified in non-jta-data-source in persistence.xml and the values specified in ejbserver.jpa.defaultNonJtaDsName.
None
08-00

ejbserver.jpa.overrideProvider
Specify the JPA provider class name that will be used with a higher priority than the values specified in provider in persistence.xml and the values specified in ejbserver.jpa.defaultProviderClassName.
None
08-00

ejbserver.jpa.emfprop.property-key
Specify the JPA provider-specific property keys. When all the persistence units are deployed, the properties with the prefix ejbserver.jpa.emfprop. removed will be passed to the JPA provider.
None
08-00

# Notes for specifying ejbserver.jpa.disable=true

If the application includes persistence.xml, Application Server does not read persistence.xml when the application starts. Also, if you are using the reload functionality of the application, update detection is not performed for persistence.xml.

If the application is using a managed persistent context or persistent unit of Application Server, you will not be able to start the application.

(t) Keys beginning with ejbserver.jta

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.jta.TransactionManager.defaultTimeOut
Specify the default value (units: seconds) for the transaction timeout of the transactions started on a J2EE server, in the following range:

In 1.4 mode:

1 to 2147483647​

180
--

Legend:

--: Indicates a version earlier than the version 08-00.

(u) Keys beginning with ejbserver.logger

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.logger.channels.define.DevelopmentLogFile.filenum
Specify an integer from 1 to 6 for the number of log files to be output with the development check log functionality for J2EE servers.
4
09-00

ejbserver.logger.channels.define.DevelopmentLogFile.filesize
Specify an integer from 4096 to 2147483647​ for the size of log files to be output with the development check log functionality for J2EE servers (unit: bytes).
1048576​
09-00

ejbserver.logger.DevelopmentLogFile.level
Specify the log output level of the development check log functionality for J2EE servers.
We recommend that you set up the INFO level during development. If you require more detailed information than the INFO level in order to investigate the errors in the application being developed, specify a level to output a more detailed log.
You can specify the following values. The values are listed in order of the amount of information to be output from smallest to largest.

OFF (log is not output)

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ALL (Entire log is output)

OFF
09-00

ejbserver.logger.channels.define.channel-name#.filenum
Specify an integer from 1 to 16 for the number of log files of a J2EE server.

16, when the channel name is WebAccessLogFile

4, when the channel name is MaintenanceLogFile or WebServletLogFile

2, when the channel name is other than above

--

ejbserver.logger.channels.define.channel-name#.filesize
Specify an integer from 4096 to 2147483647​ (units: bytes) for the size of the log files of a J2EE server.

2097152​, when the channel name is WebAccessLogFile

16777216​, when the channel name is MaintenanceLogFile

4194304​, when the channel name is WebServletLogFile

1048576​, when the channel name is other than above

--

ejbserver.logger.enabled.*
Specify the log level of a J2EE server. Specify either one or more from among Error, Warning, Information and Debug. If you specify only one log level, only the log of the applicable log level is output. When specifying more than one log levels, demarcate each level-name string with a comma (,). Normally, use the default value.
Error
--

ejbserver.logger.systemlog.enabled
Specify whether to output the log of messages about invocation, stopping and abnormal termination of a J2EE server, to the event log (syslog in UNIX).

If you specify true:

The log will be output to event log (syslog in UNIX).

If you specify false:

The log will not be output in event log (syslog in UNIX).

true
--

ejbserver.logger.rotationTime
Specify the time for switching the file to which the J2EE server log is output, in the HHMMSS format.
If the time is not specified, the output destination is switched using the log file size.
Note that even if this key is specified, the file size specification is valid. The output destination files are switched when the time specified in this key is reached or when the output destination file reaches the specified file size.
None
09-00
3. Preparations for Troubleshooting in Maintenance and Migration Guide

ejbserver.logger.rotationStyle
Specify the rules for naming a file when the file to which the J2EE server log will be output is switched.

If you specify SHIFT:

The file will be named in the shift mode.

The total number of files is equal to the specified number of output destination files + 1 (the current output destination files).

If you specify WRAP:

The file will be named in the wraparound mode.

WRAP
09-00
3. Preparations for Troubleshooting in Maintenance and Migration Guide

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

#:

You can set the following names as channel name:

Channels for output of Cosminexus system log:
MessageLogFile, MaintenanceLogFile, ExceptionLogFile, ConsoleLogFile, EJBContainerLogFile, WebContainerLogFile, WebServletLogFile, UserOutLogFile, UserErrLogFile, WebAccessLogFile, JPAOperationLogFile, JPAMaintenanceLogFile

Channels for output of resource depletion monitoring log
MemoryWatchLogFile, FileDescriptorWatchLogFile, ThreadWatchLogFile, ThreaddumpWatchLogFile, RequestQueueWatchLogFile, HttpSessionWatchLogFile, ConnectionPoolWatchLogFile

For details about the acquisition of documents, see 2.3 Acquiring data in the manual uCosminexus Application Server Maintenance and Migration Guide.

(v) Keys beginning with ejbserver.management

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled
Specify whether to enable the monitoring of the frequency of full garbage collection.

true:

Enable.

false:

Disable.

true
--

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold
Specify an integer from 1 to 2147483647​ for the frequency that acts as the threshold value when monitoring the frequency of full garbage collection.
10
--

ejbserver.management.JVM.stats_monitor.FullGCCount.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the threshold value-monitoring interval when monitoring the frequency of full garbage collection.
600
--

ejbserver.management.statistics.interval
Specify an integer from 1 to 86400 (units: seconds) for the statistics collection interval.
60
--

ejbserver.management.stats_file.base_time
Specify an integer from 0 to 1439 (units: minutes) as the base time for the time switching operation of the statistics file, by incrementing from the local time 1970-01-01 00: 00: 00.
When the local time 1970-01-01 hh: mm is taken as the base, specify h60+m.
0
--

ejbserver.management.stats_file.dir
Specify the directory to output the statistics file. When changing the output destination directory, specify a separate directory for each J2EE server.

In Windows
Cosminexus-working-directory\ejb\server-name\stats

In UNIX
Cosminexus-working-directory/ejb/server-name/stats

--

ejbserver.management.stats_file.enabled
Specify whether to enable the functionality to output the statistics file.

true:

Enable.

false:

Disable.

true
--

ejbserver.management.stats_file.num
Specify an integer from 2 to 168 for the number of statistics file.
7
--

ejbserver.management.stats_file.period
Specify an integer from 1 to 744 (units: hours) for the switching period in the time switching operation of the statistics file.
24
--

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.enabled
Specify whether to enable the monitoring of the total pending request count for Web containers.

true:

Enable.

false:

Disable.

true
09-00

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.high_threshold
Specify an integer from 1 to 100 (unit: %) as the percentage when a message is output to convey that the percentage of the total pending request count for Web containers has reached the warning level. Specify a value of ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.low_threshold or more.
If the percentage of the total pending request count for Web containers is greater than the specified value, the message is displayed.
If you specify 100, an alert message is displayed when the storage ratio of the total pending request count for Web containers becomes 100%.
80
09-00

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.low_threshold
Specify an integer from 0 to 99 (unit: %) as the percentage when a message is output to convey that the percentage of the total pending request count for Web containers has reached the normal level. Specify a value of ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.high_threshold or less.
If the percentage of the total pending request count for Web containers is less than the specified value, the message is displayed.
If you specify 0, an alert message is displayed when the storage ratio of the total pending request count for Web containers becomes 0%.
0
09-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.enabled
Specify whether to enable the monitoring of the pending request count for Web containers.

true:

Enable.

false:

Disable.

true
09-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.high_threshold
Specify an integer from 1 to 100 (unit: %) as the percentage when a message is output to convey that the percentage of the pending request count for Web containers has reached the warning level. Specify a value of ejbserver.management.webcontainer.stats_monitor.waiting_request_count.low_threshold or more.
If the percentage of the pending request count for Web containers is greater than the specified value, the message is displayed.
If you specify 100, an alert message is displayed when the storage ratio of the pending request count for Web containers becomes 100%.
80
09-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.low_threshold
Specify an integer from 0 to 99 (unit: %) as the percentage when a message is output to convey that the percentage of the pending request count for Web containers has reached the normal level. Specify a value of ejbserver.management.webcontainer.stats_monitor.waiting_request_count.high_threshold or less.
If the percentage of the pending request count for Web containers becomes less than the specified value, the message is displayed.
If you specify 0, an alert message is displayed when the storage ratio of the pending request count for Web containers becomes 0%.
0
09-00

Legend:

--: Indicates a version earlier than the version 08-00.

(w) Keys beginning with ejbserver.manager

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.manager.agent.Agent.conf
Specify the settings required for integrating with the Management Server. The Management Server automatically sets these contents in a J2EE server. For details on the contents set up automatically by the Management Server in a J2EE server, see Appendix E.5 Contents set up automatically by the Management Server in a J2EE server in the uCosminexus Application Server System Setup and Operation Guide.
None
--

ejbserver.manager.agent.Agent.enabled
Specify the settings required for integrating with the Management Server. The Management Server automatically sets these contents in a J2EE server. For details on the contents set up automatically by the Management Server in a J2EE server, see Appendix E.5 Contents set up automatically by the Management Server in a J2EE server in the manual uCosminexus Application Server System Setup and Operation Guide.
false
--

ejbserver.manager.agent.JP1EventAgent.conf
Specify the path of the setup file for JP1 integration.
None
--

ejbserver.manager.agent.JP1EventAgent.enabled
Specify whether to integrate with JP1.
false
--

ejbserver.manager.jp1event.event_server_name
Specify a value similar to the address of the ports parameter that is specified in the event server setup file (conf) of the event service of JP1/Base in use. If multiple addresses are specified in the ports parameter, specify any one of the specified addresses. If you use an event service, wherein "0.0.0.0" (default value) is specified in the address of the ports parameter, either omit this key or specify the host name of the local machine or localhost.
localhost
--

ejbserver.manager.agent.MEventAgent.conf
Specify an absolute path for the property file for issuing the Management event. If you do not specify the property file, or if the specified file does not exist, the Management event is not issued.
For details on property file for issuing the Management event, see 10.12 Property file for issuing Management events.
None
--

ejbserver.manager.agent.MEventAgent.enabled
Specify whether to enable the functionality for issuing the Management event.

If you specify true:

The functionality for issuing the Management event will be enabled.

If you specify false:

The functionality for issuing the Management event will be disabled.

If you specify an invalid value, the default value will be set.
false
--

Legend:

--: Indicates a version earlier than the version 08-00.

(x) Keys beginning with ejbserver.naming

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.naming.exec.args
Specify the runtime option added in the CORBA Naming Service that is invoked when the CORBA Naming Service is used in the automatic invocation mode (ejbserver.naming.startupMode=automatic or inprocess). Generally, there is no need to set a value in this property. This property is used to determine, take action and avoid any failures in the CORBA Naming Service, when the CORBA Naming Service is used in the automatic invocation mode.
For the runtime option, specify the string in the format that is specified in the command line argument of nameserv (specify by adding -J at the beginning of each property and demarcating with a space. It is actually specified in one line).
(Example of specification)

ejbserver.naming.exec.args=-J-Dvbroker.se.iiop_tp.scm.iiop_tp.listener.port=900
-J-Dvbroker.agent.enableLocator=false

If, however, the CORBA Naming Service is used in the in-process mode, you cannot specify the following properties:

javax.rmi.CORBA.StubClass

javax.rmi.CORBA.UtilClass

javax.rmi.CORBA.PortableRemoteObjectClass

vbroker.serverManager.name

vbroker.orb.enableServerManager

vbroker.agent.enableLocator

vbroker.se.iiop_tp.host

This property value is given priority over the values specified in ejbserver.naming.port and vbroker.agent.enableLocator property. If, however, the same property as that specified in ejbserver.naming.exec.args is set in the system properties when the CORBA Naming Service is invoked in the in-process mode, the information set in the system properties is given priority.
For details about the properties that you can specify when executing the CORBA Naming Service, see the manual Borland(R) Enterprise Server VisiBroker(R) Developers Guide and the manual Borland(R) Enterprise Server VisiBroker(R) Programmers Reference.
None
--

ejbserver.naming.host
Specify the host name or the IP address that invoke the CORBA Naming Service that the J2EE server uses.
When using the name switching functionality, do not use "localhost" as the host name. Specify the host name or the IP address that the CORBA Naming Service invokes.
If the CORBA Naming Service is used in the automatic invocation mode (ejbserver.naming.startupMode=automatic or in-process), specify either the default value ("localhost"), or the host name or IP address that starts the J2EE server.
localhost
--

ejbserver.naming.nameroot
Specify a name when the name is added to the CORBA Naming Service that is invoked, when the CORBA Naming Service is used in the automatic invocation mode (ejbserver.naming.startupMode=automatic or in-process). Specify the name with a string consisting of alphanumeric characters (A-Z, a-z, 0-9) or underscores (_). This name is used in the parameters of the nsutil command of VisiBroker.
If a name is not specified, the name "NameService" is automatically set in VisiBroker.
For details about how to use the nsutil command, and also about its usage conditions, see the manual Borland(R) Enterprise Server VisiBroker(R) Developers Guide.
None
--

ejbserver.naming.port
Specify an integer from 1 to 65535 for the port numbers of the CORBA Naming Service that the J2EE server uses. You cannot specify a port number that is already being used by another application. If the J2EE server is started by specifying a port number that is already being used by another application, the invocation process might not be finished.
900
--

ejbserver.naming.protocol
Specify the access protocol to the CORBA Naming Service that is used in the J2EE servers. Currently, this key supports only corbaname. You can, however, perform the operations even with the protocols (iioploc or iiopname) that were in use in the older versions.
corbaname
--

ejbserver.naming.startupMode#
Specify the invocation mode of the CORBA Naming Service.

If you specify manual:

Specify when the CORBA Naming Service is to be used in manual invocation mode.

Before starting the J2EE server, you need to manually start the CORBA Naming Service.

When starting the J2EE server, manually specify the CORBA Naming Service that is specified in ejbserver.naming.host and ejbserver.naming.port. When you specify this property value, the CORBA Naming Service is not invoked automatically from the invocation process of the J2EE server.

If you specify automatic:

Specify when CORBA Naming Service is to be used in the automatic invocation mode.

When a J2EE server is started, the CORBA Naming Service starts automatically as out-process.

In this mode, the CORBA Naming Service also stops automatically, when the J2EE server is shut down. If, however, the CORBA Naming Service specified in ejbserver.naming.port is already running on the local host when the J2EE server is started, that CORBA Naming Service will be used without performing the automatic start process. In this case, the CORBA Naming Service does not stop automatically when the J2EE server is shut down.

If you specify in-process:

Specify when CORBA Naming Service is to be used in the automatic invocation mode.

This is the mode in which the CORBA Naming Service is automatically started as an in-process, when the J2EE server is started. If the CORBA Naming Service specified in ejbserver.naming.port is already running on the local host when the J2EE server is started, an error message is output and the invocation process of the J2EE server fails.

In the case of new installation in 06-00 and later:
inprocess

In the case of version upgrade:
The existing specified value is set. If nothing is set, manual is set.

--

ejbserver.naming.startupRetryCount
If the CORBA Naming Service still does not start after the lapse of invocation wait time of the CORBA Naming Service that is specified in ejbserver.naming.startupWaitTime, specify an integer from 0 to 2147483647​ for the iteration frequency to await invocation only for the number of seconds specified in ejbserver.naming.startupWaitTime.
If you specify 0, the process for checking invocation status of the CORBA Naming Service is not retried
If you specify 0 in ejbserver.naming.startupWaitTime, this property value is invalid.

In the case of new installation in 06-00 and later:
9

In the case of version upgrade:
0

--

ejbserver.naming.startupWaitTime
Specify an integer from 0 to 2147483647​ for the standby time (units: seconds) until the CORBA Naming Service becomes available when a J2EE server is started. When you specify 0, invocation of the CORBA Naming Service is not awaited.
If inprocess is set in ejbserver.naming.startupMode, do not specify 0.

In the case of new installation in 06-00 and later:
1

In the case of version upgrade:
0 is set when the manual mode is used.
If the automatic mode is used and this property value has been set, the existing specified value becomes the default value. If you do not specify any value, the value is assumed to be 10.

--

Legend:

--: Indicates a version earlier than the version 08-00.

#

If the J2EE server is started by using the Management Server, do not specify automatic. If you specify automatic, the CORBA Naming Service process is no longer monitored by the operation support functionality of TPBroker and is not restarted even if the process is down.

(y) Keys beginning with ejbserver.rmi

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.rmi.localinvocation.scope
Specify the scope of the functionality for optimizing local invocation.

If you specify none:

There is no scope. This is specified for compatibility, in the case of upgrading a version.

If you specify app:

The contents of the same application are included in the scope.

If you specify all:

The contents of the same J2EE server are included in the scope.

app
--

ejbserver.rmi.logger.filenum
Specify an integer from 2 to 16 for the number of RMI communication log files of a J2EE server.
If you specify a non-numeric value, or a numeric value outside the range, or if you do not specify a string, a message is output and the default value will be set.
4
--

ejbserver.rmi.logger.filesize
Specify an integer from 8192 to 2147483647​ (units: bytes) for the size of the RMI communication log files of a J2EE server.
1048576​
--

ejbserver.rmi.naming.host
Specify the host name or the IP address of the RMI registry and MBean server that the J2EE server uses in a multi-homed host environment. The specified single-byte alphabets are not case-sensitive.
None
--

ejbserver.rmi.naming.port
Specify an integer from 1 to 65535 for the port number of RMI registry used by the J2EE server. You cannot specify a port number that is already being used by another application. If the J2EE server is started by specifying a port number that is already being used by another application, the invocation process may not finish.
23152
--

ejbserver.rmi.passbyreference#
If you specify true, the arguments and the return value are not passed by value but are passed by reference, by invoking the EJB method that contains the remote interface. If, however, the range specified in ejbserver.rmi.localinvocation.scope is exceeded when invoking the EJB method, the pass-by-reference functionality becomes disabled.
With the help of pass-by-reference, you can reduce the cost generated by copying the value, but, you need to be careful as the original value can be changed by using the reference that has been passed.
false
--

ejbserver.rmi.remote.listener.port
You can specify optional values to fix the request reception port for the statistics information acquisition by the JMX client (such as Administration Agent and JP1/Performance Management - Agent Option for uCosminexus Application Server). Specify an integer from 0 to 65535.
You cannot specify a port number that is already being used by another application. If the J2EE server is started by specifying a port number that is already being used by another application, the invocation process may not finish.
When this property is not specified, or when 0 is specified as the value, random values will be set up.
0
--

ejbserver.rmi.request.timeout
Specify an integer from 0 to 86400 for the communication timeout period (unit: seconds) between the client and server.
If you specify 0, or if this property is not specified, the timeout does not occur. Note that if a value exceeding 86400 is set, a warning message is output, and there is no timeout.
0 (seconds)
--

ejbserver.rmi.stateless.unique_id.enabled
Specify whether the invocation of the remove method of Stateless Session Bean is required.

If you specify true:

The invocation of the remove method for the EJBObject of Stateless Session Bean is not required.

If you invoke the business method after invoking the remove method, the java.rmi.NoSuchObjectException exception does not occur and the business method is executed.

If you specify false:

The invocation of the remove method for EJBObject of the Stateless Session Bean is required.

If you invoke the business method after invoking the remove method, the java.rmi.NoSuchObjectException exception occurs.

false
--
4.3.1 Notes on implementing the Stateless Session Beans in EJB Container Functionality Guide

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

#

Pass-by-reference can also be set in the EJB from the server management commands.

(z) Keys beginning with ejbserver.server

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Default value
VR
Related information

ejbserver.server.eheap.ajp13.enabled
Specify whether to deploy the objects for communication with the redirector on the Explicit heap.

If you specify true:

The objects for communication with the redirector will be deployed on the Explicit heap.

If you specify false:

The objects for communication with the redirector will be deployed on the Java heap area.

However, if JavaVM option HitachiUseExplicitMemory is disabled, this property is disabled (same as for the case when false is specified).
true
08-00

ejbserver.server.eheap.httpsession.enabled
Specify whether to deploy the objects, stored in the HTTP session, on the Explicit heap.

If you specify true:

The objects stored in the HTTP session will be deployed on the Explicit heap.

If you specify false:

The objects stored in the HTTP session will be deployed on the Java heap area.

However, if JavaVM option HitachiUseExplicitMemory is disabled, this property is disabled (same as for the case when false is specified).
true
08-00

ejbserver.server.j2ee.feature
Specify the operation mode of Component Container.

1.4
This is the mode, wherein the advanced functionality of J2EE1.4 has been added (Applicable in a system that uses all types of resources, including DB, in a transaction)
To use the mode in which the advanced functionality of J2EE1.4 has been added, you will need a transaction management server and therefore, as compared to the basic mode (compatible functionality), large amount of CPU or memory resources are required.

1.4
--

ejbserver.server.mutex.invocation.timeout
Specify an integer from 45 to 92233720368547758​ for the exclusive timeout period (units: seconds) required to concurrently access the Entity Beans of the same primary key. Specify the timeout period above the default value (45 seconds) and below the java.lang.Long.MAX_VALUE/1000 (seconds). If you specify a value lesser than the default value, the timeout period is considered as 45 (seconds).
If you specify a value greater than java.lang.Long.MAX_VALUE/1000 (seconds), the timeout period is considered as java.lang.Long.MAX_VALUE (milliseconds). Similarly, if you specify a value greater than java.lang.Long.MAX_VALUE, the default value is considered.
45
--

ejbserver.server.prf.PRFID
Specify the PRF identifier.
If you specify a PRF identifier when the PRF daemon is invoked, specify the same PRF identifier.
If the PRF identifier is omitted when invoking the PRF daemon, do not specify the PRF identifier. If the PRF identifiers do not match, the performance analysis trace is not collected.
PRF_ID
--

ejbserver.server.threaddump.filenum
Specify an integer from 1 to 2147483647​ for the upper limit of the thread dump file count, when the J2EE server detects an error and voluntarily outputs the thread dump.
If you specify a value outside the range, the default value will be set.
If the environment variable JAVACOREDIR is specified, the current value is a total of the number of thread dump files in both the directory specified in the environment variable JAVACOREDIR and the default output destination directory (Windows: Cosminexus-working-directory\ejb\server-name, Unix: Cosminexus-working-directory/ejb/server-name).
If there is an external request to output the thread dump, the files of thread dump are output, regardless of the setting of this option. The following are examples of external requests to output the thread dump.

jheapprof command

cjdumpsv command

-fd specification of the cjstopsv command

Ctrl+Break (in Windows) in the execution console of J2EE server

Specifying the kill command -3 (SIGTERM) for a J2EE server process (in UNIX)

256
--
4. Monitoring Resource Depletion in the Operation, Monitoring, and Linkage Guide

Legend:

--: Indicates a version earlier than the version 08-00.

Blank cell: Related information does not exist.

(aa) Keys beginning with ejbserver.stateful

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.stateful.passivate.switch
Specify whether to use the functionality for passivating and activating the Stateful Session Bean.

If you specify true:

The functionality for passivating and activating the Stateful Session Bean will be used.

If you specify false:

The functionality for passivating and activating the Stateful Session Bean will not be used.

false
--

Legend:

--: Indicates a version earlier than the version 08-00.

(ab) Keys beginning with ejbserver.stdoutlog

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.stdoutlog.autoflush
Specify whether to enable the automatic flush functionality of the user output log and user error log.
The automatic flush functionality is the automatic flush option of java.io.PrintStream used for the output of user output log (user_out[n]log) and user error log (user_err[n].log).

If you specify true:

The automatic flush functionality will be enabled. This might cause performance degradation compared to when the functionality is disabled.

If you specify false:

The automatic flush functionality will be disabled. If a processing, such as java.io.PrintStream.print(), for which automatic flush of PrintStream class is not performed is executed, contents to be output to user output log and user error log might be stored in the buffer and compress the memory.

false
08-00

(ac) Keys beginning with ejbserver.watch

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.watch.defaultRequestQueue.enabled
Specify whether to enable the alert output to monitor pending queues of HTTP requests, in the case of the default pending queue.

If you specify true:

Alert output to monitor pending queues of HTTP requests will be enabled, in the case of the default pending queue.

If you specify false:

Alert output to monitor pending queues of HTTP requests will be disabled, in the case of the default pending queue.

true
--

ejbserver.watch.defaultRequestQueue.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the interval to monitor the pending queues of HTTP requests, in the case of the default pending queue.
30
--

ejbserver.watch.defaultRequestQueue.threshold
Specify an integer from 1 to 100 (units: %) for the threshold value to output alert messages. If the storage ratio of the default pending queue for the requests to be monitored exceeds the value specified in this key, an alert message will be output.
80
--

ejbserver.watch.defaultRequestQueue.writefile.enabled
Specify whether to output the results to monitor pending queues of HTTP requests to a file, in the case of the default pending queue.

If you specify true:

The results of monitoring the pending queues of HTTP requests will be output to a file, in the case of the default pending queue.

If you specify false:

The results of monitoring the pending queues of HTTP requests will not be output to a file, in the case of the default pending queue.

true
--

ejbserver.watch.enabled
Specify whether to enable the depletion monitoring of all the resources.

If you specify true:

Depletion monitoring of all the resources will be enabled.

If you specify false:

Depletion monitoring of all the resources will be disabled. In this case, though depletion monitoring of each resource is set to enable, depletion monitoring of all resources is disabled.

true (false, when version is upgraded from 06-00 or earlier version)
--

ejbserver.watch.fileDescriptor.enabled
Specify whether to enable the alert output for file descriptor monitoring. Note that file descriptor monitoring cannot be used in Windows and AIX.

If you specify true:

Alert output for file descriptor monitoring will be enabled.

If you specify false:

Alert output for file descriptor monitoring will be disabled.

true
--

ejbserver.watch.fileDescriptor.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the interval for monitoring file descriptor. Note that file descriptor monitoring cannot be used in Windows and AIX.
60
--

ejbserver.watch.fileDescriptor.threshold
Specify an integer from 1 to 2147483647​ for the threshold value to monitor the usage of a file descriptor. When the number of in-use file descriptors exceeds the threshold value, an alert will be output. Set the threshold value in the following manner:
The number of file descriptors that can be allocated in the OS processes# > Value acquired from the file descriptor estimation formula > File descriptor threshold value
#
On some platforms, the system may not have any upper limit.
Note that file descriptor monitoring cannot be used in Windows and AIX.
2147483647​
--

ejbserver.watch.fileDescriptor.writefile.enabled
Specify whether to output the results of file descriptor monitoring in a file. Note that file descriptor monitoring cannot be used in Windows and AIX.

If you specify true:

The results of file descriptor monitoring will be output in a file.

If you specify false:

The results of file descriptor monitoring will not be output in a file.

true
--

ejbserver.watch.memory.enabled
Specify whether to enable alert output of memory monitoring.

If you specify true:

Alert output of memory monitoring will be enabled.

If you specify false:

Alert output of memory monitoring will be disabled.

If you specify true, Hitachi recommends that you set up the following JavaVM options with the same value:

-XX:PermSize

-XX:MaxPermSize

When you set a different value, an alert might be output in the area expansion of the Permanent area.
true
--

ejbserver.watch.memory.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the memory-monitoring interval.
60
--

ejbserver.watch.memory.threshold
Specify an integer from 1 to 100 (units: %) for the threshold value to monitor the memory usage status. If signs of a full garbage collection are detected, an alert is output in any of the following conditions:

The ratio (value output for Rate1 of resource depletion monitoring information) of Tenured area consumption size with Tenured total size is more than the threshold value.

The ratio (value output for Rate2 of resource depletion monitoring information) of New area total size with Tenured area maximum free size is more than the threshold value.

The ratio (value output for Rate3 of resource depletion monitoring information) of Permanent area consumption size with Permanent area total size is more than the threshold value.

80
--

ejbserver.watch.memory.writefile.enabled
Specify whether to output the results of memory monitoring in a file.

If you specify true:

The results of memory monitoring will be output in a file.

If you specify false:

The results of memory monitoring will not be output in a file.

true
--

ejbserver.watch.thread.enabled
Specify whether to enable alert output of thread monitoring. Note that you cannot monitor the number of threads in Linux.

If you specify true:

Alert output of thread monitoring will be enabled.

If you specify false:

Alert output of thread monitoring will be disabled.

true
--

ejbserver.watch.thread.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the thread monitoring interval. Note that you cannot monitor the number of threads in Linux.
60
--

ejbserver.watch.thread.threshold
Specify an integer from 1 to 2147483647​ for the threshold value for monitoring the usage of threads. When the number of generated threads is greater than the threshold value, alert will be output. Set the threshold value in the following manner:
The number of threads that can be allocated in the OS processes#>Value acquired from the thread estimation formula>Thread threshold value
#
On some platforms, the system may not have any upper limit.
Note that you cannot monitor the number of threads in Linux.
2147483647​
--

ejbserver.watch.thread.writefile.enabled
Specify whether to output the results of thread monitoring to a file. Note that you cannot monitor the number of threads in Linux.

If you specify true:

The results of thread monitoring will be output to a file.

If you specify false:

The results of thread monitoring will not be output to a file.

true
--

ejbserver.watch.threaddump.enabled
Specify whether to enable alert output of thread dump monitoring.

If you specify true:

Alert output of thread dump monitoring will be enabled.

If you specify false:

Alert output of thread dump monitoring will be disabled.

true
--

ejbserver.watch.threaddump.interval
Specify an integer from 1 to 2147483647​ (units: seconds) for the intervals in the thread dump monitoring period.
30
--

ejbserver.watch.threaddump.threshold
Specify an integer from 1 to 100 (units: %) for the ratio of the threshold value for thread dump monitoring with respect to the maximum value.
When the ratio of the current value with respect to the maximum value of number of files of thread dump is greater than the threshold value, alert will be output.
If the environment variable JAVACOREDIR is specified, the current value is a total of the number of thread dump files in both the directory specified in the environment variable JAVACOREDIR and the default output destination directory.
80
--

ejbserver.watch.threaddump.writefile.enabled
Specify whether to output the results of thread dump monitoring to a file.

If you specify true:

The results of thread dump monitoring will be output to a file.

If you specify false:

The results of thread dump monitoring will not be output to a file.

true
--

Legend:

--: Indicates a version earlier than the version 08-00.

(ad) Keys beginning with ejbserver.webj2ee

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

ejbserver.webj2ee.connectionAutoClose.enabled
Specify whether to use the automatic close functionality, when the J2EE server operates in 1.4 mode. When the operating mode is basic mode (compatible functionality), this property is ignored and the automatic close functionality is disabled.

If you specify true:

The automatic close functionality will be enabled.

If you specify false:

The automatic close functionality will be disabled.

If you specify an invalid value, the default value will be set.
true
--

Legend:

--: Indicates a version earlier than the version 08-00.

(ae) Keys beginning with https

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Contents | Default value | VR
https.cipherSuites | Specify the recommended coding suite to be used in HttpsURLConnection.# | # | 09-00
https.protocols | Specify the protocol to be used in HttpsURLConnection.# | # | 09-00

#

For details about keys, see the JDC documentation.

(af) Keys beginning with java

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

java.naming.factory.initial
Specify the factory class for the implementation class of the context delegated by InitialContext of JNDI. The operation for each set value is as follows:

com.hitachi.software.ejb.jndi.InsContextFactory:

Specify this context when normal search functionality is used instead of the JNDI round-robin search functionality.

com.hitachi.software.ejb.jndi.GroupContextFactory:

Specify this context when the JNDI round-robin search functionality is used during execution of applications (EJB) in the J2EE server.

com.hitachi.software.ejb.jndi.InsContextFactory
--

Legend:

--: Indicates a version earlier than the version 08-00.

(ag) Keys beginning with vbj

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

vbj.java2iiop.jvm.maxHeapSize
Specify the maximum heap size of the java2iiop command that is invoked when a J2EE application is started.
Specify the value in the format that is accepted by the -Xmx and -Xms options of the java command. If you specify the value in any other format, the operation may not produce the desired results.
Specify as follows:

Specify a value from 2048 to 4294966272​. Specify a value greater than the value specified in vbj.java2iiop.jvm.minHeapSize.

When specifying in kilobytes, add the character 'k' or 'K'.

When specifying in megabytes, add the character 'm' or 'M'.

128m
--

vbj.java2iiop.jvm.minHeapSize
Specify the initial heap size of the java2iiop command that is invoked when a J2EE application is started.
Specify the value in the format that is accepted by the -Xmx and -Xms options of the java command. If you specify the value in any other format, the operation may not produce the desired results.
Specify as follows:

Specify a value from 1024 to the value specified by -Xmx.

When specifying in kilobytes, add the character 'k' or 'K'.

When specifying in megabytes, add the character 'm' or 'M'.

16m
--

Legend:

--: Indicates a version earlier than the version 08-00.

(ah) Keys beginning with vbroker

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Note

You cannot specify the Cosminexus TPBroker properties that are not described in the following table (if specified, the operations cannot be guaranteed).

Key name
Contents
Default value
VR

vbroker.agent.enableLocator
Specify whether to use the Smart Agent.
Normally, this property need not be set. You use the default settings for this key.
When the CTM linkage functionality is valid (true is specified to the ejbserver.ctm.enabled key) true is automatically set up when you start the J2EE server.
If the Smart Agent is required for any other purpose than above, set true.
Note that if true is set in this property, the Smart Agent needs to be invoked first.
For details about the Smart Agent, see the manual Borland(R) Enterprise Server VisiBroker(R) Programmers Reference.
false
--

vbroker.agent.port
Specify the port number of Smart Agent. For details, see the manual Borland(R) Enterprise Server VisiBroker(R) Programmers Reference.
14000
--

vbroker.ce.iiop.ccm.htc.readerPerConnection
Specify whether the closing of the connection will be controlled when a timeout occurs during the invocation of the EJB method defined as the remote interface.

If true is specified:

The closing of the connection when a timeout occurs will be controlled.

If false is specified:

The closing of the connection when a timeout occurs is not controlled.

false
09-50

vbroker.ce.iiop.ccm.htc.threadStarter
Specify whether to invoke the thread for managing the reply receiving threads. To set up vbroker.ce.iiop.ccm.htc.readerPerConnection=true, specify true.
false
09-50

vbroker.orb.htc.comt.entryCount
Specify a value from 100 to 30000000​ for the upper-limit of the entry count in one communication trace file of Cosminexus TPBroker.
120000
--

vbroker.orb.htc.comt.fileCount
Specify a value from 1 to 256 for the upper-limit of the communication trace file count for Cosminexus TPBroker.
3
--

vbroker.orb.htc.tracePath
Specify a range of 1 to 210 bytes for the path of the output destination of Cosminexus TPBroker trace files. You need to create comtrc and mdltrc as the subdirectories of the specified path beforehand. In the case of default output destination, the subdirectories comtrc and mdltrc are automatically created when the server is started for the first time. Use a forward slash (/) as the delimiter in the directory path.
For example, in Windows, if C\temp\work is to be set as the work directory, specify as follows:
(Example of specification)
vbroker.orb.htc.tracePath=c:/temp/work

In Windows
Cosminexus-working-directory\ejb\server-name\logs\TPB\logj

In UNIX
Cosminexus-working-directory/ejb/server-name/logs/TPB/logj

--

vbroker.se.iiop_tp.host
Set the IP address of the EJB container for each J2EE server by specifying any optional value.
None
--

vbroker.se.iiop_tp.proxyHost#
Specify the name of the host where the J2EE server and CORBA Naming Service are allocated. Set up the host name such that the name is resolved as a NAT IP address with the EJB client. Also, if the EJB client does not use NAT, specify settings such that the name is resolved as a J2EE server IP address with the host.
None
09-50

vbroker.se.iiop_tp.scm.iiop_tp.listener.port
You can set a communication port for each J2EE server, by specifying any optional value. Make sure that the port number is not the same as that of any other program.
If this property is not set, Cosminexus TPBroker sets a random value.
Moreover, if you specify true in ejbserver.container.ejbhome.sessionbean.reconnect.enabled, make sure to specify the value and then fix the port number.
0
--

vbroker.se.iiop_ts.proxyHost#
Specify the name of the host where the J2EE server and CORBA Naming Service are allocated. Set up the host name such that the name is resolved as a NAT IP address with the EJB client. Also, if the EJB client does not use NAT, specify settings such that the name is resolved as a J2EE server IP address with the host.
None
09-50

Legend:

--: Indicates a version earlier than the version 08-00.

#

These keys are set up for the J2EE server and CORBA Naming Service, if NAT is set up between an EJB client and J2EE server. How you set up the keys depends on the invocation mode of the CORBA Naming Service.

If the invocation mode of the CORBA Naming Service is an in-process and auto-invocation mode, specify these keys in the user property file for J2EE servers. The following is an example of settings where the host name of the computer on which the J2EE server is allocated is MyJ2EEHost:

# CORBA Naming Service invocation mode settings
ejbserver.naming.startupMode=inprocess

# Settings for communication between the EJB client and J2EE server in a NAT configuration
vbroker.se.iiop_ts.proxyHost=MyJ2EEHost
vbroker.se.iiop_tp.proxyHost=MyJ2EEHost

If the CORBA Naming Service is invoked automatically as an out-process, specify these keys in both; the user property file for J2EE servers and the user property for J2EE servers ejbserver.naming.exec.args. The following is an example of settings where the host name of the computer on which the J2EE server is allocated is MyJ2EEHost. Specify the settings for ejbserver.naming.exec.args on one line, delimited with spaces for each -J. Also, if a value is set up for ejbserver.naming.exec.args in the existing system, specify that value for the command additionally.

# CORBA Naming Service invocation mode settings
ejbserver.naming.startupMode=automatic

# Settings for communication between the EJB client and J2EE server in a NAT configuration
vbroker.se.iiop_ts.proxyHost=MyJ2EEHost
vbroker.se.iiop_tp.proxyHost=MyJ2EEHost
ejbserver.naming.exec.args=-J-Dvbroker.se.iiop_ts.proxyHost=MyJ2EEHost -J-Dvbroker.se.iiop_tp.proxyHost=MyJ2EEHost

If the CORBA Naming Service is invoked manually as an out-process, specify these keys in both, the user property file for J2EE servers and the invocation option of the nameserv command. The following is an example of settings where the host name of the computer on which the J2EE server is allocated is MyJ2EEHost:

# CORBA Naming Service invocation mode settings
ejbserver.naming.startupMode=manual

# Settings for communication between the EJB client and J2EE server in a NAT configuration
vbroker.se.iiop_ts.proxyHost=MyJ2EEHost
vbroker.se.iiop_tp.proxyHost=MyJ2EEHost

An example of executing the nameserv command is as follows. Note that to execute the nameserv command, specify the settings on one line, delimited with spaces for each -J. Also, if the nameserv command is being executed in the existing system, add a postscript to that command.

nameserv -J-Dvbroker.agent.enableLocator=false
-J-Djava.security.policy=="Application-Server-installation-directory\CC\server\sysconf\cli.policy"
-J-Dvbroker.se.iiop_tp.scm.iiop_tp.listener.port=port-number
-J-Dvbroker.se.iiop_ts.proxyHost=MyJ2EEHost
-J-Dvbroker.se.iiop_tp.proxyHost=MyJ2EEHost

(ai) Keys beginning with webserver.application

The following table lists the specifiable key. Note that Default value is the value that is assumed when the key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.application.lower_version
Specify the version of the Web application that you want to set with the version setup functionality of the Web application.
When you specify 2.4, Web applications of version 2.4 or earlier as defined in web.xml are executed as Web applications of version 2.4.
When you specify 2.5, Web applications of version 2.5 or earlier as defined in web.xml are executed as Web applications of version 2.5.
None
08-20

(aj) Keys beginning with webserver.connector

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.connector.ajp12.backlog
This key is used to maintain compatibility with the older versions.
This key is used as webserver.connector.ajp13.backlog. For details about specifiable values, see the explanation of the webserver.connector.ajp13.backlog key.
When both, this key and the webserver.connector.ajp13.backlog key are specified, the value of the webserver.connector.ajp12.backlog key is used.
None
--

webserver.connector.ajp12.max_threads
This key is used to maintain compatibility with the older versions.
This key is used as webserver.connector.ajp13.max_threads. For details about specifiable values, see the explanation of the webserver.connector.ajp13.max_threads key.
When both, this key and webserver.connector.ajp13.max_threads are specified, the value of the webserver.connector.ajp12.max_threads key is used.
When you set 1025 or more than this value, the default value 100 is used for webserver.connector.ajp13.max_threads.
None
--

webserver.connector.ajp12.port
This key is used to maintain compatibility with the older versions.
This key is used as webserver.connector.ajp13.port. For details about specifiable values, see the explanation of the webserver.connector.ajp13.port key.
When both, this key and webserver.connector.ajp13.port are specified, the value of the webserver.connector.ajp12.port key is used.
None
--

webserver.connector.ajp13.backlog
Specify the maximum number of rows and columns awaiting connection requests from the redirector. Specify the value using an integer from 1 to 2147483647​.
The valid maximum value becomes the maximum value of the Listen queue in the Socket specifiable on the platform to be used. The actual maximum value of the Listen queue depends on the OS. For details, see the manuals for the listen functionality in each OS.
The value specified in this key is set in the backlog argument of java.net.ServerSocket class constructor. If, however, this specified value exceeds the limit value set for the OS, it is interpreted as the limit value of the OS, and it therefore does not result in an error. The limit value is different for every OS. For details on how to extend the limit value, see the OS manual.
100
--

webserver.connector.ajp13.bind_host
Specify the IP address or the host name used for Web server integration.
The single-byte space before and after the IP address or the host name is ignored. If you do not specify a value, the wild card address is used.
When specifying this property, you need to specify the local host name or the IP address even in the worker host name.
In a configuration wherein a Web server is integrated with another Web server running on the same host, the Web Container cannot receive requests from the Web server if either of the following settings is specified:

The local host name or IP address is specified in the webserver.connector.ajp13.bind_host property, and the loopback address of a host, such as localhost, is specified in the worker host name of the redirector.

The loopback address of a host, such as localhost, is specified in the webserver.connector.ajp13.bind_host property, and the local host name or IP address is specified in the worker host name of the redirector.

None
--

webserver.connector.ajp13.max_threads
Specify the concurrently executing number of requests being processed by the Web container.#1
Specify the value using an integer from 1 to 1024.
Number of threads equal to the concurrently executing number of specified requests is generated when the server is started.
10
--

webserver.connector.ajp13.port
Specify the port number used for communication with the Web server.
Specify the value using an integer from 1 to 65535.
You cannot specify a port number that is already being used or secured for another application. Furthermore, do not specify the same value in port numbers of the ports to be used to communicate with the Web server in multiple J2EE servers. The cjstartsv command cannot start up multiple J2EE servers in which identical port numbers are specified.
8007
--

webserver.connector.ajp13.receive_timeout
Specify an integer from 0 to 3600 (units: seconds) for the period to await a response (communication timeout value) from the redirector, while the data request is being processed in the redirector (that processes requests).
If you specify 0, the waiting period continues until a response is received from the redirector and the timeout will not occur.
600 (seconds)
--

webserver.connector.ajp13.send_timeout
Specify an integer from 0 to 3600 (units: seconds) for the timeout value for sending response.
If you specify a non-numeric value, or a numeric value outside the range, a message will be output and the default value will be used.
If 0 or a time period longer than the resend timer of data transmission present in the TCP is set, the timeout value will be the timeout value of the TCP. In such a case, a message indicating that an invalid timeout value has been specified will not be output.
600
--

webserver.connector.http.bind_host
Specify the local IP address or a resolvable local host name used in the simple Web server.
The single-byte space before and after the IP address or the host name will be ignored. If you do not specify a value, the wild card address is used.
None
--

webserver.connector.http.permitted.hosts
Specify the IP address (decimals) or the name of the host that has permission to access the simple Web server.
Note that the local host can always be accessed even if it is not specified. As a result, if this key is not specified, you can access only the local host.
When specifying multiple hosts, demarcate the IP addresses or the host names with a comma (,). If there are no access restrictions, specify only an asterisk (*). The single-byte space before and after the IP address or the host name is ignored.
None
--

webserver.connector.inprocess_http.backlog
Specify an integer from 1 to 2147483647​ for the length of the TCP listen queue that saves the connection requests from the Web client.
The maximum valid specified value or the length of the TCP listen queue that is actually set, is different for every OS.
If you specify a non-numeric value, a numeric value outside the range, a null character string, or a whitespace#2, a message is output and the default value will be set.
511
--

webserver.connector.inprocess_http.bind_host
Specify the IP address or the host name used in an in-process HTTP server.
The single-byte space before and after the IP address or the host name is ignored. If you do not specify a value, the wild card address is used.
If the specified host name or the IP address cannot be resolved and if you specify the name or IP address of a host that is not local, a message is output and the wild card address is used.
None
--

webserver.connector.inprocess_http.enabled
Specify whether to enable the in-process HTTP server functionality.

If you specify true:

The in-process HTTP server functionality will be enabled.

If you specify false:

The in-process HTTP server functionality will be disabled.

If you specify a string other than true or false or if you specify a null character string or a whitespace#2, a message is output and the default value will be set.
Note that, if the in-process HTTP server functionality is enabled, Web server integration cannot be used.
false
--

webserver.connector.inprocess_http.enabled_methods
Specify the HTTP methods that have access permission.
When specifying multiple methods, demarcate them with a comma (,). In the method name, specify the method that has been defined in HTTP/1.1.
If you specify an asterisk (*), all methods are permitted.
HTTP methods are case-sensitive so the value specified in this property is also case-sensitive.
In the method name, you need to use the value provided in RFC2616. You cannot, however, specify the string "*" as a method name.
The whitespace#2 before and after each method name is ignored. If you specify an invalid value, a null character string, or a whitespace#2, a message is output and the default value will be set.
GET, HEAD, POST, PUT, DELETE, OPTIONS
--

webserver.connector.inprocess_http.error_custom.list
Specify the definition name for error page customization used in the error page customization functionality.
The maximum length of the value that can be specified is 1024 characters. Specify a string consisting of alphanumeric characters (A-Z, a-z, 0-9) or underscores (_). The string length of one definition name is from 1 to 32 characters.
When specifying multiple definition names, demarcate them with a comma (,). The whitespace#2 before and after the comma is ignored. The same definition name for error page customization cannot be specified multiple times.
If you specify an invalid value, a message is output and all the definitions for error page customization are disabled.
None
--

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file
Specify an absolute path for the file used as the response body during error page customization with the error page customization functionality.
Use a forward slash (/) as the demarcation sign in the path.
If this property is set by using the definition name for error page customization that has not been specified in webserver.connector.inprocess_http.error_custom.list, the property is disabled.
In the definition name for error page customization specified in webserver.connector.inprocess_http.error_custom.list, make sure that you specify either this property, or webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.redirect_url. If you specify both the properties or if you do not specify any of the properties, or if you do not specify as an absolute path, or if you specify a file that does not exist, or a file for which there is no read permission, a message is output and this definition for error page customization is disabled.
If you specify a null character string, or a whitespace#2, the property is disabled.
None
--

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file.content_type
Specify the value of Content-Type header of the response during error page customization using the error page customization functionality.
If this property is set by using the definition name for error page customization that is not specified in webserver.connector.inprocess_http.error_custom.list, the property is disabled.
If webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file is not set, the property is disabled.
text/html
--

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.redirect_url
Specify the redirect URL as an absolute path using the error page customization functionality.
If this property is set by using the definition name for error page customization that is not specified in webserver.connector.inprocess_http.error_custom.list, the property is disabled.
In the definition name for error page customization specified in webserver.connector.inprocess_http.error_custom.list, make sure that you specify either this property or webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file.
Whether the value is correct is not verified, so you need to check through actual operations.
None
--

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.request_url
Specify an absolute path beginning with a forward slash (/) for the request URL that applies the error page customization with the error page customization functionality. You can specify the wild card (*) only once, immediately after the forward slash. An asterisk (*) is always interpreted as the wild card, so it cannot be used as a normal character.
The value specified in this property and the value specified in webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.status, must not match with any other definition for error page customization.
If this property is set by using the definition name for error page customization that is not specified in webserver.connector.inprocess_http.error_custom.list, the property is disabled.
If you specify an invalid value, a message is output and this definition for error page customization is disabled.
/*
--

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.status
Use the error page customization functionality and specify an integer from 400 to 599 for the response status code that performs error page customization.
The value specified in this property and the value specified in webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.request_url, must not match with any other definition for error page customization.
If this property is set by using the definition name for error page customization that is not specified in webserver.connector.inprocess_http.error_custom.list, the property is disabled.
Make sure that you specify this property for setting the definition name for error page customization that has been specified in webserver.connector.inprocess_http.error_custom.list. If you do not specify this property, or if you specify an invalid value, a message is output and this definition for error page customization is disabled.
None
--

webserver.connector.inprocess_http.gateway.host
Specify the host name or the IP address of the gateway. When requests without a Host header are redirected to files, such as the welcome file, the host name of the URL specified in the Location header becomes the specified value.
None
--

webserver.connector.inprocess_http.gateway.port
Specify the port number of the gateway by using an integer from 1 to 65535.
If a request has no Host header and the request is to be redirected to a location such as a welcome file, the port number portion of the URL that is specified in the Location header becomes the specified value.
This property specification is ignored when webserver.connector.inprocess_http.gateway.host is not specified.
If webserver.connector.inprocess_http.gateway.host is specified and this property is omitted, the following value is set:

If you specify true for webserver.connector.inprocess_http.gateway.https_scheme: 443

If you specify false for webserver.connector.inprocess_http.gateway.https_scheme: 80

If a string other than a numeric value or a numeric value outside the valid range is specified, a message appears and the value is considered not to have been specified.
None
--

webserver.connector.inprocess_http.gateway.https_scheme
When a client request uses https as a scheme, and the scheme for a Web server will become http by using an SSL accelerator, specify true.

If you specify true:

https is assumed to be used as the scheme for requests sent to the Web server.

If you specify false:

No action occurs.

If you specify a string other than true or false or if you specify a null character string or a whitespace#2, a message is output and the default value will be set.
false
--

webserver.connector.inprocess_http.hostname_lookups
Specify whether the Web container should perform reverse lookup of the host name and convert the IP address of the client to the host name, for a request received by the in-process HTTP server.
The throughput, however, will decline In the case of reverse lookup of the host name.
If the host name is not resolved, the result of the getRemoteHost() method of javax.servlet.ServletRequest interface and the client IP address output to the log file will be in the format wherein a dot (.) is used for demarcation.

If you specify true:

The IP address will be converted to the host name.

If you specify false:

The IP address will not be converted to the host name.

If you specify a string other than true or false or if you specify a null character string or a whitespace#2, a message is output and the default value will be set.
false
--

webserver.connector.inprocess_http.init_threads
Specify an integer from 1 to 1024 for the number of request processing threads of in-process HTTP server, generated when the server is started.
The specified value must be lower than the maximum number of connections with the Web client (value specified in webserver.connector.inprocess_http.max_connections). If you specify a value greater than the maximum number of connections with the Web client, a message is output and the maximum number of connections with the Web client is set as the value.
Furthermore, the maximum valid value differs based on the OS.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
10
--

webserver.connector.inprocess_http.keep_start_threads
Specify whether to maintain the number of threads that are created when the server is started.

If you specify true:

The number of threads created when the server is started will be maintained. Even if the number of spare threads maintained in the pool exceeds the maximum number of spare threads (value specified in webserver.connector.inprocess_http.max_spare_threads), the number of threads created during the startup of the server will not be reduced.

If you specify false:

The number of threads created when the server is started will not be maintained. Adjustment will be made on the basis of the maximum number and the minimum number of threads maintained as spare threads.

If the number of threads created when the server is started is lesser than the minimum number of spare threads (value specified in webserver.connector.inprocess_http.min_spare_threads), the number of threads is maintained as per the value specified in the minimum number of spare threads, irrespective of the settings in this property.
If you specify false in this property, adjustment is done so that the threads created when the server is started become lesser than the maximum number of spare threads. If the request-processing threads created when a server is started are greater than the maximum number of spare threads, the threads exceeding the maximum number of spare threads get destroyed one by one at an interval of one second after the server is started.
If you specify a string other than true or false or if you specify a null character string or a whitespace#2, a message is output and the default value will be set.
false
--

webserver.connector.inprocess_http.limit.max_headers
Specify an integer from 0 to 32767 for the upper limit of the number of HTTP headers included in the HTTP requests. If you do not want to set the upper-limit value, specify 0.
Even if the number of HTTP headers specified in this property is not met, an error occurs if the size specified in webserver.connector.inprocess_http.limit.max_request_header is exceeded.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
100
--

webserver.connector.inprocess_http.limit.max_request_body
Specify an integer from -1 to 2147483647​ (units: bytes) for the maximum size of the request body of an HTTP request. If you do not want to set the upper-limit value, specify -1. If the request body is sent in chunk format, the size of the chunk header also needs to be included in the specified size.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
-1
--

webserver.connector.inprocess_http.limit.max_request_header
Specify an integer from 7 to 65536 (units: bytes) for the maximum size of the request header of an HTTP request.
Even if the maximum size of the request header that has been set in this property is not met, an error occurs if the HTTP header specified in webserver.connector.inprocess_http.limit.max_headers is exceeded.
The linefeed characters (double bytes of CR (0x0d) + LF (0x0a)) indicating the end of the HTTP header also need to be included in the specified size.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
16384
--

webserver.connector.inprocess_http.limit.max_request_line
Specify either -1 or an integer from 7 to 8190 for the maximum length (units: bytes) of the request line. If you do not specify the upper-limit, specify -1. The request line includes URI and HTTP version that include the HTTP methods and the query strings.
The value to be specified needs to be lower than the maximum size of the request header (value specified in webserver.connector.inprocess_http.limit.max_request_header). If you specify a value greater than the maximum size of the request header, a message is output, and the maximum size of the request header is set as the maximum length of the request line.
The linefeed characters (double bytes of CR (0x0d) + LF (0x0a)) indicating the end of the HTTP header also need to be included in the size to be specified.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
8190
--

webserver.connector.inprocess_http.max_connections
Specify an integer from 1 to 1024 for the maximum number of connections with the Web client. The valid maximum value is different for every operating OS.
The value specified in this parameter becomes the maximum value for the request-processing threads.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
100
--

webserver.connector.inprocess_http.max_execute_threads
Specify an integer from 1 to 1024 for the number of concurrently executing requests processed by the Web container.
The specified value must be lower than the maximum number of connections with the Web client (value specified in webserver.connector.inprocess_http.max_connections). If you specify a value greater than the maximum number of connections with the Web client, a message is output and the maximum number of connections with the Web client is set in the value.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
10
--

webserver.connector.inprocess_http.max_spare_threads
Specify an integer from 1 to 1024 for the maximum number of spare threads stored in a pool.
The specified value must be lower than the maximum number of connections with the Web client (value specified in webserver.connector.inprocess_http.max_connections). If you specify a value greater than the maximum number of connections with the Web client, a message is output and the maximum number of connections with the Web client is set in the value.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
20
--

webserver.connector.inprocess_http.min_spare_threads
Specify an integer from 1 to 1024 for the minimum number of spare threads stored in a pool.
The specified value needs to be lower than the maximum number of spare threads stored in the pool (value specified in webserver.connector.inprocess_http.max_spare_threads). If a value greater than the maximum number of spare threads stored in the pool is set, a message is output, and the maximum number of spare threads stored in the pool is set as the minimum number of spare threads stored in the pool.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
5
--

webserver.connector.inprocess_http.permitted.hosts
Specify the IP address (decimals) or the name of the host that has access permission for the in-process HTTP server. If you specify multiple hosts, demarcate the IP addresses or the host names with a comma (,). If there are no access restrictions, specify only an asterisk (*).
Note that the local host can always be accessed even if it is not specified.
If you specify a null character string or a whitespace#2, a message is output and the default value will be set.
If the specified host cannot be resolved, a message is output, and access is permitted only from the local host.
Note that the single-byte space before and after the IP address or the host name is ignored.
*
--

webserver.connector.inprocess_http.persistent_connection.max_connections
Specify an integer from 0 to 1024 for the maximum number of TCP connections maintained in a Persistent Connection.
The value to be set must be lower than the maximum number of connections with the Web client (value specified in webserver.connector.inprocess_http.max_connections). If you set a value greater than the maximum number of connections with the Web client, a message is output and the maximum number of connections with the Web client is set as the maximum number of TCP connections stored in the Persistent Connection.
If you specify a non-numeric value or a numeric value outside the range, a message is output and the value specified in webserver.connector.inprocess_http.max_connections is set as the default value. If you specify a null character string or a whitespace#2, the value specified in webserver.connector.inprocess_http.max_connections is set as the default value.
Value specified in webserver.connector.inprocess_http.max_connections
--

webserver.connector.inprocess_http.persistent_connection.max_requests
Specify an integer from 0 to 2147483647​ for the upper limit of the number of serial connections when TCP connections are sustained by a Persistent Connection. If you do not want to set the upper-limit value, specify 0.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
100
--

webserver.connector.inprocess_http.persistent_connection.timeout
Specify an integer from 0 to 3600 for the request wait period (units: seconds), when the TCP connections are sustained in a Persistent Connection. If you specify 0, the timeout does not occur.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
3
--

webserver.connector.inprocess_http.port
Specify an integer from 1 to 65535 for the port number used by the in-process HTTP server. You cannot specify a port number that is already being used by another application. If you specify a port number that is in use or has been secured by another application, a message is output and the J2EE server does not start.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
80
--

webserver.connector.inprocess_http.receive_timeout
Specify an integer from 0 to 3600 for the period until timeout (units: seconds), when requests are received from the Web client. If you specify 0, the timeout does not occur.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
300
--

webserver.connector.inprocess_http.redirect.redirect-definition-name.file
Specify an absolute path for the file used as the response body during redirection with the redirect functionality. Use a forward slash (/) as the demarcation sign in the path.
If you specify 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status, always specify this property. If you specify 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status, and this property is not specified, a message is output and this redirect definition is disabled.
If you set this property by using a redirect definition name that is not specified in webserver.connector.inprocess_http.redirect.list and if you specify a null character string or a whitespace#2, the property is disabled.
If you specify a value that is not an absolute path, a message is output and this redirect definition name is disabled. If you specify a file that does not exist or a file that does not have read permission, a message is output and this redirect definition is disabled.
None
--

webserver.connector.inprocess_http.redirect.redirect-definition-name.file.content_type
Specify the value of the response Content-Type header during redirection, using the redirect functionality.
If this property is set by using a redirect definition name that is not set in webserver.connector.inprocess_http.redirect.list, the property is disabled.
If the webserver.connector.inprocess_http.redirect.redirect-definition-name.file is not set, this property is disabled.
text/html
--

webserver.connector.inprocess_http.redirect.redirect-definition-name.redirect_url
Specify the redirect URL as an absolute URL, using the redirect functionality.
If you specify 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status, this property cannot be set. If you specify 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status, and you specify this property, a message is output and the redirect definition name is disabled.
If you specify a value other than 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status, make sure that you specify this property. If you specify a value other than 200 in webserver.connector.inprocess_http.redirect.redirect-definition-name.status and this property is not specified, a message is output and the redirect definition is disabled.
If this property is set by using a redirect definition name that is not set in webserver.connector.inprocess_http.redirect.list, the property is disabled.
Whether the value is correct is not verified, so you need to check through actual operations.
None
--

webserver.connector.inprocess_http.redirect.redirect-definition-name.request_url
Specify an absolute path beginning with a forward slash (/) for the request URL performing redirection with the redirect functionality. You can specify the wild card (*) only once, immediately after the forward slash. The wild card indicates any string of 0 or more characters. An asterisk (*) is always interpreted as the wild card, so it cannot be used as a normal character. You also cannot specify a value same as that specified in another redirect definition.
For the redirect definition name that has been specified in webserver.connector.inprocess_http.redirect.list, you always need to specify this property. If you do not specify this property, a message is output and the redirect definition is disabled.
If this property is set by using a redirect definition name that is not set in webserver.connector.inprocess_http.redirect.list, the property is disabled.
If you specify an invalid value, a message is output and the redirect definition is disabled.
None
--

webserver.connector.inprocess_http.redirect.redirect-definition-name.status
Specify the response status code (200, 300, 301, 302, 303, 305, 307) during redirection with the redirect functionality.
If this property is set by using a redirect definition name that is not set in webserver.connector.inprocess_http.redirect.list, the property is disabled.
If you specify an invalid value, a null character string, or a whitespace#2, a message is output and the default value will be set.
302
--

webserver.connector.inprocess_http.redirect.list
Specify the redirect definition name used in the redirect functionality.
The maximum length of the value that can be specified in this property is 1024 characters. Specify the redirect definition name with a string consisting of alphanumeric characters (A-Z, a-z, 0-9) or underscores (_). The string length of one redirect definition name is from 1 to 32 characters.
When specifying multiple redirect definition names, demarcate them with a comma (,). The whitespace#2 before and after the comma is ignored. You cannot specify the same redirect definition name multiple times.
If you specify an invalid value, a message is output and all redirect definitions are disabled.
None
--

webserver.connector.inprocess_http.rejection_threads
Specify an integer from 0 to 1023 for the number of request-processing threads that are denied access. The value to be specified must be lesser than the maximum number of request-processing threads (value specified in webserver.connector.inprocess_http. max_connections). If a value greater than the maximum number of connections with the Web client is set, a message is output and a value that is 1 less than the maximum number of connections with the Web client is set as the number of request-processing threads that are denied access.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
1
--

webserver.connector.inprocess_http.response.header.server
Specify the value of the Server header that is automatically added to the response.
If you specify a null character string or a whitespace#2, a message is output and the default value will be set.
CosminexusComponentContainer
--

webserver.connector.inprocess_http.send_timeout
Specify an integer from 0 to 3600 for the period until timeout (units: seconds) when a response is sent to the Web client. When you specify 0, the timeout is not enabled.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
300
--

webserver.connector.limit.max_parameter_count
Specify an integer from -1 to 2147483647​ as the maximum number of request parameters.
The valid range of maximum number of request parameters is a total of the request query strings and number of parameters of the form data with the Content-Type header value as application/x-www-form-urlencoded or multipart/form-data.
If you do not want to set up the maximum number of request parameters, specify -1.
If you specify a non-numeric value, a numeric value outside the range, a null character string or a whitespace#2, a message is output and the default value will be set.
If the number of request parameters exceeds the specified value, the following operations are performed depending on the APIs and the KDJE39341-W or the KDJE39342-E message is displayed:

APIs that throw IllegalStateException:

javax.servlet.http.HttpServletRequest.getPart(String)

javax.servlet.http.HttpServletRequest.getParts()

APIs that return a return value using the read request parameters:

javax.servlet.ServletRequest.getParameter(String)

javax.servlet.ServletRequest.getParameterMap()

javax.servlet.ServletRequest.getParameterNames()

javax.servlet.ServletRequest.getParameterValues(String)

10000
09-00

webserver.connector.limit.max_post_form_data
Specify an integer from -1 to 2147483647​ (unit: bytes) for the maximum size of form data of a POST request. If the maximum size is not set, specify -1.
If the following numeric values or strings are specified, a message is output and the default value is applied:

A character string other than numeric values

Numeric values outside the specified range

Null character strings or blank characters

If the value of Content-Type header is application/x-www-form-urlencoded:

If the value of Content-Length header of the request exceeds the maximum specified size, an error with status code 413 (Request Entity Too Large) is returned, and the message KDJE39336-E is output.
When the request body is in the check format, if the received POST request size exceeds the maximum specified size due to an extended Servlet API invocation, a java.lang.IllegalStateException is thrown and the message KDJE39336-E is output.

If the value of Content-Type header is multipart/form-data:

When the Servlet API invocation is extended, check that the total of the parameter name and size value for the data other than file data from the form data received in multipart format does not exceed the maximum specified size. If the value exceeds the maximum specified size, a java.lang.IllegalStateException is thrown and the message KDJE39336-E is output.

2097152​
08-50

webserver.connector.redirect_https.port
Specify the HTTPS port number used by the Web server
Specify the value using an integer from 1 to 65535.
If the port number is not specified, requests are not redirected to the HTTPS port.
You cannot specify a port number that is already being used or secured for another application. Furthermore, do not specify the same value in port numbers of the ports to be used to communicate with the Web server in multiple J2EE servers. The cjstartsv command cannot start up multiple J2EE servers in which identical port numbers are specified.
None
--

Legend:

--: Indicates a version earlier than the version 08-00.

#1

The valid maximum value depends on the operating platform.

Some of the requests arriving in the Web server are passed to the Web container, therefore, the maximum number of concurrent connections of the Web server to be set up must be greater than the total size of the default pending queue and the pending queue of each URL group and Web application + maximum number of concurrently executing threads in each Web container.
In a servlet or JSP performing the database operations, since it is not possible to obtain greater multiplicity than the number of database connections, you need to increase the number of usable database connections, when increasing the concurrently executing number of Web containers.
When tuning the performance, always consider the following relation and adjust the value of each parameter:
Maximum-number-of-concurrent-connections-of-Web-server > Total-size-of-the-pending-queues-of-each-URL-group-and-Web-application-and-the-default-pending-queue + Maximum-number-of-concurrently-executing-threads-in-each-Web-container
Maximum-number-of-concurrently-executing-threads-in-each-Web-container Number-of-database-connections
For details on controlling the number of concurrently executed threads in Web containers, see 2.16 Controlling the number of concurrently executed threads in Web containers in the manual uCosminexus Application Server Web Container Functionality Guide.
For details about the number of concurrent connections used for processing in the Web server, reference the manual of the Web server.

#2

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(ak) Keys beginning with webserver.container

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.container.ac.logEnabled
Specify whether to output the trace log for Web container maintenance.

If you specify true:

The trace log will be output.

If you specify false:

The trace log will not be output.

false
--

webserver.container.jaxws.webservice.no_webxml.enabled
When SOAP request messages arrive from the client of the Web Service, specify whether to receive the SOAP request messages and distribute them to the Web Service implementation class if the Web Service implementation class or Provider implementation class developed using Cosminexus JAX-WS is included even when web.xml is not included in the WAR file either completely or partially.

If you specify strict or true:

When web.xml is not included in the WAR file, SOAP request messages are distributed to the Web Service implementation class or Provider implementation class based on the information of the @javax.jws.WebService annotation or @javax.xml.ws.WebServiceProvider annotation.

If you specify lax:

When web.xml is not included in the WAR file either completely or partially, SOAP request messages are distributed to the Web Service implementation class or Provider implementation class based on the information of the @javax.jws.WebService annotation or @javax.xml.ws.WebServiceProvider annotation.

If you specify none or false:

When web.xml is not included in the WAR file, SOAP request messages are not distributed to the Web Service implementation class.

To avoid the occurrence of situations such as those where an unexpected class is associated with the URL by mistake, or where a user is allowed access from outside, the default value is set to none (false).
none
08-00

webserver.container.jaxws.webservice.wsee.no_webxml.enabled
When SOAP request messages arrive from the client of the Web Service, specify whether to receive the SOAP request messages and distribute them to the Web Service implementation class if the Web Service implementation class or Provider implementation class developed using Cosminexus JAX-WS is included even when web.xml is not included in the WAR file either completely or partially.

If you specify strict:

When web.xml is not included in the WAR file for setup, SOAP request messages are distributed to the Web Service implementation class based on the information of the @javax.jws.WebService annotation.

If you specify lax:

When web.xml is not included in the WAR file for setup either completely or partially, SOAP request messages are distributed to the Web Service implementation class based on the information of the @javax.jws.WebService annotation.

If you specify none:

When web.xml is not included in the WAR file for setup, SOAP request messages are not distributed to the Web Service implementation class.

lax
08-70

webserver.container.jaxws.webservice.wsee.warname
Specify the path name of the WAR file for setup, for the Web service implementation class included in the EJB-JAR files#1.
The WAR file for setup might be created by the user and auto-generated during deployment. When the WAR file for setup is auto-generated during deployment, this property need not be set up.
CosminexusWSEE.war
08-70

webserver.container.server_id.enabled
Specify whether to add the Cookie of the server ID to the HTTP response.

If you specify true:

The Cookie of server ID will be added to the HTTP response. Specify the server ID in webserver.container.server_id.value.

If you specify false:

The Cookie of server ID will not be added to the HTTP response.

If you specify a string other than true or false or if you specify a null character string or a whitespace#2, a message is output and the default value will be set.
false
--

webserver.container.server_id.name
Specify the name of the Cookie when the Cookie of server ID is to be added to the HTTP response. Specify the value as a string from 1 to 64 characters. You can use single-byte alphanumeric characters (A-Z, a-z, 0-9) or underscores (_). The following name is used by the Web container and is case sensitive:

JSESSIONID

Notes:

If true is specified for the webserver.container.server_id.enabled key and the Cookie name is specified in this property, or if the default ServerID is used and the same Cookie name is specified in the webserver.session.cookie_config.name key, the value of this property is given priority. Note that the default value is used for the Cookie name specified with the webserver.session.cookie_config.name key.

If you specify an invalid value, a warning message is output and the default value will be set.
ServerID
--

webserver.container.server_id.value
Specify the value of the Cookie when the Cookie of server ID is to be added to the HTTP response. Specify the value as a string from 1 to 64 characters. You can use single-byte alphanumeric characters (A-Z, a-z, 0-9) or underscores (_).
If you specify true in webserver.container.server_id.enabled, and this property is omitted, or if you specify an invalid value, a null character string, or a whitespace#2, a message is output and the default value will be set.
String generated using the hash function from the host name and J2EE server name/Web container server name (compatibility functionality). The generated value is a 64-character hexadecimal number.
--

webserver.container.servlet.default_mapping.enabled
Specify whether to enable the default servlet mapping.

If you specify true:

The default mapping will be enabled.

If you specify false:

The default mapping will be disabled.

false
08-00

webserver.container.thread_control.enabled
Specify whether to use the functionality for controlling the concurrently executing number of threads in each Web application. This functionality is enabled only in the J2EE server mode.

If you specify true:

The functionality for controlling the concurrently executing number of threads in each Web application will be enabled.

If you specify false:

The functionality for controlling the concurrently executing number of threads in each Web application will be disabled.

true
--

webserver.container.thread_control.queue_size
Specify an integer from 0 to 2147483647​ for the default size of the pending queues, when the functionality for controlling the number of concurrently executing threads in each Web application is to be used. This functionality is enabled only in the J2EE server mode.
However, if you specify false in webserver.container.thread_control.enabled, the property is disabled.
8192
--

Legend:

--: Indicates a version earlier than the version 08-00.

#1

When a user creates the WAR file for setup, the WAR file for setup must be created in such a way that the file matches the relative path within the EAR file specified in this property. Note that the WAR file for setup includes the web.xml that is used for distributing the SOAP request messages to the Web Services included in an EJB-JAR file.

To deploy the exploded-archive-format applications in which the Web service implementation class is included in an EJB-JAR file and the WAR file for setup does not exist, specify the path name from 1 to 255 bytes. Note that the path length is a total of the following A + B + C:

A: Path length of the directory for an exploded-archive-format application

B: Path delimiter (1 byte)

C: Length of the path specified in this property

To change the value of this property, stop the Web applications that include the EJB Web Services. If you change the property value while the Web application is running, the operations cannot be guaranteed. The other applications might become invalid and an unexpected exception might occur.

#2

Whitespace implies single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(al) Keys beginning with webserver.context

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.context.check_interval
Specify an integer from 0 to 2147483647​ (units: seconds) for the interval to detect the update of a Web application.
If you specify 0, the update will not be automatically detected.
If the reload functionality of a J2EE application is disabled, you cannot set this property. If you set this property, it is ignored.
If you specify a non-numeric value, a numeric value outside the range, or a null character string, a message is output and the default value will be set.
Value set in ejbserver.deploy.context.check_interval (default value: 0)
--

webserver.context.reload_delay_timeout
Specify a negative integer or a value from 0 to 2147483647​ (units: seconds) for the maximum delay time of the delay execution functionality for reloading the Web application.
If you specify 0, the delay execution functionality for reloading is not used.
If the reload functionality of a J2EE application is disabled, you cannot set this property. If you set this property, it is ignored.
If you specify a negative integer, the delay execution functionality for reloading is used without specifying the maximum delay time.
0
--

webserver.context.update.interval
Specify an integer from 0 to 2147483647​ (units: seconds) for the time interval required for copying the file that you will update. Specify extra time for the interval. The monitoring of a request that is being processed starts after the lapse of the specified interval from the detection of resource update.
If the JSP reload functionality is disabled, you cannot set this property. If you set this property, it is ignored.
If you specify a non-numeric value, a numeric value outside the range, or a null character string, a message is output and the default value will be set.
ejbserver.deploy.context.update.interval (default value: 0)
--

Legend:

--: Indicates a version earlier than the version 08-00.

(am) Keys beginning with webserver.dbsfo

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.dbsfo.attribute_data_size.max
Specify the maximum size of the HTTP session attribute information that can be included in the global session information in bytes.
1024
08-00

webserver.dbsfo.check_size.mode
Specify whether to enable the size estimation functionality (database session failover functionality) for the HTTP session attribute information.

If you specify on:

The size estimation functionality for the HTTP session attribute information will be enabled.

If you specify off:

The size estimation functionality for the HTTP session attribute information will be disabled.

off
08-00

webserver.dbsfo.connector.name
Specify the optional name of the DB Connector to be used by the database session failover functionality.
COSMINEXUS_SFO_DBCONNECTOR
08-00

webserver.dbsfo.enabled
Specify whether to enable the database session failover functionality.

If you specify true:

The database session failover functionality will be enabled in all the Web applications on the J2EE server.

If you specify false:

The database session failover functionality will be disabled.

false
08-00

webserver.dbsfo.exception_type_backcompat
Specify the compatibility option of the exception that occurs when the HttpServletRequest#getSession method is executed in the error page of the request for which the database session failover functionality is to be controlled.

If you specify true:

The com.hitachi.software.web.dbsfo.DatabaseAccessException exception will be thrown.

If you specify false:

The com.hitachi.software.web.dbsfo.SessionOperationException exception will be thrown.

false
08-70

webserver.dbsfo.exclude.extensions
Specify the extension for controlling the database session failover functionality.
If the extension matches with the extension specified in the URL path, the database session failover functionality will be disabled in the applicable request. The comparison between the specified extension and the URL is not case sensitive.
Also, if the extension for controlling the database session failover functionality is not specified, specify a null string or a comma (,).
txt,htm,html,jpg,gif,js
08-00

webserver.dbsfo.exclude.uris
Specify a URI for inhibiting the database session failover functionality. If the path of the request URI matches the specified URI, the database session failover functionality is disabled for that request.
The comparison of the specified URI with the request URI is case sensitive.
If the URI for inhibiting the database session failover functionality is not set, a null character string will be set.
None
08-50

webserver.dbsfo.integrity_mode.enabled
Specify whether to enable the integrity guarantee mode of the database session failover functionality.

If you specify true:

The integrity guarantee mode will be enabled.

If you specify false:

The integrity guarantee mode will be disabled.

false
08-70

webserver.dbsfo.negotiation.high_level
Specify whether to continue or cancel the Web application start processing when the negotiation implemented during the startup of a Web application fails while the database session failover functionality is being used.

If you specify true:

The Web application start processing will be cancelled.

If you specify false:

The Web application start processing will continue.

false
08-70

webserver.dbsfo.session_read_only.uris
Specify the URI to be used as the reference request of the database session failover functionality. The values that can be specified are as follows:

Strings beginning with a forward slash (/)

Normalized URI

URI up to 512 characters

To specify multiple URIs, demarcate them with a semicolon (;). If you do not want to set up a reference request, specify a null character string.
If the specified URI matches with the request URI, this request becomes a reference request. When the specified URI is compared with the request URI, uppercase and lowercase characters are distinguished.
None
08-70

webserver.dbsfo.thread_control_queue.enabled
Specify the operations to be performed when the pending queue space is insufficient, and if the database session failover functionality is used while the functionality for controlling the number of concurrently executing threads for Web applications is enabled.

If you specify true:

The 503 error will be returned to the client when the pending queue space is insufficient.

If you specify false:

The 503 error will not be returned to the client when the pending queue space is insufficient.

false
08-70

(an) Keys beginning with webserver.eadssfo

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the Application Server version in which the keys are installed or changed.

For information related to the specifiable keys, see 7. EADs Session Failover Functionality in the uCosminexus Application Server Expansion Guide.

Key name
Contents
Default value
VR

webserver.eadssfo.application.cache.name
Specify the cache name of the application information cache to be used with the EADs session failover functionality.
EADsSFO_APP_INFO
09-50

webserver.eadssfo.check_size.mode
Specify whether to enable the functionality for estimating the size of the attribute information for the HTTP sessions (EADs session failover functionality).

If on is specified:

The functionality for estimating the size of the attribute information for the HTTP sessions is enabled.

If off is specified:

The functionality for estimating the size of the attribute information for the HTTP sessions is disabled.

off
09-50

webserver.eadssfo.client.retry.count
Specify an integer from 1 to 2147483647​ as the retry count when the access to the EADs server with the EADs session failover functionality fails #1.
2
09-50

webserver.eadssfo.client.retry.interval
Specify an integer from 1 to 2147483647​ as the retry interval (unit: millisecond) when the access to the EADs server with the EADs session failover functionality fails#1.
2000
09-50

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.address
This property defines the EADs client to be used with the EADs session failover functionality#3.
Specify the IP address or host name of the EADs server to be connected with the default EADs client settings used when a Web application starts.
Specify the name defined in eads.client.node.list in the variable part of the parameter.
None#2
09-50

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.port
This property defines the EADs client to be used with the EADs session failover functionality#3.
Specify the port number of the EADs server to be connected with the default EADs client settings used when a Web application starts. Specify the name defined in eads.client.node.list in the variable part of the parameter.
24600
09-50

webserver.eadssfo.eads.client.node.list
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the name for identifying the connection destination EADs server to be connected with the default EADs client settings used when a Web application starts.
To specify multiple names, delimit the names with commas (,). If multiple names are specified, a connection is established with one of the EADs servers. If a connection fails, an attempt is made to connect to another EADs server.
None#2
09-50

webserver.eadssfo.eads.connection.buffersize
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the buffer size (unit: byte) for sending and receiving the connection reading or writing data.
Note that you must set up an appropriate value according to the size of the data to be stored in the EADs server for this property. For details, see the Elastic Application Data store User Guide.
#4
09-50

webserver.eadssfo.eads.connection.retry
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the retry count for communication failure during the checking of a connection.
1
09-50

webserver.eadssfo.eads.connection.timeout
This property defines the EADs client to be used with the EADs session failover functionality #3.
Set up the monitoring time (unit: millisecond) for checking a connection and for sending and receiving the data.
#4
09-50

webserver.eadssfo.eads.connectionPool.poolsize
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the maximum number of connections to be pooled for the same connection destination.
#4
09-50

webserver.eadssfo.eads.logger.commDump.enable
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify whether to enable the output of the message dump output by the EADs client.
#4
09-50

webserver.eadssfo.eads.logger.commTrace.enable
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify whether to enable the output of the communication trace output by the EADs client.
true
09-50

webserver.eadssfo.eads.logger.commTrace.filenum
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the number of communication trace files output by the EADs client.
#4
09-50

webserver.eadssfo.eads.logger.commTrace.filesize
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the file size (unit: byte) per communication trace file output by the EADs client.
#4
09-50

webserver.eadssfo.eads.logger.dir
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the output destination directory of the message log output by the EADs client.
${ejbserver.log.directory}
09-50

webserver.eadssfo.eads.logger.message.console.enable
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify whether to enable the output of the message log, output by the EADs client, to the standard output.
#4
09-50

webserver.eadssfo.eads.logger.message.filenum
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the number of message log files output by the EADs client.
#4
09-50

webserver.eadssfo.eads.logger.message.filesize
This property defines the EADs client to be used with the EADs session failover functionality #3.
Specify the file size (unit: byte) per message log file output by the EADs client.
#4
09-50

webserver.eadssfo.enabled
Specify whether to enable the EADs session failover functionality.

If true is specified:

The EADs session failover functionality is enabled in all the Web applications on the J2EE server.

If false is specified:

The EADs session failover functionality is disabled in all the Web applications on the J2EE server.

false
09-50

webserver.eadssfo.exclude.url_patterns
Specify the URL pattern (exact match specification, prefix match specification, and extension match specification) for controlling the EADs session failover functionality.
If the specified URL pattern and request URI match, the EADs session failover functionality is disabled for that request.
For the exact match specification and prefix match specification comparisons, the values are case sensitive.
For the extension match specification, the values are not case sensitive.
If you do not want to control the EADs session failover functionality, specify a null string.
To specify multiple URL patterns, delimit the values with semi-colons (;).
*.txt;*.htm;*.html;*.jpg;*.gif;*.js
09-50

webserver.eadssfo.session.cache.name
Specify the cache name of the session information cache to be used with the EADs session failover functionality.
EADsSFO_SESSIONS
09-50

webserver.eadssfo.session_read_only.url_patterns
Specify the URL patterns (exact match specification, prefix match specification, and extension match specification) to be considered as read-only requests in the EADs session failover functionality.
If the specified URL pattern and request URI match, that request becomes a read-only request.
For the exact match specification and prefix match specification comparisons, the values are case sensitive.
For the extension match specification, the values are not case sensitive.
If you do not want to set up a read-only request, specify a null string.
To specify multiple URL patterns, delimit the values with semi-colons (;).
None
09-50

#1

For retry count (webserver.eadssfo.client.retry.count) retry interval (webserver.eadssfo.client.retry.interval), specify a value that is greater than the interval in which an EADs server with an error is deleted from the cluster during EADs server cluster monitoring.

The maximum interval in which an EADs server with an error is deleted from the cluster is obtained using the following formula from the value set for the EADs server:

Heartbeat sending interval (eads.cluster.heartbeat.interval) 2 + heartbeat timeout value (eads.cluster.heartbeat.timeout) + (connection timeout during existence check (eads.cluster.failureDetector.connect.timeout) or receiving timeout during existence check (eads.cluster.failureDetector.read.timeout) whichever is larger) (1 + retry count in the case of an existence check timeout (eads.cluster.failureDetector.retry))

#2

If omitted, the KDJE34454-E message is output, and the Web application using the EADs session failover functionality fails to start.

#3

This depends on the EADs client definition specifications. For details, see the Elastic Application Data store User Guide. Note that the name obtained by removing webserver.eadssfo. from the key name corresponds to the EADs parameter name.

#4

The default value of the EADs client definition is applied.

(ao) Keys beginning with webserver.errorpage

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.errorpage.stack_trace.enabled
Specify whether to output stack trace in the default error page, when an exception occurs.

If you specify true:

The stack trace will be output.

If you specify false:

The stack trace will not be output.

If you specify a string other than true or false, or if you specify a null character string or a whitespace#, a message is output and the default value will be set.
false
--

Legend:

--: Indicates a version earlier than the version 08-00.

#

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(ap) Keys beginning with webserver.http

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.http.request.encoding
Specify the character encoding to be used in the request body and query decoding.
The characters that can be specified as the default character encoding are the character encoding supported in the JavaVM. For details about the character encoding supported in JavaVM, see the explanation related to the supported encoding in JDK documentation. The strings that can be specified are the character encoding described in the canonical name for the java.nio API and canonical name for the java.lang API and their optional names.
None
--

webserver.http.request.uri_decode.enabled
Specify whether to decode the servlet path and additional path information.

If you specify true:

Perform decoding.

If you specify false:

Do not perform decoding.

false
08-00

webserver.http.response.encoding
Specify the character encoding to be used in the encoding of the response body.
The characters that can be specified as the default character encoding are the character encoding supported in the JavaVM. For details about the character encoding supported in JavaVM, see the explanation related to the supported encoding in JDK documentation. The strings that can be specified are the character encoding described in the canonical name for the java.nio API and canonical name for the java.lang API and their optional names.
None
--

Legend:

--: Indicates a version earlier than the version 08-00.

(aq) Keys beginning with webserver.jsp

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.jsp.additional.import.list
Specify the class name (class name of a fully qualified name or package-name.*) to be imported implicitly during JSP compilation. To specify multiple class names, demarcate the class names with a comma (,). If you specify an invalid value, such as a non-existent class name or a class name not existing in a class path, a message is displayed and a compilation error occurs.
None
08-70

webserver.jsp.check_interval
Specify an integer from 0 to 2147483647​ (units: seconds) for the interval to detect an update in JSP.
If you specify 0, the update will not be automatically detected.
If the JSP reload functionality is disabled, you cannot set this property. If you set this property, it is ignored.
If you specify a non-numeric value, a numeric value outside the range, or a null character string, a message is output and the default value will be set.
Value set in ejbserver.deploy.context.check_interval (default value: 0)
--

webserver.jsp.compile.backcompat
Specify the version of java source code during compilation of java source of the servlets generated from JSP. Specify this property when compilation cannot be done in the JavaVM version provided by Cosminexus, since the Java code is coded in JSP by the scripting of a JSP generated in an older version. If there is no dependence on the Java VM version, either omit this property or specify false.
The values that can be specified are as follows:

1.5 or 5:

Specify 1.5 or 5 when the JavaSE 5.0-dependent source code is coded in the scripting of a JSP file.

1.4:

Specify 1.4 when the J2SE 1.4-dependent source code that is considered as an error in J2SE 5.0, is coded in the scripting of a JSP file.

1.3:

Specify 1.3 when the J2SE 1.4-dependent source code that is considered as an error in J2SE 5.0, is coded in the scripting of a JSP file.

1.2:

Specify 1.2 when the J2SE 1.2-dependent source code that is considered as an error in J2SE 5.0, is coded in the scripting of a JSP file.

true:

Specify 1.2 when the J2SE 1.2-dependent source code that is considered as an error in J2SE 5.0, is coded in the scripting of a JSP file.

false:

Specify false when there is no dependence on the version of J2SE, whether or not scripting is coded in the JSP file.

If you specify a string other than a specifiable parameter value, a null character string, or a whitespace#, a message is output, and the default value will be set.
false
--

webserver.jsp.el2_2.enabled
Switches the processing nodes of EL 2.1 and EL 2.2.

true:

EL 2.2 is used.

false:

EL 2.1 is used.

true
09-00

webserver.jsp.precompile.jsp_work_dir
Specify the directory name for storing the compilation results of the JSP file generated by the JSP pre-compile functionality.
You specify the directory name with a string consisting of single-byte alphanumeric characters (A-Z, a-z, 0-9) or underscores (_).
If you specify an invalid value, a message is output and the default value will be set. If the following reserved words are specified, a message is output and the default value will be used.

classes

lib

tags

cosminexus_jsp_work
--

webserver.jsp.keepgenerated
Specify whether to store the java file generated by compiling the JSP files or the tag files.
You specify the following values:

If you specify true:

The java file will be stored.

If you specify false:

The java file will not be stored.

false
--

webserver.jsp.pageEncoding
Specify the character encoding for JSP. The characters that can be specified as the default character encoding are the character encoding supported in the JavaVM. For details about the character encoding supported in JavaVM, see the explanation related to the supported encoding in JDK documentation. The strings that can be specified are the character encoding described in the canonical name for the java.nio API and canonical name for the java.lang API and their optional names.
None
--

webserver.jsp.translation.backcompat.customAction.declareVariable
Specify whether to output the variable declaration of the script variable corresponding to the second custom tag in the Java code created from JSP files, when the script variable name and the script variable scope overlap in multiple custom tags.

true:

The script variable from second time onwards is declared.

false:

The script variable from second time onwards is not declared. You can specify the scope of the (*) script variable with the scope element in the variable elements of the subclass of the javax.servlet.jsp.tagext.TagExtraInfo class or the TLD file.

false
--

webserver.jsp.translation.backcompat.tag.noCheckRtexprvalue
Specify whether to verify the specification of Expression in an attribute value of a tag in which Expression cannot be specified.

true:

Do not verify whether the Expression is specified.

false:

Verify whether the Expression is specified.

false
--

webserver.jsp.translation.backcompat.tag.rtexprvalueTerminate
The attribute value of the tag begins with '<%= or '<%=. Specify whether to treat the value enclosed with (or ') of the attribute value that does not end with %> (specify %>' when it starts with '<%).

true:

Treated as a string until ".

false:

Treated as the attribute value until %>".

false
--

webserver.jsp.translation.backcompat.taglib.noCheckPrefix
Specify whether to check the availability of the description of custom tags where the prefix specified in the taglib directive is used before the tablib directive.

true:

Do not check.

false:

Check.

false
--

webserver.jsp.translation.backcompat.useBean.noCheckClass
Specify whether to execute the check processing of a class attribute value of the <jsp:useBean> tag in JSP translation.

true:

Do not check the class attribute value.

false:

Check the class attribute value.

false
--

webserver.jsp.update.interval
Specify an integer from 0 to 2147483647​ (units: seconds) for the interval required to copy the files that are to be monitored for JSP reload. Specify extra time for the interval. JSP is reloaded after the lapse of the interval specified after detecting JSP file update.
If the JSP reload functionality is disabled, you cannot set this property. If you set this property, it is ignored.
If you specify a non-numeric value, a numeric value outside the range, or a null character string, a message is output and the default value will be set.
Value set in ejbserver.deploy.context.update.interval (default value: 0)
--

webserver.jsp.translation.customAction.ignoreCaseAttributeName
Specify whether to differentiate upper and lower cases when checking whether the attributes specified in the custom tags are defined in the TLD files or tag files.

If you specify true:

The case will be ignored.

If you specify false:

The case will be considered.

false
08-00

webserver.jsp.translation.useBean.noCheckDuplicateId
Check whether the id attribute value of the <jsp:useBean> tag is duplicated. If true, a translation error will not occur even if the id attribute value is duplicated. If false, a translation error will occur if the id attribute value is duplicated.
false
08-00

webserver.jsp.tld.mapping.java_ee_tag_library.enabled
Specify whether TLD of the tag libraries (JSTL, JSF) included in the Java EE specifications and URL will be mapped automatically in Web applications of Servlet 2.5 and later specifications.

If you specify true:

The TLD and URL will be mapped automatically.

If you specify false:

The TLD and URL will not be mapped automatically.

Also, in Web applications of Servlet 2.5 and subsequent specifications, if you want to use a tag library (JSTL and JSF) other than the library provided by the Application Server, specify false.
true
08-00

webserver.jsp.jsp_page.bom.enabled
Specify whether to enable the specifications of BOM-based character encoding in the JSP pages of the Web applications of Servlet 2.5 and later specifications.

If you specify true:

The specifications of BOM-based character encoding will be enabled.

If you specify false:

The specifications of BOM-based character encoding will be disabled.

true
08-00

webserver.jsp.debugging.enabled
Specify whether to enable the JSP debugging functionality. Note that this property is enabled only in the J2EE server mode.

If you specify true:

The JSP debugging functionality will be enabled and SMAP will be embedded in the servlet class file created from the JSP files.

If you specify false:

The JSP debugging functionality will be disabled.

false
08-00

Legend:

--: Indicates a version earlier than the version 08-00.

#

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(ar) Keys beginning with webserver.logger

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.logger.access_log.inprocess_http.enabled
Specify enable or disable for the access log functionality of the in-process HTTP server.

If you specify true:

The access log functionality will be enabled.

If you specify false:

The access log functionality will be disabled.

If you specify a string other than true or false, or if you specify a null character string or a whitespace#1, a message is output and the default value will be set.
true
--

webserver.logger.access_log.format_list
Specify the format name to be used in the access log functionality of the in-process HTTP server.
The maximum length of the string that can be specified is 1024 characters. Specify the format name with a string consisting of alphanumeric characters (A-Z, a-z, 0-9) or underscores (_). The maximum string length of one format name is 32 characters. This key treats format_list and mode_list as invalid format names; therefore, you cannot specify them as format names. When specifying multiple format names, demarcate them with comma (,). The format name set first is treated as the default format name. You cannot specify the same format name multiple times. The formats common and combined are reserved formats of the access log functionality; therefore, you cannot specify them.

(Setup format)

format-name(,format-name)*

(( )*: Indicates 0 or more iterations of the part in square brackets (( )))

In the following case, a message is output and the default value will be set:

No string is specified.

The format name exceeds 32 characters.

An invalid format name is specified.

The maximum length of the value that can be specified in the property has exceeded 1024 characters.

The same format name has been specified multiple times.

Either one or both the reserved formats common and combined have been deleted.

common,combined
--

webserver.logger.access_log.format-name
Specify the format#2 of the access log format that is defined in format-name, with format arguments.
The maximum length of the value that can be specified is 1024 characters. The usable characters include the Ascii code from 32 (decimal) to 127 (decimal).
For setting all format names defined in webserver.logger.access_log.format_list, you need to set webserver.logger.access_log.format-name. If this property is set by a format name that has not been defined in webserver.logger.access_log.format_list, this property is disabled. You need not, however, specify the format names common and combined. If you specify the format names common and combined, this property is disabled.
If you do not specify a string, or the format exceeds 1024 characters, or if you specify characters outside the range, a message is output and the default value will be set.
%h %l %u %t "%r" %>s %b
--

webserver.logger.access_log.inprocess_http.filename
Specify an absolute path for the file name#3 that outputs the log used in the access log functionality of the in-process HTTP server. The maximum length of the value that can be specified is 210 characters.
If you specify a string exceeding 210 characters, or if you specify a numeric value or characters outside the range, or if you do not specify a string, a message is output and the default value will be set.
If the specified directory does not exist, a directory is created. If a directory is not created, invocation of J2EE server fails.

In Windows
Cosminexus-working-directory\ejb\server-name\logs\http\cjhttp_access.inprocess_http

In UNIX
Cosminexus-working-directory /ejb/server-name/logs/http/cjhttp_access.inprocess_http

--

webserver.logger.access_log.inprocess_http.filenum
Specify an integer from 1 to 256 for the number of Web container log files of the in-process HTTP server.
If you specify a non-numeric value, or a numeric value outside the range, or if you do not specify a string, a message is output and the default value will be set.
16
--

webserver.logger.access_log.inprocess_http.filesize
Specify an integer from 4096 to 2147483647​ (units: bytes) for the size of the access log file of the in-process HTTP server.
If you specify a non-numeric value, or a numeric value outside the range, or if you do not specify a string, a message is output and the default value will be set.
The decision of wraparound of the access log file is taken before writing the log, therefore, the specified file size may exceed in some cases.
4194304​
--

webserver.logger.access_log.inprocess_http.usage_format
Choose the format to be used in the access log functionality of the in-process HTTP server.
If you do not specify a string or if you specify a format name that has not been defined, a message is output and the default value will be set.
common
--

webserver.logger.communication_trace.inprocess_http.filenum
Specify an integer from 1 to 256 for the number of communication trace functionality log files of the in-process HTTP server.
If you specify a non-numeric value, or a numeric value outside the range, or if you do not specify a string, a message is output and the default value will be set.
16
--

webserver.logger.thread_trace.inprocess_http.filenum
Specify an integer from 1 to 256 for the number of thread trace functionality log files of the in-process HTTP server. If you specify a non-numeric value, or a numeric value outside the range, or if you do not specify a string, a message is output and the default value will be set.
16
--

Legend:

--: Indicates a version earlier than the version 08-00.

#1

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

#2

The following table describes the specifiable format arguments and the examples of output:

Format argument
Output contents
Examples of output

%%
% sign
%

%a
IP address of Web client.
10.20.30.40

%A
IP address of J2EE server.
10.20.30.100

%b
Number of sent bytes excluding the HTTP header. Use "--" In the case of 0 bytes.
2048

%B
Number of sent bytes excluding the HTTP header. Use "--" In the case of 0 bytes.
1024

%h
Host name or IP address of the Web client. The IP address is used, if the host name is not acquired.
10.20.30.40

%H
Request protocol.
HTTP/1.1

%l
Remote log name (User name of Web client that is acquired by the Identification protocol stipulated in RFC 1413).
-

%m
Request method.
GET

%p
Port number that receives requests from the Web client.
80

%q
Query string. Starts with "?". If there is no query string, it is assumed as a blank character.
?id=100&page=15

%r
Request line.
GET /index.html HTTP/1.1

%>s
Final status code (an internally redirected value is not output).
200

%S
Session ID of the user. Use "--" if there is no session ID.
A memory session ID displayed as %S is the value of the cookie name JSESSIONID and is different from the global session ID of the session failover functionality. If the global session ID is to be output, specify %GSESSIONIDc. If GIDCookieName is changed, specify the value of the changed GIDCookieName.
00455AFE4DA4E7B7789F247B8FE5D605

%t
Time when the processing of the requests from the Web client started (dd/MMM/YYYY:HH:mm:ss Z)
[18/Jan/2005:13:06:10 +0900]

%T
The time (units: seconds) required for processing a request from the Web client.
2

%d
Time when the processing of the requests from the Web client started. Display in the following format: (dd/MMM/YYYY: HH: mm: ss.nnn Z) (nnn indicates milliseconds)
[18/Jan/2005:13:06:10.152 +0900]

%D
The time (units: milliseconds) required for processing a request from the Web client.
2000

%u
Basic authentication user name or form authentication user name. Use "--" if there is no authentication user name.
user

%U
Request file path.
/index.html

%v
Local host name of J2EE server.
server

%{foo}i
Contents of the request header foo. Use "--" if foo header does not exist.
If the same header name is sent multiple times in one HTTP request or HTTP response, the contents of the header that is read first will be output.
In the case of %{Host}i
www.example.com:8888

%{foo}c
In the Cookie information sent by the Web client, the name of the Cookie is the foo content. If the name of the Cookie does not contain foo, it becomes "--".
n the case of %{JSESSIONID}c
00455AFE4DA4E7B7789F247B8FE5D605

%{foo}o
Contents of the response header foo. Use "--" if foo header does not exist.
If the same header name is sent multiple times in one HTTP request or HTTP response, the contents of the header that is read first will be output.
In the case of %{Server}o
CosminexusComponentContainer

#3

serial-number.log is added at the end of a file name.

(as) Keys beginning with webserver.servlet

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.servlet_api.exception.getCause.backcompat
Specify settings in such a way so that the root cause exception specified in the constructors ServletException(String, Throwable) and ServletException(Throwable) of javax.servlet.ServletException cannot be acquired using getCause().
Specify settings in such a way so that the root cause exception specified in the constructors JspException(String, Throwable) and JspException(Throwable) of javax.servlet.jsp.JspException cannot be acquired using getCause().

If you specify true:

You cannot acquire the root cause exception.

If you specify false:

You can acquire the root cause exception.

false
08-00

(at) Keys beginning with webserver.ServletContainerInitializer_jar

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Contents | Default value | VR
webserver.ServletContainerInitializer_jar.include.path | Specify the path of the JAR file that includes the ServletContainerInitializer implementation class as an absolute path. When specifying multiple methods, demarcate them with a comma (,). Use a forward slash (/) as the directory delimiter. | None | 09-00

(au) Keys beginning with webserver.session

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.session.cookie_config.http_only
Specify whether to add the HttpOnly attribute to the HTTP Cookie indicating the session ID of an HTTP session created with a Web application.

If true is specified:

The HttpOnly attribute is added to the HTTP Cookie indicating the session ID of an HTTP session created with a Web application.

If false is specified:

The HttpOnly attribute is not added to the HTTP Cookie indicating the session ID of an HTTP session created with a Web application.

false
09-50

webserver.session.cookie_config.name
Specify the name of the HTTP Cookie indicating the session ID of an HTTP session created with a Web application, or the path parameter name of the URL.

Notes:

If true is specified for the webserver.container.server_id.enabled key, specify a value different from the webserver.container.server_id.name key. If you specify the same value as the webserver.container.server_id.name key, the value in the webserver.container.server_id.name key is given priority. The default value is used for the Cookie name specified in this key, and a warning message (KDJE39008-W) is output.

For the HTTP Cookie name

JSESSIONID

For the URL path parameter

jsessionid

09-50

webserver.session.delete_cookie.backcompat
Specify whether to delete the HTTP Cookie indicating the session ID maintained by the Web client when the HTTP session is disabled.

If you specify true:

When the HTTP session is disabled, the HTTP Cookie indicating the session ID maintained by the Web client will not be deleted.

If you specify false:

When the HTTP session is disabled, an HTTP Cookie that will be used for deleting the HTTP Cookie indicating the session ID maintained by the Web client will be added in the HTTP response header.

false
08-00

webserver.session.max.log_interval
Specify an integer from 0 to 2147483647​ (units: seconds) for the interval to output the following messages:

KDJE34380-E
This message is output when an attempt is made to generate HttpSession objects in excess of the number of records while the database session failover functionality is being used.

KDJE39225-E
This message is output when an attempt is made to generate HttpSession objects in excess of the upper-limit of the number of HttpSessions.

After the message KDJE39225-E is output, the output of this message again during the interval specified in this property will be prevented. If you specify 0, you cannot control the output of the message KDJE39225-E. Note that this setting is applicable in each Web application.
If you specify a non-numeric value or a numeric value outside the range, a warning message is output and the default value will be set.
60
--

webserver.session.max.throwHttpSessionLimitExceededException
Specify whether to throw the com.hitachi.software.web.session.HttpSessionLimitExceededException exception when the number of HTTP session objects exceeds the upper limit.

If you specify true:

The com.hitachi.software.web.session.HttpSessionLimitExceededException exception that is a derived class of the java.lang.IllegalStateException exception will be thrown.

If you specify false:

The java.lang.IllegalStateException exception will be thrown.

false
08-00

webserver.session.server_id.enabled
Specify whether to append server ID to the session ID.

If you specify true:

The server ID will be appended to the session ID.

If you specify false:

The server ID will not be appended to the session ID.

Generally, specify true and specify the server ID in webserver.session.server_id.value. If you migrate from 06-51 or an earlier version to 06-70 or a later version, the default value of this property will change from false to true. As compared to false, in the case of true, the string length of the session ID increases to the extent of the length of server ID. If a problem occurs because of this, take the following measures:

When the system is not built with multiple Web containers in a redundant configuration, by a load balancer:

Specify false and server ID will not be appended to the session ID.

When the system is built with multiple Web containers in a redundant configuration, by a load balancer:

Specify true and take measures against the problems that occur due to an increase in the string length of the session ID. If you specify false, the operation may not produce the desired results.

If you specify a string other than true or false, or if you specify a null character string or a whitespace#, a message is output and the default value will be set.
true
--

webserver.session.server_id.value
Specify a string from 1 to 64 characters for the server ID that is to be appended to the session ID. You can use single-byte alphanumeric characters (A-Z, a-z, 0-9) or underscores (_).
If you specify true in webserver.session.server_id.enabled, and this property is omitted, or else if you specify an invalid value, a null character string or a whitespace# in this property, a message is output and the default value will be set.
String generated using the hash function from the host name and J2EE server name/Web container server name (compatibility functionality). The generated value is a 64-character hexadecimal number.
--

webserver.session.tracking_mode
Specify the method of managing the HTTP sessions created with a Web application. You can either specify COOKIE or URL, or both. When you specify both the session management methods, use a comma (,) to delimit between COOKIE and URL. Note that the single-byte spaces before and after COOKIE or URL are ignored.

If only COOKIE is specified

Only the HTTP Cookie-based session management is enabled. In this case, the URL path parameter indicating the session ID is not included in the string generated by URL rewriting.

If only URL is specified

Only the URL rewriting-based session management is enabled. In this case, the HTTP Cookie information indicating the session ID is not included in the response.

If both COOKIE and URL are specified:

Both HTTP Cookie-based session management and URL rewriting-based session management are enabled.

COOKIE, URL
09-50

Legend:

--: Indicates a version earlier than the version 08-00.

#

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(av) Keys beginning with webserver.static

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.static_content.cache.enabled
Specify enable/disable/forcibly disable the functionality for caching static contents.

If you specify true:

The functionality for caching static contents will be enabled.

If you specify false:

The functionality for caching static contents will be disabled.

If you specify forceoff:

Even if the functionality for caching static contents has been enabled in the DD file (web.xml) or the HITACHI Application Property file, the cache functionality will be forcibly disabled.

When this property is false and forceoff, the setting of webserver.static_content.cache.size and webserver.static_content.cache.filesize.threshold becomes disabled.
In a Web application, wherein the functionality for caching the static contents is not specified as either enable or disable in the DD file (web.xml) or the HITACHI Application Property file, the value specified in this property becomes valid. In a Web application, wherein the functionality for caching the static contents is set as either enable or disable, the value specified in this property becomes invalid. If, however, you specify forceoff, the value specified in this property becomes valid, irrespective of the settings of the DD file (web.xml) or the HITACHI Application Property file.
If a string other than true, false, forceoff, or a null character string or whitespace# are specified, a message is output and the default value will be set.
false
--

webserver.static_content.cache.size
Specify an integer from 0 to 2147483647​ for the upper limit of the size (units: bytes) that can be cached in the memory when the functionality for caching static contents is enabled.
If the value specifying the total cache size in each Web application is exceeded, deletion will begin from the cache with the longest no access time and the deletion of cache repeats until the total size of the cache becomes lesser than the set value.
If you specify 0, no upper limit is set for the cacheable size.
In a Web application, wherein the cacheable memory size is not set in DD (web.xml) or the HITACHI Application Property file, the value specified in this property becomes valid. In a Web application, wherein the cacheable memory size is set, the value specified in this property becomes invalid.
If you specify an invalid value, a value lesser than that specified in webserver.static_content.cache.filesize.threshold, a null character string, or a whitespace#, a message is output and the default value will be set.
10485760​
--

webserver.static_content.cache.filesize.threshold
Specify an integer from 0 to 2147483647​ for the file size (units: bytes) that can be cached, when the functionality for caching static contents is enabled.
A file of a size exceeding the specified value does not get cached.
If you specify 0, no upper limit is set for the file size that can be cached.
In a Web application, wherein the file size that can be cached is not set in DD (web.xml) or the HITACHI Application Property file, the value specified in this property becomes valid. In a Web application, wherein the file size that can be cached is set, the value specified in this property becomes invalid.
If you specify an invalid value, a value greater than that specified in webserver.static_content.cache.size, a null character, or a whitespace#, a message is output and the default value will be set.
524288
--

webserver.static_content.encoding.extension
Specify an extension to be applied to the character encoding used for static contents. This key is enabled when the webserver.http.response.encoding key is specified.
If the value is not specified for the key, this key is disabled.
None
--

Legend:

--: Indicates a version earlier than the version 08-00.

#

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(aw) Keys beginning with webserver.work

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.work.clean
Specify whether to delete the directory created below the temporary directory for JSP, when starting and shutting down the server.

If you specify true:

The directory will be deleted.

If you specify false:

The directory will not be deleted.

false
--

webserver.work.directory
Specify an absolute path for the temporary directory for JSP. Specify the directory name.#
Use a forward slash (/) as the delimiter in the directory path.
For example, in Windows, if C\temp\work is to be set as the work directory, specify as follows:
(Example of specification)
webserver.work.directory=c:/temp/work

In Windows
Cosminexus-installation-directory\CC\server\repository\server-name\web

In UNIX
/opt/Cosminexus/CC/server/repository/server-name/web

--

Legend:

--: Indicates a version earlier than the version 08-00.

#

The length of the file name is restricted based on the OS to be used. For example, in Windows, the file name is restricted to around 250 bytes. As a result, the servlets and JSPs cannot be executed at a location wherein the directory hierarchy is deep. Particularly, a file name generated from a JSP file becomes longer in proportion to the depth of the directory hierarchy deployed in a Web application and it may not be possible to generate a Java file for a JSP file. To avoid this, make a shallow hierarchy of the directories deployed in a Web application and specify a shallow directory hierarchy by an absolute path in the property webserver.work.directory. For details on the Cosminexus work directory, see Appendix C.1 Work directory of the J2EE servers in the manual uCosminexus Application Server System Setup and Operation Guide.

(ax) Keys beginning with webserver.xml

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name
Contents
Default value
VR

webserver.xml.validate
Specify whether to check if the tag library descriptor (TLD file) in the Web application of Servlet 2.3 has been written as per the schema coded in DTD.
The specification of this property is disabled in web.xml invoked in the J2EE server mode and in the TLD files of the Web applications of Servlet 2.4 and later versions. All the TLD files included in the Web applications of Servlet 2.4 and later versions are checked, irrespective of the version of TLD.
You specify the following values:

If you specify true:

Only the tag library descriptor will be checked.

If you specify false:

Check will not be performed.

true
--

Legend:

--: Indicates a version earlier than the version 08-00.

(6) Examples of coding

ejbserver.server.j2ee.feature=1.4

ejbserver.deploy.stub.generation.scope=ejb
ejbserver.compiler.jvm.maxHeapSize=256m
ejbserver.compiler.jvm.minHeapSize=32m

ejbserver.naming.host=localhost
ejbserver.naming.port=900
ejbserver.naming.protocol=corbaname
ejbserver.naming.startupMode=inprocess
ejbserver.naming.startupWaitTime=1
ejbserver.naming.startupRetryCount=9

ejbserver.logger.enabled.*=Error,Warning,Information,Debug
ejbserver.logger.channels.define.MessageLogFile.filenum=2
ejbserver.logger.channels.define.MessageLogFile.filesize=1048576

ejbserver.application.InitTermProcessClasses=InitTermClass1,InitTermClass2

webserver.connector.http.permitted.hosts=host1,host2
webserver.work.directory=c:/work

2.5 server.policy (Security policy file for J2EE servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Examples of coding

(5) Notes

(1) Format

The security policy file follows the format of the security policy file of J2SE.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the security policy of the JavaVM that executes the J2EE servers.

If you change the contents of this file while the J2EE server is running, the changes become effective only when the J2EE server is started next.

(4) Examples of coding

The contents of the used policy file are as follows:

// (1)
// Grant all permissions to the java extensions
grant codeBase "file:${java.home}/lib/ext/-" {
permission java.security.AllPermission;
};

// (2)
// Grant all permissions to the java tools, etc
// Note: java.home is the jre, not the installation dir for the jdk
grant codeBase "file:${java.home}/../lib/*" {
permission java.security.AllPermission;
};

// (3)
// Grant all permissions to anything loaded from the
// EJB server itself

grant codeBase "file:${ejbserver.install.root}/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${tpbroker.java.home}/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/DABJ/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/manager/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/c4web/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/c4web/exlib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/jaxws/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/jaxrs/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/jaxp/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/CTM/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/PRF/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/wss/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/XMLSEC/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${ejbserver.install.root}/sfo/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${hntrlib.home}/classes/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/common/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${ejbserver.install.root}/weld/lib/*" {
permission java.security.AllPermission;
};

// (4)
// Grant all permissions to the container generated stubs and
// implementation classes
grant codeBase "file:${ejbserver.http.root}/ejb/${ejbserver.serverName}/containers/-" {
permission java.security.AllPermission;
};

// (5)
// Grant all permissions to imported resource (datasource) implementations
// implementation classes
grant codeBase "http://*/ejb/${ejbserver.serverName}/import/resjars/-" {
permission java.security.AllPermission;
};

// (6)
// Grant permissions to resource adapters
//
grant codeBase "file:${ejbserver.http.root}/ejb/${ejbserver.serverName}/rarjars/-" {

// For uCosminexus TP1 Connector & TP1/Client/J
permission java.util.PropertyPermission "*", "read, write";

// For uCosminexus TP1 Connector & TP1/Client/J & Cosminexus Reliable Messaging
permission java.io.FilePermission "<<ALL FILES>>", "read, write, delete";
permission java.net.SocketPermission "*", "connect,listen,accept";

// For TP1/Message Queue - Access
permission java.lang.RuntimePermission "loadLibrary.*";

// For TP1/Message Queue - Access & Cosminexus Reliable Messaging
permission java.lang.RuntimePermission "modifyThreadGroup";
permission java.lang.RuntimePermission "modifyThread";

// For DB Connector
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";

// For authentication (from J2EE RI server.policy file)
permission javax.security.auth.PrivateCredentialPermission "* * \"*\"", "read";

// For Cosminexus Reliable Messaging
permission javax.security.auth.AuthPermission "modifyPrivateCredentials";
permission java.lang.RuntimePermission "getenv.HRMDIR";

// For Cosminexus SOA FTP Inbound Adapter
permission java.lang.RuntimePermission "getClassLoader";
permission java.lang.RuntimePermission "setContextClassLoader";
permission java.lang.RuntimePermission "accessDeclaredMembers";
};

// (7)
// Grant permissions to JSP/Servlet
//
grant codeBase "file:${ejbserver.http.root}/web/${ejbserver.serverName}/-" {
permission java.lang.RuntimePermission "loadLibrary.*";
permission java.lang.RuntimePermission "queuePrintJob";
permission java.net.SocketPermission "*", "connect";
permission java.io.FilePermission "<<ALL FILES>>", "read, write";
permission java.util.PropertyPermission "*", "read";
permission javax.security.auth.AuthPermission "getSubject";
permission javax.security.auth.AuthPermission "createLoginContext.*";
};

// (8)
// Grant permissions to Cosminexus Service Coordinator
//
grant codeBase "file:${cosminexus.home}/CSC/lib/*" {
permission java.security.AllPermission;
};

// (9)
// Grant permissions to custom login modules
//
grant codeBase "file:${cosminexus.home}/manager/modules/-" {
permission java.io.FilePermission "<<ALL FILES>>", "read";
permission javax.security.auth.AuthPermission "modifyPrincipals";
permission javax.security.auth.AuthPermission "modifyPublicCredentials";
};

// (10)
// Grant minimal permissions to everything else:
// EJBs
// client implementation classes
grant {
permission java.util.PropertyPermission "*", "read";
permission java.lang.RuntimePermission "queuePrintJob";
permission java.net.SocketPermission "*", "connect";
};

The examples of coding from (1) to (10) are as follows:

(1)

Grant the following permission to the class files present below ext directory of JDK:

Grant all access permissions

(2)

Grant the following permission to the class files present below lib directory of JDK:

Grant all access permissions

(3)

Grant the following permission to the class files used in a J2EE server:

Grant all access permissions

(4)

Grant the following permission to class files, such as stub and skeleton that are generated by the J2EE server.

Grant all access permissions

(5)

Grant the following permission to the class files of the resources used by a J2EE server:

Grant all access permissions

(6)

Grant the following access permissions to the class files of the resource adapters used by a J2EE server:

Allow read and write of the entire property information

Allow read, write, and deletion of all files

Allow connection to the network, standby for connection, and acceptance of a connection for all socket communications

Allow loading of all libraries

Allow changing of thread groups

Allow changing of threads

Allow all reflection operations

Allow access to all private Credentials owned by any Subject

Allow changing of sets of private Credentials correlated to the Subject

Allow the collection of values for the environment variable HRMDIR

The class loader can be obtained

The context class loader can be set up

The declared class members can be accessed

Note

The directory managed by the J2EE server which is the deployment destination of JAR files in the resource adapter is described.

All resource adapters running in the J2EE server are within the valid range.

(7)

Grant the following access permissions to the class files of JSPs and servlets:

Allow loading of all libraries

Allow print job requests

Allow network connection for all socket communications

Allow read and write for all files

Allow read of the entire property information

Subject reference is permitted

The LoginContext class can be instantiated with any name

(8)

Grant the following access permissions to the class files of Cosminexus Service Coordinator:

Grant all access permissions

(9)

The custom login module for integrated user management has the following permissions:

All the files can be read

Principal and Credential can be added in Subject

(10)

Grant the following access permissions to all class files:

Allow read of the entire property information

Allow print job requests

Allow network connection for all socket communications

(5) Notes

If you use the server.policy file with an invalid syntax or without appropriate access permissions, java.lang.StackOverflowError or java.lang.OutOfMemoryError occurs, and the J2EE server might terminate abnormally.

The minimum required access permissions for operating the J2EE server is coded in the server.policy file generated when setting up the server. Do not delete and change the coding lines in the generated server.policy file.

2.6 criticalList.cfg (Protected areas list file)

Set the classes that prohibit method cancellation in the protected area.

If you need to set this protected areas list file, you specify the settings as per the instructions provided in the notes of the documents provided with the configuration software of each Cosminexus product and the related products.

Organization of this section

(1) Format

(2) File storage location

(3) Examples of coding

(4) Precautions

(1) Format

Specify the definition file in the following format:

element

You can specify either of the following in element.

class-name
Specify the class name to be specified in the protected area.

prefix-name
Specify the prefix name of the package that includes the classes specified in the protected area. All classes having the specified prefix are specified as the protected area.

How to specify:

Specify the specifiable elements by demarcating with a linefeed.

A blank line is ignored.

A line beginning with a hash mark (#) is a comment.

You cannot add a space or a comment after element.
(Example) class-name#comment

Code the class name including the package name. Do not, however, mention the suffix ".class".
(Example) pacA.pacB.pacC.pacD.MyTestClass.class
In this case, code as pacA.pacB.pacC.pacD.MyTestClass.

You cannot specify the prefix of a class name.
(Example) pacA.pacB.pacC.pacD.My*
If you specify a class name in the protected area that uses "My" in the prefix(MyTestClass), you cannot use an asterisk (*) in the class name.
In this case, specify as pacA.pacB.pacC.*.

You cannot specify only an asterisk (*).

The single-byte space before and after element is ignored.

The double-byte spaces before and after element are treated as characters and are considered as invalid values.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\

In UNIX
/opt/Cosminexus/CC/server/usrconf/

(3) Examples of coding

When specifying a prefix name

#specify-prefix-name
pacA.pacB.*

All classes below the package pacA.pacB as well as those included in the package will form the protected area.

For example, if pacA.pacB.pacC.pacD is present below the package pacA.pacB.pacC, all classes below pacA.pacB.pacC.pacD will also become the protected area.

When specifying a class name

#specify-class-name
pacX.pacY.pacZ.MyTestpacX.pacY.pacZ.CommonTest

(4) Precautions

The protected areas list file is a product-based definition. This file is enabled in all the J2EE servers running on the machine on which the Cosminexus Component Container is installed.

The protected areas list file is read when starting a J2EE server. If you want to enable the changed contents, you need to restart the J2EE server.

If the protected areas list file does not exist or if the settings are invalid when starting a J2EE server, the J2EE server fails to start.

3. Files Used in Batch Servers

This chapter describes the storage location, functionality, and format of the files used in batch servers and the keys that you can specify in the files.

Organization of this chapter

3.1 List of files used in batch servers

3.2 usrconf.cfg (Option definition file for batch servers)

3.3 usrconf.properties (User property file for batch servers)

3.4 server.policy (Security policy file for batch servers)

3.5 criticalList.cfg (Protected areas list file)

3.6 usrconf.cfg (Option definition file for batch applications)

3.7 usrconf.properties (User property file for batch applications)

3.1 List of files used in batch servers

The following table lists the files used in batch servers.

Table 3-1 List of files used in batch servers

File name | Classification | Overview | Reference
usrconf.cfg | Option definition file for batch servers | Specify the invocation options of the JavaVM that execute the batch servers. | 3.2
usrconf.properties | User property file for batch servers | Specify the system properties of the JavaVM that execute the batch servers. | 3.3
server.policy | Security policy file for batch servers | Specify the security policy of the JavaVM that executes the batch servers. | 3.4
criticalList.cfg | Protected area list file | Set the classes that prohibit method cancellation in the protected area. | 3.5
usrconf.cfg | Option definition file for batch applications | Specify invocation options for the JavaVM that executes the cjexecjob command, the cjkilljob command, and the cjlistjob command. | 3.6
usrconf.properties | User property file for batch applications | Specify the system properties of the JavaVM that executes the cjexecjob command, and the cjkilljob command. | 3.7

3.2 usrconf.cfg (Option definition file for batch servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) JavaVM options that can be specified with add.jvm.arg

(6) Notes

(1) Format

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

You cannot code with a character encoding that is different from the runtime character encoding.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the invocation options of the JavaVM that execute the batch servers.

If you change the contents of this file while the batch server is running, the changes become effective only when the batch server is started next.

(4) Specifiable keys

The following table describes the specifiable keys and the default values. For details about keys, see 2.3 usrconf.cfg (Option definition file for J2EE servers). Furthermore, when referencing, substitute J2EE server and J2EE application for Batch server and Batch application respectively.

Note

If you use multibyte characters within the files, integrate the multibyte characters and encode used in the following locations:

usrconf.cfg (option definition file for batch applications)

Arguments of the cjexecjob command (batch application execution command)

Source code of the batch application (java.lang.System.out or java.lang.System.err)

Table 3-2 Specifiable keys and default values in usrconf.cfg (batch servers)

Key name
Overview
Default value

add.jvm.arg
This key invokes JavaVM by using the specified option.
For details about the JavaVM options that can be specified in add.jvm.arg, see 3.2(5)(a) JavaVM options that can be specified with the add.jvm.arg key for batch servers.
For details about default values, see 3.2(5)(b) Default values of JavaVM options for batch servers.

add.class.path
Specify JAR for the container extension library.
When you specify a path containing a space, you do not need to enclose the path in double quotation marks ("). Also, the path specified in double quotation marks is invalid.
To add a JAR file in the class path of a batch application class loader, specify the add.class.path key in the option definition file for batch applications.
None

add.library.path#
Specify the shared library for JNI only when the container extension library uses JNI.
None

batch.service.enabled
Do not edit this key manually.
When the batch option is specified in the cjsetup command and executed, true is displayed in the key value.
true (when -batch option is specified in -cjsetup command, and executed)

cpp.library.version
Specify the libstdc++ library version to be used in a process. Note that this key is used for Linux.
The specifiable string is as follows:

6:

Use the libstdc++.so.6 library. This key is disabled even if set up on platforms other than Red Hat Enterprise Linux.

With version 09-00 or later, only 6 can be set up.
6

ejb.public.directory
Start a batch server using the specified directory as the working directory of batch server.

In Windows
Cosminexus-installation-directory\CC\server\public

In UNIX
/opt/Cosminexus/CC/server/public

ejb.server.corefilenum (in UNIX)
Specify the number of core files that remain when restarting a batch server.
1

ejb.server.log.directory
Specify the output location directory of the log file.

In Windows
Cosminexus-working-directory\ejb\server-name\logs

In UNIX
Cosminexus-working-directory/ejb/server-name/logs

ejb.server.log.mode
Specify the output format of the log file.
7

ejb.server.log.stdout.filesize
Specify the upper-limit for the size of the cjstdout.log file.
1048576​

ejb.server.log.stderr.filesize
Specify the upper-limit for the size of the cjstderr.log file.
1048576​

jvm.type
Specify the type of JavaVM to be used.
server

#

If both the add.library.path and OS environment variables (such as LIBPATH) are set up when executing the cjstartsv command or cjstartweb command, the add.library.path settings have a higher priority.

(5) JavaVM options that can be specified with add.jvm.arg

This section describes the JavaVM options that you can specify with add.jvm.arg and the default values for batch servers.

(a) JavaVM options that can be specified with the add.jvm.arg key for batch servers

This subsection describes the JavaVM options that you can specify with the add.jvm.arg key for batch servers. JavaVM options include the options that can be specified as per the standards and the JavaVM extension options. Also, the default values of JavaVM options depend on the server to be used. For details about the JavaVM extension options, see 16.1 List of JavaVM extension options. For details about Java HotSpot VM options, see 16.5 Java HotSpot VM options that can be specified in Cosminexus.

The following are the JavaVM options that you can specify with the add.jvm.arg key for batch servers:

-agentlib:libname[=options]

-Dproperty

-verbose:[class|gc|jni]

-Xloggc:file

-Xmssize

-Xmxsize

-Xmnsize

-Xsssize

-Xprof

-Xrunhprof[:help]|[:option=value, ...]

-XrunlibraryName

-Xdebug

-XX:NewRatio=value

-XX:PermSize=value

-XX:MaxPermSize=value

-XX:SurvivorRatio=value

-XX:[+|-]PrintTenuringDistribution

-XX:TargetSurvivorRatio=value

-XX:MaxTenuringThreshold=value

-Xrunhndlwrap

-agentlib:hndlwrap2

(b) Default values of JavaVM options for batch servers

The following are the default values of JavaVM options for batch servers:

-Xms256m

-Xmx512m

-XX:NewRatio=2

-XX:PermSize=128m

-XX:MaxPermSize=128m

-XX:+HitachiOutOfMemoryStackTrace

-XX:SurvivorRatio=8

-XX:HitachiJavaLog:<ejb.server.log.directory>

-XX:HitachiJavaLogFileSize=4m

-XX:-HitachiUseExplicitMemory

-XX:+HitachiVerboseGC

-XX:+HitachiVerboseGCPrintCause

-XX:+HitachiOutputMilliTime

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiJavaClassLibTrace

-XX:HitachiJavaClassLibTraceLineSize=1024

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiUseExplicitMemory

-XX:HitachiExplicitHeapMaxSize=64m

-XX:HitachiExplicitMemoryLogLevel:normal

-XX:HitachiExplicitMemoryJavaLog:<ejb.server.log.directory>

-XX:HitachiExplicitMemoryJavaLogFileSize=4m

(6) Notes

Among the values specified in the add.class.path key, there are some values for which the <cosminexus.home> tag is used to specify the JAR files for the container extension library. These values indicate the installation destination of Application Server, so you do not need to change the contents coded for the add.class.path key. Note that when you add the container extension library to the add.class.path key, the installation and uninstallation operations might not be guaranteed. Therefore do not use the <cosminexus.home> tag.

3.3 usrconf.properties (User property file for batch servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Keys reserved in batch servers

(5) Keys for customization of batch servers

(1) Format

J2SE property file format.

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.

Specify the path in CJBATCHUSRCONFDIR using an absolute path.

If the format does not conform to Java specifications, the batch server might fail to start.
(Example) When the format contains an invalid Unicode escape sequence (the string after \U is not an appropriate Unicode hexadecimal value).

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the system properties of the JavaVM that execute the batch servers.

If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.

If you change the contents of this file while the batch server is running, the changes become effective only when the batch server is started next.

(4) Keys reserved in batch servers

A batch server internally uses the keys beginning with the following prefixes. As a result, the keys beginning with these prefixes must not be used in applications.

ejbserver.*

webserver.*

appclient.*

j2eeserver.*

(5) Keys for customization of batch servers

You can customize the operations of the batch servers by setting the values in the following system property keys.

The keys are classified and explained as follows:

Keys beginning with ejbserver.application

Keys beginning with ejbserver.batch

Keys beginning with ejbserver.client

Keys beginning with ejbserver.connectionpool

Keys beginning with ejbserver.connector

Keys beginning with ejbserver.container

Keys beginning with ejbserver.ctm

Keys beginning with ejbserver.deploy

Keys beginning with ejbserver.ext

Keys beginning with ejbserver.http

Keys beginning with ejbserver.instrumentation

Keys beginning with ejbserver.jndi

Keys beginning with ejbserver.jta

Keys beginning with ejbserver.logger

Keys beginning with ejbserver.management

Keys beginning with ejbserver.manager

Keys beginning with ejbserver.naming

Keys beginning with ejbserver.rmi

Keys beginning with ejbserver.server

Keys beginning with ejbserver.stdoutlog

Keys beginning with ejbserver.watch

Keys beginning with https

Keys beginning with java

Keys beginning with vbroker

Keys beginning with webserver.connector

The following table gives an overview of the respective specifiable keys and the default values. For details about the keys, see 2.4 usrconf.properties (User property file for J2EE servers). Furthermore, when referencing, substitute J2EE server and J2EE application for Batch server and Batch application respectively.

(a) Keys beginning with ejbserver.application

Key name | Overview | Default value
ejbserver.application.InitTermProcessClasses | When using the container extension library, specify the class name of server start/stop hook. | None
ejbserver.application.userlog.CJLogHandler.handler-name.appname | Specify the default application name that is output to the AppName field. | user_app
ejbserver.application.userlog.CJLogHandler.handler-name.count | Specify the number of log files. | 2
ejbserver.application.userlog.CJLogHandler.handler-name.encoding | Specify encoding of the character strings to be output. | Null
ejbserver.application.userlog.CJLogHandler.handler-name.filter | Specify the filter in use. | Null
ejbserver.application.userlog.CJLogHandler.handler-name.formatter | Specify the formatter in use. | Null
ejbserver.application.userlog.CJLogHandler.handler-name.level | Specify an upper-limit of a log collection level. | SEVERE
ejbserver.application.userlog.CJLogHandler.handler-name.limit | Specify the capacity of a log file. | 1048576​
ejbserver.application.userlog.CJLogHandler.handler-name.msgid | Specify the default message ID that is output to the MsgID field. | 0001
ejbserver.application.userlog.CJLogHandler.handler-name.path | Specify a value from 1 to 255 bytes for the prefix of a log file name. | user_log
ejbserver.application.userlog.CJLogHandler.handler-name.separator | Use the CJSimpleFormatter and specify a separator to output a message in one sentence. | | (Stroke)
ejbserver.application.userlog.loggers | Specify a logger name to be used. | None
ejbserver.application.userlog.Logger.logger-name.filter | Specify the filter used in the logger. | Null
ejbserver.application.userlog.Logger.logger-name.handlers | Specify the handler class for a specified logger name. | None
ejbserver.application.userlog.Logger.logger-name.level | Specify the log output level of the logger. | SEVERE
ejbserver.application.userlog.Logger.logger-name.useParentHandlers | Specify whether the log record is to be transmitted from the logger that received the log record to the handler connected to the parent logger. | true

(b) Keys beginning with ejbserver.batch

Key name
Overview
Default value

ejbserver.batch.application.exit.enabled
Specify operations of a batch server when VM end method is invoked from the batch application.

If you specify true:

The batch application thread will end without terminating the JavaVM.

If you specify false:

The batch server will end.

true

ejbserver.batch.gc.watch.threshold
Specify an integer from 0 to 100 (unit: %) for the threshold value of the memory usage for executing garbage collection. A garbage collection is executed in any of the following conditions. If 0 is specified, garbage collection is not monitored.

The ratio of Tenured area consumption size with Tenured domain total size is more than the threshold value.

The ratio of New area total size with Tenured area maximum free size is more than the threshold value.

The ratio of Permanent area consumption size with Permanent area total size is more than the threshold value.

0

ejbserver.batch.schedule.group.name
Specify a group name for the batch servers managed by CTM within 63 characters having alphanumeric characters and underscore (_).
JOBGROUP

ejbserver.batch.queue.length
Specify the value from 1 to 32767 as the length of the schedule queue created with CTM.
50

Note: This key is a user property file-specific key for batch servers. This key does not exist in the user property file for J2EE servers.

(c) Keys beginning with ejbserver.client

Key name | Overview | Default value
ejbserver.client.ctm.RequestPriority | Specify the priority (priority order) for extracting the request accumulated in the queues within CTM. | 4

(d) Keys beginning with ejbserver.connectionpool

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name | Overview | Default value | Related information
ejbserver.connectionpool.applicationAuthentication.disabled | Specify whether to enable the functionality for optimizing container management sign-on. | false |
ejbserver.connectionpool.association.enabled | Specify whether to enable the connection association functionality. | false | 3.14 Functionality for performance tuning in the Common Container Functionality Guide
ejbserver.connectionpool.sharingOutsideTransactionScope.enabled | Specify the operations of the connection sharing when a connection is acquired multiple times outside the transactions managed by the application server. | false |
ejbserver.connectionpool.validation.timeout | Specify the timeout value for the functionality to detect connection failure and the timeout value (unit: seconds) for deleting connections using the functionality to adjust the number of connections as an integer from 1 to 2147483647​. | 5 |

Legend:

Blank cell: Related information does not exist.

(e) Keys beginning with ejbserver.connector

Key name | Overview | Default value
ejbserver.connector.logwriter.filenum | Specify the number of log files of a resource adaptor. | 4
ejbserver.connector.logwriter.filesize | Specify the size of the log files of a resource adaptor. | 2097152​

(f) Keys beginning with ejbserver.container

Key name | Overview | Default value
ejbserver.container.audit_trail.enabled | Specify whether to enable the database audit trail linkage functionality. | false

(g) Keys beginning with ejbserver.ctm

Key name
Overview
Default value

ejbserver.ctm.ActivateTimeOut
When the scheduling functionality is enabled and a batch server starts, the CTM queue will be activated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647​. If you specify 0, CTM continues to wait infinitely.
180

ejbserver.ctm.CTMDomain
This property is necessary for using the CTM functionality. Specify name of the CTM domain to which the batch server belongs.
CTMDOMAIN

ejbserver.ctm.CTMID
This property is necessary for using the CTM functionality. You specify CTM identifier of the CTM daemon that controls the batch server.
IP-address

ejbserver.ctm.CTMMyHost
This property is necessary for using the CTM functionality. You specify the host name or IP address used by CTM in the node-switching environment that inherits multi-home or IP address.
host-name-acquired-by-hostname-command

ejbserver.ctm.DeactivateTimeOut
When the scheduling functionality is enabled and the batch server stops, the CTM queue will be deactivated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647​.
180

ejbserver.ctm.enabled
Specify whether the scheduling functionality will be used.

If you specify true:

The scheduling functionality will be used. When the batch server starts, a connection with CTM will be established and initialized. When successful, the batch server will start with the available scheduling functionality.

When an attempt to connect and initialize with CTM fails, the batch server will not start.

If you specify false:

The scheduling functionality will not be used. The batch server will start without using the scheduling functionality.

If the version is upgraded from version 07-50 or earlier versions when this property is omitted, you must set up the following values manually depending on the Application Server edition before upgrade:

For Application Server Enterprise:

true

For other editions:

false

false

(h) Keys beginning with ejbserver.deploy

Key name | Overview | Default value
ejbserver.deploy.exclusive.lockAliveInterval | Specify the maximum wait time until the next response sent from the command is received, after completing the server processing. | 60
ejbserver.deploy.resourcefile.scramble.enabled | Specify whether to scramble the DD files related to DataSource, JavaMail, and ResourceAdapter that are expanded below the working directory. | false

(i) Keys beginning with ejbserver.ext

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Overview
Default value
Related information

ejbserver.ext.method_observation.interval
If this property is set, it implies:

Specify whether to use the functionality for monitoring the J2EE application execution time.

Specify the time interval for monitoring whether a request processing during operation has timed out and specify the time interval for canceling the timed out request (method).

0
5. Operating the J2EE Applications in the Operation, Monitoring, and Linkage Guide

(j) Keys beginning with ejbserver.http

Key name | Overview | Default value
ejbserver.http.port | Specify the port number of the simple Web server. | 8080

(k) Keys beginning with ejbserver.instrumentation

Key name | Overview | Default value
ejbserver.instrumentation.enabled | Specify whether to integrate with the Management Server. | true

(l) Keys beginning with ejbserver.jndi

Key name | Overview | Default value
ejbserver.jndi.cache | Specify whether to perform caching in naming. | on
ejbserver.jndi.cache.interval | Specify an interval to clear cache, when caching is performed in naming. | 0
ejbserver.jndi.cache.interval.clear.option | Decide the operations to be performed in the cache area of naming, after the lapse of the interval. | refresh
ejbserver.jndi.cache.reference | Specify whether to use the caching functionality of DataSource object. | off
ejbserver.jndi.namingservice.group.list | Define the group of logical naming service that is to be searched during the round-robin search. | None
ejbserver.jndi.namingservice.group.specify-group-name.providerurls | Specify the root position of naming services belonging to each group, with a provider URL. | None
ejbserver.jndi.request.timeout | Specify the timeout period of communication with the Naming Service. | 0

(m) Keys beginning with ejbserver.jta

Key name | Overview | Default value
ejbserver.jta.TransactionManager.defaultTimeOut | Specify the default value of transaction time-out for the transaction started on the batch server. | 180

(n) Keys beginning with ejbserver.logger

Key name
Overview
Default value

ejbserver.logger.channels.define.channel-name#.filenum
Specify the number of log files of a batch server.

4, when the channel name is MaintenanceLogFile

2, when the channel name is other than above

ejbserver.logger.channels.define.channel-name#.filesize
Specify the size of the log files of a batch server.

16777216​, when the channel name is MaintenanceLogFile

1048576​, when the channel name is other than above

ejbserver.logger.enabled.*
Specify the log level of a batch server.
Error

ejbserver.logger.rotationStyle
Specify the rotation method of the J2EE server log output file.

If you specify SHIFT:

The log file will be rotated in the shift mode.

If you specify WRAP:

The log file will be rotated in the wraparound mode.

WRAP

#

You can set the following names as channel name:

Channels to output logs for the Application Server:
MessageLogFile, MaintenanceLogFile, ExceptionLogFile, ConsoleLogFile, EJBContainerLogFile, UserOutLogFile, UserErrLogFile

Channels for output of resource depletion monitoring log
MemoryWatchLogFile, FileDescriptorWatchLogFile, ThreadWatchLogFile, ThreaddumpWatchLogFile, ConnectionPoolWatchLogFile

For acquiring data, see 2.3 Acquiring data in the manual uCosminexus Application Server Maintenance and Migration Guide.

(o) Keys beginning with ejbserver.management

Key name
Overview
Default value

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled
Specify whether to enable the monitoring of the frequency of full garbage collection.
true

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold
Specify the frequency as a threshold value for monitoring the frequency of a full garbage collection.
10

ejbserver.management.JVM.stats_monitor.FullGCCount.interval
Specify the threshold value of monitoring interval for monitoring the frequency of a full garbage collection.
600

ejbserver.management.statistics.interval
Specify the statistics collection interval.
60

ejbserver.management.stats_file.base_time
Specify the base time for time switching operation of the statistic files.
0

ejbserver.management.stats_file.dir
Specify the directory to output the statistics file.

In Windows
Cosminexus-working-directory\ejb\server-name\stats

In UNIX
Cosminexus-working-directory/ejb/server-name/stats

ejbserver.management.stats_file.enabled
Specify whether to enable the functionality to output the statistics file.
true

ejbserver.management.stats_file.num
Specify the number of statistic files.
7

ejbserver.management.stats_file.period
Specify the switching time for time switching operation of statistic files.
24

(p) Keys beginning with ejbserver.manager

Key name | Overview | Default value
ejbserver.manager.agent.Agent.conf | Specify the settings required for integrating with the Management Server. | None
ejbserver.manager.agent.Agent.enabled | Specify the settings required for integrating with the Management Server. | false
ejbserver.manager.agent.JP1EventAgent.conf | Specify the path of the setup file for JP1 integration. | None
ejbserver.manager.agent.JP1EventAgent.enabled | Specify whether to integrate with JP1. | false
ejbserver.manager.agent.MEventAgent.conf | Specify the property file for issuing the Management event. | None
ejbserver.manager.agent.MEventAgent.enabled | Specify whether to enable the functionality for issuing the Management event. | false

(q) Keys beginning with ejbserver.naming

Key name
Overview
Default value

ejbserver.naming.host
Specify the host name or the IP address that invoke the CORBA Naming Service that the batch server uses.
localhost

ejbserver.naming.nameroot
Specify a name when the name is added to the CORBA Naming Service that is invoked, when the CORBA Naming Service is used in the automatic invocation mode.
None

ejbserver.naming.port
Specify the port numbers of the CORBA Naming Service that the batch server uses.
900

ejbserver.naming.startupRetryCount
If the CORBA Naming Service still does not start after the lapse of an invocation wait time of the CORBA Naming Service that is specified in ejbserver.naming.startupWaitTime, specify an iteration frequency to await invocation only for the number of seconds specified in ejbserver.naming.startupWaitTime.
9

ejbserver.naming.startupWaitTime
Specify the wait time until the CORBA Naming Service can be used when the batch server is started.
1

(r) Keys beginning with ejbserver.rmi

Key name | Overview | Default value
ejbserver.rmi.naming.host | Specify the host name or the IP address of the RMI registry and MBean server used by the batch server in a multi-homed host environment. | None
ejbserver.rmi.naming.port | Specify the port numbers of the RMI registry that is used by the batch server. | 23152
ejbserver.rmi.remote.listener.port | Specify the port numbers of the remote object that is exported in to the batch server. | 0
ejbserver.rmi.request.timeout | Specify the communication timeout period between the client and the server. | 0

(s) Keys beginning with ejbserver.server

Key name | Overview | Default value
ejbserver.server.prf.PRFID | Specify the PRF identifier. | PRF_ID
ejbserver.server.threaddump.filenum | Specify an upper limit of the number of files of thread dump when the batch server detects an error and voluntarily outputs the thread dump. | 256

(t) Keys beginning with ejbserver.stdoutlog

Key name | Overview | Default value
ejbserver.stdoutlog.autoflush | Specify whether to enable the automatic flush functionality of the user output log and user error log. | false

(u) Keys beginning with ejbserver.watch

Key name | Overview | Default value
ejbserver.watch.enabled | Specify whether to enable the depletion monitoring of all the resources. | true
ejbserver.watch.memory.enabled | Specify whether to enable alert output of memory monitoring. | true
ejbserver.watch.memory.interval | Specify the memory monitoring interval. | 60
ejbserver.watch.memory.threshold | Specify the threshold value for monitoring memory usage state. | 80
ejbserver.watch.memory.writefile.enabled | Specify whether to output the results of memory monitoring in a file. | true
ejbserver.watch.fileDescriptor.enabled | Specify whether to enable the alert output for file descriptor monitoring. Note that file descriptor monitoring cannot be used in Windows and AIX. | true
ejbserver.watch.fileDescriptor.interval | Specify the file descriptor monitoring interval. Note that file descriptor monitoring cannot be used in Windows and AIX. | 60
ejbserver.watch.fileDescriptor.threshold | Specify the threshold value for monitoring the usage of a file descriptor. Note that file descriptor monitoring cannot be used in Windows and AIX. | 2147483647​
ejbserver.watch.fileDescriptor.writefile.enabled | Specify whether to output the results of file descriptor monitoring in a file. Note that file descriptor monitoring cannot be used in Windows and AIX. | true
ejbserver.watch.thread.enabled | Specify whether to enable alert output of thread monitoring. Note that you cannot monitor the number of threads in Linux. | true
ejbserver.watch.thread.interval | Specify the thread monitoring interval. Note that you cannot monitor the number of threads in Linux. | 60
ejbserver.watch.thread.threshold | Specify the threshold value for monitoring the thread usage state. Note that you cannot monitor the number of threads in Linux. | 2147483647​
ejbserver.watch.thread.writefile.enabled | Specify whether to output the results of thread monitoring to a file. Note that you cannot monitor the number of threads in Linux. | true
ejbserver.watch.threaddump.enabled | Specify whether to enable alert output of thread dump monitoring. | true
ejbserver.watch.threaddump.interval | Specify the time interval for thread dump monitoring. | 30
ejbserver.watch.threaddump.threshold | Specify the ratio of the threshold value for thread dump monitoring with respect to the maximum value. | 80
ejbserver.watch.threaddump.writefile.enabled | Specify whether to output the results of thread dump monitoring to a file. | true

(v) Keys beginning with https

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a key is not specified.

VR is the version of Application Server on which the keys are introduced or changed.

Key name | Overview | Default value
https.cipherSuites | Specify the recommended coding suite to be used in HttpsURLConnection.# | #
https.protocols | Specify the protocol to be used in HttpsURLConnection.# | #

#

For details about keys, see the JDK documentation.

(w) Keys beginning with java

Key name | Overview | Default value
java.naming.factory.initial | Specify the factory class for the implementation class of the context delegated by InitialContext of JNDI. | com.hitachi.software.ejb.jndi.InsContextFactory

(x) Keys beginning with vbroker

Key name
Overview
Default value

vbroker.agent.enableLocator
Specify whether to use the Smart Agent. When you start the batch server for using the scheduling functionality, true will be automatically set up.
false

vbroker.agent.port
Specify the port number of Smart Agent.
14000

vbroker.ce.iiop.ccm.htc.readerPerConnection
Specify whether the closing of the connection will be controlled when a timeout occurs during the invocation of the EJB method defined as the remote interface.

If true is specified

The closing of the connection when a timeout occurs will be controlled.

If false is specified

The closing of the connection when a timeout occurs is not controlled.

false

vbroker.ce.iiop.ccm.htc.threadStarter
Specify whether to invoke the thread for managing the reply receiving threads. To set up vbroker.ce.iiop.ccm.htc.readerPerConnection=true, specify true.
false

vbroker.orb.htc.comt.entryCount
Specify an upper limit of the entry count for one communication trace file of the Cosminexus TPBroker.
120000

vbroker.orb.htc.comt.fileCount
Specify an upper limit value of the communication trace file count for Cosminexus TPBroker.
3

vbroker.orb.htc.tracePath
Specify a value from 1 to 210 bytes for the output path of Cosminexus TPBroker trace files.

In Windows
Cosminexus-working-directory\ejb\server-name\logs\TPB\logj

In UNIX
Cosminexus-working-directory/ejb/server-name/logs/TPB/logj

vbroker.se.iiop_tp.host
Set the IP address of the EJB container for each batch server by specifying any optional value.
None

vbroker.se.iiop_tp.scm.iiop_tp.listener.port
You can set a communication port for each batch server, by specifying any optional value.
0

(y) Keys beginning with webserver.connector

Key name | Overview | Default value
webserver.connector.ajp13.bind_host | Specify the IP address or the host name used for Web server integration. | None
webserver.connector.ajp13.port | Specify the port number used for communication with the Web server. | 8007

3.4 server.policy (Security policy file for batch servers)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Examples of coding

(5) Notes

(1) Format

The security policy file follows the format of the security policy file of J2SE.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\ejb\server-name\

In UNIX
/opt/Cosminexus/CC/server/usrconf/ejb/server-name/

(3) Functionality

Specify the security policy of the JavaVM that executes the batch servers.

If you change the contents of this file while the batch server is running, the changes become effective only when the batch server is started next.

(4) Examples of coding

The contents of the used policy file are as follows:

// (1)
// Grant all permissions to the java extensions
grant codeBase "file:${java.home}/lib/ext/-" {
permission java.security.AllPermission;
};

// (2)
// Grant all permissions to the java tools, etc
// Note: java.home is the jre, not the installation dir for the jdk
grant codeBase "file:${java.home}/../lib/*" {
permission java.security.AllPermission;
};

// (3)
// Grant all permissions to anything loaded from the
// EJB server itself

grant codeBase "file:${ejbserver.install.root}/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${tpbroker.java.home}/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/DABJ/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/manager/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/c4web/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/c4web/exlib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/jaxp/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/CTM/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/PRF/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/wss/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${cosminexus.home}/XMLSEC/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${ejbserver.install.root}/sfo/lib/*" {
permission java.security.AllPermission;
};
grant codeBase "file:${hntrlib.home}/classes/*" {
permission java.security.AllPermission;
};

// (4)
// Grant all permissions to the container generated stubs and
// implementation classes
grant codeBase "file:${ejbserver.http.root}/ejb/${ejbserver.serverName}/containers/-" {
permission java.security.AllPermission;
};

// (5)
// Grant all permissions to imported resource (datasource) implementations
// implementation classes
grant codeBase "http://*/ejb/${ejbserver.serverName}/import/resjars/-" {
permission java.security.AllPermission;
};

// (6)
// Grant permissions to resource adapters
//
grant codeBase "file:${ejbserver.http.root}/ejb/${ejbserver.serverName}/rarjars/-" {

// For Cosminexus TP1 Connector & TP1/Client/J
permission java.util.PropertyPermission "*", "read, write";

// For Cosminexus TP1 Connector & TP1/Client/J & Cosminexus Reliable Messaging
permission java.io.FilePermission "<<ALL FILES>>", "read, write, delete";
permission java.net.SocketPermission "*", "connect,listen,accept";

// For TP1/Message Queue - Access
permission java.lang.RuntimePermission "loadLibrary.*";

// For TP1/Message Queue - Access & Cosminexus Reliable Messaging
permission java.lang.RuntimePermission "modifyThreadGroup";
permission java.lang.RuntimePermission "modifyThread";

// For DB Connector
permission java.lang.reflect.ReflectPermission "suppressAccessChecks";

// For authentication (from J2EE RI server.policy file)
permission javax.security.auth.PrivateCredentialPermission "* * \"*\"", "read";

// For Cosminexus Reliable Messaging
permission javax.security.auth.AuthPermission "modifyPrivateCredentials";
permission java.lang.RuntimePermission "getenv.HRMDIR";

// For Cosminexus SOA FTP Inbound Adapter
permission java.lang.RuntimePermission "getClassLoader";
permission java.lang.RuntimePermission "setContextClassLoader";
permission java.lang.RuntimePermission "accessDeclaredMembers";
};

// (7)
// Grant permissions to JSP/Servlet
//
grant codeBase "file:${ejbserver.http.root}/web/${ejbserver.serverName}/-" {
permission java.lang.RuntimePermission "loadLibrary.*";
permission java.lang.RuntimePermission "queuePrintJob";
permission java.lang.RuntimePermission "modifyThread";
permission java.lang.RuntimePermission "modifyThreadGroup";
permission java.net.SocketPermission "*", "connect";
permission java.io.FilePermission "<<ALL FILES>>", "read, write";
permission java.util.PropertyPermission "*", "read";
};

// (8)
// Grant permissions to Cosminexus Service Coordinator
//
grant codeBase "file:${cosminexus.home}/CSC/lib/*" {
permission java.lang.security.AIIPermission;
};

// (9)
//
// Grant minimal permissions to everything else:
//  Batch applications
//  EJBs
//  client implementation classes
grant  {
permission java.security.AllPermission;
};

The examples of coding from (1) to (9) are as follows:

(1)

Grant the following permission to the class files present below ext directory of JDK:

Grant all access permissions

(2)

Grant the following permission to the class files present below lib directory of JDK:

Grant all access permissions

(3)

Grant the following permission to the class files used in a batch server:

Grant all access permissions

(4)

Grant the following permission to class files, such as stub and skeleton that are generated by the batch server.

Grant all access permissions

(5)

Grant the following permission to the class files of the resources used by a batch server:

Grant all access permissions

(6)

Grant the following access permissions to the class files of the resource adapters used by a batch server:

Allow read and write of the entire property information

Allow read, write, and deletion of all files

Allow connection to the network, standby for connection, and acceptance of a connection for all socket communications

Allow loading of all libraries

Allow changing of thread groups

Allow changing of threads

Allow all reflection operations

Allow access to all private Credentials owned by any Subject

Allow changing of sets of private Credentials correlated to the Subject

Allow the collection of values for the environment variable HRMDIR

Notes:

The directory managed by the batch server, which is the deployment destination of JAR files in the resource adapter, is described.

All resource adapters running in the batch server are within the valid range.

(7)

Grant the following access permissions to the class files of JSPs and servlets:

Allow loading of all libraries

Allow print job requests

Allow changing of threads

Allow changing of thread groups

Allow network connection for all socket communications

Allow read and write for all files

Allow read of the entire property information

(8)

Grant the following access permissions to the class files of Cosminexus Service Coordinator:

Grant all access permissions

(9)

Grant the following access permissions to all class files:

Grant all access permissions

(5) Notes

If you use the server.policy file with an invalid syntax or without appropriate access permissions, java.lang.StackOverflowError or java.lang.OutOfMemoryError occurs, and the batch server might terminate abnormally.

The minimum required access permissions for operating the batch server is coded in the server.policy file generated when setting up the server. Do not delete and change the coding lines in the generated server.policy file. However, if the following access permissions are set up, you can delete java.security.AllPermission that exists in grant, for which signedBy, codebase, and principal are not specified:

java.util.PropertyPermission "*", "read";

java.lang.RuntimePermission "queuePrintJob";

java.net.SocketPermission "*", "connect";

3.5 criticalList.cfg (Protected areas list file)

The protected areas list file sets the classes for which method cancellation is prohibited as the protected area.

If you need to set this protected areas list file, you specify the settings as per the instructions provided in the notes of the documents provided with the configuration software of each Cosminexus product and the related products.

Organization of this section

(1) Format

(2) File storage location

(3) Examples of coding

(4) Notes

(1) Format

Specify the protected area list in the following format:

element

You can specify either of the following in element.

class-name
Specify the class name to be specified in the protected area.

prefix-name
Specify the prefix name of the package that includes the classes specified in the protected area. All classes having the specified prefix are specified as the protected area.

How to specify:

Specify the specifiable elements by demarcating with a linefeed.

A blank line is ignored.

A line beginning with a hash mark (#) is a comment.

You cannot add a space or a comment after element.
(Example) class-name #comment

Code the class name including the package name. Do not, however, mention the suffix ".class".
(Example) pacA.pacB.pacC.pacD.MyTestClass.class
In this case, code as pacA.pacB.pacC.pacD.MyTestClass.

You cannot specify the prefix of a class name.
(Example) pacA.pacB.pacC.pacD.My*
If you specify a class name in the protected area that uses "My" in the prefix(MyTestClass), you cannot use an asterisk (*) in the class name.
In this case, specify as pacA.pacB.pacC.*.

You cannot specify only an asterisk (*).

The single-byte space before and after element is ignored.

The double-byte spaces before and after element are treated as characters and are considered as invalid values.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\server\usrconf\

In UNIX
/opt/Cosminexus/CC/server/usrconf/

(3) Examples of coding

When specifying a prefix name

#Specify-prefix-name
pacA.pacB.*

All classes below the package pacA.pacB as well as those included in the package will form the protected area.

For example, if pacA.pacB.pacC.pacD is present below the package pacA.pacB.pacC, all classes below pacA.pacB.pacC.pacD will also become the protected area.

When specifying a class name

#Specify-class-name
pacX.pacY.pacZ.MyTestpacX.pacY.pacZ.CommonTest

(4) Notes

The protected areas list file is a product-based definition. This file is enabled in all the batch servers running on the machine on which the Cosminexus Component Container is installed.

The protected areas list file is read when starting a batch server. If you want to enable the changed contents, you need to restart the batch server.

If the protected areas list file does not exist or if the settings are invalid when starting a batch server, the batch server fails to start.

3.6 usrconf.cfg (Option definition file for batch applications)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Defined values

(5) Specifiable keys

(1) Format

Specify the key as follows:

key-name=value

How to specify:

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

You cannot code with a character encoding that is different from the runtime character encoding.

Specify the path in CJBATCHUSRCONFDIR using an absolute path.

(2) File storage location

Set up the path for the storage location of usrconf.cfg (option definition file for batch applications) in the environment variable CJBATCHUSRCONFDIR or store usrconf.cfg (option definition file for batch applications) in the directory that executes the commands used for batch applications. When you execute the commands used for batch applications, the usrconf.cfg file (option definition file for batch applications) will be searched in the following order:

Directory set in environment variable (CJBATCHUSRCONFDIR)

Directory where cjexecjob command (batch application execution command) is executed

(3) Functionality

This file specifies the invocation options for JavaVM that execute batch applications.

If you change the contents of this file while a batch application is running, the changes become effective only when the batch application is started next time.

(4) Defined values

When you execute commands that are used with batch applications, the enabled options will differ depending on whether the scheduling functionality is used.

The following table describes the values defined for each command used with batch applications:

Option name | cjexecjob | cjkilljob | cjlistjob
Scheduling functionality is not used | Scheduling functionality is used | Scheduling functionality is not used | Scheduling functionality is used | Scheduling functionality is not used | Scheduling functionality is used
add.jvm.arg | Y | Y | N | N | N | N
add.class.path | Y | Y | N | N | N | N
batch.ctm.enabled | Y | Y | Y | Y | Y | Y
batch.log.directory | Y | Y | Y | Y | Y | Y
batch.log.lockInterval | Y | Y | Y | Y | Y | Y
batch.log.lockRetryCount | Y | Y | Y | Y | Y | Y
batch.log.maintenance.filenum | Y | Y | Y | Y | Y | Y
batch.log.maintenance.filesize | Y | Y | Y | Y | Y | Y
batch.log.message.filenum | Y | Y | Y | Y | Y | Y
batch.log.message.filesize | Y | Y | Y | Y | Y | Y
batch.log.stdout.enabled | Y | Y | N | N | N | N
batch.request.timeout | N | Y | N | Y | N | Y
batch.schedule.group.name | N | Y | N | Y | N | Y
batch.vbroker.agent.addr | N | Y | N | Y | N | Y
batch.vbroker.agent.port | N | Y | N | Y | N | Y

Legend:

Y: Option is enabled.

N: Option is disabled.

(5) Specifiable keys

The following table describes the specifiable keys and the default values:

Note

If you use multibyte characters within the file, integrate the multibyte characters and encode used in the following locations:

usrconf.cfg (option definition file for batch servers)

Arguments of the cjexecjob command (batch application execution command)

Source code of the batch application (java.lang.System.out or java.lang.System.err)

Table 3-3 Specifiable keys and default values for usrconf.cfg (Batch applications)

Key name
Contents
Default value

add.jvm.arg
Pass the specified value to batch application on the batch server. You can specify the following option:

-D<property>

You can specify the following properties:

java.endorsed.dirs

java.security.policy

java.class.path

java.library.path

Note that if you want to specify a system property, specify the value in the usrconf.properties file without using -D.
None

add.class.path
Add the setup value to the class path of the batch application class loader on the batch server. You can specify only one JavaVM option for this key. If you specify multiple JavaVM options, add new add.class.path.
If a path containing space is specified in the value, the path need not be enclosed with double quotation mark ("). Also, values specified in double quotations are not valid.
To specify the JAR files for the container extension library, specify the add.class.path key in the option definition file for batch servers.
None

batch.ctm.enabled
Specify whether to use the scheduling functionality.

If you specify true:

The scheduling functionality will be used.

If you specify false:

The scheduling functionality will not be used.

false

batch.log.directory
Specify the output location directory of the log file. Specify the path of the log output location with absolute path or the relative path. You can specify following characters:

Single byte alphanumeric character

Underscore (_)

Hyphen (-)

Path demarcation character

When the path (including the absolute and relative path up to the current directory when the relative path is specified) that exceeds 180 bytes is specified, a message KDJE40059-W is output, and hence the default value is used. When the default value exceeds 180 bytes, log initialization fails and terminates abnormally. When there is no access permission to directory, or when the file name is specified, a message KDJE55039-W is output and command ends.
In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk.
Cosminexus-installation-directory\CC\batch\logs

batch.log.lockInterval
Specify the retry interval (unit: milliseconds) as integers from 0 to 2147483647​ for failure in an attempt of exclusive processing of log files. If 0 is specified, an error occurs immediately.
The commands in batch applications are used to output the KDJE55042-E message and terminate the process.
In Windows, specify the value acquired by multiplying the batch.lockRetryCount value and batch.log.lockInterval value in a range from 0 to 2147483647​.
In Windows use the value acquired by multiplying the batch.log.lockRetryCount value and batch.log.lockInterval value as the wait time of exclusive process.
10

batch.log.lockRetryCount
If the exclusive process of the log file fails, specify the retry frequency (unit: times) in integers from 1 to 2147483647​.
The commands in batch applications are used to output the KDJE55042-E message and terminate the process.
1000

batch.log.maintenance.filenum
Specify the number of log files for saving commands to be used in batch applications.
Specify integers from 1 to 64. To change the number of files, stop all commands used in the batch application that are output to the corresponding log files (cjexecjob, cjkilljob, and cjlistjob) and move or delete the log files and the log management files under the mmap directory to another directory.
2

batch.log.maintenance.filesize
Specify the file size (unit: bytes) of the log file for saving commands to be used in batch applications.
Specify integers from 4096 to 16777216​. To change the size, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
1048576​

batch.log.message.filenum
Specify the number of message log files of the commands to be used in batch applications.
Specify integers from 1 to 64. To change the number of files, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
2

batch.log.message.filesize
Specify the file size (unit: bytes) of the message log file of the commands to be used in batch applications.
Specify integers from 4096 to 16777216​. To change the size, stop all commands used in the batch application that are output to the corresponding log files and move or delete the log files and the log management files under the mmap directory to another directory.
1048576​

batch.log.stdout.enabled
Specify whether to output the messages issued by the batch job input command, with the standard output of batch execution commands.

If you specify true:

Output the message in the standard output.

If you specify false:

Do not output the message in the standard output.

true

batch.request.timeout
Specify from 0 to 2147483647​ (unit: seconds) as a timeout value for the communication between batch execution commands and batch servers. If you specify 0, the operation continues to wait infinitely.
0

batch.schedule.group.name
Specify a string of 1 to 63 characters having alphanumeric characters and underscore (_) as the schedule group name of batch servers.
JOBGROUP

batch.vbroker.agent.addr
Specify the IP address that OSAgent is using. You specify this key in the environment in which multiple IP addresses are distributed.
None

batch.vbroker.agent.port
Specify an integer from 1 to 65535 as the port number for connecting to OSAgent.
14000

3.7 usrconf.properties (User property file for batch applications)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Reserved key of the server management command

(5) Keys for customization of the cjexecjobc command, and the cjkilljob command

(1) Format

The user property file has the property file format of J2SE.

(2) File storage location

Set up the path for the storage location of usrconf.properties (user property file for batch applications) in the environment variable CJBATCHUSRCONFDIR or store the usrconf.properties (user property file for batch applications) in the directory that executes the cjexecjob command (batch application execution command). An usrconf.cfg (option definition file for batch applications) is retrieved in the following order when executing the cjexecjob command (batch application execution command):

Directory set in environment variable (CJBATCHUSRCONFDIR)

Directory where the cjexecjob command (batch application execution command) is executed

(3) Functionality

Specify the system properties of the JavaVM that executes the cjexecjob command, and the cjkilljob command.

(4) Reserved key of the server management command

The cjexecjob command and the cjkilljob command internally use the keys beginning with the following prefixes. Therefore, the keys beginning with these prefixes must not be used in applications.

ejbserver.*

webserver.*

appclient.*

j2eeserver.*

(5) Keys for customization of the cjexecjobc command, and the cjkilljob command

In the cjexecjob command, and the cjkilljob command, you can customize the operations of the batch servers by setting the values in the following system property keys:

The following table gives an overview of the keys and describes the default values. For details about the keys, see 2.4 usrconf.properties (User property file for J2EE servers). Furthermore, when referencing, substitute J2EE server and J2EE application for Batch server and Batch application respectively.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Overview
Default value
Related information

ejbserver.client.ctm.RequestPriority
Specify the priority (priority order) for extracting the request accumulated in the queues within CTM.
4

ejbserver.container.rebindpolicy
Specify re-connection and re-sending of requests in the EJB client, in the case of a communication failure when invoking the EJB method.
VB_TRANSPARENT
2.13 Invoking the EJB remote interface in EJB Container Functionality Guide

ejbserver.jndi.request.timeout
Specify the timeout period of communication with the Naming Service.
0

java.naming.provider.url#¹
Specify the host name and the port number of the CORBA Naming Service that the batch application uses.
Furthermore, this key is compatible with the protocol (iioploc or iiopname) used in the old versions.
(Specified format)
corbaname::[Host name]:[Port number]
Value that communicates with CORBA Naming Service that the batch server uses where the batch application is executed.

ejbserver.rmi.request.timeout
Specify the communication timeout period between the client and the server.
0

https.cipherSuites
Specify the recommended cipher suite to be used for HttpsURLConnection.#2
#2

https.protocols
Specify the protocol to be used for HttpsURLConnection.#2
#2

Legend:

Blank cell: Related information does not exist.

#1

This key is a user property file-specific key for batch applications. This key does not exist in the user property file for J2EE servers.

#2

For details on the keys, see the JDK documentation.

4. Files Used by the Smart Composer Functionality

This chapter describes the formats, storage locations, and the functionality of the files used by the Smart Composer functionality, and the keys specifiable in the files.

Organization of this chapter

4.1 List of files used by the Smart Composer functionality

4.2 cmxserver.properties (server setting properties file)

4.3 .cmxrc (client setting properties file)

4.4 cmxclient.properties (common client setting properties file)

4.5 lb.properties (load balancer definition properties file)

4.6 Easy Setup definition file

4.7 Configuration change definition files

4.8 Logical server reference definition file

4.9 Host definition file for scale out

4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files

4.11 System configuration patterns and defined logical servers

4.12 Parameters applicable to all logical servers

4.13 Parameters applicable to logical Web servers

4.14 Parameters applicable to logical J2EE servers

4.15 Parameters applicable to logical performance tracers

4.16 Parameters applicable to logical SFO servers

4.17 Parameters applicable to the logical CTM domain manager

4.18 Parameters applicable to the logical CTM

4.19 Parameters applicable to the logical Smart Agent

4.20 Parameters applicable to the logical user server

4.21 Parameters applicable to the Logical Naming Service

4.1 List of files used by the Smart Composer functionality

This section describes the files used by the Smart Composer functionality. The used files will differ for the system executing J2EE applications and for the system executing batch applications. The following are the files used for each system:

Organization of this section

(1) Files used in the system for executing J2EE applications

(2) Files used in the system for executing batch applications

(1) Files used in the system for executing J2EE applications

The following table lists the files used in the system for executing J2EE applications:

Table 4-1 List of files used in the system for executing J2EE applications

Classification
File name
Overview

Operating environment settings files for commands
cmxserver.properties (server setting properties file)
This file is used to set up an execution environment for the commands provided by the Smart Composer functionality.

.cmxrc (client setting properties file)
Enables default value to be set for common arguments of the commands provided by the Smart Composer functionality.
This file is used to set different default values for each client.

cmxclient.properties (common client setting properties file)
Enables default value to be set for common arguments of the commands provided by the Smart Composer functionality.
This file is used to set default values common to all clients.

lb.properties (load balancer definition properties file)
This file is used to set connection information needed for accessing the load balancer.

Definition files for Web system implementation
Easy Setup definition file
Defines a Web system to be built using commands provided by the Smart Composer functionality.

Configuration change definition files
Defines changes to the configuration of a Web system that was built using commands provided using the Smart Composer functionality.

Logical server reference definition file#
Defines the logical user servers that are to be added to service units in Web systems built using the commands provided by the Smart Composer functionality.

Host definition file for scale out
Defines the configuration of the Web system at the re-produced destination, when scaling out the Web system of the host unit management model, built using the Smart Composer functionality commands.

#

The logical server reference definition file is used for compatibility with the older version. For the version 07-50 onwards, use the Easy Setup definition file for setting up the logical user servers.

(2) Files used in the system for executing batch applications

The following table lists the files used in the system for executing batch applications:

Table 4-2 List of files used in the system for executing batch applications

Classification
File name
Overview

Operating environment settings files for commands
cmxserver.properties (server setting properties file)
This file is used to set up an execution environment for the commands provided by the Smart Composer functionality.

.cmxrc (client setting properties file)
Enables default value to be set for common arguments of the commands provided by the Smart Composer functionality.
This file is used to set different default values for each client.

cmxclient.properties (common client setting properties file)
Enables default value to be set for common arguments of the commands provided by the Smart Composer functionality.
This file is used to set default values common to all clients.

Definition files for Web system implementation
Easy Setup definition file
Defines a Web system to be built using commands provided by the Smart Composer functionality.

Configuration change definition files
Defines changes to the configuration of a Web system that was built using commands provided using the Smart Composer functionality.

Host definition file for scale out
Defines the configuration of the Web system at the re-produced destination, when scaling out the Web system of the host unit management model, built using the Smart Composer functionality commands.

4.2 cmxserver.properties (server setting properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

This file is in the Java properties format.

Files are used by the Smart Composer functionality as server setup property files.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file is used to set up an execution environment for the commands provided by the Smart Composer functionality.

(4) Specifiable keys

The specifiable keys and default values are described below.

Key name
Contents
Default

cmx.max_wait_time
Specifies the maximum amount of time (in seconds) to wait for completion of a command that is executing, in the range from 1 to 2147483647​ (seconds).This key is applicable to commands executed with the -wait common option specified. If such a command's processing is not completed within the specified amount of time, the next command executed results in an error.
180

(5) Examples of coding

cmx.max_wait_time=360

(6) Precautions

If the parameter is missing or invalid, the default value is assumed.

If the settings file is updated while the Management Server is running, the updated information is not applied until the next time the Management Server is started.

4.3 .cmxrc (client setting properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

This file is in the Java properties format.

(2) File storage location

The file is stored in the home directory of an OS user who executes commands.

(3) Functionality

This file is used to set default values for common arguments of the commands provided by the Smart Composer functionality. You use this file to set default values for an individual client.

Copy and use the following template files:

In Windows
Cosminexus-installation-directory\manager\config\templates\.cmxrc

In UNIX
/opt/Cosminexus/manager/config/templates/.cmxrc

(4) Specifiable keys

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a parameter is not specified.

VR is the version of Application Server on which parameters are introduced or changed.

Key name
Contents
Specifiable value
Default value
VR

cmx.connect.host#¹
Sets host names and IP addresses to be assumed when the -m option is omitted in common arguments.
The IP address can be specified as a regular expression using meta characters. If the IP address is specified as a regular expression, the matching IP address will be used from the available local IP addresses.#2
The values that can be specified are as follows:

Host name

IPv4 address

None
06-50

cmx.connect.userid
Sets the user ID to be assumed when the -u option is omitted in the common arguments.
Specification of this key is ignored if the functionality to omit the management user account is enabled.
User ID of management user account of Management Server
None
06-50

cmx.connect.passwd
Sets the password to be assumed when the -p option is omitted in the common arguments.
Specification of this key is ignored if the functionality to omit the management user account is enabled.
Management user account password of Management Server
None
06-50

cmx.wait
Sets true to treat the -wait option in the common argument as the default, and false to treat the -nowait option as the default.
The following strings can be specified:

true

false

false
06-50

cmx.verbose
Sets true to treat the -verbose option in the common argument as the default, and false to treat the -noverbose option as the default.
The following strings can be specified:

true

false

false
06-50

cmx.websystem.name
Specifies the Web system name when the -s option of the following commands is omitted:

cmx_build_system#³

cmx_define_application#⁴

cmx_define_resource

cmx_delete_serverref#⁴

cmx_delete_system

cmx_deploy_application#⁴

cmx_deploy_resource

cmx_list_model#⁵

cmx_list_status

cmx_resume_lb#⁴

cmx_start_application#⁴

cmx_start_resource

cmx_start_target

cmx_stop_application#⁴

cmx_stop_resource

cmx_stop_target

cmx_test_lb#⁴

cmx_undefine_application#⁴

cmx_undefine_resource

cmx_undeploy_application#⁴

cmx_undeploy_resource

Web system name
None
07-50

cmx.lb#⁴
Specifies operations for the virtual server of the load balancer, when the -lb option of the cmx_delete_system command is omitted.

keepvs:The virtual server is not deleted.

deletevs:The virtual server is deleted.

The following strings can be specified:

keepvs

deletevs

None
07-10

cmx.encoding
Specifies a character encoding assumed when the -encoding option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_model (EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Character encoding name
UTF-8
07-50

cmx.indent
Specifies the indent size assumed when the -indent option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_mode l(EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Integers from 0 to 8
2
07-50

cmx.myhost
Specifies the host name of the management server machine assumed when the -myhost option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_mode l(EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Host name
None
07-50

#1

In the following cases, if a value is specified in webserver.connector.http.bind_host of mserver.properties, also specify the same value in the cmx.connect.host key:

When operating the system for executing J2EE applications in the host unit management model

In the system for executing batch applications

#2

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

Note the following points for specifying the IP address as a regular expression:

When specifying a backslash (\), specify a double backslash (\\). A double backslash (\\) will replace a single backslash (\).

Do not specify a colon (:). The text after the colon is considered as a port number.

If a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value.

#3

If the -f option is specified when the cmx_build_system command is executed, the key settings are not applied.

#4

Cannot be used in the system for executing batch applications.

#5

When the cmx.websystem.name key is set up, and if you use the cmx_list_model command for acquiring all the registered Web system information models, specify the -all option.

(5) Examples of coding

cmx.connect.host=localhost:28080
cmx.connect.userid=admin
cmx.connect.passwd=p1574809
cmx.wait=true
#cmx.verbose=false
cmx.websystem.name=MyWebSystem
cmx.lb=deletevs

(6) Precautions

You must set appropriate access permissions for this file, because sensitive information, such as the user ID and password, is specified in the file.

To use non-ASCII characters, match the character encoding between the settings file and the OS locale during execution of commands provided by the Smart Composer functionality. Moreover, when using Japanese, do not specify character strings that include Unicode-encoded characters.

If a parameter is missing or invalid, the default value is assumed.

The settings (true and false) are not case sensitive.

4.4 cmxclient.properties (common client setting properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

This file is in the Java properties format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file is used to set default values for common arguments of the commands provided by the Smart Composer functionality. You use this file to set default values that are common to all clients.

(4) Specifiable keys

The following table lists the specifiable keys. Note that Default value is the value that is assumed when a parameter is not specified.

VR is the version of Application Server on which parameters are introduced or changed.

Key name
Contents
Specifiable value
Default value
VR

cmx.apply_user
Sets user IDs for the OS of the clients to which this file is applied. Separate the user IDs with commas. Also, for applying this definition file, when the Smart Composer functionality commands are invoked from a Windows service, specify "SYSTEM" on a Windows XP or Windows Server 2003 system and "host-name$" (host-name is the host name of the host on which Management Server is running) on other systems.
User name registered for OS
None
06-70

cmx.connect.host#¹
Sets host names and IP addresses to be assumed when the -m option is omitted in common arguments.
The IP address can be specified as a regular expression using meta characters. If the IP address is specified as a regular expression, the matching IP address will be used from the available local IP addresses.#2
The values that can be specified are as follows:

Host name

IPv4 address

None
06-50

cmx.connect.userid
Sets the user ID to be assumed when the -u option is omitted in the common arguments.
Specification of this property is ignored if the functionality to omit the management user account is enabled.
User ID of management user account of Management Server
None
06-50

cmx.connect.passwd
Sets the password to be assumed when the -p option is omitted in the common arguments.
Specification of this property is ignored if the functionality to omit the management user account is enabled.
Management user account password of Management Server
None
06-50

cmx.wait
Sets true to treat the -wait option in the common argument as the default, and false to treat the -nowait option as the default.
The following strings can be specified:

true

false

false
06-50

cmx.verbose
Sets true to treat the -verbose option in the common argument as the default, and false to treat the -noverbose option as the default.
The following strings can be specified:

true

false

false
06-50

cmx.websystem.name
Specifies the Web system name when the -s option of the following commands is omitted:

cmx_build_system#3

cmx_define_application#⁴

cmx_define_resource

cmx_delete_serverref#4

cmx_delete_system

cmx_deploy_application#4

cmx_deploy_resource

cmx_list_model#5

cmx_list_status

cmx_resume_lb#4

cmx_start_application#4

cmx_start_resource

cmx_start_target

cmx_stop_application#4

cmx_stop_resource

cmx_stop_target

cmx_test_lb#4

cmx_undefine_application#4

cmx_undefine_resource

cmx_undeploy_application#4

cmx_undeploy_resource

Web system name
None
07-50

cmx.lb#⁴
Specifies operations for the virtual server of the load balancer, when the -lb option of the cmx_delete_system command is omitted.

keepvs: The virtual server is not deleted.

deletevs: The virtual server is deleted.

The following strings can be specified:

keepvs

deletevs

None
07-10

cmx.encoding
Specifies a character encoding assumed when the -encoding option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_mode l(EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Character encoding name
UTF-8
07-50

cmx.indent
Specifies the indent size assumed when the -indent option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_mode l(EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Integers from 0 to 8
2
07-50

cmx.myhost
Specifies the host name of the management server machine assumed when the -myhost option of the cmx_export_model command is omitted.
For details about specifiable values, see cmx_export_mode l(EasySetup definition file output) in the uCosminexus Application Server Command Reference Guide.
Host name
None
07-50

cmx.output.mode
Specifies the command execution result and the message output destination mode.
The following strings can be specified:

6

The Version 6 compatible mode will be assumed.

The output destination for the command execution results and messages will be same as Version 6.

7

The Version 7 compatible mode will be assumed.

The output destination for the command execution results and messages will be same as Version 7.

8

The Version 8 mode will be assumed.

The output destination for the command execution results and messages will be same as Version 8.

The values that can be specified are as follows:

6

7

8

8
08-00

#1

Note the following when operating the system for executing J2EE applications in the host unit management model or system for executing batch applications:

If a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value also in the cmx.connect.host key.

#2

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

Note the following points for specifying the IP address as a regular expression:

When specifying a backslash (\), specify a double backslash (\\). A double backslash (\\) will replace a single backslash (\).

Do not specify a colon (:). The text after the colon is considered as a port number.

If a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value.

#3

If the -f option is specified when the cmx_build_system command is executed, the key settings are not applied.

#4

Cannot be used in the system for executing batch applications.

#5

When the cmx.websystem.name key is set up, and if you use the cmx_list_model command for acquiring all the registered Web system information models, specify the -all option.

(5) Examples of coding

cmx.apply_user=Administrator,muser1
cmx.connect.host=localhost:28080
cmx.connect.userid=admin
cmx.connect.passwd=p1574809
cmx.wait=true
#cmx.verbose=false
cmx.websystem.name=MyWebSystem
cmx.lb=deletevs

(6) Precautions

You must set appropriate access permissions for this file, because sensitive information, such as the user ID and password, is specified in the file.

To use non-ASCII characters, match the character encoding between the settings file and the OS locale during execution of commands provided by the Smart Composer functionality. Moreover, when using Japanese, do not specify character strings that include Unicode-encoded characters.

If a parameter is missing or invalid, the default value is assumed.

The settings (true and false) are not case sensitive.

The values of cmx.apply_user are case sensitive in UNIX, but not case sensitive in Windows.

If .cmxrc and cmxclient.properties files are both specified, the .cmxrc file takes precedence and the cmxclient.properties file is not read.

If a client does not use the .cmxrc file and does not have access permissions for the cmxclient.properties file, a read error occurs on the cmxclient.properties file. Therefore, for each client who uses Smart Composer functionality commands, make sure that you grant access permissions for the cmxclient.properties file by setting the user ID in the cmx.apply_user key.

4.5 lb.properties (load balancer definition properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

This file is in the Java properties format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config

In UNIX
/opt/Cosminexus/manager/config

(3) Functionality

This file is used to set connection information needed for accessing the load balancer. You use this file to control the load balancer from Cosminexus.

(4) Specifiable keys

The specifiable keys and default values are described below. Note that which keys can be specified depends on the load balancer control method. For keys that can be set by using the load balancer, which uses direct connection with the use of API, see 18.2 lb.properties (load balancer definition properties file) in the uCosminexus Application Server Security Management Guide.

Key name
Contents
Default

lb.list
Sets the load balancer's management IP address in dot notation (xxx.xxx.xxx.xxx), where xxx is an integer in the range from 0 to 255. If multiple load balancers are used, set multiple management IPs separated by commas.
None

lb.connect_type.IP-address#1#2
Sets the load balancer connection type.

To use Telnet directly,
specify telnet.

To use ssh directly,
specify ssh.

If nothing is specified, jp1_nc (old VR-compatible) is assumed.
jp1_nc

lb.enable_passwd.IP-address
Sets the password required for the Privileged EXEC level set in the load balancer for each load balancer.
Note that this property is set in ACOS.
None

lb.ssh.port.IP-address#1
Sets the load balancer's ssh server port number, as an integer in the range from 1 to 65535.
22

lb.ssh.user.IP-address#1
Sets the user name to be used to connect to the load balancer with ssh.
None

lb.ssh.passwd.IP-address#1
Sets the user password to be used to connect to the load balancer with ssh.
None

lb.ssh.timeout.IP-address#1#2
Sets the timeout value (in seconds) for when the ssh command is executed for the load balancer.
If the process of connecting to the load balancer is not completed within the time set in this key, the Smart Composer functionality command (cmx_build_system, etc) terminates abnormally with a timeout error.
Specify an integer in the range from 1 to 2147483​.
10

lb.telnet.command_timeout.IP-address
Sets the timeout value (in seconds) for sending commands to the load balancer.
If the CLI command issued for the load balancer is not completed within the time set in this key, commands of the Smart Composer functionality (cmx_build_system, etc) terminates abnormally with a timeout error.
Specify an integer in the range from 1 to 2147483​.
10

lb.telnet.login_prompt.IP-address
Sets the character string to be displayed in the prompt after the login when connecting to the load balancer.
To specify spaces at the end, enclose the character string within "" (double quotation mark).
None

lb.telnet.login_timeout.IP-address
Sets the timeout value (in seconds) for the login process when connecting to the load balancer.
If the process of connecting to the load balancer is not completed within the time set in this key, the Smart Composer functionality (cmx_build_system, etc) command terminates abnormally with a timeout error.
Specify an integer in the range from 1 to 2147483​.
10

lb.telnet.passwd.IP-address
Sets the user password for logging in to the load balancer using Telnet.
None

lb.telnet.passwd_prompt.IP-address
Sets the character string appearing in the password input prompt when connecting to the load balancer.
To specify spaces at the end, enclose the character string within "" (double quotation mark).
None

lb.telnet.port.IP-address
Sets the port number of the load balancer. Specify an integer in the range from 1 to 65535.
23

lb.telnet.user.IP-address
Sets the user name for logging in to the load balancer using Telnet.
None

lb.telnet.user_prompt.IP-address
Sets the character string appearing in the user name input prompt when connecting to the load balancer.
To specify spaces at the end, enclose the character string within "" (double quotation mark).
None

#1

Specify the management IP address of the load balancer that was specified in lb.list.

#2

If an invalid value is specified, the cmx_test_lb, cmx_build_system, cmx_delete_system, cmx_start_target, and cmx_stop_target commands will result in an error.

(5) Examples of coding

lb.list=192.168.1.100
lb.enable_passwd.192.168.1.100=adminpw

lb.connect_type.192.168.1.100=telnet
#lb.telnet.port.192.168.1.100=23
lb.telnet.user.192.168.1.100=user01
lb.telnet.passwd.192.168.1.100=user01pw
lb.telnet.user_prompt.192.168.1.100="AX login: "
lb.telnet.passwd_prompt.192.168.1.100="Password: "
lb.telnet.login_prompt.192.168.1.100=>
#lb.telnet.login_timeout.192.168.1.100=10
#lb.telnet.command_timeout.192.168.1.100=10

(6) Precautions

You must set appropriate access permissions for this file, because the file contains sensitive information such as passwords.

If a parameter is missing or invalid, the default value is assumed.

If the settings file is updated while the Management Server is running, the updated information is not applied until the next time the Management Server is started.

If this file is updated or the settings of the connection between the Management Server machine and load balancer is changed, use the cmx_test_lb command for checking the connection with the load balancer. For details about the cmx_test_lb command, see 8. Commands used in the Smart Composer functionality in the uCosminexus Application Server Command Reference Guide. If you cannot connect to the load balancer, check the load balancer settings and the definition (definition of the <load-balancer> tag) of load balancers in the Easy Setup definition file based on the cmx_test_lb command output message. For details about the load balancer settings and the definition (definition of the <load-balancer> tag) of load balancers in the Easy Setup definition file, see 4.7.5 Setting environment for connecting to load balancer in the uCosminexus Application Server Virtual System Setup and Operation Guide.

4.6 Easy Setup definition file

This section describes the Easy Setup definition file.

Organization of this section

4.6.1 Overview

4.6.2 Contents specified in the Easy Setup definition file

4.6.3 Defining a Web system

4.6.4 Defining a load balancer

4.6.5 Defining cookie switching

4.6.6 Defining a virtual server

4.6.7 Defining a physical tier

4.6.8 Defining a service unit

4.6.9 Defining a logical server

4.6.10 Defining a logical server configuration

4.6.11 Defining a host

4.6.1 Overview

You define Web system attributes, load balancers, physical tiers, service units, and the hosts configuring a service unit in the Easy Setup definition file. Define only the required number of Web system attributes, physical tiers, service units, and hosts in the definition file and one load balancer in the Web system.

However, when you control a load balancer from the Application Server (when the Smart Composer functionality is not used for load balancer settings and for starting and locking the real server port), you are not required to define the load balancer. Also, a load balancer is not used in the system for executing batch applications; and therefore, you need not define the load balancer.

You copy and use the following template file:

In Windows
Cosminexus-installation-directory\manager\config\templates\cmxdefcombinedmodel.xml

In UNIX
/opt/Cosminexus/manager/config/templates/cmxdefcombinedmodel.xml

Reference note

The character encoding in the template file is UTF-8.

Note

Use the Change Configuration definition file to change the system configuration after setting up a system. You cannot change the system configuration by editing the Easy Setup definition file.

Organization of this subsection

(1) Format

(2) Storage location

(1) Format

The file format is xml format.

(2) Storage location

Store this file at any work location.

4.6.2 Contents specified in the Easy Setup definition file

The following table lists and describes each item of the Easy Setup definition file:

Item name | Description
Tag name | Describes the tag to be set.
Occurrence pattern | Indicates the occurrence frequency of the tag.
Contents | Indicates the contents defined in the key.
Specifiable value | Indicates the value that you can specify in the tag. Displays hyphen (-) when there is no value that you can specify.
Omitting tags | Indicates whether you can omit the key appearing in the definition format.
Omitting values | Indicates whether you can omit the value of the key appearing in the definition format.
Default | Indicates a valid specification value when the contents specified in the key are omitted. Displays "None" when a default value does not exist.
Version | Indicates the version of the Application Server that you can define.

For details about the omission and contents of the default tag values, see each definition in the Easy Setup definition file from the section 4.6.3 onwards.

The following table describes the Easy Setup definition file:

Tag name
Occurrence pattern
Contents
Specifiable value
Default value
VR

<web-system>
0 or more times
Defines a Web system.
For defining the multiple Web systems, specify the <web-system> tag for each Web system.
--
None
07-00

<name>
Once
You must define this tag.
The <name> tag specifies a name for identifying the Web system.
Specify a string within 32 characters having alphanumeric characters or underscore (_) and hyphen (-).
None
06-50

<display-name>
0 or once
The <display-name> tag specifies a display name of a Web system.
There are no restrictions on the permitted characters.
Specify any string within 128 characters.
None
06-50

<description>
0 or once
The <description> tag specifies comments for a Web system.
There are no restrictions on the permitted characters.
Specify any string within 1024 characters.
None
06-50

<load-balancer>
0 or once
Defines a load balancer.
--
None
06-50

<name>
0 or once
Specifies name of the load balancer.
Specify a string within 32 characters having alphanumeric characters or underscore (_) and hyphen (-).
None
06-50

<load-balancer-type>
Once
Specifies one of the following as the type of load balancer:
The following strings can be specified:

BIG-IPv9

BIG-IPv10.1

BIG-IPv10.2

BIG-IPv11

ACOS

None
06-50

<display-name>
0 or once
Specifies display name of the load balancer.
There are no restrictions on the permitted characters.
Specify any string within 128 characters.
None
06-50

<description>
0 or once
Specifies comments for the load balancer.
There are no restrictions on the permitted characters.
Specify any string within 1024 characters.
None
06-50

<cookie-switching>
0 or once
The <cookie-switching> tag is specified when using the cookie switching functionality of the load balancer.
--
None
06-51

<cookie-switching-enabled>
0 or once
The <cookie-switching-enabled> tag is specified when using the cookie switching functionality.
The following strings can be specified:

true

false

false
06-51

<cookie-name>
0 or once
Specifies cookie name by alphanumeric characters or underscore "_".
The following name is used by the Web container and is case sensitive:

JSESSIONID

In BIG-IP
Secify a character string of 64 characters or less.
Note that the 1st character must be specified as an upper case or lower case character.

For ACOS
Specify a character string of 63 characters or less.

CMX_SERVER_ID
06-51

<server-id-rule>
0 or once
In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.
--
None
06-51

<management-host>
Once
Specifies the management IP address or host name set up in the load balancer.
The following strings can be specified:

Host name

IPv4 address

None
07-50

<redundant-management-host>
Once
In a system with redundant load balancers, specifies the management IP address or host name set up in the second load balancer.
The following strings can be specified:

Host name

IPv4 address

None
07-50

<virtual-server>
Once
Defines a virtual server.
--
None
06-50

<virtual-server-name>
Once
Specifies the virtual server name.
If multiple Web systems are to share the same load balancer, make sure that the specified virtual server name is not duplicated among the sharing Web systems.
Specify a string within 31 characters using alphanumeric characters or underscore (_), period (.), and hyphen (-).
None
06-50

<display-name>
0 or once
Specifies the display name of the virtual server.
Specify any string within 128 characters.
None
06-50

<description>
0 or once
Specifies a comment about the virtual server.
Specify any string within 1024 characters.
None
06-50

<ip-address>
Once
Specifies the IP address of the virtual server.
If multiple Web systems are to share the same load balancer, make sure that the virtual server's IP address is not duplicated among the sharing Web systems.
The following strings can be specified:

Host name

IPv4 address

None
06-50

<http-port>
Once
Specifies the HTTP port number of the virtual server, in the range from 1 to 65535.
Specify an integer from 1 to 65535.
None
06-50

<tier>
One or more times
You must define this tag.
Defines the physical tier.
--
None
06-50

<tier-type>
Once
You must define this tag.
Specifies the types of physical tiers.
The following strings can be specified:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

None
06-50

<j2ee-server-count>
0 or once
Specifies the number of J2EE servers deployed on one host when ctm-tier is specified in the <tier-type> tag.
Specify an integer from 0 to 32.
1
07-10

<configuration>
0 or more times
Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server.
--
None
06-50

<logical-server-type>
Once
You must define this tag.
Specifies the types of logical servers for defining the configuration.
The following strings can be specified:

web-server

j2ee-server

sfo-server

performance-tracer

ctm-domain-manager

component-transaction-monitor

smart-agent

None
06-50

<server-no>
0 or once
Specifies the number for identifying the J2EE server when a common configuration is specified for specific J2EE servers within the physical tier.
Specify a unique number in the physical tier.
For 1 to the value specified for <j2ee-server-count>
None
07-10

<param>
One or more times
You must define this tag.
Defines the name and value of a parameter used for setting up the logical server environment.
--
None
06-50

<param-name>
Once
The <param-name> tag specifies the parameter name.
For details about specifiable values, see the description in 4.11 System configuration patterns and defined logical servers.
None
06-50

<param-value>
One or more times
The <param-value> tag specifies the value set for parameters.
For details about specifiable values, see the description in 4.11 System configuration patterns and defined logical servers.
None
06-50

<unit>
One or more times
You must define this tag.
Defines a service unit.
--
None
06-50

<name>
Once
You must define this tag.
The <name> tag specifies the name for identifying the service unit.
Specify a string within 32 characters using alphanumeric characters or underscore (_) and hyphen (-).
None
06-50

<display-name>
0 or once
The <display-name> tag specifies the display name of the service unit. There are no restrictions on the permitted characters.
Specify any string within 128 characters.
None
06-50

<description>
0 or once
The <description> tag specifies the comments for the service unit. There are no restrictions on the permitted characters.
Specify any string within 1024 characters.
None
06-50

<allocated-host>
One or more times
You must define this tag.
Defines the reference to the host that configures a service unit.
--
None
06-50

<host-ref>
Once
You must define this tag.
Specifies the host name specified in the <name> tag in the host definition, the host name defined in the already setup Web system, or @myhost.
The values that can be specified are as follows:

Host name

IPv4 address

@myhost

None
06-50

<hosts-for>
Once
You must define this tag.
Specifies the type of physical tier to which the host specified in the <host-ref> tag belongs.
The following strings can be specified:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

None
06-50

<define-server>
0 or more times
Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag.
--
None
07-00

<logical-server-name>
0 or once
The <logical-server-name> tag specifies the name for identifying a logical server or a cluster.
Specify a string within 128 characters using alphanumeric characters or underscore (_) and hyphen (-).
cmx_Web-system-name_service-unit-name_type_serial-number
07-00

<display-name>
0 or once
The <display-name> tag specifies the display name of the logical server. There are no restrictions on the permitted characters.
Specify any string within 128 characters.
None
07-00

<description>
0 or once
The <description> tag specifies the comments for a logical server. There are no restrictions on the permitted characters.
Specify any string within 1024 characters.
None
07-00

<logical-server-type>
Once
You must define this tag.
Specifies the types of logical servers for defining the configuration.
The following strings can be specified:

web-server

j2ee-server

sfo-server

performance-tracer

ctm-domain-manager

component-transaction-monitor

smart-agent

naming-service

user-server

None
07-00

<cluster-ref>
0 or once
Specifies the cluster name when setting up a logical server as a cluster member.
Specify a string within 128 characters using alphanumeric characters or underscore (_) and hyphen (-).
None
07-50

<server-no>
0 or once
Specifies the number for identifying the J2EE server when a configuration is specified for a specific J2EE server in the service unit. Specify a unique number on the host.
For 1 to the value specified for <j2ee-server-count>
None
07-10

<configuration>
0 or once
Defines the configuration to be applied for each logical server.
--
None
07-00

<param>
One or more times
You must define this tag.
Defines the name and value of a parameter used for setting up the logical server environment.
--
None
07-00

<param-name>
Once
The <param-name> tag specifies the parameter name.
For details about specifiable values, see the description in 4.11 System configuration patterns and defined logical servers.
None
07-00

<param-value>
One or more times
The <param-value> tag specifies the value set for parameters.
For details about specifiable values, see the description in 4.11 System configuration patterns and defined logical servers.
None
07-00

<host>
0 or more times
Defines a host.
--
None
06-50

<host-name>
Once
The <host-name> tag specifies a name or an IP address for identifying a host.
The following strings can be specified:

Host name

IPv4 address

@myhost

None
07-50

<display-name>
0 or once
Specifies the display name of the host. There are no restrictions on the permitted characters.
Specify any string within 128 characters.
None
06-50

<description>
0 or once
Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.
Specify any string within 1024 characters.
None
06-50

<agent-host>
0 or once
Specifies the host name, IP address, or @myhost of the Cosminexus Administration Agent.
The following strings can be specified:

Host name

IPv4 address

@myhost

Value specified in host-name
07-50

<agent-port>
0 or once
The <agent-port> tag specifies a port number of the Cosminexus Administration Agent.
Specify an integer from 1 to 65535.
20295
06-50

Legend:

--: Not applicable

4.6.3 Defining a Web system

Organization of this subsection

(1) <web-system>

(2) <name>

(3) <display-name>

(4) <description>

(1) <web-system>

Contents

Defines a Web system. For defining the multiple Web systems, specify the <web-system> tag for each Web system.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(2) <name>

Contents

You must define this tag.

The <name> tag specifies a name for identifying the Web system.

This name must be unique within the management domain. Specify this name in the -s option of the Smart Composer functionality commands.

Specifiable value

Specify a string within 32 characters using alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <display-name>

Contents

The <display-name> tag specifies a display name of a Web system. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <description>

Contents

The <description> tag specifies comments for a Web system. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

4.6.4 Defining a load balancer

Organization of this subsection

(1) <load-balancer>

(2) <name>

(3) <load-balancer-type>

(4) <display-name>

(5) <description>

(1) <load-balancer>

Contents

Defines a load balancer.

If the Smart Composer functionality is not used to set up the load balancer or to start and shut down the real server port, there is no need to define a load balancer (from the <load-balancer> tag through the </load-balancer> tag). Note that the load balancer need not be defined in the system for executing batch applications.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(2) <name>

Contents

Specifies a name for the load balancer, as a maximum of 32 characters.

Specifiable value

Specify a string within 32 characters using alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(3) <load-balancer-type>

Contents

Specifies one of the following as the type of load balancer: The types of load balancers are as follows:

BIG-IPv9

Specified when BIG-IP v9 is used.

BIG-IPv10.1

Specified when BIG-IP v10.1 is used.

BIG-IPv10.2

Specified when BIG-IP v10.2 is used.

BIG-IPv11

Specified when BIG-IP v11 is used.

ACOS

Specified when ACOS is used.

Make sure that you specify this tag when you use the Smart Composer functionality to set up the load balancer.

Specifiable value

The following strings can be specified:

BIG-IPv9

BIG-IPv10.1

BIG-IPv10.2

BIG-IPv11

ACOS

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(4) <display-name>

Contents

Specifies the display name of the load balancer, as a maximum of 128 characters. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <description>

Contents

Specifies a comment about the load balancer, as a maximum of 1,024 characters. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

4.6.5 Defining cookie switching

Organization of this subsection

(1) <cookie-switching>

(2) <cookie-switching-enabled>

(3) <cookie-name>

(4) <server-id-rule>

(5) <management-host>

(6) <redundant-management-host>

(1) <cookie-switching>

Contents

The <cookie-switching> tag is specified when using the cookie switching functionality of the load balancer.

This setting enables a series of HTTP requests to be processed by a single Web server or J2EE server.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(2) <cookie-switching-enabled>

Contents

The <cookie-switching-enabled> tag is specified when using the cookie switching functionality.

Specifiable value

The following strings can be specified:

true
The <cookie-switching-enabled> tag is specified when using the cookie switching functionality.

false
Specify false if you do not want to use the cookie switching functionality.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(3) <cookie-name>

Contents

The <cookie-name> tag specifies a cookie name with a string of 1 to 64 characters.

The permitted name is a combination of alphanumeric characters or underscore (_).

The following name is used by the Web container and is case sensitive:

JSESSIONID

Note:

This specification is disabled when you specify ACOS in <load-balancer-type> and API in lb.connect_type.IP-address of lb.properties.

Specifiable value

For BIG-IP
Specify a character string of 64 characters or less with alphanumeric characters or underscore "_". Note that the 1st character must be specified as an upper case or lower case character.

For ACOS
Specify a character string of 63 characters or less with alphanumeric characters or underscore "_".

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <server-id-rule>

Contents

In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.

Specifiable value

In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <management-host>

Contents

Specifies the management IP address or host name set up in the load balancer.

If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.

Specifiable value

The following strings can be specified:

Host name
Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.

IPv4 address
The permitted host name is the combination of alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(6) <redundant-management-host>

Contents

In a system with redundant load balancers, specifies the management IP address or host name set up in the second load balancer.

If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.

For details about tags specifiable in each definition, see 4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files.

Specifiable value

The following strings can be specified:

Host name
The permitted host name is the combination of alphanumeric characters or underscore (_) and hyphen (-).

IPv4 address
Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

4.6.6 Defining a virtual server

Organization of this subsection

(1) <virtual-server>

(2) <virtual-server-name>

(3) <display-name>

(4) <description>

(5) <ip-address>

(6) <http-port>

(1) <virtual-server>

Contents

Defines a virtual server.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(2) <virtual-server-name>

Contents

Specifies the name of the virtual server as from 1 to 31 characters.

If multiple Web systems are to share the same load balancer, make sure that the specified virtual server name is not duplicated among the sharing Web systems.

Specifiable value

Specify a string within 31 characters using alphanumeric characters or underscore (_), period (.), and hyphen (-).

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <display-name>

Contents

Specifies the display name of the virtual server.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <description>

Contents

Specifies a comment about the virtual server.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <ip-address>

Contents

The <ip-address> tag specifies a host name or a IP address for the virtual server.

If multiple Web systems are to share the same load balancer, make sure that the virtual server's IP address is not duplicated among the sharing Web systems.

Specifiable value

The following strings can be specified:

Host name

IPv4 address

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(6) <http-port>

Contents

Specifies the HTTP port number of the virtual server, in the range from 1 to 65535.

For BIG-IP 1500, AX2000, or load balancer blade AC51L4, if the same load balancer is shared between multiple Web systems, make sure that the HTTP port number of the virtual server is not repeated in the sharing Web systems.

Specifiable value

Specify an integer from 1 to 65535.

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

4.6.7 Defining a physical tier

Organization of this subsection

(1) <tier>

(2) <tier-type>

(3) <j2ee-server-count>

(4) <configuration>

(5) <logical-server-type>

(6) <server-no>

(7) <param>

(8) <param-name>

(9) <param-value>

(1) <tier>

Contents

You must define this tag.

Defines the physical tier.

There are six types of physical tiers; combined-tier, http-tier, j2ee-tier, sfo-tier, ctm-tier and free-tier. These physical tiers, single or combination of multiple tiers configure a Web system.

The specifiable physical tier configurations are as follows:

combined-tier configuration

http-tier and j2ee-tier configuration#1

http-tier configuration #2

j2ee-tier configuration

Configuration in which the sfo-tier is combined with the combined-tier#1

Configuration in which the sfo-tier is combined with the http-tier and j2ee-tier#1

ctm-tier configuration

free-tier configuration#1

#1 You can use this configuration in a system set up with the Smart Composer functionality. You cannot use this configuration with a virtual system.

#2 You can use this configuration in a virtual system. You cannot use this configuration with a system set up with the Smart Composer functionality.

In the combined-tier configuration

Configure the Web server and J2EE server included in the service unit on one host, and define them in one <tier> tag.

In the http-tier and j2ee-tier configuration

Configure the Web server and J2EE server included in the service unit on different hosts, and define them in two <tier> tags.

In the http-tier configuration

Configure the Web server included in a service unit on one host and define the server in one <tier> tag. To use the http-tier configuration, you must prepare the virtual server of the j2ee-tier configuration associated with the virtual server group information file.

In the j2ee-tier configuration

Configure the J2EE server included in the service unit on one host, and define in one <tier> tag. When using the j2ee-tier configuration, the in-process HTTP server functionality must be enabled. To use the j2ee-tier configuration in a virtual system, you must prepare the virtual server of the combined-tier configuration associated with the virtual server group information file.

For sfo-tier to be configured with the combination of combined-tier or http-tier and j2ee-tier

Configure the session failover server (SFO server) included in the service unit on one host, and define in one <tier> tag.

In the ctm-tier configuration

The ctm-tier defines tags in a Web system different from the Web system defining the combined-tier, http-tier, j2ee-tier, and sfo-tier. For the ctm-tier configuration, configure the CTM-related logical server included in a service unit (CTM domain manager, CTM, and Smart Agent) and a J2EE server on one host, and define the servers in one <tier> tag.

Also, to allocate an integrated naming scheduler server, define the Web system separately for the integrated naming scheduler server and for the CTM.

The Web system for the integrated naming scheduler server configures the CTM-related logical server included in a service unit (CTM domain manager, CTM, and Smart Agent) on one host and defines the server in one <tier> tag.

To use the ctm-tier configuration in a virtual system, you must prepare the virtual server belonging to the management units of the combined-tier configuration in addition to the virtual server belonging to the management units of the ctm-tier configuration.

In the free-tier configuration

A configuration that does not match the definition of any other physical tier is defined as 1 tier tag.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(2) <tier-type>

Contents

You must define this tag.

Specifies the types of physical tiers. The types of physical tiers are as follows:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

Specifiable value

The following strings can be specified:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <j2ee-server-count>

Contents

Specifies the number of J2EE servers to be deployed on one host, when ctm-tier is specified in the <tier-type> tag, as an integer in the range from 0 to 32.

Specifiable value

Specify the value using an integer from 0 to 32.

In the Web system for the integrated naming scheduler server

Specify 0.

Web system for CTM

Specifies the number of J2EE servers to be deployed in one host for each Web system.

Note that when the configuration of the Web system is changed, the number of J2EE servers cannot be changed.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <configuration>

Contents

Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server.

For example, to define two configurations, such as Web server and J2EE server, use two <configuration> tags for definition, one for defining the Web server and the other for defining the J2EE server.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <logical-server-type>

Contents

You must define this tag.

Specifies the types of logical servers for defining the configuration. The types of logical server are as follows:

web-server:Web server

j2ee-server:J2EE server

sfo-server:Session failover server (SFO server)

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

The logical server that can define the configuration varies according to the physical tier type. The types of physical tiers are as follows:

In combined-tier

Web server, J2EE server, and performance tracer

In http-tier

Web server and performance tracer

In j2ee-tier

J2EE server and performance tracer

In sfo-tier

Session failover server (SFO server) and performance tracer

In ctm-tier

The logical servers that can be defined are different for each Web system.

In the Web system for the integrated naming scheduler server
CTM domain manager, CTM, Smart Agent, and the performance tracer

Web system for CTM
CTM domain manager, CTM, Smart Agent, J2EE server, and performance tracer

Note:

In a physical tier definition, you cannot specify the logical server configuration included in the user server and free-tier configuration. Specify these logical server configurations using unit definitions.

Specifiable value

The following strings can be specified:

web-server

j2ee-server

sfo-server

performance-tracer

ctm-domain-manager

component-transaction-monitor

smart-agent

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(6) <server-no>

Contents

Specifies the number for identifying the J2EE server when a common configuration is specified for specific J2EE servers within the physical tier.

The specifiable range is from 1 to the value specified in <j2ee-server-count>. Specify a unique number in the physical tier.

You can only specify this tag when ctm-tier is specified in the <tier-type> tag, and when the <j2ee-server-count> tag is specified.

This tag must not be specified if a common configuration is to be specified for all the J2EE servers within the physical tier.

Specifiable value

For 1 to the value specified for <j2ee-server-count>

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(7) <param>

Contents

You must define this tag.

Defines the name and value of a parameter used for setting up the logical server environment.

Enclose one parameter in each <param> tag.

For specifying the multiple values in a parameter, specify the <param-value> tag for each value.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(8) <param-name>

Contents

The <param-name> tag specifies the parameter name.

Specifiable value

For details about specifiable values, see 4.11 System configuration patterns and defined logical servers.

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(9) <param-value>

Contents

The <param-value> tag specifies the value set for parameters.

Specifiable value

For details about specifiable values, see 4.11 System configuration patterns and defined logical servers.

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

4.6.8 Defining a service unit

Organization of this subsection

(1) <unit>

(2) <name>

(3) <display-name>

(4) <description>

(5) <allocated-host>

(6) <host-ref>

(7) <hosts-for>

(1) <unit>

Contents

You must define this tag.

Defines a service unit.

For defining the multiple service units, specify the <unit> tag for each service unit to be defined.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(2) <name>

Contents

You must define this tag.

The <name> tag specifies the name for identifying the service unit. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands.

Specifiable value

Specify a string within 32 characters having alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <display-name>

Contents

The <display-name> tag specifies the display name of the service unit. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <description>

Contents

The <description> tag specifies the comments for the service unit. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <allocated-host>

Contents

You must define this tag.

Defines the reference to the host that configures a service unit. Specify only one <allocated-host> tag. You can specify multiple <allocated-host> tags in a Web system with free-tier configuration.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(6) <host-ref>

Contents

You must define this tag.

The <host-ref> tag specifies the host name specified in the <name> tag of the host definition, the host name defined in the built Web system, IP address, or @myhost.

When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.

If there are multiple hosts, the same host cannot be shared in the same service unit.

Specifiable value

The following strings can be specified:

Host name

IPv4 address

@myhost

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(7) <hosts-for>

Contents

You must define this tag.

Specifies the type of physical tier to which the host specified in the <host-ref> tag belongs. The types of physical tiers are as follows:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

Specifiable value

The following strings can be specified:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

4.6.9 Defining a logical server

Organization of this subsection

(1) <define-server>

(2) <logical-server-name>

(3) <display-name>

(4) <description>

(5) <logical-server-type>

(6) <cluster-ref>

(7) <server-no>

(8) <configuration>

(1) <define-server>

Contents

Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag.

For example, if the <hosts-for> tag is the http-tier, you can define one logical server each for the Web server and for the performance tracer respectively. For defining multiple logical servers, specify the <define-server> tag for each logical server.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(2) <logical-server-name>

Contents

The <logical-server-name> tag specifies the name for identifying a logical server or a cluster.

Specifiable value

Specify a string within 128 characters having alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(3) <display-name>

Contents

The <display-name> tag specifies the display name of the logical server. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <description>

Contents

The <description> tag specifies the comments for a logical server. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <logical-server-type>

Contents

You must define this tag.

Specifies the types of logical servers for defining the configuration.

The types of logical server are as follows:

web-server:Web server

j2ee-server:J2EE server

sfo-server:Session failover server (SFO server)

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

naming-service:Naming service

user-server:User server

The logical server that can define the configuration of the host varies according to the physical tier type. The types of physical tiers are as follows:

In combined-tier

Web server, J2EE server, performance tracer, and user server

In http-tier

Web server, performance tracer, and user server

In j2ee-tier

J2EE server, performance tracer, and user server

In sfo-tier

Session failover server (SFO server), performance tracer, and user server

In ctm-tier

The logical servers that can be defined are different for each Web system.

In the Web system for the integrated naming scheduler server
CTM domain manager, CTM, Smart Agent, performance tracer, and user server

Web system for CTM
CTM domain manager, CTM, Smart Agent, J2EE server, performance tracer, and user server

In free-tier

Web server, J2EE server, session failover server (SFO server), CTM domain manager, CTM, Smart Agent, Naming Service, performance tracer, Web server cluster, J2EE server cluster, and user server

Specifiable value

The following strings can be specified:

web-server

j2ee-server

sfo-server

performance-tracer

ctm-domain-manager

component-transaction-monitor

smart-agent

naming-service

user-server

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(6) <cluster-ref>

Contents

Specifies the cluster name when setting up a logical server as a cluster member.

If the logical server to be set up as a cluster member is the J2EE server, this tag specifies the J2EE server cluster name, and for the Web server this tag specifies the Web server cluster name.

Logical servers other than the J2EE server and Web server cannot be set up as a cluster member.

This tag is defined only for the free-tier configuration.

Specifiable value

Specify a string within 128 characters having alphanumeric characters or underscore (_) and hyphen (-).

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(7) <server-no>

Contents

Specifies the number for identifying the J2EE server when a configuration is specified for a specific J2EE server in the service unit.

Specify a unique number on the host. Make sure that you specify this tag when specifying the J2EE server configuration when <j2ee-server-count> tag is specified in the physical tier definition.

Specifiable value

For 1 to the value specified for <j2ee-server-count>

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(8) <configuration>

Contents

Defines the configuration to be applied for each logical server.

If the environment settings defined in the physical tier definition are to be used for operation, there is no need to define the<configuration> tag.

This tag cannot be specified when J2EE server cluster or Web server cluster is specified in <logical-server-type>.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

4.6.10 Defining a logical server configuration

Organization of this subsection

(1) <param>

(2) <param-name>

(3) <param-value>

(1) <param>

Contents

You must define this tag.

Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.

For specifying the multiple values in a parameter, specify the <param-value> tag for each value.

Specifiable value

--

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(2) <param-name>

Contents

The <param-name> tag specifies the parameter name.

Specifiable value

For details about specifiable values, see 4.11 System configuration patterns and defined logical servers.

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <param-value>

Contents

The <param-value> tag specifies the value set for parameters.

Specifiable value

For details about specifiable values, see 4.11 System configuration patterns and defined logical servers.

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

4.6.11 Defining a host

Organization of this subsection

(1) <host>

(2) <host-name>

(3) <display-name>

(4) <description>

(5) <agent-host>

(6) <agent-port>

(1) <host>

Contents

Defines a host.

For defining multiple hosts, specify the host tag for each host. A host can be shared among multiple Web systems.

Specifiable value

--

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(2) <host-name>

Contents

The <host-name> tag specifies a name or an IP address for identifying a host.

When specifying the host name for which the IP address cannot be changed, an error occurs during the system setup.

You can also specify @myhost in the <host-name> tag. If you specify @myhost, the host name is automatically replaced with the host name for the management server machine in the destination environment during system setup.

Specifiable value

The following strings can be specified:

Host name

IPv4 address

@myhost

Omitting tags

Cannot be omitted.

Omitting values

Cannot be omitted.

(3) <display-name>

Contents

Specifies the host display name within 128 characters. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 128 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(4) <description>

Contents

Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.

Specifiable value

Specify any string within 1024 characters.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(5) <agent-host>

Contents

Specifies the host name or IP address of the Cosminexus Administration Agent.

You can also specify @myhost in the <agent-host> tag. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.

Specifiable value

The following strings can be specified:

Host name

IPv4 address

@myhost

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

(6) <agent-port>

Contents

The <agent-port> tag specifies a port number of the Cosminexus Administration Agent.

Specifiable value

Specify an integer from 1 to 65535.

Omitting tags

Can be omitted.

Omitting values

Can be omitted.

4.7 Configuration change definition files

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable elements

(1) Format

This file is in the XML format.

(2) File storage location

Store this file at any work location.

(3) Functionality

These are definition files used to change the configuration of a Web system built using commands of the Smart Composer functionality. There are two configuration change definition files, one for changing logical server parameters, and the other for adding a service unit or a host.

Copy and use the following template files:

For changing logical server parameters:

In Windows
Cosminexus-installation-directory\manager\config\templates\cmxmodcombinedmodel.xml

In UNIX
/opt/Cosminexus/manager/config/templates/cmxmodcombinedmodel.xml

Note:

The configuration change definition file for changing the logical server parameters is used for compatibility with the earlier versions. For changing the logical server parameters, use the Easy Setup definition file.

For adding a service unit or a host:

In Windows
Cosminexus-installation-directory\manager\config\templates\cmxaddcombinedmodel.xml

In UNIX
/opt/Cosminexus/manager/config/templates/cmxaddcombinedmodel.xml

Reference note

The character encoding in the template file is UTF-8.

(4) Specifiable elements

In the configuration change definition files, you can specify some of the tags that are specified in a Easy Setup definition file.

The following describes the difference between a configuration change definition file and a Easy Setup definition file.

(a) Configuration change definition file for changing logical server parameters

This subsection shows the structure of a configuration change definition file for changing logical server parameters. Specify the <model-modification> and <web-system> tags in this format.

Structure of a configuration change definition file for changing logical server parameters

<model-modification xmlns="http://www.cosminexus.com/mngsvr/schema/ModelModification-2.5">
 <!--  Definition of the Web system subject to configuration change -->
 <web-system>
   <!-- Definition of the Web system attributes subject to configuration change -->
   <name>Web-system-name</name>

   <!-- Logical server definition for physical tier for which parameters are to be changed -->
   <tier>
     <tier-type>type-of-physical-tier</tier-type>
     <configuration>
       <logical-server-type>type-of-logical-server</logical-server-type>
       <param>
         <param-name>parameter-name</param-name>
         <param-value>parameter-value-1</param-value>
            :
         <param-value>parameter-value-n</param-value>
       </param>
       <param>
          :
     </configuration>
     <configuration>
        :
   </tier>
   <tier>
      :

   <!-- Logical server definition for service unit for which parameters are to be changed -->
   <unit>
     <name>service-unit-name</name>
     <allocated-host>
       <host-ref>host-name-or-IP-address-of-host-configuring-the-service-unit</host-ref>
       <hosts-for>type-of-physical-tier-to-which-the-component-host-belongs</hosts-for>
       <define-server>
         <logical-server-type>type-of-logical-server</logical-server-type>
         <configuration>
           <param>
             <param-name>parameter-name</param-name>
             <param-value>parameter-value-1</param-value>
                :
             <param-value>parameter-value-n</param-value>
           </param>
           <param>
              :
         </configuration>
         <configuration>
            :
     </allocated-host>
     <allocated-host>
         :
   </unit>
   <unit>
      :
 </web-system>
 <web-system>
    :
</model-modification>

The following describes how this file is different from a Easy Setup definition file in each definition.

Definition of Web system attributes

For the Web system name in the <name> tag, specify the name of the Web system whose configuration is to be changed.

Definition of physical tier
Specify this definition if you are changing the configuration for a type of logical server in the physical tier.

Make sure that you define the <configuration> tag. However, this tag can be omitted if the configuration of the physical tier is created by using the cmx_trans_param command to expand an abstract parameter.

You can omit the <param-value> tag. When this tag is omitted, the system deletes all parameter values that have been set and restores the default values.

Definition of service unit
Specify this definition if you are changing the configuration for a specific logical server in a service unit.

If the <j2ee-server-count> tag is specified in the physical tier definition in the Web system for CTM, make sure to specify the <server-no> tag for changing the configuration of the specific J2EE server.

You can omit the <param-value> tag. When this tag is omitted, the system deletes all parameter values that have been set and restores the default values.

For details about the tags that can be specified for each definition, see 4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files.

(b) Configuration change definition file for adding a service unit or a host

This subsection shows the structure of a configuration change definition file for adding a service unit or a host. Specify the <unit-addition> and <web-system> tags in this format.

Structure of a configuration change definition file for adding a service unit or a host

<unit-addition xmlns="http://www.cosminexus.com/mngsvr/schema/UnitAddition-2.5">
 <!-- Definition of the Web system subject to configuration change -->
 <web-system>
   <!-- Definition of the Web system attributes subject to configuration change -->
   <name>Web-system-name</name>
   <addition-mode>addition-mode</addition-mode>

   <!-- Definition of service unit to be added -->
   <unit>
     <name>service-unit-name</name>
     <display-name>display-name-of-service-unit</display-name>
     <description>comment-on-service-unit</description>
     <allocated-host>
       <host-ref>host-name-or-IP-address-of-host-configuring-the-service-unit</host-ref>
       <hosts-for>type-of-physical-tier-to-which-component-host-belongs</hosts-for>
       <define-server>
         <logical-server-name>logical-server-name</logical-server-name>
         <display-name>display-name-of-logical-server</display-name>
         <description>comment-on-logical-server</description>
         <logical-server-type>type-of-logical-server</logical-server-type>
         <configuration>
           <param>
             <param-name>parameter-name</param-name>
             <param-value>parameter-value-1</param-value>
               :
             <param-value>parameter-value-n</param-value>
           </param>
           <param>
             :
         </configuration>
         <configuration>
           :
     </allocated-host>
     <allocated-host>
        :
   </unit>
   <unit>
     :
 </web-system>
 <web-system>
   :

 <!-- Definition of host to be added -->
 <host>
   <host-name>host-name-or-IP-address</host-name>
   <display-name>display-name-of-host</display-name>
   <description>comment-on-host</description>
   <agent-host>host-name-or-IP-address-of-Administration-Agent</agent-host>
   <agent-port>port-number-of-Cosminexus-Administration Agent</agent-port>
 </host>
 <host>
   :
</unit-addition >

The following describes how this file is different from a Easy Setup definition file in each definition.

Definition of Web system attributes

For the Web system name in the <name> tag, specify the name of the Web system whose configuration is to be changed.

To implement scale out using JP1/SC/DPM, specify "DEPLOYED" in the <addition-mode> tag. The <addition-mode> tag can only be specified in the configuration change definition file for adding service units and hosts.

Definition of service unit

The same as for a Easy Setup definition file.

Definition of host

The same as for a Easy Setup definition file.

For details about the tags that can be specified for each definition, see 4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files.

4.8 Logical server reference definition file

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable elements

(5) Examples of coding

(1) Format

This file is in the XML format.

(2) File storage location

Store this file at any work location.

(3) Functionality

This is a definition file used to add user-defined logical servers (logical user server) to service units in Web systems built using commands of the Smart Composer functionality. The file defines information needed to associate logical user server with service units.

Copy and use the following template files:

In Windows
Cosminexus-installation-directory\manager\config\templates\cmxaddserverref.xml

In UNIX
/opt/Cosminexus/manager/config/templates/cmxaddserverref.xml

Note that the logical server reference definition file is used for compatibility with the older version. Use this file only for adding the logical user servers into the built system. For the version 07-50 onwards, it is recommended that you use the Easy Setup definition file for setting up the logical user server.

(4) Specifiable elements

You define in a logical server reference definition file the name of a logical server to be added, and you define the target Web system and service unit to which the logical server is to be added. You can define as many Web systems, service units, and logical servers as you need.

The structure of a logical server reference definition file is shown below. Specify the <server-reference> and <web-system> tags in this format.

Structure of a logical server reference definition file

<server-reference xmlns="http://www.cosminexus.com/mngsvr/schema/ServerReference-2.0">
 <!-- Definition of Web system -->
 <web-system>
   <!-- Definition of Web system attributes -->
   <name>Web-system-name</name>

   <!-- Definition of service unit -->
   <unit>
     <name>service-unit-name1</name>
     <logical-server-ref>logical-server-name-1</logical-server-ref>
       :
     <logical-server-ref>logical-server-name-n</logical-server-ref>
   </unit>
   <unit>
     :
 </web-system>
 <web-system>
   :
</server-reference>

The following table lists and describes each tag and the default values:

Tag names
Contents
Default

web-system
Defines a Web system.
For defining the multiple Web systems, specify the <web-system> tag for each Web system.
None

name
Specifies a name for identifying the Web system, within 32 characters. This name must be unique within the domain. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
None

unit
Defines a service unit.
For defining the multiple service units, specify the <unit> tag for each service unit to be defined.
None

name
Specifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
None

logical-server-ref
Specifies the name of the logical user server that is to be added to the service unit, as up to 128 characters.
Specify the name that was specified in the <logical-server-name> tag in the logical user server definition file. Specify a logical user server that has been added by the mngsvrutil add userserver command.
To define multiple logical user servers, specify a <logical-server-ref> tag for each logical user server.
None

(5) Examples of coding

This example adds the usersv1 and usersv2 logical user servers to the unit1 service unit, and the usersv3 and sersv4 logical user servers to the unit2 service unit.

<?xml version="1.0" encoding="UTF-8"?>
<server-reference xmlns="http://www.cosminexus.com/mngsvr/schema/ServerReference-2.0">
 <web-system>
   <name>MyWebSystem</name>
   <unit>
     <name>unit1</name>
     <logical-server-ref>usersv1</logical-server-ref>
     <logical-server-ref>usersv2</logical-server-ref>
   </unit>
   <unit>
     <name>unit2</name>
     <logical-server-ref>usersv3</logical-server-ref>
     <logical-server-ref>usersv4</logical-server-ref>
   </unit>
 </web-system>
</server-reference>

4.9 Host definition file for scale out

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable elements

(5) Examples of coding

(1) Format

This file is in the XML format.

(2) File storage location

Store this file at any work location.

(3) Functionality

This is a definition file for scaling out the Web system of the host unit management model, built using the commands provided with the Smart Composer functionality. This file defines the Web system information of the re-produced destination host.

Copy and use the following template files:

In Windows
Cosminexus-installation-directory\manager\config\templates\cmxscaleouthostdef.xml

In UNIX
/opt/Cosminexus/manager/config/templates/cmxscaleouthostdef.xml

Reference note

The character encoding in the template file is UTF-8.

(4) Specifiable elements

The host definition file for scaling out defines the host to be added and load balancer to be used in the Web system at the re-produced destination.

The structure of the host definition file for scaling out is as follows. Specify the <host-scaleout> and <web-system> tags in this format.

Organization of the host definition file for scale out

<host-scaleout xmlns="http://www.cosminexus.com/mngsvr/schema/HostScaleOut-2.5">
 <!-- Definition of the Web system at re-produced destination -->
 <web-system>
   <!-- Definition of Web system attributes -->
   <name>Web-system-name</name>
 </web-system>

 <!-- Definition of the re-produced destination host -->
 <host>
   <host-name>host-name-or-IP-address</host-name>
   <display-name>display-name-of-host</display-name>
   <description>comment-on-host</description>
   <agent-host>host-name-or-IP-address-of-Cosminexus-Administration-Agent</agent-host>
 </host>
</host-scaleout>

The following table lists and describes each tag and the default values:

Tag names
Contents
Default

web-system#1
Defines the Web system at the re-produced destination.
Specify this tag to change the definition of the Web system at the re-produced destination. For defining the multiple Web systems, specify the <web-system> tag for each Web system.
None

name#1
Specifies the name of the Web system at the re-produced destination for changing the settings.
None

host#2
Defines the re-produced destination host.
A host can be shared among multiple Web systems.
None

host-name
Specifies the host name or IP address for operations. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
None

display-name
Specifies the host display name within 128 characters. There are no restrictions on the permitted characters.
None

description
Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.
None

agent-host
Specifies the host name or IP address of the Cosminexus Administration Agent. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
Value specified in the <host-name> tag

#1

You can omit the definition of the Web system at the re-produced destination, when the Cookie switching functionality of the load balancer is not used in the Web system at the re-produced source.

#2

If the host definition is omitted, the host name of the re-produced destination host is assumed to be the <host-name> tag, and the host will be defined.

(5) Examples of coding

The following table describes an example of items specified in the re-produced source host and re-produced destination host:

Table 4-3 Example of items specified in the re-produced source host and re-produced destination host

Setup items | Re-produced source host | Re-produced destination host
Web system name | MyWebSystem | MyWebSystem
Rules for assigning server IDs | 1001-1010 | 1011-1020
Host name | apsvA | apsvA
IP address | 192.168.1.20 | 192.168.1.21
Management IP address | 192.168.100.20 | 192.168.100.21

The following example describes the scale out using the disk image created by duplicating the host apsvA. This is a coding example for scaling out the system to execute J2EE applications.

<?xml version="1.0" encoding="UTF-8"?>
<host-scaleout xmlns="http://www.cosminexus.com/mngsvr/schema/HostScaleOut-2.1">
 <!-- Definition of the Web system at the reproduction destination -->
 <web-system>
   <!-- Definition of Web system attributes -->
   <name>MyWebSystem</name>
 </web-system>
 <!-- Definition of reproduction destination host -->
 <host>
   <host-name>apsvA</host-name>
   <agent-host>192.168.100.21</agent-host>
 </host>
</host-scaleout>

4.10 Tags that can be specified in the Easy Setup definition file and the configuration change definition files

This section describes the tags that can be specified in the Easy Setup definition file, the configuration definition change file for changing logical server parameters, and the configuration change definition file for adding a service unit or a host.

This section also describes the tags used for the system executing J2EE applications, and tags used for the system executing batch applications for individual systems.

For details about the structure of a Easy Setup definition file, see 4.6 Easy Setup definition file. For details about the structure of a configuration definition change file, see 4.7 Configuration change definition files.

Organization of this section

4.10.1 Tags that can be specified in the system for executing J2EE applications

4.10.2 Tags that can be specified in the system for executing batch applications

4.10.1 Tags that can be specified in the system for executing J2EE applications

This subsection describes the tags that can be specified in the system executing J2EE applications.

Organization of this subsection

(1) Definition of Web system attributes

(2) Definition of load balancer

(3) Definition of physical tier

(4) Definition of the service unit

(5) Definition of host

(1) Definition of Web system attributes

The following table describes the contents that can be defined as Web system attributes:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

web-system
Defines a Web system.
For defining the multiple Web systems, specify the <web-system> tag for each Web system.
O#¹
O
O#²
None

name
Specifies a name for identifying the Web system, within 32 characters. This name must be unique within the management domain. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
M
M
M
None

addition-mode
Specifies the addition mode.

DEPLOYED#3
Specifies addition mode when scaling out the disk image using JP1/SC/DPM. If addition mode is specified, deployment of the J2EE application and resource adapter is not required during system construction.

NORMAL
Specify this tag for a normal scale-out.

--
--
O
NORMAL

display-name
Specifies the display name of the Web system within 128 characters. There are no restrictions on the permitted characters.
O
O
--
None

description
Specifies a comment about the Web system within 1,024 characters. There are no restrictions on the permitted characters.
O
O
--
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

#1

This tag can be omitted if the Web system to be used is already defined using the Smart Composer functionality.

#2

This tag can be omitted if no service unit is to be added.

#3

For applying these settings, you must import and start the resource adapter in a batch using the Smart Composer functionality commands beforehand. For details, see 4.1.24 Starting the system (for CUI) in the uCosminexus Application Server System Setup and Operation Guide.

(2) Definition of load balancer

Define the load balancer under the <load-balancer> tag. The following table describes the contents that can be defined:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

load-balancer
Defines a load balancer.
If the Smart Composer functionality is not used to set up the load balancer or to start and shut down the real server port, there is no need to define a load balancer (from the <load-balancer> tag through the </load-balancer> tag).
O
--
--
None

name
Specifies a name for the load balancer, as a maximum of 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
O
--
--
None

load-balancer-type
Specifies one of the following as the type of load balancer:

BIG-IPv9

BIG-IPv10.1

BIG-IPv10.2

BIG-IPv11

ACOS

Make sure that you specify this tag when you use the Smart Composer functionality to set up the load balancer.
M
--
--
None

display-name
Specifies the display name of the load balancer, as a maximum of 128 characters. There are no restrictions on the permitted characters.
O
--
--
None

description
Specifies a comment about the load balancer, as a maximum of 1,024 characters. There are no restrictions on the permitted characters.
O
--
--
None

cookie-switching
Specifies that the cookie switching functionality is to be used.
This setting enables a series of HTTP requests to be processed by a single Web server or J2EE server.
O#
--
--
None

cookie-switching-enabled
Specifies true to use the cookie switching functionality and false to not use it.
O
--
--
false

cookie-name
Specifies the cookie name. The permitted characters are the combination of alphanumeric characters, the underscore (_), and the hyphen (-). The following name is used by the Web container and is case sensitive:

JSESSIONID

In BIG-IP 1500, specify a character string of 1 to 64 characters. Note that the 1st character must be specified as an upper case or lower case character.
In ACOS, specify a character string of 1 to 63 characters.
O
--
--
CMX_SERVER_ID

server-id-rule
In version 08-53 or later versions, do not specify a value in this tag. If specified, the value is disabled.
O
--
--
None

management-host
Specifies the management IP address or host name set up in the load balancer. Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-).
If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.
M
--
--
None

redundant-management-host
In a system with redundant load balancers, specifies the management IP address or host name set up in the second load balancer. Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255. A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-).
If the same load balancer is between multiple Web systems, specify the same management IP address or host name in the Web systems sharing the load balancer.
O
--
--
None

virtual-server
Defines a virtual server.
M
--
--
None

virtual-server-name
Specifies the name of the virtual server as from 1 to 31 characters. The permitted characters are the combination of alphanumeric characters, underscore (_), and hyphen (-).
If multiple Web systems are to share the same load balancer, make sure that the specified virtual server name is not duplicated among the sharing Web systems.
M
--
--
None

display-name
Specifies the display name of the virtual server.
O
--
--
None

description
Specifies a comment about the virtual server.
O
--
--
None

ip-address
Specifies the IP address of the virtual server.
If multiple Web systems are to share the same load balancer, make sure that the virtual server's IP address is not duplicated among the sharing Web systems.
M
--
--
None

http-port
Specifies the HTTP port number of the virtual server, in the range from 1 to 65535.
For BIG-IP v9 or ACOS, if the same load balancer is shared between multiple Web systems, make sure that the HTTP port number of the virtual server is not repeated in the sharing Web systems.
M
--
--
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a load balancer is defined.

O: Optional.

--: Not applicable.

#

This tag can be omitted when the load balancer's cookie switching functionality is not used.

(3) Definition of physical tier

Define the physical tier according to the configuration of the built system. Define the physical tier under the <tier> tag. The following table describes the contents that can be defined:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

tier
Defines the physical tier.
There are six types of physical tiers; combined-tier, http-tier, j2ee-tier, sfo-tier, ctm-tier and free-tier. Each physical tier combines single or multiple tiers to configure a Web system.
The specifiable physical tier configurations as follows:

combined-tier configuration

http-tier and j2ee-tier configuration

j2ee-tier configuration

Configuration in which the sfo-tier is combined with the combined-tier

Configuration in which the sfo-tier is combined with the http-tier and j2ee-tier

ctm-tier configuration

free-tier configuration

In the combined-tier configuration

Configure the Web server and J2EE server included in the service unit on one host, and define them in one <tier> tag.

In the http-tier and j2ee-tier configuration

Configure the Web server and J2EE server included in the service unit on different hosts, and define them in two <tier> tags.

In the j2ee-tier configuration

Configure the J2EE server included in the service unit on one host, and define in one <tier> tag. When using the j2ee-tier configuration, the in-process HTTP server functionality must be enabled.

For sfo-tier to be configured with the combination of combined-tier or http-tier and j2ee-tier

Configure the session failover server (SFO server) included in the service unit on one host, and define in one <tier> tag.

In the ctm-tier configuration

The ctm-tier defines tags in a Web system different from the Web system defining the combined-tier, http-tier, j2ee-tier, and sfo-tier. The ctm-tier defines tags separately for the integrated naming scheduler server and for CTM.

Web system for the integrated naming scheduler server
Configures the CTM-related logical server#1 included in the service unit on one host, and define in one <tier> tag.

Web system for CTM
Configures the CTM-related logical server#1 and J2EE server included in the service unit on one host, and define in one <tier> tag.

In the free-tier configuration

A configuration that does not match the definition of any other physical tier is defined as 1 tier tag.

M
O#²
--
None

tier-type
Specifies one of the following as the type of physical tier:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

M
M
--
None

j2ee-server-count
Specifies the number of J2EE servers to be deployed on one host, when ctm-tier is specified in the <tier-type> tag, as an integer in the range from 0 to 32.

In the Web system for the integrated naming scheduler server
Specify 0.

Web system for CTM
Specifies the number of J2EE servers to be deployed in one host for each Web system.

Note that when the configuration of the Web system is changed, the number of J2EE servers cannot be changed.
O
--
--
1

configuration
Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server. For example, to define two configurations, such as Web server and J2EE server, use two <configuration> tags for definition, one for defining the Web server and the other for defining the J2EE server.
O#³
M#⁴
--
None

logical-server-type
Specifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:

web-server:Web server

j2ee-server:J2EE server

sfo-server:Session failover server (SFO server)

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

The logical server that can define the configuration varies according to the physical tier type.

In combined-tier

Web server, J2EE server, and performance tracer

In http-tier

Web server and performance tracer

In j2ee-tier

J2EE server and performance tracer

In sfo-tier

Session failover server (SFO server) and performance tracer

In ctm-tier

The logical servers that can be defined are different for each Web system.

In the Web system for the integrated naming scheduler server
CTM domain manager, CTM, Smart Agent, and the performance tracer

Web system for CTM
CTM domain manager, CTM, Smart Agent, J2EE server, and performance tracer

M
M
--
None

server-no
Specifies the number for identifying the J2EE server when a common configuration is specified for specific J2EE servers within the physical tier. The specifiable range is from 1 to the value specified in <j2ee-server-count>. Specify a unique number in the physical tier. You can only specify this tag when ctm-tier is specified in the <tier-type> tag, and when the <j2ee-server-count> tag is specified.
This tag must not be specified if a common configuration is to be specified for all the J2EE servers within the physical tier.
O
O
--
None

param#5
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.
M
M
--
None

param-name#5
Specifies the name of the parameter used for setting up the environment for the logical server.
M
M
--
None

param-value#5
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value.
M
O#⁶
--
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

Note:

In a physical tier definition, you cannot specify the logical server configuration included in the user server and free-tier configuration. Specify these logical server configurations using unit definitions.

#1

The CTM-related logical server has the CTM domain manager, CTM, and Smart Agent.

#2

This tag can be omitted if the physical tier definition is not changed.

#3

This tag can be omitted if the environment settings assumed in the Management Server during creation of the logical server are used for operations.

#4

This tag can be omitted if the cmx_trans_param command is used for expanding the abstract parameter to create the physical tier configuration.

#5

The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.

#6

This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(4) Definition of the service unit

Define the service unit under the <unit> tag. The following table describes the contents that can be defined:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

unit
Defines a service unit.
For defining the multiple service units, specify the <unit> tag for each service unit to be defined.
M
O#¹
M
None

name
Specifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
M
O#²
M
None

display-name
Specifies the display name of the service unit within 128 characters. There are no restrictions on the permitted characters.
O
O
O
None

description
Specifies a comment about the service unit within 1,024 characters. There are no restrictions on the permitted characters.
O
O
O
None

allocated-host
Defines the reference to the host that configures a service unit. Specify only one <allocated-host> tag. You can specify multiple <allocated-host> tags in a Web system with free-tier configuration.
M
M
M
None

host-ref
Specifies the host name specified in the <name> tag in the host definition, the host name defined in the already setup Web system, or @myhost.
When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
If there are multiple hosts, the same host cannot be shared in the same service unit.
M
M
M
None

hosts-for
Specifies one of the following values as the type of physical tier to which the host specified in the <host-ref> tag belongs:

combined-tier

http-tier

j2ee-tier

sfo-tier

ctm-tier

free-tier

M
M
M
None

define-server
Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag. For example, if http-tier is specified in the <hosts-for> tag, you can define one logical server for each of the Web server and the performance tracer. For defining multiple logical servers, specify the <define-server> tag for each logical server.
O#³
M
O#³
None

logical-server-name
Specifies a name for identifying the logical server or cluster within 128 characters. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
O
--
O
cmx_Web-system-name_service-unit-name_type_serial-number

display-name
Specifies the display name of the logical server within 128 characters. There are no restrictions on the permitted characters.
O
O
O
None

description
Specifies a comment about the logical server within 1,024 characters. There are no restrictions on the permitted characters.
O
O
O
None

logical-server-type
Specifies the types of logical servers for defining the configuration. The following are the specifiable types the logical servers:

web-server:Web server

j2ee-server:J2EE server

sfo-server:Session failover server (SFO server)

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

naming-service:Naming service

user-server:User server

M
M
M
None

The logical server that can define the configuration of the host varies according to the physical tier type.

In combined-tier

Web server, J2EE server, performance tracer, and user server

In http-tier

Web server, performance tracer, and user server

In j2ee-tier

J2EE server, performance tracer, and user server

In sfo-tier

Session failover server (SFO server), performance tracer, and user server

In ctm-tier

The logical servers that can be defined are different for each Web system.

In the Web system for the integrated naming scheduler server
CTM domain manager, CTM, Smart Agent, performance tracer, and user server

Web system for CTM
CTM domain manager, CTM, Smart Agent, J2EE server, performance tracer, and user server

In free-tier

Web server, J2EE server, session failover server (SFO server), CTM domain manager, CTM, Smart Agent, Naming Service, performance tracer, Web server cluster, J2EE server cluster, and user server

cluster-ref
Specifies the cluster name when setting up a logical server as a cluster member.
If the logical server to be set up as a cluster member is the J2EE server, this tag specifies the J2EE server cluster name, and for the Web server this tag specifies the Web server cluster name.
Logical servers other than the J2EE server and Web server cannot be set up as a cluster member.
This tag is defined only for the free-tier configuration.
O
--
--
None

server-no
Specifies the number for identifying the J2EE server when a configuration is specified for a specific J2EE server in the service unit. The specifiable range is from 1 to the value specified in <j2ee-server-count>. Specify a unique number on the host. Make sure that you specify this tag when specifying the J2EE server configuration when <j2ee-server-count> tag is specified in the physical tier definition.
O
O
O
None

configuration
Defines the configuration to be applied for each logical server.
If the environment settings defined in the physical tier definition are to be used for operation, there is no need to define the<configuration> tag.
This tag cannot be specified when J2EE server cluster or Web server cluster is specified in <logical-server-type>.
O
O
O
None

param#4
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.
M
M
M
None

param-name#4
Specifies the name of the parameter used for setting up the environment for the logical server. For the specifiable parameter names, see 4.11 System configuration patterns and defined logical servers.
M
M
M
None

param-value#4
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value. For details on the parameter settings, see 4.11 System configuration patterns and defined logical servers.
M
O#⁵
M
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

Note:

You cannot set up the logical server configuration included in the free-tier configuration, in the configuration change definition file.

#1

This tag can be omitted if the service unit definition is not changed.

#2

Can be omitted when cmx.websystem.name is specified in the client setting properties file or common client setting properties file.

#3

This tag can be omitted if the configuration is not defined for each logical server.

#4

The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.

#5

This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(5) Definition of host

Define the information about the host to be used under the <host> tag. The following table describes the contents that can be defined:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

host
Defines a host.
For defining multiple hosts, specify the host tag for each host. A host can be shared among multiple Web systems.
O#¹
--
O#²
None

host-name
Specifies a name or IP address for identifying the host within 32 characters.
A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
When specifying the host name for which the IP address cannot be changed, an error occurs during the system setup.
You can also specify @myhost in the <host-name> tag. If you specify @myhost, the host name is automatically replaced with the host name for the management server machine in the destination environment during system setup.
M
--
M
None

display-name
Specifies the host display name within 128 characters. There are no restrictions on the permitted characters.
O
--
O
None

description
Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.
O
--
O
None

agent-host
Specifies the host name or IP address of the Cosminexus Administration Agent. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
You can also specify @myhost in the <agent-host> tag. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
O
--
O
Value specified in host-name

agent-port
Specifies the port number of the Cosminexus Administration Agent, in the range from 1 to 65535.
O
--
O
20295

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a host is defined.

O: Optional.

--: Not applicable.

Note:

The host definition is not output when @myhost is specified in the <host-ref> tag in the unit definition, and the values in the <display-name> tag, <description> tag, <agent-host> tag, or <agent-port> tag in the host definition are omitted. In such a case, the Management Server automatically generates a value in the <host-name> tag of the host definition, as and when required. The host name is the computer name automatically created in the Management Server in Windows, and is the host name set up using the hostname command in UNIX. If the host does not contain any logical servers, the Management Server automatically deletes that host.

#1

This tag can be omitted if the host to be used is already defined using the Smart Composer functionality.

#2

This tag can be omitted if the host definition is not changed.

4.10.2 Tags that can be specified in the system for executing batch applications

This subsection describes the tags that can be specified in the system for executing batch applications.

Organization of this subsection

(1) Definition of Web system attributes

(2) Definition of physical tier

(3) Definition of the service unit

(4) Definition of host

(1) Definition of Web system attributes

The following table describes the contents that can be defined as Web system attributes:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

web-system
Defines a Web system.
For defining the multiple Web systems, specify the <web-system> tag for each Web system.
O#¹
O
O#²
None

name
Specifies a name for identifying the Web system, within 32 characters. This name must be unique within the management domain. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
M
M
M
None

addition-mode
Specifies the addition mode.

DEPLOYED#3
Specifies addition mode when scaling out the disk image using JP1/SC/DPM. If addition mode specified, deployment of the J2EE application and resource adapter is not required during system construction.

NORMAL
Specify this tag for a normal scale-out.

--
--
O
NORMAL

display-name
Specifies the display name of the Web system within 128 characters. There are no restrictions on the permitted characters.
O
O
--
None

description
Specifies a comment about the Web system within 1,024 characters. There are no restrictions on the permitted characters.
O
O
--
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

#1

This tag can be omitted if the Web system to be used is already defined using the Smart Composer functionality.

#2

This tag can be omitted if no service unit is to be added.

#3

For applying these settings, you must import and start the resource adapter in a batch using the Smart Composer functionality commands beforehand. For details, see the uCosminexus Application Server System Setup and Operation Guide.

(2) Definition of physical tier

Define the physical tier under the <tier> tag.

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

tier
Defines the physical tier.
In the system for executing batch applications, specify j2ee-tier or ctm-tier in the physical tier. Each physical tier define j2ee-tier in the <tier> tag.
M
O#¹
--
None

tier-type
Specifies the types of physical tiers. In the system for executing batch applications, specify j2ee-tier or ctm-tier.
M
M
--
None

configuration
Defines the configuration to be applied to all the logical servers in the physical tier for each type of logical server.
O#²
M#³
--
None

logical-server-type
Specifies the types of logical servers for defining the configuration. In the system for executing batch applications, define the batch server as the logical J2EE server. The following are the types of logical servers that can be specified in the tags:

j2ee-server:J2EE server

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

The logical server that can define the configuration varies according to the physical tier type.

In j2ee-tier

J2EE server and performance tracer

In ctm-tier

CTM domain manager, CTM, Smart Agent, J2EE server and performance tracer

M
M
--
None

param#4
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.
M
M
--
None

param-name#4
Specifies the name of the parameter used for setting up the environment for the logical server.
M
M
--
None

param-value#4
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value.
M
O#⁵
--
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

Note:

In a physical tier definition, you cannot specify the logical server configuration included in the user server and free-tier configuration. Specify these logical server configurations using unit definitions.

#1

This tag can be omitted if the physical tier definition is not changed.

#2

This tag can be omitted if the environment settings assumed in the Management Server during creation of the logical server are used for operations.

#3

This tag can be omitted if the cmx_trans_param command is used for expanding the abstract parameter to create the physical tier configuration.

#4

The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.

#5

This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(3) Definition of the service unit

Define the service unit under the <unit> tag. The following table describes the contents that can be defined:

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

unit
Defines a service unit.
For defining the multiple service units, specify the <unit> tag for each service unit to be defined.
M
O#¹
M
None

name
Specifies a name for identifying the service unit, as a maximum of 32 characters. This name must be unique within the Web system. Specify this name in the -unit option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
M
O#²
M
None

display-name
Specifies the display name of the service unit within 128 characters. There are no restrictions on the permitted characters.
O
O
O
None

description
Specifies a comment about the service unit within 1,024 characters. There are no restrictions on the permitted characters.
O
O
O
None

allocated-host
Defines the reference to the host that configures a service unit. Specify only one <allocated-host> tag.
M
M
M
None

host-ref
Specifies the host name specified in the <name> tag in the host definition, the host name defined in the already setup Web system, or @myhost.
When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
If there are multiple hosts, the same host cannot be shared in the same service unit.
M
M
M
None

hosts-for
Specifies the type of physical tier to which the host specified in the <host-ref> tag belongs. Specify j2ee-tier or ctm-tier in the system for executing batch applications.
M
M
M
None

define-server
Defines the configuration for each logical server that belongs to the physical tier specified in the <hosts-for> tag. For example, if j2ee-tier is specified in the <hosts-for> tag, you can define one logical server for each of the batch server and the performance tracer. For defining multiple logical servers, specify the <define-server> tag for each logical server.
O#³
M
O#³
None

logical-server-name
Specifies a name for identifying the logical server or cluster within 128 characters. Specify this name in the -s option of the Smart Composer functionality commands. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-).
O
--
O
cmx_Web-system-name_service-unit-name_type_serial-number

display-name
Specifies the display name of the logical server within 128 characters. There are no restrictions on the permitted characters.
O
O
O
None

description
Specifies a comment about the logical server within 1,024 characters. There are no restrictions on the permitted characters.
O
O
O
None

logical-server-type
Specifies the types of logical servers for defining the configuration. In the system for executing batch applications, define the batch server as the logical J2EE server. The following are the types of logical servers that can be specified in the tags:

j2ee-server:J2EE server

performance-tracer:Performance tracer

ctm-domain-manager:CTM domain manager

component-transaction-monitor:CTM

smart-agent:Smart Agent

user-server:User server

The logical server that can define the configuration of the host varies according to the physical tier type.

In j2ee-tier

J2EE server, performance tracer, and user server

In ctm-tier

CTM domain manager, CTM, Smart Agent, J2EE server, performance tracer, and user server

M
M
M
None

configuration
Defines the configuration to be applied for each logical server.
If the environment settings defined in the physical tier definition are to be used for operation, there is no need to define the<configuration> tag.
O
O
O
None

param#4
Defines the name and value of a parameter used for setting up the logical server environment. Enclose one parameter in each <param> tag.
M
M
M
None

param-name#4
Specifies the name of the parameter used for setting up the environment for the logical server. For the specifiable parameter names, see 4.11 System configuration patterns and defined logical servers.
M
M
M
None

param-value#4
Specifies the value to be set up in the parameter specified in the <param-name> tag. For specifying the multiple values in a parameter, specify the <param-value> tag for each value. For details on the parameter settings, see 4.11 System configuration patterns and defined logical servers.
M
O#⁵
M
None

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a Web system is defined.

O: Optional.

--: Not applicable.

Note:

In the configuration change definition file you cannot set up the logical server configuration included in the free-tier configuration.

#1

This tag can be omitted if the service unit definition is not changed.

#2

Can be omitted when cmx.websystem.name is specified in the client setting properties file or common client setting properties file.

#3

This tag can be omitted if the configuration is not defined for each logical server.

#4

The parameters specifiable in the <param> tag depend on the logical server type. Additionally, the logical server to be defined depends on the configuration pattern of the system. For checking the logical servers to be defined, see 4.11 System configuration patterns and defined logical servers. For details on the parameters that can be specified in each logical server, see the sections from 4.12 onwards as per the type of logical server used.

#5

This tag can be omitted if the parameter specified in the <param-name> tag is to be deleted.

(4) Definition of host

Tag names
Contents
Easy Setup definition file
Configuration definition change file
Default

P
U

host
Defines a host.
For defining multiple hosts, specify the host tag for each host. A host can be shared among multiple Web systems.
O#¹
--
O#²
None

host-name
Specifies a name or IP address for identifying the host within 32 characters.
A host name can be a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the management IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
When specifying the host name for which the IP address cannot be changed, an error occurs during the system setup.
You can also specify @myhost in the <host-name> tag. If you specify @myhost, the host name is automatically replaced with the host name for the management server machine in the destination environment during system setup.
M
--
M
None

display-name
Specifies the host display name within 128 characters. There are no restrictions on the permitted characters.
O
--
O
None

description
Specifies a comment about the host within 1,024 characters. There are no restrictions on the permitted characters.
O
--
O
None

agent-host
Specifies the host name or IP address of the Cosminexus Administration Agent. Specifies the host name within 32 characters. The permitted name is a combination of alphanumeric characters, underscore (_), and hyphen (-). Specifies the IP address in dot notations (xxx.xxx.xxx.xxx) where xxx is an integer in the range from 0 to 255.
You can also specify @myhost in the <agent-host> tag. When specifying @myhost, the value in the <host-name> tag in the host definition is automatically set up during the system setup.
O
--
O
Value specified in host-name

agent-port
Specifies the port number of the Cosminexus Administration Agent, in the range from 1 to 65535.
O
--
O
20295

Legend:

P: Indicates the configuration definition change file, for changing logical server parameters.

U: Indicates the configuration definition change file, for adding a service unit or host.

M: Mandatory if a host is defined.

O: Optional.

--: Not applicable.

Note:

The host definition is not output when @myhost is specified in the <host-ref> tag in the unit definition, and the values in the <display-name> tag, <description> tag, <agent-host> tag, or <agent-port> tag in the host definition are omitted. In such a case, the Management Server automatically generates a value in the <host-name> tag of the host definition, as and when required. The host name is the computer name automatically created in the Management Server in Windows, and is the host name set up using the hostname command in UNIX. If the host does not contain any logical servers, the Management Server automatically deletes that host.

#1

This tag can be omitted if the host to be used is already defined using the Smart Composer functionality.

#2

This tag can be omitted if the host definition is not changed.

4.11 System configuration patterns and defined logical servers

The type of defined logical server depends on the configuration pattern of a system to be set up. This section describes the parameters that can be specified in logical servers.

Organization of this section

4.11.1 Building a system for executing J2EE applications

4.11.2 Building a system for executing batch applications

4.11.1 Building a system for executing J2EE applications

You specify the configuration for each logical server (definition of the <configuration> tag) in the 'physical tier definition' and 'service unit definition' of the Easy Setup definition file and the configuration change definition file. The parameters that you can specify in the configuration differ for each defined logical server.

Also, some specifiable parameters are common for all the logical servers. For details about common logical server parameters, see 4.12 Parameters applicable to all logical servers.

The following table lists the defined logical server types and the specifiable parameters:

Table 4-4 List of defined logical server types and specifiable parameters (In J2EE applications)

Defined logical server type | Specifiable parameter | Reference
Logical Web server | Parameters that can be specified in the logical Web server | 4.13
Logical J2EE server | Parameters used for setting up the user properties for the J2EE server | 4.14.1
Parameters used for setting up the option definitions for the J2EE server | 4.14.2
Parameters applicable to the JavaVM system properties for the J2EE server | 4.14.3
Extension parameters of J2EE server | 4.14.4
Parameters used for setting up the Management Agent properties | 4.14.9
Parameters used for setting up the properties for issuing Management events | 4.14.10
Parameters used for setting up JP1 integration | 4.14.11
Parameters used for setting up the usage of SecurityManager | 4.14.12
Logical performance tracer | Parameters applicable to logical performance tracers | 4.15
Logical SFO server (Functionality for compatibility) | Parameters that can be specified in the logical SFO server | 4.16
Logical CTM domain manager | Parameters applicable to the logical CTM domain manager | 4.17
Logical CTM | Parameters applicable to the logical CTM | 4.18
Logical Smart Agent | Parameters applicable to the logical Smart Agent | 4.19
Logical user server | Parameters applicable to the logical user server | 4.20

If the physical tier type of the Easy Setup definition file output using the cmx_export_model command is free-tier, the Logical Naming Service is output. For details about the parameters output to the Logical Naming Service, see 4.21 Parameters applicable to the Logical Naming Service.

4.11.2 Building a system for executing batch applications

You define the following logical servers in a system for executing batch applications:

Logical J2EE server#

Logical performance tracer

Logical CTM domain manager

Logical CTM

Logical Smart Agent

# Define the batch server as the logical J2EE server.

Also, the parameters that you can specify in the configuration (definition of the <configuration> tag) differ for each defined logical server.

Also, some specifiable parameters are common for all the logical servers. For details about common logical server parameters, see 4.12 Parameters applicable to all logical servers.

The following table lists the defined logical server types and the specifiable parameters:

Table 4-5 List of defined logical server types and specifiable parameters (For batch applications)

Defined logical server type | Specifiable parameter | Reference
Logical J2EE server used as batch server | Parameters used for setting up the user properties for the batch server | 4.14.5
Parameters used for setting up the option definitions for the batch server | 4.14.6
Parameters applicable to the JavaVM system properties for the batch server | 4.14.7
Extension parameters of the batch server | 4.14.8
Parameters used for setting up the Management Agent properties | 4.14.9
Parameters used for setting up the properties for issuing Management events | 4.14.10
Parameters used for setting up JP1 integration | 4.14.11
Parameters used for setting up the usage of SecurityManager# | 4.14.12
Logical performance tracer | Parameters applicable to logical performance tracers | 4.15
Logical CTM domain manager | Parameters applicable to the logical CTM domain manager | 4.17
Logical CTM | Parameters applicable to the logical CTM | 4.18
Logical Smart Agent | Parameters applicable to the logical Smart Agent | 4.19

# Make sure that you specify this parameter in the batch server.

4.12 Parameters applicable to all logical servers

This subsection describes the parameters that can be commonly specified for the following logical servers:

Logical Web server

Logical J2EE server

Logical performance tracer

Logical SFO server

Logical CTM domain manager

Logical CTM

Logical Smart Agent

Logical user server

Logical Naming Service

Organization of this section

4.12.1 Parameters common to all logical servers

4.12.1 Parameters common to all logical servers

The following table describes the parameters that can be commonly specified in each logical server.

In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-6 Parameters common to all logical servers

Value of param-name
Value of param-value
Specifiable value
Default value
VR

additional.startcmd#1
Specifies the options to be added to the start command.
Specify alphanumeric characters and signs ($%'=^+_@:,./).
Alternatively, specify a string from 1 to 256 consecutive hyphen (-) or two backward slash (\\).
None
06-50
07-00

mstartup.force.watchtime
Specifies the time for monitoring forced termination of the logical server in seconds. When 0 is specified, monitoring is not performed. Specify 0, 60, 300, 600, or 1800.
When thread dump is output during the forced termination of a J2EE server or an SFO server and if the forced termination monitoring time is shorter than the time at which thread dump output ends, note that the J2EE server or SFO server process will end before the thread dump output finishes completely.
Specify 0, 60, 300, 600, or 1800.
60
07-60

mstartup.no
Specifies the starting order of the server during batch start as an integer. For not executing the batch start, specify -1.
Specify the value using an integer from -1 to 999.

Performance tracer: 0

Smart Agent: 10

Naming Service: 20

CTM domain manager: 30

CTM: 40

SFO server: 70

J2EE server: 80

Web server: 90

User server: 900

07-50

mstartup.premised.serverName#2
Specifies the premise logical server.
Specify a string within 128 characters using alphanumeric characters, underscore (_), and hyphen (-).
None
07-50

mstartup.restartcnt
Specifies the automatic restart count for logical servers.
Specify 0, 1, 5, 10, or 1000.
Specify 0, 1, 5, 10, or 1000.
1
06-50

mstartup.retrywait
Specifies the automatic restart retry interval for logical servers, in seconds. Specify 0, 60, 300, 600, or 1800.
Specify 0, 60, 300, 600, or 1800.
60
06-50

mstartup.start.watchtime
Specifies the logical server start monitoring time, in seconds.
Specify 0, 60, 300, 600, or 3600.
When 0 is specified, monitoring is not performed.
Specify 0, 60, 300, 600, or 3600.
600
06-50
07-00

mstartup.watchtime
Specifies the logical server termination monitoring time, in seconds.
Specify 0, 60, 300, 600, or 1800.
When 0 is specified, monitoring is not performed.
Specify 0, 60, 300, 600, or 1800.
60
06-50

realservername#3
Specifies the name of the real server. This value cannot be changed after executing the cmx_build_system command.
Specify a string within 128 characters beginning with an alphanumeric character and having alphanumeric characters, underscore (_), and hyphen (-).
logical-server-name
06-50
07-00

user.env.variable
Specifies the environment variable used for starting the server. #4 To specify multiple values, specify multiple <param-value> tags.
(Default value in Windows)

J2EE server

CSCCFJ_SERVER_HOME=${cosminexus.home}\CC

Path=${cosminexus.home}\CTM\bin;%{Path}

PRF

Path=${cosminexus.home}\PRF\bin;%{Path}

(Default value in UNIX)

J2EE server

CSCCFJ_SERVER_HOME=${cosminexus.home}/CC

(AIX)
AIXTHREAD_COND_DEBUG=OFF
AIXTHREAD_MUTEX_DEBUG=OFF
AIXTHREAD_RWLOCK_DEBUG=OFF
AIXTHREAD_SCOPE=S
EXTSHM=ON
NODISCLAIM=true
PSALLOC=early
LIBPATH=/opt/DABroker/lib:${cosminexus.home}/manager/bin:%{LIBPATH}

(HP-UX(IPF), Linux)
LD_LIBRARY_PATH=/opt/DABroker/lib:${cosminexus.home}/manager/bin:%{LD_LIBRARY_PATH}

HWS

PATH=${cosminexus.home}/PRF/bin

(AIX)
LDR_CNTRL=MAXDATA=0x40000000​
EXTSHM=ON
LIBPATH=${cosminexus.home}/PRF/lib:%{LIBPATH}

(HP-UX(IPF), Linux)
LD_LIBRARY_PATH=${cosminexus.home}/PRF/lib:%{LD_LIBRARY_PATH}

PRF

PATH=${cosminexus.home}/PRF/bin:%{PATH}

(AIX)
EXTSHM=ON
LDR_CNTRL=MAXDATA=0x40000000​
NODISCLAIM=true
PSALLOC=early
LIBPATH=${cosminexus.home}/PRF/lib:%{LIBPATH}

(HP-UX(IPF), Linux)
LD_LIBRARY_PATH=${cosminexus.home}/PRF/lib:%{LD_LIBRARY_PATH}

Specify any string.
None#5
07-50

#1

Cannot be specified in the logical user server.

If you want to add multiple startup options, specify multiple options demarcated by spaces in one param-value tag.

(Example)

<param-name>additional.startcmd</param-name>

<param-value>-CTMClientConnectCount 128 -CTMEntryCount 256</param-value>

#2

Cannot be specified in the logical performance tracer.

#3

Can only be specified in the logical Web server, logical J2EE server, and logical SFO server.

#4

To specify multiple values, specify multiple <param-value>.

(Example)

<param-name>user.env.variable</param-name>

<param-value>AAA=1024</param-value>

<param-value>BBB=2048</param-value>

#5

If user.env.variable is not specified, the default environment variable is set up in the logical server. For details on environment variables set up in the logical server by default, see 4.1.13 Notes on setting environment variables of logical server in the uCosminexus Application Server System Setup and Operation Guide.

4.13 Parameters applicable to logical Web servers

This section describes the parameters applicable to the logical Web server.

Organization of this section

4.13.1 Parameters used for setting up the definitions for the Web server

4.13.2 Parameters that set up the redirector action definition for Cosminexus HTTP Server

4.13.3 Parameters used for setting up the worker definition

4.13.4 Parameters for setting the log output method of Cosminexus HTTP Server

4.13.1 Parameters used for setting up the definitions for the Web server

The following table describes the parameters used for setting up the definitions, for the Web server:

For details about the contents to be specified in param-value corresponding to "Value in param-name", see the description on the list of directives in the manual Cosminexus HTTP Server. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-7 Parameters used for setting up the definitions for the Web server

Value of param-name
Value of param-value
Specifiable value
Default value
VR

SetBy
Specifies how to set up the Web server.
item: Specified for each item.
text: The contents of httpsd.conf (Cosminexus HTTP Server definition file) are specified directly.
The following strings can be specified:

item

text

item
08-70

CoreDumpDirectory
Specifies the directory for dumping core. You can specify an absolute path or a relative path from the value specified in the ServerRoot directive. Note that the users and groups specified in the User and Group directives must be given write permission for the specified directory. In the Linux versions, a directive is only enabled when specified in the configuration file.
Note that this specified value is only enabled in UNIX.
Specify any string.
&amp;{hws.home}/servers/HWS_server-name
06-50

Group
Specifies the group name used when server processes operate.
Note that this specified value is only enabled in UNIX.
Specify a string within 16 characters using alphanumeric characters and underscore (_).
bin
06-50
07-00

HWSKeepStartServers
Specifies whether to maintain the number of server processes at the number specified in the StartServers directive only.

If you specify On:

The running server processes are maintained at only the number specified in the StartServers directive. If the number of server processes becomes less than the value specified in the StartServers directive, new processes are generated. This functionality is enabled when the value specified in each directive related to the process count has the following relationship:

MinSpareServers < StartServers MaxClients

and

MinSpareServers < MaxSpareServers MaxClients

If the value set in the StartServers directive is less than the value set in the MinSpareServers directive, the number of server processes is maintained at the value in the MinSpareServers directive.

If you specify Off:

The running server processes are not maintained at the number specified in the StartServers directive.

For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.
Note that this specified value is only enabled in UNIX.
The following strings can be specified:

On

Off

Off
06-50

HWSLogTimeVerbose
Specifies whether an error log and a request log time, the time required for the request processing of the access log (%T), and the time at which request processing is started (%t) will be displayed in milliseconds.

If you specify On:

The time will be displayed up to milliseconds.

If you specify Off:

The time will be displayed up to milliseconds.

Note that an error log only includes the error log specified in the ErrorLog directive. The error log of the CGI script specified in the ScriptLog directive will not be considered.
The following strings can be specified:

On

Off

On
07-50

KeepAliveTimeout
Specifies the request waiting time for the KeepAlive connection in seconds. If a next request does not arrive from the client even after the lapse of time is greater than this time, the connection will be terminated. In KeepAlive, the server process is occupied with a specific client. If more time is required than the standard time for moving from a certain Web page to the next Web page, KeepAlive causes the timeout to occur, terminates the connection, and applies the server process to the processing of other requests.
For details about directives, see the manual Cosminexus HTTP Server.
Specify the value using an integer from 0 to 65535.
15
06-50

ServerName
Specifies the server name and port number of Cosminexus HTTP Server.
Specify the server name using FQDN (Fully Qualified Domain Name) or IP address.
For details on the contents specified, see the manual Cosminexus HTTP Server.
Server name and port number
www.example.com
08-70

Listen
Specifies an IP address and a port number that will receive a request. Unlike the Port directive, multiple values can be specified. You specify this tag for defining a virtual host. If you specify the Listen directive, the Port directive and the BindAddress directive will be ignored.
You can also specify IPv6 address as the IP address. When you specify IPv6 address, enclose the IPv6 address within square brackets ([ ]). However, if you omit the IP address and specify only the port number, only the requests using the IPv4 address will be received. Therefore, when using the IPv6 address, make sure that you specify the IPv6 address in the Listen directive.
The values that can be specified are as follows:

IPv4 address: Port number

Host name: Port number

@myhost: Port number

The host name is a string within 255 characters consisting of alphanumeric characters, underscore (_), period (.), and hyphen (-).
The port number is a one-byte numeric character from 1 to 65535.
None
07-50

LogLevel
Specifies error levels to be output in an error log. The log of a level higher than the specified level will be output. However, the notice level log will be output regardless of this specification. Also, the messages, output before the level specification analysis ends such as when Cosminexus HTTP Server starts, might be output regardless of this specification.
The following are the error levels in their order of superiority:

emerg: Emergency message

alert: Prompt processing request message

crit: Critical status message

error: General error message

warn: Warning level message

notice: Standard but important message

info: Information message, trace of external module and CGI program runtime module#1

debug: Debug level message, internal module trace, and module trace corresponding to info#1

The following strings can be specified:

emerg

alert

crit

error

warn

notice

info

debug

info
06-50

MaxClients
Specifies the maximum number of clients that can be connected at the same time.
When the server starts, the number of processes specified in the StartServer directive start and wait for requests. If many requests are issued concurrently, multiple processes process the requests. If the number of processes waiting for the requests becomes less than the number specified in the MinSpareServers directive, new processes will be generated gradually. At this time, processes are generated until the process count reaches the number specified in this directive. After this, when the request processing ends and the processes waiting for requests increase, the processes will be terminated up to the number specified in the MaxSpareServers directive.
For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.
Note that this specified value is only enabled in UNIX.
Specify the value using an integer from 1 to 1024.
150
06-50

StartServers
Specifies the number of server processes used for starting the Web server. For details about the other directives related to the process count, see the manual Cosminexus HTTP Server.
Note that this specified value is only enabled in UNIX.
Specify the value using an integer from 0 to 1024.
5
06-50

ThreadsPerChild
Specifies the number of threads to be started as the server. The specified thread count indicates the maximum number of concurrent connections of the server.
For details about directives, see the manual Cosminexus HTTP Server.
Note that this value is enabled only in Windows.
Specify the value using an integer from 1 to 1024.
50
06-50

User
Specifies the user name used when the server process is running.
Note that this specified value is only enabled in UNIX.
Specify a string within 16 characters using alphanumeric characters and underscore (_).
bin
06-50
07-00

DocumentRoot
Specifies an absolute path for the document root directory storing the contents.
For details about directives, see the manual Cosminexus HTTP Server.
Specify any string.
&amp;{hws.home}/htdocs
08-00

AppendDirectives
Specifies the directive contents to be added when a Web server is set up for each item (item is specified in the SetBy parameter).#² For details on directives, see the manual Cosminexus HTTP Server.
Specify any string.
None
08-70

AllText
Specifies the contents of httpsd.conf (Cosminexus HTTP Server definition file) when the Web server files are directly set up (text is specified in the SetBy parameter). #2 For details on httpsd.conf (Cosminexus HTTP Server definition file), see the manual Cosminexus HTTP Server.
Specify any string.
None
08-70

#1

You can specify settings to output the module trace in the request log instead of the error log. For more details, see the manual Cosminexus HTTP Server.

#2

Specify the param-value value in the CDATA section.

(Example)

<param-name>AppendDirectives</param-name>

<param-value>

<![CDATA[

<Location /server-status>

:

</Location>

]]>

</param-value>

4.13.2 Parameters that set up the redirector action definition for Cosminexus HTTP Server

The following table describes the parameters used for setting up the redirector action definition for Cosminexus HTTP Server:

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 9.3 mod_jk.conf (Redirector action definition file for Cosminexus HTTP Server). In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Note:

To enable the specification of Parameters that set up the redirector action definition for Cosminexus HTTP Server when specifying the AllText parameter, include the following code in the setup file:

Include "Cosminexus-installation-directory/CC/web/redirector/servers/Logical-Web-server/mod_jk.conf"

Table 4-8 Parameters that set up the redirector action definition for Cosminexus HTTP Server

Value of param-name
Specifiable value
Default value
VR

JkConnectTimeout
Specify the value using an integer from 0 to 3600.
30
07-00

JkGatewayHost
Specify one of the following values:

IPv4 address

Host name

Specify a string within 255 characters using alphanumeric characters, underscore (_), period (.), and hyphen (-) as a host name.
None
07-50

JkGatewayHttpsScheme
Specify one of the following values:

On

Off

Off
06-50

JkGatewayPort
Specify the value using an integer from 1 to 65535.
None
07-50

JkLogFileDir
Specify any string.
Logs
06-50

JkLogFileNum
Specify the value using an integer from 1 to 64.
8
06-50
07-50

JkLogFileSize
Specify the value using an integer from 4096 to 2147483647​.
4194304​
06-50
07-50

JkLogLevel
Specify one of the following values:

emerg

error

info

debug

error
06-50

JkModulePriority
Specify one of the following values:

REALLY_FIRST (corresponds to integer value -10)

FIRST (corresponds to integer value 0)

MIDDLE (corresponds to integer value 10)

LAST (corresponds to integer value 20)

REALLY_LAST (corresponds to integer value 30)

Integers from -10 to 30

FIRST
07-00

JkMount
Specify the definition file in the following format:
URL-pattern=worker-name
Use the name specified in the worker definition and worker.list in worker-name. For details on the worker definition and worker.list, see 4.13.3 Parameters that set up the worker definition.

Note:

Do not define the same J2EE server in multiple worker names. The operations cannot be guaranteed if such a worker is specified in JkMount.

In the combined-tier and http-tier#

/* J2EE-server-name

Note:

Concurrently, J2EE-server-name is set up as worker (type: ajp13).

07-50

JkPrfId
Specify a string within of 31 alphanumeric characters.
If a string beginning with 'TSC' and 'tsc' or 'CTM' and 'ctm' is specified, an error will occur.
None
The value is set automatically except for free-tier.
07-50

JkRequestRetryCount
Specify the value using an integer from 1 to 16.
3
07-00

JkSendTimeout
Specify the value using an integer from 0 to 3600.
100
07-00

JkTraceLog
Specify one of the following values:

On

Off

On
06-50

JkTraceLogFileDir
Specify any string.
Logs
06-50

JkTraceLogFileNum
Specify the value using an integer from 1 to 64.
4
06-50
07-50

JkTraceLogFileSize
Specify the value using an integer from 4096 to 2147483647​.
16777216​
06-50
07-50

JkTranslateBackcompat
Specify one of the following values:

On

Off

Off
06-50

Note:

If you specify multiple keys, the value specified last will be applied.

#

If this parameter is omitted in combined-tier and http-tier, values are set up in the related parameters as follows:

<param>

<param-name>JkMount</param-name>

<param-value>/* (J2EE server name)<param-value>

</param>

<param>

<param-name>worker.list</param-name>

<param-value>(J2EE server name)<param-value>

</param>

<param>

<param-name>worker.(J2EE server name).host</param-name>

<param-value>(host name)<param-value>

</param>

<param>

<param-name>worker.(J2EE server name).port</param-name>

<param-value>(Port number)<param-value>

</param>

<param>

<param-name>worker.(J2EE server name).type</param-name>

<param-value>ajp13</param-value>

</param>

4.13.3 Parameters used for setting up the worker definition

The following table describes the parameters used for setting a worker definition.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 9.5 workers.properties (Worker definition file). In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Note:

To enable the specification of parameters that set up the worker definition when you specify the AllText parameter, include the following code in the setup file:

Include "Cosminexus-installation-directory/CC/web/redirector/servers/Logical-Web-server/mod_jk.conf"

Organization of this subsection

(1) Keys specifiable in the worker definition file

(2) Parameters defined for each worker

(1) Keys specifiable in the worker definition file

These keys define workers, and the parameters for each worker. If an invalid value is specified for this key, the operations might not execute properly.

Value of param-name | Specifiable value | Default value | VR
worker.list | Specify any string. | None | 07-50
worker.worker-name.parameter | For details about the defined parameters, see (2) Parameters defined for each worker. | None | 07-50

(2) Parameters defined for each worker

Value of param-name
Specifiable value
Default value
VR

worker.worker-name.balanced_workers
Specify any string.
None
07-50

worker.worker-name.cachesize#
Specify the value using an integer from 1 to 2147483647​.
64
07-50

worker.worker-name.default_worker
Specify the worker names delimited with commas (,).
The spaces at the beginning and end are ignored.
None
07-50

worker.worker-name.delegate_error_code
Specify 400 to 417, 422 to 424, 500 to 505, 507, and 510 by using comma (,) as the delimiter.
None
07-50

worker.worker-name.host
You can specify the following values:

IPv4 address

Host name

@myhost

None
07-50

worker.worker-name.lbfactor#
Specify the value using an integer from 0 to 9999999999​.
1
07-50

worker.worker-name.port
Specify an integer from 1 to 65535.
None
07-50

worker.worker-name.post_data
Specify a string within 10 numeric characters (0 to 9) and a string with m, M, k, and K continuing 0 to one time.
None
07-50

worker.worker-name.post_size_workers
Specify any string.
None
07-50

worker.worker-name.receive_timeout#
Specify the value using an integer from 0 to 3600.
3600
07-50

worker.worker-name.port
Specify one of the following values:

ajp13

lb

post_size_lb

None
07-50

Note:

When you define a new worker, make sure that you define the following parameters:

For details on JkMount, see 4.13.2 Parameters that set up the redirector action definition for HTTP Server.

- worker.list

- worker.worker-name.host

- worker.worker-name.port

- worker.worker-name.type

- JkMount

#

When set up on combined-tier or http-tier, the default value is applied to the worker with the worker name defined in the J2EE server name. If you want to change the default value, define the worker described in Note above.

4.13.4 Parameters for setting the log output method of Cosminexus HTTP Server

This table describes the parameters used for setting up the log output method of Cosminexus HTTP Server. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-9 Parameters that set up the output method of the Cosminexus HTTP Server log

Value of param-name
Value of param-value
Specifiable value
Default value
VR

CustomDivideFileNum
Enabled when Div is specified in HttpsdCustomMethod.
Specifies the number of divided log files. If the number of divided files exceeds the number specified here, the oldest files are deleted. If 0 is specified, the files are not deleted.
Specify the value using an integer from 0 to 256.
8
07-50

CustomDivideTimeDifference
Enabled when Div is specified in HttpsdCustomMethod.
Specifies the standard time for dividing the log files (unit: minutes) in a range from -1439 to 1439 as the difference for GMT. If 0 is specified, January 1, 1970, 0:0:0 (GMT) becomes the standard time.
Specify the value using an integer from -1439 to 1439.
540
07-50

CustomDivideTimeInterval
Enabled when Div is specified in HttpsdCustomMethod.
Specifies the time interval used for one log file in a range from 1 to 31536000​.
Specify the value using an integer from 1 to 31536000​.
86400
07-50

CustomWraparoundFileNum
Enabled when Wrap is specified in HttpsdCustomMethod.
Specifies the maximum number of log files to be output in a range from 1 to 256.
If the size of the log file exceeds the size specified in CustomWraparoundFilesize, log is output to the next log file. In such a case, if the same number of log files as the maximum number specified in this parameter are already created, the files are re-used from the file with the name .001.
Specify the value using an integer from 1 to 256.
5
07-50

CustomWraparoundFilesize
Enabled when Wrap is specified in HttpsdCustomMethod.
Specifies the maximum size of the log file (units: kilobytes) in a range from 1 to 2097151​.
During log output, if the log file size exceeds the maximum size specified in this parameter, the log is output to the next log file. In such a case, the contents of the log file in which the log is output are cleared.
Specify the value using an integer from 1 to 2097151​.
8192
07-50

ErrorDivideFileNum
Enabled when Div is specified in HttpsdErrorMethod.
Specifies the number of divided log files in a range from 0 to 256. If the number of divided files exceeds the number specified here, the oldest files are deleted. If 0 is specified, the files are not deleted.
Specify the value using an integer from 0 to 256.
8
07-50

ErrorDivideTimeDifference
Enabled when Div is specified in HttpsdErrorMethod.
Specifies the standard time for dividing the log files (unit: minutes) in a range from -1439 to 1439 as the difference for GMT. If 0 is specified, January 1, 1970, 0:0:0 (GMT) becomes the standard time.
Specify the value using an integer from -1439 to 1439.
540
07-50

ErrorDivideTimeInterval
Enabled when Div is specified in HttpsdErrorMethod.
Specifies the time interval used for one log file in a range from 1 to 31536000​.
Specify the value using an integer from 1 to 31536000​.
86400
07-50

ErrorWraparoundFileNum
Enabled when Wrap is specified in HttpsdErrorMethod.
Specifies the maximum number of log files to be output in a range from 1 to 256.
If the size of the log file exceeds the size specified in ErrorWraparoundFilesize, log is output to the next log file. In such a case, if the same number of log files as the maximum number specified in this parameter are already created, the files are re-used from the file with the name .001.
Specify the value using an integer from 1 to 256.
5
07-50

ErrorWraparoundFilesize
Enabled when Wrap is specified in HttpsdErrorMethod.
Specifies the maximum size of the log file (units: kilobytes) in a range from 1 to 2097151​.
During log output, if the log file size exceeds the maximum size specified in this parameter, the log is output to the next log file. In such a case, the contents of the log file in which the log is output are cleared.
Specify the value using an integer from 1 to 2097151​.
8192
07-50

HttpsdCustomLogFileDir
Specifies the directory to output the access log output by the Web server.
Specify any string.
Logs
07-50

HttpsdCustomlogFormat
Specifies the label name provided by Cosminexus HTTP Server or an optional format.
The formats corresponding to the label names provided by Cosminexus HTTP Server are as follows:

common

combined

combinedio

hws_std

hws_trace

To specify a format other than the above, specify the optional format. The contents specified in the format are set up in the argument of the CustomLog directive in httpsd.conf (Cosminexus HTTP Server definition file).
For details on the contents to be specified in the format, see the description about the CustomLog directive in the manual Cosminexus HTTP Server.
Specify any string with a maximum of 1024 characters.
hws_std
07-50

HttpsdCustomMethod
Specifies one of the following as the log output method for access log:

Off

Does not change the settings in httpsd.conf (Cosminexus HTTP Server definition file)

If httpsd.conf is not edited, the default value is set.

On:

Outputs the log with a monotonic increase.

Div:

Divides and outputs the log in fixed time units.

Wrap:

Divides the log by the file size and outputs the log with wraparound.

The following strings can be specified:

Off

On

Div

Wrap

Div
07-50

HttpsdErrorLogFileDir
Specifies the directory to output the error log output by the Web server.
Specify any string.
Logs
07-50

HttpsdErrorMethod
Specifies one of the following as the error log output method:

Off

Does not change the settings in httpsd.conf (Cosminexus HTTP Server definition file) If httpsd.conf is not edited, Wrap is set.

On:

Outputs the log with a monotonic increase.

Div:

Divides and outputs the log in fixed time units.

Wrap:

Divides the log by the file size and outputs the log with wraparound.

The following strings can be specified:

Off

On

Div

Wrap

Div
07-50

HttpsdLogFileDir
Specifies the directory to which log information is to be output by the Web server.
Specify any string.
Logs
06-50
07-50

HttpsdRequestLogFileDir
Specifies the directory to output the request log output by the Web server.
Specify any string.
Logs
07-50

HttpsdRequestMethod
Specifies one of the following as the request log output method:

Off

Does not change the settings in httpsd.conf (Cosminexus HTTP Server definition file) If httpsd.conf is not edited, the default value is set.

On:

Outputs the log with a monotonic increase.

Div:

Divides and outputs the log in fixed time units.

Wrap:

Divides the log by the file size and outputs the log with wraparound.

The following strings can be specified:

Off

On

Div

Wrap

Div
07-50

HWSRequestIofilter
Enabled when "on" is set up in HWSRequestLogLevel.
Specified when the I/O filter trace showing the execution trigger is output for the I/O filter function implemented in the module. The amount of output is large, so specification in real operations is not recommended.
Specify one of the following values:

true:

Output the I/O filter trace

false:

Do not output the I/O filter trace

The following strings can be specified:

true

false

false
07-50

HWSRequestLogLevel
Specifies whether to output to the request log. Specify one of the following values:

on

Output the I/O filter trace

none

Do not output the I/O filter trace

If "on" is set up in this parameter, the following parameter settings are enabled:

HWSRequestIofilter

HWSRequestModuleDebug

HWSRequestModuleInfo

HWSRequestRequest

By default, the following parameters are output:

HWSRequestModuleInfo

HWSRequestRequest

The following strings can be specified: Note that the value is not case sensitive.

on

none

On
07-50

HWSRequestModuleDebug
Enabled when "on" is set up in HWSRequestLogLevel.
Specified when the module trace for internal module is output and trace corresponding to external module is output. The amount of output is large, so specification in real operations is not recommended.
Specify one of the following values:

true:

Output the I/O filter trace

false:

Do not output the I/O filter trace

The following strings can be specified:

true

false

false
07-50

HWSRequestModuleInfo
Enabled when "on" is set up in HWSRequestLogLevel.
Specified when module trace is output for the external module.
Specify one of the following values:

true:

Output the I/O filter trace

false:

Do not output the I/O filter trace

The following strings can be specified:

true

false

true
07-50

HWSRequestRequest
Enabled when "on" is set up in HWSRequestLogLevel.
Specified in the following cases:

When trace is output after connection is established and after response is complete

When trace is to be output even after receiving the next request line for KeepAlive connection

Specify one of the following values:

true:

Output the I/O filter trace

false:

Do not output the I/O filter trace

The following strings can be specified:

true

false

true
07-50

RequestDivideFileNum
Enabled when Div is specified in HttpsdRequestMethod.
Specifies the number of divided log files in a range from 0 to 256. If the number of divided files exceeds the number specified here, the oldest files are deleted. If 0 is specified, the files are not deleted.
Specify the value using an integer from 0 to 256.
8
07-50

RequestDivideTimeDifference
Enabled when Div is specified in HttpsdRequestMethod.
Specifies the standard time for dividing the log files (unit: minutes) in a range from -1439 to 1439 as the difference for GMT. If 0 is specified, January 1, 1970, 0:0:0 (GMT) becomes the standard time.
Specify the value using an integer from -1439 to 1439.
540
07-50

RequestDivideTimeInterval
Enabled when Div is specified in HttpsdRequestMethod.
Specifies the time interval used for one log file in a range from 1 to 31536000​.
Specify the value using an integer from 1 to 31536000​.
86400
07-50

RequestWraparoundFileNum
Enabled when Wrap is specified in HttpsdRequestMethod.
Specifies the maximum number of log files to be output in a range from 1 to 256.
If the size of the log file exceeds the size specified in RequestWraparoundFilesize, log is output to the next log file. In such a case, if the same number of log files as the maximum number specified in this parameter are already created, the files are re-used from the file with the name .001.
Specify the value using an integer from 1 to 256.
5
07-50

RequestWraparoundFilesize
Enabled when Wrap is specified in HttpsdRequestMethod.
Specifies the maximum size of the log file (units: kilobytes) in a range from 1 to 2097151​.
During log output, if the log file size exceeds the maximum size specified in this parameter, the log is output to the next log file. In such a case, the contents of the log file in which the log is output are cleared.
Specify the value using an integer from 1 to 2097151​.
8192
07-50

4.14 Parameters applicable to logical J2EE servers

This subsection describes the parameters that are applicable to logical J2EE servers.

In the logical J2EE server, the applicable parameters differ depending on whether the J2EE server or the batch server is used. The following table describes the applicable parameters, and the parameter references for each server:

Table 4-10 Correspondence between the server to be used and references of the parameters to be specified

Server to be used | Parameters to be specified
J2EE server | Parameters used for setting up the user properties for the J2EE server (see 4.14.1)
Parameters used for setting up the option definitions for the J2EE server (see 4.14.2)
Parameters applicable to the JavaVM system properties for the J2EE server (see 4.14.3)
Extension parameters of J2EE server (see 4.14.4)
Parameters that set up the usage for integrated user management (see 4.14.13)
Batch server | Parameters used for setting up the user properties for the batch server (see 4.14.5)
Parameters used for setting up the option definitions for the batch server (see 4.14.6)
Parameters applicable to the JavaVM system properties for the batch server (see 4.14.7)
Extension parameters of the batch server (see 4.14.8)
J2EE server and batch server | Parameters used for setting up the Management Agent properties (see 4.14.9)
Parameters used for setting up the properties for issuing Management events (see 4.14.10)
Parameters used for setting up JP1 integration (see 4.14.11)
Parameters used for setting up usage of SecurityManager (see 4.14.12)
Parameters that set up the files to be used in the JavaVM startup parameters (see 4.14.14)

Organization of this section

4.14.1 Parameters used for setting up the user properties for the J2EE server

4.14.2 Parameters used for setting up the option definitions for the J2EE server

4.14.3 Parameters applicable to the JavaVM system properties for the J2EE server

4.14.4 Extension parameters of J2EE server

4.14.5 Parameters used for setting up the user properties for the batch server

4.14.6 Parameters used for setting up the option definitions for the batch server

4.14.7 Parameters applicable to the JavaVM system properties for the batch server

4.14.8 Extension parameters of the batch server

4.14.9 Parameters used for setting up the Management Agent properties

4.14.10 Parameters used for setting up the properties for issuing Management events

4.14.11 Parameters used for setting up JP1 integration

4.14.12 Parameters used for setting up the usage of SecurityManager

4.14.13 Parameters that set up the usage for integrated user management

4.14.14 Parameters that set up the files to be used in the JavaVM startup parameters

4.14.1 Parameters used for setting up the user properties for the J2EE server

This section describes the parameters used for setting up the user properties for the J2EE server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4 usrconf.properties (User property file for J2EE servers). When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Note that the specification method of parameters for which "Value in param-name" is specified is different from usrconf.properties (user property file for J2EE servers).

Organization of this subsection

(1) Parameters beginning with cosminexus.jpa

(2) Parameters beginning with ejbserver.application

(3) Parameters beginning with ejbserver.client

(4) Parameters beginning with ejbserver.commonj

(5) Parameters beginning with ejbserver.compiler

(6) Parameters beginning with ejbserver.connectionpool

(7) Parameters beginning with ejbserver.connector

(8) Parameters beginning with ejbserver.container

(9) Parameters beginning with ejbserver.ctm

(10) Parameters beginning with ejbserver.deploy

(11) Parameters beginning with ejbserver.distributedtx

(12) Parameters beginning with ejbserver.DynamicStubLoading

(13) Parameters beginning with ejbserver.ejb

(14) Parameters beginning with ejbserver.ext

(15) Parameters beginning with ejbserver.http

(16) Parameters beginning with ejbserver.instrumentation

(17) Parameters beginning with ejbserver.jca

(18) Parameters beginning with ejbserver.jdbc

(19) Parameters beginning with ejbserver.jndi

(20) Parameters beginning with ejbserver.jpa

(21) Parameters beginning with ejbserver.jta

(22) Parameters beginning with ejbserver.logger

(23) Parameters beginning with ejbserver.management

(24) Parameters beginning with ejbserver.manager

(25) Parameters beginning with ejbserver.naming

(26) Parameters beginning with ejbserver.rmi

(27) Parameters beginning with ejbserver.server

(28) Parameters beginning with ejbserver.stateful

(29) Parameters beginning with ejbserver.stdoutlog

(30) Parameters beginning with ejbserver.watch

(31) Parameters beginning with ejbserver.webj2ee

(32) Parameters beginning with https

(33) Parameters beginning with java

(34) Parameters beginning with vbj

(35) Parameters beginning with vbroker

(36) Parameters beginning with webserver.application

(37) Parameters beginning with webserver.connector

(38) Parameters beginning with webserver.container

(39) Parameters beginning with webserver.context

(40) Keys beginning with webserver.eadssfo

(41) Parameters beginning with webserver.dbsfo

(42) Parameters beginning with webserver.http

(43) Parameters beginning with webserver.jsp

(44) Parameters beginning with webserver.logger

(45) Parameters beginning with webserver.servlet

(46) Parameters beginning with webserver.session

(47) Parameters beginning with webserver.static

(48) Parameters beginning with webserver.work

(49) Parameters beginning with webserver.xml

(1) Parameters beginning with cosminexus.jpa

The following table describes the parameters beginning with cosminexus.jpa. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(a) Keys beginning with cosminexus.jpa. When you reference the section, read the key as parameter.

Table 4-11 Parameters beginning with cosminexus.jpa

Value of param-name
Specifiable value
Default value
VR

cosminexus.jpa.logging.level.operation.category
The following strings can be specified:

Off

Information

Detail

Off
08-00

cosminexus.jpa.exception.logging.sql
The following strings can be specified:

Off

Information

Detail

Off
08-00

(2) Parameters beginning with ejbserver.application

The following table describes the parameters beginning with ejbserver.application. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(b) Keys beginning with ejbserver.application. When you reference the section, read the key as parameter.

Table 4-12 Parameters beginning with ejbserver.application

Value of param-name
Specifiable value
Default value
VR

ejbserver.application.InitTermProcessClasses#1
Specify any string.
None
06-50

ejbserver.application.userlog.CJLogHandler.handler-name.appname
Specify single byte character set of 0 to 16 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

Stroke (|)

Colon (:)

Ampersand (&)

At sign (@)

Hash (#)

Percent (%)

Hyphen (-)

user_app
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.count
(If CJMessageFileHandler is used)
2-16

(If CJMPMessageFileHandler is used)

2-64
2
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.encoding
Specify 0 to 1024 bytes using the following characters:

Alphanumeric characters

Plus '+'

Colon (:)

Period (.)

Underscore (_)

Hyphen (-)

None
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.filter
Specify a class character set of 0 to 4096 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

None
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.formatter
Specify a class character set of 0 to 4096 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

None
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.level
The following strings can be specified:

OFF

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ALL

SEVERE
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.limit
(If CJMessageFileHandler is used)
8192-2147483647​
(If CJMPMessageFileHandler is used)
8192-16777216​
1048576​
06-50
07-00
07-50

ejbserver.application.userlog.CJLogHandler.handler-name.msgid
Specify single byte character set of 0 to 21 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

Stroke (|)

Colon (:)

Ampersand (&)

At sign (@)

Hash (#)

Percent (%)

Hyphen (-)

0001
06-50
07-00

ejbserver.application.userlog.CJLogHandler.handler-name.path
Specify any string in the range of 1 to 255 bytes.
user_log
06-50

ejbserver.application.userlog.CJLogHandler.handler-name.separator
Specify single byte character set of 0 to 1024 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

Stroke (|)

Colon (:)

Ampersand (&)

At sign (@)

Hash (#)

Percent (%)

Hyphen (-)

Stroke (|)
06-50
07-00

ejbserver.application.userlog.Logger.logger-name.filter
Specify a class character set of 0 to 4096 bytes using the following characters:

Alphanumeric characters

Period (.)

Dollar sign ($)

Underscore (_)

None
06-50
07-00

ejbserver.application.userlog.Logger.logger-name.handlers#1
Specify a class character set of 1 to 1024 bytes beginning with alphanumeric characters.
Also, when specifying multiple values, delimit with commas (,).
None
06-50
07-00

ejbserver.application.userlog.Logger.logger-name.level
The following strings can be specified:

OFF

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ALL

null

SEVERE
06-50

ejbserver.application.userlog.Logger.logger-name.useParentHandlers
The following strings can be specified:

true

false

true
06-50

ejbserver.application.userlog.loggers#1
Specify a class path within 1024 characters.
When specifying multiple values, delimit with commas (,).
You can specify the following characters in the class path:

Alphanumeric characters

Dollar sign ($)

Underscore (_)

Period (.)

However, the class path must begin with an alphanumeric character.
None
06-50
07-00

ejbserver.application.userlog.menu.handlers.#1#2
Specify the list of handler names.
When specifying multiple values, delimit with commas (,).
None
06-50
07-00

#1

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

#2

When you delete the handler name from this parameter, also delete the related parameter (ejbserver.application.userlog.CJLogHandler.handler-name-to-be-deleted.XXX).

Note that the key corresponding to this parameter does not exist 2.4(5)(b) Keys beginning with ejbserver.application.

(3) Parameters beginning with ejbserver.client

The following table describes the parameters beginning with ejbserver.client. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(c) Keys beginning with ejbserver.client. When you reference the section, read the key as parameter.

Table 4-13 Parameters beginning with ejbserver.client

Value of param-name
Specifiable value
Default value
VR

ejbserver.client.ctm.RequestPriority
Specify the value using an integer from 1 to 8.
4
06-50
07-10

(4) Parameters beginning with ejbserver.commonj

The following table describes the parameters beginning with ejbserver.commonj. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(d) Keys beginning with ejbserver.commonj. When you reference the section, read the key as parameter.

Table 4-14 Parameters beginning with ejbserver.commonj

Value of param-name | Specifiable value | Default value | VR
ejbserver.commonj.WorkManager.non_daemon_work_threads | Specify the value using an integer from 1 to 65535. | 10 | 08-50

(5) Parameters beginning with ejbserver.compiler

The following table describes the parameters beginning with ejbserver.compiler.

Table 4-15 Parameters beginning with ejbserver.compiler

Value of param-name
Value of param-value
Specifiable value
Default value
VR

ejbserver.compiler.jvm.minHeapSize#
Specifies the maximum heap size of the javac command invoked when a J2EE application is started.
Specify a value that satisfies the condition ejbserver.compiler.jvm.minHeapSize ejbserver.compiler.jvm.maxHeapSize.
This parameter is valid in version 09-00-01 or earlier, and is ignored even if specified in version 09-00-02 or later.
Specify the value using an integer from 1 to 4095.
256
06-50
07-00

ejbserver.compiler.jvm.maxHeapSize#
Specifies a range of 1 to 4095 (unit: megabytes) as the initial heap size of the javac command invoked when a J2EE application is started.
Specify a value that satisfies the condition ejbserver.compiler.jvm.minHeapSize ejbserver.compiler.jvm.maxHeapSize.
This parameter is valid in version 09-00-01 or earlier, and is ignored even if specified in version 09-00-02 or later.
Specify the value using an integer from 1 to 4095.
32
06-50
07-00

#

When this value is specified in megabytes, the characters m or M are not required.

Also, you cannot specify the value in Kilobytes adding the characters k or K.

(6) Parameters beginning with ejbserver.connectionpool

The following table describes the parameters beginning with ejbserver.connectionpool. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(f) Keys beginning with ejbserver.connectionpool. When you reference the section, read the key as parameter.

Table 4-16 Parameters beginning with ejbserver.connectionpool

Value of param-name
Specifiable value
Default value
VR

ejbserver.connectionpool.association.enabled
The following strings can be specified:

true

false

false
07-50

ejbserver.connectionpool.validation.timeout
Specify the value using an integer from 1 to 2147483647​.
5
08-00

(7) Parameters beginning with ejbserver.connector

The following table describes the parameters beginning with ejbserver.connector. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(g) Keys beginning with ejbserver.connector. When you reference the section, read the key as parameter.

Table 4-17 Parameters beginning with ejbserver.connector

Value of param-name
Specifiable value
Default value
VR

ejbserver.connector.logwriter.filenum
Specify the value using an integer from 1 to 16.
4
06-50
07-00

ejbserver.connector.logwriter.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
2097152​
06-50
07-00

(8) Parameters beginning with ejbserver.container

The following table describes the parameters beginning with ejbserver.container. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(h) Keys beginning with ejbserver.container. When you reference the section, read the key as parameter.

Table 4-18 Parameters beginning with ejbserver.container

Value of param-name
Specifiable value
Default value
VR

ejbserver.container.audit_trail.enabled
The following strings can be specified:

true

false

false
07-60

ejbserver.container.passivate.scan.interval
Specify an integer from 0 to 2147483​ (unit: seconds).
0
06-50

ejbserver.container.remove.scan.interval
Specify an integer from 0 to 153722867280912​ (unit: minutes).
5
06-50

(9) Parameters beginning with ejbserver.ctm

The following table describes the parameters beginning with ejbserver.ejb. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(i) Keys beginning with ejbserver.ctm. When you reference the section, read the key as parameter.

Table 4-19 Parameters beginning with ejbserver.ctm

Value of param-name
Specifiable value
Default value
VR

ejbserver.ctm.ActivateTimeOut
Specify an integer from 0 to 2147483647​ (unit: seconds).
180
06-50
07-10

ejbserver.ctm.CTMID
The following strings can be specified:

String that does not begin with 'ctm' or 'CTM' and is maximum 31 characters using alphanumeric characters, underscore (_), and period (.).

IP address

ctm-tier:

IP-address-of-used-CTM-with-period-replaced-by-underscore(_)_port-number-of-CTM-used
Others:
IP-address
07-50

ejbserver.ctm.DeactivateTimeOut
Specify an integer from 0 to 2147483647​ (unit: seconds).
180
06-50
07-10

ejbserver.ctm.QueueLength
Specify the value using an integer from 1 to 32767.
None
06-50
07-10

ejbserver.ctm.useGlobalJNDI
The following strings can be specified:

true

false

false
09-00

(10) Parameters beginning with ejbserver.deploy

The following table describes the parameters beginning with ejbserver.deploy. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(j) Keys beginning with ejbserver.deploy. When you reference the section, read the key as parameter.

Table 4-20 Parameters beginning with ejbserver.deploy

Value of param-name
Specifiable value
Default value
VR

ejbserver.deploy.annotations.load_libjars.enabled
The following strings can be specified:

true

false

true
09-50

ejbserver.deploy.annotations.load_check.enabled
The following strings can be specified:

true

false

false
08-00

ejbserver.deploy.context.check_interval
Specify an integer from 0 to 2147483647​ (unit: seconds).
0
07-00

ejbserver.deploy.context.reload_scope
The following strings can be specified:

app

jsp

none

web

app
07-00

ejbserver.deploy.context.update.interval
Specify an integer from 0 to 2147483647​ (unit: seconds).
0
07-00

ejbserver.deploy.resourcefile.scramble.enabled
The following strings can be specified:

true

false

false
06-50

ejbserver.deploy.session.work.directory
Specify any string.

In Windows
&amp;{cosminexus.home}\CC\server\repository\&amp;{server.name}

In UNIX
&amp;{cosminexus.home}/CC/server/repository/&amp;{server.name}

07-00

(11) Parameters beginning with ejbserver.distributedtx

The following table describes the parameters beginning with ejbserver.distributedtx. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(k) Keys beginning with ejbserver.distributedtx. When you reference the section, read the key as parameter.

Table 4-21 Parameters beginning with ejbserver.distributedtx

Value of param-name
Specifiable value
Default value
VR

ejbserver.distributedtx.enableXidReuseOptimization
The following strings can be specified:

true

false

false
06-50

ejbserver.distributedtx.ots.recoverFailMessageCount
Specify the value using an integer from 0 to 2147483647​.
0
09-00

ejbserver.distributedtx.ots.status.directory1
Specify any string with a maximum of 200 characters.
otsstatus
06-70

ejbserver.distributedtx.ots.status.directory2
Specify any string with a maximum of 200 characters.
None
06-70

ejbserver.distributedtx.recovery.port
Specify the value using an integer from 1 to 65535.
20302
06-50
07-00

ejbserver.distributedtx.rollbackClientTxOnSystemException
The following strings can be specified:

true

false

false
06-50

ejbserver.distributedtx.XATransaction.enabled
The following strings can be specified:

true

false

false
06-50

(12) Parameters beginning with ejbserver.DynamicStubLoading

The following table describes the parameters beginning with ejbserver.DynamicStubLoading. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(l) Keys beginning with ejbserver.DynamicStubLoading. When you reference the section, read the key as parameter.

Table 4-22 Parameters beginning with ejbserver.DynamicStubLoading

Value of param-name
Specifiable value
Default value
VR

ejbserver.DynamicStubLoading.Enabled
The following strings can be specified:

true

false

false
06-50

(13) Parameters beginning with ejbserver.ejb

The following table describes the parameters beginning with ejbserver.ejb. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(m) Keys beginning with ejbserver.ejb. When you reference the section, read the key as parameter.

Table 4-23 Parameters beginning with ejbserver.ejb

Value of param-name | Specifiable value | Default value | VR
ejbserver.ejb.timerservice.maxCallbackThreads | Specify the value using an integer from 1 to 100. | 1 | 07-00
ejbserver.ejb.timerservice.retryCount | Specify the value using an integer from 0 to 2147483646​. | 1 | 07-00
ejbserver.ejb.timerservice.retryInterval | Specify an integer from 1 to 604800 (unit: seconds). | 5 | 07-00

(14) Parameters beginning with ejbserver.ext

The following table describes the parameters beginning with ejbserver.ext. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(n) Keys beginning with ejbserver.ext. When you reference the section, read the key as parameter.

Table 4-24 Parameters beginning with ejbserver.ext

Value of param-name | Specifiable value | Default value | VR
ejbserver.ext.method_observation.interval | Specify an integer from 0 to 86400 (unit: seconds). | 0 | 06-50

(15) Parameters beginning with ejbserver.http

The following table describes the parameters beginning with ejbserver.http. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(o) Keys beginning with ejbserver.http. When you reference the section, read the key as parameter.

Table 4-25 Parameters beginning with ejbserver.http

Value of param-name | Specifiable value | Default value | VR
ejbserver.http.port | Specify the value using an integer from 1 to 65535. | 8080 | 07-50

(16) Parameters beginning with ejbserver.instrumentation

The following table describes the parameters beginning with ejbserver.instrumentation. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(p) Keys beginning with ejbserver.instrumentation. When you reference the section, read the key as parameter.

Table 4-26 Parameters beginning with ejbserver.instrumentation

Value of param-name
Specifiable value
Default value
VR

ejbserver.instrumentation.enabled
The following strings can be specified:

true

false

true
06-50
07-00

(17) Parameters beginning with ejbserver.jca

The following table describes the parameters beginning with ejbserver.jca. For details about the contents to be specified in param-value corresponding to 'Value of param-name' see the 2.4(5)(q) Keys beginning with ejbserver.jca. When you reference the section, read the key as parameter.

Table 4-27 Parameters beginning with ejbserver.jca

Value of param-name
Specifiable value
Default value
VR

ejbserver.jca.adapter.tp1.bind_host
The values that can be specified are as follows:

IPv4 address

Host name

Valid local address selected automatically according to the system
08-50

(18) Parameters beginning with ejbserver.jdbc

The following table describes the parameters beginning with ejbserver.jdbc. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see the description of 2.11.1(1) Keys beginning with ejbserver.jdbc in the uCosminexus Application Server Maintenance and Migration Guide. When you reference the section, read the key as parameter.

Table 4-28 Parameters beginning with ejbserver.jdbc

Value of param-name | Specifiable value | Default value | VR
ejbserver.jdbc.propertyInfo.BUF_SIZE | Specify the value using an integer from 1 to 16000. | None | 06-50
ejbserver.jdbc.propertyInfo.ENCODELANG | Specify any string. | None | 06-50

(19) Parameters beginning with ejbserver.jndi

The following table describes the parameters beginning with ejbserver.jndi. For details about the contents to be specified in param-value corresponding to 'Value of param-name' see the 2.4(5)(r) Keys beginning with ejbserver.jndi. When you reference the section, read the key as parameter.

Table 4-29 Parameters beginning with ejbserver.jndi

Value of param-name
Specifiable value
Default value
VR

ejbserver.jndi.cache
The following strings can be specified:

on

off

on
06-50

ejbserver.jndi.cache.interval
Specify an integer from 0 to 2147483647​ (unit: seconds).
0
06-50

ejbserver.jndi.cache.interval.clear.option
The following strings can be specified:

refresh

check

refresh
06-50

ejbserver.jndi.global.enabled
The following strings can be specified:

true

false

true
09-00

ejbserver.jndi.namingservice.group.specify-group-name.providerurls
Specify a string lined up in the following order:
'corbaname::' '1 to 255 alphanumeric characters or @myhost':'0 to 65535 numeric characters'. Specify a string that is delimited one or more times with a semi-colon (;) and repeated.
None
07-50

ejbserver.jndi.namingservice.group.list
Specify the Logical Naming Service group delimiting with semi-colon (:).
The Logical Naming Service group consists within 30 alphanumeric characters or underscore (_).
None
07-50

ejbserver.jndi.request.timeout
Specify an integer from 0 to 86400 (unit: seconds).
0
06-50

(20) Parameters beginning with ejbserver.jpa

The following table describes the parameters beginning with ejbserver.jpa. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(s) Keys beginning with ejbserver.jpa. When you reference the section, read the key as parameter.

Table 4-30 Parameters beginning with ejbserver.jpa

Value of param-name
Specifiable value
Default value
VR

ejbserver.jpa.defaultJtaDsName
Specify any string.
None
08-00

ejbserver.jpa.defaultNonJtaDsName
Specify any string.
None
08-00

ejbserver.jpa.defaultProviderClassName
Specify any string.
com.hitachi.software.jpa.PersistenceProvider
08-00

ejbserver.jpa.disable
The following strings can be specified:

true

false

false
08-50

ejbserver.jpa.overrideJtaDsName
Specify any string.
None
08-00

ejbserver.jpa.overrideNonJtaDsName
Specify any string.
None
08-00

ejbserver.jpa.overrideProvider
Specify any string.
None
08-00

ejbserver.jpa.emfprop.property-key
Specify any string.
None
08-00

(21) Parameters beginning with ejbserver.jta

The following table describes the parameters beginning with ejbserver.jta. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(t) Keys beginning with ejbserver.jta. When you reference the section, read the key as parameter.

Table 4-31 Parameters beginning with ejbserver.jta

Value of param-name | Specifiable value | Default value | VR
ejbserver.jta.TransactionManager.defaultTimeOut | Specify an integer from 1 to 2147483647​ (unit: seconds). | 180 | 06-50

(22) Parameters beginning with ejbserver.logger

The following table describes the parameters beginning with ejbserver.logger. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(u) Keys beginning with ejbserver.logger. When you reference the section, read the key as parameter.

Table 4-32 Parameters beginning with ejbserver.logger

Value of param-name
Specifiable value
Default value
VR

ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.ConsoleLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.ConsoleLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.DevelopmentLogFile.filenum
Specify an integer from 1 to 16.
4
09-50

ejbserver.logger.channels.define.DevelopmentLogFile.filesize
Specify an integer from 4096 to 2147483647​.
1048576​
09-50

ejbserver.logger.DevelopmentLogFile.level
The following values can be specified:

OFF (Do not output)

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ALL (Output everything)

OFF
09-50

ejbserver.logger.channels.define.EJBContainerLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.EJBContainerLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.ExceptionLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.ExceptionLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.HttpSessionWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.HttpSessionWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.JPAOperationLogFile.filenum
Specify the value using an integer from 1 to 16.
2
08-00

ejbserver.logger.channels.define.JPAOperationLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
08-00

ejbserver.logger.channels.define.JPAMaintenanceLogFile.filenum
Specify the value using an integer from 1 to 16.
2
08-00

ejbserver.logger.channels.define.JPAMaintenanceLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
08-00

ejbserver.logger.channels.define.MaintenanceLogFile.filenum
Specify the value using an integer from 1 to 16.
4
07-50

ejbserver.logger.channels.define.MaintenanceLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
16777216​
07-50

ejbserver.logger.channels.define.MemoryWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.MemoryWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.MessageLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.MessageLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.RequestQueueWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.RequestQueueWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.ThreadWatchLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.ThreadWatchLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.UserErrLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.UserErrLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.UserOutLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.UserOutLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.WebAccessLogFile.filenum
Specify the value using an integer from 1 to 16.
16
07-50

ejbserver.logger.channels.define.WebAccessLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
4194304​
07-50

ejbserver.logger.channels.define.WebContainerLogFile.filenum
Specify the value using an integer from 1 to 16.
2
07-50

ejbserver.logger.channels.define.WebContainerLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejbserver.logger.channels.define.WebServletLogFile.filenum
Specify the value using an integer from 1 to 16.
4
07-50

ejbserver.logger.channels.define.WebServletLogFile.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
4194304​
07-50

ejbserver.logger.enabled.*
Specify the following strings delimiting with commas (,):

Error

Warning

Information

Debug

Error, Warning
07-50

ejbserver.logger.rotationTime
Specify in the HHMMSS format.
None
09-50

ejbserver.logger.rotationStyle
The following strings can be specified:

SHIFT

WRAP

WRAP
09-50

ejbserver.logger.systemlog.enabled
The following strings can be specified:

true

false

true
06-50

(23) Parameters beginning with ejbserver.management

The following table describes the parameters beginning with ejbserver.management. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(v) Keys beginning with ejbserver.management. When you reference the section, read the key as parameter.

Table 4-33 Parameters beginning with ejbserver.management

Value of param-name
Specifiable value
Default value
VR

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled
The following strings can be specified:

true

false

true
07-00

ejbserver.management.JVM.stats_monitor.FullGCCount.interval
Specify the value using an integer from 1 to 2147483647​ (unit: seconds).
600
07-00

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold
Specify an integer from 1 to 2147483647​ (unit: seconds).
10
07-00

ejbserver.management.statistics.interval
Specify an integer from 1 to 86400 (unit: seconds).
60
07-00

ejbserver.management.stats_file.base_time
Specify an integer from 0 to 1439 (unit: minutes).
0
07-00

ejbserver.management.stats_file.dir
Specify any string.
[In Windows]
Cosminexus-working-directory/ejb/server-name/stats
[In UNIX]
Cosminexus-working-directory/ejb/server-name/stats
07-00

ejbserver.management.stats_file.enabled
The following strings can be specified:

true

false

true
07-00

ejbserver.management.stats_file.num
Specify the value using an integer from 2 to 168.
7
07-00

ejbserver.management.stats_file.period
Specify an integer from 1 to 744 (unit: hours).
24
07-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.enabled
The following strings can be specified:

true

false

true
09-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.high_threshold
Specify an integer from 1 to 100 (unit: %)
80
09-00

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.low_threshold
Specify an integer from 0 to 99 (unit: %)
0
09-00

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.enabled
The following strings can be specified:

true

false

true
09-00

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.high_threshold
Specify an integer from 1 to 100 (unit: %)
80
09-00

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.low_threshold
Specify an integer from 0 to 99 (unit: %)
0
09-00

(24) Parameters beginning with ejbserver.manager

The following table describes the parameters beginning with ejbserver.manager. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(w) Keys beginning with ejbserver.manager. When you reference the section, read the key as parameter.

Table 4-34 Parameters beginning with ejbserver.manager

Value of param-name
Specifiable value
Default value
VR

ejbserver.manager.agent.JP1EventAgent.conf
Specify any string.
Cosminexus-installation-directory/manager/config/manager.real-server-name.properties
07-50

ejbserver.manager.agent.JP1EventAgent.enabled
The following strings can be specified:

true

false

false
07-50

ejbserver.manager.agent.MEventAgent.conf
Specify any string.
Cosminexus-installation-directory/manager/config/mevent.real-server-name.properties
07-50

ejbserver.manager.agent.MEventAgent.enabled
You can specify the following strings:

true

false

true
06-50
07-00

(25) Parameters beginning with ejbserver.naming

The following table describes the parameters beginning with ejbserver.naming. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(x) Keys beginning with ejbserver.naming. When you reference the section, read the key as parameter.

Table 4-35 Parameters beginning with ejbserver.naming

Value of param-name
Specifiable value
Default value
VR

ejbserver.naming.host
The following strings can be specified:

Host name

IPv4 address

@myhost

Same host as the J2EE server
07-50

ejbserver.naming.port#1
Specify the value using an integer from 1 to 65535.
900
07-50

ejbserver.naming.startupMode#2
The following strings can be specified:

manual

inprocess

inprocess
07-50

ejbserver.naming.startupRetryCount#1
Specify the value using an integer from 0 to 2147483647​.
9
07-50

ejbserver.naming.startupWaitTime#1
Specify an integer from 0 to 2147483647​ (unit: seconds).
1
07-50

#1

If a value other than 'inprocess' is specified in ejbserver.naming.startupMode, the value is ignored.

#2

You cannot specify automatic.

(26) Parameters beginning with ejbserver.rmi

The following table describes the parameters beginning with ejbserver.rmi. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(y) Keys beginning with ejbserver.rmi. When you reference the section, read the key as parameter.

Table 4-36 Parameters beginning with ejbserver.rmi

Value of param-name
Specifiable value
Default value
VR

ejbserver.rmi.localinvocation.scope
The following strings can be specified:

none

app

all

app
06-50

ejbserver.rmi.naming.host
The following strings can be specified:

Host name

IPv4 address

@myhost

None
07-50

ejbserver.rmi.naming.port
Specify the value using an integer from 1 to 65535.
23152
07-00

ejbserver.rmi.passbyreference
The following strings can be specified:

true

false

false
06-50

ejbserver.rmi.remote.listener.port
Specify the value using an integer from 0 to 65535.
0
07-00

ejbserver.rmi.request.timeout
Specify an integer from 0 to 86400 (unit: seconds).
0
06-50
07-00

(27) Parameters beginning with ejbserver.server

The following table describes the parameters beginning with ejbserver.server. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(z) Keys beginning with ejbserver.server. When you reference the section, read the key as parameter.

Table 4-37 Parameters beginning with ejbserver.server

Value of param-name
Specifiable value
Default value
VR

ejbserver.server.j2ee.feature
The following strings can be specified:

1.3basic

1.4

1.4
06-50
07-00

ejbserver.server.prf.PRFID
The following strings can be specified:

String that does not begin with 'ctm', 'CTM', 'tsc', and 'TSC' and is maximum 31 characters using alphanumeric characters and underscore (_).

CTMDOMAIN

PRF-identifier-of-PRF-used
07-50

ejbserver.server.threaddump.filenum
Specify the value using an integer from 1 to 2147483647​.
256
06-50

ejbserver.server.eheap.httpsession.enabled
The following strings can be specified:

true

false

true
08-00

ejbserver.server.eheap.ajp13.enabled
The following strings can be specified:

true

false

true
08-00

(28) Parameters beginning with ejbserver.stateful

The following table describes the parameters beginning with ejbserver.Stateful. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(aa) Keys beginning with ejbserver.stateful. When you reference the section, read the key as parameter.

Table 4-38 Parameters beginning with ejbserver.stateful

Value of param-name
Specifiable value
Default value
VR

ejbserver.stateful.passivate.switch
The following strings can be specified:

true

false

false
06-50

(29) Parameters beginning with ejbserver.stdoutlog

The following table describes the parameters beginning with ejbserver.stdoutlog. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(bb) Keys beginning with ejbserver.stdoutlog. When you reference the section, read the key as parameter.

Table 4-39 Parameters beginning with ejbserver.stdoutlog

Value of param-name
Specifiable value
Default value
VR

ejbserver.stdoutlog.autoflush
The following strings can be specified:

true

false

false
08-00

(30) Parameters beginning with ejbserver.watch

The following table describes the parameters beginning with ejbserver.watch. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(cc) Keys beginning with ejbserver.watch. When you reference the section, read the key as parameter.

Table 4-40 Parameters beginning with ejbserver.watch

Value of param-name
Specifiable value
Default value
VR

ejbserver.watch.defaultRequestQueue.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.defaultRequestQueue.interval
Specify an integer from 1 to 2147483647​ (unit: seconds).
30
06-50

ejbserver.watch.defaultRequestQueue.threshold
Specify an integer from 1 to 100 (unit:%).
80
06-50

ejbserver.watch.defaultRequestQueue.writefile.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.fileDescriptor.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.fileDescriptor.interval
Specify an integer from 1 to 2147483647​ (unit: seconds).
60
06-50

ejbserver.watch.fileDescriptor.threshold
Specify the value using an integer from 1 to 2147483647​.
2147483647​
06-50

ejbserver.watch.fileDescriptor.writefile.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.memory.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.memory.interval
Specify an integer from 1 to 2147483647​ (unit: seconds).
60
06-50

ejbserver.watch.memory.threshold
Specify an integer from 1 to 100 (unit: %).
80
06-50

ejbserver.watch.memory.writefile.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.thread.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.thread.interval
Specify an integer from 1 to 2147483647​ (unit: seconds).
60
06-50

ejbserver.watch.thread.threshold
Specify the value using an integer from 1 to 2147483647​.
2147483647​
06-50

ejbserver.watch.thread.writefile.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.threaddump.enabled
The following strings can be specified:

true

false

true
06-50

ejbserver.watch.threaddump.interval
Specify an integer from 1 to 2147483647​ (unit: seconds).
30
06-50

ejbserver.watch.threaddump.threshold
Specify an integer from 1 to 100 (unit: %).
80
06-50

ejbserver.watch.threaddump.writefile.enabled
The following strings can be specified:

true

false

true
06-50

(31) Parameters beginning with ejbserver.webj2ee

The following table describes the parameters beginning with ejbserver.webj2ee. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(dd) Keys beginning with ejbserver.webj2ee. When you reference the section, read the key as parameter.

Table 4-41 Parameters beginning with ejbserver.webj2ee

Value of param-name
Specifiable value
Default value
VR

ejbserver.webj2ee.connectionAutoClose.enabled
The following strings can be specified:

true

false

true
06-50
07-00

(32) Parameters beginning with https

The following table describes the specifiable keys and the parameters beginning with https. For details on the contents to be specified in param-value corresponding to the Value of param-name column, see the description in 2.4(5)(ae) Keys beginning with https. When you reference this section, read the key as a parameter.

Value of param-name | Specifiable value | Default value | VR
https.cipherSuites | # | # | 09-50
https.protocols | # | # | 09-50

#

For details on the keys, see the JDK documentation.

(33) Parameters beginning with java

The following table describes the parameters beginning with java. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(ff) Keys beginning with java. When you reference the section, read the key as parameter.

Table 4-42 Parameters beginning with java

Value of param-name
Specifiable value
Default value
VR

java.naming.factory.initial
The following strings can be specified:

com.hitachi.software.ejb.jndi.InsContextFactory

com.hitachi.software.ejb.jndi.GroupContextFactory

com.hitachi.software.ejb.jndi.InsContextFactory
06-50

(34) Parameters beginning with vbj

The following table describes the parameters beginning with vbj.

Table 4-43 Parameters beginning with vbj

Value of param-name
Value of param-value
Specifiable value
Default value
VR

vbj.java2iiop.jvm.maxHeapSize#
Specifies the maximum heap size of the java2iiop command invoked when a J2EE application starts.
Specify the value that satisfies the condition vbj.java2iiop.jvm.minHeapSize vbj.java2iiop.jvm.maxHeapSize.
Specify the value using an integer from 1 to 4095.
128
06-50
07-00

vbj.java2iiop.jvm.minHeapSize#
Specifies a range of 1 to 4095 (unit: megabytes) as the initial heap size of the java2iiop command invoked when a J2EE application starts.
Specify the value that satisfies the condition vbj.java2iiop.jvm.minHeapSize vbj.java2iiop.jvm.maxHeapSize.
Specify the value using an integer from 1 to 4095.
16
06-50
07-00

Note:

When this value is specified in megabytes, the characters m or M are not required.

Also, you cannot specify the value in Kilobytes adding the characters k or K.

(35) Parameters beginning with vbroker

The following table describes the parameters beginning with vbroker. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(hh) Keys beginning with vbroker. When you reference the section, read the key as parameter.

Table 4-44 Parameters beginning with vbroker

Value of param-name
Specifiable value
Default value
VR

vbroker.agent.port
Specify the value using an integer from 1 to 65535.
14000
07-50

vbroker.se.iiop_tp.host
The following strings can be specified:

IPv4 address

Host name

@myhost

None
07-50

vbroker.se.iiop_tp.scm.iiop_tp.listener.port
Specify the value using an integer from 0 to 65535.
0
06-50
07-00

(36) Parameters beginning with webserver.application

The following table describes the parameters beginning with webserver.application. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(ii) Keys beginning with webserver.application. When you reference the section, read the key as parameter.

Table 4-45 Parameters beginning with webserver.application

Value of param-name
Specifiable value
Default value
VR

webserver.application.lower_version
The following strings can be specified:

2.4

2.5

None
08-50

(37) Parameters beginning with webserver.connector

The following table describes the parameters beginning with webserver.connector. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(kk) Keys beginning with webserver.container. When you reference the section, read the key as parameter.

Table 4-46 Parameters beginning with webserver.connector

Value of param-name
Specifiable value
Default value
VR

webserver.connector.ajp13.backlog
Specify the value using an integer from 1 to 2147483647​.
100
06-50

webserver.connector.ajp13.bind_host
The following strings can be specified:

Host name

IPv4 address

@myhost

None
07-50

webserver.connector.ajp13.max_threads
Specify the value using an integer from 1 to 1024.
10
06-50

webserver.connector.ajp13.port
Specify the value using an integer from 1 to 65535.
8007
06-50
07-00

webserver.connector.ajp13.receive_timeout
Specify an integer from 0 to 3600 (unit: seconds).
600
06-50
07-00

webserver.connector.ajp13.send_timeout
Specify an integer from 0 to 3600 (unit: seconds).
600
07-00

webserver.connector.http.bind_host
Specify one of the following values:

Host name

IPv4 address

@myhost

None
07-50

webserver.connector.http.permitted.hosts#
The values that can be specified are as follows:

IPv4 address

Host name

Asterisk (*)

None
06-50
07-00

webserver.connector.inprocess_http.backlog
Specify the value using an integer from 1 to 2147483647​.
511
07-50

webserver.connector.inprocess_http.bind_host
The following strings can be specified:

Host name

IPv4 address

@myhost

None
07-50

webserver.connector.inprocess_http.enabled
The following strings can be specified:

true

false

false
07-50

webserver.connector.inprocess_http.enabled_methods
The values that can be specified are as follows:

GET

HEAD

POST

PUT

DELETE

OPTIONS

TRACE

CONNECT

PATCH

LINK

UNLINK

Asterisk (*)

GET,HEAD,POST,PUT,DELETE,OPTIONS
07-50

webserver.connector.inprocess_http.error_custom.error-page-customize-definition-name.file
File name
None
07-50

webserver.connector.inprocess_http.error_custom.error-page-customize-definition-name.file.content_type
Specify any string.
text/html
07-50

webserver.connector.inprocess_http.error_custom.error-page-customize-definition-name.redirect_url
Specify any string.
None
07-50

webserver.connector.inprocess_http.error_custom.error-page-customize-definition-name.request_url
Specify any string.
/*
07-50

webserver.connector.inprocess_http.error_custom.error-page-customize-definition-name.status
Specify the value using an integer from 400 to 599.
None
07-50

webserver.connector.inprocess_http.error_custom.list
Specify a string within 32 characters using alphanumeric characters and underscore (_). Also, when specifying multiple values, delimit with commas (,).
None
07-50

webserver.connector.inprocess_http.gateway.host
Specify one of the following values:

Host name

IPv4 address

@myhost

None
07-50

webserver.connector.inprocess_http.gateway.https_scheme
The following strings can be specified:

true

false

false
07-50

webserver.connector.inprocess_http.gateway.port
Specify the value using an integer from 1 to 65535.
None
07-50

webserver.connector.inprocess_http.init_threads
Specify the value using an integer from 1 to 1024.
10
07-50

webserver.connector.inprocess_http.keep_start_threads
The following strings can be specified:

true

false

false
07-50

webserver.connector.inprocess_http.limit.max_headers
Specify the value using an integer from 0 to 32767.
100
07-50

webserver.connector.inprocess_http.limit.max_request_body
Specify an integer from -1 to 2147483647​ (unit: bytes).
-1
07-50

webserver.connector.inprocess_http.limit.max_request_header
Specify an integer from 7 to 65536 (unit: bytes).
16384
07-50

webserver.connector.inprocess_http.limit.max_request_line
You can specify the following values (unit: bytes):

-1

7-8190

8190
07-50

webserver.connector.inprocess_http.max_connections
Specify the value using an integer from 1 to 1024.
100
07-50

webserver.connector.inprocess_http.max_execute_threads
Specify the value using an integer from 1 to 1024.
10
07-50

webserver.connector.inprocess_http.max_spare_threads
Specify the value using an integer from 1 to 1024.
20
07-50

webserver.connector.inprocess_http.min_spare_threads
Specify the value using an integer from 1 to 1024.
5
07-50

webserver.connector.inprocess_http.permitted.hosts
Specify one of the following values:

Host name

IPv4 address

@myhost

Asterisk (*)

*
07-50

webserver.connector.inprocess_http.persistent_connection.max_connections
Specify the value using an integer from 0 to 1024.
100
07-50

webserver.connector.inprocess_http.persistent_connection.max_requests
Specify the value using an integer from 0 to 2147483647​.
100
07-50

webserver.connector.inprocess_http.persistent_connection.timeout
Specify an integer from 0 to 3600 (unit: seconds).
3
07-50

webserver.connector.inprocess_http.port
Specify the value using an integer from 1 to 65535.
80
07-50

webserver.connector.inprocess_http.receive_timeout
Specify an integer from 0 to 3600 (unit: seconds).
300
07-50

webserver.connector.inprocess_http.redirect.redirect-definition-name.file
Specify the file name.
None
07-50

webserver.connector.inprocess_http.redirect.redirect-definition-name.file.content_type
Specify any string.
text/html
07-50

webserver.connector.inprocess_http.redirect.redirect-definition-name.redirect_url
Specify any string.
None
07-50

webserver.connector.inprocess_http.redirect.redirect-definition-name.request_url
Specify any string.
None
07-50

webserver.connector.inprocess_http.redirect.redirect-definition-name.status
The values that can be specified are as follows:

200

300

301

302

303

305

307

302
07-50

webserver.connector.inprocess_http.redirect.list
Specify a string within 32 characters using alphanumeric characters and underscore (_). Also, when specifying multiple values, delimit with commas (,).
None
07-50

webserver.connector.inprocess_http.rejection_threads
Specify the value using an integer from 0 to 1023.
1
07-50

webserver.connector.inprocess_http.response.header.server
Specify any string.
CosminexusComponentContainer
07-50

webserver.connector.inprocess_http.send_timeout
Specify an integer from 0 to 3600 (unit: seconds).
300
07-50

webserver.connector.limit.max_parameter_count
Specify the value using an integer from -1 to 2147483647​.
10000
09-00

webserver.connector.limit.max_post_form_data
Specify the value using an integer from -1 to 2147483647​.
2097152​
08-50

webserver.connector.redirect_https.port
Specify the value using an integer from 1 to 65535.
None
06-50
07-00

#

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

(38) Parameters beginning with webserver.container

The following table describes the parameters beginning with webserver.container. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(kk) Keys beginning with webserver.container. When you reference the section, read the key as parameter.

Table 4-47 Parameters beginning with webserver.container

Value of param-name
Specifiable value
Default value
VR

webserver.container.ac.logEnabled
The following strings can be specified:

true

false

false
06-50

webserver.container.server_id.enabled
The following strings can be specified:

true

false

false
06-51

webserver.container.server_id.name
Specify a string of 1 to 64 characters using alphanumeric characters and underscore (_). Note that if you specify the string JSESSIONID, an error will occur.
Null character (The value of cookie-name specified in the load balancer settings is automatically set.)
06-51
07-00
07-50

webserver.container.server_id.value
Specify a string of 1 to 64 characters using alphanumeric characters and the underscore (_).
String generated using the hash function from the host name and J2EE server name/Web container server name (compatibility function)
06-51
07-10
07-50

webserver.container.thread_control.enabled
The following strings can be specified:

true

false

true
06-50

webserver.container.thread_control.queue_size
Specify the value using an integer from 0 to 2147483647​.
8192
06-50

webserver.container.jaxws.webservice.no_webxml.enabled
The following strings can be specified:

strict

true

lax

none

false

none
08-00

webserver.container.jaxws.webservice.wsee.no_webxml.enabled
The following strings can be specified:

strict

lax

none

lax
08-70

webserver.container.jaxws.webservice.wsee.warname
Specifies the relative path of the WAR file for setup existing in the EAR file.
CosminexusWSEE.war
08-70

webserver.container.servlet.default_mapping.enabled
The following strings can be specified:

true

false

false
08-00

(39) Parameters beginning with webserver.context

The following table describes the parameters beginning with webserver.context. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(ll) Keys beginning with webserver.context. When you reference the section, read the key as parameter.

Table 4-48 Parameters beginning with webserver.context

Value of param-name | Specifiable value | Default value | VR
webserver.context.check_interval | Specify an integer from 0 to 2147483647​ (unit: seconds). | None | 07-00
webserver.context.reload_delay_timeout | Specify an integer from -2147483648​ to 2147483647​ (unit: seconds). | 0 | 07-00
webserver.context.update.interval | Specify an integer from 0 to 2147483647​ (unit: seconds). | None | 07-00

(40) Keys beginning with webserver.eadssfo

The following table describes the parameters beginning with webserver.eadssfo. For details on the contents to be specified in param-value corresponding to the Value of param-name column, see the description in 2.4(5)(an) Keys beginning with webserver.eadssfo. When you reference the section, read the key as a parameter.

Value of param-name
Specifiable value
Default value
VR

webserver.eadssfo.application.cache.name
Specify any string.
EADsSFO_APP_INFO
09-50

webserver.eadssfo.check_size.mode
The following strings can be specified:

on

off

off
09-50

webserver.eadssfo.client.retry.count
Specify an integer from 1 to 2147483647​.
2
09-50

webserver.eadssfo.client.retry.interval
Specify an integer from 1 to 2147483647​ (unit: millisecond).
2000
09-50

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.address
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
None #2
09-50

webserver.eadssfo.eads.client.connection-destination-EADs-server-name.port
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
24600
09-50

webserver.eadssfo.eads.client.node.list
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
None #2
09-50

webserver.eadssfo.eads.connection.buffersize
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.connection.retry
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
1
09-50

webserver.eadssfo.eads.connection.timeout
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.connectionPool.poolsize
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.commDump.enable
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.commTrace.enable
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
true
09-50

webserver.eadssfo.eads.logger.commTrace.filenum
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.commTrace.filesize
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.dir
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
${ejbserver.log.directory}
09-50

webserver.eadssfo.eads.logger.message.console.enable
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.message.filenum
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.eads.logger.message.filesize
Depends on the specifications for the EADs client definition. For details, see the Elastic Application Data store User Guide.
#1
09-50

webserver.eadssfo.enabled
The following strings can be specified:

true

false

false
09-50

webserver.eadssfo.exclude.url_patterns

Regularized URI beginning with '/'

Extension beginning with '*.'

*.txt;*.htm;*.html;*.jpg;*.gif;*.js
09-50

webserver.eadssfo.session.cache.name
Specify any string.
EADsSFO_SESSIONS
09-50

webserver.eadssfo.session_read_only.url_patterns

Regularized URI beginning with '/'

Extension beginning with '*.'

None
09-50

#1 The default EADs client definition value is applied.

#2 If the value is omitted, the KDJE34421-E message is output and the starting of the Web application using the EADs session failover functionality fails.

(41) Parameters beginning with webserver.dbsfo

The following table describes the parameters beginning with webserver.dbsfo. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(mm) Keys beginning with webserver.dbsfo. When you reference the section, read the key as parameter.

Table 4-49 Parameters beginning with webserver.dbsfo

Value of param-name
Specifiable value
Default value
VR

webserver.dbsfo.enabled
The following strings can be specified:

true

false

false
08-00

webserver.dbsfo.exclude.uris
Specify a normalized URI in character string starting from slash /.
None
08-50

webserver.dbsfo.connector.name
Specify any string.
COSMINEXUS_SFO_DBCONNECTOR
08-00

webserver.dbsfo.attribute_data_size.max
Specify the value using an integer from 128 to 10485760​.
1024
08-00

webserver.dbsfo.exclude.extensions
Specify a string within 512 characters using the following characters:

Alphanumeric characters

Brackets (( ))

Exclamation (!)

Percent (%)

Dollar sign ($)

Ampersand (&)

Single quote (')

Plus '+'

Hyphen (-)

Equal sign (=)

At sign (@)

Underscore (_)

Tilde (~)

Period (.)

Comma (,)

When specifying multiple extensions, delimit with commas (,).
txt,htm,html,jpg,gif,js
08-00

webserver.dbsfo.check_size.mode
The following strings can be specified:

on

off

off
08-00

webserver.dbsfo.exception_type_backcompat
The following strings can be specified:

true

false

false
08-70

webserver.dbsfo.integrity_mode.enabled
The following strings can be specified:

true

false

false
08-70

webserver.dbsfo.negotiation.high_level
The following strings can be specified:

true

false

false
08-70

webserver.dbsfo.session_read_only.uris
Specify a normalized URI in character string starting from slash (/).
None
08-70

webserver.dbsfo.thread_control_queue.enabled
The following strings can be specified:

true

false

false
08-70

(42) Parameters beginning with webserver.http

The following table describes the parameters beginning with webserver.http. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)( ap) Keys beginning with webserver.http. When you reference the section, read the key as a parameter.

Table 4-50 Parameters beginning with webserver.http

Value of param-name
Specifiable value
Default value
VR

webserver.http.request.encoding
Specify any string with a maximum of 1024 characters.
None
07-10

webserver.http.request.uri_decode.enabled
The following strings can be specified:

true

false

false
08-50

webserver.http.response.encoding
Specify any string with a maximum of 1024 characters.
None
07-10

(43) Parameters beginning with webserver.jsp

The following table describes the parameters beginning with webserver.jsp. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(aq) Keys beginning with webserver.jsp. When you reference the section, read the key as parameter.

Table 4-51 Parameters beginning with webserver.jsp

Value of param-name
Specifiable value
Default value
VR

webserver.jsp.additional.import.list
Specify any string.
None
08-70

webserver.jsp.check_interval
Specify an integer from 0 to 2147483647​ (unit: seconds).
None
07-00

webserver.jsp.compile.backcompat
You can specify the following values and strings:

5

1.5

1.4

1.3

1.2

true

false

false
06-50
07-00

webserver.jsp.debugging.enabled
The following strings can be specified:

true

false

false
08-00

webserver.jsp.el2_2.enabled
The following strings can be specified:

true

false

true
09-00

webserver.jsp.jsp_page.bom.enabled
The following strings can be specified:

true

false

true
08-00

webserver.jsp.keepgenerated
The following strings can be specified:

true

false

false
06-50

webserver.jsp.pageEncoding
Specify any string with a maximum of 1024 characters.
None
07-10

webserver.jsp.tld.mapping.java_ee_tag_library.enabled
The following strings can be specified:

true

false

true
08-00

webserver.jsp.translation.customAction.ignoreCaseAttributeName
The following strings can be specified:

true

false

false
08-00

webserver.jsp.translation.backcompat.customAction.declareVariable
The following strings can be specified:

true

false

false
07-60

webserver.jsp.translation.backcompat.tag.noCheckRtexprvalue
The following strings can be specified:

true

false

false
07-60

webserver.jsp.translation.backcompat.tag.rtexprvalueTerminate
The following strings can be specified:

true

false

false
07-60

webserver.jsp.translation.backcompat.taglib.noCheckPrefix
The following strings can be specified:

true

false

false
07-60

webserver.jsp.translation.backcompat.useBean.noCheckClass
The following strings can be specified:

true

false

false
07-60

webserver.jsp.translation.useBean.noCheckDuplicateId
The following strings can be specified:

true

false

false
08-00

webserver.jsp.update.interval
Specify the value using an integer from 0 to 2147483647​.
None
07-00

(44) Parameters beginning with webserver.logger

The following table describes the parameters beginning with webserver.logger. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(qq) Keys beginning with webserver.logger. When you reference the section, read the key as parameter.

Table 4-52 Parameters beginning with webserver.logger

Value of param-name
Specifiable value
Default value
VR

webserver.logger.access_log.format-name
Specify any string with a maximum of 1024 characters.
%h %l %u %t &quot;%r&quot;%&gts %b
07-50

webserver.logger.access_log.format_list
Specify a string within 32 characters using alphanumeric characters and underscore (_). Also, when specifying multiple values, delimit with commas (,).
None
07-50

webserver.logger.access_log.inprocess_http.enabled
The following strings can be specified:

true

false

true
07-50

webserver.logger.access_log.inprocess_http.filename
Specify any string with a maximum of 210 characters.
(In Windows)
Cosminexus-working-directory\ejb\server-name\logs\http\cjhttp_access.inprocess_http
(In UNIX)
Cosminexus-working-directory/ejb/server-name/logs/http/cjhttp_access.inprocess_http
07-50

webserver.logger.access_log.inprocess_http.filenum
Specify the value using an integer from 1 to 256.
16
07-50

webserver.logger.access_log.inprocess_http.filesize
Specify an integer from 4096 to 2147483647​.
4194304​
07-50

webserver.logger.access_log.inprocess_http.usage_format
Specify a string within 32 characters using alphanumeric characters and underscore (_).
common
07-50

(45) Parameters beginning with webserver.servlet

The following table describes the parameters beginning with webserver.servlet. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(as) Keys beginning with webserver.servlet. When you reference the section, read the key as parameter.

Table 4-53 Parameters beginning with webserver.servlet

Value of param-name
Specifiable value
Default value
VR

webserver.servlet_api.exception.getCause.backcompat
The following strings can be specified:

true

false

false
08-00

webserver.ServletContainerInitializer_jar.include.path
There are no restrictions on the permitted characters.
When specifying multiple values, delimit with commas (,). Use a slash (/) as the directory path delimiter.
None
09-00

(46) Parameters beginning with webserver.session

The following table describes the parameters beginning with webserver.session. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(au) Keys beginning with webserver.session. When you reference the section, read the key as parameter.

Table 4-54 Parameters beginning with webserver.session

Value of param-name
Specifiable value
Default value
VR

webserver.session.cookie_config.http_only
The following strings can be specified:

true

false

false
09-50

webserver.session.cookie_config.name
Specify any string.
JSESSIONID
09-50

webserver.session.server_id.value
Specify a string within 64 characters using alphanumeric characters and underscore (_).
String generated using the hash function from the host name and J2EE server name/Web container server name (compatibility functionality) #
06-50
07-10
07-50

webserver.session.max.throwHttpSessionLimitExceededException
The following strings can be specified:

true

false

false
08-00

webserver.session.tracking_mode
The following strings can be specified:

COOKIE

URL

Specify both COOKIE and URL
09-50

#

Management Server automatically sets an 8-digit hexadecimal except for the free-tier.

(47) Parameters beginning with webserver.static

The following table describes the parameters beginning with webserver.static. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(av) Keys beginning with webserver.static. When you reference the section, read the key as parameter.

Table 4-55 Parameters beginning with webserver.static

Value of param-name
Specifiable value
Default value
VR

webserver.static_content.cache.enabled
The following strings can be specified:

true

false

forceoff

false
06-70

webserver.static_content.cache.filesize.threshold
Specify the value using an integer from 0 to 2147483647​.
524288
06-70

webserver.static_content.cache.size
Specify the value using an integer from 0 to 2147483647​.
10485760​
06-70
07-00

webserver.static_content.encoding.extension
Specify any string.
None
07-60

(48) Parameters beginning with webserver.work

The following table describes the parameters beginning with webserver.work. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(aw) Keys beginning with webserver.work. When you reference the section, read the key as parameter.

Table 4-56 Parameters beginning with webserver.work

Value of param-name
Specifiable value
Default value
VR

webserver.work.clean
The following strings can be specified:

true

false

false
06-50

webserver.work.directory
Specify any string.
(In Windows)
&amp;{cosminexus.home}\CC\server\repository\&amp;{server.name}\web
(In UNIX)
&amp;{cosminexus.home}/CC/server/repository/&amp;{server.name}/web
06-50

(49) Parameters beginning with webserver.xml

The following table describes the parameters beginning with webserver.xml. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4(5)(ax) Keys beginning with webserver.xml. When you reference the section, read the key as parameter.

Table 4-57 Parameters beginning with webserver.xml

Value of param-name
Specifiable value
Default value
VR

webserver.xml.validate
The following strings can be specified:

true

false

true
06-50

4.14.2 Parameters used for setting up the option definitions for the J2EE server

The following table describes the parameters used for setting up the option definitions for the J2EE server. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.3 usrconf.cfg (Option definition file for J2EE servers). In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-58 Parameters used for setting up the option definitions for the J2EE server

Value of param-name
Specifiable value
Default value
VR

add.jvm.arg#
This key invokes JavaVM by using the specified option.
If you want to specify the system properties, do not use -D, but specify in usrconf.properties file.
When specifying multiple options, use the same key name and specify multiple times as follows:
(Example of specification)
add.jvm.arg= -Xms128m
add.jvm.arg= -Xmx256m
You cannot specify multiple options as shown in the following example. If you specify the options as shown below, the initialization of JavaVM will fail.
(Example of specification)
add.jvm.arg=-Xms128m -Xmx256m
For details about specifiable keys, see 2.3(5) JavaVM options that can be specified in add.jvm.arg.
For details about default values, see 2.3(5)(b) Default values of the JavaVM options in J2EE servers.
07-50

ejb.public.directory
Specify any string.
(In Windows)
&amp;{cosminexus.home}\CC\server\public
(In UNIX)
&amp;{cosminexus.home}/CC/server/public
06-50

ejb.server.log.directory
Specify any string with a maximum of 200 characters.
(In Windows)
Cosminexus-working-directory/ejb/server-name/logs
(In UNIX)
Cosminexus-working-directory/ejb/server-name/logs
06-50

Note:

The value specification format is as follows:

(Example)

<param-name>add.jvm.arg</param-name>

<param-value>-Xms256m</param-value>

<param-value>-Xmx512m</param-value>

:

4.14.3 Parameters applicable to the JavaVM system properties for the J2EE server

The following table describes the parameters applicable to the JavaVM system properties for the J2EE server. For details about the values to be specified in 'Value of param-name', see 2.4 usrconf.properties (User property file for J2EE servers). In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

The specification format for specifying the parameters applicable to the JavaVM system properties for the J2EE server is as follows:

Specification format

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>parameter-name</param-name>
<param-value>Value</param-value>
<param-value>Value</param-value>

Table 4-59 Parameters applicable to the JavaVM system properties for the J2EE server

Value of param-name
Specifiable value
Default value
VR

ejbserver.connectionpool.applicationAuthentication.disabled
The following strings can be specified:

true

false

false
07-50

ejbserver.connectionpool.association.enabledDespiteUnshareableSetting
The following strings can be specified:

true

false

false
07-50

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled
The following strings can be specified:

true

false

false
07-50

ejbserver.container.bmp.backcompatible
The following strings can be specified:

true

false

false
07-50

ejbserver.container.ejbhome.sessionbean.reconnect.enabled
The following strings can be specified:

true

false

false
07-50

ejbserver.container.rebindpolicy
The following strings can be specified:

VB_TRANSPARENT

NO_RECONNECT

VB_TRANSPARENT
07-50

ejbserver.container.security.disabled
The following strings can be specified:

true

false

false
07-50

ejbserver.ctm.CTMDomain
The following strings can be specified:

String that does not begin with 'ctm', 'CTM', 'tsc', and 'TSC' and is maximum 31 characters using alphanumeric characters and underscore (_).

CTMDOMAIN

CTMDOMAIN
07-50

ejbserver.ctm.CTMMyHost
Specify 1 to 255 characters using the following characters:

Alphanumeric characters

Underscore (_)

Period (.)

Hyphen (-)

host-name-acquired-by-hostname-command
07-50

ejbserver.ctm.enabled
The following strings can be specified:

true

false

ctm-tier: true
Others: false
07-50

ejbserver.deploy.app.stopforcibly.disabled
The following strings can be specified:

true

false

false
07-50

ejbserver.deploy.exclusive.lockAliveInterval
Specify an integer from 1 to 2147483647​ (unit: seconds).
60
07-50

ejbserver.deploy.stub.generation.scope
The following strings can be specified:

ejb

app

ejb
07-50

ejbserver.distributedtx.recovery.completionCheckOnStopping.timeout
Specify an integer from -1 to 2147483647​ (unit: seconds).
-1
07-50

ejbserver.ejb.cmp20.cmr.use.existing_table
The following strings can be specified:

true

false

false
07-50

ejbserver.jndi.cache.reference
The following strings can be specified:

on

off

off
07-50

ejbserver.manager.agent.Agent.conf#1
Specify any string.
Cosminexus-installation-directory/manager/config/mngagent.real-server-name.properties
07-50

ejbserver.manager.agent.Agent.enabled#1
The following strings can be specified:

true

false

true
07-50

ejbserver.manager.jp1event.event_server_name
Specify any string.
localhost
07-50

ejbserver.naming.exec.args
Specify any string.
None
07-50

ejbserver.naming.nameroot
Specify a string having alphanumeric characters and underscore (_).
None
07-50

ejbserver.naming.protocol
The following strings can be specified:

corbaname

iioploc

iiopname

corbaname
07-50

ejbserver.rmi.stateless.unique_id.enabled
The following strings can be specified:

true

false

false
07-50

ejbserver.server.mutex.invocation.timeout
Specify an integer from 45 to 92233720368547758​ (unit: seconds).
45
07-50

vbroker.agent.enableLocator#2
The following strings can be specified:

true

false

false
07-50

vbroker.orb.htc.comt.entryCount
Specify the value using an integer from 100 to 30000000​.
120000
07-50

vbroker.orb.htc.comt.fileCount
Specify the value using an integer from 1 to 256.
3
07-50

vbroker.orb.htc.tracePath
Specify any string in the range of 1 to 210 bytes.
(In Windows)
Cosminexus-working-directory\ejb\server-name\logs\TPB\logj
(In UNIX)
Cosminexus-working-directory/ejb/server-name/logs/TPB/logj
07-50

webserver.connector.ajp12.backlog#3
Specify the value using an integer from 1 to 2147483647​.
None
07-50

webserver.connector.ajp12.max_threads#3
Specify the value using an integer from 1 to 1024.
None
07-50

webserver.connector.ajp12.port#3
Specify the value using an integer from 1 to 65535.
None
07-50

webserver.connector.inprocess_http.hostname_lookups
The following strings can be specified:

true

false

false
07-50

webserver.errorpage.stack_trace.enabled
The following strings can be specified:

true

false

false
07-50

webserver.jsp.precompile.jsp_work_dir
Specify a string having alphanumeric characters and underscore (_).
cosminexus_jsp_work
07-50

webserver.logger.communication_trace.inprocess_http.filenum
Specify the value using an integer from 1 to 256.
16
07-50

webserver.logger.thread_trace.inprocess_http.filenum
Specify the value using an integer from 1 to 256.
16
07-50

webserver.session.max.log_interval
Specify the value using an integer from 0 to 2147483647​.
60
07-50

webserver.session.server_id.enabled
The following strings can be specified:

true

false

true
07-50

webserver.sfo.negotiation.ignore_serverId
The following strings can be specified:

true

false

false
07-50

webserver.session.delete_cookie.backcompat
The following strings can be specified:

true

false

false
08-00

Note:

For specifying the multiple values in param-value, specify multiple <param-value>.

(Example)

<param-name>parameter-name</param-name>

<param-value>Value<param-value>

<param-value>Value<param-value>

#1

Settings are not recommended because the Management Server sets the value automatically.

#2

Settings are not required normally.

#3

Parameter for maintaining compatibility with the older versions.

Reference note

The parameters described in this table can also be specified in the following format:

Specification format

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

<param-value>Parameter-name=Value<param-value>

4.14.4 Extension parameters of J2EE server

The following table describes the extension parameters of J2EE server. For the details about the values to be specified in 'Value of param-name', see 2.3 usrconf.cfg (Option definition file for J2EE servers). Also, for details about batch.service.enabled, see 3.2 usrconf.cfg (Option definition file for batch servers). In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

The specification format for specifying the extension parameters of the J2EE server is as follows:

Specification format

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>
<param-value>Value</param-value>

Table 4-60 Parameters applicable to the extension parameters of J2EE server

Key name
Specifiable value
Default value
VR

add.class.path
Specify any string.
None
07-50

add.library.path
Specify any string.
None
07-50

cpp.library.version
Specify 6. Only 6 can be specified with version 09-00 or later.
6
07-50

ejb.server.corefilenum (In UNIX)
Specify the value using an integer from 0 to 16.
1
07-50

ejb.server.log.mode
Specify 6 or 7.
7
07-50

ejb.server.log.stdout.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

ejb.server.log.stderr.filesize
Specify an integer from 4096 to 2147483647​ (unit: bytes).
1048576​
07-50

jvm.type
The following strings can be specified:

server

client

server
07-50

batch.service.enabled
false#
false
07-60

Note:

For specifying the multiple values in param-value, specify multiple <param-value>.

(Example)

<param-name>parameter-name</param-name>

<param-value>Value<param-value>

<param-value>Value<param-value>

#

Do not specify true in batch.service.enabled parameter. The value is false by default. You can specify this parameter only during the initial setup of the Web system. Do not change the value when changing the Web system configuration.

Reference note

The parameters described in this table can also be described in the following format:

Specification format

<param-name>ex.param</param-name>

<param-value>Parameter-name=Value<param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>ex.param</param-name>

<param-value>Parameter-name=Value<param-value>

<param-value>Parameter-name=Value<param-value>

4.14.5 Parameters used for setting up the user properties for the batch server

This section describes the parameters used for setting up the user properties for the batch server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 3.3 usrconf.properties (User property file for batch servers). When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified.

Organization of this subsection

(1) Parameters beginning with ejbserver.application

(2) Parameters beginning with ejbserver.batch

(3) Parameters beginning with ejbserver.client

(4) Parameters beginning with ejbserver.connectionpool

(5) Parameters beginning with ejbserver.connector

(6) Parameters beginning with ejbserver.container

(7) Parameters beginning with ejbserver.deploy

(8) Parameters beginning with ejbserver.ext

(9) Parameters beginning with ejbserver.http

(10) Parameters beginning with ejbserver.instrumentation

(11) Parameters beginning with ejbserver.jndi

(12) Parameters beginning with ejbserver.jta

(13) Parameters beginning with ejbserver.logger

(14) Parameters beginning with ejbserver.management

(15) Parameters beginning with ejbserver.manager

(16) Parameters beginning with ejbserver.naming

(17) Parameters beginning with ejbserver.rmi

(18) Parameters beginning with ejbserver.server

(19) Parameters beginning with ejbserver.stdoutlog

(20) Parameters beginning with ejbserver.watch

(21) Parameters beginning with java

(22) Parameters beginning with vbroker

(23) Parameters beginning with webserver.connector

(1) Parameters beginning with ejbserver.application

The following table describes the parameters beginning with ejbserver.application.

Table 4-61 Parameters beginning with ejbserver.application

Value of param-name | Default value
ejbserver.application.InitTermProcessClasses#1 | None
ejbserver.application.userlog.CJLogHandler.handler-name.appname | user_app
ejbserver.application.userlog.CJLogHandler.handler-name.count | 2
ejbserver.application.userlog.CJLogHandler.handler-name.encoding | None
ejbserver.application.userlog.CJLogHandler.handler-name.filter | None
ejbserver.application.userlog.CJLogHandler.handler-name.formatter | None
ejbserver.application.userlog.CJLogHandler.handler-name.level | SEVERE
ejbserver.application.userlog.CJLogHandler.handler-name.limit | 1048576​
ejbserver.application.userlog.CJLogHandler.handler-name.msgid | 0001
ejbserver.application.userlog.CJLogHandler.handler-name.path | user_log
ejbserver.application.userlog.CJLogHandler.handler-name.separator | |
ejbserver.application.userlog.Logger.logger-name.filter | None
ejbserver.application.userlog.Logger.logger-name.handlers#1 | None
ejbserver.application.userlog.Logger.logger-name.level | SEVERE
ejbserver.application.userlog.Logger.logger-name.useParentHandlers | true
ejbserver.application.userlog.loggers#1 | None
ejbserver.application.userlog.menu.handlers.#1#2 | None

#1

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

#2

The list of handler names is specified in this parameter.

When you delete the handler name from this parameter, also delete the related parameter (ejbserver.application.userlog.CJLogHandler.handler-name-to-be-deleted.XXX).

Note that the key corresponding to this parameter in not included in 3.3 usrconf.properties (User property file for batch servers).

(2) Parameters beginning with ejbserver.batch

The following table describes the parameters beginning with ejbserver.batch:

Table 4-62 Parameters beginning with ejbserver.batch

Value of param-name | Default value
ejbserver.batch.application.exit.enabled | true
ejbserver.batch.gc.watch.threshold | 0
ejbserver.batch.queue.length | 50
ejbserver.batch.schedule.group.name | JOBGROUP

(3) Parameters beginning with ejbserver.client

The following table describes the parameters beginning with ejbserver.client.

Table 4-63 Parameters beginning with ejbserver.client

Value of param-name | Default value
ejbserver.client.ctm.RequestPriority | 4

(4) Parameters beginning with ejbserver.connectionpool

The following table describes the parameters beginning with ejbserver.connectionpool.

Table 4-64 Parameters beginning with ejbserver.connectionpool

Value of param-name | Default value
ejbserver.connectionpool.association.enabled | false
ejbserver.connectionpool.validation.timeout | 5

(5) Parameters beginning with ejbserver.connector

The following table describes the parameters beginning with ejbserver.connector.

Table 4-65 Parameters beginning with ejbserver.connector

Value of param-name | Default value
ejbserver.connector.logwriter.filenum | 4
ejbserver.connector.logwriter.filesize | 2097152​

(6) Parameters beginning with ejbserver.container

The following table describes the parameters beginning with ejbserver.connector.

Table 4-66 Parameters beginning with ejbserver.connector

Value of param-name | Default value
ejbserver.container.audit_trail.enabled | false

(7) Parameters beginning with ejbserver.deploy

The following table describes the parameters beginning with ejbserver.deploy.

Table 4-67 Parameters beginning with ejbserver.deploy

Value of param-name | Default value
ejbserver.deploy.resourcefile.scramble.enabled | false

(8) Parameters beginning with ejbserver.ext

The following table describes the parameters beginning with ejbserver.ext.

Table 4-68 Parameters beginning with ejbserver.ext

Value of param-name | Default value
ejbserver.ext.method_observation.interval | 0

(9) Parameters beginning with ejbserver.http

The following table describes the parameters beginning with ejbserver.http.

Table 4-69 Parameters beginning with ejbserver.http

Value of param-name | Default value
ejbserver.http.port | 8080

(10) Parameters beginning with ejbserver.instrumentation

The following table describes the parameters beginning with ejbserver.instrumentation.

Table 4-70 Parameters beginning with ejbserver.instrumentation

Value of param-name | Default value
ejbserver.instrumentation.enabled | true

(11) Parameters beginning with ejbserver.jndi

The following table describes the parameters beginning with ejbserver.jndi.

Table 4-71 Parameters beginning with ejbserver.jndi

Value of param-name | Default value
ejbserver.jndi.cache | on
ejbserver.jndi.cache.interval | 0
ejbserver.jndi.cache.interval.clear.option | refresh
ejbserver.jndi.namingservice.group.specify-group-name.providerurls | None
ejbserver.jndi.namingservice.group.list | None
ejbserver.jndi.request.timeout | 0

(12) Parameters beginning with ejbserver.jta

The following table describes the parameters beginning with ejbserver.jta.

Table 4-72 Parameters beginning with ejbserver.jta

Value of param-name | Default value
ejbserver.jta.TransactionManager.defaultTimeOut | 180

(13) Parameters beginning with ejbserver.logger

The following table describes the parameters beginning with ejbserver.logger.

Table 4-73 Parameters beginning with ejbserver.logger

Value of param-name | Default value
ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ConsoleLogFile.filenum | 2
ejbserver.logger.channels.define.ConsoleLogFile.filesize | 1048576​
ejbserver.logger.channels.define.EJBContainerLogFile.filenum | 2
ejbserver.logger.channels.define.EJBContainerLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ExceptionLogFile.filenum | 2
ejbserver.logger.channels.define.ExceptionLogFile.filesize | 1048576​
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filenum | 2
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.MaintenanceLogFile.filenum | 4
ejbserver.logger.channels.define.MaintenanceLogFile.filesize | 16777216​
ejbserver.logger.channels.define.MemoryWatchLogFile.filenum | 2
ejbserver.logger.channels.define.MemoryWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.MessageLogFile.filenum | 2
ejbserver.logger.channels.define.MessageLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ThreadWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ThreadWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.UserErrLogFile.filenum | 2
ejbserver.logger.channels.define.UserErrLogFile.filesize | 1048576​
ejbserver.logger.channels.define.UserOutLogFile.filenum | 2
ejbserver.logger.channels.define.UserOutLogFile.filesize | 1048576​
ejbserver.logger.enabled.* | Error, Warning

(14) Parameters beginning with ejbserver.management

The following table describes the parameters beginning with ejbserver.management.

Table 4-74 Parameters beginning with ejbserver.management

Value of param-name
Default value

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled
true

ejbserver.management.JVM.stats_monitor.FullGCCount.interval
600

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold
10

ejbserver.management.statistics.interval
60

ejbserver.management.stats_file.base_time
0

ejbserver.management.stats_file.dir
[In Windows]
Cosminexus-working-directory\ejb\server-name\stats
[In UNIX] Cosminexus-working-directory/ejb/server-name/stats

ejbserver.management.stats_file.enabled
true

ejbserver.management.stats_file.num
7

ejbserver.management.stats_file.period
24

(15) Parameters beginning with ejbserver.manager

The following table describes the parameters beginning with ejbserver.manager.

Table 4-75 Parameters beginning with ejbserver.manager

Value of param-name | Default value
ejbserver.manager.agent.JP1EventAgent.conf | None
ejbserver.manager.agent.JP1EventAgent.enabled | false
ejbserver.manager.agent.MEventAgent.conf | None
ejbserver.manager.agent.MEventAgent.enabled | true

(16) Parameters beginning with ejbserver.naming

The following table describes the parameters beginning with ejbserver.naming.

Table 4-76 Parameters beginning with ejbserver.naming

Value of param-name | Default value
ejbserver.naming.host | Same host as the batch server
ejbserver.naming.port | 900
ejbserver.naming.startupRetryCount | 9
ejbserver.naming.startupWaitTime | 1

(17) Parameters beginning with ejbserver.rmi

The following table describes the parameters beginning with ejbserver.rmi.

Table 4-77 Parameters beginning with ejbserver.rmi

Value of param-name | Default value
ejbserver.rmi.naming.host | None
ejbserver.rmi.naming.port | 23152
ejbserver.rmi.remote.listener.port | 0
ejbserver.rmi.request.timeout | 0

(18) Parameters beginning with ejbserver.server

The following table describes the parameters beginning with ejbserver.server.

Table 4-78 Parameters beginning with ejbserver.server

Value of param-name | Default value
ejbserver.server.prf.PRFID | None
ejbserver.server.threaddump.filenum | 256

(19) Parameters beginning with ejbserver.stdoutlog

The following table describes the parameters beginning with ejbserver.stdoutlog.

Table 4-79 Parameters beginning with ejbserver.stdoutlog

Value of param-name | Default value
ejbserver.stdoutlog.autoflush | false

(20) Parameters beginning with ejbserver.watch

The following table describes the parameters beginning with ejbserver.watch.

Table 4-80 Parameters beginning with ejbserver.watch

Value of param-name | Default value
ejbserver.watch.enabled | true
ejbserver.watch.fileDescriptor.enabled | true
ejbserver.watch.fileDescriptor.interval | 60
ejbserver.watch.fileDescriptor.threshold | 2147483647​
ejbserver.watch.fileDescriptor.writefile.enabled | true
ejbserver.watch.memory.enabled | true
ejbserver.watch.memory.interval | 60
ejbserver.watch.memory.threshold | 80
ejbserver.watch.memory.writefile.enabled | true
ejbserver.watch.thread.enabled | true
ejbserver.watch.thread.interval | 60
ejbserver.watch.thread.threshold | 2147483647​
ejbserver.watch.thread.writefile.enabled | true
ejbserver.watch.threaddump.enabled | true
ejbserver.watch.threaddump.interval | 30
ejbserver.watch.threaddump.threshold | 80
ejbserver.watch.threaddump.writefile.enabled | true

(21) Parameters beginning with java

The following table describes the parameters beginning with java.

Table 4-81 Parameters beginning with java

Value of param-name | Default value
java.naming.factory.initial | com.hitachi.software.ejb.jndi.InsContextFactory

(22) Parameters beginning with vbroker

The following table describes the parameters beginning with vbroker.

Table 4-82 Parameters beginning with vbroker

Value of param-name | Default value
vbroker.agent.port | 14000
vbroker.se.iiop_tp.host | None
vbroker.se.iiop_tp.scm.iiop_tp.listener.port | 0

(23) Parameters beginning with webserver.connector

The following table describes the parameters beginning with webserver.connector.

Table 4-83 Parameters beginning with webserver.connector

Value of param-name | Default value
webserver.connector.ajp13.bind_host | None
webserver.connector.ajp13.port | 8007
webserver.connector.http.bind_host | None
webserver.connector.http.permitted.hosts# | None

#

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

4.14.6 Parameters used for setting up the option definitions for the batch server

The following table describes the parameters used for setting up the option definitions for the batch server. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 3.2 usrconf.cfg (Option definition file for batch servers). In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-84 Parameters used for setting up the option definitions for the batch server

Value of param-name
Default value

add.jvm.arg#
None

ejb.public.directory
[In Windows]
&{cosminexus.home}\CC\server\public
[In UNIX]
&{cosminexus.home}/CC/server/public

ejb.server.log.directory
[In Windows]
Cosminexus-working-directory\ejb\server-name\logs
[In UNIX]
Cosminexus-working-directory/ejb/server-name/logs

#

The value specification format is as follows:

(Example)

<param-name>add.jvm.arg</param-name>

<param-value>-Xms256m</param-value>

<param-value>-Xmx512m</param-value>

:

4.14.7 Parameters applicable to the JavaVM system properties for the batch server

The following table describes the parameters applicable to the JavaVM system properties for the batch server. For the details about the values to be specified in 'Value of param-name', see 3.3 usrconf.properties (User property file for batch servers). In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-85 Parameters applicable to the JavaVM system properties for the batch server

Value of param-name
Default value

ejbserver.connectionpool.applicationAuthentication.disabled
false

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled
false

ejbserver.deploy.exclusive.lockAliveInterval
60

ejbserver.jndi.cache.reference
off

ejbserver.manager.agent.Agent.conf#1
Cosminexus-installation-directory/manager/config/mngagent.real-server-name.properties

ejbserver.manager.agent.Agent.enabled#¹
true

ejbserver.manager.jp1event.event_server_name
localhost

ejbserver.naming.nameroot
None

vbroker.agent.enableLocator#²
false

vbroker.orb.htc.comt.entryCount
120000

vbroker.orb.htc.comt.fileCount
3

vbroker.orb.htc.tracePath
[In Windows]
Cosminexus-working-directory\ejb\server-name\logs\TPB\logj
[In UNIX]
Cosminexus-working-directory/ejb/server-name/logs/TPB/logj

Note:

For specifying the multiple values in param-value, specify multiple <param-value>.

(Example)

<param-name>parameter-name</param-name>

<param-value>Value<param-value>

<param-value>Value<param-value>

#1

Settings are not recommended because the Management Server sets the value automatically.

#2

Settings are not required normally.

Reference note

The parameters described in this table can also be described in the following format:

Specification format

<param-name>parameter-name</param-name>

<param-value>Parameter-name=Value<param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

<param-value>Parameter-name=Value<param-value>

4.14.8 Extension parameters of the batch server

The following table describes the extension parameters of the batch server. Make sure to specify the batch.service.enabled parameter for the batch server. Specify true in the parameter value.

For the details about the values to be specified in 'Value of param-name', see 3.2 usrconf.cfg (Option definition file for batch servers). In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-86 Batch server extension parameters

Value of param-name | Default value
add.class.path | None
add.library.path | None
batch.service.enabled#1 | false
cpp.library.version | 6
ejb.server.corefilenum#2 | 1
ejb.server.log.mode | None
ejb.server.log.stderr.filesize | 1048576​
ejb.server.log.stdout.filesize | 1048576​
jvm.type | server

Note:

For specifying the multiple values in param-value, specify multiple <param-value>.

(Example)

<param-name>parameter-name</param-name>

<param-value>Value<param-value>

<param-value>Value<param-value>

#1

Make sure to specify the batch.service.enabled parameter. Specify true in the settings. If the parameter is omitted, false is set. You can specify this parameter only during the initial setup of the Web system. Do not change the value when changing the Web system configuration.

#2

Parameter for UNIX.

Reference note

The parameters described in this table can also be specified in the following format:

Specification format

<param-name>parameter-name</param-name>

<param-value>Parameter-name=Value<param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

<param-value>Parameter-name=Value<param-value>

4.14.9 Parameters used for setting up the Management Agent properties

The following table describes the parameters used for setting up the Management Agent properties. You can specify these parameters in the J2EE server and the batch server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 10.6 mngagent.actual-server-name.properties (Management Agent property file). When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-87 Parameters used for setting up the Management Agent properties

Value of param-name
Specifiable value
Default value
VR

mngagent.connector.host
The values that can be specified are as follows:

Host name

IPv4 address

@myhost

Specify a string within 255 characters using alphanumeric characters, underscore (_), period (.), and hyphen (-) as a host name.
Value defined in vbroker.se.iiop_tp.host
07-50

mngagent.connector.port
Specify the value using an integer from 1 to 65535.
Value defined in vbroker.se.iiop_tp.scm.iiop_tp.listener.port
07-50

mngagent.log.filesize
Specify the value using an integer from 4096 to 2147483647​.
65536
06-50
07-00
07-50

4.14.10 Parameters used for setting up the properties for issuing Management events

The following table describes the parameters used for setting up the properties for issuing Management events. You can specify these parameters in the J2EE server and the batch server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 10.12 Property file for issuing Management events. When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-88 Parameters used for setting up the properties for issuing Management events

Value of param-name
Specifiable value
Default value
VR

manager.mevent.message_id.list
Specify any string.
None
06-50

manager.mevent.retry.interval
Specify the value using an integer from 1 to 86400.
10
06-50

manager.mevent.retry.limit
Specify the value using an integer from 0 to 86400.
0
06-50

manager.mevent.send.max
Specify the value using an integer from 1 to 1000.
10
06-50

manager.mevent.send.timeout
Specify the value using an integer from 10 to 600.
90
06-50

manager.mevent.sender.bind.host
Specify one of the following values:

Host name

IPv4 address

@myhost

Specify a string within 255 characters using alphanumeric characters, underscore (_), period (.), and hyphen (-) as a host name.
None
07-50

4.14.11 Parameters used for setting up JP1 integration

The following table describes the parameters used for setting up JP1 integration. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

You can specify these parameters in the J2EE server and the batch server.

Table 4-89 Parameters used for setting up JP1 integration

Value of param-name
Value of param-value
Specifiable value
Default value
VR

manager.jp1event.system.filtering.severity.alert
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Alert of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.critical
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Critical of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.emergency
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Emergency of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.error
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Error of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.information
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Information of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.notice
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Notice of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.system.filtering.severity.warning
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Warning of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.user.filtering.enabled
Specifies whether to filter a user JP1 event. Specify one of the following values:

true:

The user JP1 event will be filtered.

false:

The user JP1 event will not be filtered.

The following strings can be specified:

true

false

false
06-50

manager.jp1event.user.filtering.filter
\n in the specified string is converted into linefeed.
Specify any string.
None
06-50

manager.jp1event.user.mapping.level.config
Specifies the severity of the JP1 event for the log level "CONFIG" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.fine
Specifies the severity of the JP1 event for the log level "FINE" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.finer
Specifies the severity of the JP1 event for the log level "FINER" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.finest
Specifies the severity of the JP1 event for the log level "FINEST" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.info
Specifies the severity of the JP1 event for the log level "INFO" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.severe
Specifies the severity of the JP1 event for the log level "SEVERE" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

manager.jp1event.user.mapping.level.warning
Specifies the severity of the JP1 event for the log level "WARNING" in the mapping of the user JP1 events. Specify one of the following values:

Emergency: Emergency

Alert: Alert

Critical: Critical

Error: Error

Warning: Warning

Notice: Notice

Information: Information

If the value is not specified, a JP1 event is not issued.
The following strings can be specified:

Emergency

Alert

Critical

Error

Warning

Notice

Information

Not specified
06-50

4.14.12 Parameters used for setting up the usage of SecurityManager

The following table describes the parameters used for setting up the usage of SecurityManager. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

You can specify these parameters in the J2EE server and the batch server.

Table 4-90 Parameters used for setting up the SecurityManager usage

Value of param-name
Value of param-value
Specifiable value
Default value
VR

use.security
Specifies whether to use SecurityManager in the J2EE server startup options. Specify one of the following values:

true:

Use functionality.

false:

Do not use functionality.

The following strings can be specified:

true

false

true
06-50

4.14.13 Parameters that set up the usage for integrated user management

The following table describes the parameters used for setting up the usage for integrated user management. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Note that the parameters that set up the usage for integrated user management are only enabled when you specify true in the jaas.ua.enabled parameter.

Table 4-91 Parameters that set up the usage for integrated user management

Value of param-name
Value of param-value
Specifiable value
Default value
VR

jaas.ua.enabled
Specifies whether to enable JAAS of JavaVM. Enabling JAAS of JavaVM allows you to use applications that use intergrated user management.
Specify one of the following values:

true:

Enable.

false:

Disable.

The following strings can be specified:

true

false

true
08-70

java.security.auth.login.config
Specifies the JAAS configuration file. If specified using the relative path, the configuration file under the Cosminexus-installation-directory/manager/config directory is applied.
Specify any string.
(In Windows)
&amp;{cosminexus.home}\manager\config\jaas.conf
(In UNIX)
&amp;{cosminexus.home}/manager/config/jaas.conf
08-70

com.cosminexus.admin.auth.config
Specifies the configuration file for integrated user management.
If specified using the relative path, the configuration file under the Cosminexus-installation-directory/manager/config directory is applied.
Specify any string.
(In Windows)
&amp;{cosminexus.home}\manager\config\ua.conf
(In UNIX)
&amp;{cosminexus.home}/manager/config/ua.conf
08-70

com.cosminexus.admin.auth.passwordScramble.enable
Specifies whether to enable the functionality that decodes scrambled passwords in configuration files for integrated user management. Specify one of the following values:

true:

Enable.

false:

Disable.

The following strings can be specified:

true

false

false
08-70

jaas.config.load_exclusively#
Chooses whether to ignore the login configurations specified in files other than the files specified in the JAAS configuration file.
Specify one of the following values:

true:

The specified login configuration will be ignored and the configuration of the JAAS configuration file is enabled.

false:

The specified login configuration is enabled.

The following strings can be specified:

true

false

true
08-70

#

If true is specified in this parameter, \= is added as follows to the value of the java.security.auth.login.config parameter in the usrconf.properties file at the distribution destination:

(Example): java.security.auth.login.config=\=config-file

4.14.14 Parameters that set up the files to be used in the JavaVM startup parameters

The following table describes the parameters that set up the files to be used in the JavaVM startup parameters. In the table below, Default value means the value that is assumed when the parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-92 Parameters that set up the files to be used in the JavaVM startup parameters

Value of param-name | Value of param-value | Specifiable value | Default value | VR
AutoExplicitMemoryText | Specifies the contents of the auto-allocation setup file to be used in the auto-allocation functionality of the Explicit Memory Management functionality. The contents specified here are applied to Cosminexus-installation-directory/CC/server/usrconf/ejb/real-server-name/auto_explicit_memory.cfg.# | String of one or more characters | None | 09-00
UserPrfText | Specifies the contents of the user-extended performance analysis trace setup file to be used in user-extended performance analysis trace. The contents specified here are applied to Cosminexus-installation-directory/CC/server/usrconf/ejb/real-server-name/userprf.cfg.# | String of one or more characters | None | 09-00

#

Specify the param-value value in the CDATA section.

(Example)

<param-name>UserPrfText</param-name>

<param-value>

<![CDATA[

:

]]>

</param-value>

The single-byte spaces and linefeeds before and after all the contents specified in the CDATA section are ignored.

4.15 Parameters applicable to logical performance tracers

This subsection describes the parameters that are applicable to logical performance tracers.

The following table describes the parameters that are applicable to logical performance tracers. In the following table, Default value is the value that is assumed when a parameter is not specified. VR is the version of Application Server on which parameters are introduced or changed.

Table 4-93 Parameters applicable to logical performance tracers

Value of param-name
Value of param-value
Specifiable value
Default value
VR

PRFID
Specify the PRF identifier.
If a string beginning with 'TSC', 'tsc' or 'CTM' and 'ctm' is specified, an error will occur.
PRF_ID
06-50
07-00

prfspool
Specifies the PRF trace output directory.
In Windows, the value specified here must match with the value specified in the system environment variable PRFSPOOL.
Specify any string with a maximum of 256 characters.
&amp;{cosminexus.home}/PRF/spool
06-50
07-00

PrfTraceBufferSize
Specifies the size of the buffer memory for the performance tracer.
Specify a value that satisfies the condition PrfTraceFileSize PrfTraceBufferSize.
Specify the value using an integer from 512 to 102400.
8192
06-50

PrfTraceCount
Specifies the number of files for the performance tracer.
Specify 4, 16, 32, 64, 128, or 256.
4
06-50

PrfTraceFileSize
Specifies the file size for the performance tracer in Kilobytes.
Specify a value that satisfies the condition PrfTraceFileSize PrfTraceBufferSize.
The following strings can be specified:

1024

4096

8192

16384

32768

65536

131072

262144

524288

1048576​

32768
06-50
07-00

PrfTraceLevel
Specifies the trace collection level for the performance tracer. Set up one of the following values:

STANDARD:
Standard level

DETAIL:
Detail level

Optional trace collection level value:
For details about specifiable values, see the description for the argument -PrfTraceLevel of the cprfstart (PRF daemon startup) command in the uCosminexus Application Server Command Reference Guide.

The following strings can be specified:

STANDARD

DETAIL

Any trace level value

STANDARD
06-50
07-00

4.16 Parameters applicable to logical SFO servers

This subsection describes the parameters that are applicable to logical SFO servers.

Organization of this section

4.16.1 Parameters used for setting up the user properties for the SFO server

4.16.2 Parameters used for setting up the option definitions for the SFO server

4.16.3 Parameters applicable to the JavaVM system properties for the SFO server

4.16.4 Extension parameters of SFO server

4.16.5 Parameters used for setting up the Management Agent properties

4.16.6 Parameters used for setting up the properties for issuing Management events

4.16.7 Parameters used for setting up JP1 integration

4.16.1 Parameters used for setting up the user properties for the SFO server

This section describes the parameters used for setting up the user properties for the SFO server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.4 usrconf.properties (User property file for J2EE servers). When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified.

Note that the specification method of parameters for which "Value in param-name" is specified is different from usrconf.properties (user property file for J2EE servers).

Organization of this subsection

(1) Parameters beginning with ejbserver.container

(2) Parameters beginning with ejbserver.http

(3) Parameters beginning with ejbserver.instrumentation

(4) Parameters beginning with ejbserver.logger

(5) Parameters beginning with ejbserver.management

(6) Parameters beginning with ejbserver.manager

(7) Parameters beginning with ejbserver.naming

(8) Parameters beginning with ejbserver.rmi

(9) Parameters beginning with ejbserver.server

(10) Parameters beginning with ejbserver.watch

(11) Parameters beginning with vbroker

(12) Parameters beginning with webserver.connector

(1) Parameters beginning with ejbserver.container

The following table describes the parameters beginning with ejbserver.container.

Table 4-94 Parameters beginning with ejbserver.container

Value of param-name | Default value
ejbserver.container.remove.scan.interval | 5

(2) Parameters beginning with ejbserver.http

The following table describes the parameters beginning with ejbserver.http.

Table 4-95 Parameters beginning with ejbserver.http

Value of param-name | Default value
ejbserver.http.port | 8080

(3) Parameters beginning with ejbserver.instrumentation

The following table describes the parameters beginning with ejbserver.instrumentation.

Table 4-96 Parameters beginning with ejbserver.instrumentation

Value of param-name | Default value
ejbserver.instrumentation.enabled | true

(4) Parameters beginning with ejbserver.logger

The following table describes the parameters beginning with ejbserver.logger.

Table 4-97 Parameters beginning with ejbserver.logger

Value of param-name | Default value
ejbserver.logger.channels.define.ConsoleLogFile.filenum | 2
ejbserver.logger.channels.define.ConsoleLogFile.filesize | 1048576​
ejbserver.logger.channels.define.EJBContainerLogFile.filenum | 2
ejbserver.logger.channels.define.EJBContainerLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ExceptionLogFile.filenum | 2
ejbserver.logger.channels.define.ExceptionLogFile.filesize | 1048576​
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filenum | 2
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.MaintenanceLogFile.filenum | 4
ejbserver.logger.channels.define.MaintenanceLogFile.filesize | 16777216​
ejbserver.logger.channels.define.MemoryWatchLogFile.filenum | 2
ejbserver.logger.channels.define.MemoryWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.MessageLogFile.filenum | 2
ejbserver.logger.channels.define.MessageLogFile.filesize | 1048576​
ejbserver.logger.channels.define.RequestQueueWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filesize | 1048576​
ejbserver.logger.channels.define.ThreadWatchLogFile.filenum | 2
ejbserver.logger.channels.define.ThreadWatchLogFile.filesize | 1048576​
ejbserver.logger.enabled.* | Error, Warning
ejbserver.logger.systemlog.enabled | true

(5) Parameters beginning with ejbserver.management

The following table describes the parameters beginning with ejbserver.management.

Table 4-98 Parameters beginning with ejbserver.management

Value of param-name
Default value

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled
true

ejbserver.management.JVM.stats_monitor.FullGCCount.interval
600

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold
10

ejbserver.management.statistics.interval
60

ejbserver.management.stats_file.base_time
0

ejbserver.management.stats_file.dir
[In Windows]
Cosminexus-working-directory\ejb\server-name\stats
[In UNIX]
Cosminexus-working-directory/ejb/server-name/stats

ejbserver.management.stats_file.enabled
true

ejbserver.management.stats_file.num
7

ejbserver.management.stats_file.period
24

(6) Parameters beginning with ejbserver.manager

The following table describes the parameters beginning with ejbserver.manager.

Table 4-99 Parameters beginning with ejbserver.manager

Value of param-name | Default value
ejbserver.manager.agent.JP1EventAgent.conf | Cosminexus-installation-directory/manager/config/manager.real-server-name.properties
ejbserver.manager.agent.JP1EventAgent.enabled | false
ejbserver.manager.agent.MEventAgent.conf | Cosminexus-installation-directory/manager/config/mevent.real-server-name.properties
ejbserver.manager.agent.MEventAgent.enabled | false

(7) Parameters beginning with ejbserver.naming

The following table describes the parameters beginning with ejbserver.naming.

Table 4-100 Parameters beginning with ejbserver.naming

Value of param-name | Default value
ejbserver.naming.port | 900

(8) Parameters beginning with ejbserver.rmi

The following table describes the parameters beginning with ejbserver.rmi.

Table 4-101 Parameters beginning with ejbserver.rmi

Value of param-name | Default value
ejbserver.rmi.naming.host | None
ejbserver.rmi.naming.port | 23152
ejbserver.rmi.remote.listener.port | 0

(9) Parameters beginning with ejbserver.server

The following table describes the parameters beginning with ejbserver.server.

Table 4-102 Parameters beginning with ejbserver.server

Value of param-name | Default value
ejbserver.server.prf.PRFID | PRF-identifier-of-PRF-used
ejbserver.server.threaddump.filenum | 256

(10) Parameters beginning with ejbserver.watch

The following table describes the parameters beginning with ejbserver.watch.

Table 4-103 Parameters beginning with ejbserver.watch

Value of param-name | Default value
ejbserver.watch.defaultRequestQueue.enabled | false
ejbserver.watch.defaultRequestQueue.interval | 30
ejbserver.watch.defaultRequestQueue.threshold | 80
ejbserver.watch.defaultRequestQueue.writefile.enabled | false
ejbserver.watch.enabled | true
ejbserver.watch.fileDescriptor.enabled | true
ejbserver.watch.fileDescriptor.interval | 60
ejbserver.watch.fileDescriptor.threshold | 2147483647​
ejbserver.watch.fileDescriptor.writefile.enabled | true
ejbserver.watch.memory.enabled | true
ejbserver.watch.memory.interval | 60
ejbserver.watch.memory.threshold | 80
ejbserver.watch.memory.writefile.enabled | true
ejbserver.watch.thread.enabled | true
ejbserver.watch.thread.interval | 60
ejbserver.watch.thread.threshold | 2147483647​
ejbserver.watch.thread.writefile.enabled | true
ejbserver.watch.threaddump.enabled | true
ejbserver.watch.threaddump.interval | 30
ejbserver.watch.threaddump.threshold | 80
ejbserver.watch.threaddump.writefile.enabled | true

(11) Parameters beginning with vbroker

The following table describes the parameters beginning with vbroker.

Table 4-104 Parameters beginning with vbroker

Value of param-name | Default value
vbroker.orb.htc.comt.entryCount | 120000
vbroker.se.iiop_tp.host | None
vbroker.se.iiop_tp.scm.iiop_tp.listener.port | 0

(12) Parameters beginning with webserver.connector

The following table describes the parameters beginning with webserver.connector.

Table 4-105 Parameters beginning with webserver.connector

Value of param-name | Default value
webserver.connector.ajp13.bind_host | None
webserver.connector.ajp13.max_threads | 1
webserver.connector.ajp13.port | 8007
webserver.connector.http.bind_host | None
webserver.connector.http.permitted.hosts# | None

#

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

4.16.2 Parameters used for setting up the option definitions for the SFO server

The following table describes the parameters used for setting up the option definitions for the SFO server. For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 2.3 usrconf.cfg (Option definition file for J2EE servers). In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-106 Parameters used for setting up the option definitions for the SFO server

Value of param-name | Default value
add.jvm.arg# | None

Note:

The value specification format is as follows:

(Example)

<param-name>add.jvm.arg</param-name>

<param-value>-Xms256m<param-value>

<param-value>-Xmx512m<param-value>

:

4.16.3 Parameters applicable to the JavaVM system properties for the SFO server

This section describes the parameters applicable to the JavaVM system properties for the SFO server.

The specification format for specifying the JavaVM system properties for the SFO server is as follows:

Specification format

<param-name>parameter-name</param-name>
<param-value>Value</param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>
<param-value>Value</param-value>

The following table describes the parameters applicable to the JavaVM system properties for the SFO server. For details about the values to be specified in 'Value of param-name', see 2.4 usrconf.properties (User property file for J2EE servers). In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-107 Parameters applicable to the JavaVM system properties for the SFO server

Value of param-name
Default value

ejbserver.ctm.enabled
false

ejbserver.manager.agent.Agent.conf#
Cosminexus-installation-directory/manager/config/mngagent.real-server-name.properties

ejbserver.manager.agent.Agent.enabled#
true

vbroker.orb.htc.comt.fileCount
3

vbroker.orb.htc.tracePath
[In Windows]
Cosminexus-working-directory\ejb\server-name\logs\TPB\logj
[In UNIX]
Cosminexus-working-directory/ejb/server-name/logs/TPB/logj

webserver.sfo.negotiation.ignore_serverId
false

#

Settings are not recommended because the Management Server sets the value automatically.

Reference note

The parameters described in this table can also be specified in the following format:

Specification format

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>ex.properties</param-name>

<param-value>Parameter-name=Value<param-value>

<param-value>Parameter-name=Value<param-value>

4.16.4 Extension parameters of SFO server

This section describes the parameters used for setting up the extension parameters of the SFO server.

The specification format for specifying the extension parameters of the SFO server is as follows:

Specification format

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>

For specifying the multiple values, specify multiple <param-value>.

Specification format when multiple values are specified

<param-name>Parameter-name</param-name>
<param-value>Value</param-value>
<param-value>Value</param-value>

4.16.5 Parameters used for setting up the Management Agent properties

The following table describes the parameters used for setting up the Management Agent properties.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 10.6 mngagent.actual-server-name.properties (Management Agent property file). When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-108 Parameters used for setting up the Management Agent properties

Value of param-name | Default value
mngagent.connector.host | Value defined in vbroker.se.iiop_tp.host
mngagent.connector.port | Value defined in vbroker.se.iiop_tp.scm.iiop_tp.listener.port

4.16.6 Parameters used for setting up the properties for issuing Management events

The following table describes the parameters used for setting up the properties for issuing Management events.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 10.12 Property file for issuing Management events. When you reference the section, read the key as parameter. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-109 Parameters used for setting up the properties for issuing Management events

Value of param-name | Default value
manager.mevent.message_id.list | None
manager.mevent.retry.interval | 10
manager.mevent.retry.limit | 0
manager.mevent.send.max | 10
manager.mevent.send.timeout | 90
manager.mevent.sender.bind.host | None

4.16.7 Parameters used for setting up JP1 integration

The following table describes the parameters used for setting up JP1 integration. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-110 Parameters used for setting up JP1 integration

Value of param-name
Value of param-value
Default value

manager.jp1event.system.filtering.severity.alert
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Alert of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.critical
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Critical of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.emergency
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Emergency of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.error
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Error of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.information
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Information of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.notice
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Notice of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

manager.jp1event.system.filtering.severity.warning
The item used for specifying the filtering of the JP1 events issued by the system.
Specifies whether to issue the severity level Warning of the JP1 event. Specify one of the following values:

true:

Permit issuance.

false:

Do not permit issuance.

false

4.17 Parameters applicable to the logical CTM domain manager

This section describes the parameters applicable to the logical CTM domain manager.

The following table describes the parameters applicable to the logical CTM domain manager. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-111 Parameters applicable to the logical CTM domain manager

Value of param-name
Value of param-value
Default value

cdm.agent.port
Specify the port number of Smart Agent.
This parameter can only be used for free-tier.
14000

cdm.AliveCheckCount
Specifies the monitoring interval coefficient for the operating state between CTM domain managers as an integer in the range from 2 to 255.
2

cdm.port
Specifies the port number used by the CTM domain manager to exchange the CTM domain configuration information as an integer in the range from 5001 to 65535.
20137

cdm.prf.PRFID
Specify the PRF identifier.
If you specify a PRF identifier when the PRF daemon is invoked, specify the same PRF identifier.
If the PRF identifier is omitted when invoking the PRF daemon, do not specify the PRF identifier. If the PRF identifier does not match, performance analysis trace cannot be acquired.
This parameter can only be used for free-tier.
None

cdm.SendHost#
Specifies the host IP address on which the CTM domain manager, which is present in different network segments and which becomes the distribution destination of the CTM domain configuration information, operates. The IP address specified at this time is the IP address specified in the <host-name> tag in the host definition.
Due to this specification, the CTM configuration information can be distributed among the CTM domains consisting of multiple network segments.
None

cdm.SendHostInterval
Specifies the interval for sending the CTM domain configuration information for the host specified in cdm.SendHost as an integer in the range from 0 to 65535 (unit: seconds).
If the interval is not specified, it indicates that the interval is the same as the broadcast interval. If 0 is specified indicates that the configuration information is not to be sent.
None

cdm.SendInterval
Specifies the interval at which the CTM domain manager broadcasts the CTM domain configuration information within the network segment as an integer in the range from 0 to 65535 (units: seconds). 0 indicates that the configuration information is not to be sent.
60

cdm.SubnetMask
Specifies the subnet mask of the network.
255.255.255.0

ctmdomname
Specifies the name of the CTM domain to which the CTM domain manager belongs, within 31 characters. You can specify alphanumeric characters and underscore (_). Do not specify a string other than "CTMDOMAIN", such as a string beginning with "CTM" or "ctm".
The name must be unique on the same host.
CTMDOMAIN

ctmspool
Specifies the CTM execution environment directory. Use "/" as the file separator.
&{cosminexus.home}/CTM/spool

#

To specify multiple values in param-value, delimit the values with commas (,).

(Example)

<param-value>value1, value2, value3</param-value>

4.18 Parameters applicable to the logical CTM

This section describes the parameters applicable to the logical CTM.

The following table describes the parameters applicable to the logical CTM. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-112 Parameters applicable to the logical CTM

Value of param-name
Value of param-value
Default value

ctm.Agent
Specifies whether to use the ORB gateway functionality of the CTM regulator. Specify one of the following values:
In the systems executing batch applications, make sure that you specify '1'.

1:

Use functionality.

0:

Do not use functionality.

0

ctm.cdm
Specify the CTM domain name of the CTM domain manager to be used. Specify the CTM domain name of the CTM domain manager from the same host.
CTMDOMAIN

ctm.CreatePolicy
Chooses the CTM node selection policy for the create request. Specify one of the following values:

normalDispatch:

Chooses the CTM daemon according to the load status in the schedule queue.

priorDispatch:

Chooses the CTM daemon that has received the create request on higher priority. However, if the schedule queue registered in that CTM daemon has a high load or is locked, it chooses another CTM daemon.

normalDispatch

ctm.DCSendTimeOut
Specifies the timeout value for forwarding requests of the communication between CTMs as an integer in the range from 0 to 2147483647​ (unit: seconds).
Indicates that 0 is not specified.
180

ctm.DispatchParallelCount
Specifies the maximum number of threads for distributing the request messages from the client to the J2EE server within CTM as an integer in the range from 0 to 32767.
255

ctm.DispatchPolicy
Chooses the policy for scheduling requests.

normalDispatch:

Schedules requests according to the load status in the schedule queue.

priorDispatch:

Schedules requests giving priority to the schedule queue registered in the CTM daemon that received the request. However, if the schedule queue registered in that CTM daemon has a high load or is locked, schedules the request to a schedule queue registered in another CTM daemon.

priorDispatch

ctm.EjbPort
Specifies the port number that the EJB client will use to find new CTM daemon connections as an integer in the range from 5001 to 65535. If this value is not specified, the OS automatically uses the assigned port number.
Automatically

ctm.LoadCheckInterval
Specifies the time interval for monitoring the load in the schedule queue as an integer in a range from 0 to 32767 (unit: seconds). 0 indicates that load status will not be monitored at fixed time intervals.
10

ctm.LogFileCount
Specifies the number of CTM log files.
The specifiable values are 2, 4, 8, 16, 24, and 32.
2

ctm.LogFileSize
Specifies the maximum size of one CTM log file as an integer in the range from 1 to 3 (unit: megabyte).
1

ctm.MaxRequestCount
Specifies the number of requests that can be concurrently registered in the CTM queue registered in CTM as an integer in the range from 1 to 32767.
50

ctm.ns.port
Specifies the port number of the naming service paired with CTM as an integer in the range from 1 to 65535.
20348

ctm.NsBindHost
Specifies whether to assign a specific IP address to the machine when multiple IP addresses are assigned to one machine. Specify one of the following values:

true:

Assign a specific IP address.

false:

Do not assign a specific IP address.

false

ctm.port
Specifies the port number to be used by CTM as an integer in the range from 5001 to 65535.
20138

ctm.QueueCount
Specifies the number of CTM queues that can be registered in CTM as an integer in the range from 1 to 32767.
128

ctm.QueueDeleteWait
Specifies the waiting time for reserving the CTM queue in which the abnormally terminated J2EE server was registered, and for awaiting the restart of the J2EE server as an integer in the range from 0 to 2147483647​ (unit: seconds).
0

ctm.QueueInterval
Specifies the time interval for requesting the processing rate of the system termination threshold value as an integer in the range from 1 to 32767 (unit: seconds).
None

ctm.QueueRate
Specifies the threshold value of the retention rate to migrating to the queue retention monitoring state as an integer in the range from 0 to 99 (unit: %).
None

ctm.QueueRegistCount
Specifies the number of J2EE applications that can share the same CTM queue as an integer in the range from 1 to 32767.
64

ctm.RegOption
Specifies the setup file for the CTM regulator with the absolute path of the CTM active host (string of maximum 256 characters).
None

ctm.RegStart
Specifies the number of processes of the CTM regulator to be started automatically when starting CTM as an integer in the range from 0 to 32767.
1

ctm.RequestCount
Specifies how many times should a timeout occur for the lock to be set up automatically as an integer in the range from 1 to 32767.
None

ctm.RequestInterval
Specifies the time interval for requesting the timeout occurrence frequency as an integer in the range from 1 to 32767 (unit: seconds).
None

ctm.ServerCacheSize
Specifies the size of the cache table for storing the configuration information about the CTM domain as an integer in the range from 1 to 32767 (unit: kilobyte).
1024

ctm.ServerConnectCount
Specifies the maximum number of J2EE servers connected to CTM as an integer in the range from 0 to 32767.
64

ctm.StatsFileCount
Specifies the number of generations of CTM operation statistics information.
The specifiable values are 3, 4, 16, 32, 64, 128, and 256.
3

ctm.StatsFileSize
Specifies the size of the CTM operation statistics information file in megabytes.
The specifiable values are 1, 2, 3, 4, 8, 16, 32, 64, 128, 256, 512, and 1024.
3

ctm.StatsInterval
Specifies the time interval to output the CTM operation statistics information in a file as an integer in the range from 1 to 1440 (unit: minutes).
1

ctm.StatsUse
Specifies whether to acquire the CTM operation statistics information. Specify one of the following values:

Y:

Collected.

N:

Not collected.

Y

ctm.SystemDown
Specifies whether to terminate the system. Specify one of the following values:

1:

Terminate.

0:

Do not terminate.

1

ctm.SystemDownRate
Specifies the threshold value for the processing rate to migrate to system termination as an integer in the range from 1 to 100 (unit: %)
None

ctm.TSCGwOption
Specifies the setup file for the OTM gateway with the absolute path of the CTM active host (string of maximum 256 characters).
None

ctm.TSCGwStart
Specifies the number of processes of OTM gateway to be started automatically when CTM is started as an integer in the range from 0 to 32767.
0 indicates that the OTM gateway is not to be started.
0

ctm.WatchQueue
Specifies whether to perform stationary monitoring of the queue. Specify one of the following values:

true:

Perform stationary monitoring of the queue.

false:

Do not perform stationary monitoring of the queue.

false

ctm.WatchRequest
Specifies whether to lock the queue when a timeout occurs while a request is being sent to the J2EE server. Specify one of the following values:

true:

Lock the queue.

false:

Do not lock the queue.

false

ctmid
Specifies the CTM identifier as a string of maximum 31 characters. You can use alphanumeric characters, underscore (_), and period (.). (Period (.) can only be specified in IP addresses). Do not specify strings beginning with "CTM" or "ctm".
When specifying this parameter, a unique value must be specified in all the logical CTM servers within the management domain.
If an IP address is specified, period (.) is replaced by underscore (_).
Value-specified-in-the-<agent-host>-tag-in-the- host-definition#_CTM-port-number

#

If the host name is specified in the <agent-host> tag, a value converted into the IP address is specified. If an IP address is specified in the <agent-host> tag, period (.) is replaced by underscore (_).

4.19 Parameters applicable to the logical Smart Agent

This section describes the parameters applicable to the logical Smart Agent.

The following table describes the parameters applicable to the logical Smart Agent. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-113 Parameters applicable to the logical Smart Agent

Value of param-name | Value of param-value | Default value
smartagent.port | Specifies the port number for monitoring the Smart Agent as an integer in the range from 5001 to 65535. | 14000

4.20 Parameters applicable to the logical user server

This section describes the parameters applicable to the logical user server.

For details about the contents to be specified in param-value corresponding to 'Value of param-name', see 10.21 Logical user server definition file. When you reference the section, read the element name as parameter.

The following table describes the parameters applicable to the logical user server. In the table below, Default value means the value that is assumed when the parameter is not specified.

Table 4-114 Parameters applicable to the logical user server

Value of param-name | Default value
forceStop.arg#¹ | None
getProcessID.arg#¹ | None
getProcessID.timeout#² | 180
group-id | None
isAlive.arg#¹ | None
isAlive.timeout#² | 180
start.arg#¹ | None
start-time-watch-interval | 1
stop.arg#¹ | None
type | direct
user-id | None
watch-interval#3 | Value (10 if the adminagent.userserver.watch.interval key is omitted) of the adminagent.userserver.watch.interval key of the Administration Agent property file.
working-dir | Cosminexus-installation-directory/manager/bin

#1

See the description related to the element name <arg> in 10.21 Logical user server definition file.

#2

See the description related to the element name <timeout> in 10.21 Logical user server definition file.

#3

The value specified in this parameter is valid when specified concurrently with the adminagent.userserver.watch.interval key of the Administration Agent property file.

4.21 Parameters applicable to the Logical Naming Service

This section describes the parameters applicable to the Logical Naming Service.

The following table describes the parameters applicable to the Logical Naming Service. In the following table, Default value means the value assumed when the parameter is omitted:

Table 4-115 Parameters applicable to the Logical Naming Service

Value of param-name
Value of param-value
Default value

ns.agenthost
Specifies whether to fix the Administration Agent host when fixing the host.

true:

Assign a specific IP address.

false:

Do not assign a specific IP address.

false

ns.agent.port
Specify the port number of Smart Agent.
14000

ns.bind.host
Specifies whether to assign to the specific IP address. Specify one of the following values:

true:

Assign a specific IP address.

false:

Do not assign a specific IP address.

false

port
Specifies the port number to be used when the naming service is running.
900

5. Files Used in Server Management Commands

This chapter explains the format, storage location, and functionality of files used in server management commands and the keys that you can specify in these files.

Organization of this chapter

5.1 List of files used in server management commands

5.2 usrconf (Option definition file for server management commands for UNIX)

5.3 usrconf.bat (Option definition file for server management commands for Windows)

5.4 usrconf.properties (System property file for server management commands)

5.1 List of files used in server management commands

The following table lists the files used in server management commands:

Table 5-1 List of files used in server management commands

File name
Classification
Overview
Reference

usrconf(in UNIX)
Option definition file for server management commands
This file specifies the invocation options of the JavaVM that executes the server management commands.
This file is for UNIX.
5.2

usrconf.bat(in Windows)
Option definition file for server management commands
This file specifies the invocation options of the JavaVM that executes the server management commands.
This file is for Windows.
5.3

usrconf.properties
System property file for server management commands
This file specifies the system properties of the JavaVM that executes the server management commands.
5.4

5.2 usrconf (Option definition file for server management commands for UNIX)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf)

(6) Examples of coding

(7) Precautions

(1) Format

This option definition file is in the shell script file format.

Specify the key as follows:

set key-name=value

(2) File storage location

/opt/Cosminexus/CC/admin/usrconf/

(3) Functionality

This file specifies the invocation options of the JavaVM that executes the server management commands. Note that this file is for UNIX.

(4) Specifiable keys

The following table describes the specifiable keys and the default values:

Key name
Contents
Default

USRCONF_JVM_ARGS
This key invokes JavaVM by using the specified option. You can specify the following JavaVM options:

-Xmssize

-Xmxsize

-Xsssize

-Xdebug

-XrunlibraryName

-Dejbserver.log.directory

-XX:PermSize

-XX:MaxPermSize

For details about default values, see 5.2(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf).

USRCONF_JVM_CLPATH
This key adds the set value to the class path. If you want to specify multiple values, demarcate them with a colon (:).
None

USRCONF_JVM_LIBPATH
This key adds the set value to the environment variable of library search path. If you want to specify multiple values, demarcate them with a colon (:).
None

(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf)

The following table describes JavaVM options that you can specify in USRCONF_JVM_ARGS:

Key name
Contents
Specifiable value
Default
VR

-Xms
This key sets the initial size for the Java heap.
The input is not limited.
None
06-00

-Xmx
This key sets the maximum size for the Java heap.
The input is not limited.
512m
Note
If the version of the Application Server is earlier than 08-00, a default value does not exist.
06-00

-Xss
This key sets the maximum size for one stack area.
The input is not limited.
None
06-00

-Xdebug
This key invokes JavaVM with the debugger in enable status.
The input is not limited.
None
06-00

-Xrun
This key loads the library.
The input is not limited.
None
06-00

-Dejbserver.log.directory
This key specifies the path of the directory where the log file is output. Use a forward slash (/) as the delimiter in the directory path.
The input is not limited.
None
06-00

-XX:PermSize
This key specifies the initial size of Permanent area.
The input is not limited.
None
08-00

-XX:MaxPermSize
This key specifies the maximum size for the Permanent area.
The input is not limited.
None
08-00

(6) Examples of coding

#!/bin/csh -f

set USRCONF_JVM_ARGS="-Xms64m -Xmx512m"
set USRCONF_JVM_CLPATH=/usr/home/lib/mylib.jar
set USRCONF_JVM_LIBPATH=/usr/home/bin

(7) Precautions

The CLASSPATH environment variable set by shell is disabled in the server management commands, but the other environment variables (such as PATH) are enabled.

Do not use the following characters in the value to be specified:
Double quotation mark ("), ampersand (&), stroke (|), less-than sign (<) and greater-than sign (>)

When you use Eclipse Plug-ins using Management Server for performing operations, the specification of this file is invalid. When you use Eclipse Plug-ins using Management Server for performing operations, specify the values in the option definition file for the Administration Agent (adminagentuser.cfg).

5.3 usrconf.bat (Option definition file for server management commands for Windows)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat)

(6) Examples of coding

(7) Precautions

(1) Format

This option definition file is in the batch file format of Win32.

Specify the key as follows:

set key-name=value

(2) File storage location

Cosminexus-installation-directory\CC\admin\usrconf\

(3) Functionality

This file specifies the invocation options of the JavaVM that executes the server management commands. Note that this file is for Windows.

(4) Specifiable keys

The following table describes the specifiable keys and the default values:

Key name
Contents
Default

USRCONF_JVM_ARGS
This key invokes JavaVM by using the specified option. You can specify the following JavaVM options:

-Xmssize

-Xmxsize

-Xsssize

-Xdebug

-XrunlibraryName

-Dejbserver.log.directory

-XX:PermSize

-XX:MaxPermSize

For details about default values, see (5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat).

USRCONF_JVM_CLASSPATH
This key adds the set value to the class path. If you want to specify multiple values, demarcate the values with a semicolon (;).
None

USRCONF_JVM_LIBPATH
This key adds the set value to the environment variable of library search path. If you want to specify multiple values, demarcate the values with a semicolon (;).
None

(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat)

The following table describes JavaVM options that you can specify in USRCONF_JVM_ARGS:

Key name
Contents
Specifiable value
Default
VR

-Xms
This key sets the initial size for the Java heap.
The input is not limited.
None
06-00

-Xmx
This key sets the maximum size for the Java heap.
The input is not limited.
512m
Note
If the version of the Application Server is earlier than 08-00, a default value does not exist.
06-00

-Xss
This key sets the maximum size for one stack area.
The input is not limited.
None
06-00

-Xdebug
This key invokes JavaVM with the debugger in enable status.
The input is not limited.
None
06-00

-Xrun
This key loads the library.
The input is not limited.
None
06-00

-Dejbserver.log.directory
This key specifies the path of the directory where the log file is output. Use a forward slash (/) as the delimiter in the directory path.
The input is not limited.
None
06-00

-XX:PermSize
This key specifies the initial size for the Permanent area.
The input is not limited.
None
08-00

-XX:MaxPermSize
This key specifies the maximum size for the Permanent area.
The input is not limited.
None
08-00

(6) Examples of coding

set USRCONF_JVM_ARGS=-Xms64m -Xmx512m
set USRCONF_JVM_CLASSPATH=C:\home\lib\mylib.jar
set USRCONF_JVM_LIBPATH=C:\home\bin

(7) Precautions

The CLASSPATH environment variable set at the command prompt is disabled in the server management commands, but the other environment variables (such as PATH) are enabled.

Do not use the following characters in the specified value:
Double quotation mark ("), ampersand (&), stroke (|), less-than sign (<) and greater-than sign (>)

When you use Eclipse Plug-ins using Management Server for performing operations, the specification of this file is invalid. When you use Eclipse Plug-ins using Management Server for performing operations, specify the values in the option definition file for the Administration Agent (adminagentuser.cfg).

5.4 usrconf.properties (System property file for server management commands)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Reserved keys of server management commands

(5) Keys for customization of server management commands

(6) Examples of coding

(1) Format

J2SE property file format.

Specify the key as follows:

key-name=value

Specification methods

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\admin\usrconf\

In UNIX
/opt/Cosminexus/CC/admin/usrconf/

(3) Functionality

This file specifies the system properties of the JavaVM that executes the server management commands.

(4) Reserved keys of server management commands

The server management commands internally use the keys beginning with the following prefixes. As a result, the keys beginning with these prefixes must not be used in applications.

ejbserver.*

webserver.*

appclient.*

j2eeserver.*

(5) Keys for customization of server management commands

In the server management commands, you can customize the operations of a J2EE server by setting a value in the keys of the following system properties:

The keys are classified and explained as follows:

Keys beginning with ejbserver.cui

Keys beginning with ejbserver.deploy

Key beginning with ejbserver.logger

Keys beginning with ejbserver.naming

Key beginning with ejbserver.rmi

Keys beginning with vbroker

(a) Keys beginning with ejbserver.cui

Key name
Contents
Specifiable value
Default
VR

ejbserver.cui.checkmethod.compatible
Specify how to check the methods in the property file specified in the arguments while executing the cjsetappprop command or cjsetresprop command. The methods specified in the following tags of the property file are the arguments of the check method:

<method-permission>

<container-transaction>

<exclude-list>

<ejb-method-observation-timeout>

<ejb-transaction-timeout>#

Specify one of the following values:

true

false

For a new installation: false

For an upgrade from version prior to 07-50: true

07-50

ejbserver.cui.exitcode.compatible
Specify whether to return the exit code "1", when execution is no longer possible due to an exclusive error during the execution of a server management command.

If you specify true:

In the case of an exclusive error, completion code "1" will be returned.

If you specify false:

In the case of an exclusive error, completion code "2" will be returned.

In the case of a timeout error, completion code "3" will be returned.

Specify one of the following values:

true

false

In case of new installation: false

For an upgrade from a version earlier than the version 06-00: true

06-00

ejbserver.cui.logfile.compatible
Specify whether to adopt the log output form of version 07-00 and later or the log output form of version 06-70 and earlier. The specifiable values and the operation are as follows:

If you specify false:

The log output form of version 07-00 and later will be adopted.

If you specify true:

The log output form of version 06-70 and earlier will be adopted.

If you specify an invalid value (other than all characters of true or false in lower-case), a message is output and the default value will be set.
If operations are performed by Eclipse Plug-in using Management Server, this specification becomes invalid and the value is assumed as false.
Note that you can calculate the disk space required for the log output directory of the server management commands using the following expression:

If false is specified:

18,624 KB + TPBroker trace information

If true is specified:

51,655 KB + TPBroker trace information

For details on the disk space required to output the TPBroker trace information, see the description related to disk occupancy in TPBroker Operation Guide.
Specify one of the following values:

true

false

false
07-00

ejbserver.cui.optionalname.enabled
Specify when an optional name is specified in the EJBHome object from the server management command, when using the JNDI functionality for managing the user-specified namespace.

If you specify true:

You can specify an optional name from the server management command.

If you specify false:

You cannot specify an optional name from the server management command.

Specify one of the following values:

true

false

true
05-05

# The following contents are checked according to the values set with these keys.

Table 5-2 List of contents checked according to the settings for the keys

Location where the methods are specified in the property file | Values specified for the properties
true | false
<method-permission> | Y | Y
<container-transaction> | N | Y
<exclude-list> | Y | Y
<ejb-method-observation-timeout> | N | Y
<ejb-transaction-timeout> | N | Y

Legend:

Y: Error occurs if the specified method does not exist in the Enterprise Bean.

N: The check to learn whether the specified method exists in the Enterprise Bean is not implemented.

(b) Key beginning with ejbserver.deploy

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Contents
Specifiable value
Default
VR
Related information

ejbserver.deploy.annotations.load_check.enabled
Specify whether to ignore an exception that occurs when the class is loaded for acquiring the annotation information.

If you specify true:

An error will occur and the processing will be interrupted.

If you specify false:

The exception log will be acquired and the processing will continue.

The strings that you can specify are as follows:

true

false

false
08-00
12.3 Classes to be loaded and the class path required for loading the classes in the Common Container Functionality Guide

(c) Key beginning with ejbserver.logger

Key name
Contents
Specifiable value
Default
VR

ejbserver.logger.enabled.*
Specify the log level output by a server management command. If you specify only one log level, only the log of the applicable log level is output. When specifying multiple log levels, demarcate each level-name string with a comma (,). Specify either one or more from among Error, Warning, Information and Debug. Normally, use the default value.
Specify the following strings using a comma (,) as a delimiter:

Error

Warning

Information

Debug

Error, Warning
06-00

(d) Keys beginning with ejbserver.naming

Key name
Contents
Specifiable value
Default
VR

ejbserver.naming.host
Specify the host name or the IP address that the CORBA Naming Service invokes during the execution of a server management command.
When using the name switching functionality, do not use "localhost" as the host name. Specify the host name or the IP address that the CORBA Naming Service invokes.
If the CORBA Naming Service is used in the automatic invocation mode (ejbserver.naming.startupMode=automatic or inprocess), specify either the default value ("localhost"), or the host name or IP address that starts the J2EE server.
Specify one of the following values:

IPv4 address

Host name (String within 255 characters specified using single byte alphanumeric characters or symbols (_.-))

@myhost

localhost
06-00

ejbserver.naming.port
While executing the server management command, specify the port number of the CORBA Naming Service used as the Naming Service by the J2EE server.
Specify the value using an integer from 1 to 65535.
900
06-00

ejbserver.naming.protocol
Specify the protocol for accessing the CORBA Naming Service during the execution of the server management commands. Currently, only corbaname is supported. You can, however, perform operations even with the protocols (iioploc or iiopname) that were in use in the older versions.
The input is not limited.
corbaname
06-00

(e) Key beginning with ejbserver.rmi

Key name
Contents
Specifiable value
Default
VR

ejbserver.rmi.request.timeout
Specify an integer from 0 to 86400 for the communication timeout period (units: seconds) when a server management command could not return a response due to a communication failure.
If you specify 0, the timeout does not occur. If you specify a value that exceeds 86400, a warning message is output and the default value is applied.
Note that using the following commands, when the application does not terminate within the time period specified in the -t option, this key becomes the timeout value for the period until the forced termination processing is completed:

cjstopapp

cjreplaceapp

cjreloadapp

Specify the value using an integer from 0 to 86400.
180 (seconds)
06-00

(f) Keys beginning with vbroker

Key name
Contents
Specifiable value
Default
VR

vbroker.agent.port
Specify the port number of Smart Agent that is used during execution of a server management command. For details, see the manual Borland(R) Enterprise Server VisiBroker(R) Programmers Reference.
The input is not limited.
14000
06-00

vbroker.orb.htc.tracePath
Specify a range of 1 to 210 bytes for the path of the output destination of Cosminexus TPBroker trace files. You need to create comtrc and mdltrc as the subdirectories of the specified path beforehand. In the case of default output destination, the subdirectories comtrc and mdltrc are automatically created when the server is started for the first time. Use a forward slash (/) as the delimiter in the directory path.
For example, if C:\temp\work is set as the working directory, specify as follows:

(Example of specification)

vbroker.orb.htc.tracePath=c:/temp/work

The input is not limited.
Cosminexus-installation-directory\CC\admin\logs\TPB\logj
or
/opt/Cosminexus/CC/admin/logs/TPB/logj
06-00

vbroker.se.iiop_tp.scm.iiop_tp.listener.port
You can specify any value to fix the port that receives messages from the J2EE server. Make sure that the port number is not repeated in other programs. The same key name exists in the user property file for J2EE servers. Make sure that the port number is not repeated.
If this property is not set, Cosminexus TPBroker sets a random value.
The input is not limited.
0
06-50

(6) Examples of coding

ejbserver.naming.host=localhost
ejbserver.naming.port=900

6. Files Used with JPA

This chapter describes the formats, storage locations, and functionality of files used in Cosminexus JPA Provider and the keys specifiable in these files.

Organization of this chapter

6.1 List of files used in Cosminexus JPA Provider

6.2 persistence.xml

6.3 O/R mapping files

6.4 Query hint

6.1 List of files used in Cosminexus JPA Provider

The following table lists and describes the files used in Cosminexus JPA Provider:

Table 6-1 List of files used in Cosminexus JPA Provider

File name | Overview | Reference
persistence.xml | This file is used for setting the persistence unit information of Cosminexus JPA. | 6.2
O/R mapping files | This file is used for setting the O/R mapping information. | 6.3

6.2 persistence.xml

The following table describes the configuration of persistence.xml:

Tag name
Occurrence pattern
Description

<persistence>
Once
Indicates the root tag.

<persistence-unit>
0 or more times
Defines the persistence unit.

<description>
0 or once
Describes the persistence unit.

<provider>
0 or once
Specifies the implementation class name of javax.persistence.spi.PersistenceProvider.

<jta-data-source>
0 or once
Specifies the references for the data source corresponding to the JTA transaction.

<non-jta-data-source>
0 or once
Specifies the references for the data source not corresponding to the JTA transaction.

<mapping-file>
0 or more times
Specifies the O/R mapping file.

<jar-file>
0 or more times
Codes a JAR file name containing the entity class, embeddable class, and mappedsuper class.

<class>
0 or more times
Codes the entity class, embeddable class, and mappedsuper class.

<exclude-unlisted-classes>
0 or once
Specifies the Persistence class.

<properties>
0 or once
Defines the Cosminexus JPA Provider-specific properties.

<property>
0 or more times
Defines various properties.

For details about the respective tags, see 6.2.1 Details of persistence.xml.

Organization of this section

6.2.1 Details of persistence.xml

6.2.2 Cosminexus JPA Provider-specific properties that can be specified in the <property> tag

6.2.1 Details of persistence.xml

Organization of this subsection

(1) <persistence>

(2) <persistence-unit>

(3) <description>

(4) <provider>

(5) <jta-data-source>

(6) <non-jta-data-source>

(7) <mapping-file>

(8) <jar-file>

(9) <class>

(10) <exclude-unlisted-classes>

(11) <properties>

(12) <property>

(1) <persistence>

The <persistence> tag is the root tag indicating the start of definition for the persistence unit.

You must set the xmlns element that specifies the XML namespace in the <persistence> tag.

The following table lists the specifiable attributes:

Table 6-2 Attributes of <persistence>

Attribute name | Type | Optional/Required | Description
version | persistence:versionType | Required | Specifies the XML schema version "1.0".

(2) <persistence-unit>

The <persistence-unit> tag defines the persistence unit. The following table lists the specifiable attributes:

Table 6-3 Attributes of <persistence-unit>

Attribute name
Type
Optional/Required
Description

name
xsd:string
Required
Specifies the name of the persistence unit.
The name that will be specified in the name attribute must be unique in the persistence unit packaging range.
If a persistence unit is defined with duplicate names, the operations of Cosminexus JPA Provider cannot be guaranteed.
If persistence units with the same names are defined in the Java EE environment, a warning message is output by the container.
In the Java EE environment, the value specified in the name attribute should not be a null character. If a null character is specified, an exception occurs in the container.

transaction-type
persistence:persistence-unit-transaction-type
Optional
Specifies the transaction that will be used by the EntityManager.

JTA

The JTA transaction will be used.

RESOURCE_LOCAL

The transaction will be managed uniquely without using the JTA transaction.

If the value of the transaction-type attribute is not specified, the default value 'JTA' will be applied.
For details on attributes that can be specified in the Java EE environment, see 5.8.1 Attributes specified in the <persistence-unit> tag in the manual uCosminexus Application Server Common Container Functionality Guide.

(3) <description>

Describes the persistence unit.

(4) <provider>

Specifies the implementation class name of javax.persistence.spi.PersistenceProvider.

When using Cosminexus JPA Provider, you specify com.hitachi.software.jpa.PersistenceProvider. You code this tag for explicit specification such as when other JPA providers exist. Note that when the value is not specified, the tag behavior depends on the container.

Precautions

If you insert a space in the middle of the <provider> tag, the processing is same as the case when the element is not specified.

(5) <jta-data-source>

Specifies the references for the data source corresponding to the JTA transaction.

Specify this tag when the value specified for transaction-type in the <persistence-unit> tag is JTA. Note that when the value is not specified, the tag behavior depends on the container.

(6) <non-jta-data-source>

Specifies the references for the data source not corresponding to the JTA transaction. Specify this tag when the value specified for transaction-type in the <persistence-unit> tag is RESOURCE_LOCAL.

If a value specified for transaction-type is JTA, the value is ignored in Cosminexus JPA Provider even if that value is specified for the <non-jta-data-source> tag,. When the value is not specified, the tag behavior depends on the container.

(7) <mapping-file>

Specifies the O/R mapping file.

You must store the specified file at the location specified in the class path. The <mapping-file> tag need not be coded when the O/R mapping file is not used or when orm.xml is deployed at a defined location and used.

If the specified file is not found, the application will fail to start.

(8) <jar-file>

The <jar-file> tag codes a JAR file name that includes the entity class, embeddable class, and mappedsuper class. Specify the JAR file path using the relative path from the root of the persistence unit.

If the specified file is not found, the tag behavior depends on the container.

(9) <class>

Codes the entity class, embeddable class, and mappedsuper class.

If the specified class is not found, the tag behavior depends on the container.

Note that Cosminexus JPA Provider does not implement the check to verify whether the value specified in the <class> tag is the entity class, embeddable class, and mappedsuper class. Therefore, if you specify a class other than the entity class, embeddable class, and mappedsuper class, the operation is performed without throwing an exception.

(10) <exclude-unlisted-classes>

The <exclude-unlisted-classes> tag defines the Persistence class.

The specifiable values and the behavior when the values are specified are as follows:

true

Only the classes explicitly specified by the class element, the jar-file element, and the mapping-file element are handled as the Persistence classes.

false

If the exclude-unlisted-class element is not specified, the class files under the persistence unit root will be searched to find out if the class is a JPA target class.

(11) <properties>

Defines the Cosminexus JPA Provider-specific properties. You specify the property element under this element to define the property.

(12) <property>

Defines various properties.

For details about the properties, see 6.2.2 Cosminexus JPA Provider-specific properties that can be specified in the <property> tag.

The following table lists the specifiable attributes:

Table 6-4 Attributes of <property>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property name.
value | xsd:string | Required | Property value.

6.2.2 Cosminexus JPA Provider-specific properties that can be specified in the <property> tag

This subsection describes the Cosminexus JPA Provider-specific properties specified in the <property> tag of persistence.xml.

Cosminexus JPA Provider does not have properties that can be specified as arguments for createEntityManager() of EntityManagerFactory. Note that even if the attribute values of the persistence.xml file properties are numeric, you make sure that the value is enclosed in quotation marks (double quotations or single quotations).

Note

In Cosminexus JPA Provider, you cannot specify a property beginning with javax included in JPA specifications, within the <property> tag. The operations might not execute normally if a property beginning with javax included in JPA specifications is specified in the <property> tag of persistence.xml.

Also, you do not specify a property beginning with javax included in JPA specifications as a system property. The properties beginning with javax included in JPA specifications are as follows:

javax.persistence.transactionType

javax.persistence.jtaDataSource

javax.persistence.nonJtaDataSource

javax.persistence.provider

The following is the description related to the Cosminexus JPA Provider-specific properties:

You specify these properties in the <property> tag of the persistence.xml file.

If a value outside the specifiable range is set for a property, an exception occurs during the deployment. Also, the value is case sensitive.

The following table describes the Cosminexus JPA Provider-specific properties:

Table 6-5 Cosminexus JPA Provider-specific properties

Property name
Contents
Specifiable value
Default

cosminexus.jpa.cache.size.<ENTITY>
Specify the initial size to be set for the entity cache specified in <ENTITY>.
If a cache type is Full, set the initial size for the entity cache.
If a cache type is HardWeak or SoftWeak, set the maximum size for the entity cache.
Specify the cache size using the maximum ID count (record count) of the entities invoked in all as a standard.
0 to 2147483647​
1000

cosminexus.jpa.cache.size.default
Specify the default cache size used when the entity is cached.
If a cache type is Full, set the initial size for the entity cache.
If a cache type is HardWeak or SoftWeak, set the maximum size for the entity cache.
Specify the cache size using the maximum ID count (record count) of the entities invoked in all as a standard.
0 to 2147483647​
1000

cosminexus.jpa.cache.type.<ENTITY>
Specify the entity cache type specified in <ENTITY>.
You can specify the following strings:

Full

Weak

HardWeak

SoftWeak

NONE

SoftWeak

cosminexus.jpa.cache.type.default
Specify the default cache type.
You can specify the following strings:

Full

Weak

HardWeak

SoftWeak

NONE

SoftWeak

cosminexus.jpa.target-database
Specify the name of a database you want to connect to. To classify the database-specific processing, the class implementing the database-specific part is read according to the specified value. If Auto is specified, the database is automatically identified from the connection information.
Normally, Hitachi recommends you to specify the name of the database without using Auto.
The following strings can be specified:

Auto

HiRDB

Oracle

Auto

6.3 O/R mapping files

The following table describes the configuration of the O/R mapping files:

Tag name
Occurrence pattern
Description

<entity-mappings>
Once
Indicates the root tag.

<description>
0 or once
Adds the description.

<persistence-unit-metadata>
0 or once
Specifies the definition related to the entire PersistenceUnit.

<xml-mapping-metadata-complete>
0 or once
Specifies whether to control the mapping metadata of the persistence unit.

<persistence-unit-defaults>
0 or once
Specifies the default value of the persistence unit.

<schema>
0 or once
Defines the schema.

<catalog>
0 or once
Defines the catalog.

<access>
0 or once
Specifies the access type.

<cascade-persist>
0 or once
Adds the cascade persistence option.

<entity-listeners>
0 or once
Defines the default entity listener of the persistence unit.

<entity-listener>
0 or more times
Specifies the entity listener.

<pre-persist>
0 or once
Specifies the lifecycle callback method.

<post-persist>
0 or once
Specifies the lifecycle callback method.

<pre-remove>
0 or once
Specifies the lifecycle callback method.

<post-remove>
0 or once
Specifies the lifecycle callback method.

<pre-update>
0 or once
Specifies the lifecycle callback method.

<post-update>
0 or once
Specifies the lifecycle callback method.

<post-load>
0 or once
Specifies the lifecycle callback method.

<package>
0 or once
Specifies the class package described in the elements and attributes within the same mapping file.

<schema>
0 or once
Defines the schema.

<catalog>
0 or once
Defines the catalog.

<access>
0 or once
Defines the access method.

<sequence-generator>
0 or more times
Adds the sequence generator.

<table-generator>
0 or more times
Defines the table generator.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<named-query>
0 or more times
Defines a named query.

<query>
Once
Specifies the query string.

<hint>
0 or more times
Adds a hint to the query.

<named-native-query>
0 or more times
Defines the named native query.

<query>
Once
Specifies the query string.

<hint>
0 or more times
Adds a hint to the query.

<sql-result-set-mapping>
0 or more times
Defines the SQL result set mapping.

<entity-result>
0 or more times
Specifies the entity class used for mapping the native SQL query result.

<field-result>
0 or more times
Specifies the field used for mapping the native SQL query result.

<column-result>
0 or more times
Specifies the column used for mapping the native SQL query result.

<mapped-superclass>
0 or more times
Defines the mapped superclass of the persistence unit.

<description>
0 or once
Adds the description for the mapped superclass of the persistence unit.

<id-class>
0 or once
Overwrites @IdClass specified in the mapped superclass.

<exclude-default-listeners>
0 or once
Defines whether to control the default entity listener of the mapped superclass and the sub class.

<exclude-superclass-listeners>
0 or once
Defines whether to control the superclass listener of the mapped superclass and the sub class.

<entity-listeners>
0 or once
Specifies the callback listener class.

<entity-listener>
0 or more times
Specifies the entity listener.

<pre-persist>
0 or once
Specifies the lifecycle callback method.

<post-persist>
0 or once

<pre-remove>
0 or once

<post-remove>
0 or once

<pre-update>
0 or once

<post-update>
0 or once

<post-load>
0 or once

<pre-persist>
0 or once
Defines the lifecycle callback method using the corresponding annotations in the mapped superclass.

<post-persist>
0 or once

<pre-remove>
0 or once

<post-remove>
0 or once

<pre-update>
0 or once

<post-update>
0 or once

<post-load>
0 or once

<attributes>
0 or once
The element is not defined.

<id>
0 or more times#1
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<generated-value>
0 or once
Specifies the strategy for generating the primary key value.

<temporal>
0 or once
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<table-generator>
0 or once
Adds the table generator.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<sequence-generator>
0 or once
Adds the sequence generator.

<embedded-id>
0 or once#1
Overwrites the mapping specified in fields and properties.

<attribute-override>
0 or more times
Overwrites the mapping of properties and fields.

<column>
Once
Specifies the column mapping for the properties of the Persistent field.

<basic>
0 or more times
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<lob>
0 or once#2
Specified when mapping to the Lob type.

<temporal>
0 or once#2
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<enumerated>
0 or once#2
Specified when mapping to the enumeration type.

<version>
0 or more times
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<temporal>
0 or once
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<many-to-one>
0 or more times
Overwrites the mapping specified in fields and properties.

<join-column>
0 or more times#3
Specifies the external key column of the join table corresponding to the owner-side entity.

<join-table>
0 or once#3
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<one-to-many>
0 or more times
Overwrites the mapping specified in fields and properties.

<order-by>
0 or once
Specifies the order to be applied when maintaining a relation in the collection.

<map-key>
0 or once
Specifies the map key as the Map type relation.

<join-table>
0 or once#4
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<join-column>
0 or more times#4
Specifies the external key column of the join table corresponding to the owner-side entity.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<one-to-one>
0 or more times
Overwrites the mapping specified in fields and properties.

<primary-key-join-column>
0 or more times#5
Specifies the primary key column used as external key to JOIN with other tables.

<join-column>
0 or more times#5
Specifies the external key column of the join table corresponding to the owner-side entity.

<join-table>
0 or once#5
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<many-to-many>
0 or more times
Overwrites the mapping specified in fields and properties.

<order-by>
0 or once
Specifies the order to be applied when maintaining a relation in the collection.

<map-key>
0 or once
Specifies the map key as the Map type relation.

<join-table>
0 or once
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<embedded>
0 or more times
Overwrites the mapping specified in fields and properties.

<attribute-override>
0 or more times
Overwrites the mapping of properties and fields.

<column>
Once
Specifies the column mapping for the properties of the Persistent field.

<transient>
0 or more times
Overwrites the mapping specified in fields and properties.

<entity>
0 or more times
Defines the entities of the persistence unit.

<description>
0 or once
Adds the description for the entities of the persistence unit.

<table>
0 or once
Overwrites @Table (including default values) of the entity class.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<secondary-table>
0 or more times
Overwrites all @SecondaryTable and @SecondaryTables (including default values) of the entity class.

<primary-key-join-column>
0 or more times
Overwrites all @PrimaryKeyJoinColumn and @PrimaryKeyJoinColumns (including default values) of the entity class.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<primary-key-join-column>
0 or more times
Overwrites all @PrimaryKeyJoinColumn and @PrimaryKeyJoinColumns (including default values) of the entity class.

<id-class>
0 or once
Overwrites @IdClass specified in the entity class.

<inheritance>
0 or once
Overwrites @Inheritance (including default values) of the entity class.

<discriminator-value>
0 or once
Overwrites @DiscriminatorValue (including default values) of the entity class.

<discriminator-column>
0 or once
Overwrites @DiscriminatorColumn (including default values) of the entity class.

<sequence-generator>
0 or once
Specifies the settings for the sequence generator that creates the primary key.

<table-generator>
0 or once
Specifies the settings for the generator that creates the primary key.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<named-query>
0 or more times
Defines a named query.

<query>
Once
Specifies the query string.

<hint>
0 or more times
Adds a hint to the query.

<named-native-query>
0 or more times
Defines the named native query.

<query>
Once
Specifies the query string.

<hint>
0 or more times
Adds a hint to the query.

<sql-result-set-mapping>
0 or more times
Defines the mapping of the SQL results.

<entity-result>
0 or more times
Specifies the entity class used for mapping the native SQL query result.

<field-result>
0 or more times
Specifies the field used for mapping the native SQL query result.

<column-result>
0 or more times
Specifies the column used for mapping the native SQL query result.

<exclude-default-listeners>
0 or once
Controls the default entity listeners of the entity class and the sub class.

<exclude-superclass-listeners>
0 or once
Controls the superclass listeners of the entity class and the sub class.

<entity-listeners>
0 or once
Overwrites @EntityListeners of the entity class.

<entity-listener>
0 or more times
Specifies the entity listener.

<pre-persist>
0 or once
Overwrites the definition of the lifecycle callback method according to the corresponding annotations, in the mapped superclass.

<post-persist>
0 or once

<pre-remove>
0 or once

<post-remove>
0 or once

<pre-update>
0 or once

<post-update>
0 or once

<post-load>
0 or once

<pre-persist>
0 or once
Overwrites the definition of the lifecycle callback method according to the corresponding annotations, in the entity class.

<post-persist>
0 or once

<pre-remove>
0 or once

<post-remove>
0 or once

<pre-update>
0 or once

<post-update>
0 or once

<post-load>
0 or once

<attribute-override>
0 or more times
Added to the value defined in @AttributeOverride or @AttributeOverrides of the entity class.

<column>
Once
Specifies the column mapping for the properties of the Persistent field.

<association-override>
0 or more times
Added to the value defined in @AssociationOverride or @AssociationOverrides of the entity class.

<join-column>
One or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<attributes>
0 or once
The element is not defined.

<id>
0 or more times#1
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<generated-value>
0 or once
Specifies the strategy for generating the primary key value.

<temporal>
0 or once
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<table-generator>
0 or once
Adds the table generator.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<sequence-generator>
0 or once
Specifies the settings for the sequence generator that creates the primary key.

<embedded-id>
0 or once#1
Overwrites the mapping specified in fields and properties.

<attribute-override>
0 or more times
Added to the value defined in @AttributeOverride or @AttributeOverrides of the entity class.

<column>
Once
Specifies the column mapping for the properties of the Persistent field.

<basic>
0 or more times
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<lob>
0 or once#2
Specified when mapping to the Lob type.

<temporal>
0 or once
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<enumerated>
0 or once#2
Specified when mapping to the enumeration type.

<version>
0 or more times
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<temporal>
0 or once
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<many-to-one>
0 or more times
Overwrites the mapping specified in fields and properties.

<join-column>
0 or more times#4
Specifies the external key column of the join table corresponding to the owner-side entity.

<join-table>
0 or once#4
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<one-to-many>
0 or more times
Overwrites the mapping specified in fields and properties.

<order-by>
0 or once
Specifies the order to be applied when maintaining a relation in the collection.

<map-key>
0 or once
Specifies the map key as the Map type relation.

<join-table>
0 or once#3
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<join-column>
0 or more times#3
Specifies the external key column of the join table corresponding to the owner-side entity.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<one-to-one>
0 or more times
Overwrites the mapping specified in fields and properties.

<primary-key-join-column>
0 or more times#5
Overwrites all @PrimaryKeyJoinColumn and @PrimaryKeyJoinColumns (including default values) of the entity class.

<join-column>
0 or more times#5
Specifies the external key column of the join table corresponding to the owner-side entity.

<join-table>
0 or once#5
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<many-to-many>
0 or more times
Overwrites the mapping specified in fields and properties.

<order-by>
0 or once
Specifies the order to be applied when maintaining a relation in the collection.

<map-key>
0 or once
Specifies the map key as the Map type relation.

<join-table>
0 or once
Specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

<join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owner-side entity.

<inverse-join-column>
0 or more times
Specifies the external key column of the join table corresponding to the owned-side entity.

<unique-constraint>
0 or more times
Adds a unique constraint to DDL.

<column-name>
One or more times
Specifies the name of the column in which the unique constraint will be added.

<cascade>
0 or once
Specifies the operations that you can cascade.

<cascade-all>
0 or once
Cascades all the operations.

<cascade-persist>
0 or once
Cascades the persist operation.

<cascade-merge>
0 or once
Cascades the merge operation.

<cascade-remove>
0 or once
Cascades the remove operation.

<cascade-refresh>
0 or once
Cascades the refresh operation.

<embedded>
0 or more times
Overwrites the mapping specified in fields and properties.

<attribute-override>
0 or more times
Added to the value defined in @AttributeOverride or @AttributeOverrides of the entity class.

<column>
Once
Specifies the column mapping for the properties of the Persistent field.

<transient>
0 or more times
Overwrites the mapping specified in fields and properties.

<embeddable>
0 or more times
Defines the embeddable class of the persistence unit.

<description>
0 or once
Adds the description for the embeddable class of the persistence unit.

<attributes>
0 or once
The element is not defined.

<basic>
0 or more times
Overwrites the mapping specified in fields and properties.

<column>
0 or once
Specifies the column mapping for the properties of the Persistent field.

<lob>
0 or once#2
Specified when mapping to the Lob type.

<temporal>
0 or once#2
Specified when mapping to the DATE, TIME, and TIMESTAMP type.

<enumerated>
0 or once#2
Specified when mapping to the enumeration type.

<transient>
0 or more times
Overwrites the mapping specified in fields and properties.

#1

Specify any one among the <id> tag and the <embedded-id> tag.

#2

Specify any one among the <lob> tag, the <temporal> tag, and the <enumerated> tag.

#3

Specify any one among the <join-column> tag and the <join-table> tag.

#4

Specify any one among the <join-table> tag and the <join-column> tag.

#5

Specify any one among the <primary-key-join-column> tag, the <join-column> tag, and the <join-table> tag.

Organization of this section

6.3.1 Elements below entity-mappings

6.3.2 Elements below persistence-unit-metadata

6.3.3 Elements below table-generator

6.3.4 Elements below named-query

6.3.5 Elements below named-native-query

6.3.6 Elements below sql-result-set-mapping

6.3.7 Elements below mapped-superclass

6.3.8 Elements below entity

6.3.9 Elements under embeddable

6.3.10 Other elements

6.3.1 Elements below entity-mappings

Organization of this subsection

(1) <entity-mappings>

(2) <package>

(3) <schema>

(4) <catalog>

(5) <access>

(6) <sequence-generator>

(1) <entity-mappings>

Indicates the root tag.

The following table lists the specifiable attributes:

Table 6-6 Attributes of <entity-mappings>

Attribute name | Type | Optional/Required | Description
version | orm:versionType | Required | Specifies the JPA version.

(2) <package>

The package element specifies the class package described in the elements and attributes within the same mapping file. In the package element, the class name with a package name is specified for a class, and if the name differs from the package name specified in the package element, the package name is overwritten.

(3) <schema>

The schema element only applies to the entities that are specified within the same mapping file.

The schema element is overwritten by the following elements and attributes:

The schema elements explicitly specified in @Table and @SecondaryTable of the entity class specified in the mapping file.

The schemaAttributes of the table element and the secondary-table element defined in the entity element.

(4) <catalog>

The catalog element only applies to the entities specified within the same mapping file.

The catalog element is overwritten by the following elements and attributes:

The catalog element explicitly specified in @Table and @SecondaryTable of the entity class specified in the mapping file.

The catalog attributes of the table lower element and the secondary-table lower element defined in the entity element.

Precautions

Depending upon a database, the catalog element might not exist. The catalog element does not exist in Oracle and HiRDB databases supported by the Cosminexus JPA Provider. Therefore, you cannot specify the catalog element. If specified, an exception will be thrown when you execute the application.

(5) <access>

The access element applies to the classes that are specified and managed within the same mapping file.

The access element is overwritten by the following annotations and attributes:

The access type determined on the basis of the location in which the entity class annotations are specified.

The access attributes defined in the entity element, the mapped-superclass element, and the embeddable element.

# Specify PROPERTY or FIELD as the specified value. For details on specifying how to access the entity class fields, see 6.12.3 Specifying how to access the entity class fields in the manual uCosminexus Application Server Common Container Functionality Guide.

(6) <sequence-generator>

Adds the sequence generator.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-7 Attributes of <sequence-generator>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
sequence-name | xsd:string | Optional | See the sequenceName attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
initial-value | xsd:int | Optional | See the initialValue attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
allocation-size | xsd:int | Optional | See the allocationSize attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.

6.3.2 Elements below persistence-unit-metadata

Organization of this subsection

(1) <persistence-unit-metadata>

(2) <xml-mapping-metadata-complete>

(3) <persistence-unit-defaults>

(4) <schema>

(5) <catalog>

(6) <access>

(7) <cascade-persist>

(8) <entity-listeners>

(1) <persistence-unit-metadata>

Specifies the definition related to the entire PersistenceUnit.

(2) <xml-mapping-metadata-complete>

If you specify the xml-mapping-metadata-complete element, the mapping metadata of the persistence unit is controlled and the annotations specified in the class are ignored.

If the xml-mapping-metadata-complete element is specified and the XML element is omitted, the default value is enabled.

Precautions

If you specify this element when an annotation is specified, the KDJE55532-W message is output.

(3) <persistence-unit-defaults>

Specifies the default value of the persistence unit.

(4) <schema>

The schema element applies to all entity classes, table generators, and join tables in the persistence unit.

The schema element is overwritten by the following elements and attributes:

The schema element of the entity-mappings element.

The schema attributes explicitly specified in @Table and @SecondaryTable of the entity class.

The schema attributes specified in the table element and secondary-table element of the entity element.

The schema elements explicitly specified in the @TableGenerator and table-generator element.

The schema elements explicitly specified in the @JoinTable and join-table element.

(5) <catalog>

The catalog element applies to all entity classes, table generators, and join tables in the persistence unit.

The catalog element is overwritten by the following elements and attributes:

The catalog element of the entity-mappings element.

The catalog attributes explicitly specified in @Table and @SecondaryTable of the entity class.

The catalog attributes specified in the table element and secondary-table element of the entity element.

The catalog elements explicitly specified in the @TableGenerator and table-generator element.

The catalog elements explicitly specified in the @JoinTable and join-table element.

Precautions

The catalog element does not exist in the Oracle and HiRDB databases supported in Cosminexus JPA Provider. Therefore, you cannot specify the catalog element. If specified, an exception will be thrown when the application is executed.

(6) <access>

The access element applies to all the managed classes in the persistence unit.

The access element is overwritten by the following annotations, elements, and attributes:

The access type determined on the basis of the location in which the entity class annotations are specified.

The access element of the entity-mappings element.

The access attributes defined in the entity element, mapped-superclass element, and embeddable element.

Precautions

Specify PROPERTY or FIELD as the specified value. For details on specifying how to access the entity class fields, see 6.12.3 Specifying how to access the entity class fields in the manual uCosminexus Application Server Common Container Functionality Guide.

(7) <cascade-persist>

The cascade-persist element applies to all the relationships in the persistence unit.

In addition to the values specified in annotations or O/R mapping files, the specification of the cascade-persist element adds the cascade persistence option to all the relationships.

Precautions

If you specify the cascade-persist element, you cannot overwrite and disable.

(8) <entity-listeners>

The entity-listeners element defines the default entity listeners of the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

6.3.3 Elements below table-generator

Organization of this subsection

(1) <table-generator>

(1) <table-generator>

The generators defined by the table-generator element will be applied to the persistence unit.

The defined generator is added to the generators defined using annotations. If a generator with the same name is defined in the annotation, the generator defined by the table-generator element is overwritten.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-8 Attributes of <table-generator>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide
catalog | xsd:string | Optional | See the catalog attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-name | xsd:string | Optional | See the pkColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
value-column-name | xsd:string | Optional | See the valueColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-value | xsd:string | Optional | See the pkColumnValue attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
initial-value | xsd:int | Optional | See the initialValue attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
allocation-size | xsd:int | Optional | See the allocationSize attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.

6.3.4 Elements below named-query

Organization of this subsection

(1) <named-query>

(1) <named-query>

The named query defined by the named-query element applies to the persistence unit.

The defined named query is added to the named query defined using annotations. If a named query with the same name is defined in the annotation, the named query defined by the named-query element is overwritten.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-9 Attributes of <named-query>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.35 @NamedQuery in the manual uCosminexus Application Server API Reference Guide.

6.3.5 Elements below named-native-query

Organization of this subsection

(1) <named-native-query>

(1) <named-native-query>

The named native query defined by the named-native-query element applies to the persistence unit.

The defined named native query is added to the named native query defined using annotations. If a named native query with the same name is defined in the annotation, the named native query defined by the named-native-query element of the O/R mapping file is overwritten.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-10 Attributes of <named-native-query>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.
result-class | xsd:string | Optional | See the resultClass attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.
result-set-mapping | xsd:string | Optional | See the resultSetMapping attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.

6.3.6 Elements below sql-result-set-mapping

Organization of this subsection

(1) <sql-result-set-mapping>

(1) <sql-result-set-mapping>

The SQL result set mapping defined by the sql-result-set-mapping element applies to the persistence unit.

The defined SQL result set mapping is added to the SQL result set mapping defined using annotations. If SQL result set mapping with the same name is defined in the annotation, the SQL result set mapping defined by the sql-result-set-mapping element of the O/R mapping file is overwritten.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-11 Attributes of <sql-result-set-mapping>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.57 @SqlResultSetMapping in the manual uCosminexus Application Server API Reference Guide.

6.3.7 Elements below mapped-superclass

The following elements and attributes apply only to the mapped superclass that is the target of the elements and attributes:

Organization of this subsection

(1) <mapped-superclass>

(2) <id-class>

(3) <exclude-default-listeners>

(4) <exclude-superclass-listeners>

(5) <entity-listeners>

(6) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

(7) <id>

(8) <embedded-id>

(9) <basic>

(10) <version>

(11) <many-to-one>

(12) <one-to-many>

(13) <one-to-one>

(14) <many-to-many>

(15) <embedded>

(16) <transient>

(1) <mapped-superclass>

The mapped-superclass element defines the mapped superclass of the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-12 Attributes of <mapped-superclass>

Attribute name
Type
Optional/Required
Description

class
xsd:string
Required
Class name of the mapped superclass.

access
orm:access-type
Optional
The access attribute defines the access type of the mapped superclass. The access attribute overwrites the access type specified in the persistence-unit-defaults element (default element) and entity-mappings element (element valid for the entire persistence unit) provided to the mapped superclass.#1

metadata-complete#²
xsd:boolean
Optional
If the metadata-complete attribute is specified in the mapped-superclass element, the annotations specified in the mapped superclass and in the fields and properties of the mapped superclass are ignored.
If metadata-complete is specified in the mapped-superclass element and if the XML element is omitted, the default value is enabled.

#1

Specify PROPERTY or FIELD as the specified value. For details on specifying how to access the entity class fields, see 6.12.3 Specifying how to access the entity class fields in the manual uCosminexus Application Server Common Container Functionality Guide.

#2

If you specify this element when an annotation is specified, the KDJE55532-W message is output.

(2) <id-class>

The id-class element overwrites @IdClass specified in the mapped superclass.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-13 Attributes of <id-class>

Attribute name | Type | Optional/Required | Description
class | xsd:string | Required | See the value attribute in 2.7.22 @IdClass in the manual uCosminexus Application Server API Reference Guide.

(3) <exclude-default-listeners>

The exclude-default-listeners element is applied regardless of whether @ExcludeDefaultListeners is specified in the mapped superclass.

The exclude-default-listeners element controls the default entity listeners of the mapped superclass and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(4) <exclude-superclass-listeners>

The exclude-superclass-listeners element is applied regardless of whether @ExcludeSuperclassListeners is specified in the mapped superclass.

The exclude-superclass-listeners element controls the superclass listeners of the mapped superclass and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(5) <entity-listeners>

The entity-listeners element overwrites @EntityListeners of the mapped superclass.

If these listeners are not controlled using other methods, these listeners will be applied in the mapped superclass and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(6) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

These elements overwrite the definition of the lifecycle callback method according to the corresponding annotations, in the mapped superclass.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-14 Attributes of <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, and <post-load>

Attribute name | Type | Optional/Required | Description
method-name | xsd:string | Required | Target method name.

(7) <id>

The id element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-15 Attributes of <id>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Specifies a primary key property or field.

(8) <embedded-id>

The embedded-id element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-16 Attributes of <embedded-id>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Specifies a compound primary key.

(9) <basic>

The basic element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-17 Attributes of <basic>

Attribute name
Type
Optional/Required
Description

name
xsd:string
Required
Specifies the methods and fields that map the type.

fetch
orm:fetch-type
Optional
Specifies the value of the Fetch strategy.
For details, see the fetch attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.

optional
xsd:boolean
Optional
Specifies whether to use null in the field (property).
For details, see the optional attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.

(10) <version>

The version element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-18 Attributes of <version>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Specifies a version property or field.

(11) <many-to-one>

The many-to-one element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-19 Attributes of <many-to-one>

Attribute name
Type
Optional/Required
Description

name
xsd:string
Required
Specifies methods or fields with a many-to-one relationship.

target-entity
xsd:string
Optional
Specifies the related entity classes.
For details, see the targetEntity attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.

fetch
orm:fetch-type
Optional
Specifies the value of the Fetch strategy.
For details, see the fetch attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.

optional
xsd:boolean
Optional
Defines whether to specify null in all the non-primitive field and property values.
For details, see the optional attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.

(12) <one-to-many>

The one-to-many element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-20 Attributes of <one-to-many>

Attribute name
Type
Optional/Required
Description

name
xsd:string
Required
Methods or fields with a one-to-many relationship.

target-entity
xsd:string
Optional
Specifies the related entity classes. For details, see the mappedBy attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.

fetch
orm:fetch-type
Optional
Specifies the value of the Fetch strategy.
For details, see the fetch attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.

mapped-by
xsd:string
Optional
Specifies the field (property) names allocated to the elements of the owned-side entity class and the relations are maintained in the owner-side entity class.
For details, see the mappedBy attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.

(13) <one-to-one>

The one-to-one element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-21 Attributes of <one-to-one>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a one-to-one relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
optional | xsd:boolean | Optional | See the optional attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
mapped-by | xsd:string | Optional | See the mappedBy attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.

(14) <many-to-many>

The many-to-many element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-22 Attributes of <many-to-many>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a many-to-many relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.
mapped-by | xsd:string | Optional | See the mappedBy attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.

(15) <embedded>

The embedded element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-23 Attributes of <embedded>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property or field that is an embedded object.

(16) <transient>

The transient element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-24 Attributes of <transient>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property or field that is non-persistent.

6.3.8 Elements below entity

The following elements and attributes apply only to the entity class that is the target of the lower elements and attributes:

Organization of this subsection

(1) <entity>

(2) <table>

(3) <secondary-table>

(4) <primary-key-join-column>

(5) <id-class>

(6) <inheritance>

(7) <discriminator-value>

(8) <discriminator-column>

(9) <sequence-generator>

(10) <table-generator>

(11) <named-query>

(12) <named-native-query>

(13) <sql-result-set-mapping>

(14) <exclude-default-listeners>

(15) <exclude-superclass-listeners>

(16) <entity-listeners>

(17) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

(18) <attribute-override>

(19) <association-override>

(20) <id>

(21) <embedded-id>

(22) <basic>

(23) <version>

(24) <many-to-one>

(25) <one-to-many>

(26) <one-to-one>

(27) <many-to-many>

(28) <embedded>

(29) <transient>

(1) <entity>

The entity element defines the entities of the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-25 Attributes of <entity>

Attribute name
Type
Optional/Required
Description

name
xsd:string
Optional
The name attribute defines the name of the entity. The name attribute is overwritten regardless of whether the entity name defined by the name element of @Entity is explicitly specified or is the default value.
The operation when the entity class name is overwritten might not execute normally.

class
xsd:string
Required
Entity class name.

access
orm:access-type
Optional
The access attribute defines the access type of the entity class. The access attribute overwrites the access type specified in the persistence-unit-defaults element (default element) and entity-mappings element (element valid for the entire persistence unit) provided to the entity class.#1

metadata-complete#2
xsd:boolean
Optional
If the metadata-complete attribute is specified in the entity element, the annotations specified in the entity class and in the fields and properties of the entity class are ignored.
If metadata-complete is specified in the entity element and if the XML element is omitted, the default value is enabled.

#1

Specify PROPERTY or FIELD as the specified value. For details on specifying how to access the entity class fields, see 6.12.3 Specifying how to access the entity class fields in the manual uCosminexus Application Server Common Container Functionality Guide.

#2

If you specify this element when an annotation is specified, the KDJE55532-W message is output.

(2) <table>

The table element overwrites @Table (including default values) of the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-26 Attributes of <table>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.59 @Table in the manual uCosminexus Application Server API Reference Guide.
catalog | xsd:string | Optional | See the catalog attribute in 2.7.59 @Table in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.59 @Table in the manual uCosminexus Application Server API Reference Guide.

(3) <secondary-table>

The secondary-table element overwrites all @SecondaryTable and @SecondaryTables (including default values) of the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-27 Attributes of <secondary-table>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.54 @SecondaryTable in the manual uCosminexus Application Server API Reference Guide.
catalog | xsd:string | Optional | See the catalog attribute in 2.7.54 @SecondaryTable in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.54 @SecondaryTable in the manual uCosminexus Application Server API Reference Guide.

(4) <primary-key-join-column>

The primary-key-join-column element overwrites all @PrimaryKeyJoinColumn and @PrimaryKeyJoinColumns (including default values) of the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-28 Attributes of <primary-key-join-column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.
referenced-column-name | xsd:string | Optional | See the referencedColumnName attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.

(5) <id-class>

The id-class element overwrites @IdClass specified in the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-29 Attributes of <id-class>

Attribute name | Type | Optional/Required | Description
class | xsd:string | Required | See the value attribute in 2.7.22 @IdClass in the manual uCosminexus Application Server API Reference Guide.

(6) <inheritance>

The inheritance element overwrites @Inheritance (including default values) of the entity class.

The inheritance element will be applied to the entity class and the sub class (if the sub class specified in the annotation and XML element is not overwritten using another method).

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-30 Attributes of <inheritance>

Attribute name | Type | Optional/Required | Description
strategy | orm:inheritance-type | Optional | See the strategy attribute in 2.7.23 @Inheritance in the manual uCosminexus Application Server API Reference Guide.

(7) <discriminator-value>

The discriminator-value element overwrites @DiscriminatorValue (including default values) of the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(8) <discriminator-column>

The discriminator-column element overwrites @DiscriminatorColumn (including default values) of the entity class.

The discriminator-column element will be applied to the entity class and the sub class (if the sub class specified in the annotation and XML element is not overwritten using another method).

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-31 Attributes of <discriminator-column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.8 @DiscriminatorColumn in the manual uCosminexus Application Server API Reference Guide.
discriminator-type | orm:discriminator-type | Optional | See the discriminatorType attribute in 2.7.8 @DiscriminatorColumn in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.8 @DiscriminatorColumn in the manual uCosminexus Application Server API Reference Guide.
length | xsd:int | Optional | See the length attribute in 2.7.8 @DiscriminatorColumn in the manual uCosminexus Application Server API Reference Guide.

(9) <sequence-generator>

The generator defined by the sequence-generator element is added to the generators defined using annotations and the other generators defined in the O/R mapping file. If a generator with the same name is defined in the annotation, the generator defined by the sequence-generator element overwrites this generator.

The generator defined by the sequence-generator element applies to the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-32 Attributes of <sequence-generator>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
sequence-name | xsd:string | Optional | See the sequenceName attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
initial-value | xsd:int | Optional | See the initialValue attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.
allocation-size | xsd:int | Optional | See the name attribute in 2.7.56 @SequenceGenerator in the manual uCosminexus Application Server API Reference Guide.

(10) <table-generator>

The generator defined by the table-generator element is added to the generators defined using annotations and the other generators defined in the O/R mapping file. If a generator with the same name is defined in the annotation, the generator defined by the table-generator element overwrites this generator.

The generators defined by the table-generator element will be applied to the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-33 Attributes of <table-generator>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
catalog | xsd:string | Optional | See the catalog attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-name | xsd:string | Optional | See the pkColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
value-column-name | xsd:string | Optional | See the valueColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-value | xsd:string | Optional | See the pkColumnValue attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
initial-value | xsd:int | Optional | See the initialValueattribute in2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
allocation-size | xsd:int | Optional | See the allocationSize attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.

(11) <named-query>

The named query defined by the named-query element is added to the named query defined using annotations and the other named queries defined in the O/R mapping file. If a named query with the same name is defined in the annotation, the named query defined by the named-query element overwrites this named query.

The named query defined by the named-query element applies to the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-34 Attributes of <named-query>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.35 @NamedQuery in the manual uCosminexus Application Server API Reference Guide.

(12) <named-native-query>

The named native query defined by the named-native-query element is added to the named native query defined using annotations and the other named native queries defined in the O/R mapping file. If a named native query with the same name is defined in the annotation, the named native query defined by the named-native-query element overwrites this named native query.

The named native query defined by the named-native-query element applies to the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-35 Attributes of <named-native-query>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.
result-class | xsd:string | Optional | See the resultClass attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.
result-set-mapping | xsd:string | Optional | See the resultSetMapping attribute in 2.7.33 @NamedNativeQuery in the manual uCosminexus Application Server API Reference Guide.

(13) <sql-result-set-mapping>

The SQL result mapping defined by the sql-result-set-mapping element is added to the SQL result mapping defined using annotations and the other SQL result mapping defined in the O/R mapping file. If SQL result mapping with the same name is defined in the annotation, the SQL result mapping defined in the sql-result-set-mapping element overwrites this SQL result mapping.

The SQL result mapping defined by the sql-result-set-mapping element applies to the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-36 Attributes of <sql-result-set-mapping>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.57 @SqlResultSetMapping in the manual uCosminexus Application Server API Reference Guide.

(14) <exclude-default-listeners>

The exclude-default-listeners element is applied regardless of whether @ExcludeDefaultListeners is specified in the entity class.

The exclude-default-listeners element controls the default entity listeners of the entity class and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(15) <exclude-superclass-listeners>

The exclude-superclass-listeners element is applied regardless of whether @ExcludeSuperclassListeners is specified in the entity class.

The exclude-superclass-listeners element controls the superclass listeners of the entity class and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(16) <entity-listeners>

The entity-listeners element overwrites @EntityListeners of the entity class.

If these listeners are not controlled using other methods, these listeners will be applied in the entity class and the sub class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(17) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

These elements overwrite the definition of the lifecycle callback method according to the corresponding annotations, in the entity class.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-37 Attributes of <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, and <post-load>

Attribute name | Type | Optional/Required | Description
method-name | xsd:string | Required | Target method name.

(18) <attribute-override>

The attribute-override element is added to the value defined in @AttributeOverride or @AttributeOverrides of the entity class. The attribute-override element overwrites the AttributeOverride element with the same attribute name.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-38 Attributes of <attribute-override>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.3 @AttributeOverride in the manual uCosminexus Application Server API Reference Guide.

(19) <association-override>

The association-override element is added to the value defined in @AssociationOverride or @AssociationOverrides of the entity class. The association-override element overwrites the AssociationOverride element with the same attribute name.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-39 Attributes of <association-override>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.1 @AssociationOverride in the manual uCosminexus Application Server API Reference Guide.

(20) <id>

The id element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-40 Attributes of <id>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Primary key property or field.

(21) <embedded-id>

The embedded-id element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-41 Attributes of <embedded-id>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Compound primary key.

(22) <basic>

The basic element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-42 Attributes of <basic>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields that map the type.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.
optional | xsd:boolean | Optional | See the optional attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.

(23) <version>

The version element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-43 Attributes of <version>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Version property or field.

(24) <many-to-one>

The many-to-one element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-44 Attributes of <many-to-one>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a many-to-one relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.
optional | xsd:boolean | Optional | See the optional attribute in 2.7.29 @ManyToOne in the manual uCosminexus Application Server API Reference Guide.

(25) <one-to-many>

The one-to-many element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-45 Attributes of <one-to-many>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a one-to-many relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.
mapped-by | xsd:string | Optional | See the mappedBy attribute in 2.7.36 @OneToMany in the manual uCosminexus Application Server API Reference Guide.

(26) <one-to-one>

The one-to-one element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-46 Attributes of <one-to-one>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a one-to-one relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
optional | xsd:boolean | Optional | See the optional attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.
mapped-by | xsd:string | Optional | See the mappedBy attribute in 2.7.37 @OneToOne in the manual uCosminexus Application Server API Reference Guide.

(27) <many-to-many>

The many-to-many element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-47 Attributes of <many-to-many>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields with a many-to-many relationship.
target-entity | xsd:string | Optional | See the targetEntity attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.
mapped-by | xsd:string | Optional | See the mappedBy attribute in 2.7.28 @ManyToMany in the manual uCosminexus Application Server API Reference Guide.

(28) <embedded>

The embedded element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-48 Attributes of <embedded>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property or field that is an embedded object.

(29) <transient>

The transient element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-49 Attributes of <transient>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property or field that is non-persistent.

6.3.9 Elements under embeddable

The following elements and attributes apply only to the embeddable class that is the target of the elements and attributes:

Organization of this subsection

(1) <embeddable>

(2) <basic>

(3) <transient>

(1) <embeddable>

The embeddable element defines the embeddable class of the persistence unit.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-50 Attributes of <embeddable>

Attribute name
Type
Optional/Required
Description

class
xsd:string
Required
Class name of the embeddable class.

access
orm:access-type
Optional
The access attribute defines the access type of the embeddable class. The access attribute overwrites the access type specified in the persistence-unit-defaults element (default element) and entity-mappings element (element valid for the entire persistence unit) provided to the embeddable class.#1

metadata-complete#2
xsd:boolean
Optional
If the metadata-complete attribute is specified in the embeddable element, the annotations specified in the embeddable class and in the fields and properties of the embeddable class are ignored.
If metadata-complete is specified in the embeddable element and if the XML element is omitted, the default value is enabled.

#1 Specify PROPERTY or FIELD as the specified value. For details on specifying how to access the entity class fields, see 6.12.3 Specifying how to access the entity class fields in the manual uCosminexus Application Server Common Container Functionality Guide.

#2 If you specify this element when an annotation is specified, the KDJE55532-W message is output.

(2) <basic>

The basic element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-51 Attributes of <basic>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Methods or fields that map the type.
fetch | orm:fetch-type | Optional | See the fetch attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.
optional | xsd:boolean | Optional | See the optional attribute in 2.7.5 @Basic in the manual uCosminexus Application Server API Reference Guide.

(3) <transient>

The transient element overwrites the mapping specified in fields and properties.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-52 Attributes of <transient>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | Property or field that is non-persistent.

6.3.10 Other elements

Organization of this subsection

(1) <description>

(2) <entity-listener>

(3) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

(4) <unique-constraint>

(5) <column-name>

(6) <query>

(7) <hint>

(8) <entity-result>

(9) <field-result>

(10) <column-result>

(11) <attributes>

(12) <column>

(13) <generated-value>

(14) <temporal>

(15) <table-generator>

(16) <attribute-override>

(17) <lob>

(18) <enumerated>

(19) <join-column>

(20) <join-table>

(21) <inverse-join-column>

(22) <cascade>

(23) <cascade-all>

(24) <cascade-persist>

(25) <cascade-merge>

(26) <cascade-remove>

(27) <cascade-refresh>

(28) <order-by>

(29) <map-key>

(30) <primary-key-join-column>

(1) <description>

Adds the description.

(2) <entity-listener>

Specifies the entity listener.

The following table lists the specifiable attributes:

Table 6-53 Attributes of <entity-listener>

Attribute name | Type | Optional/Required | Description
class | xsd:string | Required | Class name of the entity listener.

(3) <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, <post-load>

Specifies the lifecycle callback method.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-54 Attributes of <pre-persist>, <post-persist>, <pre-remove>, <post-remove>, <pre-update>, <post-update>, and <post-load>

Attribute name | Type | Optional/Required | Description
method-name | xsd:string | Required | Target method name.

(4) <unique-constraint>

Adds a unique constraint to DDL.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(5) <column-name>

Specifies the name of the column in which the unique constraint will be added.

The column-name element corresponds to the columnNames attribute of @UniqueConstraint.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(6) <query>

Specifies the query string.

The query element corresponds to the query attribute of @NamedQuery and the query attribute of @NamedNativeQuery.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(7) <hint>

Adds a hint to the query.

The hint element corresponds to the hints attribute of @NamedQuery and the hints attribute of @NamedNativeQuery.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-55 Attributes of <hint>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.53 @QueryHint in the manual uCosminexus Application Server API Reference Guide.
value | xsd:string | Required | See the value attribute in 2.7.53 @QueryHint in the manual uCosminexus Application Server API Reference Guide.

(8) <entity-result>

Specifies the entity class used for mapping the native SQL query result.

The entity-result element corresponds to the entities attribute of @SqlResultSetMapping.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-56 Attributes of <entity-result>

Attribute name | Type | Optional/Required | Description
entity-class | xsd:string | Required | See the entityClass attribute in 2.7.15 @EntityResult in the manual uCosminexus Application Server API Reference Guide.
discriminator-column | xsd:string | Optional | See the discriminatorColumn attribute in 2.7.15 @EntityResult in the manual uCosminexus Application Server API Reference Guide.

(9) <field-result>

Specifies the field used for mapping the native SQL query result.

The field-result element corresponds to the fields attribute of @EntityResult.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-57 Attributes of <field-result>

Type | Attribute name | Optional/Required | Description
xsd:string | name | Required | See the name attribute in 2.7.19 @FieldResult in the manual uCosminexus Application Server API Reference Guide.
xsd:string | column | Required | See the column attribute in 2.7.19 @FieldResult in the manual uCosminexus Application Server API Reference Guide.

(10) <column-result>

Specifies the column used for mapping the native SQL query result.

The column-result element corresponds to the columns attribute of @SqlResultSetMapping.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-58 Attributes of <column-result>

Type | Attribute name | Optional/Required | Description
xsd:string | name | Required | See the name attribute in 2.7.7 @ColumnResult in the manual uCosminexus Application Server API Reference Guide.

(11) <attributes>

The functionality of the attributes element does not exist.

(12) <column>

The column element specifies the column mapping for the Persistent field or property.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-59 Attributes of <column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
unique | xsd:boolean | Optional | See the unique attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
nullable | xsd:boolean | Optional | See the nullable attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
insertable | xsd:boolean | Optional | See the insertable attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
updatable | xsd:boolean | Optional | See the updatable attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
length | xsd:int | Optional | See the length attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
precision | xsd:int | Optional | See the precision attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.
scale | xsd:int | Optional | See the scale attribute in 2.7.6 @Column in the manual uCosminexus Application Server API Reference Guide.

(13) <generated-value>

Specifies the strategy for generating the primary key value.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-60 Attributes of <generated-value>

Attribute name | Type | Optional/Required | Description
strategy | orm:generation-type | Optional | See the strategy attribute in 2.7.20 @GeneratedValue in the manual uCosminexus Application Server API Reference Guide.
generator | xsd:string | Optional | See the generator attribute in 2.7.20 @GeneratedValue in the manual uCosminexus Application Server API Reference Guide.

(14) <temporal>

Specified when mapping to the DATE, TIME, and TIMESTAMP type.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(15) <table-generator>

Adds the table generator.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-61 Attributes of <table-generator>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
catalog | xsd:string | Optional | See the catalog attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-name | xsd:string | Optional | See the pkColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
value-column-name | xsd:string | Optional | See the valueColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
pk-column-value | xsd:string | Optional | See the pkColumnName attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
initial-value | xsd:int | Optional | See the initialValue attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.
allocation-size | xsd:int | Optional | See the allocationSize attribute in 2.7.60 @TableGenerator in the manual uCosminexus Application Server API Reference Guide.

(16) <attribute-override>

Overwrites the mapping of properties and fields.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-62 Attributes of <attribute-override>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Required | See the name attribute in 2.7.3 @AttributeOverride in the manual uCosminexus Application Server API Reference Guide.

(17) <lob>

The lob element is specified when mapping to the Lob type.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(18) <enumerated>

Specified when mapping to the enumeration type.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(19) <join-column>

In order to join tables, the join-column element specifies the external key column of the join table corresponding to the owner-side entity.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-63 Attributes of <join-column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
referenced-column-name | xsd:string | Optional | See the referencedColumnName attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
unique | xsd:boolean | Optional | See the unique attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
nullable | xsd:boolean | Optional | See the nullable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
insertable | xsd:boolean | Optional | See the insertable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
updatable | xsd:boolean | Optional | See the updatable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.

(20) <join-table>

The join-table element specifies the join table to be used in many-to-many and the unilateral one-to-many relationships.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-64 Attributes of <join-table>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.26 @JoinTable in the manual uCosminexus Application Server API Reference Guide.
catalog | xsd:string | Optional | See the catalog attribute in 2.7.26 @JoinTable in the manual uCosminexus Application Server API Reference Guide.
schema | xsd:string | Optional | See the schema attribute in 2.7.26 @JoinTable in the manual uCosminexus Application Server API Reference Guide.

(21) <inverse-join-column>

In order to join tables, the inverse-join-column element specifies the external key column of the join table corresponding to the owned-side entity.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-65 Attributes of <inverse-join-column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
referenced-column-name | xsd:string | Optional | See the referencedColumnName attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
unique | xsd:boolean | Optional | See the unique attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
nullable | xsd:boolean | Optional | See the nullable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
insertable | xsd:boolean | Optional | See the insertable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
updatable | xsd:boolean | Optional | See the updatable attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.
table | xsd:string | Optional | See the table attribute in 2.7.24 @JoinColumn in the manual uCosminexus Application Server API Reference Guide.

(22) <cascade>

The cascade element specifies the operations that you can cascade.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(23) <cascade-all>

Cascades all the operations.

(24) <cascade-persist>

Cascades the persist operation.

(25) <cascade-merge>

Cascades the merge operation.

(26) <cascade-remove>

Cascades the remove operation.

(27) <cascade-refresh>

Cascades the refresh operation.

(28) <order-by>

Specifies the order to be applied when maintaining a relation in the collection.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

(29) <map-key>

Specifies the map key as the Map type relation.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-66 Attributes of <map-key>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.30 @MapKey in the manual uCosminexus Application Server API Reference Guide.

(30) <primary-key-join-column>

The primary-key-join-column element specifies the primary key column used as the external key that JOINS with other tables.

For details about the functionality and attributes, see section 2.7 javax.persistence package in the manual uCosminexus Application Server API Reference Guide.

The following table lists the specifiable attributes:

Table 6-67 Attributes of <primary-key-join-column>

Attribute name | Type | Optional/Required | Description
name | xsd:string | Optional | See the name attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.
referenced-column-name | xsd:string | Optional | See the referencedColumnName attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.
column-definition | xsd:string | Optional | See the columnDefinition attribute in 2.7.51 @PrimaryKeyJoinColumn in the manual uCosminexus Application Server API Reference Guide.

6.4 Query hint

In Cosminexus JPA Provider, you can specify a query hint in the hint element that is the lower element of the named-query element in the O/R mapping file. Note that you can also specify the query hint in the @Hint annotation of the argument for the @NamedQuery annotation. For details about the query hints specified in the annotations, see 2.7.53 @QueryHint in the manual uCosminexus Application Server API Reference Guide.

The following table describes the query hints that can be specified in the hint element that is the lower element of the named-query element in the O/R mapping file:

Table 6-68 Query hints that can be used in Cosminexus JPA Provider

Key name
Description
Specifiable value
Default

cosminexus.jpa.pessimistic-lock
Specifies whether the pessimistic lock will be used.

NoLock

The pessimistic lock will not be used.

Lock

The pessimistic lock will be used.

If the target table is already locked, the release of the lock will be awaited.

In Oracle
SELECT ... FOR UPDATE will be issued.

In HiRDB
SELECT ... WITH EXCLUSIVE LOCK will be issued.

LockNoWait

The pessimistic lock will be used.

If the target table is already locked, an exception will occur.

In Oracle
SELECT ... FOR UPDATE NO WAIT will be issued.

In HiRDB
SELECT ... WITH EXCLUSIVE LOCK NO WAIT will be issued.

NoLock

Note:

The data type that can be specified is String.

Note:

If a value outside the specifiable range is set for a query hint specified in the O/R mapping file, an exception will occur when the application starts. Note that the value is not case sensitive.

7. Files Used in Cosminexus JMS Provider

This chapter describes the formats, storage locations, and functionality of the files used in Cosminexus JMS Provider and the keys that you can specify in the files.

Organization of this chapter

7.1 List of files used in Cosminexus JMS Provider

7.2 admin.properties (Management command properties file)

7.3 commonconfig.properties (CJMSP broker common properties file)

7.4 config.properties ( CJMSP broker individual properties file)

7.1 List of files used in Cosminexus JMS Provider

The following table lists and describes the files used in Cosminexus JMS Provider:

Table 7-1 List of files used in Cosminexus JMS Provider

File name | Classification | Overview | Reference
admin.properties | Management command properties file | Specifies the log output of management commands. | 7.2
commonconfig.properties | CJMSP broker common properties file | Specifies all system properties of CJMSP broker in a batch. | 7.3
config.properties | CJMSP broker individual properties file | Specifies system properties of CJMSP broker individually. | 7.4

7.2 admin.properties (Management command properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(1) Format

Specify the key as follows:

Key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

If the value specified is not within the range, the value outside the range is used. If a value is not specified, the previous value is used. In such cases, a warning message appears on the console.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\cjmsp\var\admin\config \

In UNIX
/opt/Cosminexus/CC/cjmsp/var/admin/config/

Note that hereafter Cosminexus-installation-directory\CC\cjmsp (In Windows) or /opt/Cosminexus/CC/cjmsp (In UNIX) are represented as <CJMSP_HOME>.

(3) Functionality

Specifies the log output of management commands.

Note that property values are validated even before initialization of the log. If an invalid value is specified as a property in this file, the log contents are output only to the console and not to the log file.

To change the following properties, the changed contents are enabled when all log files under <CJMSP_HOME>\var\admin\log directory (In Windows) or <CJMSP_HOME>/var/admin/log directory (In UNIX) are deleted.

admin.logger.ExceptionLogFile.filenum

admin.logger.ExceptionLogFile.filesize

admin.logger.MessageLogFile.filenum

admin.logger.MessageLogFile.filesize

(4) Specifiable keys

The following are the keys that can be specified. Note that "If value is not specified" in the table refers to the value of a non-specified key, and "VR" refers to the version of Application Server for which the keys are introduced or changed.

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

admin.logger.ExceptionLogFile.filenum
Specify the maximum number of log files to be created.
1 to 16
2
2
08-50

admin.logger.ExceptionLogFile.filepath
Specify the absolute path of the storage location of the log file.
The file is created automatically with the name, cjmsadmin_errN.log. N refers to the number of log files.
If the specified directory does not exist, Cosminexus JMS Provider displays a warning message and default contents are applied. Also, if the default directory does not exist, Cosminexus JMS Provider creates a default directory and enables its use.
Specify a path with read and write permission. If a path with only read permission is specified, the default contents are applied. If the default path has only read permission, the operation fails.
For details about the characters and length of the path that can be specified as the directory name, see the limitations of OS to be used.
Note that if you specify \ in the path, specify as \\ and escape.
path-name

In Windows
<CJMSP_HOME>\var\admin\log

In UNIX
<CJMSP_HOME>/var/admin/log

In Windows
<CJMSP_HOME>\var\admin\log

In UNIX
<CJMSP_HOME>/var/admin/log

08-50

admin.logger.ExceptionLogFile.filesize
Specify the maximum value for the log file size in bytes.
8192 to 4194304​
1048576​
1048576​
08-50

admin.logger.MessageLogFile.filenum
Specify the maximum value of the number of files to be created.
1 to 16
2
2
08-50

admin.logger.MessageLogFile.filepath
Specify the absolute path of the storage location of the log file.
The file is created automatically with the name, cjmsadmin_msgN.log. N refers to the number of log files.
If the specified directory does not exist, Cosminexus JMS Provider displays a warning message and default contents are applied. Also, if the default directory does not exist, Cosminexus JMS Provider creates a default directory and enables its use.
Specify a path with read and write permission. If a path with only read permission is specified, the default contents are applied. If the default path has only read permission, the operation fails.
For details about the characters and length of the path that can be specified as the directory name, see the limitations of OS to be used.
Note that if you specify \ in the path, specify as \\ and escape.
path-name

In Windows
<CJMSP_HOME>\var\admin\log

In UNIX
<CJMSP_HOME>/var/admin/log

In Windows
<CJMSP_HOME>\var\admin\log

In UNIX
<CJMSP_HOME>/var/admin/log

08-50

admin.logger.MessageLogFile.filesize
Specify the maximum value of the log file size.
8192 to 4194304​
1048576​
1048576​
08-50

admin.logger.MessageLogFile.trace.level
Specify the log level.
Information is recorded in the log file on the basis of the specified level.
The following strings can be specified:

ERROR

WARNING

INFO

ERROR
ERROR
08-50

7.3 commonconfig.properties (CJMSP broker common properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(1) Format

Specify the key as follows:

Key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

If the value specified is not within the range, the value outside the range is used. If a value is not specified, the previous value is used. In such cases, a warning message appears on the console.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\cjmsp\lib\props\broker \

In UNIX
/opt/Cosminexus/CC/cjmsp/lib/props/broker/

(3) Functionality

Describes the property files for batch setting of all CJMSP broker properties.

If the contents of the file are changed while CJMSP broker is running, the changed contents are applied and enabled when CJMSP broker restarts.

(4) Specifiable keys

The following are the keys that can be specified. For details, see 7.4 config.properties (CJMSP broker individual properties file).

(a) Connection service

The following are the keys that can be specified for the connection service. For details, see 7.4(4)(a) Connection service.

imq.hostnamekey

(b) Persistence service

The following are the keys that can be specified for the persistence service. For details, see 7.4(4)(b) Persistence service.

imq.persist.file.sync.enabledkey

(c) Settings for creating destinations automatically

The following are the keys that can be specified for creating destinations automatically. For details, see 7.4(4)(c) Settings for creating destinations automatically.

imq.autocreate.destination.maxNumMsgskey

imq.autocreate.destination.maxTotalMsgByteskey

imq.autocreate.queue.consumerFlowLimitkey

imq.autocreate.topic.consumerFlowLimitkey

(d) Setting monitoring properties

The following shows the keys that can be set for monitoring properties. For details, see 7.4(4)(d) Setting monitoring properties.

imq.metrics.intervalkey

(e) CJMSP broker log properties

The following are the keys that can be set for CJMSP broker log properties. For details, see 7.4(4)(e) CJMSP broker log properties.

broker.logger.ExceptionLogFile.filenumkey

broker.logger.ExceptionLogFile.filesizekey

broker.logger.MessageLogFile.filenumkey

broker.logger.MessageLogFile.filesizekey

broker.logger.MessageLogFile.trace.levelkey

7.4 config.properties ( CJMSP broker individual properties file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(1) Format

Specify the key as follows:

Key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

If the value specified is not within the range, the value outside the range is used. If a value is not specified, the previous value is used. In such cases, a warning message appears on the console.

(2) File storage location

The default storage locations are as follows. Note that you can change the storage location of the var directory in the -varhome option of the cjmsbroker command.

In Windows
Cosminexus-installation-directory\CC\cjmsp\var\instances \<CJMSP broker instance name>\props\

In UNIX
/opt/Cosminexus/CC/cjmsp/var/instances/<CJMSP broker instance name>/props/

Hereafter, Cosminexus-installation-directory\CC\cjmsp (In Windows) or /opt/Cosminexus/CC/cjmsp (In UNIX) is represented as <CJMSP_HOME>.

(3) Functionality

Specify the system properties to execute an individual CJMSP broker.

If different values are specified for config.properties and commonconfig.properties, then the priority is given to the value of config.properties.

If the contents of the file are changed while CJMSP broker is running, the changed contents are applied and enabled when CJMSP broker restarts.

(4) Specifiable keys

The following are the keys that can be specified. Note that "If value is not specified" in the table refers to the value of a non-specified key, and "VR" refers to the version of Application Server for which the keys are introduced or changed.

(a) Connection service

Properties related to the connection service are as follows:

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

imq.admin.tcp.port
Specify the port number for the admin service.
If a firewall is used for establishing a connection with CJMSP broker, you must use this property to specify a static port number.
In the following cases, the port mapper allocates a dynamic port number.

If 0 is specified

If a user specifies a value outside the range (above 65535)

If -1 or 1 to 1024 is specified, the operation is not guaranteed.
0, 1025 to
65535
0
0
08-50

imq.hostname
Specify a default host name or IP address for all connection services.
Hitachi recommends you to specify this property when Cosminexus JMS Provider is to be installed in multiple servers.
If an invalid character string is specified in the host name, CJMSP broker cannot start. If localhost or loopback address (127.*.*.*) is specified, remote connection to CJMSP broker is not enabled.
Note that if a value is not specified for this property, (if specified up to imq.hostname=), when CJMSP broker starts, it connects to the CJMSP broker of the local host. At this stage, host name is not output. For example, if a value is not specified in this property, but 7676 is specified in imq.portmapper.port, when CJSMP broker starts, :7676 is output.
--
--
host-name
08-50

imq.jms.tcp.port
Specify the port number for the jms service.
If a firewall is used for establishing a connection with CJMSP broker, you must use this property to specify a static port number.
In the following cases, the port mapper allocates a dynamic port number.

If 0 is specified

If a user specifies a value outside the range (above 65535)

If -1 or 1 to 1024 is specified, the operation is not guaranteed.
If you specify a port number that is already in use, the broker starts successfully, but the jms service cannot be used. If you execute the cjmsicmd list svc command in this state, the status of the jms service is displayed as UNKNOWN. UNKNOWN indicates that the service is not running or is unavailable.
0, 1025 to
65535
0
0
08-50

imq.portmapper.port
Specify the port number of the port mapper for the CJMSP client to connect to CJMSP broker.
If multiple CJMSP broker instances start on the same host, different port mapper port numbers must be specified for each port mapper.
1025 to 65535
7676
7676
08-50

Legend:

-: Not applicable.

(b) Persistence service

Properties related to persistence service are as follows:

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

imq.persist.file.sync.enabled
Specify whether to execute synchronous or asynchronous write process in the data file on memory.
If true is specified, synchronous write process is executed. In such cases, loss of data is prevented if a system error occurs, but process efficiency is affected. If false is specified, asynchronous write process is executed.
Hitachi recommends you to execute efficiency tests and then decide which one to specify.
If javax.jms.DeliveryMode.PERSISTENT is specified as the delivery mode in the application, we recommend that you specify true for this property.
The values that can be specified are as follows:

true

false

false
false
08-50

(c) Settings for creating destinations automatically

Properties related to settings for creating destinations automatically are as follows:

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

imq.autocreate.destination.maxNumMsgs
Specify the maximum value of the number of messages not received.
If -1 or 0 is specified, the number of messages become unlimited.
-1 to 2147483647​
100000
100000
08-50

imq.autocreate.destination.maxTotalMsgBytes
Specify the maximum byte value of the total memory size for messages not received. To specify units, add the following character strings at the end of the value. If a unit is not specified, it is considered as byte.

Byte: b

Kilobyte: k

Megabyte: m

If -1 or 0 is specified, the number of messages become unlimited.
-1 to 2147483647​ (unit: bytes)
10m
10m
08-50

imq.autocreate.queue.consumerFlowLimit
Specify the maximum value of the number of messages to be delivered to the queue consumer in the same batch.
If -1 is specified, the number of messages are unlimited.
The values that can be specified are as follows:

-1

Integers from 1 to 2147483647​

100
100
08-50

imq.autocreate.topic.consumerFlowLimit
Specify the maximum value of the number of messages to be delivered to the topic consumer in the same batch.
If -1 is specified, the number of messages are unlimited.
The values that can be specified are as follows:

-1

Integers from 1 to 2147483647​

1000
1000
08-50

(d) Setting monitoring properties

Properties related to monitoring settings are as follows:

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

imq.metrics.interval
Specify the write time of the matrix information in the logger and console, in units of seconds.
If 0 is specified, the matrix is not output.
0 to 2147483647​
0
0
08-50

(e) CJMSP broker log properties

Properties related to CJMSP broker log are as follows:

Key name
Contents
Specifiable value
If a value outside the range is specified
If the value is not specified
VR

broker.logger.ExceptionLogFile.filenum
Specify the maximum value of the number of files to be created.
1 to 16
2
2
08-50

broker.logger.ExceptionLogFile.filesize
Specify the maximum value of the log file size.
If the maximum value exceeds, a new file is created and the contents of the log file are output to the new file.
8192 to 4194304​
1048576​
1048576​
08-50

broker.logger.MessageLogFile.filenum
Specify the maximum value of the number of files to be created.
1 to 16
2
2
08-50

broker.logger.MessageLogFile.filesize
Specify the maximum value of the log file size.
If the maximum value exceeds, the contents of the log file are output to the new file.
8192 to 4194304​
1048576​
1048576​
08-50

broker.logger.MessageLogFile.trace.level
Specify the log level.
Information is output to the log file on the basis of the specified level.
The following strings can be specified:

ERROR

WARNING

INFO

ERROR
ERROR
08-50

(f) Other properties

Other properties are as follows:

Key name | Contents | Specifiable value | If a value outside the range is specified | If the value is not specified | VR
imq.instanceconfig.version | This property is used for internal processes. Do not change the settings. | -- | -- | -- | 08-50

Legend:

-: Not applicable.

8. Files Used with CTM

This chapter describes the formats, storage locations, and functionality of files used in CTM, and the keys that can be specified in these files.

Organization of this chapter

8.1 List of files used in CTM

8.2 CTM user environment variable definition file

8.3 CTM command option file

8.1 List of files used in CTM

The following table lists and describes the files used in CTM.

Table 8-1 List of files used in CTM

File name | Classification | Overview | Reference
(Optional)# | CTM user environment variable definition file | This file specifies the environment variables required for executing the ctmstart command (which starts the CTM daemon). | 8.2
(Optional)# | CTM command option file | This file is used to specify, in advance, the arguments (command options) that are used to automatically start the CTM regulator when the ctmstart command (start the CTM daemon) is executed. | 8.3

#

In Windows, you can use alphanumeric characters, periods (.), back slashes (\), colons (:), plus signs (+), or hyphens (-). In UNIX, you can use alphanumeric characters, periods (.), forward slashes (/), plus signs (+), or hyphens (-).

To use CTM to perform request scheduling and load balancing, you must also specify information in the usrconf.properties file for J2EE servers, in addition to the files shown in Table 8-1. In the usrconf.properties file, specify whether to use CTM, the CTM domain name, the CTM identifier of the CTM daemon, and the host name used by CTM. For details about the CTM keys of the usrconf.properties file for J2EE servers, see 2.4(5)(i) Keys beginning with ejbserver.ctm.

8.2 CTM user environment variable definition file

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Notes

(1) Format

Specify the file in the following format:

environment-variable-name=value

You cannot omit the environment variable name, the equal sign (=), or the value.

The characters from the beginning of a line to the character immediately before the first equal sign (=) are regarded as the environment variable name.

The characters from the character immediately after the first equal sign to the character immediately before the end of the line or file are regarded as the value.

A line beginning with a hash mark (#) is regarded as a comment. If there is a hash mark in the middle of the line, characters from the character after the hash mark to the end of the line are regarded as a comment. Spaces and tabs specified before a hash mark are ignored.

You cannot specify a hash mark (#) as the value of an environment variable.

To specify one definition on multiple lines, put a continuation character (\) immediately before the line break. Spaces and tabs immediately before the continuation character are ignored. If there is a continuation character in the middle of the line, the characters from the character after the continuation character to the end of the line are regarded as a comment. For this reason, to specify a continuation character, specify it at the end of the line.

If the specified environment variable already exists, the value of that environment value will be overwritten with the specified value. If the specified environment variable does not already exist, it will be added.

(2) File storage location

You can specify a storage location and file name of your choice. You can use the following characters in the file name:

In Windows
Alphanumeric characters, periods (.), back slashes (\), colons (:), plus signs (+), and hyphens (-)

In UNIX
Alphanumeric characters, periods (.), forward slashes (/), plus signs (+), and hyphens (-)

(3) Functionality

This file is used to specify the environment variables required for executing the ctmstart command (start the CTM daemon).

(4) Specifiable keys

You can specify any environment variable name except for the following:

Environment variable names beginning with CTM or ctm

(5) Examples of coding

In Windows

# Comment line
LANG=ja_JP.SJIS                      # Comment.
C:\Program Files\HITACHI\Cosminexus\CTM\lib\ctmj2sv.jar:    \
C:\Program Files\HITACHI\Cosminexus\java\classes.zip        # Continued line

In UNIX

# Comment line
LANG=ja_JP.SJIS                      # Comment
CLPATH=/opt/Cosminexus/CTM/lib/ctmj2sv.jar:    \
/opt/java/lib/classes.zip               # Continued line

(6) Notes

You cannot specify an environment variable name beginning with CTM or ctm.

You can specify a string consisting of alphanumeric characters or underscores (_) for an environment variable name.

You cannot specify spaces or tabs before the environment variable name. You must specify the environment variable name from the beginning of the line.

You cannot specify spaces or tabs between the environment variable name and the equal sign (=) or between the equal sign and the environment variable definition.

If the environment variable definition file contains %AAA% (in Windows) or $AAA (in UNIX), the string %AAA% or $AAA is treated as a character string and is not expanded to the environment variable AAA.

To specify a blank line, which does not contain any environment variable definition or comment, specify a line break code only (without spaces or tabs).

The definition is considered invalid in the following cases:

The environment variable definition does not contain an equal sign (=).

A line begins or ends with an equal sign (=).

An environment variable name begins with CTM or ctm.

A line contains only spaces or tabs.

When specifying environment variables in Windows, note the following regarding the use of continuation characters (\):

Make sure that a backslash (\) used to specify a path name is not confused with a continuation character (\).

Make sure that necessary spaces are not omitted.

The following are examples of specifications, where <LF> represents a line break code.

Example 1: Specifying c:\ for the environment variable ROOT_PATH

Item
Incorrect example
Correct example

Coding of the CTM user environment variable definition file
ROOT_PATH=c:\<LF>
ROOT_PORT=18000<LF>
ROOT_PATH=c:\#<LF>
ROOT_PORT=18000<LF>

Specified environment variable
ROOT_PATH=c:ROOT_PORT=18000
ROOT_PATH=c:\
ROOT_PORT=18000

In the incorrect example, the backslash (\) in c:\ is misinterpreted as a continuation character. In such cases, specify a hash mark (#) immediately after the backslash (\) so that the backslash will not be treated as a continuation character.

Example 2: Specifying C:\Program Files\Cosminexus\CTM for the environment variable CTMDIR

Item
Incorrect example
Correct example

Coding of the CTM user environment variable definition file
CTMDIR=C:\Program \<LF>
Files\Cosminexus\CTM<LF>
CTMDIR=C:\Program Files\<LF>
\Cosminexus\CTM<LF>

Specified environment variable
CTMDIR=C:\ProgramFiles\Cosminexus\CTM
CTMDIR=C:\Program Files\Cosminexus\CTM

In the incorrect example, the space in Program Files is omitted because it is specified immediately before the continuation character. Revise the specification so that the continuation character is not directly preceded by a space.

8.3 CTM command option file

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Example of coding

(6) Notes

(1) Format

Specify the file in the following format:

argument value

(2) File storage location

You can specify a storage location and file name of your choice. You can use the following characters in the file name:

In Windows
Alphanumeric characters, periods (.), back slashes (\), colons (:), plus signs (+), or hyphens (-)

In UNIX
Alphanumeric characters, periods (.), forward slashes (/), plus signs (+), or hyphens (-)

(3) Functionality

This file is used to specify, in advance, the arguments (command options) that are used to automatically start the CTM regulator when the ctmstart command (start the CTM daemon) is executed. When this file is specified for the -CTMRegOption option of the ctmstart command, the CTM regulator automatically starts based on the information specified in this file.

Note that, when the -CTMRegStart option is not specified, the specification of the -CTMRegOption option and the information specified in this file are ignored.

(4) Specifiable keys

You can specify arguments of the ctmregltd command. For details about the ctmregltd command, see ctmregltd in the uCosminexus Application Server Command Reference Guide. If you do not specify this file, the CTM regulator inherits the values of the arguments (excluding the arguments "-CTMPort" and "-CTMEjbPort") that were specified for the "ctmstart" command as the default values.

(5) Example of coding

-CTMClientConnectCount 64

(6) Notes

You can use alphanumeric characters, spaces, hyphens (-), periods (.), and forward slashes (/) in the command option file.

Do not specify anything other than command options.

9. Files Used in Web Server Integration

This chapter describes the storage locations, functionality, and format of the files used in Web server integration and the keys that you can specify in the files.

Organization of this chapter

9.1 List of files used in Web server integration

9.2 isapi_redirect.conf (Redirector action definition file for Microsoft IIS)

9.3 mod_jk.conf (Redirector action definition file for Cosminexus HTTP Server)

9.4 uriworkermap.properties (Mapping definition file for Microsoft IIS)

9.5 workers.properties (Worker definition file)

9.1 List of files used in Web server integration

The following table lists the files used in Web server integration:

Table 9-1 List of files used for Web server integration

File name | Classification | Overview | Reference
isapi_redirect.conf | Redirector action definition file for Microsoft IIS | Define the action of the redirector for Microsoft IIS. | 9.2
mod_jk.conf | Redirector action definition file for Cosminexus HTTP Server | Define the action of the redirector for Cosminexus HTTP Server. | 9.3
uriworkermap.properties | Mapping definition file for Microsoft IIS | Define the URL pattern to be transferred to the Web container server through the request to Microsoft IIS. | 9.4
workers.properties | Worker definition file | Define the action of the redirector. | 9.5

9.2 isapi_redirect.conf (Redirector action definition file for Microsoft IIS)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

Specify the key as follows:

key-name value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored. The parameters not defined as valid key names are also ignored even if defined in the action definition file.

Up to 1023 characters are valid as key-name=value. The part exceeding this number is truncated.

(2) File storage location

Cosminexus-installation-directory\CC\web\redirector\isapi_redirect.conf

(3) Functionality

This action definition file defines the action parameters of the redirector for Microsoft IIS.

(4) Specifiable keys

The specifiable keys and default values are described below. If you specify an invalid value in these keys, the operations may not produce the desired results. If you specify two or more keys, the last specified key becomes valid.

Key name
Contents
Default value

connection_sharing
Specify whether to share a connection between workers.

If you specify true:

The workers connected to the same host and the same port share a connection, even if the worker definitions are different.

If you specify false:

The workers having different worker definitions do not share a connection.

true

connect_timeout
Specify an integer (units: seconds) from 0 to 3600 for the timeout value to connect to the Web container when a request is sent.
If you specify a non-numeric value, or a numeric value outside the range, a message will be output and the default value will be used.
If you set the timeout as 0 or a time period longer than the resend timer of data transmission in TCP, the timeout value becomes the timeout value of TCP. In such a case, a message indicating that an invalid timeout value has been specified will not be output.
30

filter_priority
Specify the priority order used when the redirector is registered as an ISAPI filter.
The following strings can be specified:

high (priority order is set to "high")

medium (priority order is set to "medium")

low (priority order is set to "low")

High

gateway_host
Specify the host name or the IP address of the gateway.
When requests without a Host header are redirected to files, such as the welcome file, the host name of the Location header URL becomes the specified value.
None

gateway_https_scheme
When a client request uses https as a scheme, and the scheme for a Web server will become http by using an SSL accelerator, specify true.
If you specify true, https is assumed to be used as the scheme for requests sent to the Web server. If you specify false, no action occurs.
false

gateway_port
Specify the port number of the gateway. If a request has no Host header and the request is to be redirected to a location such as a welcome file, the port number portion of a URL that is specified in the Location header becomes the specified value. Always specify this parameter together with gateway_host.
If you specify gateway_host and omit this parameter, an access via http uses 80, and an access via hppts uses 443.
None

log_file_dir
Specify the output location directory of the log file.

When specified as a relative path:

Specify a directory name present in Cosminexus-installation-directory\CC\web\redirector.

When specified as an absolute path:

Specify the coded directory name.

Note that you must specify write permission to the Users group, as the access permission to the directory specified as the output destination. If access permission is not set, the log file is not output.
If the same value has been specified in log_file_prefix and trace_log_file_prefix, you need to specify a value different from trace_log_file_dir for this key. If you specify the same value, the redirector will not run.
Logs

log_file_num
Specify the maximum number of redirector log files. If this number is exceeded, the old log files are overwritten.
Specify an integer value from 1 to 64.
5

log_file_prefix
This is a prefix for the log file name. The actual log file name will be the value specified by this key with serial-number.log added.
If the same value has been specified in log_file_dir and trace_log_file_dir, you need to specify a value different from trace_log_file_prefix for this key. If you specify the same value, the redirector will not run.
isapi_redirect

log_file_size
Specify the size for each redirector log file in bytes.
Specify an integer value from 4096 to 16777216​.
4194304​

log_level
Specify the output level of redirector log files. You specify only one log level.
You can specify debug, info, or error.
error

prf_id
Specify the character string that was specified in the PRF identifier when invoking the PRF daemon.
None

receive_client_timeout
Specify in seconds the timeout period used when the POST data is received from the client.
Specify an integer value from 60 to 3600 in multiples of 60 (seconds).
If the specified value is not a multiple of 60, a value rounded off to a multiple of 60 becomes the timeout period.
300

request_retry_count}
Specify an integer (units: number of times) from 1 to 16 for the retry count to connect to the Web container when a request is sent and the retry count to send requests.
The retry count also includes the first establishment of connection and the request sending process.
When a timeout occurs, retry occurs in the following cases:

When a timeout occurs while connection is being established

When a timeout occurs while the request header is being sent

After the above processes, if a timeout occurs while the request body is being sent, retry does not occur.
If you set the retry count to an abnormal value, such as a value outside the range or a value that is not an integer, the default value is set.
3

send_timeout
Specify an integer (units: seconds) from 0 to 3600 for the timeout period for sending requests.
If you specify a non-numeric value, or a numeric value outside the range, a message will be output and the default value will be used.
If you set the timeout as 0 or a time period longer than the resend timer of data transmission in TCP, the timeout value becomes the timeout value of TCP. In such a case, a message indicating that an invalid timeout value has been specified will not be output.
100

trace_log
Specify whether to output the trace log for the maintenance of redirector. Specify true if trace log is to be output and false if it is not to be output.
true

trace_log_file_dir}
Specify the output destination directory for the maintenance trace log files.

When coded as a relative path:

Specify a directory name present in Cosminexus-installation-directory\CC\web\redirector.

When coded as an absolute path:

Specify the coded directory name.

Note that you must specify write permission for the Users group in the access permission to the directory specified as the output destination#. If access permission is not set, the log file is not output.
If the same value has been specified in log_file_prefix and trace_log_file_prefix, you need to specify a value different from log_file_dir for this key. If you specify the same value, the redirector will not run.
logs

trace_log_file_num}
Specify the maximum number of maintenance trace log files. If this number is exceeded, the old log files are overwritten.
Specify an integer value from 1 to 64.
4

trace_log_file_prefix
Specify the prefix for the maintenance trace log file name. The actual log file name will be the value specified by this key with serial-number.log added.
If the same value has been specified in log_file_dir and trace_log_file_dir, you need to specify a value different from log_file_prefix for this key. If you specify the same value, the redirector will not run.
iis_rd_trace

trace_log_file_size
Specify the size for each maintenance trace log file in bytes.
Specify an integer value from 4096 to 16777216​.
16777216​

worker_file
Specify the location and file name of the worker definition file.

When specified as a relative path:

Specify a file name present in Cosminexus-installation-directory\CC\web\redirector.

When specified as an absolute path:

Specify the coded file name.

workers.properties

worker_mount_file
Specify the location and file name of the mapping definition file.

When specified as a relative path:

Specify a file name present in Cosminexus-installation-directory\CC\web\redirector.

When specified as an absolute path:

Specify the coded file name.

uriworkermap.properties

# For integration with Microsoft IIS

For a new installation, the default log output destination directory does not exist. You either create a directory and grant access permission or grant access permission to the directory redirector that exists one level above.

Moreover, if the log output destination directory of the redirector is changed and only half of that path exists, you either grant the access permission to the lowest level of the existing directory or create the entire specified path, and then grant the access permission.

(5) Examples of coding

gateway_host=hostA
gateway_https_scheme=true
gateway_port=443

log_level=error
log_file_size=4194304
log_file_num=5
log_file_dir=logs
log_file_prefix=isapi_redirect
prf_id=prfid
trace_log=true
trace_log_file_size=16777216
trace_log_file_num=4
trace_log_file_dir=logs
trace_log_file_prefix=iis_rd_trace
receive_client_timeout=300
worker_file=workers.properties
worker_mount_file=uriworkermap.properties

(6) Precautions

If you change the user definition of the redirector by editing this file, you will need to restart the Web server. The changed definition will be applied after the Web server is restarted.

9.3 mod_jk.conf (Redirector action definition file for Cosminexus HTTP Server)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

Specify the key as follows:

key-name value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

Separate the key name and the value with a single-byte space. If you specify multiple values, separate them with single-byte spaces.

If the specified value contains a space in the file path, you need to enclose the entire path within double quotation marks ("").

The command coding methods and the formats for describing the types of characters that you can code must be compliant with Cosminexus HTTP Server specifications.

The key name is not case sensitive.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\web\redirector\mod_jk.conf

In UNIX
/opt/Cosminexus/CC/web/redirector/mod_jk.conf

(3) Functionality

Define the action of the redirector.

(4) Specifiable keys

Module definition
You define the library for processing the communication between the Web container server and the Cosminexus HTTP Server.

Format

LoadModule jk_module library-name

You specify the library name as an absolute path. You cannot specify multiple library names.

Examples of specification

In Windows

LoadModule jk_module

Cosminexus-installation-directory\CC\web\redirector\mod_jk.dll

In UNIX

LoadModule jk_module /opt/Cosminexus/CC/web/redirector/mod_jk.so

Precautions

You must code the key specifying the module definition before other keys.

Mapping definition
You define the URL pattern to be transferred to the Web container server through the request to Cosminexus HTTP Server.

Format

JkMount URL-pattern worker-name

Code any one worker out of those specified in the worker.list of the workers.properties. You can code multiple combinations of the URL pattern and worker name. If you set an invalid value in this file, the operations may not produce the desired results. If you specify a URL pattern which does not start with a slash (/), an error message is output in the log when the redirector starts and the specified content becomes ignored.

If you specify a URL pattern containing an extension with a length of 0 characters (when the URL pattern ends with /*.), the message KDJE41041-W is output to the log and the specified content is ignored.

For details on the JkMount key, see 4.4 Distributing requests using the round robin method, and 4.5 Distributing requests with the POST data size in the uCosminexus Application Server Web Container Functionality Guide.

Redirector definition
You can specify the following keys. If you specify an invalid value in these keys, the operations may not produce the desired results.

Key name
Contents
Default value

JkConnectTimeout
Specify the timeout value used for connecting to the Web container when a request is sent. Specify the timeout value as an integer (units: seconds) from 0 to 3600.
If you specify a non-numeric value, or a numeric value outside the range, a message will be output and the default value will be used.
If you set the timeout as 0 or a time period longer than the resend timer of data transmission in TCP, the timeout value becomes the timeout value of TCP. In such a case, a message indicating that an invalid timeout value has been specified will not be output.
30

JkGatewayHost
Specify the host name or the IP address of the gateway.
When requests without a Host header are redirected to files, such as the welcome file, the host name of the Location header URL becomes the specified value.
None

JkGatewayHttpsScheme
When a client request uses https as a scheme, and the scheme for a Web server will become http by using an SSL accelerator, specify On.
If On is specified, https is assumed to be used as the scheme for requests sent to the Web server. If you specify Off, no action occurs.
Off

JkGatewayPort
Specify the port number of the gateway. If a request has no Host header and the request is to be redirected to a location such as a welcome file, the port number portion of the URL that is specified in the Location header becomes the specified value.
Always specify this parameter together with JkGatewayHost.
If you specify JkGatewayHost and omit this parameter, an access via http uses 80, and an access via hppts uses 443.
None

JkLogFileDir
Specify the output location directory of the log file. In Windows, specify either as a relative path or as an absolute path. In UNIX, specify as an absolute path.

When specified as a relative path:

Specify a directory name present in Cosminexus-installation-directory\CC\web\redirector.

When specified as an absolute path:

Specify the coded directory name.

Note that you must specify write permission to the execution account of Cosminexus HTTP Server in the access permission to the directory specified as the output destination#1. If access permission is not set, the log file is not output.
If the same value has been specified in JkLogFilePrefix and JkTraceLogFilePrefix, you need to specify a value different from JkTraceLogFileDir in this key. If you specify the same value, the redirector will not run.

In Windows
logs

In UNIX
/opt/Cosminexus/CC/web/redirector/logs

JkLogFileNum
Specify the maximum number of redirector log files. If this number is exceeded, the old log files are overwritten. Specify an integer value in the following range:

In Windows
1 JkLogFileNum 16

In UNIX
1 JkLogFileNum 64

5

JkLogFilePrefix
This is a prefix for the log file name. The actual log file name will be the value specified by this key with serial-number.log added.
If the same value has been specified in JkLogFileDir and JkTraceLogFileDir, you need to specify a value different from JkTraceLogFilePrefix in this key. If you specify the same value, the redirector will not run.
hws_redirect

JkLogFileSize
Specify the size for each redirector log file in bytes. Specify an integer value in the following range:

In Windows
4096 JkLogFileSize 2147483647​

In UNIX
4096 JkLogFileSize 16777216​

4194304​

JkLogLevel
Specify the output level of redirector log files. You specify only one log level. You can specify debug, info, error (default value), and emerg. You can specify emerg only in Windows.
If you specify a value other than those specified above, the operation will be carried out assuming that error has been specified.
error

JkModulePriority
When registering an external module other than the redirector in the Cosminexus HTTP Server, specify the execution order of the redirector for the other external modules.
The values that can be specified are as follows:

Integers from -10 to 30

REALLY_FIRST (corresponds to integer value -10)

FIRST (corresponds to integer value 0)

MIDDLE (corresponds to integer value 10)

LAST (corresponds to integer value 20)

REALLY_LAST (corresponds to integer value 30)

Smaller the value specified, higher the position in the execution order.
FIRST

JkOptions
Specify whether to decode the requested URL. Note that this key is used for UNIX.

ForwardURICompatUnparsed (default):

Do not decode the requested URL.

ForwardURICompat:

Decode the requested URL.

URL decoding was performed in version 02-00, therefore, when using URLs containing character strings that are converted due to URL decoding, specify ForwardURICompat only when URL decoding needs to be performed as in the case of version 02-00.
ForwardURICompatUnparsed

JkPrfId
Specify the character string that was specified in the PRF identifier when invoking the PRF daemon.
None

JkRequestRetryCount
Specify an integer (units: number of times) from 1 to 16 for the retry count to connect to the Web container when a request is sent and the retry count to send requests.
The retry count also includes the first establishment of connection and the request sending process.
When a timeout occurs, retry occurs in the following cases:

When a timeout occurs while connection is being established

When a timeout occurs while the request header is being sent

After the above processes, if a timeout occurs while the request body is being sent, retry does not occur.
If you set the retry count to an abnormal value, such as a value outside the range or a value that is not an integer, the default value is set.
3

JkSendTimeout
Specify an integer (units: seconds) from 0 to 3600 for the timeout period for sending requests.
If you specify a non-numeric value, or a numeric value outside the range, a message will be output and the default value will be used.
If you set the timeout as 0 or a time period longer than the resend timer of data transmission in TCP, the timeout value becomes the timeout value of TCP. In such a case, a message indicating that an invalid timeout value has been specified will not be output.
100

JkTraceLog
Specify whether to output the trace log for the maintenance of redirector. Specify On (default value) if trace log is to be output and Off if it is not to be output.
On

JkTraceLogFileDir
Specify the output destination directory for the maintenance trace log files. In Windows, specify either as a relative path or as an absolute path. In UNIX, specify as an absolute path.

When coded as a relative path:

Specify a directory name present in Cosminexus-installation-directory\CC\web\redirector.

When coded as an absolute path:

Specify the coded directory name.

If the same value has been specified in JkLogFilePrefix and JkTraceLogFilePrefix, you need to specify a value different from JkLogFileDir in this key. If you specify the same value, the redirector will not run.

In Windows
logs

In UNIX
/opt/Cosminexus/CC/web/redirector/logs

JkTraceLogFileNum
Specify the maximum number of maintenance trace log files.

In Windows
1 to 16

In UNIX

1 to 64
If this number is exceeded, the old log files are overwritten.
4

JkTraceLogFilePrefix
Specify the prefix for the maintenance trace log file name. The actual log file name will be the value specified by this key with serial-number.log added.
If the same value has been specified in JkLogFileDir and JkTraceLogFileDir, you need to specify a value different from JkLogFilePrefix in this key. If you specify the same value, the redirector will not run.
hws_rd_trace

JkTraceLogFileSize
Specify the size for each maintenance trace log file as an integer value (units: bytes).

In Windows

4096 to 2147483647​

In UNIX

4096 to 16777216​
16777216​

JkTranslateBackcompat
The key for compatibility with versions older than 05-05.
Specify whether the translate_handler function of the module executed after the redirector is to be invoked from the Cosminexus HTTP Server, if a request sent to the Cosminexus HTTP Server is a URL pattern transferred to the Web container.
If you specify On, the translate_handler function of the module executed after the redirector is invoked.
If you specify Off, the translate_handler function of the module executed after the redirector is not invoked.
Off

JkWorkersFile
Specify the file name of the worker definition file. In Windows, specify either as a relative path or as an absolute path. In UNIX, specify as an absolute path.

When specified as a relative path:

Specify a file name present in Cosminexus-installation-directory\CC\web\redirector.

When specified as an absolute path:

Specify the coded file name.

In Windows
workers.properties

In UNIX
/opt/Cosminexus/CC/web/redirector/workers.properties#2

Note:

When you specify multiple keys, the last specified value becomes valid.

#1

For integration with Cosminexus HTTP Server

For a new installation, the default log output destination directory does not exist. You either create a directory and grant the access permission or grant the access permission to the directory redirector that exists one level above.

Moreover, if the log output destination directory of the redirector is changed and only half of that path exists, you either grant the access permission to the lowest level of the existing directory or create the entire specified path, and then grant the access permission.

#2

If /opt/Cosminexus/CC/web/redirector/workers.properties does not exist, Cosminexus HTTP Server does not start.

(5) Examples of coding

In Windows

LoadModule jk_module "C:\Program Files\Hitachi\Cosminexus\CC\web\redirector\mod_jk.dll"#

JkGatewayHost hostA
JkGatewayHttpsScheme On
JkGatewayPort 443

JkLogLevel error
JkLogFileSize 4194304
JkLogFileNum 5
JkLogFileDir logs
JkLogFilePrefix hws_redirect
JkPrfId prfid
JkTraceLog On
JkTraceLogFileSize 16777216
JkTraceLogFileNum 4
JkTraceLogFileDir logs
JkTraceLogFilePrefix hws_rd_trace
JkTranslateBackcompat Off
JkWorkersFile workers.properties

JkMount /examples/* worker1

#:

Specify LoadModule in one line in the file.

In UNIX

LoadModule jk_module /opt/Cosminexus/CC/web/redirector/mod_jk.so
JkWorkersFile /opt/Cosminexus/CC/web/redirector/workers.properties

JkLogLevel error
JkLogFileSize 4194304
JkLogFileNum 5
JkLogFileDir /opt/Cosminexus/CC/web/redirector/logs
JkLogFilePrefix hws_redirect

JkTraceLog On
JkTraceLogFileSize 16777216
JkTraceLogFileNum 4
JkTraceLogFileDir /opt/Cosminexus/CC/web/redirector/logs
JkTraceLogFilePrefix hws_rd_trace

JkMount /examples/* worker1

(6) Precautions

In Windows, you need to restart the Web server to change the user definition of the redirector. The changed definition will be applied after the Web server is restarted.

In UNIX, you need to perform the following operations to apply the changed contents once the user definition of the redirector is changed:

When you change the file size or the number of files:

Stop the Web server.

Either move or delete the log files and the management file used by HNTRLib.
<Management file used by HNTRLib>
In the case of message log file: JkLogFilePrefix-settings.mm
In the case of maintenance trace log file: JkTraceLogFilePrefix-settings.mm

Start the Web server.

Note that the default storage location of management files used in HNTRLib is as follows:

Cosminexus-installation-directory/CC/web/redirector/logs/mmap

When you do not change the file size or the number of files:

Restart the Web server.

9.4 uriworkermap.properties (Mapping definition file for Microsoft IIS)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored. The parameters not defined as valid key names are also ignored even if defined in the action definition file.

Up to 1023 characters are valid as key-name=value. The part exceeding this number is truncated.

(2) File storage location

Cosminexus-installation-directory\CC\web\redirector\uriworkermap.properties

(3) Functionality

This mapping definition file defines the URL pattern to be transferred to the Web container server through the request to Microsoft IIS.

(4) Specifiable keys

Code any one worker out of those specified in the worker.list of the workers.properties. You can code multiple combinations of the URL pattern and worker name. If you set an invalid value in this file, the operations may not produce the desired results. If you specify a URL pattern which does not start with a slash (/), an error message is output in the log when the redirector starts and the specified content becomes ignored.

If you specify a URL pattern containing an extension with a length of 0 characters (when the URL pattern ends with /*.), the message KDJE41041-W is output to the log and the specified content is ignored.

URL-pattern=worker-name

(5) Examples of coding

/examples/*=worker1

(6) Precautions

If you change the user definition of the redirector, you will need to restart the Web server. The changed definition will be applied after the Web server is restarted.

9.5 workers.properties (Worker definition file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored. The parameters not defined as valid key names are also ignored even if defined in the action definition file.

Up to 1023 characters are valid as key-name=value. The part exceeding this number is truncated.

Single-byte alphanumeric characters, underscores (_), and hyphens (-) can be used in the worker name. The operations cannot be guaranteed if you specify other characters.

(2) File storage location

In Windows
Cosminexus-installation-directory\CC\web\redirector\workers.properties

In UNIX
/opt/Cosminexus/CC/web/redirector/workers.properties

(3) Functionality

The worker definition file defines the workers, sets the parameters for each worker, and defines the actions of the redirector.

(4) Specifiable keys

The keys that you can specify in the worker definition file and the parameters defined for each worker are explained below:

(a) Keys specifiable in the worker definition file

These keys define workers, and the parameters for each worker. If an invalid value is specified for this key, the operations might not execute properly.

Key name
Contents
Default value

worker.list
Specify the list of worker names. In the case of multiple names, demarcate with a comma (,). You need to specify at least one worker name.
Specify the worker name specified in mod_jk.conf (redirector action definition file for HTTP Server), or uriworkermap.properties (mapping definition file for Microsoft IIS).
None

worker.worker-name.parameter
Specify the parameters defined for each worker. Set the parameters for each worker coded in worker.list.
For details on the defined parameters, see (b) Parameters defined for each worker.
None

(b) Parameters defined for each worker

Parameters that you can define
Contents
Default value

worker.worker-name.balanced_workers
Specify the list of workers for which load balancing is to be performed. In the case of multiple names, demarcate with a comma (,).
None

worker.worker-name.cachesize
Specify an integer value from 1 to 2147483647​ for the number of connections to the workers re-used in the redirector. Note that this parameter is used in Windows.
If the number of connections to the workers is within this set value, the connections are maintained in the redirector, re-used during the communication with the applicable worker, and are not released until the J2EE server or the Web container server that is connected is shut down. If the multiplicity of requests exceeds the set value, for only those requests that exceed the set value, establish and release connections to workers for each request.
This value uses up memory as per the following formula:
(Expression)
Memory used up = (worker.worker-name.cachesize value) 10KB
64

worker.worker-name.default_worker
Specify worker name of the default worker. If you specify a worker same as the worker specified in the POST request transfer destination worker, the requests satisfying the distribution conditions as per the POST data size and requests satisfying the conditions for the default worker are transferred to the specified worker.
Note that if you specify a worker that is not specified in the POST request transfer destination worker in this parameter, and if worker.worker-name.post_data is specified in that worker, the definition of worker.worker-name.post_data is ignored.
The null characters (space, tab, or form feed) before and after the worker name are ignored.
If you omit this parameter or specify a null string, an error is returned for the request for which a worker satisfying the transfer conditions does not exist.
None

worker.worker-name.delegate_error_code
Specify the error status code that uses the delegation functionality of the error page. # If you want to specify multiple worker names, demarcate with a comma (,).
None

worker.worker-name.host
Specify the host name or the IP address of the worker.
None

worker.worker-name.lbfactor
Specifies the load balancing value of a request. Set a value greater than 0. You can also specify a decimal value.
1

worker.worker-name.port
Specify an integer value from 1 to 65535 for the worker port number.
You cannot specify a port number that is already being used or secured for another application.
None

worker.worker-name.post_data
Specify a value adding 1 to the maximum value of the Content-Length header value for the requests to be transferred to the worker specified in worker-name as follows:

An integer value from 1 to 2147483648​ (unit: bytes)

Value adding k or K to an integer value from 1 to 2097152​ (units: kilobytes)

Value adding m or M to an integer value from 1 to 2048 (units: megabytes)

The requests in which the value of the Content-Length header is lesser than the specified value is transferred to a worker specified in worker-name.
If multiple workers are specified in the worker.worker-name.post_size_workers parameter, the request is transferred to a worker in which the request Content-Length header value is lesser than the specified value, and in which the value is the smallest specified value.
If you specify the value in the worker.POST-request-distribution-worker's- worker-name.post_size_workers parameter, do not specify the same value as the other workers.
The null characters (space, tab, or form feed) before and after the value are ignored.
None

worker.worker-name.post_size_workers
Specify the list of worker names of the POST request transfer destination workers. If you want to specify multiple worker names, demarcate with a comma (,). You cannot specify the same worker name.
The null characters (space, tab, or form feed) before and after the worker name are ignored.
None

worker.worker-name.receive_timeout
Specify the communication timeout value. Specify an integer value (units: seconds) from 0 to 3600 for the time period to await the response data. If you specify 0, the system continues to wait until a response is received and a communication timeout does not occur.
3600

worker.worker-name.type
Specify the worker type from the types shown below. For details on the parameters that you can set in each type, see (c) Parameters defined for each worker.worker-name.type. You need to specify these parameters for each worker.

ajp13:

This worker transfers requests to the Web container server running by an external process.

ajp12:

This worker maintains compatibility with older versions. This worker runs assuming that ajp13 is specified.

lb:

This worker has the load balancing functionality based on the round robin process.

post_size_lb:

This is a POST request distribution worker. You can use this worker only when you use Cosminexus HTTP Server.

None

#1

The specifiable codes are mentioned in comments. Remove the comments if required.

#2

You can also specify the host name and port number of the same Web container for multiple workers.

(c) Parameters defined for each worker.worker-name.type

Parameters that you can define | Worker types
ajp13 | lb | post_size_lb
worker.worker-name.balanced_workers | N | Y | N
worker.worker-name.cachesize#1 | O | N | N
worker.worker-name.default_worker | N | N | O
worker.worker-name.delegate_error_code | O | N | N
worker.worker-name.host | Y | N | N
worker.worker-name.lbfactor | O | N | N
worker.worker-name.port | Y | N | N
worker. worker-name.post_data | N/Y#² | N | N
worker. worker-name.post_size_workers | N | N | Y
worker. worker-name.receive_timeout | O | N | N

Legend:

Y: Always specify.

O: Specification is optional.

N: Cannot be specified.

Notes

The parameters that you can specify in ajp12 are same as in ajp13.

In UNIX, if you do not specify a value for the mandatory items or if the specified value is invalid, the Cosminexus HTTP Server does not start.

#1

Valid only in Windows. In UNIX, the parameter is ignored.

#2

Mandatory for the POST request transfer destination worker.

(5) Examples of coding

worker.list=worker1
worker.worker1.port=8007
worker.worker1.host=localhost
worker.worker1.type=ajp13
#worker.worker1.cachesize=64
#worker.worker1.receive_timeout=3600
#worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510

#----------------------------------------------------------------
# Example setting for Loadbalancer.
#----------------------------------------------------------------
#worker.list=loadbalancer1
#
#worker.loadbalancer1.type=lb
#worker.loadbalancer1.balanced_workers=worker1,worker2
#
#worker.worker1.port=8007
#worker.worker1.host=host1
#worker.worker1.type=ajp13
#worker.worker1.cachesize=64
#worker.worker1.lbfactor=1
#worker.worker1.receive_timeout=3600
#worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510

#
#worker.worker2.port=8007
#worker.worker2.host=host2
#worker.worker2.type=ajp13
#worker.worker2.cachesize=64
#worker.worker2.lbfactor=1
#worker.worker2.receive_timeout=3600
#worker.worker2.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510
#----------------------------------------------------------------
# Example setting for post data size based worker.
#----------------------------------------------------------------
#worker.list=postsizelb1#worker.postsizelb1.type=post_size_lb
#worker.postsizelb1.post_size_workers=worker1,worker2
#worker.postsizelb1.default_worker=worker1
#
#worker.worker1.port=8007
#worker.worker1.host=host1
#worker.worker1.type=ajp13
#worker.worker1.post_data=100m
#worker.worker1.receive_timeout=3600
#worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510
#
#worker.worker2.port=8007
#worker.worker2.host=host2
#worker.worker2.type=ajp13
#worker.worker2.post_data=2048m
#worker.worker2.receive_timeout=3600
#worker.worker2.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510

(6) Precautions

If you change the user definition of the redirector by editing this file, you will need to restart the Web server. The changed definition will be applied after the Web server is restarted.

10. Files Used with Cosminexus Manager

This chapter describes the storage location, functionality and format of the files used with Cosminexus Manager and the keys that you can specify in the files.

Organization of this chapter

10.1 List of files used with Cosminexus Manager

10.2 adminagent.properties (Administration Agent property file)

10.3 AdminAgentrc (Setup file for automatic start of Administration Agent)

10.4 adminagentuser.cfg (Option definition file for Administration Agent )

10.5 adminagent.xml (Administration Agent settings file)

10.6 mngagent.actual-server-name.properties (Management Agent property file)

10.7 mserver.properties (Management Server environment settings file)

10.8 mserver.cfg (Management Server option definition file)

10.9 mserverenv.cfg (Management Server environment variable definition file)

10.10 manager.cfg (Manager settings file)

10.11 maction.properties (Property file for execution of Management actions)

10.12 Property file for issuing Management events

10.13 Message ID list file for issuing Management events

10.14 Definition files to be saved for the Management Server management files

10.15 .mngsvrutilrc (Client-side definition file of the mngsvrutil command)

10.16 mngsvrutil.properties (Server-side definition file of the mngsvrutil command)

10.17 mngsvrutilcl.properties (Client-side shared definition file of the mngsvrutil command)

10.18 .mngsvrmonitorrc (Settings file of the monitor startup command for JP1/IM integration)

10.19 System log message mapping file for JP1/IM integration

10.20 setup.cfg (Setup file for the Setup Wizard)

10.21 Logical user server definition file

10.1 List of files used with Cosminexus Manager

The following table lists the files used with Cosminexus Manager:

Table 10-1 List of files used with Cosminexus Manager

File name
Classification
Overview
Reference

adminagent.properties
Administration Agent property file
Specify the settings related to the Administration agent.
10.2

AdminAgentrc
Setup file for automatic start of Administration Agent
Specify the settings for automatic start of Administration Agent.
Only Windows and Linux are the target OSs.
10.3

adminagentuser.cfg
Option definition file for Administration Agent
Specify the invocation options for the JavaVM that executes the Administration Agent.
10.4

adminagent.xml
Administration Agent settings file
Specify the settings for starting up the logical server or updating the settings files on behalf of the system administrator.
10.5

mngagent.actual-server-name.properties
Management Agent property file
Specify the settings for defining the operations of the Management Agent.
10.6

mserver.properties
Management Server environment settings file
Specify the settings for the port number used by the Management Server.
10.7

mserver.cfg
Management Server option definition file
Specify the system properties for the Management Server.
10.8

mserverenv.cfg
Management Server environment variable definition file
Set the environment variables for operating the Management Server.
10.9

manager.cfg
Manager settings file
Specify the shared Manager settings.
10.10

maction.properties
Property file for execution of Management actions
Define the Management action corresponding to the message ID reported in the Management event.
10.11

(Optional)
Property file for issuing Management events
Define the operations for issuing Management events.
10.12

(Optional)
Message ID list file for issuing Management events
Define the message IDs that are reported as Management events.
10.13

(Optional)
Backup scope definition file for the Management Server management files
Define the target file saved with the mstrexport command.
10.14

.mngsvrutilrc
Client-side definition file of the mngsvrutil command
Specify the default values for the mngsvrutil command options.
10.15

mngsvrutil.properties
Server-side definition file of the mngsvrutil command
Specify the settings for the execution environment of the mngsvrutil command.
10.16

mngsvrutilcl.properties
Client-side shared definition file of the mngsvrutil command
Specify the shared definition settings for the default values of the mngsvrutil command options.
10.17

.mngsvrmonitorrc
Settings file of the monitor startup command for JP1/IM integration
In the case of integrating with JP1/IM, specify the settings required for starting up the Management Server operation portal from the JP1/IM screen.
This file is for Windows.
10.18

mserver.jp1event.system.mapping.properties

manager.jp1event.system.mapping.properties

manager.logical-server-name.jp1event.system.mapping.properties

System log message mapping file for JP1/IM integration
Define the mapping between the Cosminexus system messages and the criticality of JP1 events.
10.19

setup.cfg
Setup file for the Setup Wizard
Specifies the Setup Wizard-related settings.
10.20

(Optional)
Logical user server definition file of the mngsvrutil command
Define the contents of the logical user server to be added.
10.21

10.2 adminagent.properties (Administration Agent property file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(1) Format

J2SE property file format.

The adminagent.properties is a property file of the Administration Agent.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Specify the settings related to the Administration agent.

(4) Specifiable keys

The specifiable keys and default values are described below. Note that "Default" refers to the value or operation assumed when the key is not specified. "VR" refers to the Application Server version introduced or changed by the key.

Key name
Contents
Specifiable value
Default value
VR

{adminagent.adapter.allowedHosts
Specify a host name or an IP address that can access to the server.
To specify multiple IP addresses, demarcate using commas (,) and you do not insert any spaces. You can specify the IP address as a regular expression using meta characters. When an IP address is specified as a regular expression, the Administration Agent uses an available local IP address that matches the expression. If multiple IP addresses exist, all the IP addresses that match the expression will be granted the access permission.
Note that when you specify an IP address as a regular expression, you cannot specify multiple values using commas (,).
The values that can be specified are as follows:

Host name

IPv4 address

None
05-05

adminagent.adapter.bind_host
Specify the host name or the IP address that will be used for communicating with the Administration Agent. You can choose any of the IP addresses for communication, when using Administration Agent on a host that has multiple physical network interfaces or a host that has multiple logical IP addresses assigned for a single physical network interface.
If an invalid value is specified, the Administration Agent will terminate abnormally.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the Administration Agent uses an available local IP address that matches the expression.#1
The values that can be specified are as follows:

Host name

IPv4 address

None
06-00

adminagent.adapter.port
Specify port numbers used by the server functionality.
Specify the value using an integer from 1 to 65535.
20295
05-05

adminagent.cluster.localaddress.check
Specify whether to stop the standby node during node switching in the Application Server.
During node switching in the Application Server, if the logical server and Administration Agent in the standby node are not stopped, this key will stop the logical server and Administration Agent.

If you specify true:

The running logical server and Administration Agent in the standby node are stopped during the node switching in the Application Server.

The local address is checked and if the cluster IP address is not specified, the logical server will be stopped and then the Administration Agent will be stopped.

If you specify false:

The running logical server and Administration Agent in the standby node are not stopped during the node switching in the Application Server.

Specify one of the following values:

true

false

false
07-10

adminagent.finalization.stop_servers
Specify whether to stop the logical server when the Administration Agent terminates.

If you specify true:

All the logical servers will be stopped in the Administration Agent termination processing.

If you specify false:

The logical servers will not be stopped in the Administration Agent termination processing.

Specify one of the following values:

true

false

false
06-50

adminagent.forcestop.threaddump
Specify whether to output the thread dump when the J2EE server and the SFO server are terminated forcefully. J2EE servers and SFO servers are the only logical servers to which the above setting are applicable.

If you specify true:

Thread dump will be output. In such cases, the forced termination processing is same as the case when the cjstopsv command is executed with the -fd option.#2

If you specify false:

Thread dump will not be output.

Specify one of the following values:

true

false

false
06-50

adminagent.forcestop.threaddump.interval
Specify an integer from 1 to 2147483647​ (unit: seconds) for the interval to confirm the completion of thread dump output, when settings are specified to output thread dump during the forced termination of the J2EE server and the SFO server.
When the value outside the range of 1 to 2147483647​ is specified, the default value will be set.
Specify the value using an integer from 1 to 2147483647​.
1
06-50

adminagent.forcestop.threaddump.timeout
Specify an integer from -1 to 2147483647​ (Unit: seconds) for the thread dump output waiting time, when Do not monitor is set for Forced stop monitoring time for the J2EE server and the SFO server settings.
When you specify -1, the completion of thread dump output is awaited.
When you specify the value outside the range of -1 to 2147483647​, the default value will be set.
If the thread dump process does not complete even after the specified time has elapsed, the J2EE server and the SFO server are terminated forcefully.#2
Specify the value using an integer from -1 to 2147483647​.
45
06-50

adminagent.hws.group
When using Cosminexus HTTP Server, specify the group name of the user starting Cosminexus HTTP Server.
When omitted, start with the group name of the Administration Agent.
This key is for UNIX.#3
Group name
None
08-00

adminagent.hws.owner
When using Cosminexus HTTP Server, specify the name of the user starting Cosminexus HTTP Server.
When omitted, start with the user name of the administration agent.
Note that this key is used for UNIX. #3
User name
None
08-00

adminagent.hws.sys_cmd.abnormal_end.traceinfo
Specify whether to collect the Web server internal trace, when executing the command for error detection.

If you specify true:

The internal trace will be collected.

If you specify false:

The internal trace will not be collected.

Specify one of the following values:

true

false

true
07-00

adminagent.hws.watch.method
Specify the HTTP method for checking the operation of Cosminexus HTTP Server when 2 is specified in adminagent.hws.watch.level. For the specifiable method, you can specify either "HEAD" or "OPTIONS". #4

If you specify "HEAD":

Accesses the URL specified in the key adminagent.hws.watch.url and checks whether returns any response.

If you specify "OPTIONS":

Checks whether the Web server can receive HTTP methods.

If "/*" is specified in the URL pattern to be mapped to the redirector, all the URLs will be redirected to the Web container of the J2EE server. Therefore, when specifying "/*" in the URL pattern to be mapped to the redirector, Hitachi recommends that you specify "OPTIONS" and do not access the URL.
Specify one of the following values:

HEAD

OPTIONS

HEAD#⁵
06-50

adminagent.hws.watch.url
Specify the URL for confirming the operations of Cosminexus HTTP Server, when "HEAD" is specified in adminagent.hws.watch.method. The Administrator Agent will determine the status of Hitachi Web Server from the response of this URL, so specify a URL that is actually accessible. Note that you specify the URL as an absolute path starting with "http" or as a relative path from the root context. When building multiple Web servers on the same host, specify the URL as a relative path.

(Example of specification)

When you specify http://HostA:80/index.html:

adminagent.hws.watch.url=http://HostA:80/index.html

When you specify http://localhost:port-nmber/index.html (in a multiple server configuration):

adminagent.hws.watch.url=index.html

URL
Root context (http://localhost:port-number/)
06-00

adminagent.j2ee.process.console_event.enabled
Specify whether to display the console output information of the J2EE server to the Eclipse Plug-in using Management Server.

If you specify true:

The console output information will be output to the Eclipse Plug-in using Management Server.

If you specify false:

The console output information will not be output to the Eclipse Plug-in using Management Server.

The key adminagent.process.consolelog.enabled must be set to true.
Since this consumes resources, Hitachi recommends that the key be set to false in operations that do not use Eclipse Plug-ins using Management Server.
Specify one of the following values:

true

false

false
07-10

adminagent.j2ee.process.console_log.enabled
Specify whether to output the console output information for the J2EE server in the console log.

If you specify true:

The console output information will be output to the console log.

If you specify false:

The console output information will not be output to the console log.

The key adminagent.process.consolelog.enabled must be set to true.
Specify one of the following values:

true

false

false
07-10

adminagent.j2ee.sys_cmd.abnormal_end.javatrace
Specify whether to acquire J2EE server stack trace when executing the command for error detection.

If you specify true:

The stack trace will be acquired.

If you specify false:

The stack trace will not be acquired.

Specify one of the following values:

true

false

true
07-00

adminagent.j2ee.sys_cmd.abnormal_end.threaddump
Specify whether to collect the J2EE server thread dump when executing the command for error detection.

If you specify true:

The J2EE server thread dump will be collected.

If you specify false:

The J2EE server thread dump will not be collected.

Specify one of the following values:

true

false

true
06-50

adminagent.jp1event.event_server_name
Specify a value same as the address set for the ports key in the event server settings file (conf) of the JP1/Base event service that is being used. If multiple addresses are specified for the ports key, choose any one of the specified addresses. When using an event service that has the value '0.0.0.0' (default value) specified for the ports key address, either omit this key or specify the host name of the local machine or localhost.
Host name or IPv4 dotted notation
localhost
06-70

adminagent.jp1event_enabled
Specify whether JP1 events will be issued from the Administration Agent.

If you specify true:

JP1 events will be issued.

If you specify false:

JP1 events will not be issued.

Specify one of the following values:

true

false

false
06-70

adminagent.log.filenum
Specify an integer from 1 to 16 for the number of log files.
Specify the value using an integer from 1 to 16.
4
05-05

adminagent.log.filesize
Specify a numeric value from 65536 to 2147483647​ for the maximum size of each log file (units: bytes).
Specify the value using an integer from 65536 to 2147483647​.
65536
05-05

adminagent.log.level
Specify an integer from -1 to 1000 for the level of log output.

-1: No log will be output.

0: Normal operation: Normal operation.

10: Normal operation (verbose): same as normal operation, waiting for recurrence.

20: Recurrence test: Acquires debug level information used in the system environment setup or test phases.

30: Error investigation: Suitable for acquiring detailed error information for errors that are difficult to investigate.

Specify the value using an integer from -1 to 1000.
0
05-05

adminagent.lsinfo_dir
Specify the directory where the logical server information file will be output. If the specified directory does not exist, create it.
When you restart the Administration Agent, the Administration Agent will use this information to once again manage the logical servers being managed before the Administration Agent stops and make them operable. This directory is created when starting the logical server and is deleted after the logical server has stopped.
Directory name (absolute path)
Manager-installation-directory/spool/lsinfo
06-50

adminagent.maintenance.log.filenum
Specify an integer from 1 to 16 for the number of maintenance log files.
Specify the value using an integer from 1 to 16.
4
06-70

adminagent.maintenance.log.filesize
Specify an integer from 65536 to 2147483647​ for the maximum size of each maintenance log file (units: bytes).
Specify the value using an integer from 65536 to 2147483647​.
16777216​
06-70

adminagent.prftrace_dir
Specify a character string for the path name of the directory to which the trace based performance analysis file is temporarily output. If no directory is specified, the specified directory is created.

Note:

The trace based performance analysis file is temporarily output in the following cases:

When the system error detection command is executed due to the abnormal termination of the logical server

When the snapshot log is collected by specifying the sub-command collect of the Management Server management command (mngsvrutil)

When the snapshot log is collected with the management portal

Therefore, allocate free space at the output destination based on the following formula: File size output at the specification destination (maximum value) = PRF-trace-size (value specified for PrfTraceFileSize) number-of-PRF-trace-files (value specified for PrfTraceCount)

Note that if multiple PRFs exist on the same host, the sum of size of all the PRF trace files is used.

Directory name (Absolute path)
Application-Server-installation-directory/manager/tmp/
09-50

adminagent.process.consolelog.enabled
Specify whether to acquire the console output information for the processes invoked by the Administration Agent. However, when using the Eclipse Plug-in that uses Management Server, you must specify true as the value for this key.

If you specify true:

The console output information will be acquired.

If you specify false:

The console output information will not be acquired.

Specify one of the following values:

true

false

true
07-00

adminagent.process.consolelog.event.queue_size
Specify the event queue size for the event notification to the Management Server from the console output information for the processes invoked by the Administration Agent.
If the queue becomes full, the events are destroyed from the oldest event in the queue.
Hitachi recommends that you specify a default value for this property; and therefore, do not change the settings.
Specify the value using an integer from 1024 to 2147483647​.
1024
07-00

adminagent.process.consolelog.filenum
Specify an integer from 1 to 16 as the number of log files output for the console output information of the processes invoked by the Administration Agent.
If the shift mode is specified in the sinaviagent.log.style key, this number becomes the number of backup files.
Specify the value using an integer from 1 to 16.
4
07-00

adminagent.process.consolelog.filesize
Specify an integer from 65536 to 2147483647​ as the maximum size (unit: bytes) of each log file output for the console output information of the processes invoked by the Administration Agent.
Specify the value using an integer from 65536 to 2147483647​.
65536
07-00

adminagent.process.consolelog.time
Specifies the time for rotating the log files used to output the console output information of the processes started by the Administration Agent in HHMMSS format as a value from 000000 to 235959. However, if the log file size reaches the upper limit before the time set in this property is reached, the log file will be rotated at that point.
If no time is specified, the files will be rotated based only on the log size.
Specify a value from 000000 to 235959 in the HHMMSS format.
None
09-00

c
Specifies the method of rotating the log files that output the console output information of the processes started by the Administration Agent.

If you specify SHIFT:

The log file will be rotated in the shift mode.

If you specify WRAP:

The log file will be rotated in the wraparound mode.

Specify one of the following values:

SHIFT

WRAP

WRAP
09-00

adminagent.rmi.log.filenum
Specify a numeric value for the number of maintenance log files in the RMI processing performed by the Administration Agent.
Specify the value using an integer from 1 to 16.
8
07-60

adminagent.rmi.log.filesize
Specify a numeric value for the maximum size of each maintenance log file in the RMI processing performed by the Administration Agent.
Specify the value using an integer from 65536 to 2147483647​.
16777216​
07-60

adminagent.rmi.log.level
Specify a character string for the output level of the maintenance log in the RMI processing performed by the Administration Agent.

<OFF>

The output level will not be output.

<SEVERE>, <WARNING>, <INFO>, <CONFIG>, <FINE>, <FINER>, <FINEST>

SEVERE only outputs severe problems. The order described here results in more detailed log output.

Specify one of the following values:

OFF

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

FINER
07-60

adminagent.snapshotlog.listfile.2.num_snapshots
Specify a numeric value from -2147483648​ to 2147483647​ as the number of snapshot log files that will be acquired as the secondary data for each logical server. If exceeds the specified file count, the log files with the oldest creation time are deleted sequentially. Also, if you specify a value not more than 0, the log files are not deleted.
Specify the value using an integer from -2147483648​ to 2147483647​.
10
06-50

adminagent.snapshotlog.log_dir
Specify a character string for the directory to output the snapshot log. If the specified directory does not exist, the directory will be created.
Directory name (absolute path)
com.cosminexus.manager.log.dir-of-manager.cfg/snapshot/
06-00

adminagent.snapshotlog.num_snapshots
Specify a numeric value from -2147483648​ to 2147483647​ as the number of snapshot log files that will be acquired as the primary data for each logical server. If exceeds the specified file count, the log files with the oldest creation time are deleted sequentially. Also, if you specify a value not more than 0, the log files are not deleted.
Specify the value using an integer from -2147483648​ to 2147483647​.
10
06-00

adminagent.sys_cmd.abnormal_end.prftrace
Specify whether to collect the performance analysis trace files when executing the command for error detection.

If you specify true:

The performance analysis trace files will be collected.

If you specify false:

The performance analysis trace files will not be collected.

Specify one of the following values:

true

false

true
06-50

adminagent.userserver.process.console_event.enabled
Specify whether to display the console output information of the user server with the Eclipse Plug-in using Management Server.

If you specify true:

The console output information will be output to the Eclipse Plug-in using Management Server.

If you specify false:

The console output information will not be output to the Eclipse Plug-in using Management Server.

The key adminagent.process.consolelog.enabled must be set to true.
Since this consumes resources, Hitachi recommends that the key be set to false in operations that do not use Eclipse Plug-ins using Management Server.
Specify one of the following values:

true

false

false
07-10

adminagent.userserver.process.console_log.enabled
Specify whether the console output information for the user-defined server will be output to the console log.

If you specify true:

The console output information will be output to the console log.

If you specify false:

The console output information will not be output to the console log.

The key adminagent.process.consolelog.enabled must be set to true.
Specify one of the following values:

true

false

false
07-10

adminagent.watch.retry_timeout.enabled
Specify whether retry is performed for the occurrence of a timeout during the confirmation of the logical server operations.

If you specify true:

Retry performed for occurrence of the timeout.

If you specify false:

Retry is not performed for occurrence of the timeout.

Specify one of the following values:

true

false

Default: false

Initial value: true

06-70

adminagent.server-type#6.usr_cmd.abnormal_end
Specify the command for error detection using the absolute path. Use "/" as a file separator. You can change the command according to the type of the logical server where the error has occurred. If you specify the value that cannot be specified in server-type#6, the value will be ignored.

In Windows:

When you create a command for error detection using a batch file, you must add "%{ComSpec} /C" before the command name. "%{ComSpec}" is replaced with the absolute path of cmd.exe. If "%{ComSpec} /C" is not specified, the command might not execute normally. Also, when you include one-byte spaces in the command path, make sure that you enclose the absolute path of the command in double quotations ("").

Example: If executing d:/my bat/j2eeabnormalend.bat, when an error occurs in the J2EE server

adminagent.j2ee.usr_cmd.abnormal_end=%{ComSpec} /c "d:/my bat/j2eeabnormalend.bat"

In UNIX:

When you create a command for error detection using a shell script, you must add "/bin/sh" before the command name. If "/bin/sh" is not specified, the command might not execute normally.

Example: If executing /home/user1/j2eeabnormalend.sh, when an error occurs in the J2EE server

adminagent.j2ee.usr_cmd.abnormal_end=/bin/sh/home/user1/j2eeabnormalend.sh

Command name (absolute path)
None
06-50

adminagent.server-type#6.watch.interval
Specify an integer from 1 to 86400 as the interval (unit: seconds) for confirming the operations of the logical server.
If you specify an invalid value, the default value will be set.
Note that when the server type is user server, the watch-interval value specified in the Logical user server definition file or Easy Setup definition file becomes valid.
Specify the value using an integer from 1 to 86400.
10
06-00

adminagent.server-type#6.watch.level
Specify the logical server operation confirmation level. You can specify 1 or 2 as the value.

If you specify 1:

The logical server operations will be confirmed by checking whether the process exists.

If you specify 2:

The logical server operations will be confirmed by checking whether the process exists and the access to the logical server. The logical servers on which operations can be checked are naming services, SFO servers, J2EE servers, and Web servers. Even if you specify 2 for other logical servers, the operations will be performed only to check that the process exists.

Specify 1 or 2.

For Naming service, SFO server, J2EE server, and Web server: 2

For logical servers other than above: 1

06-00

adminagent.server-type#6.watch.retry_count
Specify an integer from 0 to 86400 as the retry count when the operation confirmation processing fails during the confirmation of logical server operations. By specifying the retry count, you can permit temporary operation confirmation failure.
Specify the retry interval using adminagent.server-type.watch.interval. If you specify 0, an error is assumed without retrying when the operation confirmation processing fails.
When the operation confirmation processing fails and when tried retrying, KEOS21033-W or KEOS21034-W is output to the Administration Agent log.
When the operation confirmation processing fails and when retry is not executed or if the retry count exceeds the specified count, KEOS20511-E or KEOS21035-E will be output to the Administration Agent log and the error will be notified to the Management Server.
Specify the value using an integer from 0 to 86400.
1
06-70

adminagent.server-type#6.watch.start_time
When starting the logical server, specify an integer from 0 to 86400 for the time (unit: seconds) starting from the execution of the start command up to starting the operation confirmation.
By acquiring the time required for actual startup from the logical server log for logical server startup (KDJE30028-I of cjmessage?.log for the J2EE server) and by specifying the value for this property which is few seconds shorter than this time, you can reduce the unnecessary log that is output before the logical server starts and report the complete startup of the logical server to the Management Server promptly.
Specify the value greater than the value specified in this property as the start monitoring time set up in the logical server start and stop functionality. If you specify the value lesser than the specified value, the logical server will fail to start.
Specify the value using an integer from 0 to 86400.
Depending on the server-type#6, the default value differs as follows:

prf: 0

smartagent: 3

naming: 10

ctmdm: 0

ctm: 0

ots: 0

tcs: 3

sfo: 45

j2ee: 45

hws: 0

06-70

adminagent.server-type#6.watch.timeout
Specify an integer from 1 to 9223372036854775​ (unit: seconds) for the time until timeout occurs during the confirmation of the logical server operations.
Specify the value using an integer from 1 to 9223372036854775​.
60
06-50

#1

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

However, as "\\" is replaced with the single character "\", when specifying "\", specify two characters in succession. If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

#2

To output the thread dump during a forced termination, specify adequate time to output the thread dump in the "forced termination monitoring time" or the adminagent.forcestop.threaddump.timeout key. If the specified time is lesser than the time required to complete the thread dump output, the thread dump output contents might be incomplete. Also, when using Dr. Watson, you do not specify 'Notify using a message box'. For details about Dr. Watson, see Microsoft home page.

#3

To set this property, execute the following operations:

Perform settings for executing operations by a general user account. For details about the settings for executing operations by a general user account, see Cosminexus HTTP Server.
Note that a resource owner or group of Cosminexus HTTP Server must be changed after executing the cmx_build_system command or after executing setup from the management portal.

Change the owner or group of the redirector log output destination (default is /opt/Cosminexus/CC/web/redirector/servers/<server name>/logs) to the user or group starting the specified Cosminexus HTTP Server.

#4

If /* is specified in the URL pattern to be mapped to the redirector, all the URLs will be redirected to the Web container of the J2EE server. Therefore, when specifying /* in the URL pattern to be mapped to the redirector, Hitachi recommends that you specify OPTIONS and do not access the URL.

#5

In the setup file of 06-50 or later versions, the line adminagent.hws.watch.method=OPTIONS is defined as the initial value. Therefore, the initial value of the HTTP method for confirming operations, used when upgrading from a version older than 06-50, is the default value HEAD. However, the initial value of the HTTP method for confirming operations, used for a new installation or when upgrading from 06-50 or a later version, is OPTIONS.

#6

Server-type references to the type of the logical server and includes any one of the following:

smartagent: Smart agent

j2ee: J2EE server

naming: Naming service

hws: Web server (Cosminexus HTTP Server)

ctm: CTM

ctmdm: CTM domain manager

prf: Performance tracer

sfo: SFO server

userserver: User server

10.3 AdminAgentrc (Setup file for automatic start of Administration Agent)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) Precautions

(1) Format

Codes the shell script in bash format.

(2) File storage location

/opt/Cosminexus/manager/config/

(3) Functionality

Specify the settings for automatic start of Administration Agent.

Settings of this file are inherited by the logical server starting from Administration Agent.

(4) Specifiable keys

Among the shell scripts in the bash format, you can code the following settings.

Resource control settings (ulimit)

Permissions for creating a file (umask)

Environment variable

When other settings are coded, the operations are not guaranteed.

(5) Examples of coding

ulimit -c unlimited

(6) Precautions

This file is executed as shell script, so if you change the coded contents, make sure that you sufficiently confirm the operation.

10.4 adminagentuser.cfg (Option definition file for Administration Agent )

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Precautions

(1) Format

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

You can specify up to 65535 bytes in one line.

If you define a line without a value, the line is ignored.

Specify the key with ASCII characters.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Specify the invocation options for the JavaVM that executes the Administration Agent.

The contents of this file become effective when this file exists and when this file can be read from the Administration Agent. If this file exists, but cannot be read from the Administration Agent, the startup of the Administration Agent fails.

If this file does not exist, the Administration Agent is started without specifying the options.

(4) Specifiable keys

The specifiable keys and default values are described below. If you specify invalid values in these keys, the startup of the Administration Agent fails.

Key name
Contents
Default value

add.class.path
Specify the values to be added in the class path.
To specify multiple values, use the same key names and specify the class path. In the contents, you can specify the Cosminexus installation directory as ${cosminexus.home}.
(Example of specification)
add.class.path=C:/home/lib/mylib.jar
None

add.jvm.arg
Specify the option for starting up the JavaVM.
You can specify the following JavaVM options:

-Xmssize

-Xmxsize

-XX:PermSize=size (08-00 or later)

-XX:MaxPermSize=size (08-00 or later)

-XX:[+|-]HitachiOutOfMemoryAbort (08-50 or later)

To specify multiple options, use same key names and specify as follows:
(Example of specification)
add.jvm.arg=-Xms128m
add.jvm.arg=-Xmx256m
An attempt to start the Administration Agent fails when you specify a value that JavaVM cannot authenticate.
None

add.library.path
Specify the values to be added in the search library path.
To specify multiple values, use the same key names and specify the search library path. In the contents, you can specify the Cosminexus installation directory as ${cosminexus.home}.
(Example of specification)
add.library.path=C:/home/bin
None

add.network.drive
Specify the name and directory path of the allocation destination of the drive allocated as the network drive.
(Example of specification)
X=\\host\dir
Note that if the path ends with \, you might not be able to connect to the network drive.
In UNIX, the KEOS21401-E message is output to /opt/Cosminexus/manager/adminagent.err and Administration Agent stops with end code 1.
None

(5) Precautions

If java.lang.OutOfMemoryError occurs in the Administration Agent, the maximum size of Java heap in this file will be extended as follows:

add.jvm.arg=-Xmx maximum-size-of-Java-heap

10.5 adminagent.xml (Administration Agent settings file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Logical server types that you can specify in the facility name

(5) Precautions

(1) Format

You specify the facility name (indicating the types and start/stop operations of the logical server) and then specify the name and value of the environment variable.

Setting the facility name:

<facility>
<name>Facility-name</name>  <class>com.cosminexus.mngsvr.adminagent.impl.CmdExecuter</class>

Setting the name and value of an environment variable:

Add the following coding after setting the facility name as mentioned above:

<init-param>
<param-name>adminagent.facility.CmdExecuter.env.Environment-variable-name</param-name>
<param-value>Environment-variable-value</param-value>
</init-param>

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Specify the settings for starting up the logical server or updating the settings files on behalf of the system administrator.

Edit this settings file when it is necessary to change the initial values of environment variables in this file or when it is necessary to add or delete the environment variables.

(4) Logical server types that you can specify in the facility name

The following table describes the types of logical servers and the start or stop operations that you can specify in the facility name:

Logical server type
Start or stop type
Facility name
Remarks

Performance tracer
Start
prf-start
--

Stop
prf-stop
--

Smart agent
(In Windows)
Start
osagent-start
--

Stop
osagent-stop
--

Smart agent
(In UNIX)
Start
osagent-start
--

Naming service
Start
naming-service-start
--

CTM domain manager
Start
ctm-dommng-start
--

Stop
ctm-dommng-stop
--

CTM
Start
ctm-start
--

Stop
ctm-stop
--

SFO server
Start
sfo-server-start
--

Stop
sfo-server-stop
--

J2EE server
Start
j2ee-server-start
When the J2EE server uses a database, you need to provide the database specific settings in the J2EE server start up environment variables.

Stop
j2ee-server-stop

WEB server
(In Windows)
Start
web-server-start
--

Stop
web-server-stop
--

WEB server
(In UNIX)
Start
web-server-start
--

Legend: --: None

(5) Precautions

When you change the adminagent.xml file, you need to re-start the Administration Agent.

When you start or stop any of the logical servers, the environment variables that are set at the startup of the Administration Agent are inherited. If you do not want to inherit the environment variables, set the corresponding environment variable to blank.

The environment variables set in adminagent.xml, apply to the types of logical servers started from the Administration Agent of the corresponding host. You cannot set environment variables for each instance of the logical server.

(Example 1)

When Japanese_japan.ja16sjis is set in the environment variable NLS_LANG during J2EE server startup:

<facility>

<name>j2ee-server-start</name>

<class>com.cosminexus.mngsvr.adminagent.impl.CmdExecuter</class>

<init-param>

<param-name>adminagent.facility.CmdExecuter.env.NLS_LANG</param-name>

<param-value>Japanese_japan.ja16sjis</param-value>

</init-param>

...

...

(Example 2)

When the environment variable AIXTHREAD_SCOPE, set during invocation of the Administration Agent, is not inherited:

<facility>

...

...

<init-param>

<param-name>adminagent.facility.CmdExecuter.env.AIXTHREAD_SCOPE</param-name>

<param-value></param-value>

</init-param>

...

...

The values specified for Environment-variable-name and Environment-variable-value are not processed as in the case of command shells, hence environment variable replacements and processing using operators is not possible. Therefore, you cannot use system environment variables while specifying Environment-variable-name and Environment-variable-value.

10.6 mngagent.actual-server-name.properties (Management Agent property file)

Organization of this section

(1) Format

(2) File storage location

(3) Keys that you can use for setting the names of Management domain and Management Agent

(4) Keys that you can use in log or trace settings

(5) Keys that you can use when you perform operation setup by specifying communication ports and IP addresses

(6) Precautions

(1) Format

The Management Agent property file has the J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Keys that you can use for setting the names of Management domain and Management Agent

The specifiable keys and default values are described below. The domain names and agent names set in these keys are used as the default value for log file name.

Key name | Contents | Default value
mngagent.domain_name | Specify a character string for the management domain name. You can use ASCII alphanumeric characters (A to Z, a to z, 0 to 9), under scores (_), and hyphens (-). | None
mngagent.agent_name | Specifies a character string as the logical server name of the applicable node. You can use ASCII alphanumeric characters (A to Z, a to z, 0 to 9), under scores (_), and hyphens (-). | None

(4) Keys that you can use in log or trace settings

The specifiable keys and default values are described below.

Key name
Contents
Default value

mngagent.log.filename
Specify the log file name. Logging will not happen if you specify a null character string or a blank space for this property. The actual log file name will be the specified file name (where n is a number from 1 to 4) with '.n.log' added.

In Windows
com.cosminexus.manager.log.dir-of-manager.cfg\mngagent- domain name-Agent name

In UNIX
com.cosminexus.manager.log.dir-of-manager.cfg/mngagent-domain name-Agent name

mngagent.log.filesize
Specify a number from 4096 to 2147483647​ for the upper size limit (in bytes) for each log file. If you specify a value outside the range, the value 65536 is used.
65536

(5) Keys that you can use when you perform operation setup by specifying communication ports and IP addresses

The specifiable keys and default values are described below.

Key name
Contents
Default value

mngagent.connector.port
Set an integer from 1 to 65535 for the Management Agent communication port. Make sure that the port number is not the same as that of any other program. When you omit this property, the value defined in vbroker.se.iiop_tp.scm.iiop_tp.listener.port is used.
Value defined in vbroker.se.iiop_tp.scm.iiop_tp.listener.port

mngagent.connector.host
Specify any value to set the IP address for the Management Agent.
When you omit this property, the value defined in vbroker.se.iiop_tp.host is used.
Value defined in vbroker.se.iiop_tp.host

vbroker.se.iiop_tp.scm.iiop_tp.listener.port
Specify any value to set the communication port of the Management Agent. Make sure that the port number is not the same as that of any other program. If this property is not set, Cosminexus TPBroker sets a random value.
This key is used for compatibility with the products earlier than the Application Server version 06-00.
None

vbroker.se.iiop_tp.host
Specify any value to set the IP address for the Management Agent.
This key is used for compatibility with the products earlier than the Application Server version 06-00.
None

(6) Precautions

The mngagent.actual-server-name.properties file is created in the following cases:

When the Smart Composer functionality is used for building a Web system

When preference information of the J2EE server is distributed by the management portal

When managing a J2EE server built without using these functions, create a setup file mngagent.actual-server-name.properties and specify the settings related to the Management Agent.

Specify a different file name for each server instance.

When multiple Management Agents having the values same as of mngagent.domain_name or mngagent.agent_name are invoked concurrently, the output is performed in the same log file by default, and hence, the log file contents might be destroyed. For invoking multiple J2EE servers on the same machine, specify a unique value for mngagent.agent_name.

10.7 mserver.properties (Management Server environment settings file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Precautions

(1) Format

The Management Agent property file has the J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file specifies the port number that will be used by the Management Server and the settings for error detection command operations. To change the port number of the Management Server without restarting it, you do so by editing this file.

(4) Specifiable keys

The following table describes the keys that you can specify, their contents, and the default values that are used when they are omitted:

Key name
Contents
Specifiable value
Default
VR

adminagent.connector.comm.state.cache_max_time
Specify a numeric value from 0 to 2147483​ (units: seconds) for the maximum cache duration for the status of communication with the Administration Agent. When a value lesser than 0 is specified, the communication status is not cached.
Specify the value using an integer from 0 to 2147483​.
60
06-50

com.cosminexus.mngsvr.agent.read_timeout
Specify an integer (units: seconds) from 1 to 2147483​ for the Management Agent connection timeout period.
Specify the value using an integer from 1 to 2147483​.
180
07-00

com.cosminexus.mngsvr.jp1event.alert
Specify whether to issue Alert level events.

If you specify true:

Alert level events will be issued.

If you specify false:

Alert level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.emergency
Specify whether to issue Emergency level events.

If you specify true:

Emergency level events will be issued.

If you specify false:

Emergency level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.critical
Specify whether to issue Critical level events.

If you specify true:

Critical level events will be issued.

If you specify false:

Critical level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.enabled
Specify whether to enable the functionality for issuing system JP1 events.

If you specify true:

Enable the functionality for issuing system JP1 events.

If you specify false:

Disable the functionality for issuing JP1 events.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.error
Specify whether to issue Error level events.

If you specify true:

Error level events will be issued.

If you specify false:

Error level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.information
Specify whether to issue Information level events.

If you specify true:

Information level events will be issued.

If you specify false:

Information level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.notice
Specify whether to issue a Notice level event.

If you specify true:

Notice level events will be issued.

If you specify false:

Notice level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.jp1event.warning
Specify whether to issue Warning level events.

If you specify true:

Warning level events will be issued.

If you specify false:

Warning level events will not be issued.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.log.display_number
Specify any one of the following numbers as the maximum number of display items that the mngsvr configuration function should display as log information in the log display screen:
20, 60, 100, 200, 400
Specify 20, 60, 100, 200, or 400.
100
07-00

com.cosminexus.mngsvr.log.level
Specify the level of log output for the Management Server log.

0: Normal operation.

10: similar to normal operation, waiting for recurrence.

20: Acquire debug level information suitable for use during system building or testing phases.

30: Acquire detailed error information that is suitable for use, when cause investigation is difficult

Specify 0, 10, 20, or 30.
0
07-00

com.cosminexus.mngsvr.log.rotate
Specify any of the following numbers, as the number of Management Server log files:
1, 2, 4, 8, 16
Specify 1, 2, 4, 8, or 16.
4
07-00

com.cosminexus.mngsvr.log.size
Specify any one of the following sizes as the Management Server log file size:
4096 (4 kilobytes), 65536 (64 kilobytes), 262144 (256 kilobytes), 524288 (512 kilobytes), 1048576​ (1 megabyte), 2097152​ (2 megabytes), 4194304​ (4 megabytes), 16777216​ (16 megabytes), 67108864​ (64 megabytes)
Specify one of the following values:

4096 (4 kilobytes)

65536 (64 kilobytes)

262144 (256 kilobytes)

524288 (512 kilobytes)

1048576​ (1 megabytes)

2097152​ (2 megabytes)

4194304​ (4 megabytes)

16777216​ (16 megabytes)

67108864​ (64 megabytes)

65536
07-00

com.cosminexus.mngsvr.logical_server_abnormal_stop.exit
Specify the operation to be executed in case of abnormal stop status of operations of the logical server managed by Management Server (automatic restart frequency is exceeded or automatic restart frequency setting is 0).

If you specify true:

KEOS10038-I is output and Management Server stops.

If you specify false:

Management Server continues processing.

Specify one of the following values:

true

false

false
08-50

com.cosminexus.mngsvr.maintenance.log.filenum
Specify an integer from 1 to 16 for the number of Management Server maintenance log files.
Specify the value using an integer from 1 to 16.
2
06-70

com.cosminexus.mngsvr.maintenance.log.filesize
Specify an integer from 65536 to 2147483647​ for the maximum file size (units: bytes) for the Management Server maintenance log file.
Specify the value using an integer from 65536 to 2147483647​.
16777216​
06-70

com.cosminexus.mngsvr.management.connector.enabled
Specify whether to enable an external connection to the Management Server remote management functionality.

If you specify true:

Enable an external connection to the Management Server remote management functionality.

If you specify false:

Disable an external connection to the Management Server remote management functionality.

Specify one of the following values:

true

false

false
07-60

com.cosminexus.mngsvr.management.enabled
Specify whether to enable the Management Server remote management functionality.

If you specify true:

Enable the Management Server remote management functionality.

If you specify false:

Disable the Management Server remote management functionality.

Specify one of the following values:

true

false

false
07-60

com.cosminexus.mngsvr.management.host
Specify the host name, or an IP address when the host for an external connection to Management Server remote management functionality is to be specified.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#¹
When the host is specified, add the java.rmi.server.hostname key in the mserver.properties file and specify the value similar to the java.rmi.server.hostname key. However, you cannot use the regular expression with meta characters in java.rmi.server.hostname.
When you specify a value to webserver.connector.http.bind_host, specify the similar value to this property.
Host name or IPv4 dotted notation
None
07-60

com.cosminexus.mngsvr.management.listen.port
Specify an integer from 0 to 65535 for the port number for client connection created at the time of external connection to the Management Server remote management functionality. If 0 is specified, a blank port number is automatically allocated.
Specify the value using an integer from 0 to 65535.
0
07-60

com.cosminexus.mngsvr.management.port
Specify an integer from 1 to 65535 for the external connection port number of the Management Server remote management functionality.
Specify the value using an integer from 1 to 65535.
28099
07-60

com.cosminexus.mngsvr.management.read_timeout
Specify an integer from 1 to 2147483​ for the read timeout period (unit: second) at the time of an external connection to the Management Server remote management functionality.
Specify the value using an integer from 1 to 2147483​.
180
07-60

com.cosminexus.mngsvr.management_user_account.enabled
Specify whether to enable the account of the Management Server user.

If you specify true:

Execute the login authentication process of Management Server.

If you specify false:

Do not execute the login authentication process of Management Server. You can log in without entering the management user account in the Login screen of management portal. You can also omit specification of -u and -p that are common arguments in the commands used by Manager.

Specify one of the following values:

true

false

true
08-50

com.cosminexus.mngsvr.on_start
Specify whether to perform batch startup of the logical servers, when the Management Server starts.

If you specify true:

Batch startup of logical servers is performed.

If you specify false:

Batch startup of logical servers is not performed.

Specify one of the following values:

true

false

false
07-00

com.cosminexus.mngsvr.snapshot.auto_collect.enabled
Specify whether to collect snapshot log when an error occurs or when batch restart is performed.

If you specify true:

Snapshot log will be collected.

If you specify false:

Snapshot log will not be collected.

Specify one of the following values:

true

false

true
06-50

com.cosminexus.mngsvr.snapshot.collect.point
Specify the timing for snapshot log collection.

If you specify before_stop:

Snapshot log will be collected before stopping the logical server.

If you specify j2ee_restart:

Snapshot log will be collected before re-starting the J2EE server.

Specify one of the following values: Note that the value is not case sensitive.

before_stop

j2ee_restart

before_stop
06-50

com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabled
Specify whether to use the functionality for executing error detection command by the system.

If you specify true:

The functionality for executing error detection command is enabled.

If you specify false:

The functionality for executing error detection command is disabled.

Specify one of the following values:

true

false

true
06-50

com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeout
Specify an integer from -1 to 2147483647​ (in seconds) for the waiting time for completion of the following processings:

Commands executed during error detection by the system

Collection of performance analysis trace

When the command or the collection of performance analysis trace does not complete even after the specified time has elapsed, the executed command or collection is ignored and the processing is continued.
When you specify -1, the processing will wait for execution of the command or collection to complete.
If a value outside the range of -1 to 2147483647​ is specified, the default value is used.
Specify the value using an integer from -1 to 2147483647​.
600
06-50

com.cosminexus.mngsvr.trace
Specify any one of the following numbers as the maximum number of performance analysis trace files maintained in the Management Server:
1, 2, 4, 8, 16
Specify 1, 2, 4, 8, or 16.
2
07-00

com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabled
Specify whether to use the functionality for executing user-created error detection command.

If you specify true:

The functionality for executing error detection command is enabled.

If you specify false:

The functionality for executing error detection command is disabled.

Specify one of the following values:

true

false

false
06-50

com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeout
Specify an integer from -1 to 2147483647​ (units: seconds) for the period of awaiting completion of execution of the user-created error detection command.
When the command does not complete even after the specified time has elapsed, ignore the executed command, and continue the processing.
When you specifty 0, the processing will continue without waiting for the completion of the command.
When you specify -1, the processing will wait for the command execution to complete.
If a value outside the range of -1 to 2147483647​ is specified, the default value is used.
Specify the value using an integer from -1 to 2147483647​.
60
06-50

com.cosminexus.mngsvr.vmx.enabled
Specifies whether to operate the Management Server as a virtual server manager in the 08-50 mode.

If you specify true:

The Management Server operates as the virtual server manager in the 08-50 mode. Note that the logical server using Management Server must not be built or operated. If a function other than virtual server manager in the 08-50 mode is used when true is specified, the operation is not guaranteed.

If you specify false:

The Management Server does not operate as the virtual server manager in the 08-50 mode.

Specify one of the following values:

true

false

false
08-50

com.cosminexus.mngsvr.vmi.enabled
Specify whether Management Server must function as a virtual server manager.

If you specify true:

Management Server functions as the virtual server manager. Note that the logical server using Management Server must not be built or operated. If a function other than virtual server manager is used when true is specified, the operation is not guaranteed.

If you specify false:

The Management Server operates as the Management Server, or as the virtual server manager in the 08-50 mode (if true is specified in com.cosminexus.mngsvr.vmx.enabled).

Specify one of the following values:

true

false

false
08-53

com.cosminexus.mngsvr.upload_app.enabled
Specifies whether to enable the functionality for uploading the application files from the management portal to the host on which the Management Server is running.

If you specify true:

Enables the functionality for uploading the application files from the management portal to the host on which the Management Server is running.

If you specify false:

Disables the functionality for uploading the application files from the management portal to the host on which the Management Server is running.

Specify one of the following values:

true

false

true
08-70

com.cosminexus.mngsvr.upload_app.directory
Specifies the directory for uploading the application files from the management portal to the host on which the Management Server is running.
You specify the directory name as an absolute path.
Cosminexus-installation-directory/manager/apps
08-70

com.cosminexus.mngsvr.upload_app.maxsize
Specifies the maximum size (unit: bytes) of application files that can be uploaded from the management portal to the host on which the Management Server is running.
Specify a size of 1024 bytes (1 KB) or more.
If you specify 0, the size of files that can be uploaded is not restricted.
0 to 9223372036854775807​
314572800​ (300MB)
08-70

com.cosminexus.mngsvr.snapshot.auto_collect.timeout
Specifies the timeout value (unit: seconds) until the primarily sent data and secondarily sent data of the snapshot log is completely collected when an error is detected in the logical server.

If 0 is specified

Timeout will not occur.

If a value between 1 and 2147483​ is specified

If the collection of the snapshot log is not completed even after the elapse of specified number of seconds, the Management Server cancels snapshot log collection.

0 to 2147483​
0
08-70

ejbserver.naming.port
Specifies the port number used for internal communication of the Management Server, when the Management Server is used from HCSC-Manager.
The port number is enabled only when the Management Server is used from HCSC-Manager.
1 to 65535
28900
09-00

ejbserver.server.edition.settingforce
Specifies whether to use the Management Server from HCSC-Manager.
When the Management Server is not used from HCSC-Manager, either specify Smart in this key or omit the specification of this key.
When this key is omitted, it is assumed that Smart is specified.

When Smart is specified:
The Management Server is not used from HCSC-Manager. Note that if you specify Smart, the ejbserver.naming.port key settings are ignored.

No value is specified: The Management Server is used from HCSC-Manager.

Note

When nothing is specified, it is assumed that only key is specified and value is not specified.

Specification example:

ejbserver.server.edition.settingforce=

Smart
Smart
09-00

java.rmi.server.hostname
Specify the host name or an IP address when the host for an external connection to Management Server remote management functionality is to be specified.
For details about the settings for this property, see com.cosminexus.mngsvr.management.host.
Also, in an environment in which the global IP address and local IP address are converted, such as the NAT (IP masquerade), specify the host name (not the IP address) regardless of whether com.cosminexus.mngsvr.management.host is specified. In this case, if the IP address is specified in com.cosminexus.mngsvr.management.host, you must specify the host name indicating that IP address.
Host name or IPv4 dotted notation
None
07-60

mngsvr.jp1event.event_server_name
Specify a value same as the address set for the ports key in the event server settings file (conf) of the JP1/Base event service that is being used. If multiple addresses are specified for the ports key, choose any one of the specified addresses.
When using an event service that has the value '0.0.0.0' (default value) specified for the ports key address, either omit this key or specify the host name of the local machine or localhost.
Host name or IPv4 dotted notation
localhost
06-70

mngsvr.myhost.name
Specify the IP address accessible from the host to which the logical server is allocated, or specify the host name indicating that IP address in the name of the host to which the logical server is allocated.
Specify this key when the host that operates Management Server has multiple IP addresses and the host name might not be converted to the intended IP address.
When omitted or when blank characters are specified, the loopback address gets converted into the local host name that can be acquired, and the local host name is used. If the local host name cannot be acquired, the loopback address is used.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#¹

Precautions

When you specify a value to webserver.connector.http.bind_host, specify the similar value to this property.

Host name or IPv4 dotted notation
None
06-50

webserver.connector.ajp13.port
Specify the port number used for Management Server internal communication.
The value set during installation is 28009.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.
None
05-00

webserver.connector.http.bind_host
You can select an optional IP address when using the Management Server on a host having multiple physical network interfaces or a host that allocates multiple logical IP addresses to one physical network interface. However, you cannot specify the loopback address.
If a value is not specified, connections are received for all the local addresses.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#¹
Specify one of the following values:

IPv4 address

Host name (String within 255 characters specified using single byte alphanumeric characters or symbols (_.-))

None
07-10

webserver.connector.http.permitted.hosts
Specify the IP address or host name of the hosts that will be allowed access to the Management Server and the host that executes the Administration Agent. This property applies to the access from a management portal (Web browser), Management Server remote management function, or management command (mngsvrutil). Moreover, you must also specify the IP address or host name of the hosts that are to be managed by the Management Server. If you operate a logical server of a host that is not specified in this property, problems like a timeout or incomplete operations may occur.
Note that when the key is omitted, there are no access restrictions. When omitting the values or when entered values are invalid, only local host can be accessed.
When specifying multiple hosts, demarcate the IP addresses or the host names with a comma (,). If there are no access restrictions, specify only an asterisk (*). The single-byte space before and after the IP address or the host name is ignored.
Specify one of the following values:

IPv4 address or host name
If you want to specify multiple addresses or names, separate with a comma (,).
Specify a string within 255 characters specified using alphanumeric characters or symbols (_.-) for the host name.

* (asterisk)

Undefined: *

Not set: localhost

06-00

webserver.connector.http.port
Specify the HTTP port number for connecting to the Management Server.
The value set during installation is 28080.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.
None
05-00

webserver.shutdown.port
Specify the port number for receiving the Management Server termination request.
The value set during installation is 28005.
If the port number is not specified, an attempt to start the Management Server fails.
Specify the value using an integer from 1 to 65535.
None
05-00

com.cosminexus.mngsvr.compat.operation_app
Specify how the applications will be managed. Note that this item is for compatibility.

If you specify true:

V7 compatibility mode

If you specify false:

V8 mode

The following strings can be specified:

true

false

Default#2: true

Initial value#2: false

08-00

#1

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

However, as "\\" is replaced with the single character "\", when specifying "\", specify two characters in succession. If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

#2

If an application is installed from Application Server V7 or earlier, the com.cosminexus.mngsvr.compat.operation_app key does not exist, so the default (true) V7 compatibility mode is used. When Application Server V8 or later is installed, false (initial value) is set up for this key.

(5) Precautions

After starting Management Server, you can also change the port number from Network settings of Cosminexus Management Server settings in the management portal. However, when changing the port number, the comment written in the mserver.properties file is deleted.

10.8 mserver.cfg (Management Server option definition file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Notes

(1) Format

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.
(Example) key-name=value#comment

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file specifies the startup options of the JavaVM that executes the Management Server.

Do not change the contents of this file while the Management Server is running. If you change the file contents, the operations may not produce the desired results.

(4) Specifiable keys

The keys that can be specified are the keys existing in 2.3(4) Specifiable keys, and the web.add.class.path key. If you specify the web.add.class.path key, the key operates as the optional add.class.path key of the J2EE server.

(5) Notes

Among the values specified in the add.class.path key, there are some values for which the <cosminexus.home> tag is used to specify the JAR files for the container extension library. These values indicate the installation destination of Application Server, so you do not need to change the contents coded for the add.class.path key. Note that when you add the container extension library to the add.class.path key, the installation and uninstallation operations might not be guaranteed; therefore, do not use the <cosminexus.home> tag.

10.9 mserverenv.cfg (Management Server environment variable definition file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Precautions

(1) Format

Specify the key as follows:

key-name=value

Specification method

Use '=' as the separator between the key and value. Any spaces put before and after '=' are ignored.

The string up to the linefeed is a value. The linefeed character is OS dependent.

The maximum size of one line is considered as 65536 bytes.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file specifies the environment variables required in the Management Server operations (starting, stopping, and setting up).

(4) Specifiable keys

The specifiable keys and default values are described below.

Key name
Contents
Default value

add.env
Set the environment variable in the following format:
Environment variable name=Environment variable value
You can specify multiple keys.
You can also specify special variables# in the environment variable value.

(Example)

add.env=AAAHOME=C:\aaa

add.env=BBBHOME=C:\bbb

In the above example, the value of environment variable AAAHOME is set to C:\aaa and the value of BBBHOME is set to C:\bbb.

None

Note:

The following table describes the special variables that you can specify:

Special variables | Contents
${cosminexus.home} | Cosminexus installation directory
%{XXX} | Environment variable XXX value

(5) Precautions

The J2EE server overwrites the following environment variables when the Management Server starts up, and hence the specified values are considered invalid.

PATH

Shared library search path (Only for UNIX)

CLASSPATH

HVI_TRACEPATH

HVI_COMTFILECOUNT

HVI_COMTENTRYCOUNT

TPJDIR

If the default value of LANG is changed (LANG=ja_JP.utf8), the operations are not guaranteed. If the value is changed, errors such as garbled text might occur in the log output.

10.10 manager.cfg (Manager settings file)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(1) Format

Specify the key as follows:

key-name=value

Specification method

Use '=' as the separator between the key and value. Any spaces put before and after '=' are ignored.

The string up to the linefeed is a value. The linefeed character is OS dependent.

The size of one line needs to be less than 1KB (1024 bytes).

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

Whitespaces at the beginning or end of the line and blank lines are ignored.

When there is a multiple specification of the same key, the last key value is applicable.

You can use only ASCII characters.

Use "/" as the file separator.

You cannot use "\" as a part of the key or the value.

Path separators are OS dependent.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

This file specifies settings that are common to Management Server, Administration Agent and components or commands operating on them.

The integrated message log, integrated trace log and command maintenance log of the Manager are available as integrated log.

(4) Specifiable keys

The specifiable keys and default values are described below.

Key name
Contents
Specifiable value
Default
VR

com.cosminexus.manager.log.dir
Specify the Manager log output directory.
Use '/' as the file separator.
Do not specify a path containing characters other than single-byte alphanumeric characters, underscore (_), space ( ), and hyphen (-).
In case the specified log output directory is invalid, Manager does not startup.
Directory name (absolute path)
Cosminexus-installation-directory/manager/log
07-00

com.cosminexus.manager.messagelog.size
Specify a value from 4096 to 16777216​ for the upper size limit (in bytes) for each integrated message log file. If you specify a value outside the range, the value 262144 is used.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Management Server startup

Administration Agent startup

Executing commands provided by the Manager

When changing the value of this property, delete the following directory after backup:

Log-output-directory-of-Manager/message

Specify the value using an integer from 4096 to 16777216​.
262144
07-00

com.cosminexus.manager.messagelog.fnum
Specify a value from 1 to 64 for the number of integrated message log files. If the shift mode is specified in the sinaviagent.log.style key, this number becomes the number of backup files.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Management Server startup

Administration Agent startup

Executing commands provided by the Manager

When changing the value of this property, delete the following directory after backup:

Log-output-directory-of-Manager/message

Specify the value using an integer from 1 to 64.
4
07-00

com.cosminexus.manager.messagelog.time
Specifies the time at which the integrated message log files for Manager will be rotated in HHMMSS format as a value from 000000 to 235959. However, if the log file size reaches the upper limit before the time set in this property is reached, the log file will be rotated at that point.
If no time is specified, the files will be rotated based only on the log size.
Specify a value from 000000 to 235959 in the HHMMSS format.
None
09-00

com.cosminexus.manager.messagelog.style
Specifies the rotation method for the integrated message log file for Manager.

If you specify SHIFT:

The log file will be rotated in the shift mode.

If you specify WRAP:

The log file will be rotated in the wraparound mode.

Specify one of the following values:

SHIFT

WRAP

WRAP
09-00

com.cosminexus.manager.tracelog.size
Specify a value from 4096 to 16777216​ for the upper size limit (in bytes) for each integrated trace log file. If you specify a value outside the range, the value 1048576​ is used.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Management Server startup

Administration Agent startup

Executing commands provided by the Manager

When changing the value of this property, delete the following directory after backup:

Log-output-directory-of-Manager/trace

Specify the value using an integer from 4096 to 16777216​.
1048576​
07-00

com.cosminexus.manager.tracelog.fnum
Specify a value from 1 to 64 for the number of integrated trace log files.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Management Server startup

Administration Agent startup

Executing commands provided by the Manager

When changing the value of this property, delete the following directory after backup:

Log-output-directory-of-Manager/trace

Specify the value using an integer from 1 to 64.
4
07-00

com.cosminexus.manager.tracelog.time
Specify the HHMMSS format for the time at which the integrated trace log files will be rotated. However, if the log file size reaches the upper limit before the time set in this property is reached, the log files are rotated at that point.
If no value is specified, the log files are rotated based on the log size only.
Specify a value from 000000 to 235959 in the HHMMSS format.
None
09-00

com.cosminexus.manager.tracelog.style
Specify the rotation method of the integrated trace log files.

If SHIFT is specified:

The files are rotated using the shift mode.

If WRAP is specified:

The files are rotated using the wrap around mode.

Specify one of the following:

SHIFT

WRAP

WRAP
09-00

com.cosminexus.manager.cmdtracelog.size
Specify a value from 4096 to 16777216​ for the upper size limit (in bytes) for each command maintenance log file. If you specify a value outside the range, the value 16777216​ is used.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Executing commands provided by the Manager

When changing the value for this property, delete the following directories and log files after backup:

Log-output-directory-of-Manager /maintenance/mmap

Log-output-directory-of-Manager /maintenance/mngcmdn.log

Specify the value using an integer from 4096 to 16777216​.
16777216​
07-00

com.cosminexus.manager.cmdtracelog.fnum
Specify a value from 1 to 64 for the number of command maintenance log files.
If you change the value of this property after any of the following operations, the change in value will not be effective:

Executing commands provided by the Manager

When changing the value for this property, delete the following directories and log files after backup:

Log-output-directory-of-Manager /maintenance/mmap

Log-output-directory-of-Manager /maintenance/mngcmdn.log

Specify the value using an integer from 1 to 64.
4
07-00

com.cosminexus.manager.log.compatible
Specify the parent compatibility of the Manager log.

If you specify true:

Unnecessary files are output by the Manager integrated log.

If you specify false:

Unnecessary files are not output by the Manager integrated log.

Specify one of the following values:

true

false

true
07-00

10.11 maction.properties (Property file for execution of Management actions)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of settings

(6) Precautions

(1) Format

This file is a Management Server property file and has the J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Define the Management action corresponding to the message ID reported in the Management event.

(4) Specifiable keys

The following table describes the keys that you can specify, their contents, and the default values used when the specification is omitted:

Key name
Contents
Classification
Default value

maction.Management-action-ID.command
Specify the command to be executed as Management action, as an absolute path.#1
Management action definition
None

maction.Management-action-ID.timeout
Specify an integer from 0 to 86400 (units: seconds) for the timeout for the command process to be executed.
If you specify 0, a timeout will not occur.
Management action definition
10

maction.Management-action-ID.timeout.forced_stop
Specify the operations to be performed for the executed command process, when a time out occurs.

If you specify true:

Command is terminated forcefully.

If you specify false:

No action occurs.

In the case of forced termination, there is no guarantee for the sub processes created by the command process.
Management action definition
false

maction.Management-action-ID.exclusive_time
Specify an integer from 0 to 86400 for the time interval (units: seconds) of preventing execution of Management actions with the same Management action ID, after a Management action starts.
If you specify 0, the execution is not prevented.
Management action definition
0

maction.Management-action-ID.max_executable_actions
Specify an integer from 0 to 1000 for the maximum number of concurrently executing Management actions with the same Management action ID.
If you specify 0, there are no restrictions on the concurrently executing number of Management actions.
Management action definition
0

maction.message.Message-ID.mactions
Specify the Management action ID for the message ID reported in the Management event. You can use alphanumeric characters and commas (,).#2
In the case of multiple specifications, demarcate using commas (,).
When no command is set for the specified Management action, the Management action is not executed.
Mapping between message ID and Management action
None

maction.server.logical-server-name.mactions
Specify the Management action ID corresponding to the logical server. You can use alphanumeric characters and commas (,).#2
In the case of multiple specifications, demarcate using commas (,).
In the logical-server-name part of the key name, you can specify a J2EE server, a J2EE server cluster, a member of the J2EE server cluster, and SFO server. When no command is set for the specified Management action, the Management action is not executed.
Mapping between logical server and Management action
None

maction.tier.web-system-name.physical-tier-typename.mactions
Specify the Management action ID corresponding to the physical tier. You can use alphanumeric characters and commas (,).#2
When no command is set for the specified Management action, the Management action is not executed.
Mapping between logical server and Management action
None

maction.unit.web-system-name.service-unit-name.mactions
Specify the Management action ID corresponding to the service unit. You can use alphanumeric characters and commas (,).#2
When no command is set for the specified Management action, the Management action is not executed.
Mapping between logical server and Management action
None

maction.mevent.receiving_info.keep_size.max
Specify an integer from 0 to 2147483647​ for the maximum number of Management event receipt information to be maintained. If you specify 0, the Management event receipt information is not maintained. High network load or failure may cause duplicate execution of Management actions. You can prevent such duplicate execution of Management actions by maintaining the Management event receipt information. When the maximum number of Management event receipt information maintenance cases is exceeded, the information received earliest is deleted. Management event receipt information is destroyed in the following cases:

On receiving a Management event, whose receipt information has exceeded the resend time limit.

All the information received is destroyed, when the Management Server terminates.

Settings when a Management event is received
100

#1

The commands to be executed as Management action are executed by the Management Server. Note that the environment variables that are set in the Management Server are used.

For details on the command file sample, see 9.4.6 Setting up the Management action executing commands in the manual uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

#2

Any blank characters specified before and after a comma (,), are ignored.

(5) Examples of settings

The contents of the maction.properties file are as follows:

In Windows

# Management-action-definition
maction.restart.command=c\: \\tmp\\command1.bat
maction.restart.timeout=12
maction.restart.timeout.forced_stop=true
maction.restart.exclusive_time=60
maction.restart.max_executable_actions=1

# Mapping-between-message-ID-and-Management-action
maction.message.KDJE11111-E.mactions=restart
maction.message.KDJE22222-E.mactions=restart

# Mapping-between-Logical-server-and-Management-action
maction.server.j2ee1.mactions=restart
maction.server.j2ee2.mactions=restart
maction.server.j2eeClstr1.mactions=restart

In UNIX

# Management-action-definition
maction.restart.command=/tmp/command1.sh
maction.restart.timeout=12
maction.restart.timeout.forced_stop=true
maction.restart.exclusive_time=60
maction.restart.max_executable_actions=1

# Mapping-between-message-ID-and-Management-action
maction.message.KDJE11111-E.mactions=restart
maction.message.KDJE22222-E.mactions=restart

# Mapping-between-Logical-server-and-Management-action
maction.server.j2ee1.mactions=restart
maction.server.j2ee2.mactions=restart
maction.server.j2eeClstr1.mactions=restart

(6) Precautions

Priorities in the case of duplicate specifications of a Management action:
For the following property keys, the logical server, service unit, and physical tier have an inclusive relationship such as:
J2EE server < J2EE server cluster < service unit <physical tier.

maction.server. logical-server-name.mactions

maction.unit.Web-system-name.service-unit-name.mactions

maction.tier.Web-system-name.physical-tier-type-name.mactions

Therefore, when different Management actions are specified for each logical server having an inclusive relationship (for example, J2EE cluster and a J2EE server that is an element of the J2EE cluster), only one of the specified Management actions is performed based on the following order of priority:

The J2EE server that issued the Management event

The J2EE server cluster that includes the J2EE server that issued the Management event

The service unit that includes the J2EE server that issued the Management event

The physical tier that includes the J2EE server that issued the Management event

Moreover, if the orders of the Management actions specified in the mapping between message ID and Management action and specified in the mapping between logical server and Management action, are different, priority is decided by the order of Management action ID specified in the mapping between message ID and Management action (maction.message.message-ID.mactions key).

Example: Example of prioritizing act1

maction.message.KDJE99999-E.mactions=act1,act2

maction.server.J2EE01.mactions=act3,act2,act1

Note that in this example, KDJE99999-E is the message ID and J2EE01 is the logical server.

Standard output or standard error output
The Management Server does not collect the standard output or standard error output from the command that is executed as Management action. Therefore, when acquiring the standard output or standard error output information of the commands, you need to output that information to a file, as a part of the command.

10.12 Property file for issuing Management events

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Precautions

(1) Format

This file is a Management Server property file and has the J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\mevent.Logical-server-name.properties

In UNIX
/opt/Cosminexus/manager/config/mevent.Logical-server-name.properties

(3) Functionality

This file defines the logical server that sends the Management event, the Management Server to which the event is sent, and the file that contains the list of message IDs to be reported.

(4) Specifiable keys

The following table describes the keys that you can specify, their contents, and the default values used when the specification is omitted:

Key name
Contents
Default value

manager.mevent.send.host
Specify the host to which the event is to be sent.
Specify the host name or IP address of the Management Server to which the Management event is to be sent. You can use alphanumeric characters and symbols.
When this property is not specified, the Management event is not issued.
None

manager.mevent.send.port
Specify the port to which the event is to be sent.
Specify an integer from 1 to 65535 for the HTTP port number of the Management Server to which the Management event is to be sent.
When this property is not specified or when the specification is invalid, the Management event is not issued.
None

manager.mevent.logical_server_name
Specify the name of the logical server that issues the Management event. You can use alphanumeric characters and symbols.
When this property is not specified, the Management event is not issued.
If you specify a logical server name that does not exist, the Management event is ignored.
None

manager.mevent.send.timeout
Specify the send timeout.
Specify an integer from 10 to 600 (units: seconds) for the time period of awaiting a response from the Management Server, when a Management event is issued.
When there is no response within the specified time period, it is considered as Management event issue failure.
90

manager.mevent.retry.limit
Specify the resend time limit.
Specify an integer from 0 to 86400 (units: seconds) for the time limit for resending the Management event in the case of failure in issuing a Management event.
The issuing of the Management event is repeated at resend intervals specified in the manager.mevent.retry.interval key, until the issue of the event is successful, or until the time specified in this key lapses.
If you specify 0, the Management event is not resent.
0

manager.mevent.retry.interval
Specify an integer from 1 to 86400 (units: seconds) for the interval after which the Management event will be resent.
10

manager.mevent.message_id.list
Specify the message ID list file (as an absolute path) to be used for issuing the Management events.
When the specified file is invalid, Management events are not issued.
When omitted, the message ID registered in the default message ID list file is sent as Management event.
For more details on the message ID list file for issuing the Management events, see 10.13 Message ID list file for issuing Management events.
None

manager.mevent.send.max
Specify an integer from 1 to 1000 for the maximum number of Management events that can be concurrently issued.
10

manager.mevent.sender.bind.host
Specify the local address (host name or IP address) to be used when sending the Management event. You can use alphanumeric characters and symbols.
When omitted, a local IP address is randomly allocated.
None

To create this file, see the following sample of the property file for issuing Management events.

In Windows
Cosminexus-installation-directory\manager\config\templates\mevent.properties

In UNIX
/opt/Cosminexus/manager/config/templates/mevent.properties

(5) Precautions

You need to specify a settings file for issuing Management events for each J2EE server instance. Do not specify the same file for multiple J2EE server instances running concurrently.

Management events are issued in the order of their occurrence. However, Management events whose issue has failed are re-issued only after the planned Management events have been issued.

10.13 Message ID list file for issuing Management events

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Default

(5) Examples of coding

(6) Notes

(1) Format

Specify the message ID list in the following format:

[Indicator]Message-ID

Code one message ID in one line.

An indicator wherein a hash mark (#) is specified is a comment.

If you specify a plus (+) in the indicator or if you omit the indicator, the corresponding message ID is reported as the Management event.

If you use a hyphen (-) in the indicator, the corresponding message ID is not reported as the Management event. You use this facility when the message ID mentioned in the default Management event issue message ID list is not to be sent as the Management event.

Whitespaces at the beginning or end of the line and blank lines are ignored.

When the same message ID is specified many times, the message ID coded in the end becomes valid.

Always specify an indicator when the message ID starts with a plus (+) or a hyphen (-).

(2) File storage location

Any storage location and file name is possible. You can use the following characters in the file name:

Alphanumeric characters, periods (.), yen signs (), colons (:), plus signs (+), or hyphens (-)

(3) Functionality

Define the message IDs that are reported as Management events.

(4) Default

The following table describes the default message IDs that are reported as Management events:

Table 10-2 Message ID for Management issue (Default)

Functionality
Monitoring target
Message ID

Monitoring resource depletion
Memory usage status
KDJE34500-W

Number of file descriptors
KDJE34520-W

Number of threads
KDJE34540-W

Number of thread dump files
KDJE34580-W
KDJE34581-E

HTTP request pending queue (pending queue of each Web application and the default pending queue)
KDJE34621-W

Number of HTTP sessions
KDJE34640-W

Connection pool utilization state
KDJE34660-W
KDJE34661-W

Monitoring J2EE application execution time
J2EE application execution time
KDJE52702-W
KDJE52703-W
KDJE52705-W
KDJE52713-E

Detecting connection failure
A timeout in connection failure detection
KDJE48602-W

Connection managing threads
KDJE48603-W

Monitoring full garbage collection count
Full garbage collection count
KDJE53850-W

Monitoring the number of pending requests for each URL group
Upper threshold limit for the number of requests pending for each URL group
KDJE53860-W

Lower threshold limit for the number of requests pending for each URL group
KDJE53861-I

Cluster connection pool
Connection pool status
KDJE49650-I
KDJE49653-I
KDJE49655-E
KDJE49657-E
KDJE49660-I
KDJE49663-E
KDJE49664-E
KDJE49669-E

Connection managing threads
KDJE49671-I

(5) Examples of coding

A sample is as follows:

When KDJE34580-W and KDJE34660-W are not reported as Management events:

# Monitoring of resources
# : Status of memory (Java Heap)
KDJE34500-W

# : Number of file descriptors
KDJE34520-W

# : Number of threads
KDJE34540-W

# : Number of thread dump files
-KDJE34580-W
KDJE34581-E

# : Number of HTTP requests in queue
KDJE34621-W

# : Number of HTTP sessions
KDJE34640-W

# : Status of connection pool
-KDJE34660-W
KDJE34661-W

# Monitoring of execution time of user program
KDJE52702-W
KDJE52703-W
KDJE52705-W
KDJE52713-E

To create this file, see the following sample of the message ID list file for issuing Management events:

In Windows
Cosminexus-installation-directory\manager\config\templates\mevent.midlist.conf

In UNIX
/opt/Cosminexus/manager/config/templates/mevent.midlist.conf

(6) Notes

Management events are not issued for the following message IDs. If you specify these message IDs, the specification is ignored.

KDJE90001-E

KDJE90002-E

KDJE90003-E

KDJE90005-W

KDJE90006-W

KDJE90009-W

The message IDs that you can specify include only the specific message IDs output by the J2EE server or batch server that are integrated with the functionality for issuing Management events. Even if you specify other system message IDs, message IDs output by J2EE applications or batch applications, the Management events are not issued.

10.14 Definition files to be saved for the Management Server management files

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Default

(5) Examples of coding

(1) Format

Specify the definition file in the following format:

File-name

Specify the file name as an absolute path.

A line beginning with a hash mark (#) is a comment.

Use slash (/) as a file separator.

When the specified file does not exist in the specified path, the specification is ignored and the processing continues.

You can use the following variables: ($ indicates system property. Do not include $ in the value that you specify).
${cosminexus.home}: Cosminexus installation directory
${user.home}: User home directory

(2) File storage location

Any storage location and file name is possible.

(3) Functionality

When node switching is done with the active nodes and the standby nodes in a 1-to-1 relationship, you use this file to define the files to be collected and saved as the Management Server management files of the Management Server of the active node. You use this file to specify files that are not collected by default.

(4) Default

The following table describes the directories of files collected by default as management files of the Management Server:

Types
Target directory

Definition file directory

In Windows
Cosminexus-installation-directory/manager/config/

In UNIX
/opt/Cosminexus/manager/config/

Application registration directory

In Windows
Cosminexus-installation-directory/manager/containers/m/j2eeapps/mngsvr/mportal/mapps/regapps/

In UNIX
/opt/Cosminexus/manager/containers/m/j2eeapps/mngsvr/mportal/mapps/regapps/

Resource adapter registration directory

In Windows
Cosminexus-installation-directory/manager/containers/m/j2eeapps/mngsvr/mportal/mwebsystems/regras/

In UNIX
/opt/Cosminexus/manager/containers/m/j2eeapps/mngsvr/mportal/mwebsystems/regras/

File for storing the results of configuration information definition for managing the repository

In Windows
Cosminexus-installation-directory/manager/containers/m/j2eeapps/mngsvr/mportal/useradmin/config/data/editusersConfig.xml

In UNIX
/opt/Cosminexus/manager/containers/m/j2eeapps/mngsvr/mportal/useradmin/config/data/editusersConfig.xml

(5) Examples of coding

When collecting /home/confdir/message1.conf

/home/confdir/message1.conf

When collecting Cosminexus-installation-directory/manager/apps/MyApp.ear (in Windows) or /opt/Cosminexus/manager/apps/MyApp.ear (in UNIX)

${cosminexus.home}/manager/apps/MyApp.ear

10.15 .mngsvrutilrc (Client-side definition file of the mngsvrutil command)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Application timing

(5) Specifiable keys

(1) Format

J2SE property file format.

(2) File storage location

Home directory of each OS user

(3) Functionality

Specify the default values for the mngsvrutil command options.

(4) Application timing

After the settings file is changed, the updated information is applied during the next execution of the mngsvrutil command.

(5) Specifiable keys

The following table describes the keys that you can specify in the client-side definition file, their contents, and the default values used when the specification is omitted:

Key name
Contents
Specifiable value
Default
VR

mngsvrutil.connect.host
Set the Management Server host name and port number to be specified in the -m option.
(Example of settings)
mngsvrutil.connect.host=localhost:28080

Host name
Specify an IP address with dot notation or a host name for which the name analysis can be performed.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1

Port number
Follow the Management Server settings. The default value is '28080'.

Precautions

When performing the operations in the host unit management model, if a value is specified in webserver.connector.http.bind_host of mserver.properties, specify the same value in this key.

Do not specify a colon (:) in the regular expression indicating the IP address. If a colon (:) is specified, the string after the colon is considered as the port number.

Specify one of the following values:

Host name

IPv4 address

None
06-00

mngsvrutil.connect.password
Set the password to be specified in the -p option. Note that this key is not required if a password has not been set.
(Example of settings)
mngsvrutil.connect.password=admin
Specification of this property is ignored if the functionality to omit the management user account is enabled.
Management user account password of Management Server
None
06-00

mngsvrutil.connect.userid
Set the user ID to be specified in the -u option.
(Example of settings)
mngsvrutil.connect.userid=admin
Specification of this property is ignored if the functionality to omit the management user account is enabled.
User ID of the management user account of the Management Server
None
06-00

mngsvrutil.output.file
Set the output file name to be specified in the -o option.
(Example of settings)
In Windows
mngsvrutil.output.file=C:/tmp/output.txt
In UNIX
mngsvrutil.output.file=/tmp/output.txt
File name (absolute path)
None
06-00

mngsvrutil.output.format
Set the output format to be specified in the -f option.
To output in the CSV format, specify csv and to output in the SNMP integration format, specify snmp.
(Example of settings)
mngsvrutil.output.format=csv
The following strings can be specified:

csv

snmp

csv
06-00

mngsvrutil.output.suppress_header
Set this property to true when specifying the -h option and set false when not specifying the option. Note that the value is not case sensitive.
(Example of settings)
mngsvrutil.output.suppress_header=true
The following strings can be specified:

true

false

false
06-00

mngsvrutil.target_name#2
Specifies the logical server name or the host name to be specified in the -t option.
(Example of settings)
mngsvrutil.target_name=myServer
Specify the target name (logical server name or host name) to be used by the sub-command.
Follow the definition of Logical server configuration definition of the management portal.
You can specify the IP address as a regular expression using meta characters. When the IP address is specified as a regular expression, the available local IP address that matches the expression is used.#1

Precautions

When you want to specify host in the -k option or mngsvrutil.target_kind, specify the same value that is specified for webserver.connector.http.bind_host in mserver.properties.

Specify one of the following values:

IPv4 address

Host name

logical-server-name

None
06-00

mngsvrutil.target_kind
Specify the target kind to be specified in the -k option.
(Example of settings)
mngsvrutil.target_kind=host
The following strings can be specified:

logicalServer

host

logicalServer
06-00

mngsvrutil.target_server_name#2
Set the logical server name to be specified in the -t option. However, for versions 06-00 and above, Hitachi recommends using mngsvrutil.target_name. If you specify this property along with mngsvrutil.target_name, the value specified in mngsvrutil.target_name is used.
(Example of settings)
mngsvrutil.target_server_name=myServer
Specified in alphanumeric characters and symbols.
None
06-00

Notes

If a key does not exist or if it is incorrectly specified, the default value is used.

As this file holds important information such as passwords, set appropriate access permissions for this file.

When you code characters other than the ASCII characters, match the character encoding of the setup file and that of the OS locale when the executing the mngsvrutil command. Moreover, when using Japanese, do not specify character strings that include escape sequences.

For SNMP integration using 'JP1/Cm2/ESA for Extension Mib Runtime' or 'JP1/Cm2/Extensible Agent for Extension Mib Runtime', create the settings file under the home directory of the executing user of 'JP1/Cm2/ESA for Extension Mib Runtime' or 'JP1/Cm2/Extensible Agent for Extension Mib Runtime'.

#1

If the IP address subnet used in the communication with the Administration Agent in the management domain is fixed, and if the IP address to be specified is coded as 192\\.168\\.0\\..+, the IP address matches with the IP address starting with 192.168.0. (for example, 192.168.0.32 or 192.168.0.128), so the setup file can be distributed to all the hosts and can be used without modifications. For details on the regular expressions, check the specifications for the java.util.regex.Pattern class in Java.

However, as "\\" is replaced with the single character "\", when specifying "\", specify two characters in succession. If multiple IP addresses matching with the specified regular expression are detected, the IP address with the smallest value is used. For example, if 192.168.0.32 and 192.168.0.128 are detected, 192.168.0.32 will be used. In this case, the used IP address is not always the intended IP address, therefore, make sure to code a regular expression such as 192\\.168\\.0\\.1.. to match with only one IP address.

#2

For information about the relation between the mngsvrutil.target_name key and the mngsvrutil.target_server_name key specification with the -k option and -t option of the mngsvrutil command, see mngsvrutil (Management commands of Management Server) in the manual uCosminexus Application Server Command Reference Guide.

10.16 mngsvrutil.properties (Server-side definition file of the mngsvrutil command)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Application timing

(5) Specifiable keys

(1) Format

J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Specify the settings for the execution environment of the mngsvrutil command.

(4) Application timing

If the settings file is updated while the Management Server is running, the updated information is not applied until the next time the Management Server is started.

(5) Specifiable keys

The following table describes the keys that you can specify in server-side definition file, their contents, and the default values when the specification is omitted:

Key name
Contents
Default value

mngsvrutil.auth.failed_wait
Specify the number of seconds to wait when the management user authentication fails. (Values that can be specified: 0 to 2147483647​).
(Example of settings)
mngsvrutil.auth.failed_wait=10
5

mngsvrutil.auth.log_challenged
Specify whether to output instances of HTTP access to the log.#1

If you specify true:

The instances of HTTP access will be output to the log.

If you specify false:

The instances of HTTP access will not be output to the log.

(Example of settings)
mngsvrutil.auth.log_challenged=false
true

mngsvrutil.auth.log_denied
Specify whether to output instances of denied HTTP access to the log. #1

If you specify true:

The instances of denied HTTP access will be output to the log.

If you specify false:

The instances of denied HTTP access will not be output to the log.

(Example of settings)
mngsvrutil.auth.log_denied=false
true

mngsvrutil.auth.log_failed
Specify whether to output the failure of management user authentication to the log. #1

If you specify true:

The failure of management user authentication will be output to the log.

If you specify false:

The failure of management user authentication will not be output to the log.

(Example of settings)
mngsvrutil.auth.log_failed=false
true

mngsvrutil.auth.log_succeeded
Specify whether to output successful management user authentication in the log. #1

If you specify true:

The successful management user authentication will be output to the log.

If you specify false:

The successful management user authentication will not be output to the log.

(Example of settings)
mngsvrutil.auth.log_succeeded=false
true

mngsvrutil.compat.header_format
Specify whether the header format to be output in the list sub-command will be changed to the V7 compatibility mode and compatible format, when the application management method is the V8 mode. #1

If you specify true:

The header format will be output in the V7 compatibility mode and compatible format (the registration time and import time of the J2EE applications and resources will be output).

If you specify false:

The header format will be output in the V7 compatibility mode and incompatible format (the registration time and import time of the J2EE applications and resources will not be output).

(Example of settings)
mngsvrutil.compat.header_format=true
false

mngsvrutil.compat.monitoring_tree
Specify whether the application information will be included in the contents acquired by the automatic generation of the JP1/IM monitoring tree, when the application management method is the V8 mode. #1

If you specify true:

The J2EE application information and the information about the relation between the J2EE server and J2EE application will be output.

If you specify false:

The J2EE application information and the information about the relationship between the J2EE server and J2EE application will not be output.

(Example of settings)
mngsvrutil.compat.monitoring_tree=true
false

mngsvrutil.session.max_inactive_interval
Specify the maximum number of seconds until the session becomes invalid after the server has generated a session in the client and received the last request from the client. (Value that can be specified: -2147483648​ to 2147483647​).#2
(Example of settings)
mngsvrutil.session.max_inactive_interval=10
5

Notes

If a key does not exist or if it is incorrectly specified, the default value is used.

If the settings file is updated while the Management Server is running, the updated information is not applied until the next time the Management Server is started.

#1

The settings (true and false) are not case sensitive.

#2

When a negative value is specified, the session does not become invalid.

10.17 mngsvrutilcl.properties (Client-side shared definition file of the mngsvrutil command)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Application timing

(5) Specifiable keys

(6) Precautions

(1) Format

J2SE property file format.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config/

(3) Functionality

Specify the shared definition settings for the default values of the mngsvrutil command options.

You can also limit the users to whom this definition file will apply.

Note that when both the client-side definition file (.mngsvrutilrc) and mngsvrutilcl.properties (client-side shared definition file of the mngsvrutil command) have been set, the client-side definition file (.mngsvrutilrc) is applicable.

(4) Application timing

After the settings file is changed, the updated information is applied during the next execution of the mngsvrutil command.

(5) Specifiable keys

The following table describes the keys that you can specify in the client-side shared definition file, their contents, and the default values when the specification is omitted. Note that "Default" refers to the value or operation assumed when the key is not specified. "VR" refers to the Application Server version introduced or changed by the key.

Key name
Contents
Specifiable value
Default value
VR

mngsvrutil.apply_user
Specify the OS users when the mngsvrutil command or adapter commands will be executed and the users applying the client-side shared definition file. Only when the OS users specified in this key execute the mngsvrutil command or adapter commands, the other specified keys are applied.
To specify multiple users, use comma (,) for demarcation.

In Windows
Specify a user name not including the domain name. If the user name is matching, this parameter is enabled in both the login destinations, local and domain.
The value is not case sensitive.
Also, for applying this definition file when the mngsvrutil command is invoked from a Windows service, specify "SYSTEM" on a Windows XP system and "host-name$" (host-name is the host name of the host on which Management Server is running) on other systems.

In UNIX
The values are case sensitive.
Specify 'root' to apply this definition file in SNMP integration and JP1/IM integration (automatic generation of the monitoring tree and collection of the Web system configuration information).

(Example of settings)
In Windows
mngsvrutil.apply_user=SYSTEM,Administrator
In UNIX
mngsvrutil.apply_user=root,user01
User name registered for OS
None
06-70

.Key for.mngsvrutilrc (client side definition file of the mngsvrutil command)
For details on keys that can be specified, see 10.15 .mngsvrutilrc (Client-side definition file of the mngsvrutil command).
--
--
--

Legend:

-: Not applicable.

(6) Precautions

When the client-side definition file (.mngsvrutilrc) does not exist, the client-side shared definition file (mngsvrutilcl.properties) is read for all OS users and if a particular user does not have sufficient permissions to access the file, a Warning occurs.

Hitachi recommends that you set access permissions so that the OS users who execute the mngsvrutil command and the adapter command can access the client-side shared definition file and then control the application of the client-side shared definition file by using the mngsvrutil.apply_user key.

10.18 .mngsvrmonitorrc (Settings file of the monitor startup command for JP1/IM integration)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Application timing

(5) Specifiable keys

(1) Format

J2SE property file format.

(2) File storage location

Home directory of OS user who operates JP1/IM - View

(3) Functionality

In the case of integrating with JP1/IM, specify the settings required for starting up the Management Server operation portal from the JP1/IM screen. Note that this file is for Windows.

(4) Application timing

After the settings file is changed, the updated information is applied during the next execution of the mngsvrmonitor command.

(5) Specifiable keys

The following table describes the keys that you can specify in the settings file of the monitor startup command, their contents, and the default values when the specification is omitted:

Key name
Contents
Default value

mngsvrmonitor.browser
Specify the commands of the Web browser to be started, in the full path. When this key is omitted, the default browser set in the Windows registry is started (In case, default browser is not set, error occurs).
(Example of settings)
mngsvrmonitor.browser ="C:/Program Files/Internet Explorer/iexplore.exe"
Default browser of the registry

mngsvrmonitor.connect.host
Specify host name and port number of Cosminexus Management Server in the following format.
Host name [:Port number]
(Example of settings)
mngsvrmonitor.connect.host=h001:28080
Port number: 28080

mngsvrmonitor.connect.password
Specify the management user password corresponding to the management user ID set in 'Setting management user accounts' of the management portal. Note that this key is not required if a password has not been set.
(Example of settings)
mngsvrmonitor.connect.password=p43269
Specification of this property is ignored if the functionality to omit the management user account is enabled.
None

mngsvrmonitor.connect.userid
Specify the management user ID set in 'Setting management user accounts' of the management portal. If this key is omitted, the Login screen of the management portal appears.
(Example of settings)
mngsvrmonitor.connect.userid=admin
Specification of this property is ignored if the functionality to omit the management user account is enabled.
None

10.19 System log message mapping file for JP1/IM integration

The system log message mapping file for JP1/IM integration includes the files that are listed below. In these files, you define the mapping between the Cosminexus system messages, and the criticality of JP1 events.

mserver.jp1event.system.mapping.properties (Message mapping file for Management Server)

manager.jp1event.system.mapping.properties (J2EE server shared message mapping file)

manager.logical-server-name.jp1event.system.mapping.properties (Message mapping file for individual J2EE servers)

Note that you cannot define the messages related to the Web services and Web resources in the system log message mapping file for JP1/IM integration.

Organization of this section

10.19.1 mserver.jp1event.system.mapping.properties (Message mapping file for Management Server)

10.19.2 manager.jp1event.system.mapping.properties (Message mapping file for J2EE server sharing)

10.19.3 manager.Logical-server-name.jp1event.system.mapping.properties (Message mapping file for individual J2EE servers)

10.19.4 Conversion to JP1 events

10.19.1 mserver.jp1event.system.mapping.properties (Message mapping file for Management Server)

Organization of this subsection

(1) Format

(2) File storage location

(3) Functionality

(4) Examples of coding

(1) Format

J2SE property file format.

mserver.jp1event.system.mapping.severity.Message-ID = Criticality-of-JP1-event

Message-ID

Specifies the message ID described in the following manual:

Manual uCosminexus Application Server Messages

Criticality-of-JP1-event

Specify any one of the values from Information, Notice, Warning, Error, Critical, Alert, or Emergency.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config\

In UNIX
/opt/Cosminexus/manager/config

(3) Functionality

You use this message mapping file for converting the log messages output by Management Server into JP1 event.

(4) Examples of coding

mserver.jp1event.system.mapping.severity.KEOS10001-E=Error
mserver.jp1event.system.mapping.severity.KEOS10010-I=Information

10.19.2 manager.jp1event.system.mapping.properties (Message mapping file for J2EE server sharing)

Organization of this subsection

(1) Format

(2) File storage location

(3) Functionality

(4) Examples of coding

(1) Format

J2SE property file format.

mserver.jp1event.system.mapping.severity.Message-ID = Criticality-of-JP1-event

Message-ID

Specifies the message ID described in the following manual:

Manual uCosminexus Application Server Messages

Criticality-of-JP1-event

Specify any one of the values from Information, Notice, Warning, Error, Critical, Alert, or Emergency.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config

In UNIX
/opt/Cosminexus/manager/config

(3) Functionality

You use this message mapping file for sharing the J2EE servers in a server machine, and during conversion of log messages output by a J2EE server into JP1 events.

(4) Examples of coding

manager.jp1event.system.mapping.severity.KDJE42019-E=Error
manager.jp1event.system.mapping.severity.KDJE42040-I=Information

10.19.3 manager.Logical-server-name.jp1event.system.mapping.properties (Message mapping file for individual J2EE servers)

Organization of this subsection

(1) Format

(2) File storage location

(3) Functionality

(4) Examples of coding

(1) Format

J2SE property file format.

mserver.jp1event.system.mapping.severity.Message-ID = Criticality-of-JP1-event

Message-ID

Specifies the message ID described in the following manual:

Manual uCosminexus Application Server Messages

Criticality-of-JP1-event

Specify any one of the values from Information, Notice, Warning, Error, Critical, Alert, or Emergency.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\config

In UNIX
/opt/Cosminexus/manager/config

(3) Functionality

You create this file when you want to define the mapping rules for each J2EE server. When this file is defined, Cosminexus uses only the individual file for the corresponding J2EE server and converts the log messages output by the J2EE server into JP1 events.

(4) Examples of coding

manager.jp1event.system.mapping.severity.KDJE42020-E=Error
manager.jp1event.system.mapping.severity.KDJE42041-I=Information

10.19.4 Conversion to JP1 events

The message-mapping file is used to convert the log messages output with the Management Server, J2EE server, and user log functionality into JP1 events.

Organization of this subsection

(1) JP1 events for Management Server

(2) JP1 events for J2EE server

(3) JP1 events for J2EE users

(1) JP1 events for Management Server

There are following two types of JP1 events for the Management Server:

JP1 events defined in Cosminexus

JP1 events specified in the message mapping file for the Management Server

JP1 events defined in Cosminexus

Cosminexus issues JP1 events when the messages with the following message IDs are output:

Table 10-3 JP1 events for Management Server defined in Cosminexus

Event ID | Trigger | Message ID
0x00012050​ | Management Server startup | KEOS10101-I
0x00012051​ | Stopping the Management Server | KEOS10102-I
0x00012060​ | Addition of a Web system to the domain | KEOS23301-I
0x00012061​ | Deletion of a Web system from the domain | KEOS23302-I
0x0001206​A | Unit addition or deletion to the Web system and deployment or undeployment of a J2EE application (changing the Web system) | KEOS23303-I
0x00012070​ | Administration Agent startup | KEOS21100-I
0x00012071​ | Stopping the Administration Agent | KEOS21101-I

JP1 events specified in the message mapping file for the Management Server

JP1 events are issued for the messages specified in the template file (mserver.jp1event.system.mapping.properties) of the message-mapping file for the Management Server.

The storage destination for the template file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\templates\

In UNIX
/opt/Cosminexus/manager/config/templates

The following table describes the JP1 events for the Management Server that are issued based on specification of the message-mapping file:

Table 10-4 JP1 events for Management Server based on the specification of the message-mapping file

Event ID | Trigger | Criticality of JP1 events specified by mapping
0x00012000​ | Emergency-level failure of the logical server detected in the Management Server | Emergency
0x00012001​ | Alert-level failure of the logical server detected in the Management Server | Alert
0x00012002​ | Critical-level failure of the logical server detected in the Management Server | Critical
0x00012003​ | Error-level failure of the logical server detected in the Management Server | Error
0x00012004​ | Warning-level failure of the logical server detected in the Management Server | Warning
0x00012005​ | Notice-level failure of the logical server detected in the Management Server | Notice
0x00012006​ | Information-level failure of the logical server detected in the Management Server | Information
0x00012020​ | Emergency-level failure in the Management Server | Emergency
0x00012021​ | Alert-level failure in the Management Server | Alert
0x00012022​ | Critical-level failure in the Management Server | Critical
0x00012023​ | Error-level failure in the Management Server | Error
0x00012024​ | Warning-level failure in the Management Server | Warning
0x00012025​ | Notice-level failure in the Management Server | Notice
0x00012026​ | Information-level failure in the Management Server | Information

(2) JP1 events for J2EE server

JP1 events for the J2EE server are issued for the messages specified in the following template files:

Message mapping file for the shared J2EE servers (manager.jp1event.system.mapping.properties)

Message mapping file for the individual J2EE server (manager.logical-server-name.jp1event.system.mapping.properties)

The storage destination for the template file is as follows:

In Windows
Cosminexus-installation-directory\manager\config\templates\

In UNIX
/opt/Cosminexus/manager/config/templates

The following table describes the JP1 events for the J2EE server based on the specification of the message-mapping file:

Table 10-5 JP1 events for J2EE server

Event ID | Trigger | Criticality of JP1 events specified by mapping
0x00012080​ | Emergency-level failure of J2EE server | Emergency
0x00012081​ | Alert-level failure of J2EE server | Alert
0x00012082​ | Critical-level failure of J2EE server | Critical
0x00012083​ | Error-level failure of J2EE server | Error
0x00012084​ | Warning-level failure of J2EE server | Warning
0x00012085​ | Notice-level failure of J2EE server | Notice
0x00012086​ | Information-level failure of J2EE server | Information
0x00012090​ | Emergency-level failure of application detected in J2EE server | Emergency
0x00012091​ | Alert-level failure of application detected in J2EE server | Alert
0x00012092​ | Critical-level failure of application detected in J2EE server | Critical
0x00012093​ | Error-level failure of application detected in J2EE server | Error
0x00012094​ | Warning-level failure of application detected in J2EE server | Warning
0x00012095​ | Notice-level failure of application detected in J2EE server | Notice
0x00012096​ | Information-level failure of application detected in J2EE server | Information

(3) JP1 events for J2EE users

JP1 events for J2EE users are issued for messages output with the user log functionality. For details about the settings of JP1 events for user logs, see13.4.2 Setting error monitoring in manual uCosminexus Application Server Operation, Monitoring, and Linkage Guide.

Table 10-6 JP1 events for J2EE users

Event ID | Trigger | Criticality of JP1 events
0x000120D0 | Emergency-level failure of application | Emergency
0x000120D1 | Alert-level failure of application | Alert
0x000120D2 | Critical-level failure of application | Critical
0x000120D3 | Error-level failure of application | Error
0x000120D4 | Warning-level failure of application | Warning
0x000120D5 | Notice-level reporting of application | Notice
0x000120D6 | Information-level reporting of application | Information

10.20 setup.cfg (Setup file for the Setup Wizard)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Precautions

(1) Format

Specify the key as follows:

key-name=value

Specification method

A line beginning with # (hash mark) is a comment and is ignored.

If no value is specified, the line is ignored.

The spaces at the beginning and end of a line, and blank lines are ignored.

Use '=' as the separator between the key and value. Any spaces put before and after '=' are ignored.

The string up to the linefeed is a value.

When there is a multiple specification of the same key, the last key value is applicable.

One line is less than 64 KB.

You can use only ASCII characters.

(2) File storage location

In Windows
Cosminexus-installation-directory\manager\setup\config

In UNIX
/opt/Cosminexus/manager/setup/config

(3) Functionality

Specifies the output destination, maximum file size, and maximum number of Setup Wizard log files.

(4) Specifiable keys

The following table describes the keys that can be specified. Note that "Default" refers to the value or operation assumed when the key is not specified. "VR" refers to the Application Server version introduced or changed by the key.

Key name
Contents
Specifiable value
Default value
VR

setup.log.dir
Specify the output location directory of the log file. Use '/' as the file separator. If you specify a value outside the range, the default value will be set.
In UNIX, the parent directory of the specified output destination directory must exist.
Directory name (absolute path)

In Windows
Cosminexus-installation-directory\manager\setup\log

In UNIX
/opt/Cosminexus/manager/setup/log

08-00

setup.log.filenum
Specify the number of files. If you specify a value outside the range, the default value will be set.
Specify the value using an integer from 1 to 16.
4
08-00

setup.log.filesize
Specifies the maximum size per log file (unit: bytes). If you specify a value outside the range, the default value will be set.
Specify an integer from 4096 to 2147483647​.
262144
08-00

setup.maintenance.log.filenum
Specifies the number of maintenance log files. If you specify a value outside the range, the default value will be set.
Specify the value using an integer from 1 to 16.
4
08-00

setup.maintenance.log.filesize
Specifies the maximum size per maintenance log file (unit: bytes). If you specify a value outside the range, the default value will be set.
Specify the value using an integer from 4096 to 2147483647​.
16777216​
08-00

(5) Precautions

If an attempt to read the setup.cfg file fails during the execution of the Setup Wizard, the message KEOS28056-E is displayed and the Setup Wizard terminates.

10.21 Logical user server definition file

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Contents that you can define

(5) Sample definition

(6) Precautions

(1) Format

xml file format.

(2) File storage location

Any storage location and file name is possible.

(3) Functionality

You create this file when adding a logical user server by the mngsvrutil command.

(4) Contents that you can define

The following table describes the contents that you can code in the logical user server definition file:

Element name
Description
Default value

user-server-definition
Specify the following path as namespace:
http://www.cosminexus.com/mngsvr/schema/UserServerDefinition-1.1
--

Service

--

--

Type

Specify whether to start directly or indirectly.
When you specify direct:
Starts up directly.
When you specify indirect:
Starts up indirectly.

direct

startup-order

Specify an integer from -1 to 999 for the startup order. When -1 is specified, the element is ignored.

900

start-watch-time

Choose a start watch time from the following numeric values (units: seconds). When 0 is specified, monitoring is not performed.
0, 60, 300, 600, 3600

60

stop-watch-time

Choose a stop watch time from the following numeric values (units: seconds). When 0 is specified, monitoring is not performed.
0, 60, 300, 600, 3600, 1800

60

force-watch-time

Choose a force stop watch time in the following numeric value (unit: seconds). When 0 is specified, monitoring is not performed.
0, 60, 300, 600, 1800

60

retry-count

Specify the auto restart frequency, choose one from the following numeric values:
0, 1, 5, 10, 1000

1

retry-interval

Specify the auto restart retry interval, choose one from the following numeric values (units: seconds). When 0 is specified, performs immediate retry.
0, 60, 300, 600, 3600,1800

60

watch-interval

Specify an integer from 1 to 86400 (units: seconds) for the monitoring interval.
Note that if you specify the monitoring interval along with the adminagent.userserver.watch.interval key of the Administration Agent property file, the value specified in this tag is valid.

1

start-time-watch-interval

Specify the start time monitoring interval, as an integer between 1 and 86400 (units: seconds).

1

env

Define the environment variable.
You can specify multiple name-value pairs.

--

name

Specify an environment variable name.
Specify this value without fail.

--

value

Specify an environment variable name.
Specify this value without fail.
If the string ${cosminexus.home} exists in the value specified for environment variables, that value is replaced with Cosminexus-installation-directory.

--

working-dir

Specify the working directory, as an absolute path.

Cosminexus-installation-directory/manager/bin

user-id

Specify the user ID at command runtime.
This element is used for UNIX.

--

group-id

Specify the group ID at command runtime.
This element is used for UNIX.

--

command

Define the command.
Specification is mandatory. You can specify multiple commands.

--

type

Specify the command type#1. You can specify the following values:
Start: Command for starting the server
Stop: Command for stopping the server
ForceStop: Command for forced termination of the server
GetProcessID: Command for acquiring process ID
IsAlive: Command for service monitoring
Specification is mandatory.

--

timeout

Specify an integer (units: bytes) from 1 to 86400 for the timeout time.
It is valid only when the command type is getProcessID or isAlive.

180

arg

Specify the command arguments.#2
Specification is mandatory.
To add arguments and argument values for a command, specify multiple <arg> tags.
An example of specifying the <arg> tag is as follows:
<arg>Command</arg>
<arg>Argument-1</arg>
<arg>Value-specified-in-Argument-1</arg>
<arg>Argument-2-(No-value-is-specified)</arg>
<arg>Argument-3</arg>
<arg>Value-specified-in-Argument-3</arg>

--

server

Define the logical user server.
Specification is mandatory. You can specify multiple servers.

--

logical-server-name

Specify logical server name in less than 128 characters. You can use single byte alphanumeric characters (A to Z, a to z, 0 to 9), under scores (_), and hyphens (-).
Specification is mandatory.

--

display-name

Specifies the display name of the logical server within 128 characters.

--

description

Specify the explanation about the logical server in less than 1024 characters.

--

host-ref
Specify the host name defined beforehand in less than 255 characters. You can use single byte alphanumeric characters (A to Z, a to z, 0 to 9), under scores (_), hyphens (-), and periods(.).
Specification is mandatory.
--

#1

Depending on the type of startup, the various command types have different conditions of specification. The following table describes the specification conditions and command type requirements based on the type of startup:

Startup type
Command type
Specification condition
Requirements
Remarks

Direct start
start
Required
Server startup commands are included in the scope of monitoring.
--

stop
Optional
The monitored process is already stopped when the server stop command terminates normally.
When you do not specify a stop type of command, the following operations are performed:

In Windows
A Ctrl-C event is issued to the corresponding process. If the process does not stop, TerminateProcess () is executed.

In UNIX
A SIGTERM signal is sent to the corresponding process. If the process does not terminate within 1 second after that, a SIGKILL signal is sent.

forceStop
Optional

The monitored process is already stopped when the forceStop type of command terminates.

After issuing a forceStop type of command, the server startup commands are in an executable status.

When you do not specify a stop type of command, the following operations are performed:

In Windows
A Ctrl-C event is issued to the corresponding process. If the process does not stop, TerminateProcess () is executed.

In UNIX
A SIGTERM signal is sent to the corresponding process. If the process does not terminate within 1 second after that, a SIGKILL signal is sent.

getProcessID
Cannot be specified
--
If specified, it results in error.

isAlive
Optional
The command should return a termination code of 0 if the service is running and a termination code other than 0, if the service is not running.
When specified, the service is monitored.

Indirect start
start
Required

All the monitored processes are started when the process startup command terminates normally.

When the process startup command terminates normally, the process stop commands are in an executable state.

The command returns the termination code as 0 in case of normal termination, and 1 in case of abnormal termination.

--

stop
Optional
The monitored process is already stopped when the server stop command terminates normally.
When you do not specify a stop type of command, the following operations are performed:

In Windows
A Ctrl-C event is issued to the corresponding process. If the process does not stop, TerminateProcess () is executed.

In UNIX
A SIGTERM signal is sent to the corresponding process. If the process does not terminate within 1 second after that, a SIGKILL signal is sent.

forceStop
Optional

The monitored process is already stopped when the forceStop type of command terminates.

After issuing a forceStop type of command, the server startup commands are in an executable status.

When you do not specify a stop type of command, the following operations are performed:

In Windows
A Ctrl-C event is issued to the corresponding process. If the process does not stop, TerminateProcess () is executed.

In UNIX
A SIGTERM signal is sent to the corresponding process. If the process does not terminate within 1 second after that, a SIGKILL signal is sent.

getProcessID
Required

The command outputs the process ID of the process started by the server startup command, to the standard output.

When multiple processes are started, the command outputs the process IDs of all the processes.

The command returns the termination code as 0 in case of normal termination, and 1 in case of abnormal termination.

The output format is as follows:

9 9 9 6 \n
1 0 0 2 3 \n
1 0 2 5 7 \n

--

isAlive
Optional
The command should return a termination code of 0 if the service is running and a termination code other than 0, if the service is not running.
When specified, the service is monitored.

#2

If you use any of the following character strings when specifying the value of a command argument, it is replaced with the corresponding value of that string:

Character string before replacement | Character string after replacement | Remarks
${cosminexus.home} | Cosminexus-installation-directory | --
%{XXX} | Environment variable XXX value | When the environment variable XXX does not exist, it is replaced with a blank character string.
${server.name} | logical-server-name | --

(5) Sample definition

<?xml version="1.0" encoding="UTF-8" ?>
<user-server-definition xmlns="http://www.cosminexus.com/mngsvr/schema/UserServerDefinition-1.1">

<!--Service definition -->
<service>
<!--Start type -->
<type>direct</type>
<!--Startup order -->
<startup-order>900</startup-order>
<!--Start monitoring time -->
<start-watch-time>60</start-watch-time>
<!--Stop monitoring time -->
<stop-watch-time>60</stop-watch-time>
<!--Forced stop monitoring time -->
<force-watch-time>60</force-watch-time>
<!--Retry count -->
<retry-count>1</retry-count>
<!--Retry interval -->
<retry-interval>60</retry-interval>
<!--Monitoring interval -->
<watch-interval>1</watch-interval>
<!--Start time monitoring interval -->
<start-time-watch-interval>1</start-time-watch-interval>
<!--Environment variable -->
<env name="USERSERVER_HOME" value="C:\UserServer"/>
<!--Working directory -->
<working-dir>C:\UserServer</working-dir>
<!--User ID -->
<user-id>userserver</user-id>
<!--Group ID -->
<group-id>userserver</group-id>
<!--Server startup command -->
<command type="start">
<arg>C:\UserServer\start.exe</arg>
</command>
<!--Server stop command -->
<command type="stop">
<arg>C:\UserServer\stop.exe</arg>
</command>
<!--Command for forced termination of server -->
<command type="forceStop">
<arg>C:\UserServer\forceStop.exe</arg>
</command>
<!--Command to get process ID -->
<!--
<command type="getProcessID" timeout="180">
<arg>C:\UserServer\getProcessID.exe</arg>
</command>
-->
<!--Command for service monitoring -->
<command type="isAlive" timeout="180">
<arg>C:\UserServer\isAlive.exe</arg>
</command>
</service>

<!--Logical user server definition -->
<server>
<logical-server-name>UserServer01</logical-server-name>
<display-name>Logical user server</display-name>
<description>This is a logical user server</description>
<host-ref>192.168.1.1</host-ref>
</server>
</user-server-definition>

(6) Precautions

When the stop and forceStop commands are not specified, do not specify batch files or the shell scripts that invoke other processes in the start command. If you specify the batch files or shell scripts, after restarting the Administration Agent, you cannot stop the processes invoked by the batch files or shell scripts by extending the stop operation or forced stop operation.

When you specify batch files or shell scripts that invoke other processes, in the start command during direct start, specify the stop command and the forceStop command also.

When you specify batch files or shell scripts that invoke other processes, in the start command during indirect start, follow the below steps:

Specify the stop command and the forceStop command.

Specify the getProcessID command to fetch the process ID of all the processes invoked by the batch files or shell scripts.

Specify settings for the isAlive command used with the start processing of the logical user server such that instead of waiting until the starting of the logical user server can be confirmed, the command must terminate with a non-zero exit code as soon as the confirmation fails.
If the isAlive command does not terminate immediately and if the logical user server hangs up during the start processing, the auto-stop processing of the logical user server might not be executed when the exceeding of the start monitoring time of the logical user server is detected.
Also, implement the isAlive and getProcessID commands with confirmation methods that are as simple as possible, so that a response is returned immediately even if the machine load is high.

11. Files Used in Virtual Systems (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

Organization of this chapter

11.1 (INTENTIONALLY DELETED)

11.1 (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

12. Files Used in Log Operations

This chapter describes the format of the files, storage locations, and variables that you can use in log operations.

Organization of this chapter

12.1 List of files used in log operations

12.2 Definition file for snapshot log collection

12.1 List of files used in log operations

The following table lists the files used in log operations:

Table 12-1 List of files used in log operations

File name | Classification | Overview | Reference
(Optional) | Definition file for snapshot log collection | Define the target files for the primarily sent data, secondarily sent data, and definition sending data to be collected as the snapshot log. | 12.2

12.2 Definition file for snapshot log collection

The snapshot log collects information required to maintain the system and the applications.

In the definition file for the snapshot log collection, specify the target files for the primarily sent data, secondarily sent data, and definition sending data to be collected as the snapshot log. The specified file will be collected as the snapshot log. You can edit this file to change the path of the definition file for snapshot log collection.

Organization of this section

(1) Format

(2) Storage locations and file names

(3) Variables that you can use

(4) Examples of coding

(1) Format

Specify the definition file in the following format:

Specify the collection path as a full path.

The line beginning with a hash mark (#) is a comment.

Use "/" as a file separator.

Use a regular expression# for path elements classified by the file separator.

If the format includes an invalid regular expression#, the specification will be ignored.

If a file does not exist in the specified path, the specification will be ignored.

#

For details on regular expressions, see the definition of java.util.regex.Pattern.

(2) Storage locations and file names

When editing the default installation setup file

Edit the following files:

In Windows
Cosminexus-installation-directory\manager\config\snapshotlog.conf
Cosminexus-installation-directory\manager\config\snapshotlog.2.conf
Cosminexus-installation-directory\manager\config\snapshotlog.param.conf

In UNIX
/opt/Cosminexus/manager/config/snapshotlog.conf
/opt/Cosminexus/manager/config/snapshotlog.2.conf
/opt/Cosminexus/manager/config/snapshotlog.param.conf

Specify the files to be collected as primary delivery material in snapshotlog.conf and the files to be collected as secondary delivery material in snapshotlog.2.conf. In snapshotlog.param.conf, specify the data to be collected as the definition sending data.

For details about the files collected by snapshot log, see 2.3.3 Collecting snapshot log in the manual uCosminexus Application Server Maintenance and Migration Guide.

When specifying any file

Any storage location and filename is possible.

Copy and use the available template in the following locations:

In Windows
Cosminexus-installation-directory\manager\config\templates\

In UNIX
/opt/Cosminexus/manager/config/templates/

(3) Variables that you can use

You can use the following variables when you specify a path:

Table 12-2 Variables that you can use in the definition file for snapshot log collection

Variables
Contents

${cosminexus.home}
Installation directory of the Cosminexus server

${user.home}
Home directory of a user

${hws.home}
Cosminexus HTTP Server installation directory

${com.cosminexus.manager.log.dir}
Log output directory of the Cosminexus Manager

&{prfspool}
The value is specified as follows:
In the environment settings of the logical server, choose the Settings tab of the Performance Tracer, go to Performance tracer settings and specify the value in the spool directory.

&{ctmspool}
The value is specified as follows:
In the environment settings of the logical server, choose the Basic settings tab of the CTM domain manager, go to Basic settings of CTM domain manager and specify the value in the spool directory.

&{ejb.public.directory}
The value is specified as follows:
In the environment settings of the logical server, choose the Container-J2EE tab of the J2EE server, go to J2EE Container settings and specify the value in the definition of the working directory.

&{webserver.work.directory}
The value is as follows:
In the environment settings of the logical server, choose the Container-Web tab of the J2EE server and specify the value in the temporary directory for JSP.

&{ejb.server.log.directory}
The value is specified as follows:
In the environment settings of the logical server, choose the Service-Log tab of the J2EE server and specify the value in the log output directory.

&{webserver.logger.access_log.inprocess_http.filename}
The value is specified as follows:
In the environment settings of the logical server, choose the Service-Transaction tab of the J2EE server; go to Access log settings and specify the value in the output file name.

&{ejbserver.distributedtx.ots.status.directory1}
The value is specified as follows:
In the environment settings of the logical server, choose the HTTP Server-Log tab of the J2EE server and specify the value in the location for saving the status file of the in-process OTS.

&{ejbserver.distributedtx.ots.status.directory2}
The value is specified as follows:
In the environment settings of the logical server, choose the HTTP Server-Log tab of the J2EE server and specify the value in the location for saving the status file (spare) of the in-process OTS.

&{core.dump.directory}
The value is specified as follows:
In the environment settings of the logical server, choose the Settings tab of the Web server; go to Web server basic settings and specify the value in the directory where the core dump is to be output.

&{hws.logfile.dir}
The value is specified as follows:
In the environment settings of the logical server, choose the Settings tab of the Web server; go to Web server log output settings and specify the value in the directory where the log is to be output.

&{jklogfiledir}
The value is specified as follows:
In the environment settings of the logical server, choose the Redirector tab of the Web server and specify the value in the directory where the log is to be output.

&{jktracelogfiledir}
The value is specified as follows:
In the environment settings of the logical server, choose the Redirector tab of the Web server and specify the value in the directory where the maintenance trace log is to be output.

&{ctm.RegOption}
Setup file for the CTM regulator.

&{ctm.TSCGwOption}
Setup file for the OTM gateway.

${adminagent.prftrace_dir}
Output destination directory for the temporary PRF trace file.

Note:

The dollar sign ($) indicates the system properties and the ampersand (&) indicates the internal variables of the Management Server.

You cannot use variables that include the dollar sign ($) in the value.

When you collect log using the snapshot log collection command, you cannot the use internal variables of Management Server that contain the ampersand sign. However, &{ejb.public.directory} can also be used with the snapshot log collection command.

(4) Examples of coding

When collecting /home/logdir/message1.log

/home/logdir/message1\#.log

When collecting all the files in the /opt/Cosminexus/manager/log directory

${cosminexus.home}/manager/log/.+#

When collecting the JavaVM thread dump of the J2EE server (Working directory=/home/workdir, J2EE server name=Server1)

/home/workdir/ejb/Server1/javacore.+\#.txt

#

The back slash (\) is a character that negates the period (.).

The period (.) sign indicates any character.

The plus sign (+) indicates one or more times.

13. Files Used for Setting Audit Log (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

Organization of this chapter

13.1 (INTENTIONALLY DELETED)

13.1 (INTENTIONALLY DELETED)

(INTENTIONALLY DELETED)

14. Files Used in Java Applications

This chapter describes the functionality, storage locations, and the format of the files used in the Java applications and the keys that you can specify in the files.

Organization of this chapter

14.1 List of files used in the Java applications

14.2 usrconf.cfg (Option definition file for Java applications)

14.3 usrconf.properties (User property file for Java applications)

14.4 System properties specified in the Java application

14.5 Property setup file for the user log of Java applications

14.1 List of files used in the Java applications

The following table lists the files used in the Java applications:

Table 14-1 List of files used in the Java applications

File name
Classification
Overview
Reference

usrconf.cfg
Option definition file for Java applications
Specify the start option of the JavaVM that executes the Java application.
Use this file when starting a Java application with the cjclstartap command.
14.2

usrconf.properties
User property file for Java applications
Specify the system properties of the JavaVM that executes the Java application.
Use this file when starting a Java application with the cjclstartap command.
14.3

(Optional)#
System properties specified in the Java application
Specify the system properties of the JavaVM that executes the Java application.
When you use the vbj command to start the Java application, specify the system properties as command arguments in the batch file or shell script.
14.4

(Optional)
Property setup file for the user log of Java applications
Use this file for the user log of Java applications.
Use this file to start the Java application with the vbj command.
14.5

#

Specify the required system properties for each command (vbj command) to be used for starting the Java application. When invoking the Enterprise Beans from a Java application, you need to specify the system properties.

Use one of the following commands to start a Java application:

cjclstartap command
You normally use the cjclstartap command. The storage location of the command is as follows:

In Windows
Cosminexus-installation-directory\CC\client\bin\cjclstartap

In UNIX
/opt/Cosminexus/CC/client/bin/cjclstartap

vbj command
The vbj command is a command for compatibility provided to users who are already using this command. The storage location of the command is as follows:

In Windows
Cosminexus-installation-directory\TPB\bin\vbj

In UNIX
/opt/Cosminexus/TPB/bin/vbj

14.2 usrconf.cfg (Option definition file for Java applications)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Specifiable keys

(5) Examples of coding

(6) JavaVM options that can be specified with add.jvm.arg

(7) Notes

(1) Format

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

If you specify a path containing a space in the value, you need not enclose the path in double quotation marks (").

You cannot code with a character encoding that is different from the runtime character encoding.

(2) File storage location

In Windows
user-definition-file-storage-directory#\usrconf.cfg

In UNIX
user-definition-file-storage-directory#/usrconf.cfg

#

This is the directory specified in the user definition file storage location environment variable (CJCLUSRCONFDIR). Always specify this environment variable before executing the cjclstartap command. For details on the environment variable settings required to execute EJB client applications, see 3.3.4 Environment variable settings required to execute EJB client applications in the manual uCosminexus Application Server EJB Container Functionality Guide.

(3) Functionality

This file specifies the invocation options of the JavaVM that executes the Java application when you use the cjclstartap command.

If you change the contents of this file while the Java application is running, the changes are applied only when the Java application is started next.

(4) Specifiable keys

The specifiable keys and default values are described below. When an invalid value is specified for this key, operation is not guaranteed.

Hint

The following contents are explained:

Overview of the keys that you can specify in the usrconf.cfg file for Java applications
Of the keys that can be specified, those that are common with usrconf.cfg for J2EE servers are not explained in detail here.
For details on the common keys, see 2.3 usrconf.cfg (Option definition file for J2EE servers). When referencing, substitute J2EE server for Java application.
This subsection also explains the details of keys, if the specification contents and the keys for J2EE server differ greatly.

Differences with the keys for J2EE server (when the keys and specification contents of the usrconf.cfg file for J2EE server are different)
This subsection explains the details about the keys when specifications for the Java application keys and the J2EE server keys are different. Note the differences in the Difference column.

Table 14-2 Keys and default values that you can specify in usrconf.cfg (Java application)

Key name
Difference
Contents
Default value

add.jvm.arg
None
This key invokes JavaVM by using the specified option.
For details about JavaVM options that can be specified in add.jvm.arg, see 14.2(6)(a) JavaVM options that can be specified in the add.jvm.arg key of the Java application.
For details about default values, see 14.2(6)(b) Default values of the JavaVM options specified in the option definition file for Java applications.

add.class.path
Exists
Specify JAR for the container extension library.
Specify the class path (stubs.jar, numeric.jar, user class.jar) necessary for the execution of each EJB application.
If a path containing space is specified in the value, the path need not be enclosed with double quotation mark ("). Also, values specified in double quotations are not valid.
--

add.library.path#
None
Specify the shared library for JNI
--

cpp.library.version
None
Specify the version of libstdc++ library used in the process. Note that this key is used in Linux.
The following string can be specified:

6:

The libstdc++.so.6 library will be used. This key is invalid when specified on platforms other than Red Hat Enterprise Linux.

Only 6 can be specified with version 09-00 or later.
6

ejb.client.directory.shareable
Unique
Specify whether to simultaneously start multiple cjclstartap commands that use the same current directory or the same log output destination directory.

If you specify true:

Multiple commands are started at the same time.

If you specify false:

Multiple commands are not started at the same time.

true

ejb.client.ejb.log
Unique
Specify a value from 1 to 16 bytes for the name of the log output destination directory of the messages output by the Java application under the directory specified in the ejb.client.log.directory key.
You can specify single-byte alphanumeric characters, underscores (_), and hyphens (-).
If you specify a string that exceeds 16 bytes, the KDJE40051-W message is output.
If there are no access permissions for the directory and if you specify the file name, the KDJE40052-E message is output and the Java application terminates.
If you specify ejbserver.client.ejb.log in the user property file (usrconf.properties), the specification of the user property file is given priority at the following log file output destinations:

Operation log

Exception information in the case of failure

Maintenance information

system

ejb.client.log.appid
Unique
Specify a value from 1 to 16 bytes for the name of the log output destination subdirectory of the messages output by the Java application.
You can specify single-byte alphanumeric characters, underscores (_), and hyphens (-).
If you specify a string that exceeds 16 bytes, the KDJE40051-W message is output.
If there are no access permissions for the directory and if you specify the file name, the KDJE40052-E message is output and the Java application terminates.
If you specify ejbserver.client.log.appid in the user property file (usrconf.properties), the specification of the user property file is given priority at the following log file output destinations:

Operation log

Exception information in the case of failure

Maintenance information

ejbcl

ejb.client.log.directory
Unique
Specify the log output destination path for the Java application in the range of 1 to 180 bytes.
Specify the path as an absolute path or as a relative path from the current directory.
You can specify single-byte alphanumeric characters, underscores (_), hyphens (-), and path separation characters.
If you specify a path exceeding 180 bytes (when the relative path is specified, the total of absolute path and relative path up to the current directory), the KDJE40059-W message is output and the default value is used. When the default value exceeds 180 bytes, log initialization fails and terminates abnormally.
In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk.
If there are no access permissions for the directory and if you specify the file name, the KDJE40052-E message is output and the Java application terminates.
If you specify ejbserver.client.log.directory in the user property file (usrconf.properties), the specification of the user property file is given priority at the following log file output destinations:

Operation log

Log operation log

Exception information in the case of failure

Maintenance information

Current-directory/logs

ejb.client.log.stdout.enabled
Unique
Specify whether to output messages in the standard output.

true:

Messages are output in the standard output.

false:

Messages are not output in the standard output.

Following are the logs in which messages output in the standard output can be controlled:

Operation log

cjclstartap command log

Standard output information of the invocation process

true

jvm.type
Unique
Specify type of the JavaVM to be used. You can specify one of the following values:

client
Java HotSpot Client VM is used.

server
Java HotSpot Server VM is used.

If the specified value is wrong, JavaVM is searched in the "client" and "server" order. At this time, a message KDJE40020-W is output.
client

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

None:

This is a common key or default value in the usrconf.cfg file for Java applications and the usrconf.cfg file for J2EE servers. For details about keys, see 2.3 usrconf.cfg (Option definition file for J2EE servers).

Unique:

This is a key specific to usrconf.cfg file for Java applications. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.cfg file for Java applications and the usrconf.cfg file for J2EE servers. For details about the default value, see 2.3 usrconf.cfg (Option definition file for J2EE servers).

#

If both the add.library.path and OS environment variables (such as LIBPATH) are set up when executing the cjclstartap command, the add.library.path settings have a higher priority.

(5) Examples of coding

# EJB client application classpath
# RMI-IIOP Stubs jar file
add.class.path=Java-application-storage-path\stubs.jar

# RMI-IIOP interface jar file
add.class.path=Java-application-storage-path\1.jar

# User class
add.class.path=Java-application-storage-path\Java-application-jar
#add.class.path=user-classpath

# java vm options
add.jvm.arg=-Xms256m
add.jvm.arg=-Xmx512m

(6) JavaVM options that can be specified with add.jvm.arg

This section describes the JavaVM options that you can specify in add.jvm.arg and the default values for Java applications.

(a) JavaVM options that can be specified in the add.jvm.arg key of the Java application

This section describes the JavaVM options that you can specify in the add.jvm.arg key specified in the option definition file for Java applications. JavaVM options include the options that can be specified as per the standards and the JavaVM extension options. Also, the default values of JavaVM options depend on the server to be used. For details about JavaVM extension options, see 16.1 List of JavaVM extension options. For details about Java HotSpot VM options, see 16.5 Java HotSpot VM options that can be specified in Cosminexus.

The JavaVM options that you can specify in the add.jvm.arg key of the J2EE server are as follows:

-agentlib:libname[=options]

-Dproperty

-verbose:[class|gc|jni]

-Xloggc:file

-Xmssize

-Xmxsize

-Xmnsize

-Xsssize

-Xprof

-Xrunhprof[:help]|[:option=value, ...]

-XrunlibraryName

-Xdebug

-XX:NewRatio=value

-XX:PermSize=value

-XX:MaxPermSize=value

-XX:SurvivorRatio=value

-XX:[+|-]PrintTenuringDistribution

-XX:TargetSurvivorRatio=value

-XX:MaxTenuringThreshold=value

-Xrunhndlwrap

-agentlib:hndlwrap2

(b) Default values of the JavaVM options specified in the option definition file for Java applications

This section describes the default values of JavaVM options for J2EE servers:

-XX:HitachiJavaLog:ejb.client.log.directory\ejb.client.ejb.log\ejb.client.log.appid

-XX:+HitachiOutOfMemoryStackTrace

-XX:-HitachiThreadDumpToStdout

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiJavaClassLibTrace

-XX:+HitachiLocalsInStackTrace

-XX:HitachiJavaClassLibTraceLineSize=1024

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:+HitachiLocalsInStackTrace

-XX:+HitachiVerboseGC

-XX:+HitachiVerboseGCPrintCause

-XX:+HitachiOutputMilliTime

(7) Notes

Do not use a character encoding that is different from the OS locale. If UTF-8 is used in the OS locale, do not use UTF-8 with BOM.

If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.

Among the values specified in the add.class.path key, there are some values for which the <cosminexus.home> tag is used to specify the JAR files for the container extension library. These values indicate the installation destination of Application Server, so you do not need to change the contents coded for the add.class.path key. Note that when you add the container extension library to the add.class.path key, the installation and uninstallation operations might not be guaranteed; therefore, do not use the <cosminexus.home> tag.

14.3 usrconf.properties (User property file for Java applications)

Organization of this section

(1) Format

(2) File storage location

(3) Functionality

(4) Keys for customizing the Java applications

(5) Examples of coding

(1) Format

J2SE property file format.

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.

If the format does not conform to Java specifications, the Java application might fail to start.
(Example) When the format contains an invalid Unicode escape sequence (the string after "\u" is not an appropriate Unicode hexadecimal value).

(2) File storage location

In Windows
user-definition-file-storage-directory#/usrconf.properties

In UNIX
user-definition-file-storage-directory#/usrconf.properties

#

This is the directory specified in the user definition file storage location environment variable (CJCLUSRCONFDIR). Always specify this environment variable before executing the cjclstartap command. For details on the environment variable settings required to execute EJB client applications, see <3.3.4 Environment variable settings required to execute EJB client applications in the manual uCosminexus Application Server EJB Container Functionality Guide.

(3) Functionality

This file specifies the system properties of the JavaVM that executes the Java application when you use the cjclstartap command.

If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.

If you change the contents of this file while the Java application is running, the changes are applied only when the Java application is started next.

(4) Keys for customizing the Java applications

You can customize the operations of the Java applications by setting values for the following system property keys in the start command of the Java application:

The keys are classified and explained as follows:

Keys beginning with ejbserver.application

Keys beginning with ejbserver.client

Keys beginning with ejbserver.container

Keys beginning with ejbserver.distributedtx

Keys beginning with ejbserver.jndi

Keys beginning with ejbserver.jta

Keys beginning with ejbserver.logger

Keys beginning with ejbserver.rmi

Keys beginning with ejbserver.security

Keys beginning with ejbserver.server

Keys beginning with ejbserver.stdoutlog

Keys beginning with https

Keys beginning with java

Keys beginning with org

Keys beginning with vbroker

The following table lists the keys that you can specify in the usrconf.properties file for the Java applications:

Note

The following contents are explained:

Overview of the keys that you can specify in the usrconf.properties file for the Java applications
Of the keys that can be specified, those that are common with the usrconf.properties file for the J2EE server are not explained in detail here.
For details on the common keys, see 2.4 usrconf.properties (User property file for J2EE servers). In the case of Java applications, read 'Java application' in place of 'J2EE server'.
This subsection also explains the details of keys, if the specification contents and the keys for J2EE server differ greatly.

Differences with the keys for J2EE server (when the keys and the specification contents of the usrconf.properties file for J2EE server are different)
This subsection explains the details about the keys when specifications for the Java application keys and the J2EE server keys are different. If differences are not specifically coded, specify the same contents as the keys of the usrconf.properties file for the J2EE server. Note the differences in the Difference column.

Details of the usrconf.properties file-specific keys for the Java application
This subsection explains the details of the usrconf.properties file-specific keys for the Java applications.

(a) Keys beginning with ejbserver.application

The keys that begin with ejbserver.application and can be specified in the usrconf.properties file for Java applications are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.4(5)(b)Keys beginning with ejbserver.application.

Key name
Difference
Contents
Default value

ejbserver.application.userlog.CJLogHandler.handler-name#1.appname
None
Specify the default application name that is output to the AppName field.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.autoFlush.enabled
Unique
Specify whether flush is to be carried out after the message is output.

If you specify true:

The flush command will be executed for every message.

If you specify false:

The flush command will not be executed.

This specification is not necessary when you do not use CJMPMessageFileHandler. Do not specify true when java.util.logging.Handler.flush() is explicitly invoked in the application program.
false

ejbserver.application.userlog.CJLogHandler.handler-name#1.count
None
Specify the number of log files.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.encoding
None
Specify encoding of the character strings to be output.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.filter
None
Specify the filter to be used with its full name, including the package name.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.formatter
None
Specify the formatter that you will use along with its full name, including the package name.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.level
None
Specify an upper-limit of a log collection level.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.limit
None
Specify the capacity of a log file.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.msgid
None
Specify the default message ID that is output to the MsgID field.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.path
Exists
Specify a value from 1 to 255 bytes for the prefix of a log file name. Specify the path as a relative path. Do not specify a single-byte numeric value at the end of the path name.
The value obtained by adding "xx (an integer between 1 to 16).log" to the prefix specified in this key forms the name of the trace information file.
The single-byte alphanumeric characters specified in the path are not case-sensitive. Specify the length of the path value, such that the total of the following A + B + C values is within the range of the value:

A (in Windows): log-output-destination-root (value of ejbserver.client.log.directory)\user\ (by default, Cosminexus-installation-directory\CC\client\logs\user\)

A (in UNIX): log-output-destination-root (value of ejbserver.client.log.directory) /user/ (by default, /opt/Cosminexus/CC/client/logs/user/)

B: Length of the prefix specified by the user

C: Six characters of "xx.log"

Apart from the above, note the following when specifying the path:

Double-byte codes of native cannot be used in the Properties file, therefore, acquire and specify the Unicode strings by using native2ascii.

Do not specify as an absolute path. Do not use "..\" ("../" in Unix) of a relative path.

If the path includes Japanese characters, JavaVM needs to be running in an environment where the locale settings enable the processing of Japanese characters.

You cannot set the same path as another handler. If you set the same path, the handler is not created.
--

ejbserver.application.userlog.CJLogHandler.handler-name#1.separator
None
Use the CJSimpleFormatter and specify a separator to output a message in one sentence.
--

ejbserver.application.userlog.loggers
None
Declare the names of the loggers to be used.
--

ejbserver.application.userlog.Logger.logger-name#2.filter
None
Specify the full name including the package name of the filter used in the logger.
--

ejbserver.application.userlog.Logger.logger-name#2.handlers
None
Specify the handler class for the specified logger name.
--

ejbserver.application.userlog.Logger.logger-name#2.level
None
Specify the log output level of the logger.
--

ejbserver.application.userlog.Logger.logger-name#2.useParentHandlers
None
Specify whether the log record is to be transmitted from the logger that received the log record to the handler connected to the parent logger.
--

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(b) Keys beginning with ejbserver.application.

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(b) Keys beginning with ejbserver.application.

#1

Use the handler name to differentiate between the property values. Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name. If you specify default, handler name indicates a property that is recognized as the common default value by all CJLogHandler.

#2

Logger name has "." that is specified for getting the instances of logger by Logger.getLogger (logger-name). Logger name must be declared beforehand in the ejbserver.application.userlog.loggers property. For details on the logger name, follow the specifications of java.util.logging.Logger.

Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name. If you specify default, handler name indicates a property that is recognized as the common default value by all CJLogHandler.

The properties identified by the logger names are used for initializing the logger class of the user log functionality.

If a logger name ends with .handlers, there may be confusion when the properties of ejbserver.application.userlog.Logger.logger-name.handlers are specified, and therefore, Hitachi recommends that you do not end a logger name with ".handlers".

(b) Keys beginning with ejbserver.client

The keys that begin with ejbserver.client and can be specified in the usrconf.properties file for the Java application are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.4(5)(c)Keys beginning with ejbserver.client.

When using uCosminexus Client, read the storage directory Cosminexus-installation-directory\CC as Cosminexus-installation-directory \CCL.

Key name
Difference
Contents
Default value

ejbserver.client.ctm.RequestPriority
None
Specify the priority (priority order) for extracting the request accumulated in the queues within CTM.
--

ejbserver.client.ejb.log
Unique
Specify a value from 1 to 16 bytes for the name of the log output directory of the messages output by the Java application under the directory specified in the ejbserver.client.log.directory key. You can specify only single byte alphanumeric characters, underscore (_), and hyphen (-). You use a slash (/) as the directory path delimiter. When using multiple Java applications, specify the log output destinations for every EJB application.
When the specified directory name or file name does not have access permission, the message KDJE51003-E is output in standard output and cjlogger.log file and the Java application is terminated.
The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.ejb.log key in the option definition file for Java applications (usrconf.cfg).
None

ejbserver.client.log.appid
Unique
Specify a value from 1 to 16 bytes for the log output subdirectory of the Java application.
You can specify only single byte alphanumeric characters, underscore (_), and hyphen (-). When this key is specified, the same subdirectory is used every time and therefore, the subdirectory is not deleted. If you use this key in the cases where you do not invoke one Java application many times, then you can manage the log file in an exclusive subdirectory. Do not specify this key when concurrently invoking multiple applications.
If the specified string exceeds 16 bytes, the message KDJE51002-W is output to the cjlogger.log file and normal value is used.
The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.log.appid key in the option definition file for Java applications (usrconf.cfg).
None

ejbserver.client.log.directory
Unique
Specify a value from 1 to 200 bytes for the absolute path of the log output destination of the Java application.
You can specify only single byte alphanumeric characters, underscore (_), hyphen (-), and space (). You can specify space only in Windows. To specify a directory containing whitespace#, enclose the path with double quotation marks ("). For example, when setting C:\logs\ejb client, specify the path as follows:

ejbserver.client.log.directory="C:\logs\ejb client"

When the specified path exceeds 200 bytes, the message KDJE51001-W is output to the cjlogger.log file and the normal value is used. When a path is not specified, the message KDJE51002-W is output to the cjlogger.log file and the normal value is used.
When there is no access permission to the directory or when the file name is specified, the message KDJE51003-E is output to standard output and cjlogger.log file and the Java application is terminated.
In the case of using normal value, if you invoke the Java application by using Java other than the Cosminexus Developer's Kit for Java, the message KDJE51004-W is output to the cjlogger.log file and Java application execution directory is used.
In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk.
The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.log.directory key in the option definition file for Java applications (usrconf.cfg).
None

ejbserver.client.log.lockInterval
Unique
Specify the retry interval (unit: milliseconds) as integers from 0 to 2147483647​ for failure in an attempt of exclusive processing of log files. If the specified value is out of the range or is not an integer, the message KDJE51002-W is output to the cjlogger.log file and the default value is used. This key is used when the Java application operating in the shared subdirectory mode terminates after the output of the message KDJE90002-E to the cjlogger.log file.
10

ejbserver.client.log.lockRetryCount
Unique
If the exclusive process of the log file fails, specify the retry frequency (unit: times) in integers from 0 to 2147483647​. If the specified value is out of the range and is not an integer, the message KDJE51002-W is output to the cjlogger.log file and the default value is used. This key is used when the Java application operating in the shared subdirectory mode terminates after the output of the message KDJE90002-E to the cjlogger.log file.
1000

ejbserver.client.transaction.clientName
Unique
Specify a string from 1 to 128 characters for the client name used by the transaction service. You can specify single byte alphanumeric characters, (0-9, A-Z, a-z), underscore (_) and hyphen (-).
You need to specify a client name that is different for each process of the Java application.
Moreover, you need to specify a client name that is different from the name of the J2EE server operating on the same machine.
None

ejbserver.client.transaction.enabled
Unique
Specify whether transaction is to be used in the Java application.

If you specify true:

The transaction can be used.

If you specify false:

The transaction cannot be used.

false

Legend:

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(c) Keys beginning with ejbserver.client.

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(c) Keys beginning with ejbserver.client.

#

Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).

(c) Keys beginning with ejbserver.container

The keys that begin with ejbserver.container and can be specified in the usrconf.properties file for the Java application are listed below. For details about the usrconf.properties file for J2EE servers and the common keys, see 2.4(5)(h) Keys beginning with ejbserver.container.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name | Difference | Contents | Default value | Related information
ejbserver.container.rebindpolicy | None | Specify re-connection and re-sending of requests in the EJB client, in the case of a communication failure when invoking the EJB method. | -- | 2.13 Invoking the EJB remote interface in EJB Container Functionality Guide

Legend:

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(h) Keys beginning with ejbserver.container.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(h) Keys beginning with ejbserver.container.

(d) Keys beginning with ejbserver.distributedtx

The keys that begin with ejbserver.distributedtx and can be specified in the usrconf.properties file for the Java application are described below. For details about the keys that are common with the usrconf.properties file of J2EE servers, see 2.4(5)(k) Keys beginning with ejbserver.distributedtx.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Key name
Difference
Contents
Default value
Related information

ejbserver.distributedtx.ots.status.directory1
Exists
Specify the directory for storing the status file of the in-process transaction service and the backup of the status file as maintenance data. You use a forward slash (/) as the path delimiter.
When an absolute path is specified in the application server, the path begins from the following directory:

In Windows
Cosminexus-working-directory\ejb\server-name

In UNIX
Cosminexus-working-directory/ejb/server-name

When an absolute path is specified in the Java, the path begins from the execution directory of the Java.
You need to specify a different directory so that the path does not overlap with the path of other J2EE servers or other Java application processes running on the same machine.
None
3.4 Managing transactions in Common Container Functionality Guide

ejbserver.distributedtx.ots.status.directory2
None
When replicating the status file of in-process transaction service, specify a directory that stores the backup of spare status files and the spare status files used as maintenance data.
--
3.4 Managing transactions in Common Container Functionality Guide

ejbserver.distributedtx.recovery.port
Exists
Specify an integer from 1 to 65535 for the fixed port number that is used for transaction recovery. If an invalid value is specified and when the specified port is already being used, an error occurs in the initialization process.
None

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(k) Keys beginning with ejbserver.distributedtx.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(k) Keys beginning with ejbserver.distributedtx.

Blank column:

Related information does not exist.

(e) Keys beginning with ejbserver.jndi

The keys that begin with ejbserver.jndi and can be specified in the usrconf.properties file for the Java application are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.4(5)(r) Keys beginning with ejbserver.jndi.

Key name
Difference
Contents
Default value

ejbserver.jndi.cache
Exists
Specify whether to implement the caching of distributed objects.

For caching:

Specify on.

For not cashing:

Specify off.

You need to specify com.hitachi.software.ejb.rmi.PortableRemoteObject in the javax.rmi.CORBA.PortableRemoteObjectClass key and com.hitachi.software.ejb.rmi.Util in the javax.rmi.CORBA.UtilClass key.
off

ejbserver.jndi.cache.interval
Exists
In the case of caching of distributed objects, specify an integer from 0 to 2147483647​ (units: seconds) as the interval for clearing the cache. If you specify a value other than a number from 1 to 2147483647​, the cache is not cleared. You need to specify com.hitachi.software.ejb.rmi.PortableRemoteObject in the javax.rmi.CORBA.PortableRemoteObjectClass key and com.hitachi.software.ejb.rmi.Util in the javax.rmi.CORBA.UtilClass key.
When using the failure detection functionality of the Naming Service, Hitachi recommends you to specify a short interval value (60 seconds).
--

ejbserver.jndi.cache.interval.clear.option
None
Decide the operations to be performed in the cache area of naming, after the lapse of the interval.
--

ejbserver.jndi.namingservice.group.list
None
Define the group of logical naming service that is to be searched during the round-robin search.
--

ejbserver.jndi.namingservice.group.specify-group-name.providerurls
None
Specify the root location of the Naming Service of each group.
--

ejbserver.jndi.request.timeout
None
Specify the timeout period of communication with the Naming Service.
--

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(r) Keys beginning with ejbserver.jndi.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(r) Keys beginning with ejbserver.jndi.

(f) Keys beginning with ejbserver.jta

The keys that begin with ejbserver.jta and can be specified in the usrconf.properties file for the Java application are listed below:

Key name
Difference
Contents
Default value

ejbserver.jta.TransactionManager.defaultTimeOut
Exists
Specify the transaction timeout default value (units: seconds) of the transaction that has been started in the Java application in the following range:

In 1.4 mode:

1 to 2147483647​

--

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(t) Keys beginning with ejbserver.jta.

(g) Keys beginning with ejbserver.logger

The keys that begin with ejbserver.logger and can be specified in the usrconf.properties file for the Java application are listed below:

Key name
Difference
Contents
Default value

ejbserver.logger.channels.define.channel-name#.filenum
Exists
Specify the number of log files of the Java application.
Specify integers from 1 to 64.
To change the number, stop all the processes that are generating output to the corresponding log file and either move the log file and the log management file under the mmap directory to a different directory or delete the files.
2

ejbserver.logger.channels.define.channel-name#.filesize
Exists
Specify integers from 4096 to 16777216​.
To change the size, stop all the processes that are generating output to the corresponding log file and either move the log file and the log management file under the mmap directory to a different directory or delete the files.
1048576​

ejbserver.logger.enabled.*
Exists
Specify the log level. Specify either one or more from among Error, Warning, Information and Debug.
If you specify only one log level, only the log of the applicable log level is output. When specifying more than one log levels, demarcate each level-name string with a comma (,).
Note that you cannot specify this key when you set the system properties using shell script.
Error

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

#

You can set the following names as channel name:

ClientMessageLogFile, ClientExceptionLogFile, ClientMaintenanceLogFile, EJBContainerLogFile, UserOutLogFile, or UserErrLogFile.

For details on obtaining materials, see <2.3 Acquiring data in the manual uCosminexus Application Server Maintenance and Migration Guide.

(h) Keys beginning with ejbserver.rmi

The keys that begin with ejbserver.rmi and can be specified in the usrconf.properties file for the Java application are listed below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.4(5)(y) Keys beginning with ejbserver.rmi.

Key name | Difference | Contents | Default value
ejbserver.rmi.request.timeout | None | Specify timeout period (unit: seconds) when communicating between clients and the server. | --

Legend:

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(y) Keys beginning with ejbserver.rmi.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(y) Keys beginning with ejbserver.rmi.

(i) Keys beginning with ejbserver.security

The keys that begin with ejbserver.security and can be specified in the usrconf.properties file for the Java application are listed below:

Key name
Difference
Contents
Default value

ejbserver.security.service.url
Unique
Specify the CORBA naming service that is connected to the J2EE server that performs the security authentication processing. Specify this key in the case of performing the authentication processing with the J2EE server that is connected to a naming service other than the naming service specified in java.naming.provider.url. Note that you need to specify the name of the J2EE server to be connected beforehand in the ejbserver.serverName key.
Specify the name using the corbaname format. When the name is not specified, the naming service specified in java.naming.provider.url is used.
(Specified format)
corbaname::host-name-of-the-naming-service:port-number-of-the-naming-service
corbaname::localhost:900

Legend:

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

(j) Keys beginning with ejbserver.server

The keys that begin with ejbserver.server and can be specified in the usrconf.properties file for the Java application are listed below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.4(5)(z) Keys beginning with ejbserver.server.

Key name | Difference | Contents | Default value
ejbserver.serverName | Unique | Specify the name of the J2EE server that connects to the Java application. | None
ejbserver.server.prf.PRFID | None | Specify the PRF identifier. | --

Legend:

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(z) Keys beginning with ejbserver.server.

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.4(5)(z) Keys beginning with ejbserver.server.

(k) Keys beginning with ejbserver.stdoutlog

The keys that begin with ejbserver.stdoutlog and can be specified in the usrconf.properties file for Java applications are as follows. For details about the keys that are common with the usrconf.properties file of J2EE servers, see 2.4(5)(ab) Keys beginning with ejbserver.stdoutlog.

Key name | Difference | Contents | Default value
ejbserver.stdoutlog.autoflush | None | Specify whether to enable the automatic flush functionality of the user output log and user error log. | --

Legend:

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about keys, see 2.4(5)(bb) Keys beginning with ejbserver.stdoutlog.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about default values, see 2.4(5)(bb) Keys beginning with ejbserver.stdoutlog.

(l) Keys beginning with https

The keys that begin with https and can be specified in the usrconf.properties file for Java applications are as follows. For details on the keys that are common with the usrconf.properties file for J2EE servers, see 2.4(5)(ae) Keys beginning with https.

Key name | Difference | Contents | Default value
https.cipherSuites | None | Specify the recommended cipher suite to be used with HttpsURLConnection. | --
https.protocols | None | Set up the protocol to be used with HttpsURLConnection. | --

Legend:

None:

This key is common to the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details on the keys, see 2.4(5)(ae) Keys beginning with https.

--:

This is a default value common to the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details on the default values, see 2.4(5)(ae) Keys beginning with https.

(m) Keys beginning with java

The keys that begin with java and that can be specified in the usrconf.properties file for the Java application are listed below. For details about the usrconf.properties file for J2EE servers and the common keys, see 2.4(5)(ff) Keys beginning with java.

Key name
Difference
Contents
Default value

java.naming.factory.initial
Exists
Specify the factory class for the implementation class of the context delegated by InitialContext of JNDI. The operation for each set value is as follows:

com.hitachi.software.ejb.jndi.InsContextFactory:

Specify this context when normal search functionality is used instead of the JNDI round-robin search functionality.

com.hitachi.software.ejb.jndi.GroupContextFactory:

Specify this context when the JNDI round-robin search functionality is used during execution of applications (EJB) in the J2EE server.

The key is compatible with the values used in the earlier versions (com.hitachi.software.ejb.jndi.spi.cosnaming.CNCtxFactory).
--

java.naming.provider.url
Unique
Specify the host name and the port number of the CORBA naming service used by the Java application. The CORBA naming service used here is the one that is used by the J2EE server invoked from the corresponding Java application.
Furthermore, this key is compatible with the protocol (iioploc or iiopname) used in the old versions.
(Specified format)
corbaname::[host-name]:[port-number]
None

javax.xml.datatype.DatatypeFactory
Unique
Specify the implementation class name of javax.xml.datatype.DatatypeFactory.
com.cosminexus.jaxp.impl.parsers.jaxp.datatype.DatatypeFactoryImpl

javax.xml.parsers.DocumentBuilderFactory
Unique
Specify the implementation class name of javax.xml.parsers.DocumentBuilderFactory.
com.cosminexus.jaxp.impl.parsers.jaxp.DocumentBuilderFactoryImpl

javax.xml.parsers.SAXParserFactory
Unique
Specify the implementation class name of javax.xml.parsers.SAXParserFactory.
com.cosminexus.jaxp.impl.parsers.jaxp.SAXParserFactoryImpl

javax.xml.transform.TransformerFactory
Unique
Specify the implementation class name of javax.xml.transform.TransformerFactory.
com.cosminexus.jaxp.impl.transform.processor.TransformerFactoryImpl

javax.xml.xpath.XPathFactory\:http\://java.sun.com/jaxp/xpath/dom
Unique
Specify the implementation class name of javax.xml.xpath.XPathFactory.
com.cosminexus.jaxp.impl.xpath.jaxp.XPathFactoryImpl

javax.xml.validation.SchemaFactory\:http\://www.w3.org/2001/XMLSchema
Unique
Specify the implementation class name of javax.xml.validation.SchemaFactory.
com.cosminexus.jaxp.impl.parsers.jaxp.validation.XMLSchemaFactory

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about keys, see 2.4(5)(ff) Keys beginning with java.

(n) Keys beginning with org

The keys that begin with org and can be specified in the usrconf.properties file for the Java application are listed below:

Key name | Difference | Contents | Default value
org.w3c.dom.DOMImplementationSourceList | Unique | Specify the implementation class name of org.w3c.dom.DOMImplementationSourceList. | com.cosminexus.jaxp.impl.parsers.dom.DOMXSImplementationSourceImpl
org.xml.sax.driver | Unique | Specify the implementation class name of org.xml.sax.driver. | com.cosminexus.jaxp.impl.parsers.parsers.SAXParser
org.xml.sax.parser | Unique | Specify the implementation class name of org.xml.sax.parser. | org.xml.sax.helpers.XMLReaderAdapter

Legend:

Unique:

This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.

(o) Keys beginning with vbroker

The keys that begin with vbroker and can be specified in the usrconf.properties file for the Java application are described below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.4(5)(hh) Keys beginning with vbroker.

Key name
Difference
Contents
Default value

vbroker.ce.iiop.ccm.htc.readerPerConnection
None
Specify whether to control the closing of the connections when a timeout occurs during the invocation of the EJB method defined as the remote interface.

If true is specified

The closing of the connection will be controlled when the timeout occurs.

If false is specified

The closing of the connection will not be controlled when the timeout occurs.

false

vbroker.orb.htc.comt.entryCount
None
Specify an upper limit of the entry count for one communication trace file of the Cosminexus TPBroker.
--

vbroker.orb.htc.comt.fileCount
None
Specify an upper limit value of the communication trace file count for Cosminexus TPBroker.
15

vbroker.orb.htc.tracePath
Exists
Specify a range of 1 to 210 bytes for the path of the output destination of Cosminexus TPBroker trace files. Specify a unique path for each Java application. You need to create comtrc and mdltrc as the subdirectories of the specified path beforehand. In the case of default output destination, the subdirectories comtrc and mdltrc are created automatically when the Java application is invoked for the first time.
Use a forward slash (/) as the delimiter in the directory path. For example, specify as follows to set up /temp/work as the work directory:
vbroker.orb.htc.tracePath=/temp/work

In Windows
value-of-ejbserver.client.ejb.log-directory\TPB\logj

In UNIX
value-of-ejbserver.client.ejb.log.directory/TPB/logj

Legend:

Exists:

There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.

None:

This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default value, see 2.4(5)(hh) Keys beginning with vbroker.

--:

This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.4(5)(hh) Keys beginning with vbroker.

(5) Examples of coding

java.naming.provider.url=corbaname::localhost:900
ejbserver.serverName=MyServer

14.4 System properties specified in the Java application

Organization of this section

(1) Format

(2) Functionality

(3) Specifiable keys

(4) Examples of coding

(1) Format

Specify the system properties in a file with a Win32 batch file format (in Windows) or shell script file format (in UNIX).

(2) Functionality

When you use the vbj command, specify the system properties of the JavaVM that executes the Java application.

When using java.lang.System.setProperty() to define the system properties, you need to define the properties before the corresponding functionality is used for the first time.

If you change the contents of this file while the Java application is running, the changes are applied only when the Java application is started next.

(3) Specifiable keys

The following table lists the keys that can be specified for the vbj command:

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Table 14-3 System properties specified in the Java applications

Classification
Key name
Types
Specifiable/ Not-specifiable
Related information

Common keys
ejbserver.client.ctm.RequestPriority
Select
variable
Y

ejbserver.client.ejb.log
Select
variable
Y

ejbserver.client.log.appid
Select
variable
Y

ejbserver.client.log.directory
Select
variable
Y

ejbserver.client.log.lockInterval
Select
variable
Y

ejbserver.client.log.lockRetryCount
Select
variable
Y

ejbserver.container.rebindpolicy
Select
variable
Y

ejbserver.jndi.cache
Select
variable
Y
2.13 Invoking the EJB remote interface in EJB Container Functionality Guide

ejbserver.jndi.cache.interval
Select
variable
Y

ejbserver.jndi.cache.interval.clear.option
Select
variable
Y

ejbserver.jndi.namingservice.group.list
Select
variable
Y

ejbserver.jndi.namingservice.group.specify-group-name.providerurls
Select
variable
Y

ejbserver.jndi.request.timeout
Select
variable
Y

ejbserver.logger.channels.define.channel-name#.filenum
Select
variable
Y

ejbserver.logger.channels.define.channel-name#.filesize
Select
variable
Y

ejbserver.logger.enabled.*
Select
variable
Y

ejbserver.rmi.request.timeout
Select
variable
Y

ejbserver.security.service.url
Select
variable
Y

ejbserver.serverName
Variable
Y

ejbserver.server.prf.PRFID
Select
variable
Y

java.naming.factory.initial
Variable
Y

java.naming.provider.url
Variable
Y

vbroker.orb.htc.comt.entryCount
Select
variable
Y

vbroker.orb.htc.comt.fileCount
Select
variable
Y

vbroker.orb.htc.tracePath
Select
variable
Y

Unique keys
ejbserver.jndi.log.message.verbosemode
Select
variable
Y

ejbserver.server.prf.processName
Select
variable
Y

java.endorsed.dirs
Variable
N

java.naming.factory.object
Fixed
Y

java.naming.factory.state
Fixed
Y

javax.rmi.CORBA.UtilClass
Fixed
Y

javax.rmi.CORBA.StubClass
Fixed
N

javax.rmi.CORBA.PortableRemoteObjectClass
Fixed
Y

org.omg.PortableInterceptor.ORBInitializerClass.com.hitachi.software.ejb.security.std.interceptor.SecurityClientInterceptorInit
Fixed
Y

java.security.policy
Fixed
Y

org.omg.CORBA.ORBClass
Fixed
N

org.omg.CORBA.ORBSingletonClass
Fixed
N

vbroker.agent.enableLocator
Select
variable
Y

Legend:

Y: You need to specify the key in the command.

N: You need not specify the key in the command.

Blank column: Related information does not exist.

Types

In the case of fixed type, the value for the corresponding key is fixed and must always be specified. In the case of variable type, you need to specify the value according to the system execution environment. In the case of Select variable type, either specify the value according to the system execution environment or do not specify anything.

#

You can set the following names as channel name:

ClientMessageLogFile, ClientExceptionLogFile, or ClientMaintenanceLogFile.

For details on acquiring data, see 2.3 Acquiring data in the manual uCosminexus Application Server Maintenance and Migration Guide.

(a) Common keys

The system property keys are common with the usrconf.properties file for the Java applications.

For details on the common keys, see 14.3 usrconf.properties (User property file for Java applications). You can also see 2.4 usrconf.properties (User property file for J2EE servers), if required.

(b) Unique keys

The unique keys refer to the system property-specific keys.

The details of the unique keys are as follows:

ejbserver.jndi.log.message.verbosemode
Type: Select variable
Value: on or off
Default value: off

Contents:

Specify message log output in the standard output.

ejbserver.server.prf.processName
Type: Select variable
Value: Optional client identifier
Normal value: EJBClient

Contents:

Specify the name that you want to display as the process name in the edit result of the performance analysis trace file. The normal value is used when null is specified or when this key is not specified.

java.endorsed.dirs
Type: Variable
Value: Directory path
Normal value: Cosminexus-installation-directory\TPB\lib\endorsed (in Windows) or /opt/Cosminexus/TPB/lib/endorsed (in UNIX)

Contents:

Specify the directory path containing the class to be replaced by using the Endorsed Standards Override Mechanism.

java.naming.factory.object
Type: Fixed
Value: com.hitachi.software.ejb.jndi.InsNamingFactory

Contents:

Specify the implementation class of ObjectFactory that acts as the SPI of JNDI.

ObjectFactory converts the object during object search.

This key is compatible with the value (com.hitachi.software.ejb.jndi.nameserver.spi.cos.wrappers.vbj.WrapperObjectFactory) used in the earlier versions.

java.naming.factory.state
Type: Fixed
Value: com.hitachi.software.ejb.jndi.InsNamingFactory

Contents:

Specify the implementation class of the StateFactory that acts as the SPI of JNDI.

StateFactory converts the object during object registration.

This key is compatible with the value (com.hitachi.software.ejb.jndi.nameserver.spi.cos.wrappers.vbj.WrapperStateFactory) used in the earlier versions.

javax.rmi.CORBA.UtilClass
Type: Fixed
Value: com.hitachi.software.ejb.rmi.Util

Contents:

Specify the implementation class name of javax.rmi.CORBA.Util.

This key is compatible with the value (com.inprise.vbroker.rmi.CORBA.UtilImpl) used in the earlier versions.

javax.rmi.CORBA.StubClass
Type: Fixed
Value: com.inprise.vbroker.rmi.CORBA.StubImpl

Contents:

Specify the implementation class name of javax.rmi.CORBA.Stub.

javax.rmi.CORBA.PortableRemoteObjectClass
Type: Fixed
Value: com.hitachi.software.ejb.rmi.PortableRemoteObject

Contents:

Specify the implementation class name of javax.rmi.PortableRemoteObject.

This key is compatible with the value (com.inprise.vbroker.rmi.CORBA.PortableRemoteObjectImpl) used in the earlier versions.

org.omg.PortableInterceptor.ORBInitializerClass.com.hitachi.software.ejb.security.std.interceptor.SecurityClientInterceptorInit
Type: Fixed
Value: 1

Contents:

Specify the initialization class of the client interceptor for the security functionality.

Specify the initialization class only when the Java application uses the EJB security interface to log on to the J2EE server and invoke an EJB.

java.security.policy
Type: Fixed
Value: absolute-path-of-the-security-policy-file

Contents:

Copy the Cosminexus-installation-directory\CC\client\cli.policy (in Windows) or /opt/Cosminexus/CC/client/cli.policy (in UNIX) to any directory in the client and specify the file name as an absolute path. Do not change the contents of the file.

org.omg.CORBA.ORBClass
Type: Fixed
Value: com.inprise.vbroker.orb.ORB

Contents:

Specify the implementation class name of ORB.

org.omg.CORBA.ORBSingletonClass
Type: Fixed
Value: com.inprise.vbroker.orb.ORBSingleton

Contents:

Specify the implementation class name for the singleton of ORB.

vbroker.agent.enableLocator
Type: Select variable
Value: true or false
Normal value: true

Contents:

Specify false only when the Java application calls the J2EE server. The CORBA naming service and the smart agent are provided as the naming services of Cosminexus TPBroker that processes the J2EE server communication. Use only the CORBA naming service for the communication between the Java application and the J2EE server. You only need to start the CORBA naming service between the J2EE server and the Java application and specify false for the corresponding key.

On the other hand, you need to start the CORBA naming service and smart agent and specify true in the corresponding key when the Java application is invoking the J2EE server as well the server application of Cosminexus TPBroker by using the smart agent.

(4) Examples of coding

The examples of coding for the system properties are explained below for each operating system:

(a) In Windows

The following is a coding example of a bat file that starts a Java application. In this example, the vbj command is used to start a Java application. For details on the CLASS_PATH to be specified in the JAR file, see 3.7.4 Setting JAR file to class path of EJB client application in the manual uCosminexus Application Server EJB Container Functionality Guide

For details on environment variables, see Appendix I System Environment Variables in the uCosminexus Application Server Command Reference Guide.

setlocal

rem --- set environment ---
set COSMI_HOME=C:\Program Files\Hitachi\Cosminexus
set SERVERNAME=MyServer
set PRF_HOME=%COSMI_HOME%\PRF
set TPB_HOME=%COSMI_HOME%\TPB
set JAVA_HOME=%COSMI_HOME%\jdk
set VBJ="%TPB_HOME%\bin\vbj"
set VBROKER_ADM=%TPB_HOME%\adm
set PATH=%PRF_HOME%\bin;%TPB_HOME%\bin;%JAVA_HOME%\bin;%PATH%

rem --- set class path ---
set CLASS_PATH=%COSMI_HOME%\TPB\lib\vbjorb.jar
set CLASS_PATH=%CLASS_PATH%;%COSMI_HOME%\TPB\lib\vbsec.jar
set CLASS_PATH=%CLASS_PATH%;%COSMI_HOME%\PRF\lib\cprf.jar
set CLASS_PATH=%CLASS_PATH%;%ProgramFiles%\Hitachi\HNTRLib2\classes\hntrlibMj.jar
set CLASS_PATH=%CLASS_PATH%;%COSMI_HOME%\CC\lib\hitj2ee.jar
set CLASS_PATH=%CLASS_PATH%;%COSMI_HOME%\CC\client\lib\HiEJBClientStatic.jar
set CLASS_PATH=%CLASS_PATH%;stubs.jar
set CLASS_PATH="%CLASS_PATH%;1.jar"

rem --- set properties ---
set PROPS=-Djavax.rmi.CORBA.UtilClass=com.hitachi.software.ejb.rmi.Util
set PROPS=%PROPS% -Djavax.rmi.CORBA.PortableRemoteObjectClass=com.hitachi.software.ejb.rmi.PortableRemoteObject
set PROPS=%PROPS% -Djava.naming.factory.initial=com.hitachi.software.ejb.jndi.InsContextFactory
set PROPS=%PROPS% -Djava.naming.factory.object=com.hitachi.software.ejb.jndi.InsNamingFactory
set PROPS=%PROPS% -Djava.naming.factory.state=com.hitachi.software.ejb.jndi.InsNamingFactory
set PROPS=%PROPS% -Djava.naming.provider.url=corbaname::localhost:900
set PROPS=%PROPS% -Dejbserver.jndi.cache=on
set PROPS=%PROPS% -Dejbserver.jndi.cache.interval=0
set PROPS=%PROPS% -Dejbserver.jndi.cache.interval.clear.option=refresh
set PROPS=%PROPS% -Dejbserver.jndi.request.timeout=0
set PROPS=%PROPS% -Dejbserver.rmi.request.timeout=0
set PROPS=%PROPS% -Dejbserver.serverName=%SERVERNAME%
set PROPS=%PROPS% -Dvbroker.agent.enableLocator=false
set PROPS=%PROPS% -Dorg.omg.PortableInterceptor.ORBInitializerClass.com.hitachi.software.ejb.security.std.interceptor.SecurityClientInterceptorInit=1
set PROPS=%PROPS% "-Djava.security.policy==%COSMI_HOME%\CC\client\cli.policy"
set PROPS=%PROPS% -Dejbserver.server.prf.processName=EJBClient
set PROPS=%PROPS% "-Dejbserver.client.log.directory=%COSMI_HOME%\CC\client\logs"
set PROPS=%PROPS% -Dejbserver.logger.enabled.*=Error

rem --- execute client ---
%VBJ% -VBJclasspath %CLASS_PATH% %PROPS% ConverterClient

endlocal

(b) In UNIX

The following is a coding example of a shell script that starts a Java application. In this example, the vbj command is used to start a Java application.

For details on the environment variables to be specified in CLASS_PATH, see Appendix I System Environment Variables in the uCosminexus Application Server Command Reference Guide.

#!/bin/csh -f

# --- environment ---
set COSMI_HOME=/opt/Cosminexus
set SERVERNAME="MyServer"
set PRF_HOME="${COSMI_HOME}/PRF"
set TPB_HOME="${COSMI_HOME}/TPB"
set JAVA_HOME="${COSMI_HOME}/jdk"
set VBJ="${TPB_HOME}/bin/vbj"
setenv PSALLOC early
setenv NODISCLAIM true
setenv AIXTHREAD_SCOPE S
setenv AIXTHREAD_MUTEX_DEBUG OFF
setenv AIXTHREAD_RWLOCK_DEBUG OFF
setenv AIXTHREAD_COND_DEBUG OFF
setenv EXTSHM ON
setenv LDR_CNTRL MAXDATA=0x40000000
setenv VBROKER_ADM "${TPB_HOME}/adm"
setenv PATH "${JAVA_HOME}/bin:${PATH}"
set LPATH="${TPB_HOME}/lib:${PRF_HOME}/lib"
if ($?LIBPATH) then
       setenv LIBPATH "${LPATH}:${LIBPATH}"
else
       setenv LIBPATH "${LPATH}"
endif

# --- class path ---
set CLASS_PATH="${COSMI_HOME}/TPB/lib/vbjorb.jar"
set CLASS_PATH="${CLASS_PATH}:${COSMI_HOME}/TPB/lib/vbsec.jar"
set CLASS_PATH="${CLASS_PATH}:${COSMI_HOME}/PRF/lib/cprf.jar"
set CLASS_PATH="${CLASS_PATH}:/opt/hitachi/HNTRLib2/classes/hntrlibMj.jar"
set CLASS_PATH="${CLASS_PATH}:${COSMI_HOME}/CC/lib/hitj2ee.jar"
set CLASS_PATH="${CLASS_PATH}:${COSMI_HOME}/CC/client/lib/HiEJBClientStatic.jar"
set CLASS_PATH="${CLASS_PATH}:stubs.jar"
set CLASS_PATH="${CLASS_PATH}:1.jar"

# --- properties ---
set PROPS="-Djavax.rmi.CORBA.UtilClass=com.hitachi.software.ejb.rmi.Util"
set PROPS="${PROPS} -Djavax.rmi.CORBA.PortableRemoteObjectClass=com.hitachi.software.ejb.rmi.PortableRemoteObject"
set PROPS="${PROPS} -Djava.naming.factory.initial=com.hitachi.software.ejb.jndi.InsContextFactory"
set PROPS="${PROPS} -Djava.naming.factory.object=com.hitachi.software.ejb.jndi.InsNamingFactory"
set PROPS="${PROPS} -Djava.naming.factory.state=com.hitachi.software.ejb.jndi.InsNamingFactory"
set PROPS="${PROPS} -Djava.naming.provider.url=corbaname::localhost:900"
set PROPS="${PROPS} -Dejbserver.jndi.cache=on"
set PROPS="${PROPS} -Dejbserver.jndi.cache.interval=0"
set PROPS="${PROPS} -Dejbserver.jndi.cache.interval.clear.option=refresh"
set PROPS="${PROPS} -Dejbserver.jndi.request.timeout=0"
set PROPS="${PROPS} -Dejbserver.rmi.request.timeout=0"
set PROPS="${PROPS} -Dejbserver.serverName=${SERVERNAME}"
set PROPS="${PROPS} -Dvbroker.agent.enableLocator=false"
set PROPS="${PROPS} -Dorg.omg.PortableInterceptor.ORBInitializerClass.com.hitachi.software.ejb.security.std.interceptor.SecurityClientInterceptorInit=1"
set PROPS="${PROPS} -Djava.security.policy==${COSMI_HOME}/CC/client/cli.policy"
set PROPS="${PROPS} -Dejbserver.server.prf.processName=EJBClient"
set PROPS="${PROPS} -Dejbserver.client.log.directory=${COSMI_HOME}/CC/client/logs"

# --- execute client ---
${VBJ} -VBJclasspath ${CLASS_PATH} ${PROPS} ConverterClient

The underlined text indicates an AIX-specific description.

Italic text is used to indicate that the variable name differs based on the operating system. Substitute the variable and use as follows:
In AIX: LIBPATH
In HP-UX, Linux, or Solaris: LD_LIBRARY_PATH

14.5 Property setup file for the user log of Java applications

Organization of this section

(1) Format

(2) Functionality

(3) File name

(4) Specifiable keys

(5) Examples of coding

(1) Format

J2SE property file format.

Specify the key as follows:

key-name=value

Specification method

The string up to the linefeed is a value.

The line beginning with a hash mark (#) is a comment.

If you define a line without a value, the line is ignored.

You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.

(Example) key-name=value#comment

(2) Functionality

This file specifies the system properties for the user log in the Java application when using the vbj command.

The properties set up in this file are read by the Java application and hence, you need to set the properties in the system properties. For details on the implementation of user log output in Java applications, see 9.11 Implementing and setting up user log output for EJB client applications (when vbj command is used) in the manual uCosminexus Application Server Expansion Guide.

(3) File name

Any storage location and file name is possible.

(4) Specifiable keys

The following table lists the keys that can be specified. For details on the keys, see 14.3(4)(a) Keys beginning with ejbserver.application. Also, if required, see 2.4(5)(b) Keys beginning with ejbserver.application.

Table 14-4 Keys that can be specified in the property setup file for the user log of the Java application

Key name | Contents
ejbserver.application.userlog.CJLogHandler.handler-name.appname | Specify the default application name that is output to the AppName field.
ejbserver.application.userlog.CJLogHandler.handler-name.autoFlush.enabled | Specify whether flush is to be carried out after the message is output.
ejbserver.application.userlog.CJLogHandler.handler-name.count | Specify the number of log files.
ejbserver.application.userlog.CJLogHandler.handler-name.encoding | Specify encoding of the character strings to be output.
ejbserver.application.userlog.CJLogHandler.handler-name.filter | Specify the filter to be used with its full name, including the package name.
ejbserver.application.userlog.CJLogHandler.handler-name.formatter | Specify the formatter that you will use along with its full name, including the package name.
ejbserver.application.userlog.CJLogHandler.handler-name.level | Specify an upper-limit of a log collection level.
ejbserver.application.userlog.CJLogHandler.handler-name.limit | Specify the capacity of a log file.
ejbserver.application.userlog.CJLogHandler.handler-name.msgid | Specify the default message ID that is output to the MsgID field.
ejbserver.application.userlog.CJLogHandler.handler-name.path | Specify the prefix of log file name.
ejbserver.application.userlog.CJLogHandler.handler-name.separator | Use the CJSimpleFormatter and specify a separator to output a message in one sentence.
ejbserver.application.userlog.loggers | Declare the names of the loggers to be used.
ejbserver.application.userlog.Logger.logger-name.filter | Specify the full name including the package name of the filter used in the logger.
ejbserver.application.userlog.Logger.logger-name.handlers | Specify the handler class for the specified logger name.
ejbserver.application.userlog.Logger.logger-name.level | Specify the output level of the logger.
ejbserver.application.userlog.Logger.logger-name.useParentHandlers | Specify whether the log record is to be transmitted from the logger that received the log record to the handler connected to the parent logger.

(5) Examples of coding

The storage location is as follows:

In Windows
Cosminexus-installation-directory\CC\examples\EJBClient\userlog\sample.properties

In UNIX
/opt/Cosminexus/CC/examples/EJBClient/userlog/sample.properties

A sample is as follows:

# user-log handler function
ejbserver.application.userlog.CJLogHandler.conf1.appname=my_app1
ejbserver.application.userlog.CJLogHandler.conf1.path=application1/logfileA
ejbserver.application.userlog.CJLogHandler.conf1.limit=10485760​
ejbserver.application.userlog.CJLogHandler.conf1.count=2
ejbserver.application.userlog.CJLogHandler.conf1.level=SEVERE

# user-log logger function
ejbserver.application.userlog.Logger.com.example.userlogger1.handlers=com.hitachi.software.ejb.application.userlog.CJMPMessageFileHandler;conf1
ejbserver.application.userlog.Logger.com.example.userlogger1.useParentHandlers=true
ejbserver.application.userlog.Logger.com.example.userlogger1.level=INFO
ejbserver.application.userlog.loggers=com.example.userlogger1

15. Files Used in Web Applications

This chapter describes the compilation exclusion list files and the execution result list files to be used in Web applications.

Organization of this chapter

15.1 List of files used in Web applications

15.2 Compilation exclusion list file

15.3 Execution result list file

15.1 List of files used in Web applications

The following table lists the files used in Web applications:

Table 15-1 List of files used in Web applications

File name | Classification | Overview | Reference
(Optional)# | Compilation exclusion list file | This file defines the JSP files to be excluded from command-executed JSP pre-compilation. | 15.2
(Optional)# | Execution result list file | This file is used to collect the compiled results. | 15.3

#

You can use single byte alphanumeric characters, periods (.), and underscores (_).

15.2 Compilation exclusion list file

Organization of this section

(1) Format

(2) Storage locations and file names

(3) Functionality

(4) Examples of coding

(1) Format

Specify the compilation exclusion list file as shown below:

# comment
path-of-JSP-file-to-be-excluded-from-compilation1
path-of-JSP-file-to-be-excluded-from-compilation2
...

Specification method

The line beginning with a hash mark (#) is a comment.

Specify the path of one JSP file to be excluded from compilation on each line.

(2) Storage locations and file names

Any storage location and filename is possible. You can use the following characters in the file name:

Alphanumeric characters, underscore (_), or period (.)

(3) Functionality

This file specifies the paths of the JSP files to be excluded from compilation when you use a command to execute JSP pre-compilation.

By using the -excludelist option of the cjjspc command to specify the compilation exclusion list file, you can exclude the compilation of the JSP files coded in the compilation exclusion list file. For details about the cjjspc command, see cjjspc (JSP precompile) in the manual uCosminexus Application Server Command Reference Guide.

(4) Examples of coding

To specify single JSP files:

/jsp/title.jsp
/jsp/pieces/pageA.jsp

To specify all the files contained in a directory:

/jsp/pieces/*

To specify the extension of files to be excluded from compilation:

/jsp/pieces/*.jsp

To write a comment:

# JSP Fragment
/jsp/pieces/pageA.jsp

15.3 Execution result list file

Organization of this section

(1) Format

(2) Storage locations and file names

(3) Functionality

(4) Examples of output

(1) Format

The output format of the execution result list file is as follows:

# Excluded JSP files.
list-of-JSP-files-to-be-excluded-from-compilation
# Compiled JSP files.
JSP-files-that-succeeded-in-compilation
# JSP-files-that-failed-from-compilation
...

(2) Storage locations and file names

Any storage location and filename is possible. You can use the following characters in the file name:

Alphanumeric characters, underscore (_), or period (.)

(3) Functionality

When you use a command to execute JSP pre-compilation, you can specify the -resultlist option of the cjjspc command to output the following information in an execution result list file: List of JSP file paths excluded from compilation, JSP files whose compilation was successful, and list of JSP file paths whose compilation failed

The compiled results are output in the execution result list file in the following order:

List of JSP file paths to be excluded from compilation

JSP file paths whose compilation was successful or whose compilation failed

The JSP files paths whose compilation failed are output as comments.

(4) Examples of output

# Excluded JSP files.
/jsp/title.jsp
/jsp/pieces/*.jsp
# Compiled JSP files.
/jsp/confirm.jsp
#/jsp/discorrect.jsp
#/jsp/fail.jsp
/jsp/index.jsp
/jsp/order.jsp
#/jsp/uncomfortable.jsp  

16. Options for Invoking JavaVM

This chapter describes the options for invoking JavaVM.

In Cosminexus, apart from the Java HotSpot VM options, you can specify JavaVM extension options as the options for invoking JavaVM.

This chapter describes the details of the JavaVM extension options. This chapter also describes Java HotSpot VM options that you can specify in Cosminexus, and describes default values.

Organization of this chapter

16.1 List of JavaVM extension options

16.2 Details of JavaVM extension options

16.3 Properties used in JavaVM

16.4 Default values of the Java HotSpot VM options that can be specified in Cosminexus

16.5 Java HotSpot VM options that can be specified in Cosminexus

16.6 List of environment variables used in JavaVM

16.7 Details of environment variables used in JavaVM

16.1 List of JavaVM extension options

The following table describes the list of the JavaVM extension options.

Note

Specifiable options

The options that can be specified for Application Server only include the options displayed when the java command is invoked without specifying options, and the options displayed when the -X, -XX, or -XX:+Hitachi options are specified for the java command. If other options are specified, the operations might not function properly.

You can specify the following options in the option definition file. VR is the version of Application Server on which parameters are introduced or changed.

Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.

Table 16-1 List of JavaVM extension options

Classification
Option name
Overview
VR
Related information

List display option
-XX:+Hitachi
Display the list of JavaVM extension options.
Solaris version: 06-50
Others: version 05-02

Extended thread dump functionality option
-XX:[+|-]HitachiThreadDump
Specify whether to output the extended thread dump information.
Windows version: 05-05
Solaris version: 06-50
Others: version 05-00

-XX:[+|-]HitachiThreadDumpToStdout
Specify whether to output the thread dump as the standard output.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiThreadDumpWithHashCode
Specify whether to output the hash code in the thread information.
07-00

-XX:[+|-]HitachiThreadDumpWithCpuTime
Specify whether to output the user CPU time and the kernel CPU time in the thread information.
You cannot use this functionality in HP-UX. Even if you specify this option, it will be ignored.
07-00

-XX:[+|-]HitachiThreadDumpWithBlockCount
Specify whether to output the number of times the process is blocked and the number of times the process is in the waiting status, in the thread information.
07-00

JavaVM log file option
-XX:HitachiJavaLog#¹
Specify the prefix of log file name.
Solaris version: 06-50
Others: version 05-02

-XX:HitachiJavaLogFileSize#1
Specify the maximum file size of one file.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiJavaLogNoMoreOutput#1
Specify the operation when the input/ output error occurs while creating a log file.
Solaris version: 06-50
Others: version 05-02

-XX:HitachiJavaLogNumberOfFile#1
Specify the maximum number of log files to be created.
Solaris version: 06-50
Others: version 05-02

Detailed time output option
-XX:[+|-]HitachiOutputMilliTime
Specify whether to output the time up to milliseconds.
Solaris version: 06-50
HP-UX/PA version: 06-70
Others: 06-00

Extended verbosegc functionality option
-XX:[+|-]HitachiVerboseGC#2
Specify whether to output the extended verbosegc information when garbage collection occurs.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiCommaVerboseGC
Specify whether to output the extended verbosegc information in CSV format.
Solaris version: 06-50
Others: version 05-02

-XX:HitachiVerboseGCIntervalTime
Specify the time interval in which the extended verbosegc information is to be output.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiVerboseGCPrintCause
Specify whether to output the cause of the garbage collection.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiVerboseGCPrintDate
Specify whether to output the date in the extended verbosegc information.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiVerboseGCCpuTime
Specify whether to output the processor time of the garbage collection.
You cannot use this functionality in HP-UX. Even if you specify this option, it will be ignored.
07-00

-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution
Output the age distribution of objects in the Survivor area into the JavaVM log file, when garbage collection occurs.
08-00

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory
Specifies whether to output the heap information being managed in JavaVM to the JavaVM log file.
08-53

-XX:[+|-]HitachiVerboseGCPrintThreadCount
Specifies whether to output the number of Java threads to the JavaVM log file in order to monitor the number of Java threads.
Linux version (x86/AMD64 & Intel EM64T): 08-53
Windows version x86: 08-53
Windows version x64: 08-53
Windows version x86 (for JDK 6 base): 08-70

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit
Specifies whether to output the cumulative heap size that JavaVM allocates by invoking the java.io.File.deleteOnExit() method and the method invocation count to the JavaVM log file.
Linux version (x86/AMD64 & Intel EM64T): 08-53
Windows version x86: 08-53
Windows version x64: 08-53
Windows version x86 (for JDK 6 base): 08-70

Options of the functionality to output the code cache area information
-XX:[+|-]PrintCodeCacheInfo
Specify whether to output the amount of code cache area used, and whether to output a message informing the user that the usage has reached the threshold value.
09-50

-XX:CodeCacheInfoPrintRatio
Specify the usage rate of the code cache area that will trigger the output of a message informing the user that the usage of the code cache area has reached the threshold value.
09-50

-XX:[+|-]PrintCodeCacheFullMessage
Specify whether to output a message if the code cache area is depleted when the Java method is subject to JIT compilation.
09-50

Extended functionality option when OutOfMemoryError occurs
-XX:[+|-]HitachiOutOfMemoryCause#2
Specify whether to output the types of causes for the occurrence of OutOfMemoryError.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiOutOfMemoryStackTrace#²
Specify whether to output the stack trace when OutOfMemoryError occurs.
Solaris version: 06-50
Others: version 05-02

-XX:HitachiOutOfMemoryStackTraceLineSize
Specify the number of characters in one line of stack trace that is output when OutOfMemoryError occurs.
Solaris version: 06-50
Others: version 05-02

-XX:[+|-]HitachiOutOfMemorySize#2
Output the requested memory size when OutOfMemoryError occurs.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiOutOfMemoryAbort
Specify whether to output the message and memory dump and perform the forced termination when OutOfMemoryError occurs.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump
Specify whether to output the thread dump when OutOfMemoryError occurs.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf
Outputs class-wise statistical information to the thread dump log file output by -XX:+HitachiOutOfMemoryAbortThreadDump.
08-00

-XX:[+|-]HitachiOutOfMemoryHandling
Specifies whether to enable the OutOfMemory handling functionality.
08-53

-XX:HitachiOutOfMemoryHandlingMaxThrowCount
Specifies the per-hour upper limit for the total OutOfMemory occurrence count caused by a Java heap or Perm heap shortage when the OutOfMemory handling functionality is enabled.
08-53

Class library trace functionality option
-XX:[+|-]HitachiJavaClassLibTrace#2
Specify whether to output stack trace of the class library.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:HitachiJavaClassLibTraceLineSize
Specify the number of characters in one line of stack trace of the class library.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

Local variable information output functionality option
-XX:[+|-]HitachiLocalsInThrowable
Specify whether to output the local variable information in the stack trace when exception occurs.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiLocalsInStackTrace
Specify whether to output the local variable information in the stack trace when the thread dump is output.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiLocalsSimpleFormat
Specify whether to output the local variable information in simple format.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:[+|-]HitachiTrueTypeInLocals
Specify a character string for whether you need to output the true type name of the local variable object when the local variable information is output.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

-XX:HitachiCallToString
Specify a character string for whether you need to output the variable value of the local variable object when the local variable information is output.
HP-UX/PA version: 06-70
Windows/IPF version: 06-70
Others: version 06-50

Release system resource option
-XX:[+|-]HitachiFullCore
Specify whether to change the settings of the system resource RLIMIT_CORE.
This option is for UNIX.
Solaris version: 06-50
Others: version 05-02

Reserve swap area option
-XX:[+|-]HitachiReserveSwapSpace
Specify whether to reserve the maximum swap area required to run JavaVM, when starting JavaVM.
This option is used for HP-UX.
HP-UX/PA version: 06-70
HP-UX/IPF version: version 06-00

Options specified in the explicit memory management
-XX:[+|-]HitachiUseExplicitMemory
Specify whether to enable or disable the Explicit Memory Management function.
08-00

-XX:HitachiExplicitHeapMaxSize
Specify the maximum size of the entire Explicit heap.
08-00

-XX:HitachiExplicitMemoryLogLevel
Specify the event log level of the Explicit Memory Management functionality.
08-00

-XX:HitachiExplicitMemoryJavaLog
Specify the file name (path name can be included) or directory name in which the log will be output using this functionality.
08-00

-XX:HitachiExplicitMemoryJavaLogFileSize
Set up the maximum file size of one file in bytes.
08-00

-XX:HitachiExplicitMemoryJavaLogNumberOfFile
Specify the maximum number of files to be created. If the maximum number of files is exceeded, the log is output again to the file that was created first (wrap around).
08-00

-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst
Specify the transition destination of the objects of the release process of Explicit memory block.
08-50
8. Controlling Full Garbage Collection Using the Explicit Memory Management functionality in Expansion Guide

-XX:[+|-]HitachiExplicitMemoryAutoReclaim
Specify whether to enable the automatic release function of the Explicit Memory Management functionality.
08-50

Version compatibility option of the Explicit Memory Management function
-XX:[+|-]HitachiExplicitMemoryCompatibleToV8
Specify whether to use the same method as in 08-00 for securing the Explicit memory block.
08-50

Options in the Explicit Memory Management automatic allocation setup file
-XX:[+|-]HitachiAutoExplicitMemory
Specify whether to enable the automatic allocation function for the Explicit memory block.
08-50

-XX:HitachiAutoExplicitMemoryFile
Specify the path of the automatic allocation setup file to be used by the automatic allocation function of the Explicit memory block.
08-50

Option for controlling the transfer of objects to the Explicit memory block of the Explicit Memory Management functionality
-XX:ExplicitMemoryFullGCPolicy
Specify whether to control the transfer of reference relationship-based objects from the Java heap to the Explicit memory block when a full garbage collection occurs.
09-50
8. Controlling Full Garbage Collection Using the Explicit Memory Management functionality in Expansion Guide

Option for the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality
-XX:[+|-]ExplicitMemoryUseExcludeClass
Specify whether to enable the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality.
09-50

-XX:ExplicitMemoryExcludeClassListFile
Specify the path of the Explicit Memory Management functionality exclusion setup file to be used with the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality.
09-50

-XX:ExplicitMemoryNotExcludeClassListFile
Specify the path of the Explicit Memory Management functionality non-exclusion setup file to be used with the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality.
09-50

Memory usage reduction option for the Explicit heap used in an HTTP session
-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim
Specifies whether to enable the memory usage reduction function for the Explicit heap used in an HTTP session.
08-70
8. Controlling Full Garbage Collection Using the Explicit Memory Management functionality in Expansion Guide

Option for specifying the maximum resources
-XX:HitachiJITCompileMaxMemorySize
Specifies the upper limit of the memory to be secured for the JIT compilation.
08-53

-XX:HitachiThreadLimit
Specifies the upper limit for the number of threads.
08-53

Option for the JIT compiler continuation functionality
-XX:[+|-]JITCompilerContinuation
Specify whether to enable the JIT compiler continuation functionality.
09-50

Legend:

Blank column: Related information does not exist.

#1

Settings for the JavaVM log file.

#2

When the following options are specified, the JavaVM log file is output:

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiVerboseGC

-XX:+HitachiJavaClassLibTrace

Hint

The references for the default values of JavaVM extension options differ for each server. The following table describes the references for the default values of JavaVM extension options for each server and application:

Table 16-2 References for the default values of JavaVM extension options for each server and application

Server and application used | Reference
J2EE server | 2.3 usrconf.cfg (Option definition file for J2EE servers)
Batch server | 3.2 usrconf.cfg (Option definition file for batch servers)
Web container server (compatibility function) | 3.11.2 usrconf.cfg (Option definition file for Web container server) in the manual Cosminexus Application Server Function Guide - Compatibility
Java applications started with the cjclstartap command | 14.2 usrconf.cfg (Option definition file for Java applications)
Other Java applications | 16.4 Default values of the Java HotSpot VM options that can be specified in Cosminexus

To specify JavaVM extension options in the Easy Setup definition file, you specify JavaVM extension options in 'Contents specified in param-value' that can be specified when add.jvm.arg is set in 'Value specified in param-name'.

16.2 Details of JavaVM extension options

This section explains the details of the JavaVM extension options.

The following Java programs are used as examples in this document:

Java Program example 1

class Example1 {
 public static void main(String[] args) {
   Example1 e1 = new Example1();
   Object obj = new Object();
   e1.method(1, 'Q', obj); // 5th line
 }

 void method(int l1, char l2, Object l3) {
   float l4 = 4.0f;
   boolean l5 = true;
   double l6 = Double.MAX_VALUE; // double type maximum value
   Object[] l7 = new Object[10];

   try {
    exception-occurred // 15th line
   } catch (Exception e) {
    e.printStackTrace();
   }
 }
}

Java Program example 2

class Example2 {
 public static void main(String[] args) {
   Example2 e2 = new Example2();
   e2.method(); // 4th line
 }

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

   thread-dump-is-output // 15th line
 }
}

Java Program example 3

class Example3 {
 public static void main(String[] args) {
   Example3 e3 = new Example3();
   e3.method(); // 4th line
 }

 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 type minimum value
   Object l6 = new Thread();
   Object[] l7 = new Thread[10];

   try {
    exception-occurred // 18th line
   } catch (Exception e) {
    e.printStackTrace();
   }
 }

 public String toString() {
   return "I am an Example3 instance.";
 }
}

Organization of this section

-XX:+Hitachi (List display option)

-XX:[+|-]HitachiThreadDump (Option to output the extended thread dump information)

-XX:[+|-]HitachiThreadDumpToStdout (Option for preventing the standard output of extended thread dump)

-XX:[+|-]HitachiThreadDumpWithHashCode (Hash code output option of the extended thread dump)

-XX:[+|-]HitachiThreadDumpWithCpuTime (CPU usage time output option of the extended thread dump)

-XX:[+|-]HitachiThreadDumpWithBlockCount (Block count output option of the extended thread dump)

-XX:HitachiJavaLog (Option for specifying the prefix of log file name)

-XX:HitachiJavaLogFileSize (Option for specifying the maximum log file size)

-XX:[+|-]HitachiJavaLogNoMoreOutput (Option specified when the log file input/ output error occurs)

-XX:HitachiJavaLogNumberOfFile (Option for specifying the maximum number of log files)

-XX:[+|-]HitachiOutputMilliTime (Detailed time output option)

-XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output)

-XX:[+|-]HitachiCommaVerboseGC (Option for CSV output)

-XX:HitachiVerboseGCIntervalTime (Option for specifying the output interval of extended verbosegc information)

-XX:[+|-]HitachiVerboseGCPrintCause (Option to output the cause of garbage collection)

-XX:[+|-]HitachiVerboseGCPrintDate (Option to output the date of extended verbosegc information)

-XX:[+|-]HitachiVerboseGCCpuTime (Option to output the CPU usage time of the extended verbosegc information)

-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution (Age distribution output option of Survivor area)

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory (Option to output the C heap information)

-XX:[+|-]HitachiVerboseGCPrintThreadCount (Option to output the number of threads)

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit (Heap size output option used by java.io.File.deleteOnExit())

-XX:[+|-]PrintCodeCacheInfo (Option for the output of the code cache area information)

-XX:CodeCacheInfoPrintRatio (Option for specifying the usage rate of the code cache area)

-XX:[+|-]PrintCodeCacheFullMessage (Option for the output of the code cache area depletion message)

-XX:[+|-]HitachiOutOfMemoryCause (Option to output the causes of exception)

-XX:[+|-]HitachiOutOfMemoryStackTrace (Option for stack trace output)

-XX:HitachiOutOfMemoryStackTraceLineSize (Option for specifying the line size of stack trace)

-XX:[+|-]HitachiOutOfMemorySize (Option to output the memory size)

-XX:[+|-]HitachiOutOfMemoryAbort (Forced termination option)

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump (Option to output the thread dump)

-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf(Class-wise statistical information output option)

-XX:[+|-]HitachiOutOfMemoryHandling (OutOfMemory handling option)

-XX:HitachiOutOfMemoryHandlingMaxThrowCount (Option for setting up the maximum occurrence count)

-XX:[+|-]HitachiJavaClassLibTrace (Option to output the stack trace of class library)

-XX:HitachiJavaClassLibTraceLineSize (Option to specify the line size of stack trace for the class library)

-XX:[+|-]HitachiLocalsInThrowable (Option for collecting the local variable information when an exception occurs)

-XX:[+|-]HitachiLocalsInStackTrace (Option to output the local variable when the thread dump is output)

-XX:[+|-]HitachiLocalsSimpleFormat (Option for changing the output format of the local variable information)

-XX:[+|-]HitachiTrueTypeInLocals (Option to output the true type name of the local variable information)

-XX:HitachiCallToString (Option to output the local variable information)

-XX:[+|-]HitachiFullCore (Release system resource option)

-XX:[+|-]HitachiReserveSwapSpace (Reserve swap area option)

-XX:[+|-]HitachiUseExplicitMemory (Explicit Memory Management functionality option)

-XX:HitachiExplicitHeapMaxSize (Option for specifying the maximum size of the Explicit memory block)

-XX:HitachiExplicitMemoryLogLevel (Option for specifying the log output level of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLog (Option for specifying the log file output location of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLogFileSize (Option for specifying the maximum log file size of the Explicit Memory Management functionality)

-XX:HitachiExplicitMemoryJavaLogNumberOfFile (Option for specifying the maximum number of log files of the Explicit Memory Management functionality)

-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst(Explicit release function option of Explicit Memory Management function)

-XX:[+|-]HitachiExplicitMemoryAutoReclaim (Automatic release function option of explicit memory management)

-XX:[+|-]HitachiExplicitMemoryCompatibleToV8 (Version compatibility setting option of Explicit Memory Management function)

-XX:[+|-]HitachiAutoExplicitMemory (Automatic allocation function option of Explicit Memory Management function)

-XX:HitachiAutoExplicitMemoryFile (Option for specifying the file path of the automatic allocation function of the Explicit Memory Management function)

-XX:ExplicitMemoryFullGCPolicy (Option for controlling the transfer of objects to the Explicit memory block of the Explicit Memory Management functionality)

-XX:[+|-]ExplicitMemoryUseExcludeClass (Option for the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality)

-XX:ExplicitMemoryExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality exclusion setup file)

-XX:ExplicitMemoryNotExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality non-exclusion setup file)

-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim (Memory usage reduction option for Explicit heap used in an HTTP session)

-XX:HitachiJITCompileMaxMemorySize (Option for specifying the maximum memory allocated for JIT compilation)

-XX:[+|-]JITCompilerContinuation (Option for the JIT compiler continuation functionality)

-XX:HitachiThreadLimit (Option for specifying the maximum number of threads)

-XX:+Hitachi (List display option)

Format

-XX:+Hitachi

Description

This option displays a list of JavaVM extension options.

This option does not run the Java program. If you specify this option for starting the J2EE server, the J2EE server will not be started.

-XX:[+|-]HitachiThreadDump (Option to output the extended thread dump information)

Format

-XX:+HitachiThreadDump

If the -Xrs option is not specified, this option outputs the extended thread dump information during thread dump output.

-XX:-HitachiThreadDump

This option outputs the standard thread dump information during thread dump output.

Description

Specify whether to output the extended thread dump information.

The thread dump is output as the standard output to the following files:

Default value

-XX:+HitachiThreadDump

Thread dump output destination

By default, the output destination is the current directory when executing JavaVM. You can specify the environment variable JAVACOREDIR and change the output destination.

Thread dump output file name

javacore process-number.YYMMDDhhmmss#.txt

#

YY: Year (last 2 digits), MM: Month (2 digits), DD: Date (2 digits)

hh: Hours (represented in 24-hours), mm: Minutes (2 digits), ss: Seconds (2 digits)

The following table describes the configuration of thread dump information:

Table 16-3 Configuration of the thread dump information

Output information
Contents

Header
Outputs the date and time when the thread dump is started, the JavaVM version information, and the start command line.

Explicit heap information
The usage status in the entire Explicit heap is output to the Explicit heap information. Regardless of whether the Explicit heap is used, the information will always output when -XX:+HitachiUseExplicitMemory is enabled.

Explicit memory block information
The following information is output with the Explicit memory block information. However, if the Explicit memory block does not exist, nothing is output.

Usage status for each Explicit memory block

Object statistics information (output when the eheapprof command is executed)

Object release ratio information (output when the eheapprof command is executed with the -freeratio option specified)

System settings
Outputs the following information:

The installation directory of the JDK execution environment.

The installation directory of a library configuring JDK

System class path

Java command option

Operation environment
Outputs the following information:

Host name

OS version

CPU information

Resource information (only for UNIX)

Memory information
Outputs the following information for Windows:

Memory usage status

Physical memory usage status

Virtual memory usage status

Paging usage

Java heap information
Outputs the memory usage status of each Java heap generation.

Internal memory map information for JavaVM
Outputs the information of memory area secured by JavaVM.

Internal memory size information for JavaVM
Outputs the information of memory size secured by JavaVM.

Application information
Outputs the following information:

Signal handler

Environment variable

Current directory information

Library information
Outputs the information about a loaded library.

Thread information
Thread-1
:
Thread-n
Outputs the thread information for each thread. Outputs the stack traces of all the existing threads.

Java monitor dump#
Displays the list of Java monitor objects. You can check the exclusion wait status between threads.

JNI global reference information
Outputs the number of global references of JNI maintaining JavaVM.
JNI global reference is created in the following cases:

When Java VM itself is required for startup or execution.

When you issue the NewGlobalRef function that is supported by JNI.

Footer
Outputs the date and time when the thread dump ends.

#

In UNIX, the notify pending list might not be displayed.

Output format

Header

EEE MMM dd hh:mm:ss yyyy#

Full thread dump Java HotSpot(TM) Client VM (1.5.0_05-b05-CDK0850-build-date mixed mode)
invoke-command-line
...

#

EEE represents a day, MMM a month, and dd a date. hh represents hours, mm minutes, ss seconds, and yyyy represents a year.

Explicit heap information and Explicit memory block information

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

Note the following:

A blank line exists between the Explicit heap information and Explicit memory block information.

The output order for the Explicit memory block information (which Explicit memory block will output) is not defined.

Two one-byte character spaces exist before "EM_NAME".

Four one-byte character spaces exist before deployed objects.

ISIZE is aligned at the end of "e" of _________________Size_.

INUM is aligned at the end of the final "s" of __Instances.

FRATIO is aligned at the end of "o" of __FreeRatio__.

CNAME is aligned at the end of the second "_" which is at the beginning of __Class________________.

Four one-byte character spaces exist before memory map.

A blank line exist as the last line. As a result, a blank line exist between the output of each Explicit memory block.

System settings

System Properties
-----------------
Java Home Dir : installation-directory-of-JDK-execution-environment
Java DLL Dir  : installation-directory-of-library-configuring-JDK
Sys Classpath : system-class-path
User Args   :
Java-command-option-1
Java-command-option-2
...

Operating environment (In Windows)

Operating Environment
---------------------
Host  : host-name:IP-address
OS   : OS-version
CPU   : CPU-type, number-of-available-CPUs/ number-of-CPUs-of-all-systems

Operating environment (In UNIX)

Operating Environment
---------------------
Host  : host-name:IP-address
OS   : OS-version
CPU   : CPU-type, number-of-available-CPUs/ number-of-CPUs-of-all-systems

Resource Limits -
    RLIMIT_CPU   :number-of-seconds-available-for-the-process
    RLIMIT_FSIZE  :maximum-file-size-(-unit-:-byte-)
    RLIMIT_DATA  :mallocable-size-(-unit-:-byte-)
    RLIMIT_STACK  :maximum-stack-size-(-unit-:-byte-)
    RLIMIT_CORE  :maximum-core-size-(-unit-:-byte-)
    RLIMIT_RSS   :process-residence-size-(-unit-:-byte-)
    RLIMIT_AS   :available-memory-for-total-processes-(-unit-:-byte-)
    RLIMIT_NOFILE :maximum-file-descriptor-value

Memory information (In Windows)

Memory Status
-------------
Memory in use  : memory-usage-status-(-unit-:-percent-)
Physical memory : physical-memory-usage# free
Virtual memory : virtual-memory-usage# free
Paging file   : paging-usage# free

#

Displayed in the format of available-size/total-size (Units: Bytes).

Java heap information

Heap Status
-----------
def new generation  max maximum-capacity, total current-capacity, used memory-in-use (rate-of-usage-to-maximum-capacity% used/max, rate-of-usage-to-current-capacity% used/total)
          [first-address-of-the-area, last-address-of-the-committed-area, last-address-of-the-reserved-area)
eden space current-capacity, usage% used [first-address-of-the-area, first-address-of-the-area-in-use, last-address-of-the-reserved-area)
from space current-capacity,  usage% used [first-address-of-the-area, first-address-of-the-area-in-use, last-address-of-the-reserved-area)
to  space current-capacity,  usage% used [first-address-of-the-area, first-address-of-the-area-in-use, last-address-of-the-reserved-area)
tenured generation  max maximum-capacity, total current-capacity, used memory-in-use (rate-of-usage-to-maximum-capacity% used/max, rate-of-usage-to-current-capacity% used/total)
          [first-address-of-the-area, last-address-of-the-committed-area, last-address-of-the-reserved-area)
 the space current-capacity, usage% used [first-address-of-the-area, first-address-of-the-area-in-use, first-address-of-the-next-blank-block, last-address-of-the-reserved-area)
compacting perm gen max maximum-capacity, total current-capacity, used memory-in-use (rate-of-usage-to-maximum-capacity% used/max, rate-of-usage-to-current-capacity% used/total)
          [first-address-of-the-area, last-address-of-the-committed-area, last-address-of-the-reserved-area)
 the space current-capacity, usage% used [first-address-of-the-area, first-address-of-the-area-in-use, first-address-of-the-next-blank-block, last-address-of-the-reserved-area)

Note:

The unit of capacity and memory size is kilobytes.

If the -XX:+UseParNewGC option is specified, def new generation is output as par new generation.

Internal memory map information for JavaVM

JVM Internal Memory Map
-----------------------
memory-secure-function:address = start-address - end-address (size:size)

Note:

Memory-secure-function: Either mmap() or malloc() is output.

start-address: Start address of the memory area is output as hexadecimal.

end-address: End address of the memory area is output as hexadecimal.

size: Size of the secured memory area is output (Units: Bytes).

Internal memory size information for JavaVM

JVM Internal Memory Status
--------------------------
Heap Size   :secured-memory-size#
Alloc Size   :used-memory-size#
Free Size   :free-memory-size#

#

Unit: Bytes

Application information (in Windows)

Application Environment
-----------------------
Signal Handlers -
SIGINT     :signal-handler-information
SIGILL     :signal-handler-information
...
SIGBREAK    :signal-handler-information
SIGABRT    :signal-handler-information

Environment Variables -
environment-variable=value
...
Cueeent Directory -

C:\Program Files\Hitachi\Cosminexus\CC\...

Application environment (in UNIX)

Application Environment
-----------------------
Signal Handlers -#1
SIGHUP     :signal-handler-information
SIGINT     :signal-handler-information
...
SIGSOUND    :signal-handler-information
SIGSAK     :signal-handler-information

Signal Handlers -
signal-type: [signal-handler-address], sa_mask[0]= signal-mask, sa_flags= specific-flag
...

Environment Variables -#2
environment-variable=value
...
Current Directory -
/opt/Cosminexus/CC/server/...

#1

The following information is displayed:

- If the signal handler is installed, its address is displayed.

- In the case of SIG_DFL, default is displayed.

- In the case of SIG_IGN, ignored is displayed.

#2

The following information is displayed:

- The signal name defined in /usr/include/sys/signal.h is displayed in signal type.

- The address of the signal handler is output as hexadecimal in the "signal handler address". The address may be displayed in the form of "Library name + Offset."

- The sa_mask field value of the structure fetched by sigaction() is output as hexadecimal in the "signal mask".

- The sa_flags field value of the structure fetched by sigaction() is output as hexadecimal in the "specific flag".

Library information (in Windows and Linux)

Loaded Libraries
----------------
Dynamic libraries :
start-address-end-address  command
start-address-end-address  library
...

Library information (in AIX, HP-UX, and Solaris)

Loaded Libraries
----------------
command
   text   :start-address-end-address (size)
   data   :start-address-end-address (size)
library
   text   :start-address-end-address (size)
   data   :start-address-end-address (size)
...

Thread information

-----------
"thread-name" daemon prio= priority jid=hash-value tid= thread-ID nid= nativeID status [start-address...end-address]
java.lang.Thread.State: current-status-of-thread#
stack=[stack-start-address..YellowPage-address..RedPage-address..stack-end-address]
[user cpu time=user-time ms, kernel cpu time=kernel-time ms] [blocked count=block-count, waited count=standby-count]
at class-name.method-name(method-information)
...

#

Information of current-status-of-thread is output only if JDK 6 is the base and the version is 08-10 or later.

The output contents are as follows:

thread-name

The thread name specified in the constructor of the Thread class is output.

daemon: In the case of the daemon thread, thread name is output as "daemon".

priority: The priority set in the Thread#setPriority is output.

hash-value: The value same as the one obtained by invoking System.identityHashCode() is output as 8-digit hexadecimal.

thread-ID: Memory address of thread object.

nativeID: Thread ID of the OS level.

status: Thread state.
runnable: Running or executable thread
in Object.wait(), waiting for monitor entry or waiting on condition: Thread waiting for monitor lock
sleeping: Thread in the suspended state

start-address: The top-level stack address of the Java frame is output as hexadecimal.

end-address: The top-level stack address with JavaLock is output as hexadecimal.

user-time: The user time since the thread is started is output in milliseconds.

kernel-time: The kernel time since the thread is started is output in milliseconds.

block-count: The number of times the process is blocked since the thread is started is output.

standby- count: The number of times the process is pending since the thread is started is output.

current-status-of-thread

The message indicating the current status of thread is output. The contents of the message correspond to the java.lang.Thread.State enumerated type.

stack-start- address

The stack start address is output in hexadecimals.

YellowPage-address

The first address of the stack Yellow guard page is output in hexadecimals.

RedPage-address

The first address of the stack Red guard page is output in hexadecimals.

stack-end-address

The stack end address is output in hexadecimals.

class-name

The class name is output.

method-name

The method name is output.

method-information

The following method information is output:

Native Method
The information is output in the case of the native method.

File name: Line number
The information is output when the Java method is compiled with the line number.

Unknown Source
The information is output when the Java method is compiled without the line number.

Java monitor dump

Java monitor
------------
lock-object@hash-code owner-information
standby-state:standby-thread-number
standby-thread-information

The output contents are explained below:

lock-object

The class name of the object to be locked is output.

hash-code

The hash code to be obtained with Object.hashCode is output.

owner-information

owner "thread-name"thread-ID
When the monitor has an owner, owner "thread-name"thread-ID is output.

no owner
When the monitor does not have an owner, "no owner" is output.

standby-state

... waiting to enter
This state is displayed when the monitor is waiting for method execution.

... waiting to be notified
This state is displayed when the monitor is waiting for notification.

standby-thread-count

The thread count is output.

standby-thread-information

The information is output in the form of "thread-name" thread-ID.

Information on the number of JNI global references

JNI Information
---------------
JNI global references: JNI-global-reference-count

The output contents are explained below:

JNI global reference count

The number of global references maintained by JavaVM are output.

Note:

Since the JNI global reference is reused even in JavaVM, the numeric value does not reduce even after issuing the DeleteGlobalRef function supported by JNI to delete the JNI global reference. Even if the NewGlobalRef function is issued to create a new JNI global reference, the numeric value does not increase if the JNI global reference reused by JavaVM is allocated.

Footer

Full thread dump completed.  EEE MMM dd hh:mm:ss yyyy#

#

EEE represents a day, MMM a month, and dd a date. hh represents hours, mm minutes, ss seconds, and yyyy represents a year.

The following table describes the comparison of the extended thread dump information:

Table 16-4 Comparison between the output information of the standard thread dump and the extended thread dump

Output information
Standard thread dump
Extended thread dump

Header
N
Y

System settings
N
Y

Operation environment
N
Y

Memory information (in Windows only)
N
Y

Java heap information
N
Y

Internal memory map information for JavaVM
N
Y

Internal memory size information for JavaVM
N
Y

Application environment
N
Y

Library information
N
Y

Thread information
Y
Y#¹

Java monitor dump
N
Y

Footer
N
Y

Thread dump output destination
Standard output
Standard output#2
JavaVM log file

Legend:

Y: Information is output.

N: Information is not output.

#1

Information such as the start and end address of stack is output.

#2

The information is output when the -XX:+HitachiThreadDumpToStdout option is specified.

Precautions

When the output to the directory specified in the environment variable JAVACOREDIR fails, the information is output in current directory.

When the output to the current directory fails, the information is output as standard error output. In this case, the thread dump is not output as the standard output.

When [+|-] in the following options is specified as "-", part of the thread information is not output:

Option name | Information not to be output
-XX:[+|-]HitachiThreadDumpWithHashCode | hash-value
-XX:[+|-]HitachiThreadDumpWithCpuTime | user-time, kernel-time
-XX:[+|-]HitachiThreadDumpWithBlockCount | block-count, standby-count

-XX:[+|-]HitachiThreadDumpToStdout (Option for preventing the standard output of extended thread dump)

Format

-XX:+HitachiThreadDumpToStdout

This option outputs the extended thread dump to the standard output as well as to the thread dump output file.

-XX:-HitachiThreadDumpToStdout

This option does not output the extended thread dump to the standard output. This option outputs the extended tread to the thread dump output file only.

Description

Specify whether to output the extended thread dump to the standard output.

The following message is output regardless of the specification of this option. The extended thread dump is output to the JavaVM log file.

Writing Java core to file-name-(full-path)... OK

Default value

-XX:+HitachiThreadDumpToStdout

Prerequisite options

-XX:+HitachiThreadDump

-XX:[+|-]HitachiThreadDumpWithHashCode (Hash code output option of the extended thread dump)

Format

-XX:+HitachiThreadDumpWithHashCode

This option outputs the hash code to the thread information of extended thread dump.

-XX:-HitachiThreadDumpWithHashCode

This option does not output the hash code to the thread information of the extended thread dump.

Description

Specify whether to output the hash code to the thread information of the extended thread dump.

Note that hash code is output for the thread that is running the Java program. The hash code is not output for the thread used for the internal operations of JavaVM.

Default value

-XX:+HitachiThreadDumpWithHashCode

Prerequisite options

-XX:+HitachiThreadDump

-XX:[+|-]HitachiThreadDumpWithCpuTime (CPU usage time output option of the extended thread dump)

Format

-XX:+HitachiThreadDumpWithCpuTime

In the thread information of the extended thread dump, this option outputs the user CPU time and the kernel CPU time since the thread was started.

-XX:-HitachiThreadDumpWithCpuTime

In the thread information of the extended thread dump, this option does not output the user CPU time and the kernel CPU time since the thread was started.

Description

Specify whether to output the user CPU time and the kernel CPU time in the thread information of the extended thread dump.

The user CPU time and the kernel CPU time are output for the thread that is running the Java program. The user CPU time and the kernel CPU time are not output for the thread used for the internal operations of JavaVM.

You cannot use this functionality in HP-UX. Even if you specify this option, it will be ignored.

Default value

-XX:+HitachiThreadDumpWithCpuTime

Prerequisite options

-XX:+HitachiThreadDump

-XX:[+|-]HitachiThreadDumpWithBlockCount (Block count output option of the extended thread dump)

Format

-XX:+HitachiThreadDumpWithBlockCount

In the thread information of the extended thread dump, this option outputs the number of times the thread has blocked the process and the number of times the process is in the waiting status.

-XX:-HitachiThreadDumpWithBlockCount

In the thread information of the extended thread dump, this option does not output the number of times the thread has blocked the process and the number of times the process is in the waiting status.

Description

In the thread information of the extended thread dump, specify whether to output the number of times the thread has blocked the process and the number of times the process is in the waiting status.

Note that hash code is output for the thread that is running the Java program. The hash code is not output for the thread used for the internal operations of JavaVM.

Default value

-XX:+HitachiThreadDumpWithBlockCount

Prerequisite options

-XX:+HitachiThreadDump

-XX:HitachiJavaLog (Option for specifying the prefix of log file name)

Format

-XX:HitachiJavaLog:character-string

Description

Specify the prefix and the output destination directory of JavaVM log files.

Default value

-XX:HitachiJavaLog:javalog

Prerequisite options

Specify one of the following values:

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:+JITCompilerContinuation

Argument

character-string

Specify the prefix and path. The following 3 types can be specified:

To specify the prefix

The log file name is created as character-string??.log (?? is a serial number from 01 to 99). For example, if you specify "Samp" in character-string, the log file name is Samp01.log. If you do not specify this option, then "javalog" will be set in the character-string and. The log file is output to the current directory.

To specify the path

If the directory is specified in character-string, the file is created in the specified directory. The log file name is generated as character-stringjavalog??.log (?? is the serial number from 01 to 99).

To specify the path and prefix concurrently

When the directory and prefix are specified in character-string, the file is created in the specified directory. The log file name is created as character-string??.log (?? is a serial number from 01 to 99). For example, if you specify d:\temp\Samp in character-string, Samp01.log is created in the d:\temp directory.

-XX:HitachiJavaLogFileSize (Option for specifying the maximum log file size)

Format

-XX:HitachiJavaLogFileSize=integer-value

Description

To avoid the increase in the size of a log file, specify the maximum file size of a log file. When the file size exceeds the maximum limit, log is not output to that file. When this option is not specified, '256 kilobytes' is specified by default.

Default value

-XX:HitachiJavaLogFileSize=256k

Prerequisite options

Specify one of the following values:

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

-XX:+JITCompilerContinuation

Argument

integer-value

Specify the integer value from 1024 to 2147483647 (unit: byte). However, if a value out of range is specified, 1024 is set. When negative value is specified, an error will occur.

-XX:[+|-]HitachiJavaLogNoMoreOutput (Option specified when the log file input/ output error occurs)

Format

-XX:+HitachiJavaLogNoMoreOutput

When the file input/ output error occurs during the log file output, this option outputs the following message to the standard error output and stops the output of log information:

Java logfile output failed.(errno=input-/-output-function-name-where -an-error-occurs:error-number)

-XX:-HitachiJavaLogNoMoreOutput

When the file input/ output error occurs during the log file output, this option outputs the following message as the standard error output, changes the output destination of the log information to the standard error output, and continues the output:

Java logfile output failed.(errno=input-/-output-function-name-where-an-error-occurs:error-number) Changing output to stderr

Description

When input/ output error occurs during log file creation, specify how to output the log information. Note that the processing of JavaVM will continue even if you specify -XX:+HitachiJavaLogNoMoreOutput or -XX:-HitachiJavaLogNoMoreOutput option.

Default value

-XX:+HitachiJavaLogNoMoreOutput

Prerequisite options

Specify one of the following values:

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

Other than -XX:HitachiExplicitMemoryLogLevel:none

-XX:+JITCompilerContinuation

-XX:HitachiJavaLogNumberOfFile (Option for specifying the maximum number of log files)

Format

-XX:HitachiJavaLogNumberOfFile=integer-value

Description

For preventing the increase in the number of log files, specify the maximum number of files to be created. When the number of files exceeds the maximum value, the output to the file created in the beginning is re-started. When this option is not specified, '4' is specified by default.

Default value

-XX:HitachiJavaLogNumberOfFile=4

Prerequisite options

Specify one of the following values:

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

Argument

integer-value

Specify a value in the range of 1 to 99. If a value of 100 or more is specified, 99 will be set and if 0 or less is specified, then 1 will be set. When negative value is specified, an error will occur.

-XX:[+|-]HitachiOutputMilliTime (Detailed time output option)

Format

-XX:+HitachiOutputMilliTime

This option outputs the time up to milliseconds in the JavaVM log file.

-XX:-HitachiOutputMilliTime

This option outputs the time up to seconds in the JavaVM log file.

Description

Specify whether to output the time up to milliseconds.

Default value

-XX:-HitachiOutputMilliTime

Prerequisite options

Specify one of the following values:

-XX:+HitachiVerboseGC

-XX:+HitachiOutOfMemoryStackTrace

-XX:+HitachiOutOfMemoryCause

-XX:+HitachiOutOfMemorySize

-XX:+HitachiJavaClassLibTrace

Other than -XX:HitachiExplicitMemoryLogLevel:none

-XX:+JITCompilerContinuation

Examples of output

Output of the extended verbosegc information

[VGC]<Wed Mar 17 00:45:55.068 2004>(Skip Full:0,Copy:0)[Full GC 149K->149K(1984K), 0.0786038​ secs][DefNew::Eden: 264K->0K(512K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 85K->149K(1408K)][Perm: 1300K->1300K(1536K)]

Output when OutOfMemoryError occurs

[OOM][Thread: 0x00957820​]<Wed Mar 17 00:47:00.662 2004>[java.lang.OutOfMemory Error :(C Heap) :340]

Output of the class library trace

[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 compiler continuation functionality (information on JIT compile failure)

[JCC][Thread: 0x05432c00]<Thu Nov 15 17:10:40.347 2012>[Method: chosa_cmp.func(Ljava/lang/String;)V][Fail: 3][JITCT: 1]

-XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output)

Format

-XX:+HitachiVerboseGC

When garbage collection occurs, this option outputs the extended verbosegc information to the JavaVM log file.

This option outputs the information of Eden, Survivor, Tenured, and Perm kinds that form the internal areas of garbage collection, as the extended verbosegc information.

-XX:-HitachiVerboseGC

When garbage collection occurs, this option does not output the extended verbosegc information to the JavaVM log file.

Description

Specify whether to output the extended verbosegc information when garbage collection occurs.

Default value

-XX:-HitachiVerboseGC

Output format

[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][Perm: perm_info] [cause:cause_info] [User: user_cpu secs] [Sys: system_cpu secs] [CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

The following is a description of the output contents:

id

VGC (Identifier of the JavaVM log file)

date

Indicates the date and time for starting garbage collection.

When the -XX:-HitachiVerboseGCPrintDate option is specified, the date is not output.

full_count

Indicates the number of times the output of full GC information is skipped.

This is output when the -XX:HitachiVerboseGCIntervalTime option is specified.

copy_count

Indicates the number of times the output of copy GC information is skipped.

This is output when the -XX:HitachiVerboseGCIntervalTime option is specified.

gc_kind

Indicates the garbage collection type. "FullGC" or "GC" is output.

gc_info

Indicates the garbage collection information. The information is output in the following format:

area-length-before-the-garbage-collection -> area-length-after-the-garbage-collection (area-size)

gc_time

Indicates the elapsed time for garbage collection.

Eden

Indicates the type of eden. "DefNew::Eden" or "ParNew::Eden" is output.

eden_info

Indicates the Eden information. The information is output in the following format:

area-length-before-the-garbage-collection -> area-length-after-the-garbage-collection (area-size)

Servivor

Indicates the survivor type. "DefNew:: Survivor" or "ParNew::Survivor" is output.

survivor_info

Indicates the Survivor information. The information is output in the following format:

area-length-before-the-garbage-collection -> area-length-after-the-garbage-collection (area-size)

Tenured

Indicates the type of Tenured. "Tenured" is output.

tenured_info

Indicates the Tenured information. The information is output in the following format:

area-length-before-the-garbage-collection -> area-length-after-the-garbage-collection (area-size)

Perm

Indicates the type of Perm. "Perm" is output.

perm_info

Indicates the Perm information. The information is output in the following format:

area-length-before-the-garbage-collection -> area-length-after-the-garbage-collection (area-size)

cause_info

Indicates the cause of garbage collection.

When the -XX:-HitachiVerboseGCPrintCause option is specified, this information is not output.

user_cpu

Indicates the CPU time that the garbage collection thread has consumed in the user mode. The unit is in seconds.

If the -XX:+UseParNewGC option is specified, user_cpu becomes the total CPU time spent in the user mode by all the garbage collection threads.

If an attempt to obtain the CPU time fails, unknown is displayed as in the case of [User: unknown].

When the -XX:-HitachiVerboseGCCpuTime option is specified, the information is not output.

system_cpu

Indicates the CPU time that the garbage collection thread has consumed in the kernel mode. The unit is in seconds.

If the -XX:+UseParNewGC option is specified, system_cpu becomes the total CPU time spent by all the garbage collection threads in the kernel mode.

If an attempt to obtain the CPU time, unknown is displayed as in the case of [Sys: unknown].

When the -XX:-HitachiVerboseGCCpuTime option is specified, the information is not output.

jvm_alloc_size

Specifies the size of the area currently in use, from the areas being managed in JavaVM (size of the area currently in use, from the total size of mmap_total_size and malloc_total_size).

When the -XX:HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

mmap_total_size

Specifies the total C heap size allocated for mmap (VirtualAlloc in Windows), from the areas being managed in JavaVM.

When the -XX:-HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

malloc_total_size

Specifies the total C heap size allocated for malloc, from the areas being managed in JavaVM.

When the -XX:-HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

thread_count

Specifies the number of Java threads.

When the -XX:-HitachiVerboseGCPrintThreadCount option is specified, this information is not output.

doe_alloc_size

Specifies the cumulative heap size allocated by invoking the java.io.File.deleteOnExit()method.

When the -XX:-HitachiVerboseGCPrintDeleteOnExit option is specified, this information is not output.

called_count

Specifies the invocation count of the java.io.File.deleteOnExit() method.

When the -XX:-HitachiVerboseGCPrintDeleteOnExit option is specified, this information is not output.

cc_used_size

Specifies the size of the code cache area used when the garbage collection occurs. The unit is kilobyte.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

cc_max_size

Specifies the maximum size of the code cache area. The unit is kilobyte.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

cc_info

Specifies the maintenance information.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

Examples of output

When -XX:HitachiVerboseGCIntervalTime option is specified

[VGC]<Wed Mar 17 00:42:30 2004>(Skip Full:0,Copy:0)[Full GC 149K->149K(1984K), 0.0786038​ secs][DefNew::Eden: 264K->0K(512K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 85K->149K(1408K)][Perm: 1300K->1300K(1536K)][cause:System.gc][User: 0.0156250​ secs][Sys: 0.0312500​ secs][IM: 729K, 928K, 0K][TC: 509][DOE: 16K, 170] [CCI: 2301K, 49152K, 2304K]

-XX:[+|-]HitachiCommaVerboseGC (Option for CSV output)

Format

-XX:+HitachiCommaVerboseGC

This option outputs the extended verbosegc information in the comma format so that the output can be obtained in a CSV file.

Delete all brackets (parenthesis (), square brackets [], angle brackets <>) and colons (:), and output the comma-delimited numeric values or character strings (,).

-XX:-HitachiCommaVerboseGC

This option outputs the extended verbosegc information in the normal format.

Description

Specify whether to output the extended verbosegc information in CSV format.

Default value

-XX:-HitachiCommaVerboseGC

Prerequisite options

-XX:+HitachiVerboseGC

Output format

The following are the output contents when the -XX:-HitachiVerboseGCIntervalTime option is specified:

id, date, full_count, copy_count, inc_count, gc_kind, gc_info, gc_time, eden_info, survivor_info,tenured_info, perm_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

Indicates the identifier for JavaVM log file.

date

Indicates the date and time for starting garbage collection. When the -XX:-HitachiVerboseGCPrintDate option is specified, the date is not output.

full_count

Indicates the number of times the output of full GC information is skipped.

This is output when the -XX:HitachiVerboseGCIntervalTime option is specified.

copy_count

Indicates the number of times the output of copy GC information is skipped.

This is output when the -XX:HitachiVerboseGCIntervalTime option is specified.

inc_count

0 is displayed.

This is output when the -XX:HitachiVerboseGCIntervalTime option is specified.

gc_kind

Indicates the garbage collection type. "FullGC" or "GC" is output.

gc_info

Indicates the garbage collection information. The information is output in the following format. The unit is kilobyte.

area-length-before-the-garbage-collection,area-length-after-the-garbage-collection,area-size

gc_time

Indicates the elapsed time for garbage collection. The unit is in seconds.

eden_info

Indicates the Eden information. The information is output in the following format: The unit is in kilobytes.

area-length-before-the-garbage-collection,area-length-after-the-garbage-collection,area-size

survivor_info

Indicates the Survivor information. The information is output in the following format: The unit is in kilobytes.

area-length-before-the-garbage-collection,area-length-after-the-garbage-collection,(area-size)

tenured_info

Indicates the Tenured information. The information is output in the following format: The unit is in kilobytes.

area-length-before-the-garbage-collection,area-length-after-the-garbage-collection,(area-size)

perm_info

Indicates the Perm information. The information is output in the following format: The unit is in kilobytes.

area-length-before-the-garbage-collection,area-length-after-the-garbage-collection,area-size

cause_info

Indicates the cause number of garbage collection.

When the -XX:-HitachiVerboseGCPrintCause option is specified, this information is not output.

For the garbage collection cause number, see -XX:[+|-]HitachiVerboseGCPrintCause (Option to output the cause of garbage collection).

user_cpu

Indicates the CPU time that the garbage collection thread has consumed in the user mode. The unit is in seconds.

If the -XX:+UseParNewGC option is specified, user_cpu becomes the total CPU time spent in the user mode by all the garbage collection threads.

If fails to obtain the CPU time, unknown is displayed.

When the -XX:-HitachiVerboseGCCpuTime option is specified, the information is not output.

system_cpu

Indicates the CPU time that the garbage collection thread has consumed in the kernel mode. The unit is in seconds.

If the -XX:+UseParNewGC option is specified, system_cpu becomes the total CPU time spent by all the garbage collection threads in the kernel mode.

If fails to obtain the CPU time, unknown is displayed.

When the -XX:-HitachiVerboseGCCpuTime option is specified, the information is not output.

jvm_alloc_size

Specifies the size of the area currently in use, from the areas being managed in JavaVM (size of the area currently in use, from the total size of mmap_total_size and malloc_total_size). The unit is in kilobytes.

When the -XX:-HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

mmap_total_size

Specifies the total C heap size allocated for mmap (VirtualAlloc in Windows), from the areas being managed in JavaVM. The unit is in kilobytes.

When the -XX:-HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

malloc_total_size

Specifies the total C heap size allocated for malloc, from the areas being managed in JavaVM. The unit is in kilobytes.

When the -XX:-HitachiVerboseGCPrintJVMInternalMemory option is specified, this information is not output.

thread_count

Specifies the number of Java threads.

When the -XX:-HitachiVerboseGCPrintThreadCount option is specified, this information is not output.

doe_alloc_size

Specifies the cumulative heap size allocated by invoking the java.io.File.deleteOnExit()method. The unit is in kilobytes.

When the -XX:-HitachiVerboseGCPrintDeleteOnExit option is specified, this information is not output.

called_count

Specifies the invocation count of the java.io.File.deleteOnExit() method.

When the -XX:-HitachiVerboseGCPrintDeleteOnExit option is specified, this information is not output.

cc_used_size

Specifies the size of the code cache area used when the garbage collection occurs. The unit is kilobyte.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

cc_max_size

Specifies the maximum size of the code cache area. The unit is kilobyte.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

cc_info

Specifies the maintenance information.

When the -XX:-PrintCodeCacheInfo option is specified, this information is not output.

The following are the output contents when the -XX:+HitachiVerboseGCPrintTenuringDistribution option is specified:

id, date, size, value, max_value, total_age1, total_age2, total_agen

For output contents, see -XX:[+|-]HitachiVerboseGCPrintTenuringDistribution (Option to output the tenuring distribution for the Survivor area).

Examples of output

When -XX:HitachiVerboseGCIntervalTime option is specified

VGC,Fri Jan 23 21:37:50 2004,11,41,0,GC,16886,16886,65088,0.0559806​,
4094,0,4096,447,447,448,12345,16439,60544,1116,1116,4096,0,0.0312500​, 0.0156250​,729,928,0,509,2167,2054,2301,49152,2304
VGC,Fri Jan 23 21:37:55 2004,6,24,0,Full GC,65082,65082,65088,0.4294532​,
4094,4094,4096,447,447,448,60541,60541,60544,1116,1116,4096,0,0.0156250​, 0.0312500​,729,928,0,509,16,170,2301,49152,2304
...

When -XX:+HitachiVerboseGCPrintTenuringDistribution option is specified

PTD,Wed May 28 11:45:23 2008,5467547​,30,31,1357527​,1539661​

-XX:HitachiVerboseGCIntervalTime (Option for specifying the output interval of extended verbosegc information)

Format

-XX:HitachiVerboseGCIntervalTime = integer-value

Description

Specify the time interval (second) to output the extended verbosegc information.

When option is specified

The extended verbosegc information is not output for each garbage collection, but it is output for the following cases of garbage collection that exceeds the specified time. In such cases, the number of times the following garbage collection occurs between the previous output and the current output is also output. This option always outputs the number of times the garbage collection occurs.

Table 16-5 List of the garbage collection frequency

Character string | Meaning
Full | Number of times the full garbage collection is skipped.
Copy | Number of times the copy garbage collection is skipped

When option is not specified

By default, 0 seconds is specified and the extended verbosegc information is output for each occurrence of garbage collection.

Default value

-XX:HitachiVerboseGCIntervalTime=0

Prerequisite options

-XX:+HitachiVerboseGC

Argument

integer-value

Specify the integer value from 0 to 2147483647 (unit: seconds). However, if a value out of range is specified, 0 is set. When negative value is specified, an error will occur.

-XX:[+|-]HitachiVerboseGCPrintCause (Option to output the cause of garbage collection)

Format

-XX:+HitachiVerboseGCPrintCause

This option outputs the cause of garbage collection to the end of extended verbosegc information.

-XX:-HitachiVerboseGCPrintCause

This option outputs the extended verbosegc information in the normal format.

Description

Specify whether to output the cause of the garbage collection.

Default value

-XX:+HitachiVerboseGCPrintCause

Prerequisite options

-XX:+HitachiVerboseGC

When the -XX:+HitachiCommaVerboseGC option is specified, the following cause numbers are output:

Table 16-6 List of causes of garbage collection

Cause number | Cause | Description
0 | ObjAllocFail | The garbage collection occurred due to the failure in object allocation.
1 | System.gc | The garbage collection occurred due to the invocation of the java.lang.System.gc method.
2 | PermAllocFail | The garbage collection occurred due to the failure in allocation of the permanent heap.
3 | DelayedGC | The reserved garbage collection is invoked by the JNI and JVMPI.
4 | JavaGC Command | The garbage collection occurred by the JavaGC command
5 | LastPermGC | The last garbage collection before throwing the OutOfMemoryError of permanent heap occurred.
6 | JHeapProf Command | The garbage collection occurred due to the jheapprof command.
8 | EMReclaimFail | There was a Java heap overflow because objects were moved to the Java heap due to the explicit release of the Explicit memory.
9 | EMMigrateFail | There was a Java heap overflow because objects were moved to the Java heap due to the automatic release of the Explicit memory.
10 | JVMTIForceGC | Garbage collection occurred due to the JVMTI function ForceGarbageCollection().
11 | PromotionFail | Garbage collection occurred due to promotion failure in copy garbage collection.
12 | EMJavaGC Command | Garbage collection occurred due to the release of the Explicit memory block by the javagc command.
13 | EHeapProf Command | Garbage collection occurred due to the eheapprof command.

Examples of output

[VGC]<Wed Mar 17 00:42:30 2004>(Skip Full:0,Copy:0)[Full GC 149K->149K(1984K), 0.0786038​ secs][DefNew::Eden: 264K->0K(512K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 85K->149K(1408K)][Perm: 1300K->1300K(1536K)][cause:System.gc]

-XX:[+|-]HitachiVerboseGCPrintDate (Option to output the date of extended verbosegc information)

Format

-XX:+HitachiVerboseGCPrintDate

This option outputs the date and time for starting garbage collection at the beginning of each output line of the extended verbosegc information.

-XX:-HitachiVerboseGCPrintDate

This option does not output the date and time for starting garbage collection at the beginning of each output line of the extended verbosegc information.

Description

Specify whether to output the date and time for starting garbage collection in the extended verbosegc information.

Default value

-XX:+HitachiVerboseGCPrintDate

Prerequisite options

-XX:+HitachiVerboseGC

-XX:[+|-]HitachiVerboseGCCpuTime (Option to output the CPU usage time of the extended verbosegc information)

Format

-XX:+HitachiVerboseGCCpuTime

This option outputs the processor time that the garbage collection executing thread has consumed in the user mode and kernel mode from the start to the end of the garbage collection in the extended verbosegc information.

-XX:-HitachiVerboseGCCpuTime

This option does not output the processor time that the garbage collection executing thread has consumed in the user mode and the kernel mode from the start to the end of the garbage collection in the extended verbosegc information.

Description

Specify whether to output the CPU usage time in the extended verbosegc information.

You cannot use this functionality in HP-UX. Even if you specify this option, it will be ignored.

Default value

-XX:+HitachiVerboseGCCpuTime

Prerequisite options

-XX:+HitachiVerboseGC

Examples of output

[VGC]<Wed Mar 17 00:42:30 2004>(Skip Full:0,Copy:0)[Full GC 149K->149K(1984K), 0.0786038​ secs][DefNew::Eden: 264K->0K(512K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 85K->149K(1408K)][Perm: 1300K->1300K(1536K)][User:0.0156250​ secs][Sys: 0.0312500​ secs]

-XX:[+|-]HitachiVerboseGCPrintTenuringDistribution (Age distribution output option of Survivor area)

Format

-XX:+HitachiVerboseGCPrintTenuringDistribution

This option outputs the age distribution of Survivor area that is output when specifying -XX:+PrintTenuringDistribution to the JavaVM log file.

-XX:-HitachiVerboseGCPrintTenuringDistribution

This option does not output the age distribution of Survivor area that is output when specifying -XX:+PrintTenuringDistribution to the JavaVM log file.

Description

Specify whether to output the age distribution of the Survivor area that is output when specifying -XX:+PrintTenuringDistribution to the JavaVM log file.

Default value

-XX:-HitachiVerboseGCPrintTenuringDistribution

Prerequisite options

-XX:+HitachiVerboseGC

Related option

-XX:+PrintTenuringDistribution

-XX:+HitachiVerboseGCPrintDate

-XX:+HitachiCommaVerboseGC

Output format

[id]date[Desired survivor:size bytes][New threshold:value][MaxTenuringThreshold: max_value][age1:total_age1][age2:total_age2]...[agen:total_agen]

The following is a description of the output contents:

id

PTD (JavaVM log file identifier).

date

Indicates the date and time for starting garbage collection.

size

Indicates the object target size in Survivor area after garbage collection.

value

Specifies the tenuring threshold value of the Java objects promoted to the Tenured area during the next copy garbage collection.

This value is set up dynamically for each copy garbage collection, based on the values specified in the -XX:MaxTenuringThreshold=value option, the memory size of the Survivor area, and the -XX:TargetSurvivorRatio=value option.

The tenured Java objects more than the value in value are promoted to the Tenured area in the next copy garbage collection.

max_value

Maximum (value specified in the MaxTenuringThreshold option) tenuring threshold value (value) of the Java objects promoted to the Tenured area during copy garbage collection.

The value is set up dynamically for each copy garbage collection; however, does not exceed the max_value value.

Also, the Java objects for which tenuring is greater than the max_value value are definitely promoted to the Tenured area during the next copy garbage collection.

total_age1

Indicates total number of bytes of a 1 year old object.

total_age2

Indicates total number of bytes of a 1 to 2 year old object.

total_agen

Indicates total number of bytes of a 1 to n year old object.

If n is close to max_value, it means that an object with a long life exists.

Examples of output

[PTD]<Wed Jan 28 17:47:10 2009>[Desired survivor:32768 bytes][New threshold:30][MaxTenuringThreshold:30][age1:6872][age2:9632][age3:25632]

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory (Option to output the C heap information)

Format

-XX:+HitachiVerboseGCPrintJVMInternalMemory

This option outputs the heap information being managed in JavaVM to the JavaVM log file.

-XX:-HitachiVerboseGCPrintJVMInternalMemory

This option does not output the heap information being managed in JavaVM to the JavaVM log file.

Description

Specifies whether to output the heap information being managed in JavaVM to the JavaVM log file.

From the C heap areas, the heap area obtained using the following two methods is managed in JavaVM:

C heap area obtained with mmap

C heap area obtained with malloc

If you enable the -XX:+HitachiVerboseGCPrintJVMInternalMemory option, you can output the total C heap size obtained with mmap (mmap_total_size) and the total C heap size obtained with malloc (malloc_total_size). You can also output the total size of the area in use from these allocated areas (jvm_alloc_size).

Default value

-XX:+HitachiVerboseGCPrintJVMInternalMemory

Prerequisite options

-XX:+HitachiVerboseGC

Output format

[id] date (Skip Full:full_count, Copy:copy_count, Inc:inc_count) [gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info][Tenured: tenured_info][Perm: perm_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]

The output contents are explained below. Note that the following explains the items output by this option. For items other than explained below, see the output format described in the -XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output).

jvm_alloc_size

Specifies the size of the area currently in use, from the areas being managed in JavaVM (size of the area currently in use, from the total size of mmap_total_size and malloc_total_size).

mmap_total_size

Specifies the total C heap size allocated for mmap (VirtualAlloc in Windows), from the areas being managed in JavaVM.

malloc_total_size

Specifies the total C heap size allocated for malloc, from the areas being managed in JavaVM.

Examples of output

[VGC]<Wed Jan 27 13:03:36 2010>(Skip Full:0,Copy:0)[GC 489K->152K(3520K), 0.0156080​ secs][DefNew::Eden: 489K->0K(2048K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 0K->88K(1408K)][Perm: 1867K->1867K(8192K)][cause:ObjAllocFail][IM: 729K, 928K, 0K][TC: 509][DOE: 16K, 170]

-XX:[+|-]HitachiVerboseGCPrintThreadCount (Option to output the number of threads)

Format

-XX:+HitachiVerboseGCPrintThreadCount

This option outputs the number of Java threads.

-XX:-HitachiVerboseGCPrintThreadCount

This option does not output the number of Java threads.

Description

Specifies whether to output the number of Java threads to the JavaVM log file in order to monitor the number of Java threads.

A thread individually allocates the memory to be used for a stack as C heap. Therefore, if the number of threads increase, the allocated C heap amount also increases in proportion to the number of threads. By specifying the -XX:+HitachiVerboseGCPrintThreadCount option, you can monitor the number of Java threads as well as understand the amount of C heap that is allocated.

Default value

-XX:+HitachiVerboseGCPrintThreadCount

Prerequisite options

-XX:+HitachiVerboseGC

Output format

[id] <date> (Skip Full:full_count, Copy:copy_count, Inc:inc_count) [gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info][Tenured: tenured_info][Perm: perm_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]

The output contents are explained below. Note that the following explains the items output by this option. For items other than explained below, see the output format described in -XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output).

thread_count

Specifies the number of Java threads.

Examples of output

[VGC]<Wed Jan 27 13:03:36 2010>(Skip Full:0,Copy:0)[GC 489K->152K(3520K), 0.0156080​ secs][DefNew::Eden: 489K->0K(2048K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 0K->88K(1408K)][Perm: 1867K->1867K(8192K)][cause:ObjAllocFail][IM: 729K, 928K, 0K][TC: 509]

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit (Heap size output option used by java.io.File.deleteOnExit())

Format

-XX:+HitachiVerboseGCPrintDeleteOnExit

This option outputs the cumulative heap size allocated by invoking the java.io.File.deleteOnExit() method and the method invocation count.

-XX:-HitachiVerboseGCPrintDeleteOnExit

This option does not output the cumulative heap size allocated by invoking the java.io.File.deleteOnExit() method and the method invocation count.

Description

Specifies whether to output the cumulative heap size that JavaVM allocates by invoking the java.io.File.deleteOnExit() method and the method invocation count, to the JavaVM log file.

The path information for a specified file is allocated to a heap each time the java.io.File.deleteOnExit()method is invoked; however, the allocated area is not released until the process ends; and therefore, might lead to compression of memory. If you specify the -XX:+HitachiVerboseGCPrintDeleteOnExit option, JavaVM can invoke the java.io.File.deleteOnExit() method, output the allocated heap size to a log, and monitor the size. The method invocation count can also be output concurrently as the supplementary information to understand the invocation status of java.io.File.deleteOnExit().

The information that is output helps to understand the heap size allocated by invoking the java.io.File.deleteOnExit() and to investigate the cause of memory shortage when an error occurs. You can also use this information to check the changes in the increase of the heap size allocated by invoking the java.io.File.deleteOnExit() and to check for any signs of memory compression during operations, in the development and testing phase before the start of operations.

Note that an error message is displayed when an error occurs.

Default value

-XX:+HitachiVerboseGCPrintDeleteOnExit

Prerequisite options

-XX:+HitachiVerboseGC

Output format

The output format of the JavaVM log file is as follows:

[id] <date> (Skip Full:full_count, Copy:copy_count, Inc:inc_count) [gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info][Tenured: tenured_info][Perm: perm_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]

The output contents are explained below. Note that the following explains the items output by this option. For items other than explained below, see the output format described in -XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output).

doe_alloc_size

Specifies the cumulative heap size allocated by invoking the java.io.File.deleteOnExit()method.

called_count

Specifies the invocation count of the java.io.File.deleteOnExit() method.

The output format of the error message displayed when an error occurs is as follows:

[DOE] date Error occurred during processing of java.io.File.deleteOnExit's heap size output function. (maintenance-information)
[DOE]java.io.File.deleteOnExit's heap size output function stopped.

The following is the contents of the error message:

DOE

Specifies an identifier indicating that an error occurred in the heap size output function of the java.io.File.deleteOnExit().

date

Specifies the date when the error occurred.

Examples of output

The following is an example of output of the JavaVM log file:

[VGC]<Wed Jan 27 13:03:36 2010>(Skip Full:0,Copy:0)[GC 489K->152K(3520K), 0.0156080​ secs][DefNew::Eden: 489K->0K(2048K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 0K->88K(1408K)][Perm: 1867K->1867K(8192K)][cause:ObjAllocFail][IM: 729K, 928K, 0K] [TC: 509][DOE: 16K, 170]

The following is an example of output of the error message:

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

Precautions

The cumulative heap size and method invocation count is not calculated in the following cases even when the java.io.File.deleteOnExit() is invoked:

If the SecurityException exception occurs when the java.io.File.deleteOnExit() is invoked (This exception occurs when the SecurityManager.checkDelete() method of the security manager is not allowed access to delete files. In this case, an exception is thrown at method entrance and no heap is allocated).

When java.io.File.deleteOnExit() is invoked from applications created using the batch application executing infrastructure of Application Server.

When java.io.File.deleteOnExit() is invoked by using the File instance created with the same path name string.

Note the following points when you check the heap size output by this functionality:

The heap type allocated by java.io.File.deleteOnExit() is Java heap.

The heap size is output in kilobytes and a size of less than 1 KB is rounded down. The heap size allocated when the java.io.File.deleteOnExit() method is invoked once ranges from tens of bytes to 100 bytes, depending on the length of the file path; therefore, the output results of heap size might not increase with each invocation of the java.io.File.deleteOnExit() method. In this case, you can check the execution of the method from the method invocation count.

-XX:[+|-]PrintCodeCacheInfo (Option for the output of the code cache area information)

Format

-XX:+PrintCodeCacheInfo

This option outputs the amount of code cache area used.

This option also outputs a message informing the user that the usage of the code cache area has reached the threshold value.

-XX:-PrintCodeCacheInfo

This option does not output the amount of code cache area used.

Also, this option does not output the message informing the user that the usage of the code cache area has reached the threshold value.

Description

Specify whether to output the amount of code cache area used and the message informing the user that the usage has reached the threshold value, to the JavaVM log file.

For details on the code cache area, see 7.1.2 Memory space configuration used with JavaVM and the JavaVM options in the uCosminexus Application Server System Design Guide.

If this option is enabled, the amount of code cache area used is output to the extended verbosegc information when a garbage collection occurs. Also, a message is output when the amount of code cache area used reaches the threshold value.

The threshold value is maximum-size-of-code-cache-area value-of--XX:CodeCacheInfoPrintRatio-option / 100.

Even if the -XX:-HitachiVerboseGC option is specified, the amount of code cache area used is output to the extended verbosegc information output by the -v option and -s option of the javagc command.

Default value

-XX:+PrintCodeCacheInfo

Prerequisite option

-XX:+HitachiVerboseGC

Related options

-XX:+HitachiCommaVerboseGC

-XX:CodeCacheInfoPrintRatio

Output format

The output format of the amount of code cache area used is as follows:

[id] date (Skip Full:full_count, Copy:copy_count, Inc:inc_count) [gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info][Tenured: tenured_info][Perm: perm_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]

The output contents are as follows. Note that the items output by this option are described here. For items other than those described here, see the output format in -XX:[+|-]HitachiVerboseGC (Option for extended verbosegc information output).

cc_used_size

Specifies the size of the code cache area used when the garbage collection occurs. The unit is kilobyte.

cc_max_size

Specifies the maximum size of the code cache area. The unit is kilobyte.

cc_info

Specifies the maintenance information.

The following is the output format of the message informing the user that the usage of the code cache area has reached the threshold value:

[cc_id]<cc_date>CodeCache usage has exceeded the threshold.[cc_used_sizeK, cc_max_sizeK, cc_infoK]

The contents output in the message are as follows:

cc_id

Specifies the CCI (identifier of the JavaVM log file).

cc_date

Specifies the date and time when the JIT compilation was executed.

cc_used_size

Specifies the used size of the code cache area after the JIT compilation. The unit is kilobyte.

cc_max_size

Specifies the maximum size of the code cache area. The unit is kilobyte.

cc_info

Specifies the maintenance information.

Examples of output

The following is an example of output of the amount of code cache area used:

[VGC]<Wed Mar 17 00:42:30 2004>(Skip Full:0,Copy:0)[Full GC 149K->149K(1984K), 0.0786038​ secs][DefNew::Eden: 264K->0K(512K)][DefNew::Survivor: 0K->63K(64K)][Tenured: 85K->149K(1408K)][Perm: 1300K->1300K(1536K)][cause:System.gc][User: 0.0156250​ secs][Sys: 0.0312500​ secs][IM: 729K, 928K, 0K][TC: 509][DOE: 16K, 170][CCI: 2301K, 49152K, 2304K]

The following is an example of output of the message informing the user that the usage of the code cache area has reached the threshold value:

[CCI]<Wed Dec 26 14:27:53 2012>CodeCache usage has exceeded the threshold.[39358K, 49152K, 39360K]

Notes

If usage of the code cache area is changed when the threshold value is reached, no message is output even if the JIT compilation is executed for the Java method.
On the other hand, after the usage of the code cache area drops to less than the threshold value, the message is output when the usage of the code cache area again reaches the threshold value due to the JIT compilation of the Java method.

The code cache area used by the system is a maximum of 500 kilobyte in a 32-bit system and a maximum of 2 megabyte in a 64-bit system. Therefore, depending on the usage of the code cache area of the system, the code cache area might deplete even if the maximum area is not used.
Also, if a large value is specified as the threshold value for the usage of the code cache area, the code cache area might deplete before the message is output. If you want the message to be output before the code cache area depletes, specify the value for -XX:CodeCacheInfoPrintRatio (Option for specifying the usage rate of the code cache area) in such a way that the value of "maximum-size-of-code-cache-area - threshold-value" is 4 megabyte or more.

-XX:CodeCacheInfoPrintRatio (Option for specifying the usage rate of the code cache area)

Format

-XX:CodeCacheInfoPrintRatio=integer-value

Description

Specify the usage rate of the code cache area that will trigger the output of a message informing the user that the usage of the code cache area has reached the threshold value.

The threshold value is calculated using the following formula based on the usage rate specified in this option:

maximum-size-of-code-cache-area value-of--XX:CodeCacheInfoPrintRatio-option / 100

For details on the code cache area, see 7.1.2 Memory space configuration used with JavaVM and the JavaVM options in the uCosminexus Application Server System Design Guide.

Default value

-XX:CodeCacheInfoPrintRatio=80

Prerequisite option

-XX:+PrintCodeCacheInfo

Argument

Integer-value

Specify an integer from 0 to 100 (unit: %). If the specified value is outside the range, 80 is specified.

-XX:[+|-]PrintCodeCacheFullMessage (Option for the output of the code cache area depletion message)

Format

-XX:+PrintCodeCacheFullMessage

This option outputs a message if the code cache area is depleted when the Java method is subject to JIT compilation. The message is output once only.

-XX:-PrintCodeCacheFullMessage

This option does not output a message even if the code cache area is depleted when the Java method is subject to JIT compilation.

Description

Specify whether to output a message to the JavaVM log file if the code cache area is depleted when the Java method is subject to JIT compilation.

For details on the code cache area, see 7.1.2 Memory space configuration used with JavaVM and the JavaVM options in the uCosminexus Application Server System Design Guide.

Default value

-XX:+PrintCodeCacheFullMessage

Prerequisite option

-XX:+HitachiVerboseGC

Output format

The output format of the message is as follows:

[cc_id]<cc_date>CodeCache is full. Compiler has been disabled.[cc_used_sizeK, cc_max_sizeK, cc_infoK]

The contents output in the message are as follows:

cc_id

Specifies the CCI (identifier of the JavaVM log file).

cc_date

Specifies the date and time when the Java method is subjected to the JIT compilation.

cc_used_size

Specifies the used size of the code cache area when the Java method is subjected to the JIT compilation. The unit is kilobyte.

cc_max_size

Specifies the maximum size of the code cache area. The unit is kilobyte.

cc_info

Specifies the maintenance information.

Examples of output

The following is an example of output of the message:

[CCI]<Wed Dec 26 14:38:29 2012>CodeCache is full. Compiler has been disabled.[49151K, 49152K, 49152K]

Notes

The code cache area used by the system is a maximum of 500 kilobytes in a 32-bit system and a maximum of 2 megabyte in a 64-bit system. Therefore, depending on the usage of the code cache area of the system, the code cache area might deplete even if the maximum area is not used.

-XX:[+|-]HitachiOutOfMemoryCause (Option to output the causes of exception)

Format

-XX:+HitachiOutOfMemoryCause

When OutOfMemoryError occurs, this option outputs the types of causes for exceptions in the JavaVM log file. When the -XX:+HitachiOutOfMemoryStackTrace option is specified, the -XX:+HitachiOutOfMemorySize option is also specified.

The following table describes the types of the causes that are output:

When OutOfMemoryError is thrown because the functionality for setting up the maximum number of threads (HitachiThreadLimit option) is specified and the number of created threads exceeds the specified limit.

Table 16-7 List of types of exception causes

No. | Cause message | Description
1 | C Heap | Exception when securing the C heap
2 | Java Heap | Exception when securing the Java heap
3 | Perm Heap | Exception when securing the Perm heap
4 | Unknown | Exception not identified as one of the above
5 | Thread Limit | Exception thrown when the functionality for setting up the maximum number of threads (-XX:HitachiThreadLimit option) is specified and the number of created threads exceed the specified limit.

-XX:-HitachiOutOfMemoryCause

When OutOfMemoryError occurs, the -XX:-HitachiOutOfMemoryCause option does not output the types of causes for exceptions in the JavaVM log file.

Description

Specify whether to output the types of causes for the occurrence of OutOfMemoryError.

Default value

-XX:-HitachiOutOfMemoryCause

Examples of output

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>[java.lang.OutOfMemoryError :(C Heap) : unable to create thread : 340 threads exist]

-XX:[+|-]HitachiOutOfMemoryStackTrace (Option for stack trace output)

Format

-XX:+HitachiOutOfMemoryStackTrace

When OutOfMemoryError occurs, this option outputs the exception information and the stack trace in the JavaVM log file.

The stack trace is stored in the buffer for each stack and is output after changing the code. The stack trace is output every time OutOfMemoryError is thrown. Therefore, when OutOfMemoryError is caught and thrown again, the stack trace is output multiple times. When OutOfMemoryError occurs during the creation of the thread, the stack trace is not output.

-XX:-HitachiOutOfMemoryStackTrace

When OutOfMemoryError occurs, this option does not output the stack trace to the JavaVM log file.

Description

Specify whether to output the exception information and the stack trace to the JavaVM log file when OutOfMemoryError occurs.

Default value

-XX:-HitachiOutOfMemoryStackTrace

Output format

[id] [Thread:thread_id]date[java.lang.OutOfMemoryError : requested size bytes (cause) : reason : thread_count threads exist]
[id] [Thread:thread_id] stack_trace

The following is a description of the output contents:

id

OOM (Identifier of the JavaVM log file).

thread_id

Thread ID (tid output to the thread dump).

date

Indicates the date and time when OutOfMemory exception occurs.

size

The size of the memory that you tried to secure is output (unit: Bytes). When the -XX:-HitachiOutOfMemorySize option is specified, the size is not output.

Note that in the following cases the requested memory size is not fetched. In such cases, "unknown" is output as the size.

When OutOfMemoryError is explicitly thrown without using the memory secure functionality of Java
The errors thrown by the standard class library will also be included. For example, when an error is thrown by the processes, such as "throw new OutOfMemoryError();" the memory size cannot be output.

When OutOfMemoryError is caused by the verifier in the case of class loading.

cause

Indicates the types of causes for the occurrence of exceptions. The cause, however, is not output when the -XX:-HitachiOutOfMemoryCause option is specified. For the types of causes for the occurrence of exceptions, see -XX:[+|-]HitachiOutOfMemoryCause (Option to output the causes of exception).

reason

Indicates the reason for the occurrence of the exception. The reason is output when the creation of the thread fails.

thread_count

Indicates the number of threads when OutOfMemoryError occurs. The count also includes the number of threads whose creation failed.

stack_trace

Stack trace.

Examples of output

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

Precautions

When the thread creation in JavaVM fails due to insufficient memory, only the exception information is output and the stack trace is not output.

-XX:HitachiOutOfMemoryStackTraceLineSize (Option for specifying the line size of stack trace)

Format

-XX:HitachiOutOfMemoryStackTraceLineSize=integer-value

Description

When OutOfMemoryError occurs, specify the number of characters in one line of the output stack trace, in bytes. When the option is not specified, by default 1024 bytes is specified. When the specified number of bytes cannot be secured, a warning message is output and the stack trace is not output. When the number of characters in one line exceeds the number of specified characters, the first half portion of the character strings from "at" onwards is deleted and the specified number of characters is output.

Default value

-XX:HitachiOutOfMemoryStackTraceLineSize=1024

Prerequisite options

-XX:+HitachiOutOfMemoryStackTrace

Argument

integer-value

Specify the integer value from 1024 to 2147483647 (unit: byte). However, if a value out of range is specified, 1024 is set. When negative value is specified, an error will occur.

-XX:[+|-]HitachiOutOfMemorySize (Option to output the memory size)

Format

-XX:+HitachiOutOfMemorySize

When OutOfMemoryError occurs, this option outputs the requested memory size in bytes.

When the -XX:+HitachiOutOfMemoryStackTrace option is specified, the -XX:+HitachiOutOfMemorySize option is also specified.

-XX:-HitachiOutOfMemorySize

When OutOfMemoryError occurs, this option does not output the requested memory size.

Description

Output the requested memory size when OutOfMemoryError occurs.

Default value

-XX:-HitachiOutOfMemorySize

Examples of output

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>[java.lang.OutOfMemoryError : requested 1024 bytes. (Java Heap) : 20 threads exist]

Precautions

In the following cases, the requested memory size is not fetched:

When OutOfMemoryError is clearly thrown without using the memory secure functionality of Java (errors thrown by J2SE class library are also included).

Example: throw new OutOfMemoryError();

When OutOfMemoryError is caused by verifier during class loading.

[OOM][Thread: 0x00062fd0]<Tue Dec 2 16:42:39 2003>[java.lang.OutOfMemoryError : requested size unknown. (Unknown) : 10 threads exist]

-XX:[+|-]HitachiOutOfMemoryAbort (Forced termination option)

Format

-XX:+HitachiOutOfMemoryAbort

When OutOfMemoryError occurs, this option outputs the memory dump and executes forced termination.

-XX:-HitachiOutOfMemoryAbort

When OutOfMemoryError occurs, this option does not execute forced termination.

Description

When OutOfMemoryError occurs due to the following reasons, a message is output to the standard output and memory dump or core dump to the current directory, and then forced termination is executed.

When Java heap is insufficient

When Perm heap is insufficient

When C heap is insufficient in the J2SE class library

Note that when C heap is insufficient during JavaVM processing, the process is forcefully terminated regardless of whether this option is specified.

Exit code for forced termination

The JavaVM exit code for forced termination is as follows:

In Windows

In Windows XP
When the output of memory dump is successful: -2147483645
When the output of memory dump fails: 1

In Windows Server 2012, Windows Server 2008, Windows 8, Windows 7, and Windows Vista
1

In UNIX

6

Note that when executed on UNIX shell (such as sh and csh), 0x80 is added and the exit code becomes 0x86.

Default value

-XX:-HitachiOutOfMemoryAbort

Examples of output

java.lang.OutOfMemoryError occurred.
JavaVM aborted because of specified -XX:+HitachiOutOfMemoryAbort options.

Precautions

When the -XX:+HitachiOutOfMemoryStackTrace option is specified, the stack trace is output to the JavaVM log file and then the process is aborted.

Memory dump is created in the Watson log generated directory as user.dmp. In the case of IPF, the memory dump is created in the current directory as memory.dmp.

When this option is specified, the processing of JavaVM termination that is registered in the java.io.File.deleteOnExit method and the java.lang.Runtime.addShutdownHook method is not executed and is forcefully terminated.

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump (Option to output the thread dump)

Format

-XX:+HitachiOutOfMemoryAbortThreadDump

When OutOfMemoryError occurs, the thread dump is output.

When the -XX:+HitachiOutOfMemoryAbort option is specified, this option can be specified.

-XX:-HitachiOutOfMemoryAbortThreadDump

This option does not output the thread dump when OutOfMemoryError occurs.

Description

When OutOfMemoryError occurs, the thread dump is output. When C heap is insufficient in J2SE class library, this option does not output the thread dump to avoid the recurrence of C heap insufficiency due to the output of thread dump.

Specify the output destination of the thread dump in the environment variable JAVACOREDIR or the -XX:+HitachiThreadDumpToStdout option.

Default value

-XX:+HitachiOutOfMemoryAbortThreadDump

Prerequisite options

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiThreadDump

-XX:[+|-]HitachiOutOfMemoryAbortThreadDumpWithJHeapProf(Class-wise statistical information output option)

Format

-XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

The -XX:+HitachiOutOfMemoryAbortThreadDumpWithJHeapProf outputs class-wise statistical information to the thread dump log file output by -XX:+HitachiOutOfMemoryAbortThreadDump.

-XX:-HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

The -XX:-HitachiOutOfMemoryAbortThreadDumpWithJHeapProf does not output class-wise statistical information to the thread dump log file output by -XX:+HitachiOutOfMemoryAbortThreadDump.

Description

Specify whether to output class-wise statistical information to the thread dump log file output by -XX:+HitachiOutOfMemoryAbortThreadDump.

Default value

-XX:-HitachiOutOfMemoryAbortThreadDumpWithJHeapProf

Prerequisite options

-XX:+HitachiOutOfMemoryAbort

-XX:+HitachiOutOfMemoryAbortThreadDump

-XX:+HitachiThreadDump

-XX:[+|-]HitachiOutOfMemoryHandling (OutOfMemory handling option)

Format

-XX:+HitachiOutOfMemoryHandling

This option enables the OutOfMemory handling functionality.

-XX:-HitachiOutOfMemoryHandling

This option disables the OutOfMemory handling functionality.

Description

Specify whether to enable the OutOfMemory handling functionality. This option is valid only when the J2EE server is executed in J2EE server mode.

Use the OutOfMemory handling functionality in combination with the forced termination functionality for OutOfMemory (-XX:+HitachiOutOfMemoryAbort). If the forced termination functionality for OutOfMemory (-XX:-HitachiOutOfMemoryAbort) is disabled, the OutOfMemory handling functionality will be disabled.

If the OutOfMemory handling functionality is enabled, the OutOfMemoryError throwing condition is determined when OutOfMemory occurs. Specifically, if OutOfMemory occurs due to Java heap or Perm heap shortage during the following processing, the functionality determines whether to continue executing the J2EE server:

Request processing during the execution of Web applications (Servlets or JSPs) on the Web container

Processing during the execution of the Enterprise Bean invoked from an EJB client application

Processing during the execution of the Message-driven Bean

Processing during the execution of the Enterprise Bean invoked from Timer Service

After determining, if the J2EE server continues execution, the java.lang.OutOfMemoryError is thrown and only the request processing where OutOfMemory occurred is cancelled.

JavaVM performs the following operations based on the determined results. However, if java.lang.OutOfMemoryError is caught by a Web application, that processing is followed.

If the OutOfMemoryError throwing conditions are satisfied
The java.lang.OutOfMemoryError error is thrown and only the request processing where OutOfMemory occurred is cancelled.

If the OutOfMemoryError throwing conditions are not satisfied
JavaVM is terminated forcibly by the forced termination functionality for OutOfMemory.

The OutOfMemoryError throwing condition is as follows. Note that when JavaVM does not conform to the OutOfMemoryError throwing conditions, JavaVM is terminated forcibly by the forced termination functionality for OutOfMemory.

OutOfMemoryError throwing conditions

When OutOfMemory occurs and if all the following conditions are applicable, JavaVM is said to satisfy the OutOfMemoryError throwing conditions and throws java.lang.OutOfMemoryError without terminating abnormally.

The OutOfMemory error was caused by a Java heap or Perm heap shortage.

The OutOfMemory error occurred in the request processing during the execution of the Web applications (Servlets or JSPs) on the Web container, processing during the execution of the Enterprise Bean invoked from an EJB client application, processing during the execution of the Message-driven Bean, or processing during the execution of the Enterprise Bean invoked from Timer Service.

The throw OutOfMemoryError exclusion condition is not applicable.

Throw OutOfMemoryError exclusion condition

The total value (including the current OutOfMemory) of the occurrence counts of the OutOfMemory error caused by the Java heap shortage and the Perm heap shortage occurring within the past one hour from the time when the current OutOfMemory error occurred is greater than the value specified in the -XX:HitachiOutOfMemoryHandlingMaxThrowCount option.

The following table describes the operations for the cause of OutOfMemory occurrence for the forced termination functionality for OutOfMemory and OutOfMemory handling functionality. The enabling of the OutOfMemory handling functionality impacts the operations to be performed when the cause of OutOfMemory is a Java heap or Perm heap shortage.

Table 16-8 Operations for the cause of OutOfMemory occurrence of the forced termination functionality for OutOfMemory and OutOfMemory handling functionality

Causes of OutOfMemory occurrence
Is an operation performed for the forced termination functionality for OutOfMemory
(Operations to be performed during OutOfMemory #1)
Is an operation performed for the OutOfMemory handling functionality
(Operations to be performed during OutOfMemory)

Java heap shortage
An operation is performed
(JavaVM is terminated forcibly).
An operation is performed
(an operation is performed according to the determined results#2).

Perm heap shortage
An operation is performed
(JavaVM is terminated forcibly).
An operation is performed
(an operation is performed according to the determined results#2).

C heap shortage
An operation is performed
(JavaVM is terminated forcibly).
An operation is not performed
(JavaVM is terminated forcibly#3).

Unkown
An operation is not performed
(java.lang.OutOfMemoryError is thrown).
An operation is not performed
(java.lang.OutOfMemoryError is thrown).

Thread Limit
An operation is not performed
(java.lang.OutOfMemoryError is thrown).
An operation is not performed
(java.lang.OutOfMemoryError is thrown).

#1

This operation is performed when the OutOfMemory handling functionality is disabled (-XX:-HitachiOutOfMemoryHandling).

#2

If the OutOfMemoryError throwing condition is satisfied, java.lang.OutOfMemoryError is thrown. If the OutOfMemoryError throwing condition is not satisfied, the processing shifts to the forced termination functionality for OutOfMemory and JavaVM is terminated forcibly.

#3

JavaVM is terminated forcibly by the forced termination functionality for OutOfMemory.

Also, if the OutOfMemory handling functionality is enabled, the information related to the frequency of OutOfMemory occurrence is output to the JavaVM log file when the OutOfMemory error occurs due to a Java heap and Perm heap shortage.

Default value

-XX:-HitachiOutOfMemoryHandling

Prerequisite options

-XX:+HitachiOutOfMemoryAbort

Output format

[id][Thread: thread_id]<date>[Handling: oom_count(max_oom_count)]

The following is a description of the output contents:

id

OMH (Identifier of the Java VM log file).

thread_id

Thread ID (tid output to the thread dump).

date

Date when OutOfMemory was handled.

oom_count

The total value (including the current OutOfMemory) of the occurrence count of the OutOfMemory error caused by a Java heap shortage and a Perm heap shortage occurring within the past one hour from the time when the current OutOfMemory error occurred.

However, including the current OutOfMemory, even if the total value of the occurrence count within an hour exceeds 3601, the maximum value of the output items is 3601.

max_oom_count

Value specified in the -XX:HitachiOutOfMemoryHandlingMaxThrowCount option.

Examples of output

[OMH][Thread: 0x00927f48]<Tue Aug 24 19:02:19 2010>[Handling: 1(60)]

Precautions

The OutOfMemory handling functionality does not resolve the root cause of the OutOfMemory error and does not prevent the termination of a J2EE server due to the OutOfMemory error. Also, this functionality does not guarantee that the J2EE server execution can be continued after the occurrence of the OutOfMemory error. This functionality is used to temporarily prevent the termination of a J2EE server when an OutOfMemory error occurs unexpectedly due to problems in user program processing.
The java.lang.OutOfMemoryError error occurs when a heap depletes, regardless of the OutOfMemory handling functionality settings. When the java.lang.OutOfMemoryError occurs, we recommend that you restart and recover the J2EE server as soon as possible, and then resolve the root cause of the OutOfMemory error.
Note that the resources might be leaked or locked by throwing the java.lang.OutOfMemoryError, and unexpected operations might occur in the J2EE server. Therefore, if the OutOfMemory error occurs when this functionality is enabled, perform operations so that the J2EE server is restarted at an appropriate time. Also, if you want to avoid unexpected operations in the J2EE server, disable this functionality. In this case, if the OutOfMemory error occurs unexpectedly, the J2EE server will be terminated.
If this functionality is enabled and if unexpected operations occur, restart the J2EE server. Also, disable this functionality in subsequent operations.

When the OutOfMemory handling functionality is enabled, even if the forced termination functionality is enabled (-XX:+HitachiOutOfMemoryAbort) during the OutOfMemory error, if the OutOfMemory error occurs during the processing of jsps and Servlets, java.lang.OutOfMemoryError is thrown as per the Java SE specifications instead of a forced termination.
Therefore, for example, if the resources are not released properly by using the finally clause, the resources might not be released.
To avoid such problems and to implement forced termination as before, disable the OutOfMemory handling functionality.

-XX:HitachiOutOfMemoryHandlingMaxThrowCount (Option for setting up the maximum occurrence count)

Format

-XX:HitachiOutOfMemoryHandlingMaxThrowCount=integer-value

Description

Specifies the per-hour upper limit for the total OutOfMemory occurrence count caused by a Java heap or Perm heap shortage when the OutOfMemory handling functionality is enabled.

The value specified in this option is used to determine the throw OutOfMemoryError exclusion condition.

If an OutOfMemory error occurs because of a Java heap or Perm heap shortage, the processing is executed as follows:

If the total value (including the current OutOfMemory) of the occurrence count of the OutOfMemory error caused by a Java heap shortage and a Perm heap shortage occurring within the past one hour from the time when the current OutOfMemory error occurred is greater than the upper limit specified in this option, the OutOfMemoryError is not thrown. The processing shifts to the forced termination functionality for OutOfMemory (-XX:+HitachiOutOfMemoryAbort) and JavaVM is terminated forcibly.

If you specify 0 as the value of this option and if the OutOfMemory error occurs, the processing necessarily shifts to the forced termination functionality for OutOfMemory and JavaVM is terminated forcibly.

If you specify 3600 as the value of this option, the throw OutOfMemoryError exclusion condition is not determined. In this case, when the OutOfMemory error occurs, the java.lang.OutOfMemoryError is necessarily thrown if a OutOfMemoryError throwing condition other than the throw OutOfMemoryError exclusion condition is satisfied.

Default value

-XX:HitachiOutOfMemoryHandlingMaxThrowCount=60

Prerequisite options

-XX:+HitachiOutOfMemoryHandling

Argument

integer-value

Specifies the per-hour upper limit of the total occurrence count of the OutOfMemory error caused by a Java heap or Perm heap shortage.

For 32-bit JavaVM:

0 to 3600 (3601 to 231-1 is handled as 3600).

For 64-bit JavaVM:

0 to 3600 (3601 to 2⁶³-1 is handled as 3600).

Precautions

If a value other than a natural number is specified, the operation will be the same as when an un-defined option is specified.

-XX:[+|-]HitachiJavaClassLibTrace (Option to output the stack trace of class library)

Format

-XX:+HitachiJavaClassLibTrace

This option outputs the stack trace of the class library.

-XX:-HitachiJavaClassLibTrace

This option does not output the stack trace of the class library.

Description

When a method that affects the entire system shown below is used, the stack traces of the API of these systems will be output to the JavaVM log file:

java.lang.System.gc

java.lang.System.exit

java.lang.System.runFinalizersOnExit

java.lang.Runtime.exit

java.lang.Runtime.halt

java.lang.Runtime.runFinalizersOnExit

Default value

-XX:-HitachiJavaClassLibTrace

Output format

[id] [Thread:thread_id]<date>
[id] [Thread:thread_id] stack_trace

The following is a description of the output contents:

id

CLT (Identifier of the Java VM log file).

thread_id

Thread ID (tid output to the thread dump).

date

Indicates the date and time when class library was used.

stack_trace

Stack trace.

Example of output 1

[CLT][Thread: 0x00062fd0]<Mon Sep 27 12:10:03 2004>
[CLT][Thread: 0x00062fd0] at at java.lang.Shutdown.halt0(Native Method)
[CLT][Thread: 0x00062fd0] at java.lang.Shutdown.halt(Shutdown.java:145)
[CLT][Thread: 0x00062fd0] - locked <0x100101a0> (a java.lang.Shutdown$Lock)
[CLT][Thread: 0x00062fd0] at java.lang.Shutdown.exit(Shutdown.java:222)
[CLT][Thread: 0x00062fd0] - locked <0x1413c0a0> (a java.lang.Class)
[CLT][Thread: 0x00062fd0] at java.lang.Terminator$1.handle(Terminator.java:35)
[CLT][Thread: 0x00062fd0] at sun.misc.Signal$1.run(Signal.java:195)
[CLT][Thread: 0x00062fd0] at java.lang.Thread.run(Thread.java:534)

Example of output 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)

-XX:HitachiJavaClassLibTraceLineSize (Option to specify the line size of stack trace for the class library)

Format

-XX:HitachiJavaClassLibTraceLineSize=integer-value

Description

Specify in bytes, the number of characters in one line of class library stack trace output when -XX:+HitachiJavaClassLibTrace option is specified.

Default value

-XX:HitachiJavaClassLibTraceLineSize=1024

Prerequisite options

-XX:+HitachiJavaClassLibTrace

Argument

integer-value

Specify the integer value from 1024 to 2147483647 (unit: byte). However, if a value out of range is specified, 1024 is set.

Examples of output

[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​ (omitted) xyz(Sample.java:9)
[CLT][Thread: 0x00286c58] at Sample.main(Sample.java:5)

When number of characters in one line exceeds the number of specified bytes, the first half portion of the character string from "at" onwards is deleted. In the case of the example of output, in the fourth line, the first half of "Sample" will be deleted and will become "mple".

-XX:[+|-]HitachiLocalsInThrowable (Option for collecting the local variable information when an exception occurs)

Format

-XX:+HitachiLocalsInThrowable

This option outputs the local variable information of the methods in the stack trace.

The -XX:+HitachiLocalsInThrowable option is ignored when java.lang.StackOverflowError occurs.

-XX:-HitachiLocalsInThrowable

This option does not output the local variable information of the methods in the stack trace.

Description

When the java.lang.Throwable.fillInStackTrace method is executed, the local variable information of the method in the stack trace is collected.

Default value

-XX:-HitachiLocalsInThrowable

Output format

 locals:
  name: <name>
  type: <type>
  value: <value>
...

The output contents are explained below:

In the first line, "locals:" header is output.

From second line onwards, the following information is output line by line for each local variable that can be collected:

Variable name

Type name (basic type name, class name, or array type name)

Character string that represents variable value

Note that the output contents of each local variable are demarcated with a blank line.

name

Local variable name.

For the argument passed to the method, [arg***](*** is the argument number) will be displayed in continuation to the variable name.

type

Type name of the local variable (the basic type name, class name, or the array type name)

value

Character string representing the value of local variable

Basic type:
Value converted as it is into a character string

Class or array type:
When variable type is null: (null)
Other than the above-mentioned: existing-address-of-the-object

Maximum length of the character string representing a value is 64. When the character string exceeds the maximum length, the characters up to 64th character are output and after that "..." character string is output. In the case of the class or array type, you can add detailed expressions by specifying the following add options:

-XX:+HitachiLocalsSimpleFormat

-XX:+HitachiTrueTypeInLocals

-XX:HitachiCallToString

Examples of output

The following is an example of output using Java program example 1:

When all the local variable information is output

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

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

When the local variable information does not exist

For a class file generated without adding the -g option or the -g:vars option

For the native method of a class file generated by adding the -g option or the -g:vars option

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

Precautions

To collect complete local variable information, while you are creating the class file in javac, you need to add the -g option or the -g:vars option and fill the local variable information in the class file. For the class file created without adding the -g option or the -g:vars option, the local variable information is output in the collectable range.

The local variable information does not exist for the native method even if the class file is generated by adding the -g option or the -g:vars option.

When the JIT compiler compiles a method, as a part of optimization, the local variables determined as unnecessary, are removed.
(Example) Consider a declaration and local variable that is not used after initialization as "int not_used = 12345":
In this case, the following value is output in the local variable information when an exception occurs:

Type name
Output information

boolean type
false

char type
'\0'

byte type
Short type
int type
long type
float type
double type
0

class type
array type
(null)

When the local variable information of the method containing complicated control structure and multiple lines is to be output, analysis takes time, and hence, when an exception occurs the process for generating the exception object may take longer time.

To output the local variable information to the stack trace of the current thread obtained by using the getStackTrace method of the java.lang.Thread class, you must set up the option for collecting the local variable information for an exception (-XX:+HitachiLocalsInThrowable), which outputs the local variable information to the stack trace used for an exception.

-XX:[+|-]HitachiLocalsInStackTrace (Option to output the local variable when the thread dump is output)

Format

-XX:+HitachiLocalsInStackTrace

This option outputs the local variable information to the stack trace when thread dump is output.

-XX:-HitachiLocalsInStackTrace

This option does not output the local variable information to the stack trace when thread dump is output.

Description

Add the local variable information of each method and output to the stack trace when the thread dump was output. For details on output content of the local variable information, see -XX:[+|-] HitachiLocalsInThrowable (Option for collecting the local variable information when an exception occurs).

Default value

-XX:-HitachiLocalsInStackTrace

Examples of output

The following is an example of output using Java program example 2:

When the -XX:+HitachiLocalsSimpleFormat option and the -XX:+HitachiTrueTypeInLocals option are specified:

"main" prio=1 tid=0xb6e88d20 nid=0xb7492080​ runnable [bfffb000..bfffb474]
   at Example2.method(Example2.java:15)
   - locked <0xab040550> (a Example2)
    locals:
     (Example2) this = <0xab040550> (Example2)
     (int) l1 = 1
     (float) l2 = 2.000000
     (java.lang.String) l3 = <0xaf112cc0> (java.lang.String)
     (java.lang.Character) l4 = <0xab040698> (java.lang.Character)
     (java.lang.Object) l5 = <0xab0407c8> (java.lang.Thread)
     (java.lang.Object[]) l6 = <0xab0408b8> (java.lang.Thread[])
   at Example2.main(Example2.java:4)
    locals:
     (java.lang.String[]) args [arg1] = <0xab040540> (java.lang.String[])
     (Example2) e2 = <0xab040550> (Example2)

Precautions

To collect complete local variable information, while you are creating the class file in javac, you need to add the -g option or the -g:vars option and fill the local variable information in the class file. For the class file created without adding the -g option or the -g:vars option, the local variable information is output in the collectable range.

The threads collecting the stack trace information and the threads that are to be collected, generally do not match. As a result, to collect the information, you need to terminate the target threads and you cannot invoke the toString method. Consequently, the specification of -XX:HitachiCallToString option becomes invalid.

When the local variable information of the method containing complicated control structure and multiple lines is to be output, analysis takes time, and hence, it may take time to output the extended thread dump and to obtain the thread stack trace.

-XX:[+|-]HitachiLocalsSimpleFormat (Option for changing the output format of the local variable information)

Format

-XX:+HitachiLocalsSimpleFormat

This option outputs the local variable information in a simple format.

-XX:-HitachiLocalsSimpleFormat

This option outputs the local variable information in a normal format.

Description

Change the output format of the local variable information to the simple output format, in which one variable is output in one line.

Default value

-XX:-HitachiLocalsSimpleFormat

Prerequisite options

-XX:+HitachiLocalsInThrowable

-XX:+HitachiLocalsInStackTrace

Output format

 locals:
  (type) name = value
  (type) name = value
...

For the details on output contents for the type, name, and value, see -XX:[+|-]HitachiLocalsInThrowable (Option for collecting the local variable information when an exception occurs).

Examples of output

The following is an example of output using Java program example 1:

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.000000
  (boolean) l5 = true
  (double) l6 = 1.79769E+308
  (java.lang.Object[]) l7 = <0x922f42d8>
at Example1.main(Example1.java:5)
 locals:
...

-XX:[+|-]HitachiTrueTypeInLocals (Option to output the true type name of the local variable information)

Format

-XX:+HitachiTrueTypeInLocals

This option outputs the actual object type name in the local variable information.

-XX:-HitachiTrueTypeInLocals

This option does not output the actual object type name in the local variable information.

Description

When collecting the local variable information, the object type name that is actually substituted is output for the local variable of the class or the array type. The type name is displayed in the round bracket after the character string that represents the variable value.

Note that if the class or array type object stored in the local variable is a JavaVM internal object, "internal type" is output.

Default value

-XX:-HitachiTrueTypeInLocals

Prerequisite options

-XX:+HitachiLocalsInThrowable

-XX:+HitachiLocalsInStackTrace

Examples of output

The following is an example of output using Java program example 3:

When the -XX:+HitachiLocalsSimpleFormat option and -XX:HitachiCallToString=full are specified:

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

-XX:HitachiCallToString (Option to output the local variable information)

Format

-XX:HitachiCallToString=applicable-range

Description

The character string of a String object obtained for the local variable object from the class corresponding to the applicable-range is output as a character string that represents the variable value.

Note that if no objects are stored in the local variable, or if the object is a JavaVM internal object, the local variable information is not output.

Default value

-XX:HitachiCallToString=minimal

Prerequisite options

-XX:+HitachiLocalsInThrowable

Argument

applicable-range

Specify minimal or full.

minimal

The following classes in the java.lang package are applicable:

String

StringBuffer

Boolean

Byte

Character

Short

Integer

Long

Float

Double

Note that, even when null character ("") is specified, the applicable range will be same as "minimal".

full

All the classes and array types are applicable.

Examples of output

The following is an example of output (simple output format) using the Java program example 3:

For -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:
...

For -XX:HitachiCallToString=full

at Example3.method(Example3.java:18)
 locals:
  (Example3) this = <0xaa07db58> "I am an Example3 instance."
  (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> "Thread[Thread-0,5,main]"
  (java.lang.Object[]) l7 = <0xaa07e298> "[Ljava.lang.Thread;@26e431"
at Example3.main(Example3.java:4)
 locals:
...

Precautions

To collect complete local variable information, while you are creating the class file in javac, you need to add the -g option or the -g:vars option and fill the local variable information in the class file. For the class file created without adding the -g option or the -g:vars option, the local variable information is output in the collectable range.

When you specify this option and execute a Java program using AWT or Swing, specify minimal (default) in applicable-range. If you specify full in applicable-range, the program might not operate correctly.

-XX:[+|-]HitachiFullCore (Release system resource option)

This option is used for UNIX.

Format

-XX:+HitachiFullCore

This option forcefully increases the system resource RLIMIT_CORE to the maximum value and creates a core file by ignoring the user limit when failure occurs.

-XX:-HitachiFullCore

This option does not change the system resource RLIMIT_CORE.

Description

Specify whether to change the settings of the system resource RLIMIT_CORE.

Default value

-XX:-HitachiFullCore

-XX:[+|-]HitachiReserveSwapSpace (Reserve swap area option)

This option is used for HP-UX.

Format

-XX:+HitachiReserveSwapSpace

This option reserves all the maximum swap areas that are required to execute JavaVM.

-XX:-HitachiReserveSwapSpace

This option all the maximum swap areas that are required to execute JavaVM are not reserved.

Description

Specify whether to reserve the maximum swap area (corresponding to OS) that is required to execute JavaVM, when invoking JavaVM.

You can calculate the size of the required maximum swap area by the following format:

(-Xmx specified-value)#1+(-XX:MaxPermSize specified-value)#1+(Area storing the code compiled by JIT)#2

#1

The default values of -Xmx and MaxPermSize are as follows:

- -Xmx: 64MB

- MaxPermSize: 64MB

#2

In HP-UX (IPF): 128 MB

Default value

-XX:-HitachiReserveSwapSpace

Precautions

The swap area reserved by JavaVM cannot be used (reserved) from other processes. Similarly, even if JavaVM is not using the area, the area cannot be used. Therefore, JavaVM does not stop due to the failure in securing the swap area during the execution of JavaVM.

When the swap area cannot be reserved, the following message is output to the standard output and the process is terminated.

Error occurred during initialization of VM
Could not reserve enough space for object heap

Depending upon the value specified in this option, the size of the core, generated when JavaVM terminates abnormally, does not change.

If this option is not specified in HP-UX, the swap area used by Java on the disk is not allocated when JavaVM starts. In this case, the swap area is allocated during execution as and when required, so the execution might be interrupted if the swap area is insufficient. Therefore, Hitachi recommends that the system manager allocate a swap area greater than the value specified in the -Xmx option on the disk in advance.
Also, if this option is specified, all the swap area used by Java on the disk is allocated when JavaVM starts. In this case, there is no shortfall of the swap area during the execution of the Java programs. However, if you specify an unnecessarily large value in the -Xmx option, note that the swap area cannot be allocated and the following events occur:

JavaVM fails to start

Other processes cannot allocate the swap area

You can use the following formula to calculate the size of the swap area allocated when JavaVM starts:

Swap-area-size=Value-of-Xmx-option + Value-of--XX:MaxPermSize-option + 128MB

-XX:[+|-]HitachiUseExplicitMemory (Explicit Memory Management functionality option)

Format

-XX:+HitachiUseExplicitMemory

This option enables the Explicit Memory Management functionality.

-XX:-HitachiUseExplicitMemory

This option disables the Explicit Memory Management functionality.

Description

Specify whether to enable or disable the Explicit Memory Management function. Note that to enable the Explicit Memory Management function, Hitachi recommends that you specify the same value for -Xms and -Xmx.

Default value

-XX:-HitachiUseExplicitMemory

Related option

-Xms

-Xmx

Precautions

If the -XX:+UseParNewGC option is specified, you cannot specify this option. If specified concurrently with the -XX:+UseParNewGC option, a message is output to standard output and JavaVM terminates with the return code 1.

-XX:HitachiExplicitHeapMaxSize (Option for specifying the maximum size of the Explicit memory block)

Format

-XX: HitachiExplicitHeapMaxSize=applicable-range

Description

Specify the maximum size of the entire Explicit heap.

Default value

-XX:HitachiExplicitHeapMaxSize=64m

Prerequisite options

-XX:+HitachiUseExplicitMemory

Argument

applicable-range

[32bit version]

1 to 2³¹-1 (2147483647)

[64bit version]

1 to 2⁶³-1 (9223372036854775807)

Precautions

Specify the scope in bytes.

If the set value is not included in the range of valid values, the following message is output in standard output and the JavaVM is terminated with return code 1:

Invalid maximum explicit heap size: -XX:HitachiExplicitHeapMaxSize=[specified-value]Could not create the Java virtual machine.

-XX:HitachiExplicitMemoryLogLevel (Option for specifying the log output level of the Explicit Memory Management functionality)

Format

-XX:HitachiExplicitMemoryLogLevel:applicable-range

Description

Specify the event log level of the Explicit Memory Management functionality.

Default value

-XX:HitachiExplicitMemoryLogLevel:none

Prerequisite options

-XX:+HitachiUseExplicitMemory

Argument

applicable-range

none

The event log of the Explicit Memory Management functionality is not output.

normal

Specified during normal operations. Outputs the status of Explicit heap at regular intervals (for each garbage collection). Also, outputs the status when there are events where status of Explicit heap has large variations.

verbose

In addition to the contents for normal, the log is output for events when the Explicit heap status changes. The amount of log is more than that for normal.

debug

In addition to the contents for verbose, detailed information for the occurrence of some events is output. Since the amount of log is large, the performance deteriorates remarkably.

Precautions

If you specify the value other than none, normal, verbose, or debug, the following message is output in the standard output and the JavaVM is terminated with return code 1:

Invalid explicit heap log level: -XX:HitachiExplicitMemoryLogLevel:applicable-range Could not create the Java virtual machine.(log levels: none normal verbose debug)

-XX:HitachiExplicitMemoryJavaLog (Option for specifying the log file output location of the Explicit Memory Management functionality)

Format

-XX:HitachiExplicitMemoryJavaLog:character-string

Description

Specify the prefix and the output destination directory of the log file of the Explicit Memory Management function.

Default value

-XX:HitachiExplicitMemoryJavaLog:ehjavalog

Related option

-XX:HitachiJavaLog

Argument

character-string

Specify the prefix and path. The following 3 types can be specified:

To specify the prefix

The log file name is created as character-string??.log (?? is a serial number from 01 to 99). For example, if you specify "Samp" in character-string, the log file name is Samp01.log. If you do not specify this option, "ehjavalog" is set in character-string. The log file is output to the current directory.

To specify the path

If the directory is specified in character-string, the file is created in the specified directory. The log file name is created as character-string ehjavalog??.log (?? is a serial number from 01 to 99).

To specify the path and prefix concurrently

When the directory and prefix are specified in character-string, the file is created in the specified directory. The log file name is created as character-string??.log (?? is a serial number from 01 to 99). For example, if you specify d:\temp\Samp in character-string, Samp01.log is created in the d:\temp directory.

-XX:HitachiExplicitMemoryJavaLogFileSize (Option for specifying the maximum log file size of the Explicit Memory Management functionality)

Format

-XX:HitachiExplicitMemoryJavaLogFileSize=integer-value

Description

Set up the maximum file size of one file in bytes. When the -XX:HitachiJavaLogFileSize option is not specified, '256 kilobytes' is specified by default.

Default value

-XX:HitachiExplicitMemoryJavaLogFileSize=256k

Related option

-XX:HitachiJavaLogFileSize

Argument

integer-value

Specify the integer value in the range of 1024 to 2147483647 (unit: bytes).

However, if a value out of range is specified, 1024 is set.

Precautions

If a value other than a natural number is specified, the operation will be the same as when an un-defined option is specified.

-XX:HitachiExplicitMemoryJavaLogNumberOfFile (Option for specifying the maximum number of log files of the Explicit Memory Management functionality)

Format

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=integer-value

Description

Specify the maximum number of files to be created. If the maximum number of files is exceeded, the log is output again to the file that was created first (wrap around).

Default value

-XX:HitachiExplicitMemoryJavaLogNumberOfFile=4

Related option

-XX:HitachiJavaLogNumberOfFile

Argument

integer-value

Specify a value in the range of 1 to 99.

However, if 100 or more is specified, the value becomes 99 and if 0 is specified, the value becomes 1.

Precautions

If a value other than a natural number is specified, the operation will be the same as when an un-defined option is specified.

-XX:[+|-]HitachiExplicitMemoryMoveToTenuredFirst(Explicit release function option of Explicit Memory Management function)

Format

-XX:+HitachiExplicitMemoryMoveToTenuredFirst

The objects in the release process of Explicit memory block are moved to the Tenured area.

-XX:-HitachiExplicitMemoryMoveToTenuredFirst

The objects in the release process of Explicit memory block are moved to the New area.

Description

Specify the transition destination of the objects of the release process of Explicit memory block.

Default value

-XX:+HitachiExplicitMemoryMoveToTenuredFirst

Prerequisite options

-XX:HitachiUseExplicitMemory

Precautions

If this option is enabled, the reference object moves to the Tenured area when the release process is executed.

If the reference source object is a temporarily short-lived object, this option is disabled and the referenced object in the Explicit memory block is moved to the New area to enable concurrent collection with the reference source object during the next copy garbage collection. This action prevents an increase in the used size of the Tenured area when this option is disabled.

You must note the following points:

Increasing CopyGC frequency
If the Explicit memory block is released, the referenced object moves to the New area and the moved object uses the New area. As a result, the interval until the next garbage collection might reduce causing throughput decrease and speed up in the ageing process of the object.

Among the objects moved to the Tenured area
If there is an object (For example, data definitions of common applications) referenced from objects of Explicit memory block repeatedly in New area and Explicit memory management area, then this is a long-lived object. If this option is enabled, the object is moved to the Explicit memory block, and when the release process of the Explicit memory block is executed, it moves to the Tenured area and continues to exist there for its rest of the life (such as application termination).
However, if this option is enabled, the object moves to the New area when executing the release process of the Explicit memory block, and here, if the copy garbage collection is executed up to the threshold value, the object is moved to some other Explicit memory block. On repeating this process, the object is circulated between the New area and the Explicit memory management area, resulting in an increase in the overheads of the release process of the copy garbage collection and the Explicit memory block.

-XX:[+|-]HitachiExplicitMemoryAutoReclaim (Automatic release function option of explicit memory management)

Format

-XX:+HitachiExplicitMemoryAutoReclaim

Enable the automatic release function of the Explicit Memory Management function.

-XX:-HitachiExplicitMemoryAutoReclaim

Disable the automatic release function of the Explicit Memory Management function.

Description

Specify whether to use the automatic release function of the Explicit Memory Management function.

Default value

-XX:+HitachiExplicitMemoryAutoReclaim

Prerequisite options

-XX:-HitachiExplicitMemoryCompatibleToV8

Related option

-XX:+HitachiAutoExplicitMemory

-XX:[+|-]HitachiExplicitMemoryCompatibleToV8 (Version compatibility setting option of Explicit Memory Management function)

Format

-XX:+HitachiExplicitMemoryCompatibleToV8

Secure the Explicit memory block by the same method as 08-00.

-XX:-HitachiExplicitMemoryCompatibleToV8

Secure the Explicit memory block by a method other than the 08-00.

Description

Specify whether to use the same method as in 08-00 for securing the Explicit memory block. This option is enabled if the application operating in 08-00 operates as it is in 08-50 and the new functions of 08-50 are not used.

If you use this option, the automatic release function of the explicit memory management is disabled.

Default value

-XX:-HitachiExplicitMemoryCompatibleToV8

Prerequisite options

-XX:+HitachiUseExplicitMemory

Related option

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:+HitachiAutoExplicitMemory

-XX:[+|-]HitachiAutoExplicitMemory (Automatic allocation function option of Explicit Memory Management function)

Format

-XX:+HitachiAutoExplicitMemory

Enable the automatic allocation function of the explicit memory management.

-XX:-HitachiAutoExplicitMemory

Disable the automatic allocation function of the explicit memory management.

Description

Specify whether to enable or disable the automatic allocation function of the Explicit memory block. When the function is enabled, irrespective of the 32-bit version or the 64-bit version, the required Explicit memory block is secured in advance when starting Java VM. Note that Java VM cannot be started in an environment in which continuous areas cannot be secured in the memory space when starting Java VM.

Note that if this option is enabled, the minimum size of the Explicit memory block is 16 kilobytes. If disabled, the minimum size of the Explicit memory block is 64 kilobytes.

Default value

-XX:-HitachiAutoExplicitMemory

Prerequisite options

-XX:+HitachiUseExplicitMemory

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:-HitachiExplicitMemoryCompatibleToV8

Related option

-XX:HitachiAutoExplicitMemoryFile

-XX:HitachiAutoExplicitMemoryFile (Option for specifying the file path of the automatic allocation function of the Explicit Memory Management function)

Format

-XX:HitachiAutoExplicitMemoryFile: character-string

Description

Specify the path of the automatic allocation setup file to be used by the automatic allocation function of the Explicit memory block.

Default value

-XX:HitachiAutoExplicitMemoryFile: blank-character

Prerequisite options

-XX:+HitachiAutoExplicitMemory

Argument

character-string

Specify the relative path and absolute path from the current directory of the JavaVM process. You can specify a path that includes the directory name.

Note that you can specify only one automatic allocation setup file.

If a character string with more than 1 character is specified

The default settings of the automatic allocation setting for the explicit memory management and the file settings specified by this option are enabled.

-XX:ExplicitMemoryFullGCPolicy (Option for controlling the transfer of objects to the Explicit memory block of the Explicit Memory Management functionality)

Format

-XX:ExplicitMemoryFullGCPolicy=numeric-value

Description

Specify whether to control the transfer of the reference relationship-based objects from the Java heap to the Explicit memory block when a full garbage collection occurs. If you use this option, you can transfer the objects that were being moved to the Explicit heap during a full garbage collection to the Tenured area.

Default value

-XX:ExplicitMemoryFullGCPolicy=0

Prerequisite option

-XX:+HitachiUseExplicitMemory

Related options

-XX:+HitachiAutoExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

Argument

numeric-value

Specify 0 or 1. If the specified value is outside the range, 0 is set.

If you specify 0, the Java heap objects referenced from the objects in the Explicit memory block will be transferred to the Explicit memory block when a full garbage collection occurs.

If you specify 1, the Java heap objects referenced from the objects in the Explicit memory block will not be transferred to the Explicit memory block when a full garbage collection occurs. The objects in the New area will be transferred to the Tenured area.

-XX:[+|-]ExplicitMemoryUseExcludeClass (Option for the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality)

Format

-XX:+ExplicitMemoryUseExcludeClass

This option enables the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality.

-XX:-ExplicitMemoryUseExcludeClass

This option disables the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality.

Description

Enable or disable the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality. If you enable the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality, the Explicit Memory Management functionality is not applied to the classes coded in the following files. Therefore, the objects of the classes coded in the files will be transferred to the Tenured area instead of the Explicit heap.

In Windows

JDK-installation-directory\jre\lib\explicitmemory\sysexmemexcludeclass.cfg

JDK-installation-directory\usrconf\exmemexcludeclass.cfg

In UNIX

/opt/Cosminexus/jdk/jre/lib/explicitmemory/sysexmemexcludeclass.cfg

/opt/Cosminexus/jdk/usrconf/exmemexcludeclass.cfg

Default value

-XX:-ExplicitMemoryUseExcludeClass

Prerequisite option

-XX:+HitachiUseExplicitMemory

Related options

-XX:+HitachiAutoExplicitMemory

-XX:ExplicitMemoryFullGCPolicy

-XX:ExplicitMemoryExcludeClassListFile

-XX:ExplicitMemoryNotExcludeClassListFile

Notes

If you enable the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality, the functionality for controlling the transfer of objects to the Explicit memory block will also be enabled.

You cannot specify the JavaVM classes (such as java.lang or java.util) as the classes to be excluded from the Explicit Memory Management functionality.

-XX:ExplicitMemoryExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality exclusion setup file)

Format

-XX:ExplicitMemoryExcludeClassListFile:character-string

Description

Specify the file path of the Explicit Memory Management functionality exclusion setup file used with the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality. The Explicit Memory Management functionality is not applied to the classes coded in this file.

When JavaVM starts, the file in the file path specified in this option is read as the Explicit Memory Management functionality exclusion setup file. Note that if you omit this option or specify null, the file in the default file path will be read as the Explicit Memory Management functionality exclusion setup file.

Default value

-XX:ExplicitMemoryExcludeClassListFile:Null

In Windows

JDK-installation-directory\usrconf\exmemexcludeclass.cfg

In UNIX

/opt/Cosminexus/jdk/usrconf/exmemexcludeclass.cfg

Prerequisite options

-XX:+HitachiUseExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

Related options

-XX:ExplicitMemoryFullGCPolicy

-XX:+HitachiAutoExplicitMemory

-XX:ExplicitMemoryNotExcludeClassListFile

Argument

character-string

Specify the relative path from the current directory of the JavaVM process, or the absolute path. You can include the directory name in the path.

Note that you can only specify one Explicit Memory Management functionality exclusion setup file. Also, use the ASCII code for the character encoding in the file.

Notes

If the specified file cannot be opened or read, a warning message will be output to the event log of the Explicit Memory Management functionality and the setup file in the default path will be read. If the file in the default path cannot be opened or read, the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality will not be enabled.

If the coding format of the specified file is incorrect, a warning message will be output to the event log of the Explicit Memory Management functionality and the syntax analysis continues from the next line.

If the same class names are coded in both the Explicit Memory Management functionality exclusion setup file and the Explicit Memory Management functionality non-exclusion setup file, the specification in the Explicit Memory Management functionality non-exclusion setup file is given priority. In this case, the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality will be disabled for those classes.

-XX:ExplicitMemoryNotExcludeClassListFile (Option for specifying the path of the Explicit Memory Management functionality non-exclusion setup file)

Format

-XX:ExplicitMemoryNotExcludeClassListFile:character-string

Description

Specify the file path of the Explicit Memory Management functionality non-exclusion setup file used with the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality. The functionality for specifying the classes to be excluded from the Explicit Memory Management functionality is not applied to the classes coded in this file even if the classes are also coded in the Explicit Memory Management functionality exclusion setup file.

When JavaVM starts, the file in the file path specified in this option is read as the Explicit Memory Management functionality non-exclusion setup file. Note that if you omit this option or specify null, the file in the default file path will be read as the Explicit Memory Management functionality non-exclusion setup file.

Default value

-XX:ExplicitMemoryNotExcludeClassListFile:Null

In Windows

JDK-installation-directory\usrconf\exmemnotexcludeclass.cfg

In UNIX

/opt/Cosminexus/jdk/usrconf/exmemnotexcludeclass.cfg

Prerequisite options

-XX:+HitachiUseExplicitMemory

-XX:+ExplicitMemoryUseExcludeClass

Related options

-XX:ExplicitMemoryFullGCPolicy

-XX:HitachiAutoExplicitMemory

-XX:ExplicitMemoryExcludeClassListFile

Argument

character-string

Specify the relative path from the current directory of the JavaVM process, or the absolute path. You can include the directory name in the path.

Note that you can only specify one Explicit Memory Management functionality exclusion setup file. Also, use the ASCII code for the character encoding in the file.

Notes

If the specified file cannot be opened or read, a warning message will be output to the event log of the Explicit Memory Management functionality, and the setup file in the default path will be read. If the file in the default path cannot be opened or read, the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality will not be disabled.

If the coding format of the specified file is incorrect, a warning message will be output to the event log of the Explicit Memory Management functionality and the syntax analysis continues from the next line.

If the same class names are coded in both the Explicit Memory Management functionality exclusion setup file and the Explicit Memory Management functionality non-exclusion setup file, the specification in the Explicit Memory Management functionality non-exclusion setup file is given priority. In this case, the functionality for specifying the classes to be excluded from the Explicit Memory Management functionality will be disabled for those classes.

-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim (Memory usage reduction option for Explicit heap used in an HTTP session)

Format

-XX:+HitachiExplicitMemoryAutoRefReclaim

Enables the memory usage reduction function of the Explicit heap used in an HTTP session.

-XX:-HitachiExplicitMemoryAutoRefReclaim

Disables the memory usage reduction function of the Explicit heap used in an HTTP session.

Description

Specifies the enabling or disabling of the memory usage reduction function of the Explicit heap used in an HTTP session.

If the function is disabled, the automatic release of the Explicit memory block created by the Application Server is not reserved automatically.

If the function is enabled, automatic release is automatically reserved for the Explicit memory block created by the Application Server to allocate the HTTP session objects in addition to the Explicit memory block created using the automatic allocation setup file. As a result, you can reduce the required Explicit heap size.

However, if the function is enabled, you must note the content output in the operation information. For details, see 8.11 Reducing the memory usage of Explicit heap used in an HTTP session in the manual uCosminexus Application Server Expansion Guide.

Default value

-XX:-HitachiExplicitMemoryAutoRefReclaim

Prerequisite options

-XX:+HitachiExplicitMemoryAutoReclaim

-XX:HitachiJITCompileMaxMemorySize (Option for specifying the maximum memory allocated for JIT compilation)

Format

-XX:HitachiJITCompileMaxMemorySize=integer-value

Description

Specify the uppler limit value for the C heap memory size secured for the JIT compilation. When the C heap memory secured for the JIT complitaion exceeds the upper limit, this option outputs logs to the JavaVM log file and also controls the JIT compliaton. Hereafter, the Java method, for which the JIT compilation is executed, will only be executed with an interpreter. Even when the JIT compilation is controlled, JavaVM is not terminated forcibly and continues processing.

If 0 is specified, the memory to be secured for the JIT compilation will not have an upper limit.

Note that the JIT compilation is executed using the JavaVM internal threads (JIT compiler threads). There are two JIT compiler threads and the value acquired by dividing the upper limit specified in this option by two will become the upper limit for one JIT compiler thread.

Also, even when the upper limit is set up in this option, if the actually usable C heap is less than the upper limit, a C heap shortage might occur before the upper limit is reached. In this case, JavaVM is terminated forcibly.

Default value

-XX:HitachiJITCompileMaxMemorySize=0

Prerequisite options

-server

Argument

integer-value

Specifies the upper limit of the memory to be secured for the JIT compilation. The unit is in seconds. You can also specify k for kilo, m for mega, and g for giga. The specifiable range is as follows. If a value outside the range is specified, 0 will be assumed.

For 32-bit JavaVM:

0 to 2³²-1 (4294967295)

For 64-bit JavaVM:

0 to 2⁶⁴-1 (18446744073709551615)

If 0 is specified, the memory to be secured for the JIT compilation will not have an upper limit. If C heap is insufficient during JIT compilation, JavaVM will terminate forcibly.

Output format

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

The following is a description of the output contents:

id

JMS (JavaVM log file identifier)

thread_id

Thread ID of the JIT compiler thread that controls the JIT compilation.

date

A date on which the JIT compilation is controlled.

Outputs in the unit of milli seconds if -XX:+HitachiOutputMilliTime option is specified.

thread_name

A thread name of the JIT compiler thread that controls the JIT compilation.

current_size

Currently secured memory size of the JIT compiler thread that controls the JIT compilation (unit: kilobytes).

new_size

Total of the currently secured memory size and the size to be additionally secured for the JIT compiler thread that controls the JIT compilation (unit: kilobytes).

limit_size_per_thread

Upper limit for one JIT compiler thread (unit: Kilobyte).

limit_size

Upper limit of all the JIT compiler threads (unit: kilobytes).

compile_target

Java method for which the JIT compilation processing is performed.

byte_code_size

Byte code size of the Java method for which the JIT compilation processing is performed (unit: bytes).

Examples of output

The following is an example of output when the upper limit is reached when -XX:HitachiJITCompileMaxMemorySize=536870912 is specified as the option and C heap of 262145 kilobytes is allocated to one JIT compiler thread:

[JMS][Thread: 0x03bf1150]<Wed Feb 24 14:33:58 2010>["CompilerThread0" exceeded max memory size.][262143K->262145K/262144K/524288K][test1.func][213]

Precautions

If the memory secured for the JIT compilation exceeds the upper limit specified in this option and the JIT compilation is controlled, the throughput of the application will decrease.

If a value other than a natural number is specified, the operation will be the same as when an un-defined option is specified.

-XX:[+|-]JITCompilerContinuation (Option for the JIT compiler continuation functionality)

Format

-XX:+JITCompilerContinuation

This option enables the JIT compiler continuation functionality.

-XX:-JITCompilerContinuation

This option disables the JIT compiler continuation functionality.

Description

Specify whether to enable the JIT compiler continuation functionality.

Hitachi recommends that you enable this functionality to be able to continue an application normally even if the JIT compilation fails due to a logical inconsistency in a method configuring the application.

If you enable the JIT compiler continuation functionality, even if the JIT compilation fails due to a logical inconsistency in a method configuring the application, JavaVM outputs the log for this functionality to the JavaVM log file and continues the processing. In this case, the subsequent compilation with the method where the JIT compilation failed is executed using the interpreter method. From the methods configuring an application, the methods other than those where the JIT compilation failed are executed with the JIT compilation, so the application continues normally. However, if the JIT compilation fails six times or more, JavaVM outputs an error report file and a memory dump or core dump, and then terminates the processing forcefully.

If you disable the JIT compiler continuation functionality, and if the JIT compilation fails due to a logical inconsistency in a method configuring the application, JavaVM outputs an error report file and a memory dump or core dump, and then terminates the processing forcefully.

Default value

-XX:+JITCompilerContinuation

Prerequisite option

-server

-XX:+HitachiVerboseGC

Output format

[id]

Note: The log of the JIT compiler continuation functionality is output after [id].

A description of the output contents is as follows:

id:

This option specifies the JCC (identifier of the JavaVM log file).

Example of output

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

-XX:HitachiThreadLimit (Option for specifying the maximum number of threads)

Format

-XX:HitachiThreadLimit=integer-value

Description

Specifies the upper limit for the number of threads. The OutOfMemoryError exception is thrown when the upper limit for the number of threads exceeds the specified value. However, if the upper limit exceeds before activating JavaVM, the exception will not be thrown. Also, threads that are created outside the management range of JavaVM by using application such as JNI will not be included in the number of threads. If 0 is specified, the upper limit is not set up.

Note that if this option is specified concurrently with the -XX:+HitachiOutOfMemoryAbort option, and if the OutOfMemoryError exception is thrown by the functionality of this option, JavaVM is not terminated forcibly.

Also, if this option is specified concurrently with the -XX:+HitachiOutOfMemoryStackTrace option, an exception message is output to the JavaVM log file.

Default value

-XX:HitachiThreadLimit=0

Argument

integer-value

Specify the upper limit for the number of threads in an integer between 0 and 2147483647 (unit: number of threads). However, if a value out of range is specified, 0 is set. When negative value is specified, an error will occur.

Output format

Could not create "name" thread. Threadlimit Exceeded. num threads exist.

You can acquire this message with java.lang.Throwable.getMessage(). Also, if the entire message is 128 single-byte characters or more, the end of the message is omitted.

name

Name of the thread that could not be created

num

Current number of threads

If -XX:+HitachiOutOfMemoryStackTrace option is specified, exception information and stack traces can be output to the JavaVM log file. The type of the exception cause is "Thread Limit". For the types of causes for the occurrence of exceptions, see -XX:[+|-]HitachiOutOfMemoryCause (Option to output the causes of exception).

Examples of output

Could not create "Thread-1" thread. Threadlimit Exceeded. 9 threads exist.

This is an example of the message retrieved using java.lang.Throwable.getMessage() when the main thread invokes java.lang.Thread.start and this functionality throws an exception.

Precautions

If you set up a small value as an upper limit, an exception will be thrown before the startup. Do not set up a value that is smaller than the number of threads used by the J2EE server.

For the number of threads used by a J2EE server, see 5. Estimating the Resources to be Used (J2EE Application Execution Platform) or 6. Estimating the Resources to be Used (Batch Application Execution Platform) in the manual uCosminexus Application Server System Design Guide.

16.3 Properties used in JavaVM

The following table lists the properties used in JavaVM.

Table 16-9 List of properties used in JavaVM

Classification
Option name
Overview
VR

Property used in JavaVM
jvm.userprf.Enable
Specifies whether to enable the user-extended performance analysis trace.
09-00

jvm.userprf.ExtendedSetting
Specifies whether to enable the following methods in the coding format of the user-extended trace based performance analysis setup file:

Method specifying the package name and class name

Method specifying only the package name

09-50

jvm.userprf.File
Specifies the path of the user-extended performance analysis trace setup file.
09-00

jvm.userprf.Limit
Specifies the maximum number of target methods of the user-extended performance analysis trace.
09-00

jvm.userprf.Trace
Specifies whether to output the log for successful rewriting of the class file specified in the user-extended performance analysis trace setup file.
09-00

jvm.userprf.LineNumber
Specifies whether to output the line number of the line executed at the end of the method to the trace information.
09-00

jvm.userprf.ThrowableName
Specifies whether to output the exception or error class name to the trace information.
09-00

jvm.userprf.ThrowableNameEditMethod
Specifies how to edit a name when the exception or error class name exceeds the 32-character limit.
09-00

jvm.userprf.LogLevel
Specifies the trace output level of the user-extended performance analysis trace.
09-00

Organization of this section

jvm.userprf.Enable

jvm.userprf.ExtendedSetting

jvm.userprf.File

jvm.userprf.Limit

jvm.userprf.Trace

jvm.userprf.LineNumber

jvm.userprf.ThrowableName

jvm.userprf.ThrowableNameEditMethod

jvm.userprf.LogLevel

jvm.userprf.Enable

Format

jvm.userprf.Enable={true|false}

Description

Specifies whether to enable the user-extended performance analysis trace.

Default value

jvm.userprf.Enable=false

Prerequisite property

None

Argument

true

Enables the user-extended performance analysis trace.

false

Disables the user-extended performance analysis trace.

If a value other than true or false is specified, the default value is used.

Precautions

If true is specified in this property, the user-extended performance analysis trace setup file is automatically read for the user-extended performance analysis trace. Set up the user-extended performance analysis trace setup file in advance. For specifying the name of the user-extended performance analysis trace setup file, see the jvm.userprf.File property.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.Enable=true

jvm.userprf.ExtendedSetting

Format

jvm.userprf.ExtendedSetting={true|false}

Description

Specify whether to enable the following methods in the coding format of the user-extended trace based performance analysis setup file:

Method specifying the package name and class name

Method specifying only the package name

Default value

jvm.userprf.ExtendedSetting=false

Prerequisite property

jvm.userprf.Enable=true

Argument

true

You can use the following methods for coding in the user-extended trace based performance analysis setup file:

Method specifying the package name and class name

Method specifying only the package name

false

You cannot code the following methods in the user-extended trace based performance analysis setup file:

Method specifying the package name and class name

Method specifying only the package name

If a value other than true or false is specified, the default value is used.

Notes

If you specify false in this property and use the methods that are enabled with true for coding in the user-extended trace based performance analysis setup file, a format error occurs for the user-extended trace based performance analysis setup file.

Example of specification

An example specification of the property is as follows:

add.jvm.arg= -Djvm.userprf.ExtendedSetting=true

jvm.userprf.File

Format

jvm.userprf.File=character-string

Description

Specifies the path of the user-extended performance analysis trace setup file.

The file in the path specified in this property is read as the user-extended performance analysis trace setup file for the user-extended performance trace. Note that if this property is not specified, the file in the default path is read as the user-extended performance analysis trace setup file.

Hint

The method coded in the user-extended performance analysis trace setup file becomes the trace target of the user-extended performance analysis trace.

Default value

In Windows

JDK-installation-directory\usrconf\userprf.cfg

In UNIX

/opt/Cosminexus/jdk/usrconf/userprf.cfg

Prerequisite property

jvm.userprf.Enable=true

Argument

character-string

Specifies the path of the user-extended performance analysis trace setup file.

Specify the path of the user-extended performance analysis trace setup file as follows:

You can specify only one file path.

The relative path and absolute path from the current directory are valid as path strings. An example of current directory is as follows:

(Example) Default current directory when the cjstartsv command is used for execution:

In Windows
Cosminexus-installation-directory\CC\server\public\ejb\server-name

In UNIX
/opt/Cosminexus/CC/server/public/ejb/server-name

Precautions

The character encoding used for reading the user-extended performance analysis trace setup file is the default encoding for the JDK operation platform. If the character encoding is not the default encoding, the encoding is processed as the default encoding.

To specify different user-extended performance analysis trace settings for each server, prepare a user-extended performance analysis trace setup file for each server and specify the file path for each server in this property.

If the file in the specified path cannot be read or if the read settings are not enabled, the log for reading of the user-extended performance analysis trace setup file is output to the JavaVM log file.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.File=/test/setting.txt

jvm.userprf.Limit

Format

jvm.userprf.Limit=integer-value

Description

Specifies the maximum number of target methods of the user-extended performance analysis trace.

Default value

2147483647

Prerequisite property

jvm.userprf.Enable=true

Argument

integer-value

Specify an integer between 0 and 2147483647. If a value out of range is specified, the default value is set.

Precautions

Among the methods specified in the user-extended performance analysis trace setup file, trace is collected for the number of methods specified in this property. When the specified method first exceeds the value specified in this property, a log message is output to the JavaVM log file.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.Limit=100

jvm.userprf.Trace

Format

jvm.userprf.Trace={true|false}

Description

Specifies whether to output the log for successful rewriting of the class file specified in the user-extended performance analysis trace setup file.

Default value

jvm.userprf.Trace=false

Prerequisite property

jvm.userprf.Enable=true

Argument

true

This argument outputs the log for successful rewriting of the target class of the user-extended performance analysis trace.

false

This argument does not output the log for successful rewriting of the target class of the user-extended performance analysis trace.

If a value other than true or false is specified, the default value is used.

Precautions

If an attempt to rewrite the target class of the user-extended performance analysis trace fails, a log message is output to the JavaVM log file, regardless of the specification of this property.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.Trace=true

jvm.userprf.LineNumber

Format

jvm.userprf.LineNumber={true|false}

Description

Specifies whether to output the line number of the line executed at the end of the method to the trace information, when a method terminates normally.

Default value

jvm.userprf.LineNumber=false

Prerequisite property

jvm.userprf.Enable=true

Argument

true

This argument outputs the line number of the line executed at the end of the method, to the operation information (OPR) in the trace information.

false

This argument does not output the line number of the line executed at the end of the method to the trace information.

If a value other than true or false is specified, the default value is used.

Precautions

When the debug information of the line number is not generated using the -g option of the Javac command, the line number is not output even when you specify true in this property.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.LineNumber=true

jvm.userprf.ThrowableName

Format

jvm.userprf.ThrowableName={true|false}

Description

Specifies whether to output the exception or error class name as the operation information (OPR) of the trace information, when a method terminates abnormally.

Default value

jvm.userprf.ThrowableName=false

Prerequisite property

jvm.userprf.Enable=true

Argument

true

This argument outputs the exception or error class name to the trace information.

false

This argument does not output the exception or error class name to the trace information.

If a value other than true or false is specified, the default value is used.

Precautions

If you specify true in this property, the class name is output with the editing method specified in the jvm.userprf.ThrowableNameEditMethod property.

Examples of specification

The following is an example of specifying the property:

add.jvm.arg= -Djvm.userprf.ThrowableName=true

jvm.userprf.ThrowableNameEditMethod

Format

jvm.userprf.ThrowableNameEditMethod={FRONT_CUT|BACK_CUT|CENTER_CUT}

Description

Specifies how to edit a class name when the exception or error class name exceeds 32 characters. If the exception or error class name is less than 32 characters, all the characters are output to the trace information regardless of the specification in this property.

Default value

jvm.userprf.ThrowableNameEditMethod=FRONT_CUT

Prerequisite property

jvm.userprf.Enable=true

jvm.userprf.ThrowableName=true

Argument

character-string

Specifies how to edit a class name when the exception or error class name exceeds 32 characters, using the following strings:

FRONT_CUT

The last 32 characters of the exception or error class name are output. Note that asterisk (*) indicating omission is added at the beginning of the characters.

BACK_CUT

The first 32 characters of the exception or error class name are output. Note that asterisk (*) indicating omission is added at the end of the characters.

CENTER_CUT

The first 16 characters and the last 16 characters of the exception or error class name are output. Note that asterisk (*) indicating omission is added between the first 16 and last 16 characters.

If strings other than those listed above are specified, the default value is used.

Examples of specification

The following is an example of specification when the first 32 characters of the exception class name or fully qualified class name are output to the operation information (OPR) in the trace information, when the processing terminates with an exception in which the package name is com.sample and the class name is Class0123456789012345678901234567890:

add.jvm.arg= -Djvm.userprf.ThrowableNameEditMethod=BACK_CUT

Depending on the value specified in the jvm.userprf.LogLevel property, the output in the operation information (OPR) of the trace information is as follows. For jvm.userprf.LogLevel properties, see jvm.userprf.LogLevel.

If class is specified:

Class012345678901234567890123456*

If package or method or signature is specified:

com.sample.Class0123456789012345*

jvm.userprf.LogLevel

Format

jvm.userprf.LogLevel={class|package|method|signature}

Description

Specifies the output level of the user-extended performance analysis trace.

Default value

jvm.userprf.LogLevel=class

Prerequisite property

jvm.userprf.Enable=true

Argument

character-string

Specifies the following strings as the output level of the trace target methods to be output to the option information (OPT) in the trace information for the user-extended performance analysis trace.

class

Class name

package

Fully qualified class name

method

Fully qualified class name + method name

signature

Fully qualified class name + method name + method argument type

If strings other than those listed above are specified, the default value is used.

Note that if true is specified in the jvm.userprf.ThrowableName property, the operation information (OPR) is output as follows for the abnormal exit of the method due to the value specified in this property:

If class is specified: Exception or error class name

If package or method or signature is specified: Fully qualified class name of the exception or error

Examples of specification

The following is an example of specification when the trace information containing package name com.sample, class name ClassA, and method name methodA is output to the option information (OPT) in the trace information using fully qualified class name + method name:

add.jvm.arg= -Djvm.userprf.LogLevel=method

The trace information is output as follows:

com.sample.ClassA.methodA

16.4 Default values of the Java HotSpot VM options that can be specified in Cosminexus

This section displays the default value of the Java HotSpot VM options. The default value differs for each OS.

Hint

The default values that are described in this section are valid for Java applications. For other applications, the default values in this table are not valid but the default value of the add.jvm.arg key in each option definition file is valid. For details about the default values for each option definition files, see 2.3 usrconf.cfg (Option definition file for J2EE servers) or 3.2 usrconf.cfg(Option definition file for batch servers).

The following table describes the default values of the Java HotSpot VM options for each OS:

Table 16-10 Default values of the Java HotSpot VM options

No.
Option name
Types of OS and JavaVM to be used

Windows
x86
Windows
x64
Linux (AMD64 & Intel EM64T)
HP-UX (IPF)
AIX

[client]#1
[server]#1
[server]
[server]
[server]
[server]

1
-Xmxsize#2
64M
64M
83M
83M
83M
83M

2
-Xmssize#2
5120k
5120k
7.8M
7.8M
7.8M
7.8M

3
-XX:MaxPermSize=size#2
64M
64M
83M
83M
83M
83M

4
-XX:PermSize=size#2
12M
16M
20M
20M
20M
20M

5
-Xmnsize
#4
#4
#4
#4
#4
#4

6
-Xsssize
256k
256k
1M
1M
4M
1M

7
-XX:NewRatio=value#2
12
8
2
2
2
2

8
-XX:SurvivorRatio=value#3
8
8
8
32
8
8

9
-XX:TargetSurvivorRatio=value
50
50
50
50
50
50

10
-XX:MaxTenuringThreshold=value
14
14
14
14
14
14

11
-XX:ReservedCodeCacheSize=size
32M
48M
48M
48M
128M
48M

Legend:

Indicates that [client]: Java HotSpot Client VM is used.

Indicates that [server]: Java HotSpot Server VM is used.

Note:

Unit of size is bytes.

#1

You can select the JavaVM to be used according to the value specified in jvm.type key of the option definition file (usrconf.cfg).

#2

For J2EE servers, the default value of the add.jvm.arg key in the option definition file for J2EE servers (usrconf.cfg) is enabled. The default value of the option that is not defined in the add.jvm.arg key is the value mentioned in this table.

#3

If the Application Server version is version 08-00 or later, the default JavaVM values are overwritten on the J2EE server executed in the J2EE server mode. The default value after overwriting is -XX:SurvivorRatio=8. This is common in all platforms.

#4

Decided according to the Java heap and -XX:NewRatio.

See 16.5 Java HotSpot VM options that can be specified in Cosminexus.

16.5 Java HotSpot VM options that can be specified in Cosminexus

This section describes the Java HotSpot VM options that can be specified in add.jvm.arg and the precautions to be taken when you specify the options.

The following table describes the Java HotSpot VM options that can be specified in add.jvm.arg. Note that VR is the version of the Application Server in which parameters are introduced or changed.

Table 16-11 Java HotSpot VM options that can be specified when add.jvm.arg is specified

Option name
Contents
Specifiable value
VR

-Dproperty
Specifies the JavaVM system properties.
The input is not limited.
05-00

-agentlib:libname[=options]
Loads the native agent library libname.
The input is not limited.
08-00

-verbose:information-type
Outputs the information specified in information-type. The following values can be specified in information-type:

class:

Outputs the class-related information whenever a class is loaded.

gc:

Reports whenever a garbage collection event occurs.

jni:

Reports the information related to usage of the native method and other Java Native Interface (JNI) activities.

The following strings can be specified:

class

gc

jni

05-00

-Xloggc:file
Alike -verbose:gc, the garbage collection event is reported whenever the event occurs; however, that data is recorded in the file. Apart from the information reported when -verbose:gc is specified, the time (unit: seconds) elapsed from the first garbage collection event is added at the beginning of each reported event.
The input is not limited.
05-00

-Xmssize
Sets up the initial size of Java heap.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-Xmxsize
Sets up the maximum size of the Java heap.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-Xmnsize
Sets up the initial value and maximum value of the New area.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-Xsssize
Sets up the maximum size of one stack area.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-Xprof
When this option is specified, a profile of the running program is generated and the profiling data is output in standard output. This option is provided as the utility for developing programs. This option is not intended for use in a real system.
--
05-00

-Xrunhprof[:suboption=value,...]
Enables the profiling of the CPU, heap, or monitor. Specify a colon ':' behind -Xrunhprof and code '<suboption>=<value>'. You can specify multiple '<suboption>=<value>' separated with comma ','.
To acquire the list of sub options and their default values, execute the command java-Xrunhprof:help.
Specify any string.
You cannot specify '=' and ',' in <suboption>.
Also, you cannot specify ',' in <value>.
05-00

-XrunlibraryName
Specifies the library containing agents such as JVMPI and JVMDI, and the option strings passed at start up.
The input is not limited.
05-00

-Xdebug
When this option is specified, JVMDI support is enabled and started. Hitachi does not recommend JVMDI. Also, this option is not used for debugging in J2SE 5.0. Therefore, this option is not required for debugging in J2SE 5.0.
--
05-00

-XX:NewRatio=value
Specifies the ratio of Tenured area to New area.
If value is 2, the ratio of the New area and the Tenured area is 1:2.
If size-of-New-area-being-used size-of-Tenured-free-area, the full garbage collection occurs. Note that the full garbage collection occurs frequently if 1 is specified for this option.
Specify a natural number value.
05-00

-XX:PermSize=size
Specifies the initial size of Permanent area.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-XX:MaxPermSize=size
Specifies the maximum size for the Permanent area.
Specify a natural number using the following units:

Kilo "k"

Mega "m"

Giga "g"

Tera "t"

Note that the value is not case sensitive.
05-00

-XX:SurvivorRatio=value
Specifies the ratio of New::Eden area to the From space and To space of New::Survivor area.
If 8 is set in value, the ratio of the New::Eden area, From space and To space is 8:1:1.
Specify a natural number value.
05-00

-XX:[+|-]PrintTenuringDistribution

-XX:+PrintTenuringDistribution

Outputs the age distribution for the objects in Survivor area when copy garbage collection is executed.

-XX:-PrintTenuringDistribution

Does not output the age distribution for the objects in Survivor area when copy garbage collection is executed.

The following characters can be specified:

Plus '+'

Minus '-'

05-00

-XX:TargetSurvivorRatio=value
Specifies the target value (0 to 100 (unit: %)) for the ratio occupied by the Java objects in New::Survivor area after garbage collection is executed.
Specify a natural number value.
05-00

-XX:MaxTenuringThreshold=value
Specifies the threshold value for the number of times a Java object is replaced in the From space and To space when copy garbage collection is executed. The Java objects to be replaced after the specified count is exceeded are moved to Tenured area.
The valid range of this option is from 0 to the default value. If a value outside the range is specified, the function for moving to the Tenured area is disabled if exceeds the threshold value.
Specify a natural number value.
05-00

-Xrunhndlwrap
Specifies whether to continue an execution of JavaVM, if you log off the Windows in an environment earlier than the JDK version 5.
If -XX:+EagerXrunInit is specified, specification of this option is invalid or -agentlib:hndlwrap2.
If -agentlib:hndlwrap2 is set, do not set this option.
This option cannot be used concurrently with another JVMTI version program.
If you log off Windows when a Java program using this option is being executed at the command prompt, an error popup stating 'Program is not responding' appears and you cannot log off.
--
05-01

-agentlib:hndlwrap2
Specifies whether to continue an execution of JavaVM, if you log off the Windows is in an environment with JDK version 6.
If -Xrunhndlwrap is set, do not set this option.
This option cannot be used concurrently with other JVMTI version programs.
If you log off Windows when a Java program using this option is being executed at the command prompt, an error popup stating 'Program is not responding' appears and you cannot log off.
--
08-50

-XX:[+|-]UseSerialGC#¹

-XX:+UseSerialGC

Serial copy garbage collection is executed.

-XX:-UseSerialGC

Serial copy garbage collection is not executed.

The following characters can be specified:

Plus '+'

Minus '-'

08-70

-XX:[+|-]UseParNewGC#¹

-XX:+UseParNewGC

Parallel copy garbage collection is executed.

-XX:-UseParNewGC

Parallel copy garbage collection is not executed.

However, when both the following conditions are satisfied, the specified -XX:+UseParNewGC option is disabled, and the processing is handled in the same manner as when the -XX:+UseSerialGC option is specified:

The -XX:ParallelGCThreads option is not explicitly specified.

The number of CPUs in the execution environment is 1.

This option cannot be specified concurrently with the -XX:+HitachiUseExplicitMemory option. If specified, a message is output to the standard output and JavaVM terminates with the return code 1.
The following characters can be specified:

Plus '+'

Minus '-'

08-70#²

-XX:ParallelGCThreads
Specifies the number of threads that will execute copy garbage collection in parallel. This option is enabled when -XX:+UseParNewGC is specified. Also, we recommend that you use the default value for this option. If you want to change the value, calculate the optimum value based on the value measured by actually operating JavaVM, and then change the value.
When JavaVM starts, the number of garbage collection threads specified in this option are created and the processing is executed.
The default values used when this option is omitted are as follows:

If the logical CPU count in the execution environment is 8 or less, the CPU count becomes the default value.

If the logical CPU count in the execution environment is 9 or more, the default value is "8+(CPU-count-8) (58)" (rounded off after the decimal point).

For example, for 4 CPUs, the default value is 4 with ParallelGCThreads=4. Also, for 72 CPUs, the default value is 48 with ParallelGCThreads=8 + (72-8) (5 8 )=48.
If you specify 0 in this option, a serial copy garbage collection is executed.
Note the following when you specify a value:

If you specify 1, parallel execution is performed in one thread, so the execution performance declines.

If you specify a value exceeding the number of threads that can be created in the execution environment, JavaVM cannot start because the creation of garbage collection threads fail when JavaVM starts.

If you specify a value outside the valid range, a message is output to the standard output and JavaVM terminates with the return code 1.

Specify a natural number value.
08-70

Legend:

-: Not applicable.

#1

If both the -XX:+UseSerialGC and the -XX:+UseParNewGC options are specified, the process fails to start.

#2

You can specify the -XX:+UseParNewGC option only in the JDK version 6.

Note

Debug or profiling option
The JavaVM options -Xprof and -Xdebug, and the JVMTI agents hprof and jdwp (specified using -agentlib:<libname>) are provided as the program development utilities. Do not specify these options with system operations.

Specifying the garbage collector
You can select the serial garbage collector (UseSerialGC) and the parallel garbage collector (UseParNewGC) as the Application Server garbage collectors. Do not specify both the garbage collectors concurrently. The Java processes cannot start if both the garbage collectors are specified concurrently.

Parallelism of the parallel garbage collector
With the parallel garbage collector, you can specify the garbage collector parallelism in the ParallelGCThreads option. Do not specify 0 or 1 in this option. If you specify 0, the garbage collector automatically changes to the serial garbage collector. If you specify 1, the parallel garbage collector operates, but parallel execution is performed with one thread, so performance improvement cannot be expected.

Consumption of Java heap by the parallel garbage collector
To execute the parallel processing for a copy garbage collection at a high speed, the parallel garbage collector creates a thread-specific heap area in the Java heap. Therefore, more Java heap is consumed as compared to a serial garbage collection. As a result, the transfer of an object to the Tenured area and the occurrence of a full garbage collection might be accelerated. Note that the amount of Java heap consumed depends on the processing of the Java application.

Hint

The references for the default values of the Java HotSpot VM options differ for each server. The following table describes the references for the default values of the Java HotSpot VM options for each server and application:

Table 16-12 References for the default values of the Java HotSpot VM options for each server and application

Server and application used | Reference
J2EE server | 2.3 usrconf.cfg (Option definition file for J2EE servers)
Batch server | 3.2 usrconf.cfg (Option definition file for batch servers)
Web Container Server (Compatibility function) | 3.11.2 usrconf.cfg (Option definition file for Web Container Server) in the manual Cosminexus Application Server Function Guide - Compatibility.
Java applications started with the cjclstartap command | 14.2 usrconf.cfg (Option definition file for Java applications)
Other Java applications | 16.4 Default values of the Java HotSpot VM options that can be specified in Cosminexus

To specify Java HotSpot VM options in the Easy Setup definition file, you specify Java HotSpot VM options in 'Contents specified in param-value' that can be specified when add.jvm.arg is specified in 'Value specified in param-name'.

16.6 List of environment variables used in JavaVM

The following table lists the environment variables used in JavaVM:

VR is the version of Application Server on which environment variables are introduced or changed.

Table 16-13 List of environment variables used in JavaVM

Classification
Environment variable
Description
VR

Environment variables used in JavaVM
JAVACOREDIR
Specify the output destination directory of the thread dump file.

In Windows

05-05

In Solaris

06-50

On other OSs

05-00

16.7 Details of environment variables used in JavaVM

This section describes details on the environment variables used in JavaVM.

Organization of this section

JAVACOREDIR

JAVACOREDIR

Format

In Windows (batch file)

set JAVACOREDIR=output-destination-directory-of-thread-dump-file

In UNIX (C shell)

setenv JAVACOREDIR output-destination-directory-of-thread-dump-file

Description

Specifies the output destination directory used to output the thread dump file.

Default value

By default, JAVACOREDIR is not setup.

Thread dump output destination

By default, the thread dump file is output to the current directory.

The current directory is as follows:

In Windows

working-directory\ejb\server-name

In UNIX

working-directory/ejb/server-name

Prerequisite options

-XX:+HitachiThreadDump

Examples of specification

In Windows (batch file)

The thread dump is output to C:.

set JAVACOREDIR=C:\home\user\threaddump

In UNIX (C shell)

The thread dump is output to /home/user/threaddump.

setenv JAVACOREDIR /home/user/threaddump

Precautions

If an attempt to output the thread dump file to the directory specified in JAVACOREDIR fails, the thread dump file is output to the current directory.

If the output to the current directory also fails, the thread dump is only output to the standard error output. In this case, the thread dump is not output to the standard output.

Appendixes

Organization of the appendixes

A. Extended MIB object definition file

B. DD (web.xml) for Web applications

C. Parameters that can be specified in the logical server configuration (for compatibility)

Appendix A. Extended MIB object definition file

The extended MIB object definition file is used to output information such as operation performance that the Management Server outputs, in the form of MIB objects. Use MIB objects when integrating with SNMP Manager products.

Organization of this section

A.1 Tables in the extended MIB object definition file

Appendix A.1 Tables in the extended MIB object definition file

This section describes the tables of the extended MIB object definition file.

The OIDs of each table are as follows:

.iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).hitachi(116).systemExMib(5).cosminexusMibs(33).manager(1)

Organization of this subsection

(1) j2eeContainerTable

(2) jvmTable

(3) transactionTable

(4) httpServerTable

(5) httpServerConnectorTable

(6) dataSourceTable

(7) j2eeApplicationTable

(8) ejbApplicationTable

(9) statelessSessionBeanTable

(10) statelessSessionBeanHomeTable

(11) statelessSessionBeanRemoteTable

(12) statefulSessionBeanTable

(13) statefulSessionBeanHomeTable

(14) statefulSessionBeanRemoteTable

(15) entityBeanTable

(16) entityBeanHomeTable

(17) entityBeanRemoteTable

(18) webApplicationTable

(19) servletTable

(20) requestUrlTable

(21) dataSourceFullJTATable

(22) resourceAdapterTable

(23) statelessSessionBeanLocalHomeTable

(24) statelessSessionBeanLocalComponentTable

(25) statefulSessionBeanLocalHomeTable

(26) statefulSessionBeanLocalComponentTable

(27) entityBeanLocalHomeTable

(28) entityBeanLocalComponentTable

(29) messageDrivenBeanTable

(30) queueTable

(31) statelessSessionBeanHomeMethodTable

(32) statelessSessionBeanRemoteMethodTable

(33) statelessSessionBeanLocalHomeMethodTable

(34) statelessSessionBeanLocalComponentMethodTable

(35) statefulSessionBeanHomeMethodTable

(36) statefulSessionBeanRemoteMethodTable

(37) statefulSessionBeanLocalHomeMethodTable

(38) statefulSessionBeanLocalComponentMethodTable

(39) webContainerTable

(40) inprocHttpSvrTable

(41) queueAppTable

(1) j2eeContainerTable

The following table describes j2eeContainerTable:

Table A-1 j2eeContainerTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

j2eeContainerTable
(1)
j2eeContainerEntry
(1)
j2eeContainerIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

j2eeContainerFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name"

j2eeContainerServerName
(3)
DisplayString
RO
--
Name of the J2EE server

j2eeContainerNamingServiceHost
(4)
DisplayString
RO
--
Host name of the Naming Service to which the J2EE server is to be connected.

j2eeContainerNamingServicePort
(5)
INTEGER
RO
--
Port number of the Naming Service to which the J2EE server is to be connected.

j2eeContainerStartedTime
(6)
INTEGER
RO
Seconds
Startup time of the J2EE server#

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

#

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

(2) jvmTable

The following table describes jvmTable:

Table A-2 jvmTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

jvmTable
(2)
jvmEntry
(1)
jvmIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

jvmFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name"

jvmName
(3)
DisplayString
RO
--
Implementation name of JavaVM

jvmVersion
(4)
DisplayString
RO
--
Implementation version of JavaVM

jvmCurrentFreeMemory
(5)
Gauge
RO
KB
Free memory requirement of JavaVM (current value)

jvmFreeMemoryHighWaterMark
(6)
Gauge
RO
KB
Free memory requirement of JavaVM (maximum value)

jvmFreeMemoryLowWaterMark
(7)
Gauge
RO
KB
Free memory requirement of JavaVM (minimum value)

jvmFreeMemoryAverag
(8)
Gauge
RO
KB
Free memory requirement of JavaVM (average value#1)

jvmFreeMemoryPeak
(9)
Gauge
RO
KB
Free memory requirement of JavaVM (peak value#2)

jvmCurrentTotalMemory
(10)
Gauge
RO
KB
Current value of the total memory requirement of JavaVM (total of the used memory requirement and free memory requirement)

jvmTotalMemoryHighWaterMark
(11)
Gauge
RO
KB
Maximum value of the total memory requirement of JavaVM (total of the used memory requirement and free memory requirement)

jvmTotalMemoryLowWaterMark
(12)
Gauge
RO
KB
Minimum value of the total memory requirement of JavaVM (total of the used memory requirement and free memory requirement)

jvmTotalMemoryAverage
(13)
Gauge
RO
KB
Average value#1 of the total memory requirement of JavaVM (total of the used memory requirement and free memory requirement)

jvmTotalMemoryPeak
(14)
Gauge
RO
KB
Peak value#2 of the total memory requirement of JavaVM (total of the used memory requirement and free memory requirement)

jvmMaxMemory
(15)
INTEGER
RO
KB
If maximum used memory requirement of JavaVM
is not specified, assume (2⁶³-1)/2¹⁰

jvmStatisticsStartedTime
(16)
INTEGER
RO
Seconds
Statistics start time#3

jvmSamplingTime
(17)
INTEGER
RW
Seconds
Statistics sampling time#4

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(3) transactionTable

The following table describes transactionTable:

Table A-3 transactionTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

transactionTable
(3)
transactionEntry
(1)
transactionIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The transaction must be started

transactionFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name"

transactionDefaultTransactionTimeout
(3)
INTEGER
RO
Seconds
Default value of transaction timeout

transactionActiveTransactionCount
(4)
Gauge
RO
--
Number of active transactions (current value)

transactionAveTime
(5)
Gauge
RO
Milliseconds
Transaction time (average value#1)

transactionStatisticsStartedTime
(6)
INTEGER
RO
Seconds
Statistics start time#2

transactionSamplingTime
(7)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(4) httpServerTable

The following table describes httpServerTable:

Table A-4 httpServerTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

httpServerTable
(4)
httpServerEntry
(1)
httpServerIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

httpServerFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name"

httpServerPortNumber
(3)
INTEGER
RO
--
Port number of the server for management

httpServerActiveThreadCountHighWaterMark
(4)
Gauge
RO
--
Number of active threads (maximum value)

httpServerActiveThreadCountLowWaterMark
(5)
Gauge
RO
--
Number of active threads (minimum value)

httpServerActiveThreadCountAverage
(6)
Gauge
RO
--
Number of active threads (average value#1)

httpServerActiveThreadCountPeak
(7)
Gauge
RO
--
Number of active threads (peak value#2)

httpServerStatisticsStartedTime
(8)
INTEGER
RO
Seconds
Statistics start time#3

httpServerSamplingTime
(9)
INTEGER
RW
Seconds
Statistics sampling time#4

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(5) httpServerConnectorTable

The following table describes httpServerConnectorTable:

Table A-5 httpServerConnectorTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

httpServer
ConnectorTable
(5)
httpServer
ConnectorEntry
(1)
httpServerConnectorIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Web server integration functionality is used

httpServerConnectorFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name"

httpServerConnectorPortNumber
(3)
INTEGER
RO
--
Port used for communication with the Web server

httpServerConnectorBackLogUpperBound
(4)
INTEGER
RO
--
Backlog of the socket used for communication with the Web server

httpServerConnectorConnectionCount
(5)
Gauge
RO
--
Number of connections between the Web server and Web container (current value)

httpServerConnectorConnectionCountHighWaterMark
(6)
Gauge
RO
--
Number of connections between the Web server and Web container (maximum value)

httpServerConnectorConnectionCountLowWaterMark
(7)
Gauge
RO
--
Number of connections between the Web server and Web container (minimum value)

httpServerConnectorActiveThreadCountUpperBound
(8)
Gauge
RO
--
Number of active threads (upper-limit value)

httpServerConnectorActiveThreadCountHighWaterMark
(9)
Gauge
RO
--
Number of active threads (maximum value)

httpServerConnectorActiveThreadCountLowWaterMark
(10)
Gauge
RO
--
Number of active threads (minimum value)

httpServerConnectorActiveThreadCountAverage
(11)
Gauge
RO
--
Number of active threads (average value#¹)

httpServerConnectorActiveThreadCountPeak
(12)
Gauge
RO
--
Number of active threads (peak value#2)

httpServerConnectorWaitingRequestCountHighWaterMark
(13)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (maximum value)

httpServerConnectorWaitingRequestCountLowWaterMark
(14)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (minimum value)

httpServerConnectorWaitingRequestCountAverage
(15)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (average value#1)

httpServerConnectorWaitingRequestCountPeak
(16)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (peak value#2)

httpServerConnectorStatisticsStartedTime
(17)
INTEGER
RO
Seconds
Statistics start time#3

httpServerConnectorSamplingTime
(18)
INTEGER
RW
Seconds
Statistics sampling time#4

httpServerConnectorActiveThreadCount
(19)
Gauge
RO
--
Number of active threads

httpServerConnectorWaitingRequestCount
(20)
Gauge
RO
--
Number of requests awaiting execution

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(6) dataSourceTable

The following table describes dataSourceTable:

Table A-6 dataSourceTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

dataSourceTable
(6)
dataSourceEntry
(1)
dataSourceIndex(1)
INTEGER
RO
--
Sequence number [1,...]
The data source must be imported

dataSourceFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:data-source-name"

dataSourceName
(3)
DisplayString
RO
--
Data source name

dataSourceAuthenticationType
(4)
INTEGER
RO
--
Authentication type
Authentication of each application
Authentication of each container

dataSourceLoginTimeout
(5)
INTEGER
RO
Seconds
Login timeout value

dataSourceUserID
(6)
DisplayString
RO
--
User ID

dataSourcePoolUpperBound
(7)
INTEGER
RO
--
Number of connection pools (upper-limit value)

dataSourcePoolLowerBound
(8)
INTEGER
RO
--
Number of connection pools (lower-limit value)

dataSourceCurrentPoolSize
(9)
Gauge
RO
--
Number of connection pools (current value)

dataSourceActiveConnectionCount
(10)
Gauge
RO
--
Number of active connections (current value)

dataSourceFreeConnectionCount
(11)
Gauge
RO
--
Number of free connections (current value)

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

(7) j2eeApplicationTable

The following table describes j2eeApplicationTable:

Table A-7 j2eeApplicationTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

j2eeApplicationTable
(7)
j2eeApplicationEntry
(1)
j2eeApplicationIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The J2EE application (EAR) must be started

j2eeApplicationFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name"#

j2eeApplicationName
(3)
DisplayString
RO
--
J2EE application name

j2eeApplicationDeployedTime
(4)
INTEGER
RO
Seconds
Time of deployment

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

#

When you start an application in the test mode,

the fully qualified name becomes"logical-server-name:J2EE-application-name_TEST".

(8) ejbApplicationTable

The following table describes ejbApplicationTable:

Table A-8 ejbApplicationTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

ejbApplicationTable
(8)
ejbApplicationEntry
(1)
ejbApplicationIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The EJB application (EJB-JAR) must be started

ejbApplicationFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name"

ejbApplicationName
(3)
DisplayString
RO
--
EJB application name (EJB-JAR name)

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

(9) statelessSessionBeanTable

The following table describes statelessSessionBeanTable:

Table A-9 statelessSessionBeanTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSessionBeanTable
(9)
statelessSessionBeanEntry
(1)
statelessSessionBeanIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A Stateless Session Bean is used

statelessSessionBeanFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statelessSessionBeanName
(3)
DisplayString
RO
--
Enterprise Bean name

statelessSessionBeanHomeInterfaceName
(4)
DisplayString
RO
--
RemoteHome interface class name#1

statelessSessionBeanRemoteInterfaceName
(5)
DisplayString
RO
--
RemoteComponent interface class name#1

statelessSessionBeanLocalHomeInterfaceName
(6)
DisplayString
RO
--
LocalHome interface class name (EJB2.0 compliant)#2

statelessSessionBeanLocalComponentInterfaceName
(7)
DisplayString
RO
--
LocalComponent interface class name (EJB2.0 compliant)#2

statelessSessionBeanEjbClassName
(8)
DisplayString
RO
--
EJB class name

statelessSessionBeanPoolUpperBound
(9)
INTEGER
RO
--
Number of instance pools (upper-limit value)

statelessSessionBeanPoolLowerBound
(10)
INTEGER
RO
--
Number of instance pools (lower-limit value)

statelessSessionBeanCurrentPoolSize
(11)
Gauge
RO
--
Number of instance pools (current value)

statelessSessionBeanWaitingSessionCount
(12)
Gauge
RO
--
Number of sessions waiting to be connected (current value)

statelessSessionBeanActiveSessionBeanCount
(13)
Gauge
RO
--
Number of active Stateless Session Beans (current value)

statelessSessionBeanFreeSessionBeanCount
(14)
Gauge
RO
--
Number of free Stateless Session Beans (current value)

statelessSessionBeanFreeSessionTransactionType
(15)
DisplayString
RO
--
Transaction type
"CMT" or "BMT"

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

#1

Displays "" (a null character) only in case of the Local interface.

#2

Displays "" (a null character) only in case of the Remote interface.

(10) statelessSessionBeanHomeTable

The following table describes statelessSessionBeanHomeTable:

Table A-10 statelessSessionBeanHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSession
BeanHomeTable
(10)
statelessSession
BeanHomeEntry
(1)
statelessSessionBeanHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Remote Home Interface is used

statelessSessionBeanHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statelessSessionBeanHomeName
(3)
DisplayString
RO
--
RemoteHome interface class name

statelessSessionBeanHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (maximum value)

statelessSessionBeanHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (minimum value)

statelessSessionBeanHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (average value#1)

statelessSessionBeanHomeStatisticsStartedTime
(7)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanHomeSamplingTime
(8)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(11) statelessSessionBeanRemoteTable

The following table describes statelessSessionBeanRemoteTable:

Table A-11 statelessSessionBeanRemoteTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSession
BeanRemoteTable
(11)
statelessSession
BeanRemoteEntry
(1)
statelessSessionBeanRemoteIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Remote Component Interface is used

statelessSessionBeanRemoteFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statelessSessionBeanRemoteName
(3)
DisplayString
RO
--
RemoteComponent interface class name

statelessSessionBeanRemoteResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (maximum value)

statelessSessionBeanRemoteResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (minimum value)

statelessSessionBeanRemoteResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (average value#1)

statelessSessionBeanRemoteResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (maximum value)

statelessSessionBeanRemoteResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (minimum value)

statelessSessionBeanRemoteResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (average value#1)

statelessSessionBeanRemoteStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanRemoteSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(12) statefulSessionBeanTable

The following table describes statefulSessionBeanTable:

Table A-12 statefulSessionBeanTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSession
BeanTable
(12)
statefulSession
BeanEntry
(1)
statefulSessionBeanIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A Stateful Session Bean is used

statefulSessionBeanFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statefulSessionBeanName
(3)
DisplayString
RO
--
Enterprise Bean name

statefulSessionBeanHomeInterfaceName
(4)
DisplayString
RO
--
RemoteHome interface class name#1

statefulSessionBeanRemoteInterfaceName
(5)
DisplayString
RO
--
RemoteComponent interface class name#1

statefulSessionBeanLocalHomeInterfaceName
(6)
DisplayString
RO
--
LocalHome interface class name#2

statefulSessionBeanLocalComponentInterfaceName
(7)
DisplayString
RO
--
LocalComponent interface class name#2

statefulSessionBeanEjbClassName
(8)
DisplayString
RO
--
EJB class name

statefulSessionBeanSessionUpperBound
(9)
INTEGER
RO
--
Number of concurrent connections (upper-limit value)

statefulSessionBeanActiveSessionUpperBound
(10)
INTEGER
RO
--
Number of concurrent executions (upper-limit value)

statefulSessionBeanPassivateTimeout
(11)
INTEGER
RO
Seconds
Timeout value of a passive session

statefulSessionBeanActiveTimeout
(12)
INTEGER
RO
Seconds
Timeout value of an active session

statefulSessionBeanCurrentSessionCount
(13)
Gauge
RO
--
Number of connected sessions (current value)

statefulSessionBeanWaitingSessionCount
(14)
Gauge
RO
--
Number of sessions waiting to be connected (current value)

statefulSessionBeanActiveSessionCount
(15)
Gauge
RO
--
Number of active sessions (current value)

statefulSessionBeanPassiveSessionCount
(16)
Gauge
RO
--
Number of passive sessions (current value)

statefulSessionBeanTransactionType
(17)
DisplayString
RO
--
Transaction type
"CMT" or "BMT"

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

#1

Displays "" (a null character) only in case of the Local interface.

#2

Displays "" (a null character) only in case of the Remote interface.

(13) statefulSessionBeanHomeTable

The following table describes statefulSessionBeanHomeTable:

Table A-13 statefulSessionBeanHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSession
BeanHomeTable
(13)
statefulSession
BeanHomeEntry
(1)
statefulSessionBeanHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
Stateful Session Bean Remote Home Interface is used

statefulSessionBeanHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statefulSessionBeanHomeName
(3)
DisplayString
RO
--
RemoteHome interface class name

statefulSessionBeanHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (maximum value)

statefulSessionBeanHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (minimum value)

statefulSessionBeanHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (average value#1)

statefulSessionBeanHomeResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (maximum value)

statefulSessionBeanHomeResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (minimum value)

statefulSessionBeanHomeResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (average value#1)

statefulSessionBeanHomeStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanHomeSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(14) statefulSessionBeanRemoteTable

The following table describes statefulSessionBeanRemoteTable:

Table A-14 statefulSessionBeanRemoteTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSession
BeanRemoteTable
(14)
statefulSession
BeanRemoteEntry
(1)
statefulSessionBeanRemoteIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Remote Component Interface is used

statefulSessionBeanRemoteFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statefulSessionBeanRemoteName
(3)
DisplayString
RO
--
RemoteComponent interface class name

statefulSessionBeanRemoteResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (maximum value)

statefulSessionBeanRemoteResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (minimum value)

statefulSessionBeanRemoteResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (average value#1)

statefulSessionBeanRemoteResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (maximum value)

statefulSessionBeanRemoteResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (minimum value)

statefulSessionBeanRemoteResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (average value#1)

statefulSessionBeanRemoteStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanRemoteSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(15) entityBeanTable

The following table describes entityBeanTable:

Table A-15 entityBeanTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

entityBeanTable
(15)
entityBeanEntry
(1)
entityBeanIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
An Entity Bean is used

entityBeanFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

entityBeanName
(3)
DisplayString
RO
--
Enterprise Bean name

entityBeanHomeInterfaceName
(4)
DisplayString
RO
--
RemoteHome interface class name#1

entityBeanRemoteInterfaceName
(5)
DisplayString
RO
--
RemoteComponent interface class name#1

entityBeanLocalHomeInterfaceName
(6)
DisplayString
RO
--
LocalHome interface class name#2

entityBeanLocalComponentInterfaceName
(7)
DisplayString
RO
--
LocalComponent interface class name#2

entityBeanEjbClassName
(8)
DisplayString
RO
--
EJB class name

entityBeanPersistenceType
(9)
DisplayString
RO
--
Persistence type
CMP or BMP

entityBeanCacheOption
(10)
DisplayString
RO
--
Cache model
A: Full Cache
B: Cache
C: No Cache

entityBeanSessionUpperBound
(11)
INTEGER
RO
--
Number of concurrent connections (upper-limit value)

entityBeanPoolUpperBound
(12)
INTEGER
RO
--
Number of instance pools (upper-limit value)

entityBeanPoolLowerBound
(13)
INTEGER
RO
--
Number of instance pools (lower-limit value)

entityBeanCurrentPoolSize
(14)
Gauge
RO
--
Number of instance pools (current value)

entityBeanSessionTimeout
(15)
INTEGER
RO
--
Connection timeout value

entityBeanCurrentSessionCount
(16)
Gauge
RO
--
Number of connected sessions (current value)

entityBeanWaitingSessionCount
(17)
Gauge
RO
--
Number of sessions waiting to be connected (current value)

entityBeanActiveEntityBeanCount
(18)
Gauge
RO
--
Number of active Entity Beans (current value)

entityBeanFreeEntityBeanCount
(19)
Gauge
RO
--
Number of free Entity Beans (current value)

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

#1

Displays "" (a null character) only in case of the Local interface.

#2

Displays "" (a null character) only in case of the Remote interface.

(16) entityBeanHomeTable

The following table describes entityBeanHomeTable:

Table A-16 entityBeanHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

entityBeanHomeTable
(16)
entityBeanHomeEntry
(1)
entityBeanHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Entity Bean Remote Home Interface is used

entityBeanHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

entityBeanHomeName
(3)
DisplayString
RO
--
RemoteHome interface class name

entityBeanHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (maximum value)

entityBeanHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (minimum value)

entityBeanHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteHome interface (average value#1)

entityBeanHomeResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (maximum value)

entityBeanHomeResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (minimum value)

entityBeanHomeResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteHome interface (average value#1)

entityBeanHomeStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

entityBeanHomeSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(17) entityBeanRemoteTable

The following table describes entityBeanRemoteTable:

Table A-17 entityBeanRemoteTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

entityBeanRemoteTable
(17)
entityBeanRemoteEntry
(1)
entityBeanRemoteIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Entity Bean Remote Component Interface is used

entityBeanRemoteFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

entityBeanRemoteName
(3)
DisplayString
RO
--
RemoteComponent interface class name

entityBeanRemoteResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (maximum value)

entityBeanRemoteResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (minimum value)

entityBeanRemoteResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the RemoteComponent interface (average value#1)

entityBeanRemoteResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (maximum value)

entityBeanRemoteResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (minimum value)

entityBeanRemoteResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the RemoteComponent interface (average value#1)

entityBeanRemoteStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

entityBeanRemoteSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(18) webApplicationTable

The following table describes webApplicationTable:

Table A-18 webApplicationTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

webApplicationTable
(18)
webApplicationEntry
(1)
webApplicationIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A Web application (WAR) is used

webApplicationFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:Context-root"

webApplicationContextRoot
(3)
DisplayString
RO
--
Context root

webApplicationActiveSessionCount
(4)
Gauge
RO
--
Number of active sessions (current value)

webApplicationTotalJSPServiceCount
(5)
Counter
RO
--
Number of JSP executions (total value)

webApplicationTotalJSPServiceFailedCount
(6)
Counter
RO
--
Number of failed JSP executions (total value)

webApplicationTotalJSPServiceMaxTime
(7)
Gauge
RO
Milliseconds
JSP execution time (maximum value)

webApplicationTotalJSPServiceMinTime
(8)
Gauge
RO
Milliseconds
JSP execution time (minimum value)

webApplicationTotalJSPServiceAveTime
(9)
Gauge
RO
Milliseconds
JSP execution time (average value#1)

webApplicationTotalJSPServicePeak
(10)
Gauge
RO
Milliseconds
JSP execution time (peak value#2)

webApplicationTotalJSPServiceOutputDataSizeMax
(11)
Gauge
RO
KB
JSP output data size (maximum value)

webApplicationTotalJSPServiceOutputDataSizeMin
(12)
Gauge
RO
KB
JSP output data size (minimum value)

webApplicationTotalJSPServiceOutputDataSizeAve
(13)
Gauge
RO
KB
JSP output data size (average value#1)

webApplicationTotalJSPServiceOutputDataSizePeak
(14)
Gauge
RO
KB
JSP output data size (peak value#2)

webApplicationTotalStaticFileServiceCount
(15)
Counter
RO
--
Number of times of accessing static contents (total value)

webApplicationTotalStaticFileServiceFailedCount
(16)
Counter
RO
--
Number of times of accessing failed static contents (total value)

webApplicationTotalStaticFileServiceMaxTime
(17)
Gauge
RO
Milliseconds
Processing time for static contents acquisition (maximum value)

webApplicationTotalStaticFileServiceMinTime
(18)
Gauge
RO
Milliseconds
Processing time for static contents acquisition (minimum value)

webApplicationTotalStaticFileServiceAveTime
(19)
Gauge
RO
Milliseconds
Processing time for static contents acquisition (average value#1)

webApplicationTotalStaticFileServicePeak
(20)
Gauge
RO
Milliseconds
Processing time for static contents acquisition (peak value#2)

webApplicationTotalStaticFileServiceOutputDataSizeMax
(21)
Gauge
RO
KB
Static contents output data size (maximum value)

webApplicationTotalStaticFileServiceOutputDataSizeMin
(22)
Gauge
RO
KB
Static contents output data size (minimum value)

webApplicationTotalStaticFileServiceOutputDataSizeAve
(23)
Gauge
RO
KB
Static contents output data size (average value#1)

webApplicationTotalStaticFileServiceOutputDataSizePeak
(24)
Gauge
RO
KB
Static contents output data size (peak value#2)

webApplicationStatisticsStartedTime
(25)
INTEGER
RO
Seconds
Statistics start time#3

webApplicationSamplingTime
(26)
INTEGER
RW
Seconds
Statistics sampling time#4

webApplicationExclusiveThreadCountUpperBound
(27)
INTEGER
RO
--
Number of exclusive threads

A Web application (WAR) is used

The control functionality for concurrently executing threads is used

webApplicationActiveThreadCountUpperBound
(28)
INTEGER
RO
--
Number of active threads (upper-limit value)

webApplicationCurrentThreadCountUpperBound
(29)
Gauge
RO
--
Number of active threads (current upper-limit value#5)

webApplicationActiveThreadCount
(30)
Gauge
RO
--
Number of active threads (current value)

webApplicationActiveThreadCountHighWaterMark
(31)
Gauge
RO
--
Number of active threads (maximum value)

webApplicationActiveThreadCountLowWaterMark
(32)
Gauge
RO
--
Number of active threads (minimum value)

webApplicationActiveThreadCountAverage
(33)
Gauge
RO
--
Number of active threads (average value#1)

webApplicationActiveThreadCountPeak
(34)
Gauge
RO
--
Number of active threads (peak value#2)

webApplicationWaitingRequestCountUpperBound
(35)
INTEGER
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (upper-limit value)

webApplicationWaitingRequestCount
(36)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (current value)

webApplicationWaitingRequestCountHighWaterMark
(37)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (maximum value)

webApplicationWaitingRequestCountLowWaterMark
(38)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (minimum value)

webApplicationWaitingRequestCountAverage
(39)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (average value#1)

webApplicationWaitingRequestCountPeak
(40)
Gauge
RO
--
Number of requests awaiting execution based on the upper-limit value set for the running threads (peak value#2)

webApplicationOverflowRequestCount
(41)
Counter
RO
--
Number of requests for which an error is returned based on the upper limit value that is set up for pending requests of each URL group and Web application (total value)

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

#5

Upper-limit value for the number of threads that can be concurrently executed at present

(19) servletTable

The following table describes servletTable:

Table A-19 servletTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

servletTable
(19)
servletEntry
(1)
servletIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A servlet is used

servletFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:context-root:Servlet-class-name"

servletName
(3)
DisplayString
RO
--
Servlet name coded in web.xml
Null character if the servlet name is not set

servletServletClassName
(4)
DisplayString
RO
--
Servlet class name

servletServiceCount
(5)
Counter
RO
--
Number of executions of the servlet (total value)

servletServiceFailedCount
(6)
Counter
RO
--
Number of failed executions of the servlet (total value)

servletServiceMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the servlet (maximum value)

servletServiceMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the servlet (minimum value)

servletServiceAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the servlet (average value#1)

servletServicePeak
(10)
Gauge
RO
Milliseconds
Execution time of the servlet (peak value#2)

servletServiceOutputDataSizeMax
(11)
Gauge
RO
KB
Servlet output data size (maximum value)

servletServiceOutputDataSizeMin
(12)
Gauge
RO
KB
Servlet output data size (minimum value)

servletServiceOutputDataSizeAve
(13)
Gauge
RO
KB
Servlet output data size (average value#1)

servletServiceOutputDataSizePeak
(14)
Gauge
RO
KB
Servlet output data size (peak value#2)

servletStatisticsStartTime
(15)
INTEGER
RO
Seconds
Statistics start time#3

servletSamplingTime
(16)
INTEGER
RW
Seconds
Statistics sampling time#4

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(20) requestUrlTable

The following table describes requestUrlTable:

Table A-20 requestUrlTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

requestUrlTable
(20)
requestUrlEntry
(1)
requestUrlIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
Statistics of the requestUrl must be started, and the URL for the corresponding Web application must be accessed

requestUrlFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:context-root:request-URL"

requestUrl
(3)
DisplayString
RO
--
Request URL

requestUrlServiceCount
(4)
Counter
RO
--
Number of request executions (total value)

requestUrlServiceFailedCount
(5)
Counter
RO
--
Number of failed request executions (total value)

requestUrlServiceMaxTime
(6)
Gauge
RO
Milliseconds
Request execution time (maximum value)

requestUrlServiceMinTime
(7)
Gauge
RO
Milliseconds
Request execution time (minimum value)

requestUrlServiceAveTime
(8)
Gauge
RO
Milliseconds
Request execution time (average value#1)

requestUrlServicePeak
(9)
Gauge
RO
Milliseconds
Request execution time (peak value#2)

requestUrlServiceOutputDataSizeMax
(10)
Gauge
RO
KB
Request output data size (maximum value)

requestUrlServiceOutputDataSizeMin
(11)
Gauge
RO
KB
Request output data size (minimum value)

requestUrlServiceOutputDataSizeAve
(12)
Gauge
RO
KB
Request output data size (average value#1)

requestUrlServiceOutputDataSizePeak
(13)
Gauge
RO
KB
Request output data size (peak value#2)

requestUrlStatisticsStartedTime
(14)
INTEGER
RO
Seconds
Statistics start time#3

requestUrlSamplingTime
(15)
INTEGER
RW
Seconds
Statistics sampling time#4

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request

This peak value is the maximum value for the available period of the sampling time after recording.

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(21) dataSourceFullJTATable

The following table describes dataSourceFullJTATable:

Table A-21 dataSourceFullJTATable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

dataSourceFullJTATable
(21)
dataSourceFullJTAEntry
(1)
dataSourceFullJTAIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
Data source (XA) is imported

dataSourceFullJTAFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:data-source-name"

dataSourceFullJTAName
(3)
DisplayString
RO
--
Data source name

dataSourceFullJTALoginTimeout
(4)
INTEGER
RO
Seconds
Login timeout value

dataSourceFullJTAUserID
(5)
DisplayString
RO
--
User ID

dataSourceFullJTAPoolUpperBound
(6)
INTEGER
RO
--
Number of connection pools (upper-limit value)

dataSourceFullJTAPoolLowerBound
(7)
INTEGER
RO
--
Number of connection pools (lower-limit value)

dataSourceFullJTACurrentPoolSize
(8)
Gauge
RO
--
Number of connection pools (current value)

dataSourceFullJTAActiveConnectionCount
(9)
Gauge
RO
--
Number of active connections (current value)

dataSourceFullJTAFreeConnectionCount
(10)
Gauge
RO
--
Number of free connections (current value)

dataSourceFullJTAGetConnectionMaxTime
(11)
Gauge
RO
Milliseconds
Execution time of the getConnection method (maximum value)

dataSourceFullJTAGetConnectionMinTime
(12)
Gauge
RO
Milliseconds
Execution time of the getConnection method (minimum value)

dataSourceFullJTAGetConnectionAveTime
(13)
Gauge
RO
Milliseconds
Execution time of the getConnection method (average value#1)

dataSourceFullJTACreateConnectionMaxTime
(14)
Gauge
RO
Milliseconds
Execution time of the getXAConnection method (maximum value)

dataSourceFullJTACreateConnectionMinTime
(15)
Gauge
RO
Milliseconds
Execution time of the getXAConnection method (minimum value)

dataSourceFullJTACreateConnectionAveTime
(16)
Gauge
RO
Milliseconds
Execution time of the getXAConnection method (average value#1)

dataSourceFullJTAGetConnectionFailedCount
(17)
Counter
RO
--
Number of failures of the getConnection method

dataSourceFullJTAConnectionErrorCount
(18)
Counter
RO
--
Number of times a FATAL error occurred in the Connection.
Number of times the connectionErrorOccurred method of ConnectionEventListener was invoked.

dataSourceFullJTAStatisticsStartedTime
(19)
INTEGER
RO
Seconds
Statistics start time#2

dataSourceFullJTASamplingTime
(20)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(22) resourceAdapterTable

The following table describes resourceAdapterTable:

Table A-22 resourceAdapterTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

resourceAdapterTable
(22)
resourceAdapterEntry
(1)
resourceAdapterIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A resource adapter is used

resourceAdapterFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:resource-adapter-name":container
"logical-server-name:J2EE-application-name:resource-adapter-name":application"

resourceAdapterName
(3)
DisplayString
RO
--
Resource adapter name

resourceAdapterVendorName
(4)
DisplayString
RO
--
Name of the vendor providing the resource adapter

resourceAdapterSpecVersion
(5)
DisplayString
RO
--
Used version of the JCA-based resource adapter

resourceAdapterEISType
(6)
DisplayString
RO
--
EIS type to which the resource adapter connects

resourceAdapterVersion
(7)
DisplayString
RO
--
Version of the resource adapter

resourceAdapterConnectionFactoryInterfaceName
(8)
DisplayString
RO
--
Interface class name of ConnectionFactory

resourceAdapterConnectionFactoryImplName
(9)
DisplayString
RO
--
Implementation class name of ConnectionFactory

resourceAdapterManagedConnectionFactoryImplName
(10)
DisplayString
RO
--
Implementation class name of ManagedConnectionFactory

resourceAdapterConnectionInterfaceName
(11)
DisplayString
RO
--
Interface class name of Connection

resourceAdapterConnectionImplName
(12)
DisplayString
RO
--
Implementation class name of Connection

resourceAdapterTransactionSupport
(13)
DisplayString
RO
--
Supported transaction models
NoTransaction: No transaction
LocalTransaction: Local transaction
XATransaction: XA transaction

resourceAdapterConfigProperties
(14)
DisplayString
RO
--
ConfigurationProperty information#1

resourceAdapterMConCreateCount
(15)
Counter
RO
--
Number of executions of the createManagedConnection method of ManagedConnectionFactory#2

resourceAdapterConCreateCount
(16)
Counter
RO
--
Number of executions of the getConnection method of ManagedConnection#2

resourceAdapterMConCleanupCount
(17)
Counter
RO
--
Number of executions of the cleanup method of ManagedConnection#2

resourceAdapterMConDestroyCount
(18)
Counter
RO
--
Number of executions of the destroy method of ManagedConnection#2

resourceAdapterUserId
(19)
DisplayString
RO
--
User ID

resourceAdapterPoolUpperBound
(20)
INTEGER
RO
--
Number of connection pools#2 (upper-limit value)

resourceAdapterPoolLowerBound
(21)
INTEGER
RO
--
Number of connection pools#2 (lower-limit value)

resourceAdapterCurrentPoolSize
(22)
Gauge
RO
--
Number of connection pools#2 (current value)

resourceAdapterActiveConnectionCount
(23)
Gauge
RO
--
Number of active connections#2 (current value)

resourceAdapterFreeConnectionCount
(24)
Gauge
RO
--
Number of free connections#2 (current value)

resourceAdapterGetConnectionMaxTime
(25)
Gauge
RO
Milliseconds
Execution time of the allocateConnection method of ConnectionManager#3, #4 (maximum value)

resourceAdapterGetConnectionMinTime
(26)
Gauge
RO
Milliseconds
Execution time of the allocateConnection method of ConnectionManager #3, #4 (minimum value)

resourceAdapterGetConnectionAveTime
(27)
Gauge
RO
Milliseconds
Execution time of the allocateConnection method of ConnectionManager #2, #5 (average value#6)

resourceAdapterCreateConnectionMaxTime
(28)
Gauge
RO
Milliseconds
Execution time of the createManagedConnection method of ManagedConnectionFactory#3 (maximum value)

resourceAdapterCreateConnectionMinTime
(29)
Gauge
RO
Milliseconds
Execution time of the createManagedConnection method of ManagedConnectionFactory#3 (minimum value)

resourceAdapterCreateConnectionAveTime
(30)
Gauge
RO
Milliseconds
Execution time of the createManagedConnection method of ManagedConnectionFactory#2 (average value#⁶)

resourceAdapterGetConnectionFailedCount
(31)
Counter
RO
--
Number of failures of the allocateConnection method#2, #5

resourceAdapterConnectionErrorCount
(32)
Counter
RO
--
Number of times a FATAL error occurred in ManagedConnection
Number of times the connectionErrorOccurred method of ConnectionEventListener was invoked#2

resourceAdapterStatisticsStartedTime
(33)
INTEGER
RO
Seconds
Statistics start time#7

resourceAdapterSamplingTime
(34)
INTEGER
RW
Seconds
Statistics sampling time#8

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

The output format is property-name=property-value:property-name=property-value:.... If the property name or property value includes an equal sign (=), colon (:), and a yen sign (), these signs are displayed as \=, \:and \\.

(Example) abc=ab\:bc\=ef\\gh for property name ..."abc" and property value..."ab:bc=ef\gh"

#2

0 is displayed for the root resource adapter.

#3

Not Available is displayed for the member resource adapter.

#4

Not Available is displayed for the root resource adapter.

#5

0 is displayed for member resource adapter.

#6

Average value of the past sampling time from the time of value acquisition request.

#7

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#8

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(23) statelessSessionBeanLocalHomeTable

The following table describes statelessSessionBeanLocalHomeTable:

Table A-23 statelessSessionBeanLocalHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSession
BeanLocalHomeTable
(23)
statelessSession
BeanLocalHomeEntry
(1)
statelessSessionBeanLocalHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Local Home Interface is used

statelessSessionBeanLocalHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statelessSessionBeanLocalHomeName
(3)
DisplayString
RO
--
LocalHome interface class name

statelessSessionBeanLocalHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (maximum value)

statelessSessionBeanLocalHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (minimum value)

statelessSessionBeanLocalHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (average value#1)

statelessSessionBeanLocalHomeStatisticsStartedTime
(7)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanLocalHomeSamplingTime
(8)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(24) statelessSessionBeanLocalComponentTable

The following table describes statelessSessionBeanLocalComponentTable:

Table A-24 statelessSessionBeanLocalComponentTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSession
BeanLocalComponentTable
(24)
statelessSession
BeanLocalComponentTable
(1)
statelessSessionBeanLocalComponentIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Local Component Interface is used

statelessSessionBeanLocalComponentFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statelessSessionBeanLocalComponentFullyQualifiedName
(3)
DisplayString
RO
--
LocalComponent interface class name

statelessSessionBeanLocalComponentResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (maximum value)

statelessSessionBeanLocalComponentResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (minimum value)

statelessSessionBeanLocalComponentResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (average value#1)

statelessSessionBeanLocalComponentResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (maximum value)

statelessSessionBeanLocalComponentResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (minimum value)

statelessSessionBeanLocalComponentResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (average value#1)

statelessSessionBeanLocalComponentStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanLocalComponentSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(25) statefulSessionBeanLocalHomeTable

The following table describes statefulSessionBeanLocalHomeTable:

Table A-25 statefulSessionBeanLocalHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSession
BeanLocalHomeTable
(25)
statefulSession
BeanLocalHomeEntry
(1)
statefulSessionBeanLocalHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Local Home Interface is used

statefulSessionBeanLocalHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statefulSessionBeanLocalHomeName
(3)
DisplayString
RO
--
LocalHome interface class name

statefulSessionBeanLocalHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (maximum value)

statefulSessionBeanLocalHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (minimum value)

statefulSessionBeanLocalHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (average value#1)

statefulSessionBeanLocalHomeResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (maximum value)

statefulSessionBeanLocalHomeResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (minimum value)

statefulSessionBeanLocalHomeResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (average value#1)

statefulSessionBeanLocalHomeStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanLocalHomeSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(26) statefulSessionBeanLocalComponentTable

The following table describes statefulSessionBeanLocalComponentTable:

Table A-26 statefulSessionBeanLocalComponentTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSession
BeanLocalComponentTable
(26)
statefulSession
BeanLocalComponentEntry
(1)
statefulSessionBeanLocalComponentIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Local Component Interface is used

statefulSessionBeanLocalComponentFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

statefulSessionBeanLocalComponentName
(3)
DisplayString
RO
--
LocalComponent interface class name

statefulSessionBeanLocalComponentResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (maximum value)

statefulSessionBeanLocalComponentResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (minimum value)

statefulSessionBeanLocalComponentResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (average value#1)

statefulSessionBeanLocalComponentResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (maximum value)

statefulSessionBeanLocalComponentResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (minimum value)

statefulSessionBeanLocalComponentResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (average value#1)

statefulSessionBeanLocalComponentStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanLocalComponentSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(27) entityBeanLocalHomeTable

The following table describes entityBeanLocalHomeTable:

Table A-27 entityBeanLocalHomeTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

entityBeanLocalHomeTable
(27)
entityBeanLocalHomeEntry
(1)
entityBeanLocalHomeIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Entity Bean Local Home Interface is used

entityBeanLocalHomeFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

entityBeanLocalHomeName
(3)
DisplayString
RO
--
LocalHome interface class name

entityBeanLocalHomeResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (maximum value)

entityBeanLocalHomeResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (minimum value)

entityBeanLocalHomeResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (average value#1)

entityBeanLocalHomeResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (maximum value)

entityBeanLocalHomeResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocaHome interface (minimum value)

entityBeanLocalHomeResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocaHome interface (average value#1)

entityBeanLocalHomeStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

entityBeanLocalHomeSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(28) entityBeanLocalComponentTable

The following table describes entityBeanLocalComponentTable:

Table A-28 entityBeanLocalComponentTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

entityBeanLocal
ComponentTable
(28)
entityBeanLocal
ComponentEntry
(1)
entityBeanLocalComponentIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Entity Bean Local Component Interface is used

entityBeanLocalComponentFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

entityBeanLocalComponentName
(3)
DisplayString
RO
--
LocalComponent interface class name

entityBeanLocalComponentResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (maximum value)

entityBeanLocalComponentResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (minimum value)

entityBeanLocalComponentResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (average value#1)

entityBeanLocalComponentResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (maximum value)

entityBeanLocalComponentResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (minimum value)

entityBeanLocalComponentResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (average value#1)

entityBeanLocalComponentStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

entityBeanLocalComponentSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(29) messageDrivenBeanTable

The following table describes messageDrivenBeanTable:

Table A-29 messageDrivenBeanTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

messageDrivenBeanTable
(29)
messageDrivenBeanEntry
(1)
messageDrivenBeanIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
A Message-driven Bean is used

messageDrivenBeanFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name"

messageDrivenBeanName
(3)
DisplayString
RO
--
Enterprise Bean name

messageDrivenBeanEjbClassName
(4)
DisplayString
RO
--
EJB class name

messageDrivenBeanTransactionType
(5)
DisplayString
RO
--
Transaction type
CMT or BMT

messageDrivenBeanDestinationType
(6)
DisplayString
RO
--
Destination types
Queue: Destination of the Point-To-Point model
Topic: Destination of the Publish-Subscribe model

messageDrivenBeanPoolUpperBound
(7)
INTEGER
RO
--
Number of instance pools (upper-limit value)

messageDrivenBeanCurrentPoolSize
(8)
Gauge
RO
--
Number of instance pools (current value)

messageDrivenBeanCurrentSessionCount
(9)
Gauge
RO
--
Number of connected sessions (current value)

messageDrivenBeanResponseEjbMaxTime
(10)
Gauge
RO
Milliseconds
Execution time of the EJB method (maximum value)

messageDrivenBeanResponseEjbMinTime
(11)
Gauge
RO
Milliseconds
Execution time of the EJB method (minimum value)

messageDrivenBeanResponseEjbAveTime
(12)
Gauge
RO
Milliseconds
Execution time of the EJB method (average value#1)

messageDrivenBeanStatisticsStartedTime
(10)
INTEGER
RO
Seconds
Statistics start time#2

messageDrivenBeanSamplingTime
(11)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(30) queueTable

The following table describes queueTable:

Table A-30 queueTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

queueTable
(30)
queueEntry
(1)
queueIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

queueFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:queue-name"

queueName
(3)
DisplayString
RO
--
Queue name

queueStatus
(4)
DisplayString
RO
--
Status
scheduling:State in which scheduling is possible
preparing: Preparation in progress
stopping: Queue being terminated
closing[in]:Locking the queue entry
closing[out]: Locking the queue exit

queueSharedApplicationCount
(5)
INTEGER
RO
--
Number of applications sharing the queue

queueStayedRequestCount
(6)
Gauge
RO
--
Number of requests retained in the queue

queueStayedRequestMax
(7)
Gauge
RO
--
Maximum number of requests retained in the queue

queueLength
(8)
INTEGER
RO
--
Number of requests that can be registered concurrently

queueLookupName
(9)
DisplayString
RO
--
Registered name information managed by the queue

queueInterfaceName
(10)
DisplayString
RO
--
Interface information managed by the queue

queueParallelCount
(11)
INTEGER
RO
--
Number of concurrent executions managed by the queue

queueTotalThreadCount
(12)
INTEGER
RO
--
Total number of current resident threads managed by the queue

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

(31) statelessSessionBeanHomeMethodTable

The following table describes statelessSessionBeanHomeMethodTable:

Table A-31 statelessSessionBeanHomeMethodTable

Table name (OID)
Entry name (OID)
Metric name (OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSessionBean
HomeMethodTable
(31)
statelessSessionBean
HomeMethodEntry
(1)
statelessSessionBeanHomeMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Remote Home Interface Method is used

statelessSessionBeanHomeMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:Home-interface-class-name:method-name"

statelessSessionBeanHomeMethodName
(3)
DisplayString
RO
--
Method name

statelessSessionBeanHomeMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (maximum value)

statelessSessionBeanHomeMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (minimum value)

statelessSessionBeanHomeMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (average value#1)

statelessSessionBeanHomeMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (maximum value)

statelessSessionBeanHomeMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (minimum value)

statelessSessionBeanHomeMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (average value#1)

statelessSessionBeanHomeMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statelessSessionBeanHomeMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanHomeMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(32) statelessSessionBeanRemoteMethodTable

The following table describes statelessSessionBeanRemoteMethodTable:

Table A-32 statelessSessionBeanRemoteMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSessionBean
RemoteMethodTable
(32)
statelessSessionBean
RemoteMethodEntry
(1)
statelessSessionBeanRemoteMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Remote Component Interface Method is used

statelessSessionBeanRemoteMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:Remote-interface-class-name:method-name"

statelessSessionBeanRemoteMethodName
(3)
DisplayString
RO
--
Method name

statelessSessionBeanRemoteMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (maximum value)

statelessSessionBeanRemoteMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (minimum value)

statelessSessionBeanRemoteMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (average value#1)

statelessSessionBeanRemoteMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (maximum value)

statelessSessionBeanRemoteMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (minimum value)

statelessSessionBeanRemoteMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (average value#1)

statelessSessionBeanRemoteMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statelessSessionBeanRemoteMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanRemoteMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(33) statelessSessionBeanLocalHomeMethodTable

The following table describes statelessSessionBeanLocalHomeMethodTable:

Table A-33 statelessSessionBeanLocalHomeMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSessionBean
LocalHomeMethodTable
(33)
statelessSessionBean
LocalHomeMethodEntry
(1)
statelessSessionBeanLocalHomeMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Local Home Interface Method is used

statelessSessionBeanLocalHomeMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:LocalHome-interface-class-name:method-name"

statelessSessionBeanLocalHomeMethodName
(3)
DisplayString
RO
--
Method name

statelessSessionBeanLocalHomeMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (maximum value)

statelessSessionBeanLocalHomeMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (minimum value)

statelessSessionBeanLocalHomeMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (average value#1)

statelessSessionBeanLocalHomeMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (maximum value)

statelessSessionBeanLocalHomeMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (minimum value)

statelessSessionBeanLocalHomeMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (average value#1)

statelessSessionBeanLocalHomeMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statelessSessionBeanLocalHomeMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanLocalHomeMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(34) statelessSessionBeanLocalComponentMethodTable

The following table describes statelessSessionBeanLocalComponentMethodTable:

Table A-34 statelessSessionBeanLocalComponentMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statelessSessionBean
LocalComponentMethodTable
(34)
statelessSessionBean
LocalComponentMethodEntry
(1)
statelessSessionBeanLocalComponentMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateless Session Bean Local Component Interface Method is used

statelessSessionBeanLocalComponentMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:LocalComponent-interface-class-name:method-name"

statelessSessionBeanLocalComponentMethodName
(3)
DisplayString
RO
--
Method name

statelessSessionBeanLocalComponentMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (maximum value)

statelessSessionBeanLocalComponentMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (minimum value)

statelessSessionBeanLocalComponentMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (average value#1)

statelessSessionBeanLocalComponentMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (maximum value)

statelessSessionBeanLocalComponentMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (minimum value)

statelessSessionBeanLocalComponentMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (average value#1)

statelessSessionBeanLocalComponentMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statelessSessionBeanLocalComponentMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statelessSessionBeanLocalComponentMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(35) statefulSessionBeanHomeMethodTable

The following table describes statefulSessionBeanHomeMethodTable:

Table A-35 statefulSessionBeanHomeMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSessionBean
HomeMethodTable
(35)
statefulSessionBean
HomeMethodEntry
(1)
statefulSessionBeanHomeMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Remote Home Interface Method is used

statefulSessionBeanHomeMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:Home-interface-class-name:method-name"

statefulSessionBeanHomeMethodName
(3)
DisplayString
RO
--
Method name

statefulSessionBeanHomeMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (maximum value)

statefulSessionBeanHomeMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (minimum value)

statefulSessionBeanHomeMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the Home interface (average value#1)

statefulSessionBeanHomeMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (maximum value)

statefulSessionBeanHomeMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (minimum value)

statefulSessionBeanHomeMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Home interface (average value#1)

statefulSessionBeanHomeMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statefulSessionBeanHomeMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanHomeMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(36) statefulSessionBeanRemoteMethodTable

The following table describes statefulSessionBeanRemoteMethodTable:

Table A-36 statefulSessionBeanRemoteMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSessionBean
RemoteMethodTable
(36)
statefulSessionBean
RemoteMethodEntry
(1)
statefulSessionBeanRemoteMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Remote Component Interface Method is used

statefulSessionBeanRemoteMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:Remote-interface-class-name:method-name"

statefulSessionBeanRemoteMethodName
(3)
DisplayString
RO
--
Method name

statefulSessionBeanRemoteMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (maximum value)

statefulSessionBeanRemoteMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (minimum value)

statefulSessionBeanRemoteMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the Remote interface (average value#1)

statefulSessionBeanRemoteMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (maximum value)

statefulSessionBeanRemoteMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (minimum value)

statefulSessionBeanRemoteMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the Remote interface (average value#1)

statefulSessionBeanRemoteMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statefulSessionBeanRemoteMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanRemoteMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(37) statefulSessionBeanLocalHomeMethodTable

The following table describes statefulSessionBeanLocalHomeMethodTable:

Table A-37 statefulSessionBeanLocalHomeMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSessionBean
LocalHomeMethodTable
(37)
statefulSessionBean
LocalHomeMethodEntry
(1)
statefulSessionBeanLocalHomeMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Local Home Interface Method is used

statefulSessionBeanLocalHomeMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:LocalHome-interface-class-name:method-name"

statefulSessionBeanLocalHomeMethodName
(3)
DisplayString
RO
--
Method name

statefulSessionBeanLocalHomeMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (maximum value)

statefulSessionBeanLocalHomeMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (minimum value)

statefulSessionBeanLocalHomeMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalHome interface (average value#1)

statefulSessionBeanLocalHomeMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (maximum value)

statefulSessionBeanLocalHomeMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (minimum value)

statefulSessionBeanLocalHomeMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalHome interface (average value#1)

statefulSessionBeanLocalHomeMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statefulSessionBeanLocalHomeMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanLocalHomeMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(38) statefulSessionBeanLocalComponentMethodTable

The following table describes statefulSessionBeanLocalComponentMethodTable:

Table A-38 statefulSessionBeanLocalComponentMethodTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

statefulSessionBean
LocalComponentMethodTable
(38)
statefulSessionBean
LocalComponentMethodEntry
(1)
statefulSessionBeanLocalComponentMethodIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
The Stateful Session Bean Local Component Interface Method is used

statefulSessionBeanLocalComponentMethodFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance
"logical-server-name:J2EE-application-name:EJB-application-name:Enterprise-Bean-name:LocalComponent-interface-class-name:method-name"

statefulSessionBeanLocalComponentMethodName
(3)
DisplayString
RO
--
Method name

statefulSessionBeanLocalComponentMethodResponseMaxTime
(4)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (maximum value)

statefulSessionBeanLocalComponentMethodResponseMinTime
(5)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (minimum value)

statefulSessionBeanLocalComponentMethodResponseAveTime
(6)
Gauge
RO
Milliseconds
Response time of calls to the LocalComponent interface (average value#1)

statefulSessionBeanLocalComponentMethodResponseEjbMaxTime
(7)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (maximum value)

statefulSessionBeanLocalComponentMethodResponseEjbMinTime
(8)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (minimum value)

statefulSessionBeanLocalComponentMethodResponseEjbAveTime
(9)
Gauge
RO
Milliseconds
Execution time of the EJB method for the LocalComponent interface (average value#1)

statefulSessionBeanLocalComponentMethodCallCount
(10)
Counter
RO
--
Number of executions of the method

statefulSessionBeanLocalComponentMethodStatisticsStartedTime
(11)
INTEGER
RO
Seconds
Statistics start time#2

statefulSessionBeanLocalComponentMethodSamplingTime
(12)
INTEGER
RW
Seconds
Statistics sampling time#3

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#3

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(39) webContainerTable

The following table describes webContainerTable:

Table A-39 webContainerTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

webContainerTable
(39)
webContainerEntry
(1)
webContainerIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

webContainerFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance "logical-server-name"

webContainerServerName
(3)
DisplayString
RO
--
Server name of the Web container

webContainerStartedTime
(4)
INTEGER
RO
Seconds
Startup time of the Web container#1

webContainerStatisticsStartedTime
(5)
INTEGER
RO
Seconds
Statistics start time#1

webContainerSamplingTime
(6)
INTEGER
RW
Seconds
Statistics sampling time#2

webContainerActiveThreadCountUpperBound
(7)
INTEGER
RO
--
Upper-limit value of the number of active threads

A Web application (WAR) is used

The control functionality for concurrently executing threads is used

A Web application in which the number of concurrently executing threads is not set exists

webContainerCurrentThreadCountUpperBound
(8)
Gauge
RO
--
Current upper-limit value of the number of active threads#3

webContainerActiveThreadCount
(9)
Gauge
RO
--
Current number of active threads

webContainerActiveThreadCountHighWaterMark
(10)
Gauge
RO
--
Maximum number of active threads

webContainerActiveThreadCountLowWaterMark
(11)
Gauge
RO
--
Minimum number of active threads

webContainerActiveThreadCountAverage
(12)
Gauge
RO
--
Average value#4 of the number of active threads

webContainerActiveThreadCountPeak
(13)
Gauge
RO
--
Peak value#5of the number of active threads

webContainerWaitingRequestCountUpperBound
(14)
INTEGER
RO
--
Upper-limit value of the number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerWaitingRequestCount
(15)
Gauge
RO
--
Current number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerWaitingRequestCountHighWaterMark
(16)
Gauge
RO
--
Maximum number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerWaitingRequestCountLowWaterMark
(17)
Gauge
RO
--
Minimum number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerWaitingRequestCountAverage
(18)
Gauge
RO
--
Average value#4 of the number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerWaitingRequestCountPeak
(19)
Gauge
RO
--
Peak value#5 of the number of requests awaiting execution based on the upper-limit value set for the running threads

webContainerOverflowRequestCount
(20)
Counter
RO
--
Total number of requests in which an error is returned based on the upper limit value that is set up for the default pending request

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#2

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

#3

Upper-limit value for the number of threads that can be concurrently executed at present

#4

Average value of the past sampling time from the time of value acquisition request.

#5

Peak value at the point of value acquisition request (the maximum value involving the available period of the sampling time after recording).

(40) inprocHttpSvrTable

The following table describes inprocHttpSvrTable:

Table A-40 inprocHttpSvrTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

inprocHttpSvrTable
(40)
inprocHttpSvrEntry
(1)
inprocHttpSvrIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
An in-process HTTP server is used

inprocHttpSvrFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance "logical-server-name"

inprocHttpSvrPortNumber
(3)
INTEGER
RO
--
Port number of the in-process HTTP server

inprocHttpSvrBackLogUpperBound
(4)
INTEGER
RO
--
Backlog of the communication sockets

inprocHttpSvrThreadCount
(5)
Gauge
RO
--
Current value of the total number of threads used in request processing

inprocHttpSvrThreadCountUpperBound
(6)
INTEGER
RO
--
Upper-limit value of the total number of threads used in request processing

inprocHttpSvrThreadCountLowerBound
(7)
INTEGER
RO
--
Lower-limit value of the total number of threads used in request processing

inprocHttpSvrThreadCountHighWaterMark
(8)
Gauge
RO
--
Maximum value of the total number of threads used in request processing

inprocHttpSvrThreadCountLowWaterMark
(9)
Gauge
RO
--
Minimum value of the total number of threads used in request processing

inprocHttpSvrThreadCountAverage
(10)
Gauge
RO
--
Average value#1 of the total number of threads used in request processing

inprocHttpSvrThreadCountPeak
(11)
Gauge
RO
--
Peak value#2 of the total number of threads used in request processing

inprocHttpSvrActiveThreadCount
(12)
Gauge
RO
--
Current value of the number of running threads

inprocHttpSvrActiveThreadCountUpperBound
(13)
INTEGER
RO
--
Upper-limit value of the number of running threads

inprocHttpSvrActiveThreadCountHighWaterMark
(14)
Gauge
RO
--
Maximum number of running threads

An in-process HTTP server is used

The control functionality for concurrently executing threads is not used

inprocHttpSvrActiveThreadCountLowWaterMark
(15)
Gauge
RO
--
Minimum number of running threads

inprocHttpSvrActiveThreadCountAverage
(16)
Gauge
RO
--
Average value#1 of the number of running threads

inprocHttpSvrActiveThreadCountPeak
(17)
Gauge
RO
--
Peak value#2 of the number of running threads

inprocHttpSvrPoolingThreadCount
(18)
Gauge
RO
--
Current value of the number of pooling threads
An in-process HTTP server is used

inprocHttpSvrPoolingThreadCountUpperBound
(19)
INTEGER
RO
--
Upper-limit value of the number of pooling threads

inprocHttpSvrPoolingThreadCountLowerBound
(20)
INTEGER
RO
--
Lower-limit value of the number of pooling threads

inprocHttpSvrPoolingThreadCountHighWaterMark
(21)
Gauge
RO
--
Maximum number of pooling threads

inprocHttpSvrPoolingThreadCountLowWaterMark
(22)
Gauge
RO
--
Minimum number of pooling threads

inprocHttpSvrPoolingThreadCountAverage
(23)
Gauge
RO
--
Average value#1 of the number of pooling threads

inprocHttpSvrPoolingThreadCountPeak
(24)
Gauge
RO
--
Peak value#2 of the number of pooling threads

InprocHttpSvrConnectionCount
(25)
Gauge
RO
--
Current value of the number of connections

inprocHttpSvrConnectionCountUpperBound
(26)
INTEGER
RO
--
Upper-limit value of the number of connections

inprocHttpSvrConnectionCountHighWaterMark
(27)
Gauge
RO
--
Maximum number of connections

inprocHttpSvrConnectionCountLowWaterMark
(28)
Gauge
RO
--
Minimum number of connections

inprocHttpSvrConnectionCountAverage
(29)
Gauge
RO
--
Average value#1 of the number of connections

inprocHttpSvrConnectionCountPeak
(30)
Gauge
RO
--
Peak value#2 of the number of connections

inprocHttpSvrPersistentConnectionCount
(31)
Gauge
RO
--
Current value of the number of Persistent connections

inprocHttpSvrPersistentConnectionCountUpperBound
(32)
INTEGER
RO
--
Upper-limit value of the number of Persistent connections

inprocHttpSvrPersistentConnectionCountHighWaterMark
(33)
Gauge
RO
--
Maximum number of Persistent connections

inprocHttpSvrPersistentConnectionCountLowWaterMark
(34)
Gauge
RO
--
Minimum number of Persistent connections

inprocHttpSvrPersistentConnectionCountAverage
(35)
Gauge
RO
--
Average value#1 of the number of Persistent connections

inprocHttpSvrPersistentConnectionCountPeak
(36)
Gauge
RO
--
Peak value#2 of the number of Persistent connections

inprocHttpSvrPersistentConnectionProcessedRequestCountUpperBound
(37)
INTEGER
RO
--
Upper-limit value of the number of requests processed until the Persistent connection was disconnected

inprocHttpSvrPersistentConnectionProcessedRequestCountMax
(38)
Gauge
RO
--
Maximum number of requests processed until the Persistent connection was disconnected

inprocHttpSvrPersistentConnectionProcessedRequestCountMin
(39)
Gauge
RO
--
Minimum number of requests processed until the Persistent connection was disconnected

inprocHttpSvrPersistentConnectionProcessedRequestCountAve
(40)
Gauge
RO
--
Average value#1 of the number of requests processed until the Persistent connection was disconnected

inprocHttpSvrPersistentConnectionProcessedRequestCountPeak
(41)
Gauge
RO
--
Peak value#2 of the number of requests processed until the Persistent connection was disconnected

inprocHttpSvrPersistentConnectionRequestWaitingTimeUpperBound
(42)
INTEGER
RO
Milliseconds
Upper-limit value of the request waiting time when the TCP connection continues as the Persistent connection

inprocHttpSvrPersistentConnectionRequestWaitingTimeMaxTime
(43)
Gauge
RO
Milliseconds
Maximum request waiting time when the TCP connection continues as the Persistent connection

inprocHttpSvrPersistentConnectionRequestWaitingTimeMinTime
(44)
Gauge
RO
Milliseconds
Minimum request waiting time when the TCP connection continues as the Persistent connection

inprocHttpSvrPersistentConnectionRequestWaitingTimeAveTime
(45)
Gauge
RO
Milliseconds
Average value#1 of the request waiting time when the TCP connection continues as the Persistent connection

inprocHttpSvrPersistentConnectionRequestWaitingTimePeak
(46)
Gauge
RO
Milliseconds
Peak value#2 of the request waiting time when the TCP connection continues as the Persistent connection

inprocHttpSvrWaitingRequestCount
(47)
Gauge
RO
--
Current value of the number of requests that exceed the concurrently executing thread count, and are pending for each Web container

An in-process HTTP server is used

The control functionality for concurrently executing threads is not used

inprocHttpSvrWaitingRequestCountHighWaterMark
(48)
Gauge
RO
--
Maximum number of requests that exceed the concurrently executing thread count, and are pending for each Web container

inprocHttpSvrWaitingRequestCountLowWaterMark
(49)
Gauge
RO
--
Minimum number of requests that exceed the concurrently executing thread count, and are pending for each Web container

inprocHttpSvrWaitingRequestCountAverage
(50)
Gauge
RO
--
Average value#1 of the number of requests that exceed the concurrently executing thread count, and are pending for each Web container

inprocHttpSvrWaitingRequestCountPeak
(51)
Gauge
RO
--
Peak value#² of the number of requests that exceed the concurrently executing thread count, and are pending for each Web container

inprocHttpSvrRejectionRequestCount
(52)
Counter
RO
--
Total number of requests for which access is denied based on the control functionality for concurrent connections
An in-process HTTP server is used

inprocHttpSvrStatisticsStartedTime
(53)
INTEGER
RO
Seconds
Statistics start time#3

inprocHttpSvrSamplingTime
(54)
INTEGER
RW
Seconds
Statistics sampling time#4

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

RW: Read-Write

#1

Average value of the past sampling time from the time of value acquisition request.

#2

Peak value at the point of value acquisition request (the maximum value involving the available period of the sampling time after recording).

#3

Number of seconds elapsed since 00:00 Jan. 1, 1970 UTC

#4

Setting the sampling time

If you specify 0 or a lesser value, the statistics stops. If you specify a value from 1 to 9, the sampling time is set to the default value (10 seconds) and the statistics starts. If you specify 10 or a higher value, the statistics starts assuming the specified value as the sampling time.

(41) queueAppTable

The following table describes queueAppTable:

Table A-41 queueAppTable

Table name
(OID)
Entry name
(OID)
Metric name
(OID)
TYPE
R/W
Unit
Description
Preconditions

queueAppTable
(40)
queueAppEntry
(1)
queueAppIndex
(1)
INTEGER
RO
--
Sequence number [1,...]
None

queueAppFullyQualifiedName
(2)
DisplayString
RO
--
Fully qualified name that uniquely identifies an instance "logical-CTM-server-name:queue-name:logical-J2EE-server-name"

queueAppQueueName
(3)
DisplayString
RO
--
Queue name

queueAppJ2EEName
(4)
DisplayString
RO
--
Actual J2EE server name

queueAppStartParallelCount
(5)
INTEGER
RO
--
Number of concurrent executions when the J2EE application is started

queueAppResidentThreadCount
(6)
INTEGER
RO
--
Number of current resident threads for the J2EE application

Legend:

R/W:Read-Only/ Read-Write type

Not applicable

RO: Read-Only

Appendix B. DD (web.xml) for Web applications

Organization of this section

B.1 Relationship between extension and MIME type

Appendix B.1 Relationship between extension and MIME type

Table B-1 describes the default values of the relationship between the extensions and MIME types specified in the mime-mapping tags in web.xml.

Table B-1 Relationship between extensions and MIME types

Extensions | MIME types
abs | audio/x-mpeg
ai | application/postscript
aif | audio/x-aiff
aifc | audio/x-aiff
aiff | audio/x-aiff
aim | application/x-aim
art | image/x-jg
asf | video/x-ms-asf
asx | video/x-ms-asf
au | audio/basic
avi | video/x-msvideo
avx | video/x-rad-screenplay
bcpio | application/x-bcpio
bin | application/octet-stream
bmp | image/bmp
body | text/html
cdf | application/x-cdf
cer | application/x-x509-ca-cert
class | application/java
cpio | application/x-cpio
csh | application/x-csh
css | text/css
dib | image/bmp
doc | application/msword
dtd | text/plain
dv | video/x-dv
dvi | application/x-dvi
eps | application/postscript
etx | text/x-setext
exe | application/octet-stream
gif | image/gif
gtar | application/x-gtar
gz | application/x-gzip
hdf | application/x-hdf
hqx | application/mac-binhex40
htc | text/x-component
htm | text/html
html | text/html
ief | image/ief
jad | text/vnd.sun.j2me.app-descriptor
jar | application/octet-stream
java | text/plain
jnlp | application/x-java-jnlp-file
jpe | image/jpeg
jpeg | image/jpeg
jpg | image/jpeg
js | text/javascript
kar | audio/x-midi
latex | application/x-latex
m3u | audio/x-mpegurl
mac | image/x-macpaint
man | application/x-troff-man
me | application/x-troff-me
mid | audio/x-midi
midi | audio/x-midi
mif | application/x-mif
mov | video/quicktime
movie | video/x-sgi-movie
mp1 | audio/x-mpeg
mp2 | audio/x-mpeg
mp3 | audio/x-mpeg
mpa | audio/x-mpeg
mpe | video/mpeg
mpeg | video/mpeg
mpega | audio/x-mpeg
mpg | video/mpeg
mpv2 | video/mpeg2
ms | application/x-wais-source
nc | application/x-netcdf
oda | application/oda
pbm | image/x-portable-bitmap
pct | image/pict
pdf | application/pdf
pgm | image/x-portable-graymap
pic | image/pict
pict | image/pict
pls | audio/x-scpls
png | image/png
pnm | image/x-portable-anymap
pnt | image/x-macpaint
ppm | image/x-portable-pixmap
ps | application/postscript
psd | image/x-photoshop
qt | video/quicktime
qti | image/x-quicktime
qtif | image/x-quicktime
ras | image/x-cmu-raster
rgb | image/x-rgb
rm | application/vnd.rn-realmedia
roff | application/x-troff
rtf | application/rtf
rtx | text/richtext
sh | application/x-sh
shar | application/x-shar
smf | audio/x-midi
snd | audio/basic
src | application/x-wais-source
sv4cpio | application/x-sv4cpio
sv4crc | application/x-sv4crc
swf | application/x-shockwave-flash
t | application/x-troff
tar | application/x-tar
tcl | application/x-tcl
tex | application/x-tex
texi | application/x-texinfo
texinfo | application/x-texinfo
tif | image/tiff
tiff | image/tiff
tr | application/x-troff
tsv | text/tab-separated-values
txt | text/plain
ulw | audio/basic
ustar | application/x-ustar
xbm | image/x-xbitmap
xpm | image/x-xpixmap
xwd | image/x-xwindowdump
wav | audio/x-wav
wbmp | image/vnd.wap.wbmp
wml | text/vnd.wap.wml
wmlc | application/vnd.wap.wmlc
wmls | text/vnd.wap.wmlscript
wmlscriptc | application/vnd.wap.wmlscriptc
wrl | x-world/x-vrml
Z | application/x-compress
z | application/x-compress
zip | application/zip

Appendix C. Parameters that can be specified in the logical server configuration (for compatibility)

This section describes the compatibility parameters among the parameters that can be specified in a logical server configuration.

The following parameters are compatibility parameters:

Parameters that can be commonly specified for each logical server

Parameters that can be specified in the logical Web server

Parameters that can be specified in the logical J2EE server

Parameters that can be specified in the logical SFO server

Hint

The parameters described in this section are used for compatibility. We recommend that you use the recommended parameters for defining new items. For details on the recommended parameters, see 4.11 System configuration patterns and defined logical servers. Note that if both recommended parameters and compatibility parameters are specified, the recommended parameters are enabled.

Organization of this section

C.1 Parameters that can be commonly specified for each logical server (for compatibility)

C.2 Parameters that can be specified in the logical Web server (For compatibility)

C.3 Parameters that can be specified in the logical J2EE server (For compatibility)

C.4 Parameters that can be specified in the logical SFO server (For compatibility)

Appendix C.1 Parameters that can be commonly specified for each logical server (for compatibility)

This section describes the parameters that can be commonly specified for the following logical servers:

Logical Web server

Logical J2EE server

Logical performance tracer

Logical SFO server

Logical CTM domain manager

Logical CTM

Logical Smart Agent

The following table describes the parameters for compatibility that can be commonly specified for each logical server. In the table below, Default value means the value that is assumed when the parameter is not specified. Recommended value of param-name is the recommended parameter corresponding to the parameters for compatibility.

Table C-1 Parameters that can be specified in common for the logical servers (for compatibility)

Value of param-name | Value specified in param-value | Default value | Recommended param-name value
user.env.variable.m | Specifies the name and value of the environment variable used to start the server, in the format variable-name=value.# | None | user.env.variable

#

To specify multiple values, specify multiple <param-value>.

Also, to enable a parameter, add '.' at the beginning of the string. If you want to disable a parameter, add '#' at the beginning of the string.

(Example)

<param-name>user.env.variable.m</param-name>

<param-value>.AAA=XXX</param-value>

<param-value>#BBB=XXX</param-value>

Appendix C.2 Parameters that can be specified in the logical Web server (For compatibility)

The following table lists and describes the compatibility parameters that can be specified in common for the logical Web servers. In the table below, Default value means the value that is assumed when the parameter is not specified. Recommended value of param-name is the recommended parameter corresponding to the parameters for compatibility.

Table C-2 Parameters that can be specified in the logical Web servers (for compatibility)

Value of param-name
Value specified in param-value
Default value
Recommended param-name value

JkGatewayHost.value
Specifies the gateway host name in less than 255 characters.
None
JkGatewayHost

JkGatewayPort.value
Specifies the gateway port number in a range from 1 to 65535.
None
JkGatewayPort

Listen.host.value
Specifies whether or not to assign the Web server to a specific address when multiple addresses are assigned to one machine.
true: Allocated.
false: Not allocated.
false
Listen

Port
Specifies the port number of the server that receives requests from the Web browser in the range from 1 to 65535.
80
Listen

urlmap.m
Specifies the pattern of the URLs to which requests will be distributed when the redirector distributes requests to the J2EE server.#
In urlmap.m, you can specify the URL specified in the JkMount key of the mod_jk.conf file .
./* (all requests are targets)
JkMount

worker.cachesize
Specifies the number of worker connections to be reused by the redirector in a range from 1 to 2147483647​.
64
worker.worker-name.cachesize

worker.receive_timeout
Specifies the communication timeout value for the worker connection to be reused by the redirector, in the range from 0 to 3600 (unit: seconds).
3600
worker. worker-name.receive_timeout

#

To specify multiple values, specify multiple <param-value>.

Also, to enable a parameter, add '.' at the beginning of the string. If you want to disable a parameter, add '#' at the beginning of the string.

(Example)

<param-name>urlmap.m</param-name>

<param-value>.ssss</param-value>

<param-value>#rrrr</param-value>

Appendix C.3 Parameters that can be specified in the logical J2EE server (For compatibility)

The following table lists and describes the compatibility parameters that can be specified in common for the logical J2EE server. In the table below, Default value means the value that is assumed when the parameter is not specified. Recommended value of param-name is the recommended parameter corresponding to the parameters for compatibility.

Table C-3 Parameters that can be specified in the logical J2EE server (for compatibility) (often used keys)

Value of param-name
Contents
Specifiable value
Default value
VR

mngagent.vbroker.se.iiop_tp.host.value
Specifies whether to fix the Management Agent host of the J2EE container. Specify one of the following values:

true:

The host will be fixed.

false:

The host will not be fixed.

Specify one of the following values:

true

false

false
06-50
07-00

mngagent.vbroker.se.iiop_tp.scm.iiop_tp.listener.port.value
Specifies the Management Agent port number of the J2EE container in the range from 0 to 65535.
0 indicates Automatic.
Specify the value using an integer from 0 to 65535.
0
06-50
07-00

Table C-4 Parameters that can be specified in the logical J2EE server (for compatibility)

Value of param-name
Value specified in param-value
Default value
Recommended param-name value

add.jvm.arg.m
Sets up the extension startup parameter.
Specifies the JavaVM options that can be specified when you start JavaVM.#1
None
add.jvm.arg

ejbserver.manager.jp1event.enabled
Specifies whether to enable the JP1 event issuing functionality.
true: Enable
false: Disable
false
ejbserver.manager.agent.JP1EventAgent.enabled

ejbserver.rmi.naming.host.value
Specifies the host of the RMI registry and MBean server that the J2EE server uses in the multi-homed host environment.

true:

The host name or IP address that can reference the network of the host defined in "management domain configuration definition" is set up.

false:

The host name or IP address is not set up.

etc:

The loopback address (localhost) is set up.

false
ejbserver.rmi.naming.host

ex.param.m
Specifies the J2EE server extension parameter in any option #1 used in the J2EE server.
None
ex.param

ex.properties.m
Specifies the JavaVM system properties. #1
None
ex.properties

http
Specifies the port number of the simple Web server in a range from 1 to 65535.
8080
ejbserver.http.port

inprocess.ns.port
Specifies the port number for the in-process naming service in the range from 1 to 65535.
900
ejbserver.naming.startupMode,ejbserver.naming.host,ejbserver.naming.port

inprocess.ns.retryCount
Specifies the retry count to wait for the in-process naming service to start completely in the range from 0 to 2147483647​.
9
ejbserver.naming.startupRetryCount

inprocess.ns.waitTime
Specifies the waiting time for the in-process naming service to start completely in the range from 0 to 2147483647​ (unit: seconds).
1
ejbserver.naming.startupWaitTime

jndi.rr.ns.list
Specifies the group name and the group members of a round-robin search. Group-name = member-name-1[; member-name-2] #2

Note

Specify CTM, J2EE server, or logical server name of the naming service as the member name.

None
ejbserver.jndi.namingservice.group.list

jvm.ms.size
Specifies the initial size of memory required for JavaVM in a range from 0 to 9999999999​ (unit: megabytes).
Specify a value which consists of the relationship jvm.ms.size jvm.mx.size.
256
add.jvm.arg

jvm.mx.size
Specifies the maximum size of memory required for JavaVM in a range from 0 to 9999999999​ (unit: megabyte).
Specify a value which consists of the relationship jvm.ms.size jvm.mx.size.
512
add.jvm.arg

LogFile.Console.filenum
Specifies the number of console log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ConsoleLogFile.filenum

LogFile.Console.filesize
Specifies the size of a console log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ConsoleLogFile.filesize

LogFile.EJBContainer.filenum
Specifies the number of EJB container maintenance log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.EJBContainerLogFile.filenum

LogFile.EJBContainer.filesize
Specifies the size of an EJB container maintenance log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.EJBContainerLogFile.filesize

LogFile.Exception.filenum
Specifies the number of exception log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ExceptionLogFile.filenum

LogFile.Exception.filesize
Specifies the size of an exception log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ExceptionLogFile.filesize

LogFile.Maintenance.filenum
Specifies the number of maintenance log files.
You can specify 1, 2, 4, 8, and 16.
4
ejbserver.logger.channels.define.MaintenanceLogFile.filenum

LogFile.Maintenance.filesize
Specifies the size of a maintenance log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
16777216​
ejbserver.logger.channels.define.MaintenanceLogFile.filesize

LogFile.Message.filenum
Specifies the number of message log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.MessageLogFile.filenum

LogFile.Message.filesize
Specifies the size of a message log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.MessageLogFile.filesize

LogFile.UserErr.filenum
Specifies the number of user error log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.UserErrLogFile.filenum

LogFile.UserErr.filesize
Specifies the size of a user error log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.UserErrLogFile.filesize

LogFile.UserOut.filenum
Specifies the number of user output log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.UserOutLogFile.filenum

LogFile.UserOut.filesize
Specifies the size of a user output log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.UserOutLogFile.filesize

LogFile.WebAccess.filenum
Specifies the number of Web Container trace log files.
You can specify 1, 2, 4, 8, and 16.
16
ejbserver.logger.channels.define.WebAccessLogFile.filenum

LogFile.WebAccess.filesize
Specifies the size of a Web Container trace log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
4194304​
ejbserver.logger.channels.define.WebAccessLogFile.filesize

LogFile.WebContainer.filenum
Specifies the number of Web Container maintenance log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.WebContainerLogFile.filenum

LogFile.WebContainer.filesize
Specifies the size of a Web Container maintenance log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.WebContainerLogFile.filesize

LogFile.WebServlet.filenum
Specifies the number of Web servlet log files.
You can specify 1, 2, 4, 8, and 16.
4
ejbserver.logger.channels.define.WebServletLogFile.filenum

LogFile.WebServlet.filesize
Specifies the size of a Web servlet log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
4194304​
ejbserver.logger.channels.define.WebServletLogFile.filesize

loglevel
Specifies the log output level.
Error: Normal operations
Error,Warning: Normal operations (verbose)
Error,Warning,Information: During testing
Error,Warning,Information,Debug: Troubleshooting
Error
ejbserver.logger.enabled. #

manager.mevent.sender.bind.host.value
Specifies whether to fix the local address of the Management event issuing functionality.
true: The address is fixed.
false: The address is not fixed.
false
manager.mevent.sender.bind.host

mngagent.connector.host.value
Specifies whether to fix the Management Agent host of the J2EE container.
true: The host is fixed
false: The host is not fixed
false
mngagent.connector.host

mngagent.connector.port.value
Specifies the Management Agent port number of the J2EE container in the range from 0 to 65535.
0 indicates Automatic.
0 (automatic)
mngagent.connector.port

mngagent.vbroker.se.iiop_tp.host.value
Specifies whether to fix the Management Agent host of the J2EE container.
true: The host is fixed
false: The host is not fixed
false
mngagent.connector.host

mngagent.vbroker.se.iiop_tp.scm.iiop_tp.listener.port.value
Specifies the Management Agent port number of the J2EE container in the range from 0 to 65535.
0 indicates Automatic.
0 (automatic)
mngagent.connector.port

vbroker.se.iiop_tp.host.value
Specifies whether to fix the host in the EJB container.
true: The host is fixed
false: The host is not fixed
etc: Receive the connection for the loopback address (localhost).
false
vbroker.se.iiop_tp.host

WatchFile.ConnectionPool.filenum
Specifies the number of monitoring result output files for the connection pool.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filenum

WatchFile.ConnectionPool.filesize
Specifies the size of a monitoring result output file for the connection pool in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ConnectionPoolWatchLogFile.filesize

WatchFile.FileDescriptor.filenum
Specifies the number of monitoring result output files for the file descriptors.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filenum

WatchFile.FileDescriptor.filesize
Specifies the size of the monitoring result output file for the file descriptors in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filesize

WatchFile.HttpSession.filenum
Specifies the number of monitoring result output files for the HTTP sessions.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.HttpSessionWatchLogFile.filenum

WatchFile.HttpSession.filesize
Specifies the size of the monitoring result output file for the HTTP sessions in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.HttpSessionWatchLogFile.filesize

WatchFile.Memory.filenum
Specifies the number of monitoring result output files for memory.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.MemoryWatchLogFile.filenum

WatchFile.Memory.filesize
Specifies the size of the monitoring result output file for memory in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.MemoryWatchLogFile.filesize

WatchFile.RequestQueue.filenum
Specifies the number of monitoring result output files for each Web container, Web application, and the default HTTP request pending queue.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.RequestQueueWatchLogFile.filenum

WatchFile.RequestQueue.filesize
Specifies the size of monitoring result output file for each Web container, Web application, and the default HTTP request pending queue in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.RequestQueueWatchLogFile.filesize

WatchFile.Thread.filenum
Specifies the number of monitoring result output files for threads.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ThreadWatchLogFile.filenum

WatchFile.Thread.filesize
Specifies the size of the monitoring result output file for threads in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ThreadWatchLogFile.filesize

WatchFile.Threaddump.filenum
Specifies the number of monitoring result output files for the thread dump files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filenum

WatchFile.Threaddump.filesize
Specifies the size of the monitoring result output file for the thread dump files in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filesize

webserver.connector.ajp13.bind_host.value
Specifies whether to fix the host in the settings for connecting the Web container to the Web server.
true: The host is fixed.
false: The host is not fixed.
etc: Connection is received for the loopback address (localhost).
false
webserver.connector.ajp13.bind_host

webserver.connector.http.bind_host.value
Specifies whether to fix the host in the settings for the Web container management server (Simple Web server).
true: The host is fixed.
false: The host is not fixed.
false
webserver.connector.http.bind_host

webserver.sfo.sfo_server.server-definition-name-of-SFO-filter.serverName
Specifies the SFO server name associated with the server definition name of the SFO filter using 128 or less characters.
None
webserver.sfo.sfo_server.server-definition-name-of-SFO-filter.naming

#1

To specify multiple values, specify multiple <param-value>.

Also, to enable a parameter, add '.' at the beginning of the string. If you want to disable a parameter, add '#' at the beginning of the string.

(Example)

<param-name>ex.param.m</param-name>

<param-value>.ssss</param-value>

<param-value>#rrrr</param-value>

#2

To specify multiple values in param-value, use comma (, ) as the delimiter.

(Example) <param-value> value 1, value 2, value 3 <param-value>

Appendix C.4 Parameters that can be specified in the logical SFO server (For compatibility)

The following table lists and describes the compatibility parameters that can be specified in common for the logical SFO server. In the table below, Default value means the value that is assumed when the parameter is not specified. Recommended value of param-name is the recommended parameter corresponding to the parameters for compatibility.

Table C-5 Parameters that can be specified in the logical SFO server (for compatibility)

Value of param-name
Value specified in param-value
Default value
Recommended param-name value

add.jvm.arg.m
Sets up the extension startup parameter.
Specifies the JavaVM options that can be specified when you start JavaVM.#
None
add.jvm.arg

ejbserver.rmi.naming.host.value
Specifies the host of the RMI registry and MBean server used by the SFO server in the multi-homed host environment.
true: The host name or IP address that can reference the network of the host defined in "management domain configuration definition" is set up.
false: The host name or IP address is not set up.
etc: The loopback address (localhost) is set up.
false
ejbserver.rmi.naming.host

ex.param.m
Specifies the SFO server extension parameter in any option #1 used in the SFO server.
None
ex.param

ex.properties.m
Specifies the JavaVM system properties.#
None
ex.properties

http
Specifies the port number of the simple Web server in a range from 1 to 65535.
8080
ejbserver.http.port

inprocess.ns.port
Specifies the port number for the in-process naming service in the range from 1 to 65535.
900
ejbserver.naming.port

jvm.ms.size
Specifies the initial size of memory required for JavaVM in a range from 0 to 9999999999​ (unit: megabytes).
Specify a value which consists of the relationship jvm.ms.size jvm.mx.size.
128
add.jvm.arg

jvm.mx.size
Specifies the maximum size of memory required for JavaVM in a range from 0 to 9999999999​ (unit: megabyte).
Specify a value which consists of the relationship jvm.ms.size jvm.mx.size.
128
add.jvm.arg

LogFile.Console.filenum
Specifies the number of console log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ConsoleLogFile.filenum

LogFile.Console.filesize
Specifies the size of a console log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ConsoleLogFile.filesize

LogFile.EJBContainer.filenum
Specifies the number of EJB container maintenance log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.EJBContainerLogFile.filenum

LogFile.EJBContainer.filesize
Specifies the size of an EJB container maintenance log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.EJBContainerLogFile.filesize

LogFile.Exception.filenum
Specifies the number of exception log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ExceptionLogFile.filenum

LogFile.Exception.filesize
Specifies the size of an exception log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ExceptionLogFile.filesize

LogFile.Maintenance.filenum
Specifies the number of maintenance log files.
You can specify 1, 2, 4, 8, and 16.
4
ejbserver.logger.channels.define.MaintenanceLogFile.filenum

LogFile.Maintenance.filesize
Specifies the size of a maintenance log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
16777216​
ejbserver.logger.channels.define.MaintenanceLogFile.filesize

LogFile.Message.filenum
Specifies the number of message log files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.MessageLogFile.filenum

LogFile.Message.filesize
Specifies the size of a message log file in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.MessageLogFile.filesize

loglevel
Specifies the log output level.
Error: Normal operations
Error,Warning: Normal operations (verbose)
Error,Warning,Information: During testing
Error,Warning,Information,Debug: Troubleshooting
Error
ejbserver.logger.enabled.#

manager.mevent.sender.bind.host.value
Specifies whether to fix the local address of the Management event issuing functionality.
true: The host is fixed.
false: The host is not fixed.
false
manager.mevent.sender.bind.host

mngagent.connector.host.value
Specifies whether to fix the Management Agent host of the J2EE container.
true: The host is fixed.
false: The host is not fixed.
false
mngagent.connector.host

mngagent.connector.port.value
Specifies the Management Agent port number of the J2EE container in the range from 0 to 65535.
0 indicates Automatic.
0 (automatic)
mngagent.connector.port

vbroker.se.iiop_tp.host.value
Specifies whether to fix the host in the EJB container.
true: The host is fixed.
false: The host is not fixed.
etc: Connection is received for the loopback address (localhost).
false
vbroker.se.iiop_tp.host

WatchFile.FileDescriptor.filenum
Specifies the number of monitoring result output files for the file descriptors.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filenum

WatchFile.FileDescriptor.filesize
Specifies the size of the monitoring result output file for the file descriptors in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.FileDescriptorWatchLogFile.filesize

WatchFile.Memory.filenum
Specifies the number of monitoring result output files for memory.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.MemoryWatchLogFile.filenum

WatchFile.Memory.filesize
Specifies the size of the monitoring result output file for memory in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.MemoryWatchLogFile.filesize

WatchFile.Thread.filenum
Specifies the number of monitoring result output files for threads.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ThreadWatchLogFile.filenum

WatchFile.Thread.filesize
Specifies the size of the monitoring result output file for threads in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ThreadWatchLogFile.filesize

WatchFile.Threaddump.filenum
Specifies the number of monitoring result output files for the thread dump files.
You can specify 1, 2, 4, 8, and 16.
2
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filenum

WatchFile.Threaddump.filesize
Specifies the size of the monitoring result output file for the thread dump files in bytes.
You can specify 4096, 65536, 262144, 524288, 1048576​, 2097152​, 4194304​, 16777216​, and 67108864​.
1048576​
ejbserver.logger.channels.define.ThreaddumpWatchLogFile.filesize

webserver.connector.ajp13.bind_host.value
Specifies whether to fix the host in the settings for connecting the Web container to the Web server.
true: The host is fixed.
false: The host is not fixed.
etc: Connection is received for the loopback address (localhost).
false
webserver.connector.ajp13.bind_host

webserver.connector.http.bind_host.value
Specifies whether to fix the host in the settings for the Web container management server (Simple Web server).
true: The host is fixed.
false: The host is not fixed.
false
webserver.connector.http.bind_host

#

To specify multiple values, specify multiple <param-value>.

Also, to enable a parameter, add '.' at the beginning of the string. If you want to disable a parameter, add '#' at the beginning of the string.

(Example)

<param-name>ex.param.m</param-name>

<param-value>.ssss</param-value>

<param-value>#rrrr</param-value>

Index

[Symbols]
[A][B][C][D][E][F][G][H][I][J][K][L][M][O][P][Q][R][S][T][U][V][W]

(Symbols)

.cmxrc

.mngsvrmonitorrc

mngsvrmonitor.browser

mngsvrmonitor.connect.host

.mngsvrutilrc

mngsvrutil.connect.host

mngsvrutil.connect.password

mngsvrutil.connect.userid

mngsvrutil.output.file

mngsvrutil.output.format

mngsvrutil.output.suppress_header

mngsvrutil.target_kind

mngsvrutil.target_name

mngsvrutil.target_server_name

-XX:[+|-]HitachiExplicitMemoryAutoRefReclaim

-XX:[+|-]ExplicitMemoryUseExcludeClass

-xx:[+|-]hitachiautoexplicitmemory

-XX:[+|-]HitachiCommaVerboseGC

-xx:[+|-]hitachiexplicitmemoryautoreclaim

-xx:[+|-]hitachiexplicitmemorycompatibletov8

-xx:[+|-]hitachiexplicitmemorymovetotenuredfirst

-XX:[+|-]HitachiFullCore

-XX:[+|-]HitachiJavaClassLibTrace

-XX:[+|-]HitachiJavaLogNoMoreOutput

-XX:[+|-]HitachiLocalsInStackTrace

-XX:[+|-]HitachiLocalsInThrowable

-XX:[+|-]HitachiLocalsSimpleFormat

-XX:[+|-]HitachiOutOfMemoryAbort

-XX:[+|-]HitachiOutOfMemoryAbortThreadDump

-xx:[+|-]hitachioutofmemoryabortthreaddumpwithjheapprof

-XX:[+|-]HitachiOutOfMemoryCause

-XX:[+|-]HitachiOutOfMemoryHandling

-XX:[+|-]HitachiOutOfMemorySize

-XX:[+|-]HitachiOutOfMemoryStackTrace

-XX:[+|-]HitachiReserveSwapSpace

-XX:[+|-]HitachiThreadDump

-XX:[+|-]HitachiThreadDumpToStdout

-XX:[+|-]HitachiThreadDumpWithBlockCount

-XX:[+|-]HitachiThreadDumpWithCpuTime

-XX:[+|-]HitachiThreadDumpWithHashCode

-XX:[+|-]HitachiTrueTypeInLocals

-XX:[+|-]HitachiUseExplicitMemory

-XX:[+|-]HitachiVerboseGCPrintJVMInternalMemory

-XX:[+|-]HitachiVerboseGC

-XX:[+|-]HitachiVerboseGCCpuTime

-XX:[+|-]HitachiVerboseGCPrintCause

-XX:[+|-]HitachiVerboseGCPrintDate

-XX:[+|-]HitachiVerboseGCPrintDeleteOnExit

-xx:[+|-]hitachiverbosegcprinttenuringdistribution

-XX:[+|-]HitachiVerboseGCPrintThreadCount

-XX:[+|-]JITCompilerContinuation

-XX:[+|-]PrintCodeCacheFullMessage

-XX:[+|-]PrintCodeCacheInfo

-XX:[+|-]HitachiOutputMilliTime

-XX:+Hitachi

-XX:CodeCacheInfoPrintRatio

-XX:ExplicitMemoryExcludeClassListFile

-XX:ExplicitMemoryFullGCPolicy

-XX:ExplicitMemoryNotExcludeClassListFile

-xx:hitachiautoexplicitmemoryfile

-XX:HitachiCallToString

-XX:HitachiExplicitHeapMaxSize

-XX:HitachiExplicitMemoryJavaLog

-XX:HitachiExplicitMemoryJavaLogFileSize

-XX:HitachiExplicitMemoryJavaLogNumberOfFile

-XX:HitachiExplicitMemoryLogLevel

-XX:HitachiJavaClassLibTraceLineSize

-XX:HitachiJavaLog

-XX:HitachiJavaLogFileSize

-XX:HitachiJavaLogNumberOfFile

-XX:HitachiJITCompileMaxMemorySize

-XX:HitachiOutOfMemoryHandlingMaxThrowCount

-XX:HitachiOutOfMemoryStackTraceLineSize

-XX:HitachiThreadLimit

-XX:HitachiVerboseGCIntervalTime

(A)

add.class.path (key for option definition file for administration agent)

add.class.path (Key for batch applications)

add.class.path (Key for batch servers)

add.class.path (Key for Java applications)

add.class.path (Option for J2EE servers)

add.class.path (option for J2EE servers)

add.jvm.arg (key for option definition file for administration agent)

add.jvm.arg (Key for batch applications)

add.jvm.arg (Key for batch servers)

add.jvm.arg (Key for Java applications)

add.jvm.arg (Option for J2EE servers)

add.jvm.arg (option for J2EE servers)

add.library.path (key for option definition file for administration agent)

add.library.path (Key for batch servers)

add.library.path (Key for Java applications)

add.library.path (Option for J2EE servers)

add.library.path (option for J2EE servers)

add.network.drive (key for option definition file for administration agent)

add.env [Key for Management Server environment variable definition file]

additional.startcmd

admin.logger.exceptionlogfile.filenum (key for management command properties file)

admin.logger.exceptionlogfile.filepath (key for management command properties file)

admin.logger.exceptionlogfile.filesize (key for management command properties file)

admin.logger.messagelogfile.filenum (key for management command properties file)

admin.logger.messagelogfile.filepath (key for management command properties file)

admin.logger.messagelogfile.filesize (key for management command properties file)

admin.logger.messagelogfile.trace.level (key for management command properties file)

adminagent.server type.usr_cmd.abnormal_end (key for administration agent property file)

adminagent.adapter.allowedHosts (Key for Administration Agent property file)

adminagent.adapter.bind_host [Key for Administration Agent property file]

adminagent.adapter.port [Key for Administration Agent property file]

adminagent.cluster.localaddress.check [Key for Administration Agent property file]

adminagent.connector.comm.state.cache_max_time

adminagent.finalization.stop_servers [Key for Administration Agent property file]

adminagent.forcestop.threaddump.interval [Key for Administration Agent property file]

adminagent.forcestop.threaddump.timeout [Key for Administration Agent property file]

adminagent.forcestop.threaddump [Key for Administration Agent property file]

adminagent.hws.group (key for administration agent property file)

adminagent.hws.owner (key for administration agent property file)

adminagent.hws.sys_cmd.abnormal_end.traceinfo [Key for Administration Agent property file]

adminagent.hws.watch.method [Key for Administration Agent property file]

adminagent.hws.watch.url [Key for Administration Agent property file]

adminagent.j2ee.process.console_event.enabled [Key for Administration Agent property file]

adminagent.j2ee.process.console_log.enabled [Key for Administration Agent property file]

adminagent.j2ee.sys_cmd.abnormal_end.javatrace [Key for Administration Agent property file]

adminagent.j2ee.sys_cmd.abnormal_end.threaddump [Key for Administration Agent property file]

adminagent.jp1event.event_server_name [Key for Administration Agent property file]

adminagent.jp1event_enabled [Key for Administration Agent property file]

adminagent.log.filenum [Key for Administration Agent property file]

adminagent.log.filesize [Key for Administration Agent property file]

adminagent.log.level [Key for Administration Agent property file]

adminagent.lsinfo_dir [Key for Administration Agent property file]

adminagent.maintenance.log.filenum [Key for Administration Agent property file]

adminagent.maintenance.log.filesize [Key for Administration Agent property file]

adminagent.prftrace_dir (Key for Administration Agent property file)

adminagent.process.consolelog.enabled [Key for Administration Agent property file]

adminagent.process.consolelog.event.queue_size [Key for Administration Agent property file]

adminagent.process.consolelog.filenum [Key for Administration Agent property file]

adminagent.process.consolelog.filesize [Key for Administration Agent property file]

adminagent.process.consolelog.style [Key for Administration Agent property file]

adminagent.process.consolelog.time [Key for Administration Agent property file]

adminagent.properties

adminagent.rmi.log.filenum [Key for Administration Agent property file]

adminagent.rmi.log.filesize [Key for Administration Agent property file]

adminagent.rmi.log.level [Key for Administration Agent property file]

adminagent.server-type.watch.interval [Key for Administration Agent property file]

adminagent.server-type.watch.level [Key for Administration Agent property file]

adminagent.server-type.watch.retry_count [Key for Administration Agent property file]

adminagent.server-type.watch.start_time [Key for Administration Agent property file]

adminagent.server-type.watch.timeout [Key for Administration Agent property file]

adminagent.snapshotlog.listfile.2.num_snapshots [Key for Administration Agent property file]

adminagent.snapshotlog.log_dir [Key for Administration Agent property file]

adminagent.snapshotlog.num_snapshots [Key for Administration Agent property file]

adminagent.sys_cmd.abnormal_end.prftrace [Key for Administration Agent property file]

adminagent.userserver.process.console_event.enabled [Key for Administration Agent property file]

adminagent.userserver.process.console_log.enabled [Key for Administration Agent property file]

adminagent.watch.retry_timeout.enabled [Key for Administration Agent property file]

adminagent.xml

AdminAgentrc

adminagentuser.cfg

Administration Agent

option definition file

property file

setting file

AllText

AppendDirectives

(B)

batch.ctm.enabled (Key for batch applications)

batch.log.directory (Key for batch applications)

batch.log.lockInterval (Key for batch applications)

batch.log.lockRetryCount (Key for batch applications)

batch.log.maintenance.filenum (Key for batch applications)

batch.log.maintenance.filesize (Key for batch applications)

batch.log.message.filenum (Key for batch applications)

batch.log.message.filesize (Key for batch applications)

batch.log.stdout.enabled (Key for batch applications)

batch.request.timeout (Key for batch applications)

batch.schedule.group.name (Key for batch applications)

batch.service.enabled (Key for batch servers)

batch.service.enabled (option for J2EE servers)

batch.vbroker.agent.addr (Key for batch applications)

batch.vbroker.agent.port (Key for batch applications)

batch applications

option definition file

user property file

batch servers

file

key for customization

list of files

option definition file

security policy file

user property file

broker.logger.exceptionlogfile.filenum (key for cjmsp broker individual properties file)

broker.logger.exceptionlogfile.filenum (key for common properties file of cjmsp broker)

broker.logger.exceptionlogfile.filesize (key for cjmsp broker individual properties file)

broker.logger.exceptionlogfile.filesize (key for common properties file of cjmsp broker)

broker.logger.messagelogfile.filenum (key for cjmsp broker individual properties file)

broker.logger.messagelogfile.filenum (key for common properties file of cjmsp broker)

broker.logger.messagelogfile.filesize (key for cjmsp broker individual properties file)

broker.logger.messagelogfile.filesize (key for common properties file of cjmsp broker)

broker.logger.messagelogfile.trace.level (key for cjmsp broker individual properties file)

broker.logger.messagelogfile.trace.level (key for common properties file of cjmsp broker)

(C)

cjmsp broker individual properties file

client setting properties file

cmxclient.properties

cmxserver.properties

com.cosminexus.manager.cmdtracelog.fnum [Key for maganer setting file]

com.cosminexus.manager.cmdtracelog.size [Key for maganer setting file]

com.cosminexus.manager.log.compatible [Key for maganer setting file]

com.cosminexus.manager.log.dir [Key for maganer setting file]

com.cosminexus.manager.messagelog.fnum [Key for maganer setting file]

com.cosminexus.manager.messagelog.size [Key for maganer setting file]

com.cosminexus.manager.messagelog.style [Key for maganer setting file]

com.cosminexus.manager.messagelog.time [Key for maganer setting file]

com.cosminexus.manager.tracelog.fnum [Key for maganer setting file]

com.cosminexus.manager.tracelog.size [Key for maganer setting file]

com.cosminexus.manager.tracelog.style (Key for Manager setup file)

com.cosminexus.manager.tracelog.time (Key for Manager setup file)

com.cosminexus.mngsvr.compat.operation_app [key for Management Server environment setting file]

com.cosminexus.mngsvr.jp1event.alert

com.cosminexus.mngsvr.jp1event.critical

com.cosminexus.mngsvr.jp1event.emergency

com.cosminexus.mngsvr.jp1event.enabled

com.cosminexus.mngsvr.jp1event.error

com.cosminexus.mngsvr.jp1event.information

com.cosminexus.mngsvr.jp1event.notice

com.cosminexus.mngsvr.jp1event.warning

com.cosminexus.mngsvr.log.display_number

com.cosminexus.mngsvr.log.level

com.cosminexus.mngsvr.log.rotate

com.cosminexus.mngsvr.log.size

com.cosminexus.mngsvr.logical_server_abnormal_stop.exit (key for management server environment setting file)

com.cosminexus.mngsvr.maintenance.log.filenum

com.cosminexus.mngsvr.maintenance.log.filesize

com.cosminexus.mngsvr.management.connector.enabled (key for management server environment setting file)

com.cosminexus.mngsvr.management.enabled (key for management server environment setting file)

com.cosminexus.mngsvr.management.host (key for management server environment setting file)

com.cosminexus.mngsvr.management.listen.port (key for management server environment setting file)

com.cosminexus.mngsvr.management.port (key for management server environment setting file)

com.cosminexus.mngsvr.management.read_timeout (key for management server environment setting file)

com.cosminexus.mngsvr.management.read_timeout (key for management server environment setting file)

com.cosminexus.mngsvr.management_user_account.enabled (key for management server environment setting file)

com.cosminexus.mngsvr.on_start

com.cosminexus.mngsvr.snapshot.auto_collect.enabled

com.cosminexus.mngsvr.snapshot.auto_collect.timeout [key for Management Server environment setting file]

com.cosminexus.mngsvr.snapshot.collect.point

com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabled

com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeout

com.cosminexus.mngsvr.trace

com.cosminexus.mngsvr.upload_app.directory [key for Management Server environment setting file]

com.cosminexus.mngsvr.upload_app.enabled [key for Management Server environment setting file]

com.cosminexus.mngsvr.upload_app.maxsize [key for Management Server environment setting file]

com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabled

com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeout

com.cosminexus.mngsvr.vmi.enabled [key for Management Server environment setting file]

com.cosminexus.mngsvr.vmx.enabled [key for Management Server environment setting file]

common client setting properties file

config.properties

configuration change definition file

for adding service unit or host

for changing logical server parameters

specifiable tags in

configuration change definition files

connect_timeout

connection_sharing

CoreDumpDirectory

Correspondence between server to be used and references of parameters to be specified

cosminexus.jpa.cache.size.default

cosminexus.jpa.cache.size.ENTITY

cosminexus.jpa.cache.type.default

cosminexus.jpa.cache.type.ENTITY

cosminexus.jpa.exception.logging.sql (Key for customizing J2EE servers)

cosminexus.jpa.logging.level.operation.category (Key for customizing J2EE servers)

cosminexus.jpa.pessimistic-lock

cosminexus.jpa.target-database

Cosminexus JPA provider-specific properties

cpp.library.version (Key for batch servers)

cpp.library.version (Key for Java applications)

cpp.library.version (Option for J2EE servers)

cpp.library.version (option for J2EE servers)

criticalList.cfg

criticalList.cfg

CTM

file

file

CTM command option file

CTM user environment variable definition file

CustomDivideFileNum

CustomDivideTimeDifference

CustomDivideTimeInterval

CustomWraparoundFileNum

CustomWraparoundFilesize

(D)

datasourcefulljtatable

datasourcetable

Definition of host

Definition of host

Definition of physical tier

Definition of service unit

Definition of service unit

Definition of Web system attributes

Definition of Web system attributes

definition file

client-side of mngsvrutil command

client-side shared of mngsvrutil command

logical user server

Management Server management file

server-side of mngsvrutil command

snapshot log collection

DocumentRoot

(E)

Easy Setup definition file

specifiable tags in

Easy Setup definition file

ejb.client.directory.shareable (Key for Java applications)

ejb.client.ejb.log (Key for Java applications)

ejb.client.log.appid (Key for Java applications)

ejb.client.log.directory (Key for Java applications)

ejb.client.log.stdout.enabled (Key for Java applications)

ejb.public.directory (Key for batch servers)

ejb.public.directory (Option for J2EE servers)

ejb.public.directory (option for J2EE servers)

ejb.server.corefilenum (Key for batch servers)

ejb.server.corefilenum (Option for J2EE servers)

ejb.server.corefilenum (option for J2EE servers)

ejb.server.log.directory (Key for batch servers)

ejb.server.log.directory (Option for J2EE servers)

ejb.server.log.directory (option for J2EE servers)

ejb.server.log.mode (Key for batch servers)

ejb.server.log.mode (Option for J2EE servers)

ejb.server.log.mode (option for J2EE servers)

ejb.server.log.stderr.filesize (Key for batch servers)

ejb.server.log.stderr.filesize (Option for J2EE servers)

ejb.server.log.stderr.filesize (option for J2EE servers)

ejb.server.log.stdout.filesize (Key for batch servers)

ejb.server.log.stdout.filesize (Option for J2EE servers)

ejb.server.log.stdout.filesize (option for J2EE servers)

ejbapplicationtable

ejbserver.application.InitTermProcessClasses (Key for batch servers)

ejbserver.application.InitTermProcessClasses(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name.appname [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.appname (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.appname(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name.autoFlush.enabled [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.count [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.count (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.count(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name.encoding [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.encoding (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.encoding(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name.filter [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.filter (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.filter(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.formatter [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.formatter (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.formatter(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.level [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.level (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.level(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.limit [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.limit (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.limit(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.msgid [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.msgid (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.msgid(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.path [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.path (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.path(Key for customizing J2EE servers)

ejbserver.application.userlog.CJLogHandler.handler-name;.separator [Java application]

ejbserver.application.userlog.CJLogHandler.handler-name.separator (Key for batch servers)

ejbserver.application.userlog.CJLogHandler.handler-name.separator(Key for customizing J2EE servers)

ejbserver.application.userlog.Logger.logger-name.filter [Java application]

ejbserver.application.userlog.Logger.logger-name.filter (Key for batch servers)

ejbserver.application.userlog.Logger.logger-name.filter(Key for customizing J2EE servers)

ejbserver.application.userlog.Logger.logger-name.handlers [Java application]

ejbserver.application.userlog.Logger.logger-name.handlers (Key for batch servers)

ejbserver.application.userlog.Logger.logger-name.handlers(Key for customizing J2EE servers)

ejbserver.application.userlog.Logger.logger-name.level [Java application]

ejbserver.application.userlog.Logger.logger-name.level (Key for batch servers)

ejbserver.application.userlog.Logger.logger-name.level(Key for customizing J2EE servers)

ejbserver.application.userlog.Logger.logger-name.useParentHandler(Key for customizing J2EE servers)

ejbserver.application.userlog.Logger.logger-name.useParentHandlers [Java application]

ejbserver.application.userlog.Logger.logger-name.useParentHandlers (Key for batch servers)

ejbserver.application.userlog.loggers [Java application]

ejbserver.application.userlog.loggers (Key for batch servers)

ejbserver.application.userlog.loggers(Key for customizing J2EE servers)

ejbserver.batch.application.exit.enabled (Key for batch servers)

ejbserver.batch.gc.watch.threshold (Key for batch servers)

ejbserver.batch.queue.length (Key for batch servers)

ejbserver.batch.schedule.group.name (Key for batch servers)

ejbserver.client.ctm.RequestPriority

ejbserver.client.ctm.RequestPriority [Java application]

ejbserver.client.ctm.RequestPriority (Key for batch applications)

ejbserver.client.ctm.RequestPriority (Key for batch servers)

ejbserver.client.ejb.log [Java application]

ejbserver.client.log.appid [Java application]

ejbserver.client.log.directory [Java application]

ejbserver.client.log.lockInterval [Java application]

ejbserver.client.log.lockRetryCount [Java application]

ejbserver.client.transaction.clientName [Java application]

ejbserver.client.transaction.enabled [Java application]

ejbserver.commonj.workmanager.non_daemon_work_threads (key for customizing j2ee servers)

ejbserver.compiler.jvm.maxHeapSize

ejbserver.compiler.jvm.maxHeapSize(Key for customizing J2EE servers)

ejbserver.compiler.jvm.minHeapSize

ejbserver.compiler.jvm.minHeapSize(Key for customizing J2EE servers)

ejbserver.connectionpool.applicationAuthentication.disabled (Key for batch servers)

ejbserver.connectionpool.applicationAuthentication.disabled (Key for customizing J2EE servers)

ejbserver.connectionpool.applicationAuthentication.disabled(Key for customizing J2EE servers)

ejbserver.connectionpool.association.enabled (Key for batch servers)

ejbserver.connectionpool.association.enabled(Key for customizing J2EE servers)

ejbserver.connectionpool.association.enabledDespiteUnshareableSetting (Key for customizing J2EE servers)

ejbserver.connectionpool.association.enabledDespiteUnshareableSetting(Key for customizing J2EE servers)

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled (Key for batch servers)

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled (Key for customizing J2EE servers)

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled(Key for customizing J2EE servers)

ejbserver.connectionpool.validation.timeout (Key for batch servers)

ejbserver.connectionpool.validation.timeout(Key for customizing J2EE servers)

ejbserver.connector.logwriter.filenum (Key for batch servers)

ejbserver.connector.logwriter.filenum(Key for customizing J2EE servers)

ejbserver.connector.logwriter.filesize (Key for batch servers)

ejbserver.connector.logwriter.filesize(Key for customizing J2EE servers)

ejbserver.connector.statementpool.clear.backcompat(Key for customizing J2EE servers)

ejbserver.container.audit_trail.enabled (Key for batch servers)

ejbserver.container.audit_trail.enabled(Key for customizing J2EE servers)

ejbserver.container.bmp.backcompatible(Key for customizing J2EE servers)

ejbserver.container.bmp.backcompatible (Key for customizing J2EE servers)

ejbserver.container.ejbhome.sessionbean.reconnect.enabled(Key for customizing J2EE servers)

ejbserver.container.ejbhome.sessionbean.reconnect.enabled (Key for customizing J2EE servers)

ejbserver.container.passivate.scan.interval(Key for customizing J2EE servers)

ejbserver.container.rebindpolicy [Java application]

ejbserver.container.rebindpolicy (Key for batch applications)

ejbserver.container.rebindpolicy(Key for customizing J2EE servers)

ejbserver.container.rebindpolicy (Key for customizing J2EE servers)

ejbserver.container.remove.scan.interval(Key for customizing J2EE servers)

ejbserver.container.security.disabled(Key for customizing J2EE servers)

ejbserver.container.security.disabled (Key for customizing J2EE servers)

ejbserver.ctm.ActivateTimeOut (Key for customizing J2EE servers)

ejbserver.ctm.ActivateTimeOut (Key for batch servers)

ejbserver.ctm.CTMDomain (Key for customizing J2EE servers)

ejbserver.ctm.CTMDomain (Key for batch servers)

ejbserver.ctm.CTMDomain (Key for customizing J2EE servers)

ejbserver.ctm.CTMID (Key for customizing J2EE servers)

ejbserver.ctm.CTMID (Key for batch servers)

ejbserver.ctm.CTMMyHost (Key for customizing J2EE servers)

ejbserver.ctm.CTMMyHost (Key for batch servers)

ejbserver.ctm.CTMMyHost (Key for customizing J2EE servers)

ejbserver.ctm.DeactivateTimeOut (Key for customizing J2EE servers)

ejbserver.ctm.DeactivateTimeOut (Key for batch servers)

ejbserver.ctm.enabled (Key for customizing J2EE servers)

ejbserver.ctm.enabled (Key for batch servers)

ejbserver.ctm.enabled (Key for customizing J2EE servers)

ejbserver.ctm.QueueLength (Key for customizing J2EE servers)

ejbserver.ctm.useGlobalJNDI (Key for customizing J2EE servers)

ejbserver.cui.checkmethod.compatible

ejbserver.cui.exitcode.compatible

ejbserver.cui.logfile.compatible

ejbserver.cui.optionalname.enabled

ejbserver.deploy.annotations.load_check.enabled (key for customization of server management commands)

ejbserver.deploy.annotations.load_check.enabled (Key for customizing J2EE servers)

ejbserver.deploy.annotations.load_libjars.enabled (Key for customizing J2EE servers)

ejbserver.deploy.app.stopforcibly.disabled (Key for customizing J2EE servers)

ejbserver.deploy.app.stopforcibly.disabled (Key for customizing J2EE servers)

ejbserver.deploy.context.check_interval (Key for customizing J2EE servers)

ejbserver.deploy.context.reload_scope (Key for customizing J2EE servers)

ejbserver.deploy.context.update.interval (Key for customizing J2EE servers)

ejbserver.deploy.exclusive.lockAliveInterval (Key for customizing J2EE servers)

ejbserver.deploy.exclusive.lockAliveInterval (Key for batch servers)

ejbserver.deploy.exclusive.lockAliveInterval (Key for customizing J2EE servers)

ejbserver.deploy.resourcefile.scramble.enabled (Key for customizing J2EE servers)

ejbserver.deploy.resourcefile.scramble.enabled (Key for batch servers)

ejbserver.deploy.session.work.directory (Key for customizing J2EE servers)

ejbserver.deploy.stub.generation.scope (Key for customizing J2EE servers)

ejbserver.deploy.stub.generation.scope (Key for customizing J2EE servers)

ejbserver.distributedtx.enableXidReuseOptimization (Key for customizing J2EE servers)

ejbserver.distributedtx.ots.recoverFailMessageCount (Key for customizing J2EE servers)

ejbserver.distributedtx.ots.status.directory1 [Java application]

ejbserver.distributedtx.ots.status.directory1 (Key for customizing J2EE servers)

ejbserver.distributedtx.ots.status.directory2 [Java application]

ejbserver.distributedtx.ots.status.directory2 (Key for customizing J2EE servers)

ejbserver.distributedtx.recovery.completionCheckOnStopping.timeout (Key for customizing J2EE servers)

ejbserver.distributedtx.recovery.completionCheckOnStopping.timeout (Key for customizing J2EE servers)

ejbserver.distributedtx.recovery.port [Java application]

ejbserver.distributedtx.recovery.port (Key for customizing J2EE servers)

ejbserver.distributedtx.rollbackClientTxOnSystemException (Key for customizing J2EE servers)

ejbserver.distributedtx.XATransaction.enabled (Key for customizing J2EE servers)

ejbserver.DynamicStubLoading.Enabled (Key for customizing J2EE servers)

ejbserver.ejb.cmp20.cmr.use.existing_table (Key for customizing J2EE servers)

ejbserver.ejb.cmp20.cmr.use.existing_table (Key for customizing J2EE servers)

ejbserver.ejb.timerservice.maxCallbackThreads (Key for customizing J2EE servers)

ejbserver.ejb.timerservice.retryCount (Key for customizing J2EE servers)

ejbserver.ejb.timerservice.retryInterval (Key for customizing J2EE servers)

ejbserver.ext.method_observation.interval (Key for customizing J2EE servers)

ejbserver.ext.method_observation.interval (Key for batch servers)

ejbserver.http.port (Key for customizing J2EE servers)

ejbserver.http.port (Key for batch servers)

ejbserver.instrumentation.enabled (Key for customizing J2EE servers)

ejbserver.instrumentation.enabled (Key for batch servers)

ejbserver.jca.adapter.tp1.bind_host (Key for customizing J2EE servers)

ejbserver.jndi.cache [Java application]

ejbserver.jndi.cache.interval [Java application]

ejbserver.jndi.cache.interval.clear.option [Java application]

ejbserver.jndi.cache.interval.clear.option (Key for customizing J2EE servers)

ejbserver.jndi.cache.interval.clear.option (Key for batch servers)

ejbserver.jndi.cache.interval (Key for customizing J2EE servers)

ejbserver.jndi.cache.interval (Key for batch servers)

ejbserver.jndi.cache.reference (Key for customizing J2EE servers)

ejbserver.jndi.cache.reference (Key for batch servers)

ejbserver.jndi.cache.reference (Key for customizing J2EE servers)

ejbserver.jndi.cache (Key for customizing J2EE servers)

ejbserver.jndi.cache (Key for batch servers)

ejbserver.jndi.global.enabled (Key for customizing J2EE servers)

ejbserver.jndi.log.message.verbosemode

ejbserver.jndi.namingservice.group.list [Java application]

ejbserver.jndi.namingservice.group.list (Key for customizing J2EE servers)

ejbserver.jndi.namingservice.group.list (Key for batch servers)

ejbserver.jndi.namingservice.group.specify-group-name.providerurls [Java application]

ejbserver.jndi.namingservice.group.specify-group-name.providerurls (Key for customizing J2EE servers)

ejbserver.jndi.namingservice.group.specify-group-name.providerurls (Key for batch servers)

ejbserver.jndi.request.timeout [Java application]

ejbserver.jndi.request.timeout (Key for customizing J2EE servers)

ejbserver.jndi.request.timeout (Key for batch applications)

ejbserver.jndi.request.timeout (Key for batch servers)

ejbserver.jpa.defaultJtaDsName (Key for customizing J2EE servers)

ejbserver.jpa.defaultNonJtaDsName (Key for customizing J2EE servers)

ejbserver.jpa.defaultProviderClassName (Key for customizing J2EE servers)

ejbserver.jpa.disable (Key for customizing J2EE servers)

ejbserver.jpa.emfprop.property-key (Key for customizing J2EE servers)

ejbserver.jpa.overrideJtaDsName (Key for customizing J2EE servers)

ejbserver.jpa.overrideNonJtaDsName (Key for customizing J2EE servers)

ejbserver.jpa.overrideProvider (Key for customizing J2EE servers)

ejbserver.jta.TransactionManager.defaultTimeOut [Java application]

ejbserver.jta.TransactionManager.defaultTimeOut (Key for customizing J2EE servers)

ejbserver.jta.TransactionManager.defaultTimeOut (Key for batch servers)

ejbserver.logger.channels.define.channel-name.filenum [Java application]

ejbserver.logger.channels.define.channel-name.filenum (Key for customizing J2EE servers)

ejbserver.logger.channels.define.channel-name.filenum (Key for batch servers)

ejbserver.logger.channels.define.channel-name.filesize [Java application]

ejbserver.logger.channels.define.channel-name.filesize (Key for customizing J2EE servers)

ejbserver.logger.channels.define.channel-name.filesize (Key for batch servers)

ejbserver.logger.channels.define.DevelopmentLogFile.filenum (Key for customizing J2EE servers)

ejbserver.logger.channels.define.DevelopmentLogFile.filesize (Key for customizing J2EE servers)

ejbserver.logger.DevelopmentLogFile.level (Key for customizing J2EE servers)

ejbserver.logger.enabled.*

ejbserver.logger.enabled.* [Java application]

ejbserver.logger.enabled.* (Key for customizing J2EE servers)

ejbserver.logger.enabled.* (Key for batch servers)

ejbserver.logger.rotationStyle (Key for customizing J2EE servers)

ejbserver.logger.rotationStyle (Key for batch servers)

ejbserver.logger.rotationTime (Key for customizing J2EE servers)

ejbserver.logger.systemlog.enabled (Key for customizing J2EE servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled (Key for customizing J2EE servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled (Key for batch servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.interval (Key for customizing J2EE servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.interval (Key for batch servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold (Key for customizing J2EE servers)

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold (Key for batch servers)

ejbserver.management.statistics.interval (Key for customizing J2EE servers)

ejbserver.management.statistics.interval (Key for batch servers)

ejbserver.management.stats_file.base_time (Key for customizing J2EE servers)

ejbserver.management.stats_file.base_time (Key for batch servers)

ejbserver.management.stats_file.dir (Key for customizing J2EE servers)

ejbserver.management.stats_file.dir (Key for batch servers)

ejbserver.management.stats_file.enabled (Key for customizing J2EE servers)

ejbserver.management.stats_file.enabled (Key for batch servers)

ejbserver.management.stats_file.num (Key for customizing J2EE servers)

ejbserver.management.stats_file.num (Key for batch servers)

ejbserver.management.stats_file.period (Key for customizing J2EE servers)

ejbserver.management.stats_file.period (Key for batch servers)

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.enabled (Key for customizing J2EE servers)

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.high_threshold (Key for customizing J2EE servers)

ejbserver.management.webcontainer.stats_monitor.waiting_request_count.low_threshold (Key for customizing J2EE servers)

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.enabled (Key for customizing J2EE servers)

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.high_threshold (Key for customizing J2EE servers)

ejbserver.management.webcontainer.stats_monitor.whole_waiting_request_count.low_threshold (Key for customizing J2EE servers)

ejbserver.manager.agent.Agent.conf (Key for customizing J2EE servers)

ejbserver.manager.agent.Agent.conf (Key for batch servers)

ejbserver.manager.agent.Agent.conf (Key for customizing J2EE servers)

ejbserver.manager.agent.Agent.enabled (Key for customizing J2EE servers)

ejbserver.manager.agent.Agent.enabled (Key for batch servers)

ejbserver.manager.agent.Agent.enabled (Key for customizing J2EE servers)

ejbserver.manager.agent.JP1EventAgent.conf (Key for customizing J2EE servers)

ejbserver.manager.agent.JP1EventAgent.conf (Key for batch servers)

ejbserver.manager.agent.JP1EventAgent.enabled (Key for customizing J2EE servers)

ejbserver.manager.agent.JP1EventAgent.enabled (Key for batch servers)

ejbserver.manager.agent.MEventAgent.conf (Key for customizing J2EE servers)

ejbserver.manager.agent.MEventAgent.conf (Key for batch servers)

ejbserver.manager.agent.MEventAgent.enabled (Key for customizing J2EE servers)

ejbserver.manager.agent.MEventAgent.enabled (Key for batch servers)

ejbserver.manager.jp1event.event_server_name (Key for customizing J2EE servers)

ejbserver.manager.jp1event.event_server_name (Key for customizing J2EE servers)

ejbserver.naming.exec.args (Key for customizing J2EE servers)

ejbserver.naming.exec.args (Key for customizing J2EE servers)

ejbserver.naming.host

ejbserver.naming.host (Key for customizing J2EE servers)

ejbserver.naming.host (Key for batch servers)

ejbserver.naming.nameroot (Key for customizing J2EE servers)

ejbserver.naming.nameroot (Key for batch servers)

ejbserver.naming.nameroot (Key for customizing J2EE servers)

ejbserver.naming.port

ejbserver.naming.port (Key for customizing J2EE servers)

ejbserver.naming.port (Key for batch servers)

ejbserver.naming.protocol

ejbserver.naming.protocol (Key for customizing J2EE servers)

ejbserver.naming.protocol (Key for customizing J2EE servers)

ejbserver.naming.startupMode (Key for customizing J2EE servers)

ejbserver.naming.startupRetryCount (Key for customizing J2EE servers)

ejbserver.naming.startupRetryCount (Key for batch servers)

ejbserver.naming.startupWaitTime (Key for customizing J2EE servers)

ejbserver.naming.startupWaitTime (Key for batch servers)

ejbserver.rmi.localinvocation.scope (Key for customizing J2EE servers)

ejbserver.rmi.logger.filenum (Key for customizing J2EE servers)

ejbserver.rmi.logger.filesize (Key for customizing J2EE servers)

ejbserver.rmi.naming.host (Key for customizing J2EE servers)

ejbserver.rmi.naming.host (Key for batch servers)

ejbserver.rmi.naming.port (Key for customizing J2EE servers)

ejbserver.rmi.naming.port (Key for batch servers)

ejbserver.rmi.passbyreference (Key for customizing J2EE servers)

ejbserver.rmi.remote.listener.port (Key for customizing J2EE servers)

ejbserver.rmi.remote.listener.port (Key for batch servers)

ejbserver.rmi.request.timeout

ejbserver.rmi.request.timeout [Java application]

ejbserver.rmi.request.timeout (Key for customizing J2EE servers)

ejbserver.rmi.request.timeout (Key for batch applications)

ejbserver.rmi.request.timeout (Key for batch servers)

ejbserver.rmi.stateless.unique_id.enabled (Key for customizing J2EE servers)

ejbserver.rmi.stateless.unique_id.enabled (Key for customizing J2EE servers)

ejbserver.security.service.url [Java application]

ejbserver.server.eheap.ajp13.enabled (Key for customizing J2EE servers)

ejbserver.server.eheap.httpsession.enabled (Key for customizing J2EE servers)

ejbserver.server.j2ee.feature (Key for customizing J2EE servers)

ejbserver.server.mutex.invocation.timeout (Key for customizing J2EE servers)

ejbserver.server.mutex.invocation.timeout (Key for customizing J2EE servers)

ejbserver.server.prf.PRFID [Java application]

ejbserver.server.prf.PRFID (Key for customizing J2EE servers)

ejbserver.server.prf.PRFID (Key for batch servers)

ejbserver.server.prf.processName

ejbserver.server.threaddump.filenum (Key for customizing J2EE servers)

ejbserver.server.threaddump.filenum (Key for batch servers)

ejbserver.serverName [Java application]

ejbserver.stateful.passivate.switch (Key for customizing J2EE servers)

ejbserver.stdoutlog.autoflush [Java application]

ejbserver.stdoutlog.autoflush (Key for customizing J2EE servers)

ejbserver.stdoutlog.autoflush (Key for batch servers)

ejbserver.watch.defaultRequestQueue.enabled (Key for customizing J2EE servers)

ejbserver.watch.defaultRequestQueue.interval (Key for customizing J2EE servers)

ejbserver.watch.defaultRequestQueue.threshold (Key for customizing J2EE servers)

ejbserver.watch.defaultRequestQueue.writefile.enabled (Key for customizing J2EE servers)

ejbserver.watch.enabled (Key for customizing J2EE servers)

ejbserver.watch.enabled (Key for batch servers)

ejbserver.watch.fileDescriptor.enabled (Key for customizing J2EE servers)

ejbserver.watch.fileDescriptor.enabled (Key for batch servers)

ejbserver.watch.fileDescriptor.interval (Key for customizing J2EE servers)

ejbserver.watch.fileDescriptor.interval (Key for batch servers)

ejbserver.watch.fileDescriptor.threshold (Key for customizing J2EE servers)

ejbserver.watch.fileDescriptor.threshold (Key for batch servers)

ejbserver.watch.fileDescriptor.writefile.enabled (Key for customizing J2EE servers)

ejbserver.watch.fileDescriptor.writefile.enabled (Key for batch servers)

ejbserver.watch.memory.enabled (Key for customizing J2EE servers)

ejbserver.watch.memory.enabled (Key for batch servers)

ejbserver.watch.memory.interval (Key for customizing J2EE servers)

ejbserver.watch.memory.interval (Key for batch servers)

ejbserver.watch.memory.threshold (Key for customizing J2EE servers)

ejbserver.watch.memory.threshold (Key for batch servers)

ejbserver.watch.memory.writefile.enabled (Key for customizing J2EE servers)

ejbserver.watch.memory.writefile.enabled (Key for batch servers)

ejbserver.watch.thread.enabled (Key for customizing J2EE servers)

ejbserver.watch.thread.enabled (Key for batch servers)

ejbserver.watch.thread.interval (Key for customizing J2EE servers)

ejbserver.watch.thread.interval (Key for batch servers)

ejbserver.watch.thread.threshold (Key for customizing J2EE servers)

ejbserver.watch.thread.threshold (Key for batch servers)

ejbserver.watch.thread.writefile.enabled (Key for customizing J2EE servers)

ejbserver.watch.thread.writefile.enabled (Key for batch servers)

ejbserver.watch.threaddump.enabled (Key for customizing J2EE servers)

ejbserver.watch.threaddump.enabled (Key for batch servers)

ejbserver.watch.threaddump.interval (Key for customizing J2EE servers)

ejbserver.watch.threaddump.interval (Key for batch servers)

ejbserver.watch.threaddump.threshold (Key for customizing J2EE servers)

ejbserver.watch.threaddump.threshold (Key for batch servers)

ejbserver.watch.threaddump.writefile.enabled (Key for customizing J2EE servers)

ejbserver.watch.threaddump.writefile.enabled (Key for batch servers)

ejbserver.webj2ee.connectionAutoClose.enabled (Key for customizing J2EE servers)

entitybeanhometable

entitybeanlocalcomponenttable

entitybeanlocalhometable

entitybeanremotetable

entitybeantable

environment setting file

Management Server

environment variable definition file

Management Server

ErrorDivideFileNum

ErrorDivideTimeDifference

ErrorDivideTimeInterval

ErrorWraparoundFileNum

ErrorWraparoundFilesize

execution of Management action

property file

extended mib object definition file

Extension parameters of batch server

extension parameters of J2EE server

Extension parameters of SFO server

(F)

file

batch servers

CTM

CTM

J2EE servers

Java applications

log operations

server management commands

Web server integration

files used for setting audit log

Files Used in Cosminexus JMS

files used in virtual systems

Files used with Cosminexus Manager

filter_priority

(G)

gateway_host

gateway_https_scheme

gateway_port

global transaction

Group

(H)

hitachi_web.properties

host definition file for scale out

https.cipherSuites (Java application)

https.cipherSuites (Key for batch applications)

https.cipherSuites (Key for batch servers)

https.cipherSuites (Key for customizing J2EE servers)

https.protocols (Java application)

https.protocols (Key for batch applications)

https.protocols (Key for batch servers)

https.protocols (Key for customizing J2EE servers)

HttpsdCustomLogFileDir

HttpsdCustomlogFormat

HttpsdCustomMethod

HttpsdErrorLogFileDir

HttpsdErrorMethod

HttpsdLogFileDir

HttpsdRequestLogFileDir

HttpsdRequestMethod

httpserverconnectortable

httpservertable

HWSKeepStartServers

HWSLogTimeVerbose

HWSRequestIofilter

HWSRequestLogLevel

HWSRequestModuleDebug

HWSRequestModuleInfo

HWSRequestRequest

(I)

imq.admin.tcp.port (key for cjmsp broker individual properties file)

imq.autocreate.destination.maxnummsgs (key for cjmsp broker individual properties file)

imq.autocreate.destination.maxnummsgs (key for common properties file of cjmsp broker)

imq.autocreate.destination.maxtotalmsgbytes (key for cjmsp broker individual properties file)

imq.autocreate.destination.maxtotalmsgbytes (key for common properties file of cjmsp broker)

imq.autocreate.queue.consumerflowlimit (key for cjmsp broker individual properties file)

imq.autocreate.queue.consumerflowlimit (key for common properties file of cjmsp broker)

imq.autocreate.topic.consumerflowlimit (key for cjmsp broker individual properties file)

imq.autocreate.topic.consumerflowlimit (key for common properties file of cjmsp broker)

imq.hostname (key for cjmsp broker individual properties file)

imq.hostname (key for common properties file of cjmsp broker)

imq.instanceconfig.version (key for cjmsp broker individual properties file)

imq.jms.tcp.port (key for cjmsp broker individual properties file)

imq.metrics.interval (key for cjmsp broker individual properties file)

imq.metrics.interval (key for common properties file of cjmsp broker)

imq.persist.file.sync.enabled (key for cjmsp broker individual properties file)

imq.persist.file.sync.enabled (key for common properties file of cjmsp broker)

imq.portmapper.port (key for cjmsp broker individual properties file)

isapi_redirect.conf

connect_timeout

connection_sharing

filter_priority

gateway_host

gateway_https_scheme

gateway_port

log_file_dir

log_file_num

log_file_prefix

log_file_size

log_level

prf_id

receive_client_timeout

request_retry_count

send_timeout

trace_log

trace_log_file_dir

trace_log_file_num

trace_log_file_prefix

trace_log_file_size

worker_file

worker_mount_file

(J)

J2EE server

parameters for logical

j2eeapplicationtable

j2eecontainertable

J2EE servers

file

key for customization

list of files

option definition file

security policy file

user property file

Web application property file

java.endorsed.dirs

java.naming.factory.initial [Java application]

java.naming.factory.initial (Key for customizing J2EE servers)

java.naming.factory.initial (Key for batch servers)

java.naming.factory.object

java.naming.factory.state

java.naming.provider.url [Java application]

java.naming.provider.url (Key for batch applications)

java.rmi.server.hostname [key for Management Server environment setting file]

java.security.policy

Java applications

file

list of files

option definition file

user property file

JavaVM

option

JavaVM extension

detail of options

list of options

javax.rmi.CORBA.PortableRemoteObjectClass

javax.rmi.CORBA.StubClass

javax.rmi.CORBA.UtilClass

javax.xml.datatype.DatatypeFactory [Java application]

javax.xml.parsers.DocumentBuilderFactory [Java application]

javax.xml.parsers.SAXParserFactory [Java application]

javax.xml.transform.TransformerFactory [Java application]

javax.xml.validation.SchemaFactory\:http\://www.w3.org/2001/XMLSchema [Java application]

javax.xml.xpath.XPathFactory\:http\://java.sun.com/jaxp/xpath/dom [Java application]

JkConnectTimeout (Key of redirector action definition file for Cosminexus HTTP Server)

JkConnectTimeout(Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayHost (Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayHost(Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayHttpsScheme (Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayHttpsScheme(Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayPort (Key of redirector action definition file for Cosminexus HTTP Server)

JkGatewayPort(Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileDir (Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileDir(Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileNum (Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileNum(Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFilePrefix(Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileSize (Key of redirector action definition file for Cosminexus HTTP Server)

JkLogFileSize(Key of redirector action definition file for Cosminexus HTTP Server)

JkLogLevel (Key of redirector action definition file for Cosminexus HTTP Server)

JkLogLevel(Key of redirector action definition file for Cosminexus HTTP Server)

JkModulePriority (Key of redirector action definition file for Cosminexus HTTP Server)

JkModulePriority(Key of redirector action definition file for Cosminexus HTTP Server)

JkMount (Key of redirector action definition file for Cosminexus HTTP Server)

JkOptions(Key of redirector action definition file for Cosminexus HTTP Server)

JkPrfId (Key of redirector action definition file for Cosminexus HTTP Server)

JkPrfId(Key of redirector action definition file for Cosminexus HTTP Server)

JkRequestRetryCount (Key of redirector action definition file for Cosminexus HTTP Server)

JkRequestRetryCount(Key of redirector action definition file for Cosminexus HTTP Server)

JkSendTimeout (Key of redirector action definition file for Cosminexus HTTP Server)

JkSendTimeout(Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLog (Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLog(Key for redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileDir (Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileDir(Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileNum (Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileNum(Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFilePrefix(Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileSize (Key of redirector action definition file for Cosminexus HTTP Server)

JkTraceLogFileSize(Key of redirector action definition file for Cosminexus HTTP Server)

JkTranslateBackcompat (Key of redirector action definition file for Cosminexus HTTP Server)

JkTranslateBackcompat(Key of redirector action definition file for Cosminexus HTTP Server)

JkWorkersFile(Key of redirector action definition file for Cosminexus HTTP Server)

JP1 event

conversion

jvm.type (Key for batch servers)

jvm.type (Key for Java applications)

jvm.type (Option for J2EE servers)

jvm.type (option for J2EE servers)

jvmtable

(K)

KeepAliveTimeout

key for mngsvrutilrc (client-side definition file for mngsvrutil command)

Keys specifiable in worker definition file

Keys specifiable in worker definition file

(L)

lb.properties

light transaction

list of files used in system for executing batch applications

list of files used in system for executing J2EE applications

List of files used with Cosminexus Manager

Listen

list file

compilation exclusion

execution result

protected areas

protected areas

list of files

batch servers

J2EE servers

Java applications

log operations

server management commands

Web application

Web server integration

list of options

JavaVM extension

load balancer

definition of

definition properties file

log_file_dir

log_file_num

log_file_prefix

log_file_size

log_level

logical J2EE server, parameters for

logical performance tracer, parameters applicable to

logical server

parameters applicable to all

reference definition file

logical SFO server, parameters applicable to

logical Web server, parameters for

LogLevel

log operations

file

list of files

(M)

maction.Management-action-ID.command

maction.Management-action-ID.exclusive_time

maction.Management-action-ID.max_executable_actions

maction.Management-action-ID.timeout

maction.Management-action-ID.timeout.forced_stop

maction.message.Message-ID.mactions

maction.mevent.receiving_info.keep_size.max

maction.properties

maction.Management-action-ID.command

maction.Management-action-ID.exclusive_time

maction.Management-action-ID.max_executable_actions

maction.Management-action-ID.timeout

maction.Management-action-ID.timeout.forced_stop

maction.message.Message-ID.mactions

maction.mevent.receiving_info.keep_size.max

maction.server.logical-server-name.mactions

maction.tier.web-system-name.physical-tier-typename.mactions

maction.unit.web-system-name.service-unit-name.mactions

maction.server.logical-server-name.mactions

maction.tier.web-system-name.physical-tier-typename.mactions

maction.unit.web-system-name.service-unit-name.mactions

Management Agent

property file

Management Server

environment setting file

environment variable definition file

message mapping file

option definition file

Manager

setting file

manager.cfg

manager.jp1event.system.filtering.severity.alert

manager.jp1event.system.filtering.severity.critical

manager.jp1event.system.filtering.severity.emergency

manager.jp1event.system.filtering.severity.error

manager.jp1event.system.filtering.severity.information

manager.jp1event.system.filtering.severity.notice

manager.jp1event.system.filtering.severity.warning

manager.jp1event.system.mapping.properties

manager.jp1event.user.filtering.enabled

manager.jp1event.user.filtering.filter

manager.jp1event.user.mapping.level.config

manager.jp1event.user.mapping.level.fine

manager.jp1event.user.mapping.level.finer

manager.jp1event.user.mapping.level.finest

manager.jp1event.user.mapping.level.info

manager.jp1event.user.mapping.level.severe

manager.jp1event.user.mapping.level.warning

manager.Logical-server-name.jp1event.system.mapping.properties

manager.mevent.logical_server_name

manager.mevent.message_id.list

manager.mevent.message_id.list

manager.mevent.retry.interval

manager.mevent.retry.interval

manager.mevent.retry.limit

manager.mevent.retry.limit

manager.mevent.send.host

manager.mevent.send.max

manager.mevent.send.max

manager.mevent.send.port

manager.mevent.send.timeout

manager.mevent.send.timeout

manager.mevent.sender.bind.host

manager.mevent.sender.bind.host

mapping definition

mapping definition file

Microsoft IIS

MaxClients

messagedrivenbeantable

Message ID list file

issuing Management events

message mapping file

individual J2EE servers

J2EE server sharing

Management Server

mevent.logical-server-name.properties

manager.mevent.logical_server_name

manager.mevent.message_id.list

manager.mevent.retry.interval

manager.mevent.retry.limit

manager.mevent.send.host

manager.mevent.send.max

manager.mevent.send.port

manager.mevent.send.timeout

manager.mevent.sender.bind.host

Microsoft IIS

mapping definition file

redirector action definition file

mngagent.actual-server-name.properties

mngagent.agent_name

mngagent.connector.host

mngagent.connector.port

mngagent.domain_name

mngagent.log.filename

mngagent.log.filesize

vbroker.se.iiop_tp.host

vbroker.se.iiop_tp.scm.iiop_tp.listener.port

mngagent.agent_name

mngagent.connector.host

mngagent.connector.host

mngagent.connector.port

mngagent.connector.port

mngagent.domain_name

mngagent.log.filename

mngagent.log.filesize

mngagent.log.filesize

mngsvr.jp1event.event_server_name [key for Management Server environment setting file]

mngsvr.myhost.name [key for Management Server environment setting file]

mngsvrmonitor.browser

mngsvrmonitor.connect.host

mngsvrmonitor.connect.password (key for setting file of monitor start command for JP1/IM integration)

mngsvrmonitor.connect.userid (key for setting file of monitor start command for JP1/IM integration)

mngsvrutil.apply_user [Key for client-side shared definition file of mngsvrutil command]

mngsvrutil.auth.failed_wait

mngsvrutil.auth.log_challenged

mngsvrutil.auth.log_denied

mngsvrutil.auth.log_failed

mngsvrutil.auth.log_succeeded

mngsvrutil.compat.header_format [Key for server-side definition file of mngsvrutil command]

mngsvrutil.compat.monitoring_tree [Key for server-side definition file of mngsvrutil command]

mngsvrutil.connect.host

mngsvrutil.connect.password

mngsvrutil.connect.userid

mngsvrutil.output.file

mngsvrutil.output.format

mngsvrutil.output.suppress_header

mngsvrutil.properties

mngsvrutil.auth.failed_wait

mngsvrutil.auth.log_challenged

mngsvrutil.auth.log_denied

mngsvrutil.auth.log_failed

mngsvrutil.auth.log_succeeded

mngsvrutil.session.max_inactive_interval

mngsvrutil.session.max_inactive_interval

mngsvrutil.target_kind

mngsvrutil.target_name

mngsvrutil.target_server_name

mngsvrutilcl.properties

mngsvrutil command

client-side definition file

client-side shared definition file

server-side definition file

mod_jk.conf

module definition

mserver.cfg

mserver.jp1event.system.mapping.properties

mserver.properties

adminagent.connector.comm.state.cache_max_time

com.cosminexus.mngsvr.jp1event.alert

com.cosminexus.mngsvr.jp1event.critical

com.cosminexus.mngsvr.jp1event.emergency

com.cosminexus.mngsvr.jp1event.enabled

com.cosminexus.mngsvr.jp1event.error

com.cosminexus.mngsvr.jp1event.information

com.cosminexus.mngsvr.jp1event.notice

com.cosminexus.mngsvr.jp1event.warning

com.cosminexus.mngsvr.log.display_number

com.cosminexus.mngsvr.log.level

com.cosminexus.mngsvr.log.rotate

com.cosminexus.mngsvr.log.size

com.cosminexus.mngsvr.maintenance.log.filenum

com.cosminexus.mngsvr.maintenance.log.filesize

com.cosminexus.mngsvr.on_start

com.cosminexus.mngsvr.snapshot.auto_collect.enabled

com.cosminexus.mngsvr.snapshot.collect.point

com.cosminexus.mngsvr.sys_cmd.abnormal_end.enabled

com.cosminexus.mngsvr.sys_cmd.abnormal_end.timeout

com.cosminexus.mngsvr.trace

com.cosminexus.mngsvr.usr_cmd.abnormal_end.enabled

com.cosminexus.mngsvr.usr_cmd.abnormal_end.timeout

mserverenv.cfg

mstartup.force.watchtime

mstartup.no

mstartup.premised.serverName

mstartup.restartcnt

mstartup.retrywait

mstartup.start.watchtime

mstartup.watchtime

(O)

option

JavaVM

option definition file

Administration Agent

batch applications

batch servers

J2EE servers

Java applications

Management Server

server management commands for UNIX

server management commands for Windows

org.omg.CORBA.ORBClass

org.omg.CORBA.ORBSingletonClass

org.omg.PortableInterceptor.ORBInitializerClass.com.hitachi.software.ejb.security.std.interceptor.SecurityClientInterceptorInit

org.w3c.dom.DOMImplementationSourceList [Java application]

org.xml.sax.driver [Java application]

org.xml.sax.parser [Java application]

(P)

Parameters applicable to JavaVM system properties for batch server

Parameters applicable to JavaVM system properties for J2EE server

Parameters applicable to logical CTM

Parameters applicable to logical CTM domain managers

Parameters applicable to logical naming service

Parameters applicable to logical Smart Agent

Parameters applicable to logical user server

Parameters applicable to the JavaVM system properties for the SFO server

Parameters for setting log output method of Cosminexus HTTP Server

parameters that can be commonly specified for each logical server (for compatibility)

parameters that can be specified in logical j2ee server (for compatibility)

parameters that can be specified in logical sfo server (for compatibility)

parameters that can be specified in logical Web server (for compatibility)

Parameters used for setting definitions for Web server

Parameters used for setting Management Agent properties

Parameters used for setting Management Agent properties

Parameters used for setting option definitions for batch server

Parameters used for setting option definitions for J2EE server

Parameters used for setting option definitions for SFO server

Parameters used for setting properties for issuing Management events

Parameters used for setting the properties for issuing Management events

Parameters used for setting the user properties for the J2EE server

Parameters used for setting up JP1 integration

Parameters used for setting up JP1 integration

Parameters used for setting up usage of SecurityManager

Parameters used for setting user properties for batch server

Parameters used for setting user properties for SFO server

Parameters used for setting worker definition

Parameters defined for each worker

Parameters that set up redirector action definition for Cosminexus HTTP Server

performance tracer

parameters for logical

physical tier

definition of

prf_id

PRFID

prfspool

PrfTraceBufferSize

PrfTraceCount

PrfTraceFileSize

PrfTraceLevel

property file

Administration Agent

execution of Management action

property file

issuing Management event

property file

Management Agent

(Q)

queuetable

(R)

realservername

receive_client_timeout

Redirector action definition file for Cosminexus HTTP Server

redirector action definition file

Microsoft IIS

redirector definition

relationship between extension and MIME type

request_retry_count

RequestDivideFileNum

RequestDivideTimeDifference

RequestDivideTimeInterval

requesturltable

RequestWraparoundFileNum

RequestWraparoundFilesize

Reserved key of server management command

resourceadaptertable

(S)

security policy file

batch servers

J2EE servers

send_timeout

server setting properties file

server.policy

server.policy

server management commands

file

key for customization

list of files

option definition file for UNIX

option definition file for Windows

reserved key

system property file

ServerName

servlettable

SetBy

setting file

Administration Agent

settings file

Manager

monitor startup command for JP1/IM integration

setup file for automatic start of administration agent

setup.cfg (setup file for setup wizard)

setup.log.dir [key for setup file for the Setup Wizard]

setup.log.filenum [key for setup file for the Setup Wizard]

setup.log.filesize [key for setup file for the Setup Wizard]

setup.maintenance.log.filenum [key for setup file for the Setup Wizard]

setup.maintenance.log.filesize [key for setup file for the Setup Wizard]

SFO server

parameters for logical

SFO server (functionality for compatibility)

StartServers

statefulsessionbeanhomemethodtable

statefulsessionbeanhometable

statefulsessionbeanlocalcomponentmethodtable

statefulsessionbeanlocalcomponenttable

statefulsessionbeanlocalhomemethodtable

statefulsessionbeanlocalhometable

statefulsessionbeanremotemethodtable

statefulsessionbeanremotetable

statefulsessionbeantable

statelesssessionbeanhomemethodtable

statelesssessionbeanhometable

statelesssessionbeanlocalcomponentmethodtable

statelesssessionbeanlocalcomponenttable

statelesssessionbeanlocalhomemethodtable

statelesssessionbeanlocalhometable

statelesssessionbeanremotemethodtable

statelesssessionbeanremotetable

statelesssessionbeantable

system log message mapping file

JP1/IM integration

system property file

server management commands

(T)

Tags that can be specified in system for executing batch applications

tags that can be specified in system for executing J2EE applications

ThreadsPerChild

trace_log

trace_log_file_dir

trace_log_file_num

trace_log_file_prefix

trace_log_file_size

transactiontable

(U)

uriworkermap.properties

use.security

User

user.env.variable

user property file

batch applications

batch servers

J2EE servers

Java applications

usrconf

USRCONF_JVM_ARGS

USRCONF_JVM_CLPATH

USRCONF_JVM_LIBPATH

usrconf.bat

USRCONF_JVM_ARGS

USRCONF_JVM_CLASSPATH

USRCONF_JVM_LIBPATH

usrconf.cfg

usrconf.cfg

usrconf.cfg

usrconf.cfg

usrconf.properties

usrconf.properties

usrconf.properties

usrconf.properties

usrconf.properties

ejbserver.client.ctm.RequestPriority

ejbserver.cui.checkmethod.compatible

ejbserver.cui.exitcode.compatible

ejbserver.cui.logfile.compatible

ejbserver.cui.optionalname.enabled

ejbserver.logger.enabled.*

ejbserver.naming.host

ejbserver.naming.port

ejbserver.naming.protocol

ejbserver.rmi.request.timeout

vbroker.agent.port

vbroker.orb.htc.tracePath

USRCONF_JVM_ARGS

USRCONF_JVM_ARGS

USRCONF_JVM_CLASSPATH

USRCONF_JVM_CLPATH

USRCONF_JVM_LIBPATH

USRCONF_JVM_LIBPATH

(V)

variable

definition file for snapshot log collection

vbj.java2iiop.jvm.maxHeapSize

vbj.java2iiop.jvm.maxHeapSize (Key for customizing J2EE servers)

vbj.java2iiop.jvm.minHeapSize

vbj.java2iiop.jvm.minHeapSize (Key for customizing J2EE servers)

vbroker.agent.enableLocator

vbroker.agent.enableLocator (Key for customizing J2EE servers)

vbroker.agent.enableLocator (Key for batch servers)

vbroker.agent.enableLocator (Key for customizing J2EE servers)

vbroker.agent.port

vbroker.agent.port (Key for customizing J2EE servers)

vbroker.agent.port (Key for batch servers)

vbroker.ce.iiop.ccm.htc.readerPerConnection (Java application)

vbroker.ce.iiop.ccm.htc.readerPerConnection (Key for batch servers)

vbroker.ce.iiop.ccm.htc.readerPerConnection (Key for customizing J2EE servers)

vbroker.ce.iiop.ccm.htc.threadStarter (Key for batch servers)

vbroker.ce.iiop.ccm.htc.threadStarter (Key for customizing J2EE servers)

vbroker.orb.htc.comt.entryCount [Java application]

vbroker.orb.htc.comt.entryCount (Key for customizing J2EE servers)

vbroker.orb.htc.comt.entryCount (Key for batch servers)

vbroker.orb.htc.comt.entryCount (Key for customizing J2EE servers)

vbroker.orb.htc.comt.fileCount [Java application]

vbroker.orb.htc.comt.fileCount (Key for customizing J2EE servers)

vbroker.orb.htc.comt.fileCount (Key for batch servers)

vbroker.orb.htc.comt.fileCount (Key for customizing J2EE servers)

vbroker.orb.htc.tracePath

vbroker.orb.htc.tracePath [Java application]

vbroker.orb.htc.tracePath (Key for customizing J2EE servers)

vbroker.orb.htc.tracePath (Key for batch servers)

vbroker.orb.htc.tracePath (Key for customizing J2EE servers)

vbroker.se.iiop_tp.host

vbroker.se.iiop_tp.host (Key for customizing J2EE servers)

vbroker.se.iiop_tp.host (Key for batch servers)

vbroker.se.iiop_tp.proxyHost (Key for customizing J2EE servers)

vbroker.se.iiop_tp.scm.iiop_tp.listener.port

vbroker.se.iiop_tp.scm.iiop_tp.listener.port (Key for customizing J2EE servers)

vbroker.se.iiop_tp.scm.iiop_tp.listener.port (Key for batch servers)

vbroker.se.iiop_tp.scm.iiop_tp.listener.port(Key for customizing server management commands)

vbroker.se.iiop_ts.proxyHost (Key for customizing J2EE servers)

(W)

Web server

parameters for logical

Web application

list of files

Web application property file

J2EE servers

Web Applications

DD (web.xml)

webapplicationtable

webcontainertable

webserver.application.lower_version (Key for customizing J2EE servers)

webserver.connector.ajp12.backlog (Key for customizing J2EE servers)

webserver.connector.ajp12.backlog (Key for customizing J2EE servers)

webserver.connector.ajp12.max_threads (Key for customizing J2EE servers)

webserver.connector.ajp12.max_threads (Key for customizing J2EE servers)

webserver.connector.ajp12.port (Key for customizing J2EE servers)

webserver.connector.ajp12.port (Key for customizing J2EE servers)

webserver.connector.ajp13.backlog (Key for customizing J2EE servers)

webserver.connector.ajp13.bind_host (Key for customizing J2EE servers)

webserver.connector.ajp13.bind_host (Key for batch servers)

webserver.connector.ajp13.max_threads (Key for customizing J2EE servers)

webserver.connector.ajp13.port [key for Management Server environment setting file]

webserver.connector.ajp13.port (Key for customizing J2EE servers)

webserver.connector.ajp13.port (Key for batch servers)

webserver.connector.ajp13.receive_timeout (Key for customizing J2EE servers)

webserver.connector.ajp13.send_timeout (Key for customizing J2EE servers)

webserver.connector.http.bind_host [key for Management Server environment setting file]

webserver.connector.http.bind_host (Key for customizing J2EE servers)

webserver.connector.http.permitted.hosts [key for Management Server environment setting file]

webserver.connector.http.permitted.hosts (Key for customizing J2EE servers)

webserver.connector.http.port [key for Management Server environment setting file]

webserver.connector.inprocess_http.backlog (Key for customizing J2EE servers)

webserver.connector.inprocess_http.bind_host (Key for customizing J2EE servers)

webserver.connector.inprocess_http.enabled_methods (Key for customizing J2EE servers)

webserver.connector.inprocess_http.enabled (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file.content_type (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.file (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.redirect_url (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.request_url (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.error-page-customization-definition-name.status (Key for customizing J2EE servers)

webserver.connector.inprocess_http.error_custom.list (Key for customizing J2EE servers)

webserver.connector.inprocess_http.gateway.host (Key for customizing J2EE servers)

webserver.connector.inprocess_http.gateway.https_scheme (Key for customizing J2EE servers)

webserver.connector.inprocess_http.gateway.port (Key for customizing J2EE servers)

webserver.connector.inprocess_http.hostname_lookups (Key for customizing J2EE servers)

webserver.connector.inprocess_http.hostname_lookups (Key for customizing J2EE servers)

webserver.connector.inprocess_http.init_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.keep_start_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.limit.max_headers (Key for customizing J2EE servers)

webserver.connector.inprocess_http.limit.max_request_body (Key for customizing J2EE servers)

webserver.connector.inprocess_http.limit.max_request_header (Key for customizing J2EE servers)

webserver.connector.inprocess_http.limit.max_request_line (Key for customizing J2EE servers)

webserver.connector.inprocess_http.max_connections (Key for customizing J2EE servers)

webserver.connector.inprocess_http.max_execute_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.max_spare_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.min_spare_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.permitted.hosts (Key for customizing J2EE servers)

webserver.connector.inprocess_http.persistent_connection.max_connections (Key for customizing J2EE servers)

webserver.connector.inprocess_http.persistent_connection.max_requests (Key for customizing J2EE servers)

webserver.connector.inprocess_http.persistent_connection.timeout (Key for customizing J2EE servers)

webserver.connector.inprocess_http.port (Key for customizing J2EE servers)

webserver.connector.inprocess_http.receive_timeout (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.list (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.redirect-definition-name.file.content_type (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.redirect-definition-name.file (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.redirect-definition-name.redirect_url (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.redirect-definition-name.request_url (Key for customizing J2EE servers)

webserver.connector.inprocess_http.redirect.redirect-definition-name.status (Key for customizing J2EE servers)

webserver.connector.inprocess_http.rejection_threads (Key for customizing J2EE servers)

webserver.connector.inprocess_http.response.header.server (Key for customizing J2EE servers)

webserver.connector.inprocess_http.send_timeout (Key for customizing J2EE servers)

webserver.connector.limit.max_parameter_count (Key for customizing J2EE servers)

webserver.connector.limit.max_post_form_data (Key for customizing J2EE servers)

webserver.connector.redirect_https.port (Key for customizing J2EE servers)

webserver.container.ac.logEnabled (Key for customizing J2EE servers)

webserver.container.jaxws.webservice.no_webxml.enabled (Key for customizing J2EE servers)

webserver.container.jaxws.webservice.wsee.no_webxml.enabled (Key for customizing J2EE servers)

webserver.container.jaxws.webservice.wsee.warname (Key for customizing J2EE servers)

webserver.container.server_id.enabled (Key for customizing J2EE servers)

webserver.container.server_id.name (Key for customizing J2EE servers)

webserver.container.server_id.value (Key for customizing J2EE servers)

webserver.container.servlet.default_mapping.enabled (Key for customizing J2EE servers)

webserver.container.thread_control.enabled (Key for customizing J2EE servers)

webserver.container.thread_control.queue_size (Key for customizing J2EE servers)

webserver.context.check_interval (Key for customizing J2EE servers)

webserver.context.reload_delay_timeout (Key for customizing J2EE servers)

webserver.context.update.interval (Key for customizing J2EE servers)

webserver.dbsfo.attribute_data_size.max (Key for customizing J2EE servers)

webserver.dbsfo.check_size.mode (Key for customizing J2EE servers)

webserver.dbsfo.connector.name (Key for customizing J2EE servers)

webserver.dbsfo.enabled (Key for customizing J2EE servers)

webserver.dbsfo.exception_type_backcompat (Key for customizing J2EE servers)

webserver.dbsfo.exclude.extensions (Key for customizing J2EE servers)

webserver.dbsfo.exclude.uris (Key for customizing J2EE servers)

webserver.dbsfo.integrity_mode.enabled (Key for customizing J2EE servers)

webserver.dbsfo.negotiation.high_level (Key for customizing J2EE servers)

webserver.dbsfo.session_read_only.uris (Key for customizing J2EE servers)

webserver.dbsfo.thread_control_queue.enabled (Key for customizing J2EE servers)

webserver.eadssfo.application.cache.name (Key for customizing J2EE servers)

webserver.eadssfo.check_size.mode (Key for customizing J2EE servers)

webserver.eadssfo.client.retry.countwebserver.eadssfo.client.retry.count

webserver.eadssfo.client.retry.interval (Key for customizing J2EE servers)

webserver.eadssfo.eads.client.<connection destination EADs server name>.address (Key for customizing J2EE servers)

webserver.eadssfo.eads.client.<connection destination EADs server name>.port (Key for customizing J2EE servers)

webserver.eadssfo.eads.client.node.list (Key for customizing J2EE servers)

webserver.eadssfo.eads.connection.buffersize (Key for customizing J2EE servers)

webserver.eadssfo.eads.connection.retry (Key for customizing J2EE servers)

webserver.eadssfo.eads.connection.timeout (Key for customizing J2EE servers)

webserver.eadssfo.eads.connectionPool.poolsize (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.commDump.enable (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.commTrace.enable (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.commTrace.filenum (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.commTrace.filesize (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.dir (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.message.console.enable (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.message.filenum (Key for customizing J2EE servers)

webserver.eadssfo.eads.logger.message.filesize (Key for customizing J2EE servers)

webserver.eadssfo.enabled (Key for customizing J2EE servers)

webserver.eadssfo.exclude.url_patterns (Key for customizing J2EE servers)

webserver.eadssfo.session.cache.name (Key for customizing J2EE servers)

webserver.eadssfo.session_read_only.url_patterns (Key for customizing J2EE servers)

webserver.errorpage.stack_trace.enabled (Key for customizing J2EE servers)

webserver.errorpage.stack_trace.enabled (Key for customizing J2EE servers)

webserver.http.request.encoding (Key for customizing J2EE servers)

webserver.http.request.uri_decode.enabled (Key for customizing J2EE servers)

webserver.http.response.encoding (Key for customizing J2EE servers)

webserver.jsp.additional.import.list (Key for customizing J2EE servers)

webserver.jsp.check_interval (Key for customizing J2EE servers)

webserver.jsp.compile.backcompat (Key for customizing J2EE servers)

webserver.jsp.debugging.enabled (Key for customizing J2EE servers)

webserver.jsp.el2_2.enabled (Key for customizing J2EE servers)

webserver.jsp.jsp_page.bom.enabled (Key for customizing J2EE servers)

webserver.jsp.keepgenerated (Key for customizing J2EE servers)

webserver.jsp.keepgenerated (Option for J2EE servers)

webserver.jsp.pageEncoding (Key for customizing J2EE servers)

webserver.jsp.precompile.jsp_work_dir (Key for customizing J2EE servers)

webserver.jsp.precompile.jsp_work_dir (Key for customizing J2EE servers)

webserver.jsp.tld.mapping.java_ee_tag_library.enabled (Key for customizing J2EE servers)

webserver.jsp.translation.backcompat.customAction.declareVariable (Key for customizing J2EE servers)

webserver.jsp.translation.backcompat.tag.noCheckRtexprvalue (Key for customizing J2EE servers)

webserver.jsp.translation.backcompat.tag.rtexprvalueTerminate (Key for customizing J2EE servers)

webserver.jsp.translation.backcompat.taglib.noCheckPrefix (Key for customizing J2EE servers)

webserver.jsp.translation.backcompat.useBean.noCheckClass (Key for customizing J2EE servers)

webserver.jsp.translation.customAction.ignoreCaseAttributeName (Key for customizing J2EE servers)

webserver.jsp.translation.useBean.noCheckDuplicateId (Key for customizing J2EE servers)

webserver.jsp.update.interval (Key for customizing J2EE servers)

webserver.logger.access_log.format_list (Key for customizing J2EE servers)

webserver.logger.access_log.format-name (Key for customizing J2EE servers)

webserver.logger.access_log.inprocess_http.enabled (Key for customizing J2EE servers)

webserver.logger.access_log.inprocess_http.filename (Key for customizing J2EE servers)

webserver.logger.access_log.inprocess_http.filenum (Key for customizing J2EE servers)

webserver.logger.access_log.inprocess_http.filesize (Key for customizing J2EE servers)

webserver.logger.access_log.inprocess_http.usage_format (Key for customizing J2EE servers)

webserver.logger.communication_trace.inprocess_http.filenum (Key for customizing J2EE servers)

webserver.logger.communication_trace.inprocess_http.filenum (Key for customizing J2EE servers)

webserver.logger.thread_trace.inprocess_http.filenum (Key for customizing J2EE servers)

webserver.logger.thread_trace.inprocess_http.filenum (Key for customizing J2EE servers)

webserver.servlet_api.exception.getCause.backcompat (Key for customizing J2EE servers)

webserver.ServletContainerInitializer_jar.include.path (Key for customizing J2EE servers)

webserver.session.cookie_config.http_only (Key for customizing J2EE servers)

webserver.session.cookie_config.name (Key for customizing J2EE servers)

webserver.session.delete_cookie.backcompat (Key for customizing J2EE servers)

webserver.session.delete_cookie.backcompat (Key for customizing J2EE servers)

webserver.session.max.log_interval (Key for customizing J2EE servers)

webserver.session.max.log_interval (Key for customizing J2EE servers)

webserver.session.max.throwHttpSessionLimitExceededException (Key for customizing J2EE servers)

webserver.session.server_id.enabled (Key for customizing J2EE servers)

webserver.session.server_id.enabled (Key for customizing J2EE servers)

webserver.session.server_id.value (Key for customizing J2EE servers)

webserver.session.tracking_mode (Key for customizing J2EE servers)

webserver.sfo.negotiation.ignore_serverId (Key for customizing J2EE servers)

webserver.shutdown.port [key for Management Server environment setting file]

webserver.static_content.cache.enabled (Key for customizing J2EE servers)

webserver.static_content.cache.filesize.threshold (Key for customizing J2EE servers)

webserver.static_content.cache.size (Key for customizing J2EE servers)

webserver.static_content.encoding.extension (Key for customizing J2EE servers)

webserver.work.clean (Key for customizing J2EE servers)

webserver.work.directory (Key for customizing J2EE servers)

webserver.xml.validate (Key for customizing J2EE servers)

webserver.xml.validate (Option for J2EE servers)

Web server integration

file

list of files

worker.< worker name >.< parameter > (Key for worker definition file)

worker.< worker name >.delegate_error_code (Parameters defined for each worker)

worker.< worker name >.port (Parameters defined for each worker)

worker.list

worker.list (Key for worker definition file)

worker.worker-name.balanced_workers

worker.worker-name.balanced_workers (Parameters defined for each worker)

worker.worker-name.cachesize

worker.worker-name.cachesize (Parameters defined for each worker)

worker.worker-name.default_worker

worker. worker-name.default_worker (Parameters defined for each worker)

worker.worker-name.delegate_error_code

worker.worker-name.host

worker.worker-name.host (Parameters defined for each worker)

worker.worker-name.lbfactor

worker.worker-name.lbfactor (Parameters defined for each worker)

worker.worker-name.parameter

worker.worker-name.port

worker.worker-name.port (Parameters defined for each worker)

worker.worker-name.port (Parameters defined for each worker)

worker.worker-name.post_data

worker. worker-name.post_data (Parameters defined for each worker)

worker.worker-name.post_size_workers

worker.worker-name.post_size_workers (Parameters defined for each worker)

worker.worker-name.receive_timeout

worker.worker-name.receive_timeout (Parameters defined for each worker)

worker_file

worker_mount_file

worker definition file

parameter

parameter for worker.worker-name.type

workers.properties

worker.list

worker.worker-name.balanced_workers

worker.worker-name.cachesize

worker.worker-name.default_worker

worker.worker-name.delegate_error_code

worker.worker-name.host

worker.worker-name.lbfactor

worker.worker-name.parameter

worker.worker-name.port

worker.worker-name.post_data

worker.worker-name.post_size_workers

worker.worker-name.receive_timeout

working directory

Trademarks

AIX is a trademark of International Business Machines Corporation in the United States, other countries, or both.
AMD is a trademark of Advanced Micro Devices, Inc.
F5, F5 Networks, BIG-IP, and iControl are trademarks or registered trademarks of F5 Networks, Inc. in the U.S. and certain other countries.
All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries.
CORBA is a registered trademark of Object Management Group, Inc. in the United States.
GIF is the name of a format developed by CompuServe Inc. in the United States and/or other countries.
gzip is the software distributed by FSF(Free Software Foundation) in the United States and/or other countries.
HP-UX is a product name of Hewlett-Packard Development Company, L.P. in the U.S. and other countries.
IIOP is a trademark of Object Management Group, Inc. in the United States.
Intel is a trademark of Intel Corporation in the U.S. and/or other countries.
Internet Explorer is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.
Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
OMG, CORBA, IIOP, UML, Unified Modeling Language, MDA, and Model Driven Architecture are either registered trademarks or trademarks of Object Management Group, Inc. in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle Corporation and/or its affiliates.
Red Hat is a trademark or a registered trademark of Red Hat Inc. in the United States and other countries.
SOAP is an XML-based protocol for sending messages and making remote procedure calls in a distributed environment.
All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc., in the United States and other countries. Products bearing SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.
UNIX is a registered trademark of The Open Group in the United States and other countries.
VisiBroker is a trademark or registered trademark of Micro Focus IP Development Limited or its subsidiaries or affiliated companies in the United Kingdom, United States, and other countries.
Win32 is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.
Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Eclipse is an open development platform for tools integration provided by Eclipse Foundation, Inc., an open source community for development tool providers.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
The other company names and product names are either trademarks or registered trademarks of the respective companies. Throughout this document Hitachi has attempted to distinguish trademarks from descriptive terms by writing the name with the capitalization used by the manufacturer, or by writing the name with initial capital letters. Hitachi cannot attest to the accuracy of this information. Use of a trademark in this document should not be regarded as affecting the validity of the trademark.