5.2.3 usrconf.properties (System property file for server management commands)
- Organization of this subsection
(1) Format
J2SE property file format.
Specify the key as follows:
key-name=value
- Specification methods
-
-
The string up to the linefeed is a value.
-
The line beginning with a hash mark (#) is a comment.
-
If you define a line without a value, the line is ignored.
-
You cannot add alphanumeric strings such as spaces and comments after the value. If you add such values, they will be considered as invalid.
(Example) key-name=value#comment
-
Use the ISO 8859-1 character encoding according to the Java specifications for the characters to be encoded.
-
(2) File storage location
-
In Windows
Cosminexus-installation-directory\CC\admin\usrconf\
-
In UNIX
/opt/Cosminexus/CC/admin/usrconf/
(3) Functionality
This file specifies the system properties of the JavaVM that executes the server management commands.
(4) Reserved keys of server management commands
The server management commands internally use the keys beginning with the following prefixes. As a result, the keys beginning with these prefixes must not be used in applications.
-
ejbserver.*
-
webserver.*
-
appclient.*
-
j2eeserver.*
(5) Keys for customization of server management commands
In the server management commands, you can customize the operations of a J2EE server by setting a value in the keys of the following system properties:
The keys are classified and explained as follows:
(a) Keys beginning with ejbserver.cui
Key name |
Contents |
Specifiable value |
Default |
VR |
---|---|---|---|---|
Specify how to check the methods in the property file specified in the arguments while executing the cjsetappprop command or cjsetresprop command. The methods specified in the following tags of the property file are the arguments of the check method:
|
Specify one of the following values:
|
false |
07-50 |
|
Specify whether to return the exit code "1", when execution is no longer possible due to an exclusive error during the execution of a server management command.
|
Specify one of the following values:
|
false |
06-00 |
|
Specify whether to adopt the log output form of version 07-00 and later or the log output form of version 06-70 and earlier. The specifiable values and the operation are as follows:
If you specify an invalid value (other than all characters of true or false in lower-case), a message is output and the default value will be set. If operations are performed by Eclipse Plug-in using Management Server, this specification becomes invalid and the value is assumed as false. Note that you can calculate the disk space required for the log output directory of the server management commands using the following expression:
For details on the disk space required to output the TPBroker trace information, see the description related to disk occupancy in TPBroker Operation Guide. |
Specify one of the following values:
|
false |
07-00 |
|
Specify when an optional name is specified in the EJBHome object from the server management command, when using the JNDI functionality for managing the user-specified namespace.
|
Specify one of the following values:
|
true |
05-05 |
Location where the methods are specified in the property file |
Values specified for the properties |
|
---|---|---|
true |
false |
|
<method-permission> |
Y |
Y |
<container-transaction> |
N |
Y |
<exclude-list> |
Y |
Y |
<ejb-method-observation-timeout> |
N |
Y |
<ejb-transaction-timeout> |
N |
Y |
(b) Key beginning with ejbserver.deploy
Related information is the reference location for information related to the specified key. uCosminexus Application Server is omitted from the manual names.
Key name |
Contents |
Specifiable value |
Default |
VR |
Related information |
---|---|---|---|---|---|
Specify whether to ignore an exception that occurs when the class is loaded for acquiring the annotation information.
|
The strings that you can specify are as follows:
|
false |
08-00 |
14.3 Classes to be loaded and the class path required for loading the classes in the Common Container Functionality Guide |
(c) Key beginning with ejbserver.logger
Key name |
Contents |
Specifiable value |
Default |
VR |
---|---|---|---|---|
Specify the log level output by a server management command. If you specify only one log level, only the log of the applicable log level is output. When specifying multiple log levels, demarcate each level-name string with a comma (,). Specify either one or more from among Error, Warning, Information and Debug. Normally, use the default value. |
Specify the following strings using a comma (,) as a delimiter:
|
Error, Warning |
06-00 |
(d) Keys beginning with ejbserver.naming
Key name |
Contents |
Specifiable value |
Default |
VR |
---|---|---|---|---|
Specify the host name or the IP address that the CORBA Naming Service invokes during the execution of a server management command. When using the name switching functionality, do not use "localhost" as the host name. Specify the host name or the IP address that the CORBA Naming Service invokes. If the CORBA Naming Service is used in the automatic invocation mode (ejbserver.naming.startupMode=automatic or inprocess), specify either the default value ("localhost"), or the host name or IP address that starts the J2EE server. |
Specify one of the following values:
|
localhost |
06-00 |
|
While executing the server management command, specify the port number of the CORBA Naming Service used as the Naming Service by the J2EE server. |
Specify the value using an integer from 1 to 65535. |
900 |
06-00 |
|
Specify the protocol for accessing the CORBA Naming Service during the execution of the server management commands. Currently, only corbaname is supported. You can, however, perform operations even with the protocols (iioploc or iiopname) that were in use in the older versions. |
The input is not limited. |
corbaname |
06-00 |
(e) Key beginning with ejbserver.rmi
Key name |
Contents |
Specifiable value |
Default |
VR |
---|---|---|---|---|
Specify an integer from 0 to 86400 for the communication timeout period (units: seconds) when a server management command could not return a response due to a communication failure. If you specify 0, the timeout does not occur. If you specify a value that exceeds 86400, a warning message is output and the default value is applied. If you specify a value smaller than the value of the ejbserver.deploy.exclusive.lockAliveInterval user property key for J2EE servers, a timeout becomes likely to occur during execution of a server management command. Therefore, we recommend that you specify a value larger than the value of the ejbserver.deploy.exclusive.lockAliveInterval user property key for J2EE servers. Note that using the following commands, when the application does not terminate within the time period specified in the -t option, this key becomes the timeout value for the period until the forced termination processing is completed:
|
Specify the value using an integer from 0 to 86400. |
180 (seconds) |
06-00 |
(f) Keys beginning with vbroker
Key name |
Contents |
Specifiable value |
Default |
VR |
---|---|---|---|---|
Specify a range of 1 to 210 bytes for the path of the output destination of Cosminexus TPBroker trace files. You need to create comtrc and mdltrc as the subdirectories of the specified path beforehand. In the case of default output destination, the subdirectories comtrc and mdltrc are automatically created when the server is started for the first time. Use a forward slash (/) as the delimiter in the directory path. For example, if C:\temp\work is set as the working directory, specify as follows: (Example of specification) vbroker.orb.htc.tracePath=c:/temp/work |
The input is not limited. |
Cosminexus-installation-directory\CC\admin\logs\TPB\logj or /opt/Cosminexus/CC/admin/logs/TPB/logj |
06-00 |
|
You can specify any value to fix the port that receives messages from the J2EE server. Make sure that the port number is not repeated in other programs. The same key name exists in the user property file for J2EE servers. Make sure that the port number is not repeated. If this property is not set, Cosminexus TPBroker sets a random value. |
The input is not limited. |
0 |
06-50 |
(6) Examples of coding
ejbserver.naming.host=localhost ejbserver.naming.port=900