JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle GlassFish Server Message Queue 4.5 Administration Guide
search filter icon
search icon

Document Information

Preface

Part I Introduction to Message Queue Administration

1.  Administrative Tasks and Tools

2.  Quick-Start Tutorial

Part II Administrative Tasks

3.  Starting Brokers and Clients

4.  Configuring a Broker

5.  Managing a Broker

6.  Configuring and Managing Connection Services

7.  Managing Message Delivery

8.  Configuring Persistence Services

9.  Configuring and Managing Security Services

10.  Configuring and Managing Broker Clusters

11.  Managing Administered Objects

12.  Configuring and Managing Bridge Services

13.  Monitoring Broker Operations

14.  Analyzing and Tuning a Message Service

15.  Troubleshooting

Part III Reference

16.  Command Line Reference

17.  Broker Properties Reference

Connection Properties

Routing and Delivery Properties

Persistence Properties

File-Based Persistence Properties

File-Based Persistence Properties for Transaction Logging

JDBC-Based Persistence Properties

Security Properties

Monitoring Properties

Cluster Configuration Properties

Bridge Properties

JMX Properties

Alphabetical List of Broker Properties

18.  Physical Destination Property Reference

19.  Administered Object Attribute Reference

20.  JMS Resource Adapter Property Reference

21.  Metrics Information Reference

22.  JES Monitoring Framework Reference

Part IV Appendixes

A.  Distribution-Specific Locations of Message Queue Data

B.  Stability of Message Queue Interfaces

C.  HTTP/HTTPS Support

D.  JMX Support

E.  Frequently Used Command Utility Commands

Index

Cluster Configuration Properties

Table 17-14 lists the configuration properties related to broker clusters.

Table 17-14 Broker Properties for Cluster Configuration

Property
Type
Default Value
Description
imq.cluster.url1,2
String
None
URL of cluster configuration file, if any

Examples:

  • http://webserver/imq/cluster.properties

  • (for a file on a Web server)

  • file:/net/mfsserver/imq/cluster.properties

  • (for a file on a shared drive)

imq.cluster.hostname3
String
None
Host name or IP address for cluster connection service

If specified, overrides imq.hostname (see Table 17-1) for the cluster connection service. This might be necessary, for instance, if the broker’s host computer has more than one interface card installed.

imq.cluster.port3
Integer
0
Port number for cluster connection service

A value of 0 specifies that the port number should be allocated dynamically by the Port Mapper. You might need to set a different value, for instance, to specify a static port number for connecting to the broker through a firewall.

imq.cluster.transport1
String
tcp
Network transport protocol for cluster connection service

For secure, encrypted message delivery between brokers, set this property to ssl.

imq.cluster.ha
Boolean
false
Is broker part of an enhanced (high-availability) cluster?
Additional Properties for Conventional Clusters
imq.cluster.brokerlist1,4
String
None
List of broker addresses belonging to cluster

The list consists of one or more addresses, separated by commas. Each address specifies the Port Mapper host name and Port Mapper port number of a broker in the cluster, in the form hostName:portNumber.

Example:

  • host1:3000,host2:8000,ctrlhost

Literal IP addresses as host names: You can use a literal IPv4 or IPv6 address as a host name. If you use a literal IPv6 address, its format must conform to RFC2732, Format for Literal IPv6 Addresses in URL's.


Note - If set, this property is ignored (and a warning logged) for high-availability clusters; all brokers configured to use the cluster’s shared persistent store are automatically recognized as members of the cluster.


imq.cluster.nomasterbroker1,4
Boolean
false
Specifies whether a conventional cluster uses a shared JDBC database store for the cluster configuration change record instead of using a master broker.

Set to true for a conventional cluster of peer brokers, which uses a shared JDBC store for the cluster's configuration change record.

When set to true, the imq.cluster.clusterid must be set, and the imq.cluster.sharecc.persist.jdbc.* properties must be configured for accessing the shared JDBC store.

imq.cluster.masterbroker1,4
String
None
Port Mapper host name and Port Mapper port number of host on which cluster’s master broker (if any) is running.

The value has the form hostName:portNumber, where hostName is the Port Mapper host name of the master broker’s host and portNumber is its Port Mapper port number.

Example:

  • ctrlhost:7676

Literal IP addresses as host names: You can use a literal IPv4 or IPv6 address as a host name. If you use a literal IPv6 address, its format must conform to RFC2732, Format for Literal IPv6 Addresses in URL's.


Note - enhanced clusters cannot have a master broker. If this property is set for a broker belonging to an enhanced cluster, the broker will log a warning message and ignore the property.


