Hitachi

uCosminexus Application Server Definition Reference Guide


3.2.2 usrconf.properties (User property file for batch 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.

  • Specify the path in CJBATCHUSRCONFDIR using an absolute path.

  • If the format does not conform to Java specifications, the batch server might fail to start.

    (Example) When the format contains an invalid Unicode escape sequence (the string after \U is not an appropriate Unicode hexadecimal value).

(2) File storage location

(3) Functionality

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

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

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

(4) Keys reserved in batch servers

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

(5) Keys for customization of batch servers

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

The keys are classified and explained as follows:

The following table gives an overview of the respective specifiable keys and the default values. For details about the keys, see 2.2.3 usrconf.properties (User property file for J2EE servers). Furthermore, when referencing, substitute J2EE server and J2EE application for Batch server and Batch application respectively.

(a) Keys beginning with ejbserver.application

Key name

Overview

Default value

ejbserver.application.InitTermProcessClasses

When using the container extension library, specify the class name of server start/stop hook.

None

ejbserver.application.userlog.CJLogHandler.handler-name.appname

Specify the default application name that is output to the AppName field.

user_app

ejbserver.application.userlog.CJLogHandler.handler-name.count

Specify the number of log files.

2

ejbserver.application.userlog.CJLogHandler.handler-name.encoding

Specify encoding of the character strings to be output.

Null

ejbserver.application.userlog.CJLogHandler.handler-name.filter

Specify the filter in use.

Null

ejbserver.application.userlog.CJLogHandler.handler-name.formatter

Specify the formatter in use.

Null

ejbserver.application.userlog.CJLogHandler.handler-name.level

Specify an upper-limit of a log collection level.

SEVERE

ejbserver.application.userlog.CJLogHandler.handler-name.limit

Specify the capacity of a log file.

1048576

ejbserver.application.userlog.CJLogHandler.handler-name.msgid

Specify the default message ID that is output to the MsgID field.

0001

ejbserver.application.userlog.CJLogHandler.handler-name.path

Specify a value from 1 to 255 bytes for the prefix of a log file name.

user_log

ejbserver.application.userlog.CJLogHandler.handler-name.separator

Use the CJSimpleFormatter and specify a separator to output a message in one sentence.

| (Vertical bar)

ejbserver.application.userlog.loggers

Specify a logger name to be used.

None

ejbserver.application.userlog.Logger.logger-name.filter

Specify the filter used in the logger.

Null

ejbserver.application.userlog.Logger.logger-name.handlers

Specify the handler class for a specified logger name.

None

ejbserver.application.userlog.Logger.logger-name.level

Specify the log output level of the logger.

SEVERE

ejbserver.application.userlog.Logger.logger-name.useParentHandlers

Specify whether the log record is to be transmitted from the logger that received the log record to the handler connected to the parent logger.

true

(b) Keys beginning with ejbserver.batch

Key name

Overview

Default value

ejbserver.batch.application.exit.enabled

Specify operations of a batch server when VM end method is invoked from the batch application.

If you specify true:

The batch application thread will end without terminating the JavaVM.

If you specify false:

The batch server will end.

true

ejbserver.batch.gc.watch.threshold

Specify an integer from 0 to 100 (unit: %) for the threshold value of the memory usage for executing GC. GC is executed when any of the following conditions are met. If 0 is specified, GC is not monitored.

  • The ratio of Tenured area consumption size with Tenured domain total size is more than the threshold value (if serial GC is enabled).

  • The ratio of New area total size with Tenured area maximum free size is more than the threshold value (if serial GC is enabled).

  • The ratio of the used Java heap area size to the Java heap area size reaches or exceeds the threshold value (if G1 GC is enabled).

  • The ratio of the used metaspace area size to the maximum metaspace area size reaches or exceeds the threshold value.

0

ejbserver.batch.schedule.group.name

Specify a group name for the batch servers managed by CTM within 63 characters having alphanumeric characters and underscore (_).

JOBGROUP

ejbserver.batch.queue.length

Specify the value from 1 to 32767 as the length of the schedule queue created with CTM.

50

Note: This key is a user property file-specific key for batch servers. This key does not exist in the user property file for J2EE servers.

(c) Keys beginning with ejbserver.client

Key name

Overview

Default value

ejbserver.client.ctm.RequestPriority

Specify the priority (priority order) for extracting the request accumulated in the queues within CTM.

4

(d) Keys beginning with ejbserver.connectionpool

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

Key name

Overview

Default value

Related information

ejbserver.connectionpool.applicationAuthentication.disabled

Specify whether to enable the functionality for optimizing container management sign-on.

false

ejbserver.connectionpool.association.enabled

Specify whether to enable the connection association functionality.

false

3.14 Functionality for performance tuning in the Common Container Functionality Guide

ejbserver.connectionpool.sharingOutsideTransactionScope.enabled

Specify the operations of the connection sharing when a connection is acquired multiple times outside the transactions managed by the application server.

false

ejbserver.connectionpool.validation.timeout

Specify the timeout value for the functionality to detect connection failure and the timeout value (unit: seconds) for deleting connections using the functionality to adjust the number of connections as an integer from 1 to 2147483647.

5

Legend:

Blank cell: Related information does not exist.

(e) Keys beginning with ejbserver.connector

Key name

Overview

Default value

ejbserver.connector.logwriter.filenum

Specify the number of log files of a resource adaptor.

4

ejbserver.connector.logwriter.filesize

Specify the size of the log files of a resource adaptor.

2097152

(f) Keys beginning with ejbserver.container

Key name

Overview

Default value

ejbserver.container.audit_trail.enabled

Specify whether to enable the database audit trail linkage functionality.

false

(g) Keys beginning with ejbserver.ctm

Key name

Overview

Default value

ejbserver.ctm.ActivateTimeOut

When the scheduling functionality is enabled and a batch server starts, the CTM queue will be activated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647. If you specify 0, CTM continues to wait infinitely.

180

ejbserver.ctm.CTMDomain

This property is necessary for using the CTM functionality. Specify name of the CTM domain to which the batch server belongs.

CTMDOMAIN

ejbserver.ctm.CTMID

This property is necessary for using the CTM functionality. You specify CTM identifier of the CTM daemon that controls the batch server.

IP-address

ejbserver.ctm.CTMMyHost

This property is necessary for using the CTM functionality. You specify the host name or IP address used by CTM in the node-switching environment that inherits multi-home or IP address.

host-name-acquired-by-hostname-command

ejbserver.ctm.DeactivateTimeOut

When the scheduling functionality is enabled and the batch server stops, the CTM queue will be deactivated. In such a case, you specify the waiting time (unit: seconds) between 0 and 2147483647.

180

ejbserver.ctm.enabled

Specify whether the scheduling functionality will be used.

If you specify true:

The scheduling functionality will be used. When the batch server starts, a connection with CTM will be established and initialized. When successful, the batch server will start with the available scheduling functionality.

When an attempt to connect and initialize with CTM fails, the batch server will not start.

If you specify false:

The scheduling functionality will not be used. The batch server will start without using the scheduling functionality.

false

(h) Keys beginning with ejbserver.deploy

Key name

Overview

Default value

ejbserver.deploy.exclusive.lockAliveInterval

Specify the maximum wait time until the next response sent from the command is received, after completing the server processing.

60

ejbserver.deploy.resourcefile.scramble.enabled

Specify whether to scramble the DD files related to DataSource, JavaMail, and ResourceAdapter that are expanded below the working directory.

false

(i) Keys beginning with ejbserver.ext

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

Key name

Overview

Default value

Related information

ejbserver.ext.method_observation.interval

If this property is set, it implies:

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

  • Specify the time interval for monitoring whether a request processing during operation has timed out and specify the time interval for canceling the timed out request (method).

0

5. Operations of J2EE Applications in the Operation, Monitoring, and Linkage Guide

(j) Keys beginning with ejbserver.http

Key name

Overview

Default value

ejbserver.http.port

Specify the port number of the management server.

28080

(k) Keys beginning with ejbserver.instrumentation

Key name

Overview

Default value

ejbserver.instrumentation.enabled

Specify whether to integrate with the Management Server.

true

(l) Keys beginning with ejbserver.jndi

Key name

Overview

Default value

ejbserver.jndi.cache

Specify whether to perform caching in naming.

on

ejbserver.jndi.cache.interval

Specify an interval to clear cache, when caching is performed in naming.

0

ejbserver.jndi.cache.interval.clear.option

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

refresh

ejbserver.jndi.cache.reference

Specify whether to use the caching functionality of DataSource object.

off

ejbserver.jndi.namingservice.group.list

Define the group of logical naming service that is to be searched during the round-robin search.

None

ejbserver.jndi.namingservice.group.specify-group-name.providerurls

Specify the root position of naming services belonging to each group, with a provider URL.

None

ejbserver.jndi.request.timeout

Specify the timeout period of communication with the Naming Service.

0

(m) Keys beginning with ejbserver.jta

Key name

Overview

Default value

ejbserver.jta.TransactionManager.defaultTimeOut

Specify the default value of transaction time-out for the transaction started on the batch server.

180

(n) Keys beginning with ejbserver.logger

Key name

Overview

Default value

ejbserver.logger.channels.define.channel-name#.filenum

Specify the number of log files of a batch server.

  • 4, when the channel name is MaintenanceLogFile

  • 2, when the channel name is other than above

ejbserver.logger.channels.define.channel-name#.filesize

Specify the size of the log files of a batch server.

  • 16777216, when the channel name is MaintenanceLogFile

  • 1048576, when the channel name is other than above

ejbserver.logger.enabled.*

Specify the log level of a batch server.

Error

ejbserver.logger.rotationStyle

Specify the rotation method of the J2EE server log output file.

If you specify SHIFT:

The log file will be rotated in the shift mode.

If you specify WRAP:

The log file will be rotated in the wraparound mode.

WRAP

#

You can set the following names as channel name:

  • Channels to output logs for the Application Server:

    MessageLogFile, MaintenanceLogFile, ExceptionLogFile, ConsoleLogFile, EJBContainerLogFile, UserOutLogFile, UserErrLogFile

  • Channels for output of resource depletion monitoring log

    MemoryWatchLogFile, FileDescriptorWatchLogFile, ThreadWatchLogFile, ThreaddumpWatchLogFile, ConnectionPoolWatchLogFile

For acquiring data, see 2.3 Acquiring the Data in the manual uCosminexus Application Server Maintenance and Migration Guide.

(o) Keys beginning with ejbserver.management

Key name

Overview

Default value

ejbserver.management.JVM.stats_monitor.FullGCCount.enabled

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

true

ejbserver.management.JVM.stats_monitor.FullGCCount.threshold

Specify the number of Full GC occurrences as the threshold value for monitoring of Full GC.

10

ejbserver.management.JVM.stats_monitor.FullGCCount.interval

Specify the interval at which to check the number of Full GC occurrences for monitoring of Full GC.

600

ejbserver.management.statistics.interval

Specify the statistics collection interval.

60

ejbserver.management.stats_file.base_time

Specify the base time for time switching operation of the statistic files.

0

ejbserver.management.stats_file.dir

Specify the directory to output the statistics file.

  • In Windows

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

  • In UNIX

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

ejbserver.management.stats_file.enabled

Specify whether to enable the functionality to output the statistics file.

true

ejbserver.management.stats_file.num

Specify the number of statistic files.

7

ejbserver.management.stats_file.period

Specify the switching time for time switching operation of statistic files.

24

(p) Keys beginning with ejbserver.manager

Key name

Overview

Default value

ejbserver.manager.agent.Agent.conf

Specify the settings required for integrating with the Management Server.

None

ejbserver.manager.agent.Agent.enabled

Specify the settings required for integrating with the Management Server.

false

ejbserver.manager.agent.JP1EventAgent.conf

Specify the path of the setup file for JP1 integration.

None

ejbserver.manager.agent.JP1EventAgent.enabled

Specify whether to integrate with JP1.

false

ejbserver.manager.agent.MEventAgent.conf

Specify the property file for issuing the Management event.

None

ejbserver.manager.agent.MEventAgent.enabled

Specify whether to enable the functionality for issuing the Management event.

false

(q) Keys beginning with ejbserver.naming

Key name

Overview

Default value

ejbserver.naming.host

Specify the host name or the IP address that invoke the CORBA Naming Service that the batch server uses.

localhost

ejbserver.naming.nameroot

Specify a name when the name is added to the CORBA Naming Service that is invoked, when the CORBA Naming Service is used in the automatic invocation mode.

None

ejbserver.naming.port

Specify the port numbers of the CORBA Naming Service that the batch server uses.

900

ejbserver.naming.startupRetryCount

If the CORBA Naming Service still does not start after the lapse of an invocation wait time of the CORBA Naming Service that is specified in ejbserver.naming.startupWaitTime, specify an iteration frequency to await invocation only for the number of seconds specified in ejbserver.naming.startupWaitTime.

9

ejbserver.naming.startupWaitTime

Specify the wait time until the CORBA Naming Service can be used when the batch server is started.

1

(r) Keys beginning with ejbserver.rmi

Key name

Overview

Default value

ejbserver.rmi.naming.host

Specify the host name or the IP address of the RMI registry and MBean server used by the batch server in a multi-homed host environment.

None

ejbserver.rmi.naming.port

Specify the port numbers of the RMI registry that is used by the batch server.

23152

ejbserver.rmi.remote.listener.port

Specify the port numbers of the remote object that is exported in to the batch server.

0

ejbserver.rmi.request.timeout

Specify the communication timeout period between the client and the server.

0

(s) Keys beginning with ejbserver.server

Key name

Overview

Default value

ejbserver.server.prf.PRFID

Specify the PRF identifier.

PRF_ID

ejbserver.server.threaddump.filenum

Specify an upper limit of the number of files of thread dump when the batch server detects an error and voluntarily outputs the thread dump.

256

(t) Keys beginning with ejbserver.stdoutlog

Key name

Overview

Default value

ejbserver.stdoutlog.autoflush

Specify whether to enable the automatic flush functionality of the user output log and user error log.

false

(u) Keys beginning with ejbserver.watch

Key name

Overview

Default value

ejbserver.watch.enabled

Specify whether to enable the depletion monitoring of all the resources.

true

ejbserver.watch.memory.enabled

Specify whether to enable alert output of memory monitoring.

true

ejbserver.watch.memory.interval

Specify the memory monitoring interval.

60

ejbserver.watch.memory.threshold

Specify the threshold value for monitoring memory usage state.

80

ejbserver.watch.memory.writefile.enabled

Specify whether to output the results of memory monitoring in a file.

true

ejbserver.watch.fileDescriptor.enabled

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

true

ejbserver.watch.fileDescriptor.interval

Specify the file descriptor monitoring interval. Note that file descriptor monitoring cannot be used in Windows and AIX.

60

ejbserver.watch.fileDescriptor.threshold

Specify the threshold value for monitoring the usage of a file descriptor. Note that file descriptor monitoring cannot be used in Windows and AIX.

2147483647

ejbserver.watch.fileDescriptor.writefile.enabled

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

true

ejbserver.watch.thread.enabled

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

true

ejbserver.watch.thread.interval

Specify the thread monitoring interval. Note that you cannot monitor the number of threads in Linux.

60

ejbserver.watch.thread.threshold

Specify the threshold value for monitoring the thread usage state. Note that you cannot monitor the number of threads in Linux.

2147483647

ejbserver.watch.thread.writefile.enabled

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

true

ejbserver.watch.threaddump.enabled

Specify whether to enable alert output of thread dump monitoring.

true

ejbserver.watch.threaddump.interval

Specify the time interval for thread dump monitoring.

30

ejbserver.watch.threaddump.threshold

Specify the ratio of the threshold value for thread dump monitoring with respect to the maximum value.

80

ejbserver.watch.threaddump.writefile.enabled

Specify whether to output the results of thread dump monitoring to a file.

true

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.

true

(v) Keys beginning with https

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

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

Key name

Overview

Default value

https.cipherSuites

Specify the recommended coding suite to be used in HttpsURLConnection.#

#

https.protocols

Specify the protocol to be used in HttpsURLConnection.#

#

#

For details about keys, see the JDK documentation.

(w) Keys beginning with java

Key name

Overview

Default value

java.naming.factory.initial

Specify the factory class for the implementation class of the context delegated by InitialContext of JNDI.

com.hitachi.software.ejb.jndi.InsContextFactory

(x) Keys beginning with vbroker

Key name

Overview

Default value

vbroker.agent.enableLocator

Specify whether to use the Smart Agent. When you start the batch server for using the scheduling functionality, true will be automatically set up.

false

vbroker.agent.port

Specify the port number of Smart Agent.

14000

vbroker.ce.iiop.ccm.htc.readerPerConnection

Specify whether the closing of the connection will be controlled when a timeout occurs during the invocation of the EJB method defined as the remote interface.

If true is specified

The closing of the connection when a timeout occurs will be controlled.

If false is specified

The closing of the connection when a timeout occurs is not controlled.

false

vbroker.ce.iiop.ccm.htc.threadStarter

Specify whether to invoke the thread for managing the reply receiving threads. To set up vbroker.ce.iiop.ccm.htc.readerPerConnection=true, specify true.

false

vbroker.orb.htc.comt.entryCount

Specify an upper limit of the entry count for one communication trace file of the Cosminexus TPBroker.

120000

vbroker.orb.htc.comt.fileCount

Specify an upper limit value of the communication trace file count for Cosminexus TPBroker.

3

vbroker.orb.htc.tracePath

Specify a value from 1 to 210 bytes for the output path of Cosminexus TPBroker trace files.

  • In Windows

    Cosminexus-working-directory\ejb\server-name\logs\TPB\logj

  • In UNIX

    Cosminexus-working-directory/ejb/server-name/logs/TPB/logj

vbroker.se.iiop_tp.host

Set the IP address of the EJB container for each batch server by specifying any optional value.

None

vbroker.se.iiop_tp.scm.iiop_tp.listener.port

You can set a communication port for each batch server, by specifying any optional value.

0

(y) Keys beginning with webserver.connector

Key name

Overview

Default value

webserver.connector.ajp13.bind_host

Specify the IP address or the host name used for Web server integration.

None

webserver.connector.ajp13.port

Specify the port number used for communication with the Web server.

8007