Element list

diagram description The jrun-jms element is the parent element for all settings that control the operation of the JMS implementation provided as part of JRun. To setup individual connection factories and destinations, see the jrun resources setup file, jrun-resources.xml. To control how aspects of JMS are exposed within the J2EE framework or to substitute another vendor's JMS implementation entirely, see the main jrun configuration file, jrun.xml. attributes uses persistence-manager  server  scheduler  message-manager  garbage-collection  destinations  client-jndi  mode

diagram description The persistence-manager element and its children control the underlying mechanism used to safely store any JMS information such as messages, durable consumers, and destinations. This information is saved even if the server is restarted and is automatically available when the server restarts. This is the foundation of reliable messaging. There are two choices for how this information can be stored: in a file or in a relational database. The default storage mechanism is a file. This is simpler and requires less configuration; however, in most situations, its performance will be inferior to that of the RDBM-backed store. For most production environments or situation in which the benefits of an external, enterprise-level backing-store are desired, the RDBM-backed store is a better option. To switch the storage mechanism, use the active-adapter-element. In most cases, few of the underlying persistence-adapter settings will need to be adjusted. Perhaps the only adjustment that will be routinely required will be to set the JDBC datasource information, in the data-source element, when first moving to an RDBM-backed store. Used in: jrun-jms attributes uses active-adapter-type  persistence-adapter

diagram description The active-adapter-type element determines the underlying storage mechanism used by JMS. It can be either "file" or "rdbm" to use the filesystem-based or relational database-based storage mechanisms, repectively. Essentially, this setting determines which of the subsequent persistent-adapter descriptions is active. Used in: persistence-manager attributes uses

diagram description The persistent-adapter element describes details for how a particular storage mechanism will operate. For convenience, there can be any number of persistent-adapter descriptions in this file. However, only one, the one named in the active-persistent-adapter element, is active at any given time. Used in: persistence-manager attributes uses adapter-type  adapter-class-name  adapter-config

diagram description The adapter-type element is the name of the adapter description described by this persistence-adapter element. It can be "file" or "rdbm". Used in: persistence-adapter attributes uses

diagram description The adapter-class-name is the Java class name of the class that implements this adapter. Used in persistence-adapter attributes uses

diagram description The adapter-config element contains whatever adapter-specific information is needed to configure this adapter. Its content differs depending on the adapter type. Used in: persistence-adapter attributes uses data-source  message-sql  handle-sql  consumer-sql  destination-sql  transact  auto-table-creation  dir-path  dir-name  cache  transact

diagram description The data-source element specifies the JDBC resource to be used as the JMS persistent backing store if the active-adapter-type is set to "rdbm". This database is used by the JMS subsystem to store any persistent data it needs as part of its normal operation. It is used only internally by JMS and should not be modified or used in any other way. This data-source element is identical to the data-source element used in the jrun-resources.xml file to describe other JDBC resources. Please refer to the jrun-resources.xml documentation or the jrun-resources.dtd file for a description of the data-source element and any of its child elements. Used in: adapter-config attributes uses dbname  jndi-name  driver  url  description  username  password  isolation-level  native-results  transaction-domain  transaction-timeout  disable-pooling  initial-connections  minimum-size  maximum-size  maximum-soft  connection-timeout  user-timeout  skimmer-frequency  shrink-by  validation-query  debugging  cache-enabled  cache-size  cache-refresh-interval  remove-on-exceptions  pool-statements

diagram description The dbname element specifies the data source name. Used in: data-source attributes uses

diagram description The url element specifies the connection URL for the data source. Used in: data-source attributes uses

diagram description The url element specifies the connection URL for the data source. Used in: data-source attributes uses

diagram description The description element is used to provide human-readable text describing the parent element. Used in: data-source attributes uses

diagram description The username element specifies the username used when creating connections. Used in: data-source attributes uses

diagram description The password element specifies the password used when creating connections. Used in: data-source attributes uses

diagram description The isolation-level element specifies the transaction isolation level for the data source. Used in: data-source attributes uses

diagram description The native-results element specifies whether the result set returned from the JDBC driver should be wrapped to facilitate pooling. Used in: data-source attributes uses

