Hitachi

uCosminexus Application Server Definition Reference Guide


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

Organization of this subsection

(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

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

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

(a) 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.

| (Vertical bar)

--

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 (-), vertical bars (|), 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".

(b) Keys beginning with ejbserver.bv

Key name

Contents

Default value

VR

ejbserver.bv.limit.max_validation_message

Specify the threshold value for issuing an alert for the string length during the message interpolation processing performed when constraint violation occurs. You can specify a value in the range from 1 to 2147483647. If you specify a value larger than the value of the system property, the system outputs the KDJE60110-W message and continues the processing. If you specify a non-numeric value or a numeric value outside the specifiable range, the system outputs the KDJE60111-W message and sets the default value.

10000

09-85

(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

--

3.14.8 Optimizing the container-managed sign-on for DB Connector in the Common Container Functionality Guide

ejbserver.connectionpool.association.enabled

Specify whether to enable the connection association functionality.

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.

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

--

2.11.2 Timeout of a Stateful Session Bean in the EJB Container Functionality Guide

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.

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

--

3.3.5 CTM domains and CTM domain managers in the Expansion Guide

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

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

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

false

08-00

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

--

15.8.6 Update detection interval for J2EE applications in the Common Container Functionality Guide

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

--

15.8.2 Scope of reloading in the Common Container Functionality Guide

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

--

15.8.7 Interval for updating the J2EE application configuration file in the Common Container Functionality Guide

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 Used with a 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.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. 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 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

--

ejbserver.distributedtx.XATransaction.enabled

Specify whether to use a global transaction.

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

--

3.4.2 Local transaction and global transaction in the Common Container Functionality Guide

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.

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

--

3.7.3 Dynamic class loading in the EJB Container Functionality Guide

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. Operations of 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 the port number for the management server. You can specify an integer in the range from 1 to 65535.

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.

28008

11-00

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

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.javaee.batch.J2EE-application-name.appTag

Changes the application tag for Java batch processing.

Specify a string as the application tag if the job repository needs to be shared with multiple J2EE servers in cases such as when the system is set up in a cluster or HA configuration.

J2EE-server-name:J2EE-application-name

11-00

ejbserver.javaee.batch.J2EE-application-name.executorService.jndiName

Specify a string as the JNDI name of the thread pool used for Java batch processing for each application.

If you specify an asterisk (*) for the J2EE-application-name portion of the key name, the specified value becomes the default value applied to all applications on the target J2EE server.

concurrent/__BatchExecutorService

11-00

ejbserver.javaee.batch.executorService.JNDI-name.keepAliveTime

Specify the maximum time (in seconds) during which the threads in the thread pool used for Java batch processing except the minimum threads required can remain after they are used until they are reused. You can specify an integer in the range from 0 to 2147483647. If the specified time elapses before a thread is reused, the thread is discarded.

For the JNDI-name portion, specify the JNDI name of the target thread pool used for Java batch processing.

60

11-00

ejbserver.javaee.batch.executorService.JNDI-name.maxThreads

Specify the maximum number of threads in the thread pool used for Java batch processing. You can specify an integer in the range from 0 to 2147483647.

For the JNDI-name portion, specify the JNDI name of the target thread pool used for Java batch processing.

2147483647

11-00

ejbserver.javaee.batch.executorService.JNDI-name.minThreads

Specify the minimum number of threads in the thread pool used for Java batch processing. You can specify an integer in the range from 0 to 2147483647.

For the JNDI-name portion, specify the JNDI name of the target thread pool used for Java batch processing.

0

11-00

ejbserver.javaee.batch.executorService.JNDI-name.queueSize

Specify the maximum number of tasks that can be put in the queue of the thread pool used for Java batch processing. You can specify an integer in the range from 0 to 2147483647.

For the JNDI-name portion, specify the JNDI name of the target thread pool used for Java batch processing.

2147483647

11-00

ejbserver.javaee.batch.jobRepository.autoCreate.enabled

Specify whether the job repository for Java batch processing is generated automatically.

If you specify true (case insensitive):

The job repository for Java batch processing is generated automatically.

In other cases:

The job repository for Java batch processing is not generated automatically.

false

11-00

ejbserver.javaee.batch.jobRepository.jndiName

Specify a string as the JNDI name of the data source to be made persistent in the job repository for Java batch processing.

Use the user-specified name space functionality of DBConnector to specify an optional name in the JNDI name space, and then specify the optional name for this property.

jdbc/__BatchPool

11-00

ejbserver.javaee.cdi.beansXmlRequired

Specify whether to make only the archives in which beans.xml exists be subject to management of CDI in compliance with the CDI 1.0 specifications in the same way as in version 09-70 or earlier.

If you specify true (case insensitive):

Only the archives in which beans.xml exists are managed by CDI.

In other cases:

All archives are managed by CDI, regardless of whether beans.xml exists.

false

11-00

ejbserver.javaee.concurrent.hungCheckIntervalSeconds

Specify the interval (in seconds) at which to check for non-responding tasks with Concurrency Utilities. You can specify an integer in the range from 1 to 2147483647.

60

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.awaitTerminationSeconds

Specify the maximum time (in seconds) for which to wait until the task that is being executed by the ManagedExecutorService specified by JNDI-name in Concurrency Utilities ends when the J2EE server stops. You can specify an integer in the range from 0 to 2147483647.

If you specify 0, Concurrency Utilities are forcibly terminated without waiting for the task to end.

0

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.corePoolSize

Specify the initial number of threads for the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647.

16

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.hungAfterSeconds

Specify the thread execution time (in seconds) before the thread is judged to be non-responding if false is set for longRunningTasks of the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If you specify 0 or a smaller value, the task is not judged to be non-responding.

0

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.keepAliveSeconds

Specify the maximum time (in seconds) for which to wait before the used threads other than the initial number of threads are reused for the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If the specified time elapses before a thread is requested to be used for execution, the thread is discarded.

60

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.longRunningTasks

Specify whether the ManagedExecutorService specified by JNDI-name in Concurrency Utilities is a long-running task.

If you specify false:

If a task does not end before the time specified with hungAfterSeconds elapses after the task started, the task is judged to be non-responding and the KDJE60831-W message is output to the message log.

If you specify true:

No judgment is performed.

false

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.maxPoolSize

Specify the maximum number of threads for the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. No more threads than the specified number are generated.

16

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.taskQueueCapacity

Specify the maximum number of tasks that can be put in the queue for the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647.

If more tasks than the initial number of tasks are requested to run concurrently, the tasks that cannot run are put in the queue. If the queue becomes full, new threads are generated. In the case where the maximum number of threads is reached and the queue is full, if a request to start another task is issued, a java.util.concurrent.RejectedExecutionException is thrown and the request is rejected.

2147483647

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.threadLifeTimeSeconds

Specify the time (in seconds) before discarding the threads that are no longer used for the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If you specify 0, the threads are always reused without being discarded.

0

11-00

ejbserver.javaee.concurrent.managedExecutorService.JNDI-name.threadPriority

Specify the priority of threads generated by the ManagedExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 1 to 10.

5

11-00

ejbserver.javaee.concurrent.managedExecutorService.jndiNames

Specify the JNDI name (as a string value) for the ManagedExecutorService in the user definition of Concurrency Utilities. If you specify multiple JNDI names for lookup use, specify them as a comma-separated list.

None

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.awaitTerminationSeconds

Specify the maximum time (in seconds) for which to wait until the task being executed by the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities ends when the J2EE server stops. You can specify an integer in the range from 0 to 2147483647. If you specify 0, the task is forced to end immediately.

0

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.corePoolSize

Specify (as a string value) the number of initial number of threads for the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities.

None

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.hungAfterSeconds

Specify the thread execution time (in seconds) before the thread is judged to be non-responding if false is set for longRunningTasks of the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If you specify 0 or a smaller value, the task is not judged to be non-responding.

0

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.keepAliveSeconds

Specify the maximum time (in seconds) for which to wait before the used threads other than the initial number of threads are reused for the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If the specified time elapses before a thread is requested to be used for execution, the thread is discarded.

60

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.longRunningTasks

Specify whether the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities is a long-running task.

If you specify false:

If a task does not end before the time specified with hungAfterSeconds elapses after the task started, the task is judged to be non-responding and the KDJE60818-W message is output to the message log.

If you specify true:

No judgment is performed.

false

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.threadLifeTimeSeconds

Specify the time (in seconds) before discarding the threads that are no longer used for the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 0 to 2147483647. If you specify 0, the threads are always reused without being discarded.

0

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.JNDI-name.threadPriority

Specify the priority of threads generated by the ManagedScheduledExecutorService specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 1 to 10.

5

11-00

ejbserver.javaee.concurrent.managedScheduledExecutorService.jndiNames

Specify the JNDI name (as a string value) for the ManagedScheduledExecutorService in the user definition of Concurrency Utilities. If you specify multiple JNDI names for lookup use, specify them as a comma-separated list.

None

11-00

ejbserver.javaee.concurrent.managedThreadFactory.JNDI-name.threadPriority

Specify the priority of threads generated by the ManagedThreadFactory specified by JNDI-name in Concurrency Utilities. You can specify an integer in the range from 1 to 10.

5

11-00

ejbserver.javaee.concurrent.managedThreadFactory.jndiNames

Specify the JNDI name (as a string value) for the ManagedThreadFactory in the user definition of Concurrency Utilities. If you specify multiple JNDI names for lookup use, specify them as a comma-separated list.

None

11-00

ejbserver.javaee.jaxrs.config.client.connectTimeout

Specify the default value (in milliseconds) of the jersey.config.client.connectTimeout client configuration property for the JAX-RS Client API. You can specify an integer in the range from 0 to 2147483647.

If you specify 0, no timeout occurs.

0

11-00

ejbserver.javaee.jaxrs.config.client.readTimeout

Specify the default value (in milliseconds) of the jersey.config.client.readTimeout client configuration property for the JAX-RS Client API. You can specify an integer in the range from 0 to 2147483647.

If you specify 0, no timeout occurs.

0

11-00

ejbserver.javaeeLogfilter.msgids

Specify (as a string value) a comma-separated list of the IDs of installation-base-log messages that are not to be output to the message log and exception log. A space, tab, line break, or another character must not be placed between a message ID and a comma.

The log messages whose IDs are included in the list are redirected from the message log or exception log to the maintenance log.

If the same message ID is specified more than once, the second and subsequent specifications are ignored.

None

11-00

(r) 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

(s) 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.

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

--

3.14.7 Caching the DataSource objects in the Common Container Functionality Guide

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

--

2.11.5 Timeout of RMI-IIOP communication in the EJB Container Functionality Guide

Legend:

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

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

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

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.jta.TransactionManager.defaultTimeOut

Specify the default value (in seconds) for the timeout time of transactions started on J2EE servers. You can specify an integer in the range from 1 to 2147483647.

180

--

3.15.8 Transaction timeout and statement collection in the Common Container Functionality Guide

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.access_log.nio_http.enabled

Specify whether to enable the access logger for the HTTP communications handled on the NIO HTTP server.

If you specify true:

The HTTP access logger is enabled.

If you specify false:

The HTTP access logger is disabled.

true

11-00

ejbserver.logger.access_log.nio_http.format

Specify the format of the access log for the HTTP communications handled on the NIO HTTP server.

%h %{X-Forwarded-For}i %l %u %d %rootap "%r" %s %b %D %S

11-00

ejbserver.logger.access_log.websocket.enabled

Specify whether to enable the access logger for the WebSocket communications handled on the NIO HTTP server.

If you specify true:

The WebSocket access logger is enabled.

If you specify false:

The WebSocket access logger is disabled.

false

11-00

ejbserver.logger.access_log.websocket.format

Specify the format of the access log for the WebSocket communications handled on the NIO HTTP server.

For n of the %PAYLOADDATA(n) format argument, specify an integer in the range from 1 to 32768.

You cannot specify both of the %PAYLOADDATA and %PAYLOADDATA(n) format arguments.

%TS %IO %OPCODE %ROOTAP %URI %FIN %PAYLOADDATALEN %CLIENTAP %CLOSEREASON

11-00

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.channels.define.NIOHTTPAccessLogFile.filenum

Specify the number of log files used by the access logger for the HTTP communications handled on the NIO HTTP server. You can specify an integer in the range from 1 to 16.

16

11-00

ejbserver.logger.channels.define.NIOHTTPAccessLogFile.filesize

Specify (in bytes) the size of each log file used by the access logger for the HTTP communications handled on the NIO HTTP server. You can specify an integer in the range from 4096 to 2147483647.

4194304

11-00

ejbserver.logger.channels.define.WebSocketAccessLogFile.filenum

Specify an integer from 1 to 16 for the number of log files to use with the WebSocket access log functionality handled via the NIO HTTP server.

16

11-00

ejbserver.logger.channels.define.WebSocketAccessLogFile.filesize

Specify an integer from 4096 to 2147483647 (unit: bytes) for the size of the log files to use with the WebSocket access log functionality handled via the NIO HTTP server.

4194304

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

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

  • 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. Preparing 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. Preparing 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, 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 the 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.

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.management.JVM.stats_monitor.FullGCCount.enabled

Specify whether to enable the monitoring of the frequency of Full GC.

true:

Enable.

false:

Disable.

true

--

3.4 Event issuing functionality in the Operation, Monitoring, and Linkage Guide

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

10

--

3.4 Event issuing functionality in the Operation, Monitoring, and Linkage Guide

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

600

--

3.4 Event issuing functionality in the Operation, Monitoring, and Linkage Guide

ejbserver.management.statistics.interval

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

60

--

3.3 Statistics File Output Functionality in the Operation, Monitoring, and Linkage Guide

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 h×60+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

--

3.3 Statistics File Output Functionality in the Operation, Monitoring, and Linkage Guide

ejbserver.management.stats_file.num

Specify an integer from 2 to 168 for the number of statistics file.

7

--

3.3 Statistics File Output Functionality in the Operation, Monitoring, and Linkage Guide

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.4 Contents set automatically by Management Server to the 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.4 Contents set automatically by Management Server to the 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 8.2.11 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.

inprocess

--

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.

9

--

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.

1

--

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.

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

--

2.13 Invoking the remote interface of EJB in the EJB Container Functionality Guide

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.

If you specify 0 for this property, a random value is specified.

Therefore, the request reception port might change when the J2EE server is restarted.

A JMX client might send a request to the port that was previously used as the request reception port, but the port might have already been used by another process. To avoid this problem, we recommend that you fix the request reception port for statistics acquisition.

23550

--

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)

--

2.11.5 Timeout of RMI-IIOP communication in the EJB Container Functionality Guide

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

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.security.digest.algorithm

Specify the message digest algorithm that is used for authentication of the security management functionality. You can specify MD5, SHA-1, SHA-256, or another message digest algorithm supported by JDK. For details, see java.security.MessageDigest in the Java SE API reference. If you specify an invalid value, it will be changed to the default value.

If you change the value that has already been set for this property, you must delete the user and then re-create it. This functionality treats different string values as different message digest algorithms.

If you use an algorithm other than SHA-1 to implement security on the EJB client, the version of the EJB client must be 09-70 or later. If the version is earlier than 09-70, authentication fails.

If you implement security on the EJB client whose version is earlier than 09-70, you must use SHA-1 as the digest algorithm on the J2EE server used as an authentication server.

SHA-1

09-70

(aa) 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.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.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.

(ab) 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.

(ac) 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

(ad) 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

--

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, make sure that the same value is set for the following Java VM options:

  • -XX:MetaspaceSize

  • -XX:MaxMetaspaceSize

If different values are set, the system might perform Full GC without generating an alert.

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. The system generates an alert if it detects a symptom that can trigger Full GC under any of the following conditions:

If serial GC is enabled:

  • 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 in the resource depletion monitoring information) of the used metaspace area size to the maximum metaspace area size is more than the threshold value.

