12.2.2 usrconf.properties (User property file for Java applications)
- Organization of this subsection
(1) Format
J2SE property file format.
Specify the key as follows:
key-name=value
- Specification method
-
-
The string up to the linefeed is a value.
-
The line beginning with a hash mark (#) is a comment.
-
If you define a line without a value, the line is ignored.
-
You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.
(Example) key-name=value#comment
-
Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.
-
If the format does not conform to Java specifications, the Java application might fail to start.
(Example) When the format contains an invalid Unicode escape sequence (the string after "\u" is not an appropriate Unicode hexadecimal value).
-
(2) File storage location
-
In Windows
user-definition-file-storage-directory#/usrconf.properties
-
In UNIX
user-definition-file-storage-directory#/usrconf.properties
- #
-
This is the directory specified in the user definition file storage location environment variable (CJCLUSRCONFDIR). If this environment variable is not set, the system references the current directory. For details on the environment variable settings required to execute EJB client applications, see 3.3.4 Environment variable settings required to execute EJB client applications in the manual uCosminexus Application Server EJB Container Functionality Guide.
(3) Functionality
This file specifies the system properties of the JavaVM that executes the Java application when you use the cjclstartap command.
If you specify the same key in the usrconf.properties file and in -D of add.jvm.arg of the usrconf.cfg file, the value specified in usrconf.properties is given priority.
If you change the contents of this file while the Java application is running, the changes are applied only when the Java application is started next.
(4) Keys for customizing the Java applications
You can customize the operations of the Java applications by setting values for the following system property keys in the start command of the Java application:
The keys are classified and explained as follows:
The following table lists the keys that you can specify in the usrconf.properties file for the Java applications:
- Important note
-
The following contents are explained:
-
Overview of the keys that you can specify in the usrconf.properties file for the Java applications
Of the keys that can be specified, those that are common with the usrconf.properties file for the J2EE server are not explained in detail here.
For details on the common keys, see 2.2.3 usrconf.properties (User property file for J2EE servers). In the case of Java applications, read 'Java application' in place of 'J2EE server'.
This subsection also explains the details of keys, if the specification contents and the keys for J2EE server differ greatly.
-
Differences with the keys for J2EE server (when the keys and the specification contents of the usrconf.properties file for J2EE server are different)
This subsection explains the details about the keys when specifications for the Java application keys and the J2EE server keys are different. If differences are not specifically coded, specify the same contents as the keys of the usrconf.properties file for the J2EE server. Note the differences in the Difference column.
-
Details of the usrconf.properties file-specific keys for the Java application
This subsection explains the details of the usrconf.properties file-specific keys for the Java applications.
-
(a) Keys beginning with ejbserver.application
The keys that begin with ejbserver.application and can be specified in the usrconf.properties file for Java applications are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.2.3(5)(a) Keys beginning with ejbserver.application.
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(a) Keys beginning with ejbserver.application.
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(a) Keys beginning with ejbserver.application.
- #1
-
Use the handler name to differentiate between the property values. Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name. If you specify default, handler name indicates a property that is recognized as the common default value by all CJLogHandler.
- #2
-
Logger name has "." that is specified for getting the instances of logger by Logger.getLogger (logger-name). Logger name must be declared beforehand in the ejbserver.application.userlog.loggers property. For details on the logger name, follow the specifications of java.util.logging.Logger.
Specify a class character set from 1 to 1024 bytes beginning with a single-byte alphanumeric character for the handler name. If you specify default, handler name indicates a property that is recognized as the common default value by all CJLogHandler.
The properties identified by the logger names are used for initializing the logger class of the user log functionality.
If a logger name ends with .handlers, there may be confusion when the properties of ejbserver.application.userlog.Logger.logger-name.handlers are specified, and therefore, Hitachi recommends that you do not end a logger name with ".handlers".
(b) Keys beginning with ejbserver.client
The keys that begin with ejbserver.client and can be specified in the usrconf.properties file for the Java application are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.2.3(5)(c) Keys beginning with ejbserver.client.
When using uCosminexus Client, read the storage directory Cosminexus-installation-directory\CC as Cosminexus-installation-directory \CCL.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
None |
Specify the priority (priority order) for extracting the request accumulated in the queues within CTM. |
-- |
|
Unique |
Specify a value from 1 to 16 bytes for the name of the log output directory of the messages output by the Java application under the directory specified in the ejbserver.client.log.directory key. You can specify only single byte alphanumeric characters, underscore (_), and hyphen (-). You use a forward slash (/) as the directory path delimiter. When using multiple Java applications, specify the log output destinations for every EJB application. When the specified directory name or file name does not have access permission, the message KDJE51003-E is output in standard output and cjlogger.log file and the Java application is terminated. The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.ejb.log key in the option definition file for Java applications (usrconf.cfg). |
None |
|
Unique |
Specify a value from 1 to 16 bytes for the log output subdirectory of the Java application. You can specify only single byte alphanumeric characters, underscore (_), and hyphen (-). When this key is specified, the same subdirectory is used every time and therefore, the subdirectory is not deleted. If you use this key in the cases where you do not invoke one Java application many times, then you can manage the log file in an exclusive subdirectory. Do not specify this key when concurrently invoking multiple applications. If the specified string exceeds 16 bytes, the message KDJE51002-W is output to the cjlogger.log file and normal value is used. The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.log.appid key in the option definition file for Java applications (usrconf.cfg). |
None |
|
Unique |
Specify a value from 1 to 200 bytes for the absolute path of the log output destination of the Java application. You can specify only single byte alphanumeric characters, underscore (_), hyphen (-), and space (). You can specify space only in Windows. To specify a directory containing whitespace#, enclose the path with double quotation marks ("). For example, when setting C:\logs\ejb client, specify the path as follows: ejbserver.client.log.directory="C:\logs\ejb client" When the specified path exceeds 200 bytes, the message KDJE51001-W is output to the cjlogger.log file and the normal value is used. When a path is not specified, the message KDJE51002-W is output to the cjlogger.log file and the normal value is used. When there is no access permission to the directory or when the file name is specified, the message KDJE51003-E is output to standard output and cjlogger.log file and the Java application is terminated. In the case of using normal value, if you invoke the Java application by using Java other than the Cosminexus Developer's Kit for Java, the message KDJE51004-W is output to the cjlogger.log file and Java application execution directory is used. In Windows, you cannot specify a path that includes a UNC name. In UNIX, you cannot specify a path of an nfs-mounted disk. The output destination for some logs cannot be changed with this key. To change the log output destination, specify the ejb.client.log.directory key in the option definition file for Java applications (usrconf.cfg). |
None |
|
Unique |
Specify the retry interval (unit: milliseconds) as integers from 0 to 2147483647 for failure in an attempt of exclusive processing of log files. If the specified value is out of the range or is not an integer, the message KDJE51002-W is output to the cjlogger.log file and the default value is used. This key is used when the Java application operating in the subdirectory common mode terminates after the output of the message KDJE90002-E to the cjlogger.log file. |
10 |
|
Unique |
If the exclusive process of the log file fails, specify the retry frequency (unit: times) in integers from 0 to 2147483647. If the specified value is out of the range and is not an integer, the message KDJE51002-W is output to the cjlogger.log file and the default value is used. This key is used when the Java application operating in the subdirectory common mode terminates after the output of the message KDJE90002-E to the cjlogger.log file. |
1000 |
|
Unique |
Specify a string from 1 to 128 characters for the client name used by the transaction service. You can specify single byte alphanumeric characters, (0-9, A-Z, a-z), underscore (_) and hyphen (-). You need to specify a client name that is different for each process of the Java application. Moreover, you need to specify a client name that is different from the name of the J2EE server operating on the same machine. |
None |
|
Unique |
Specify whether transaction is to be used in the Java application.
|
false |
Legend:
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(c) Keys beginning with ejbserver.client.
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(c) Keys beginning with ejbserver.client.
- #
-
Whitespace imply single-byte spaces, tabs, LF (0x0a), CR (0x0d) or FF (0x0c).
(c) Keys beginning with ejbserver.container
The keys that begin with ejbserver.container and can be specified in the usrconf.properties file for the Java application are listed below. For details about the usrconf.properties file for J2EE servers and the common keys, see 2.2.3(5)(h) Keys beginning with ejbserver.container.
Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.
Key name |
Difference |
Contents |
Default value |
Related information |
---|---|---|---|---|
None |
Specify re-connection and re-sending of requests in the EJB client, in the case of a communication failure when invoking the EJB method. |
-- |
2.13 Invoking the EJB remote interface in EJB Container Functionality Guide |
Legend:
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(h) Keys beginning with ejbserver.container.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(h) Keys beginning with ejbserver.container.
(d) Keys beginning with ejbserver.distributedtx
The keys that begin with ejbserver.distributedtx and can be specified in the usrconf.properties file for the Java application are described below. For details about the keys that are common with the usrconf.properties file of J2EE servers, see 2.2.3(5)(k) Keys beginning with ejbserver.distributedtx.
Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.
Key name |
Difference |
Contents |
Default value |
Related information |
---|---|---|---|---|
Exists |
Specify the directory for storing the status file of the in-process transaction service and the backup of the status file as maintenance data. You use a forward slash (/) as the path delimiter. When an absolute path is specified in the application server, the path begins from the following directory:
When an absolute path is specified in the Java, the path begins from the execution directory of the Java. You need to specify a different directory so that the path does not overlap with the path of other J2EE servers or other Java application processes running on the same machine. |
None |
3.4 Managing transactions in Common Container Functionality Guide |
|
None |
When replicating the status file of in-process transaction service, specify a directory that stores the backup of spare status files and the spare status files used as maintenance data. |
-- |
3.4 Managing transactions in Common Container Functionality Guide |
|
Exists |
Specify an integer from 1 to 65535 for the fixed port number that is used for transaction recovery. If an invalid value is specified and when the specified port is already being used, an error occurs in the initialization process. |
None |
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(k) Keys beginning with ejbserver.distributedtx.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(k) Keys beginning with ejbserver.distributedtx.
- Blank column:
-
Related information does not exist.
(e) Keys beginning with ejbserver.jndi
The keys that begin with ejbserver.jndi and can be specified in the usrconf.properties file for the Java application are listed below. For details on the keys that are common with the usrconf.properties file for the J2EE server, see 2.2.3(5)(s) Keys beginning with ejbserver.jndi.
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(s) Keys beginning with ejbserver.jndi.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(s) Keys beginning with ejbserver.jndi.
(f) Keys beginning with ejbserver.jta
The keys that begin with ejbserver.jta and can be specified in the usrconf.properties file for the Java application are listed below:
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Exists |
Specify the transaction timeout default value (units: seconds) of the transaction that has been started in the Java application in the following range: 1 to 2147483647 |
-- |
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(t) Keys beginning with ejbserver.jta.
(g) Keys beginning with ejbserver.logger
The keys that begin with ejbserver.logger and can be specified in the usrconf.properties file for the Java application are listed below:
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Exists |
Specify the number of log files of the Java application. Specify integers from 1 to 64. To change the number, stop all the processes that are generating output to the corresponding log file and either move the log file and the log management file under the mmap directory to a different directory or delete the files. |
2 |
|
Exists |
Specify integers from 4096 to 16777216. To change the size, stop all the processes that are generating output to the corresponding log file and either move the log file and the log management file under the mmap directory to a different directory or delete the files. |
1048576 |
|
Exists |
Specify the log level. Specify either one or more from among Error, Warning, Information and Debug. If you specify only one log level, only the log of the applicable log level is output. When specifying more than one log levels, demarcate each level-name string with a comma (,). Note that you cannot specify this key when you set the system properties using shell script. |
Error |
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- #
-
You can set the following names as channel name:
ClientMessageLogFile, ClientExceptionLogFile, ClientMaintenanceLogFile, EJBContainerLogFile, UserOutLogFile, or UserErrLogFile.
For details on obtaining materials, see 2.3 Acquiring the Data in the manual uCosminexus Application Server Maintenance and Migration Guide.
(h) Keys beginning with ejbserver.rmi
The keys that begin with ejbserver.rmi and can be specified in the usrconf.properties file for the Java application are listed below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.2.3(5)(y) Keys beginning with ejbserver.rmi.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
None |
Specify timeout period (unit: seconds) when communicating between clients and the server. |
-- |
Legend:
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(y) Keys beginning with ejbserver.rmi.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(y) Keys beginning with ejbserver.rmi.
(i) Keys beginning with ejbserver.security
The keys that begin with ejbserver.security and can be specified in the usrconf.properties file for the Java application are listed below:
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Unique |
Specify the CORBA naming service that is connected to the J2EE server that performs the security authentication processing. Specify this key in the case of performing the authentication processing with the J2EE server that is connected to a naming service other than the naming service specified in java.naming.provider.url. Note that you need to specify the name of the J2EE server to be connected beforehand in the ejbserver.serverName key. Specify the name using the corbaname format. When the name is not specified, the naming service specified in java.naming.provider.url is used. (Specified format) corbaname::host-name-of-the-naming-service:port-number-of-the-naming-service |
None |
Legend:
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
(j) Keys beginning with ejbserver.server
The keys that begin with ejbserver.server and can be specified in the usrconf.properties file for the Java application are listed below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.2.3(5)(aa) Keys beginning with ejbserver.server.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Unique |
Specify the name of the J2EE server that connects to the Java application. |
None |
|
None |
Specify the PRF identifier. |
-- |
Legend:
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(aa) Keys beginning with ejbserver.server.
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default values, see 2.2.3(5)(aa) Keys beginning with ejbserver.server.
(k) Keys beginning with ejbserver.stdoutlog
The keys that begin with ejbserver.stdoutlog and can be specified in the usrconf.properties file for Java applications are as follows. For details about the keys that are common with the usrconf.properties file of J2EE servers, see 2.2.3(5)(ac) Keys beginning with ejbserver.stdoutlog.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
None |
Specify whether to enable the automatic flush functionality of the user output log and user error log. |
-- |
Legend:
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about keys, see 2.2.3(5)(ac) Keys beginning with ejbserver.stdoutlog.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about default values, see 2.2.3(5)(ac) Keys beginning with ejbserver.stdoutlog.
(l) Keys beginning with https
The keys that begin with https and can be specified in the usrconf.properties file for Java applications are as follows. For details on the keys that are common with the usrconf.properties file for J2EE servers, see 2.2.3(5)(af) Keys beginning with https.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
None |
Specify the recommended cipher suite to be used with HttpsURLConnection. |
-- |
|
None |
Set up the protocol to be used with HttpsURLConnection. |
-- |
Legend:
- None:
-
This key is common to the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details on the keys, see 2.2.3(5)(af) Keys beginning with https.
- --:
-
This is a default value common to the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details on the default values, see 2.2.3(5)(af) Keys beginning with https.
(m) Keys beginning with java
The keys that begin with java and that can be specified in the usrconf.properties file for the Java application are listed below. For details about the usrconf.properties file for J2EE servers and the common keys, see 2.2.3(5)(ag) Keys beginning with java.
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about keys, see 2.2.3(5)(ag) Keys beginning with java.
(n) Keys beginning with org
The keys that begin with org and can be specified in the usrconf.properties file for the Java application are listed below:
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Unique |
Specify the implementation class name of org.w3c.dom.DOMImplementationSourceList. |
com.cosminexus.jaxp.impl.parsers.dom.DOMXSImplementationSourceImpl |
|
Unique |
Specify the implementation class name of org.xml.sax.driver. |
com.cosminexus.jaxp.impl.parsers.parsers.SAXParser |
|
Unique |
Specify the implementation class name of org.xml.sax.parser. |
org.xml.sax.helpers.XMLReaderAdapter |
Legend:
- Unique:
-
This is a key specific to the usrconf.properties file for Java applications. For details about keys, see the Contents column.
(o) Keys beginning with vbroker
The keys that begin with vbroker and can be specified in the usrconf.properties file for the Java application are described below. For details about the keys that are common in the usrconf.properties file for J2EE servers, see 2.2.3(5)(ai) Keys beginning with vbroker.
Key name |
Difference |
Contents |
Default value |
---|---|---|---|
Exists |
For a Java application that invokes only a J2EE server, specify false. TPBroker naming services that implement the communication processing of a J2EE server include the CORBA Naming Service and Smart Agent. For the communication between a Java application and a J2EE server, only the CORBA Naming Service is used as a naming service. Therefore, it is necessary to start only the CORBA Naming Service between the J2EE server and Java application. This is the reason you specify false for this key in this case. On the other hand, for a Java application that invokes a TPBroker server application by using the Smart Agent in addition to invoking a J2EE server, you need to start both the CORBA Naming Service and Smart Agent. In this case, specify true for this key. |
true |
|
None |
Specify whether to control the closing of the connections when a timeout occurs during the invocation of the EJB method defined as the remote interface.
|
false |
|
Exists |
Specify an upper limit of the entry count for one communication trace file of the Cosminexus TPBroker. |
20000 |
|
None |
Specify an upper limit value of the communication trace file count for Cosminexus TPBroker. |
15 |
|
Exists |
Specify whether to collect module traces.
|
true |
|
Exists |
Specify a range of 1 to 210 bytes for the path of the output destination of Cosminexus TPBroker trace files. Specify a unique path for each Java application. You need to create comtrc and mdltrc as the subdirectories of the specified path beforehand. In the case of default output destination, the subdirectories comtrc and mdltrc are created automatically when the Java application is invoked for the first time. Use a forward slash (/) as the delimiter in the directory path. For example, specify as follows to set up /temp/work as the work directory: vbroker.orb.htc.tracePath=/temp/work |
|
Legend:
- Exists:
-
There is a difference in the keys of the usrconf.properties file for Java applications and the keys of the usrconf.properties file for J2EE servers. For details about keys, see the Contents column.
- None:
-
This key is common in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the default value, see 2.2.3(5)(ai) Keys beginning with vbroker.
- --:
-
This is a common default value in the usrconf.properties file for Java applications and the usrconf.properties file for J2EE servers. For details about the keys, see 2.2.3(5)(ai) Keys beginning with vbroker.
(5) Examples of coding
java.naming.provider.url=corbaname::localhost:900 ejbserver.serverName=MyServer