Chapter 7. Persisting Messages

Procedure

1. Add the appropriate JDBC client libraries to the broker runtime. You can do this by adding the relevant jars to the BROKER_INSTANCE_DIR/lib directory.

2. Create a store element in your BROKER_INSTANCE_DIR/etc/broker.xml configuration file under the core element, as in the example below.

   <configuration>
     <core>
       <store>
          <database-store>
             <jdbc-connection-url>jdbc:oracle:data/oracle/database-store;create=true</jdbc-connection-url>
             <jdbc-user>ENC(5493dd76567ee5ec269d11823973462f)</jdbc-user>
             <jdbc-password>ENC(56a0db3b71043054269d11823973462f)</jdbc-password>
             <bindings-table-name>BINDINGS_TABLE</bindings-table-name>
             <message-table-name>MESSAGE_TABLE</message-table-name>
             <large-message-table-name>LARGE_MESSAGES_TABLE</large-message-table-name>
             <page-store-table-name>PAGE_STORE_TABLE</page-store-table-name>
             <node-manager-store-table-name>NODE_MANAGER_TABLE<node-manager-store-table-name>
             <jdbc-driver-class-name>oracle.jdbc.driver.OracleDriver</jdbc-driver-class-name>
             <jdbc-network-timeout>10000</jdbc-network-timeout>
             <jdbc-lock-renew-period>2000</jdbc-lock-renew-period>
             <jdbc-lock-expiration>20000</jdbc-lock-expiration>
             <jdbc-journal-sync-period>5</jdbc-journal-sync-period>
          </database-store>
       </store>
     </core>
   </configuration>

   jdbc-connection-url

   Full JDBC connection URL for your database server. The connection url should include all configuration parameters and the database name.

   jdbc-user

   Encrypted user name for your database server. For more information about encrypting user names and passwords for use in configuration files, see Encrypting Passwords in Configuration Files.

   jdbc-password

   Encrypted password for your database server. For more information about encrypting user names and passwords for use in configuration files, see Encrypting Passwords in Configuration Files.

   bindings-table-name

   Name of the table in which bindings data is stored. Specifying this table name enables you to share a single database between multiple servers, without interference.

   message-table-name

   Name of the table in which message data is stored. Specifying this table name enables you to share a single database between multiple servers, without interference.

   large-message-table-name

   Name of the table in which large messages and related data are persisted. In addition, if a client streams a large message in chunks, the chunks are stored in this table. Specifying this table name enables you to share a single database between multiple servers, without interference.

   page-store-table-name

   Name of the table in which paged store directory information is stored. Specifying this table name enables you to share a single database between multiple servers, without interference.

   node-manager-store-table-name

   Name of the table in which the shared store high-availability (HA) locks for live and backup brokers and other HA-related data is stored on the broker server. Specifying this table name enables you to share a single database between multiple servers, without interference. Each live-backup pair that uses shared store HA must use the same table name. You cannot share the same table between multiple (and unrelated) live-backup pairs.

   jdbc-driver-class-name

   Fully-qualified class name of the JDBC database driver. For information about supported databases, see Red Hat AMQ 7 Supported Configurations on the Red Hat Customer Portal.

   jdbc-network-timeout

   JDBC network connection timeout, in milliseconds. The default value is 20000 milliseconds (that is, 20 seconds). When using a JDBC for shared store HA, it is recommended to set the timeout to a value less than or equal to jdbc-lock-expiration.

   jdbc-lock-renew-period

   Length, in milliseconds, of the renewal period for the current JDBC lock. When this time elapses, the broker can renew the lock. The default value is 2000 milliseconds (that is, 2 seconds).

   jdbc-lock-expiration

   Time, in milliseconds, that the current JDBC lock is considered active, even if the jdbc-lock-renew-period time has elapsed. Setting this property to a value greater than jdbc-lock-renew-period ensures that the lock is not immediately lost if the broker that owns the lock experiences an unexpected delay in renewing it. After the expiration time elapses, if the JDBC lock has not been renewed by the broker that currently owns it, another broker can establish a JDBC lock. The default value is 20000 milliseconds (that is, 20 seconds).

   jdbc-journal-sync-period

   Duration, in milliseconds, for which the broker journal synchronizes with JDBC. The default value is 5 milliseconds.