If G1 GC is enabled:

  • The ratio (value output for Rate1 in the resource depletion monitoring information) of the used Java heap area size to the maximum Java heap area size is more than the threshold value.

  • The ratio (value output for Rate3 in the resource depletion monitoring information) of the used metaspace area size to the maximum metaspace area 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

--

ejbserver.watch.memory.rate2alert.enabled

Specify whether to enable alert generation for Rate2 in the memory depletion monitoring information that is output by the resource depletion monitoring functionality.

If you specify true:

Alert generation for Rate2 is enabled. Note, however, that if alert generation for Rate2 is enabled when G1 GC is enabled, no alert is generated because Rate2 is always -1.

If you specify false:

Alert generation for Rate2 is disabled.

true

Cosminexus Component Container 09-70-12 or later and 09-80-02 or later

Legend:

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

(ae) 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.

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.

(af) 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.

(ag) 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.

(ah) 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.

(ai) 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.

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

Important 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

Related information

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.

Before you specify true for this property, make sure that the Smart Agent has been started and vbroker.orb.htc.oadNoUse=true has been specified.

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

--

2.14 Fixing the communication port and IP address of the EJB container (TPBroker options) in the EJB Container Functionality Guide

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

(aj) 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

(ak) 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.

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

webserver.connector.http.bind_host