diagram description The transaction-domain element specifies the transaction domain, which connections should run in the context of. Used in: data-source attributes uses

diagram description The transaction-timeout element specifies the timeout interval for transactions associated with this datasource. Used in: data-source attributes uses

diagram description The disable-pooling element specifies whether data source pooling is disabled. Used in: data-source attributes uses

diagram description The initial-connections element specifies the number of initial connections that are created when the data source is created. Used in: data-source attributes uses

diagram description The minimum allowed number of connections to the data source in the pool. Used in: data-source attributes uses

diagram description The maximum-size element specifies the maximum number of allowed pooled connections in the pool. Used in: data-source attributes uses

diagram description The maximum-soft element specifies whether the maximum number of connections is allowed to grow past the maximum pool size in order to handle load. Used in: data-source attributes uses

diagram description The connection-timeout element specifies the number of seconds, since the connection was last accessed, before the connection will timeout. Used in: data-source attributes uses

diagram description Not currently used. Used in: data-source attributes uses

diagram description The skimmer-frequency element specifies the number of seconds between processing the connection pool. Used in: data-source attributes uses

diagram description The shrink-by element specifies the number of connections that the pool size is decreased by when the skimmer needs to reduce the size of the pool. Used in: data-source attributes uses

diagram description The validation-query element specifies an SQL statement used to validate whether a connection is valid. Used in: data-source attributes uses

diagram description The debugging element specifies whether data source debugging information will be logged. Used in: data-source attributes uses

diagram description The cache-enabled element specifies whether SQL statement caching is enabled. Used in: data-source attributes uses

diagram description The cache-size element specifies the size of the SQL statement cache. Used in: data-source attributes uses

diagram description The cache-refresh-interval element specifies number of seconds between cache refreshs. Used in: data-source attributes uses

diagram description The remove-on-exceptions element specifies whether connections will be recycled back into the connection pool when exceptions occur. Used in: data-source attributes uses

diagram description The pool-statements element specifies whether statement objects will be reused. Used in: data-source attributes uses

diagram description The message-sql element contains SQL statements used by the RDBM-backed store. There is one element for each of the tables used in the relational database. Used in: adapter-config attributes uses jdbc-mapping

diagram description The handle-sql element contains SQL statements used by the RDBM-backed store. There is one element for each of the tables used in the relational database. Used in: adapter-config attributes uses jdbc-mapping

diagram description This destination-sql element contains SQL statements used by the RDBM-backed store. There is one element for each of the tables used in the relational database. Used in: adapter-config attributes uses jdbc-mapping

diagram description The consumer-sql element contains SQL statements used by the RDBM-backed store. There is one element for each of the tables used in the relational database. Used in: adapter-config attributes uses jdbc-mapping

diagram description The jdbc-mapping element contains a description of a single database operation. Used in: message-sql, handle-sql, destination-sql, and consumer-sql attributes uses name  statement

diagram description The name element is the name of the database operation this JDBC mapping describes. Used in: jdbc-mapping attributes uses

diagram description The statement element and its children describe the SQL used to implement a particular database operation. Used in: jdbc-mapping attributes uses action  source  params  fields

diagram attributes uses

diagram attributes uses

diagram attributes uses param

diagram attributes uses field

diagram attributes uses name  type

diagram attributes uses

diagram attributes uses

diagram description The dir-path element is used only by the file-based backing store. It is the absolute path to the directory where dir-name (see below) will be created. By default this will be "<SERVER-HOME>/SERVER-INF/jms/db". Used in: adapter-config attributes uses

diagram description The dir-name element is the name of the subdirectory of dir-path where JMS data will actually be stored. Together, the dir-path and the dir-name elements specify the complete path to the directory in which the data is stored. If this directory or any component of its path does not exist, JRun automatically creates it. Note: If you ever want to completely "clean up" the JMS file-backed store, simply stop the server and delete this directory. However, you should use caution and be certain this is what you want to do. Doing so permanantly destroys all undelivered mesages and any programatically created consumers and destinations (those not created through the JRun JMC). To perform a similar "clean up" when using an RDBM-backed store, you must use whatever tools are provided by the database vendor to clear out the following tables: message, handle, consumer, and destination. Used in: adapter-config attributes uses

