Hitachi

uCosminexus Application Server Definition Reference Guide

6.2.3 config.properties (CJMSP broker individual properties file)

Organization of this subsection

(1) Format

Specify the key as follows:

Key-name=value
Specification method

  • The string up to the linefeed is a value.

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

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

  • If the value specified is not within the range, the value outside the range is used. If a value is not specified, the previous value is used. In such cases, a warning message appears on the console.

To Page Top

(2) File storage location

The default storage locations are as follows. Note that you can change the storage location of the var directory in the -varhome option of the cjmsbroker command.

Hereafter, Cosminexus-installation-directory\CC\cjmsp (In Windows) or /opt/Cosminexus/CC/cjmsp (In UNIX) is represented as <CJMSP_HOME>.

To Page Top

(3) Functionality

Specify the system properties to execute an individual CJMSP broker.

If different values are specified for config.properties and commonconfig.properties, then the priority is given to the value of config.properties.

If the contents of the file are changed while CJMSP broker is running, the changed contents are applied and enabled when CJMSP broker restarts.

To Page Top

(4) Specifiable keys

The following are the keys that can be specified. Note that "If value is not specified" in the table refers to the value of a non-specified key, and "VR" refers to the version of Application Server for which the keys are introduced or changed.

(a) Connection service

Properties related to the connection service are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

imq.admin.tcp.port

Specify the port number for the admin service.

If a firewall is used for establishing a connection with CJMSP broker, you must use this property to specify a static port number.

In the following cases, the port mapper allocates a dynamic port number.

  • If 0 is specified

  • If a user specifies a value outside the range (above 65535)

If -1 or 1 to 1024 is specified, the operation is not guaranteed.

0, 1025 to

65535

0

0

08-50

imq.hostname

Specify a default host name or IP address for all connection services.

Hitachi recommends you to specify this property when Cosminexus JMS Provider is to be installed in multiple servers.

If an invalid character string is specified in the host name, CJMSP broker cannot start. If localhost or loopback address (127.*.*.*) is specified, remote connection to CJMSP broker is not enabled.

Note that if a value is not specified for this property, (if specified up to imq.hostname=), when CJMSP broker starts, it connects to the CJMSP broker of the local host. At this stage, host name is not output. For example, if a value is not specified in this property, but 7676 is specified in imq.portmapper.port, when CJSMP broker starts, :7676 is output.

--

--

host-name

08-50

imq.jms.tcp.port

Specify the port number for the jms service.

If a firewall is used for establishing a connection with CJMSP broker, you must use this property to specify a static port number.

In the following cases, the port mapper allocates a dynamic port number.

  • If 0 is specified

  • If a user specifies a value outside the range (above 65535)

If -1 or 1 to 1024 is specified, the operation is not guaranteed.

If you specify a port number that is already in use, the broker starts successfully, but the jms service cannot be used. If you execute the cjmsicmd list svc command in this state, the status of the jms service is displayed as UNKNOWN. UNKNOWN indicates that the service is not running or is unavailable.

0, 1025 to

65535

0

0

08-50

imq.portmapper.port

Specify the port number of the port mapper for the CJMSP client to connect to CJMSP broker.

If multiple CJMSP broker instances start on the same host, different port mapper port numbers must be specified for each port mapper.

1025 to 65535

7676

7676

08-50
Legend:

--: Not applicable.

(b) Persistence service

Properties related to persistence service are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

imq.persist.file.sync.enabled

Specify whether to execute synchronous or asynchronous write process in the data file on memory.

If true is specified, synchronous write process is executed. In such cases, loss of data is prevented if a system error occurs, but process efficiency is affected. If false is specified, asynchronous write process is executed.

Hitachi recommends you to execute efficiency tests and then decide which one to specify.

If javax.jms.DeliveryMode.PERSISTENT is specified as the delivery mode in the application, we recommend that you specify true for this property.

The values that can be specified are as follows:

  • true

  • false

false

false

08-50

(c) Settings for creating destinations automatically

Properties related to settings for creating destinations automatically are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

imq.autocreate.destination.maxNumMsgs

Specify the maximum value of the number of messages not received.

If -1 or 0 is specified, the number of messages become unlimited.

-1 to 2147483647

100000

100000

08-50

imq.autocreate.destination.maxTotalMsgBytes

Specify the maximum byte value of the total memory size for messages not received. To specify units, add the following character strings at the end of the value. If a unit is not specified, it is considered as byte.

  • Byte: b

  • Kilobyte: k

  • Megabyte: m

If -1 or 0 is specified, the number of messages become unlimited.

-1 to 2147483647 (unit: bytes)

10m

10m

08-50

imq.autocreate.queue.consumerFlowLimit

Specify the maximum value of the number of messages to be delivered to the queue consumer in the same batch.

If -1 is specified, the number of messages are unlimited.

The values that can be specified are as follows:

  • -1

  • Integers from 1 to 2147483647

100

100

08-50

imq.autocreate.topic.consumerFlowLimit

Specify the maximum value of the number of messages to be delivered to the topic consumer in the same batch.

If -1 is specified, the number of messages are unlimited.

The values that can be specified are as follows:

  • -1

  • Integers from 1 to 2147483647

1000

1000

08-50

(d) Setting monitoring properties

Properties related to monitoring settings are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

imq.metrics.interval

Specify the write time of the matrix information in the logger and console, in units of seconds.

If 0 is specified, the matrix is not output.

0 to 2147483647

0

0

08-50

(e) CJMSP broker log properties

Properties related to CJMSP broker log are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

broker.logger.ExceptionLogFile.filenum

Specify the maximum value of the number of files to be created.

1 to 16

2

2

08-50

broker.logger.ExceptionLogFile.filesize

Specify the maximum value of the log file size.

If the maximum value exceeds, a new file is created and the contents of the log file are output to the new file.

8192 to 4194304

1048576

1048576

08-50

broker.logger.MessageLogFile.filenum

Specify the maximum value of the number of files to be created.

1 to 16

2

2

08-50

broker.logger.MessageLogFile.filesize

Specify the maximum value of the log file size.

If the maximum value exceeds, the contents of the log file are output to the new file.

8192 to 4194304

1048576

1048576

08-50

broker.logger.MessageLogFile.trace.level

Specify the log level.

Information is output to the log file on the basis of the specified level.

The following strings can be specified:

  • ERROR

  • WARNING

  • INFO

ERROR

ERROR

08-50

(f) Other properties

Other properties are as follows:

Key name

Contents

Specifiable value

If a value outside the range is specified

If the value is not specified

VR

imq.instanceconfig.version

This property is used for internal processes. Do not change the settings.

--

--

--

08-50
Legend:

--: Not applicable.

To Page Top

Trademarks

All Rights Reserved. Copyright (C) 2022, Hitachi, Ltd.