Specify the local IP address that is used by the management server or a local host name that can resolve to the local IP address.

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 (in decimal notation) or host name of the host to be permitted to access the management server.

Note that the local host (the host whose address is associated with localhost#3) can always access the management server implicitly. If this key is omitted, the local host (the host whose address is associated with localhost#3) is the only host that can access the management server.

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.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 2147483639 (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 whitespaces

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.nio_http.backlog

Specify the length (in bytes) of the TCP listen queue that stores connection requests from the Web client. You can specify an integer in the range from 1 to 2147483647.

The maximum valid specified value or the length of the TCP listen queue that is actually set, is different for every OS.

511

11-00

webserver.connector.nio_http.bind_host

Specify the IP address or host name that is used by the NIO HTTP server. Halfwidth spaces before and after the IP address or host name are ignored. If no value is specified, the wildcard address is used.

If the specified host name or IP address is unresolvable:

The KDJE39565-W message is output and the wildcard address is used.

If the host name or IP address of a host that is not the local host is specified:

The KDJE39567-W message is output and the wildcard address is used.

None

11-00

webserver.connector.nio_http.hostname_lookups

Specify whether to perform reverse lookup for conversion of the client's IP address into a host name in response to a request received on the NIO HTTP server.

If reverse lookup of a host name is performed, the throughput is degraded.

If the IP address cannot resolve to a host name, an IP address in a dot-separated format will be output by the getRemoteHost() method of the javax.servlet.ServletRequest interface or to log files.

If you specify true:

The IP address is converted into a host name.

If you specify false:

The IP address is not converted into a host name.

false

11-00

webserver.connector.nio_http.idle_thread_timeout

Specify the maximum length of time (in seconds) for which the threads in the thread pool on the NIO HTTP server can continue to be idle. You can specify an integer in the range from 1 to 2147483647.

60

11-00

webserver.connector.nio_http.keep_alive.max_requests

Specify the maximum number of successive connections that can be continued without closing a TCP connection. You can specify an integer in the range from 0 to 2147483647. If you do not want to set the upper limit, specify 0.

0

11-00

webserver.connector.nio_http.keep_alive.timeout

Specify the time (in seconds) for which to wait for a request without closing a TCP connection. You can specify an integer in the range from 0 to 3600. If you specify 0, no timeout occurs.

0

11-00

webserver.connector.nio_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. Specifying the value 0 indicates that no headers can be included.

Even if the number of included HTTP headers is less than the value of this property, an error occurs if the total header size exceeds the value specified for the webserver.connector.nio_http.limit.max_request_header property.

100

11-00

webserver.connector.nio_http.limit.max_request_body

Specify (in bytes) the maximum request body size of an HTTP request. You can specify an integer in the range from -1 to 9223372036854775807. If you do not want to set the upper limit, specify -1.

If a request body is sent in chunk format, the size of the chunk header must be included in the specified size.

-1

11-00

webserver.connector.nio_http.limit.max_request_header

Specify (in bytes) the maximum request header size of an HTTP request. You can specify an integer in the range from 7 to 65536.

Even if the actual request header size is less than the maximum set for this property, an error occurs if the number of HTTP headers exceeds the value specified for the webserver.connector.nio_http.limit.max_headers property.

The two-byte line break code (CR(0x0d)+LF(0x0A)) that indicates the end of the HTTP header must be included in the specified size.

16384

11-00

webserver.connector.nio_http.max_connections

Specify the maximum number of the Web client connections that can be established. You can specify an integer in the range from 1 to 2147483647. Note that the actually effective maximum value differs depending on the platform.

1024

11-00

webserver.connector.nio_http.max_servlet_execute_threads

Specify the maximum number of concurrently executable threads within the web container when the web container executes synchronous servlets via the NIO HTTP server. You can specify an integer in the range from 1 to 2147483647.

The value you specify must be equal to or less than the maximum number of threads that can be processed on the NIO HTTP server (value specified for the webserver.connector.nio_http.max_threads parameter). If you specify a value larger than the maximum number of threads that can be processed on the NIO HTTP server, the system outputs the KDJE39010-W message and changes the specified value to the number of concurrent executions for which the web container processes the request.

The maximum number of concurrently executable threads that can be controlled by using this parameter includes only the number of threads for synchronous servlets and does not include the number of other threads, such as those for executing asynchronous servlets and for calling back by asynchronous I/O API functions.

The total maximum number of threads that can be processed including those that are not used for executing synchronous servlets is specified by using the

webserver.connector.nio_http.max_threads parameter.

100

11-00

webserver.connector.nio_http.max_threads

Specify the maximum number of threads that can be processed on the NIO HTTP server. You can specify an integer in the range from 1 to 2147483647.

100

11-00

webserver.connector.nio_http.min_threads

Specify the minimum number of threads that can be processed on the NIO HTTP server. You can specify an integer in the range from 1 to 2147483647.

The value you specify must be equal to or less than the maximum number of threads (the value specified for the webserver.connector.nio_http.max_threads parameter). If you specify a value larger than the maximum number of threads, the system outputs the KDJE39010-W message and changes the specified value to the maximum number of threads.

Note that the actually effective maximum value differs depending on the platform.

10

11-00

webserver.connector.nio_http.permitted.hosts

Specify the IP address (in decimal notation) or host name of the host to be permitted to access the NIO HTTP server. To specify multiple IP addresses or host names, specify them as a comma-separated list. 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 whitespaces, the system outputs the KDJE39009-W message and changes the specified value to the default value.

If the host names you specify are unresolvable, the system outputs the KDJE39563-W message and permits only the local host to access the server.

Halfwidth spaces before and after each IP address or host name are ignored.

*

11-00

webserver.connector.nio_http.port

Specify the port number used by the NIO HTTP server. You can specify an integer in the range from 1 to 65535. Do not specify a port number that has already been used by another application or a port number that has not been secured. If you do so, the KDJE39566-E message is output and the J2EE server does not start.

8008

11-00

webserver.connector.nio_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, no timeout occurs.

300

11-00

webserver.connector.nio_http.response.header.server

Specify the value of the Server header that is automatically added to the response.

CosminexusComponentContainer

11-00

webserver.connector.nio_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.

300

11-00

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.14 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).

#3

This is the address that is associated with localhost when the J2EE server starts.

(al) 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.

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

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 HTTP cookie that indicates the server ID to the HTTP response.

If you specify true:

The HTTP cookie that indicates the server ID is added to the HTTP response. Specify the server ID in webserver.container.server_id.value.

If you specify false:

The HTTP cookie that indicates the server ID is not 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

If you choose to add the HTTP cookie that indicates the server ID to the HTTP response, use this key to specify the name of the HTTP cookie. 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

If you choose to add the HTTP cookie that indicates the server ID to the HTTP response, use this key to specify the value of the HTTP cookie. 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.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.

8192

--

2.17 Controlling the number of concurrently executing threads in the Web application in the Web Container Functionality Guide

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

(am) 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.

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

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)