diagram description The transact element is used to enlist all actions of the specified persistent adapter in a transaction. This improves the overall reliability of the persistent adapter at the cost of whatever overhead is associated with its transactional support. Note: Not all adapter types support transactions. Currently, only the RDBM adapter supports transactions (and only if the underlying database supports them). See the transaction-related settings in the data-source element for more information. Used in: adapter-config attributes uses

diagram description The cache element is used to enable in-memory caching of persistant information at the level of the persistent adapter. The JMS subsystem uses many levels of caching as part of its operation. This setting does not affect higher-level schemes. It only turns on caching in the adapter itself (and only if the specific adapter supports it). Note: Not all adapter types support caching. Currently, only the file adapter supports this type of caching. Used in: adapter-config attributes uses

diagram description The auto-table-creation element is used only by the RDBM adapter. If set to yes, it lets the adapter automatically create the required database tables within the specified JDBC data source. Therefore, it is only useful the first time JMS is started (using the RDBM adapter) with a new database. For performance, security, and data-integrity reasons, it is best to set this option to false for production deployments. Used in: adapter-config attributes uses

diagram description The server element and its children control high-level aspects of the JMS implementation. Used in: jrun-jms attributes uses server-address  server-internal-host  server-name  admin-server-name  client-ping-interval  transport  connection-factory

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses layer  server-class-name  server-client-class-name  port

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses connection-factory-class  connection-factory-type  jndi-name

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram description The scheduler element and its children control the behavior of the JMS scheduler thread. This thread is responsible for asynchonous background operations performed by the JMS subsystem. Such operations include garbage collection, database cleanup, and asynchonous message delivery. Used in: jrun-jms attributes uses sleep-interval

diagram attributes uses

diagram description The message-manager element and its children control aspects of the JMS subsystem related to how it internally handles message traffic. Used in: jrun-jms attributes uses destination-cache-size  max-thread-number  allow-dynamic-dest  max-message-queue-size-mb  max-message-queue-size-test-fail-silently

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram description The max-message-queue-size-mb element puts an upper limit on the amount of memory used to cache undelivered messages. If this limit is reached, no new non-persistent messages will be accepted until some of the cached messages are delivered and the cache shrinks. The value is specified in MB. It should be set to a value significantly less than the server's total VM memory limit (as specified using the VM's -Xms and -Xmx arguments) thereby preventing the in-memory accumulation of undelivered JMS messages from inadvertently using up all the memory and, potentially, disabling the entire JRun server. This setting in no way affects the long-term, disk-based storage of messages marked as persistent or addressed to durable destinations. To disable this limit, set the value to 0. The default value is "50", meaning 50MB is as large as the message cache will grow. Used in: message-manager, Value: integer. attributes uses

diagram description The max-message-queue-size-test-fail-silently element can be used to prevent the generation of a client-side JMS exception when incoming messages are rejected because the max-message-queue-size-mb limit (above) has been exceeded. The default value is "false", meaning that an exception will be generated. Note that this only affects the client's view of this failure. An informational message is written to the JRun log (every 1000 rejected messages) regardless of this element's setting. Used in: message-manager, Value true/false. attributes uses

diagram description The garbage collection element and its children control the behavior of the JMS garbage collector. The garbage collector is a background thread primarily responsible for removing references to messages that are no longer needed. Messages become garbage if, for example, they have expired, been delivered, or their destinations have been deleted. Used in: jrun-jms attributes uses garbage-collection-interval  garbage-collection-thread-priority  low-threshold  memory-check-interval

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram description The destination element is not currently active. Used in: jrun-jms attributes uses

diagram description The client-jndi element and its children define the JNDI connection information that a stand-alone JMS client must specify to connect ot this JMS implementation. Used in: jrun-jms attributes uses initial-context-factory  url-pkg-prefixes  provider-url

diagram attributes uses

diagram attributes uses

diagram attributes uses

diagram description The mode element toggles different test modes of the JMS subsystem. It is not functional in the public version of the product. Used in: jrun-jms attributes uses