imq.cluster.dynamicChangeMasterBrokerEnabled1,4
Boolean
false
Can the master broker for the cluster be changed dynamically; that is, without stopping all the brokers in the cluster?

If set to true, you can use the imqcmd changemaster command to change the master broker without stopping the brokers in the cluster.

If set to true, the imq.cluster.masterbroker property cannot be specified on the imqbrokerd command line.

imq.cluster.sharecc.persist.jdbc.dbVendor1,4
String
None
Name of database vendor for shared JDBC data store housing the cluster configuration change record:
  • db2: DB2

  • derby: Java DB (Oracle Corporation)

  • oracle: Oracle (Oracle Corporation)

  • mysql: MySQL (Oracle Corporation)

  • postgresql: postgreSQL

imq.cluster.sharecc.persist.jdbc.vendorName.driver1,4
String
per Vendor
Java class name of the JDBC driver, if needed, for connecting to database from vendor vendorName for shared JDBC data store housing the cluster configuration change record
imq.cluster.sharecc.persist.jdbc.vendorName.opendburl1,4
String
None
URL for connecting to existing database from vendor vendorName for shared JDBC data store housing the cluster configuration change record

Applicable when a java.sql.Driver is used to connect to database.

imq.cluster.sharecc.persist.jdbc.vendorName.createdburl1,4
String
None
URL for creating new database from vendor vendorName for shared JDBC data store housing the cluster configuration change record

Applicable for embedded databases, such as Java DB.

imq.cluster.sharecc.persist.jdbc.vendorName.closedburl1,4
String
None
URL for closing connection to database from vendor vendorName for shared JDBC data store housing the cluster configuration change record

Applicable for some embedded databases, such as Java DB.

imq.cluster.sharecc.persist.jdbc.vendorName.tableoption1,4
String
None, except for MySQL
Vendor-specific options passed to database from vendor vendorName for shared JDBC data store housing the cluster configuration change record when creating the table schema

For information about this property's use, see the default broker properties file, default.properties.

imq.cluster.sharecc.persist.jdbc.vendorName.user1,4
String
None
User name, if required, for connecting to database from vendor vendorName for shared JDBC data store housing the cluster configuration change record
imq.cluster.sharecc.persist.jdbc.vendorName.needpassword1,4
Boolean
false
Does database from vendor vendorName for shared JDBC data store housing the cluster configuration change record require a password for broker access?

If true, the imqbrokerd and imqdbmgr commands will prompt for a password unless the following property, password is set.

imq.cluster.sharecc.persist.jdbc.vendorName.password1,4
String
None
Password, if required, for connecting to database from vendor vendorName for shared JDBC data store housing the cluster configuration change record

This property should only be specified in a password file, as described in Password Files.

imq.cluster.sharecc.persist.jdbc.vendorName.property.propName1,4
String
None
Optional vendor-specific property propName for the JDBC driver from vendor vendorName for shared JDBC data store housing the cluster configuration change record
Additional Properties for Enhanced (High-Availability) Clusters
imq.cluster.clusterid1,5
String
None
Cluster identifier

Must be a unique alphanumeric string of no more than n–13 characters, where n is the maximum table name length allowed by the database. No two running clusters may have the same cluster identifier.

This string is appended to the names of all database tables in the cluster’s shared persistent store.


Note - For brokers belonging to a high-availability cluster, this property is used in database table names in place of imq.brokerid (see Table 17-1).


imq.cluster.ha.takeoverWaitTimeout5
Integer
300
Time in seconds a failed broker attempting to restart waits for an existing takeover activity (from the broker's initial failure) to complete before exiting its restart attempt
imq.cluster.heartbeat.hostname5
String
None
Host name for heartbeat service

If specified, overrides imq.hostname (see Table 17-1) for the heartbeat service.

imq.cluster.heartbeat.port5
Integer
7676
Port number for heartbeat service

A value of 0 specifies that the port number should be allocated dynamically by the Port Mapper.

imq.cluster.heartbeat.interval5
Integer
2
Interval between heartbeats, in seconds
imq.cluster.heartbeat.threshold5
Integer
3
Number of missed heartbeat intervals after which to invoke monitor service
imq.cluster.monitor.interval5
Integer
30
Interval, in seconds, at which to update monitor time stamp

Note - Larger values for this property will reduce the frequency of database access and thus improve overall system performance, but at the cost of slower detection and takeover in the event of broker failure.


imq.cluster.monitor.threshold5
Integer
2
Number of missed monitor intervals after which to initiate broker takeover

1Must have the same value for all brokers in a cluster.

2Can be used with the imqcmd update bkr command.

3Can be specified independently for each broker in a cluster.

4Conventional clusters only

5Enhanced (high-availability) clusters only