--

15.8 Detecting updates and reloading the J2EE applications in the Common Container Functionality Guide

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

Specify the maximum time (in seconds) for which to wait for completion of asynchronous processing before stopping the application. You can specify an integer in the range from 0 to 2147483647.

If you specify 0, the system waits for 0 seconds, which means that the system does not wait for completion of asynchronous processing. When the specified time elapses, the system stops the application even if there is asynchronous processing that has not yet been completed. The behavior of asynchronous processing that remains after the application stops depends on the implementation of the application. If all asynchronous processing for the application to be stopped is completed before the specified time elapses, the system immediately stops the application.

30

11-00

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.

(an) 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 character 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

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

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

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)

--

15.8 Detecting updates and reloading the J2EE applications in the Common Container Functionality Guide

webserver.jsp.compile.backcompat

Specify the version of the Java language specifications of the Java compiler when you compile the Java source file of a servlet generated from JSP files. Specify this property if the Java source file of a servlet generated from JSP files cannot be compiled because the scripts in the JSP files do not comply with the Java SE 8 language specifications. If the source file of a servlet generated from JSP files can be successfully compiled, you do not need to specify this property.

The values that can be specified are as follows:

1.8 or 8:

Specify this value if the scripts in the JSP files are written with source code that depends on the Java SE 8 language specifications.

1.7 or 7:

Specify this value if the scripts in the JSP files are written with source code that depends on the Java SE 7 language specifications.

1.6 or 6:

Specify this value if the scripts in the JSP files are written with source code that depends on the Java SE 6 language specifications.

false:

Specify this value if no scripts are written in the JSP files or if the written scripts do not depend on any Java SE language specifications earlier than Java SE 7.

In this case, the Java source file is compiled according to the Java SE 8 language specifications.

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

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.prf.output_httpheader

Specify (as a string value) the HTTP header name that is to be output as the operation name in the performance analysis trace event with the ID 0x8236. If you specify nothing, a null character string, or the name of a non-existing header, nothing will be output as the operation name in the event 0x8236.

None

11-00

(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

webserver.servlet_api.unsupported.throwUnsupportedOperationException

Specify whether to throw an UnsupportedOperationException exception when an unsupported API method is invoked.

If you specify true:

An UnsupportedOperationException exception is thrown.

If you specify false:

A specific value that differs depending on the API method is returned as follows:

For the javax.servlet.ServletContext#getJspConfigDescriptor method: null

For the javax.servlet.ServletContext#getVirtualServerName method: Null character

For the javax.servlet.http.HttpServletRequest#changeSessionId method: Session ID of the current HTTP session (If no HTTP session has been created, an IllegalStateException exception is thrown.)

For the javax.servlet.http.HttpServletRequestWrapper#changeSessionId method: Same as the method with the same name in javax.servlet.http.HttpServletRequest

false

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

The specified path of the JAR file must also be specified for add.class.path in the usrconf.cfg file (option definition file for J2EE servers).

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.

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

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

--

2.7 Session management functionality in the Web Container Functionality Guide

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.

--

2.7 Session management functionality in the Web Container Functionality Guide

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

(ay) Keys beginning with mail.mime

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

mail.mime.charset

Specify the default character code set to be used in JavaMail. If this property is omitted, the file.encoding property of J2SE is used. This property allows you to change the default character code set applied to files that are used when messages are sent.

None

--

mail.mime.encodeeol.strict

Specify whether to convert the line break code to CR-LF if the data meets all of the following conditions. If you set false for this property, the line break code is converted.

  • The data contains only ASCII characters.

  • The data includes the CR and LF codes.

false

--

mail.mime.decodetext.strict

Specify whether to decode an invalid email header that violates RFC 2047 (a delimiter is not included at the start of encoded text). Examples of invalid encoding that violates RFC 2047 are as follows:

  • Decoding is not performed if true is set for this property.

  • An email header that violates the RFC is decoded if false is set for this property.

true

--

mail.mime.encodefilename

See the standard specifications.

false

09-50

mail.mime.decodefilename

See the standard specifications.

false

09-50

mail.mime.multipart.ignoremissingendboun

See the standard specifications.

true

09-50

mail.mime.encodeeol.ignoremissingboundaryparameter

See the standard specifications.

true

09-50

mail.mime.encodeparameters

See the standard specifications.

false

09-50

mail.mime.decodeparameters

See the standard specifications.

false

09-50

Legend:

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

(az) Keys beginning with manager.j2ee

The Management Server automatically sets this content in a J2EE server. Note that Default value is the value that is assumed when a key is not specified.

Because this key is used internally, do not specify or change the settings if nothing is specified.

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

Key name

Contents

Default value

VR

manager.j2ee.compat

Specifies information required to link with the Management Server. Because the Management Server automatically specifies this information, you cannot edit this key manually. For details about the information that the Management Server specifies automatically, see Appendix E.4 Contents set automatically by Management Server to the J2EE server in the manual uCosminexus Application Server System Setup and Operation Guide.

none

11-00

(6) Examples of coding

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