Property Reference
Use
In the schema jms-resources.xsd there are optional property elements under <sap-local-factory-type> and <sap-local-destination-type>. These are the only properties that can be modified via deployment.
Optional Properties of the JMS Resources in the Deployment Descriptor
Property Name |
Value Type |
Default Value |
Relevant for |
Description |
clientID |
String |
“” |
Connection Factory |
The clientID of the connection factory. |
agentKeepAliveTimeSeconds |
int |
300 |
Destination |
The time (in seconds) to keep the agent alive after the last consumer or producer is closed. |
jmsxDeliveryCountEnabled |
boolean |
True |
Destination |
Switches the optional message property JMSXDeliveryCount on or off. |
deliveryAttemptsLimited |
boolean |
True |
Queue |
A flag indication if the number of delivery attempts is limited, that is, if the undeliverable messages have to be moved to a dead message queue. |
maxDeliveryAttempts |
int |
5 |
Queue |
Defines the maximum number of message delivery attempts. |
deliveryDelayInterval |
long |
2000 |
Destination |
Defines the delay in milliseconds between two consecutive message delivery attempts. |
errorDestination |
String |
sapDefaultErrorQueue |
Destination |
Defines the name of a JMS destination where dead messages will be moved. |
loadBalanceBehavior |
byte |
3 |
Queue |
Defines the load balance behavior of the queue in case the destination has more than one consumer. The possible values are 1 (Exclusive - the registering of a second consumer will fail) and 3 (Round-robin - messages will be distributed among all registered consumers in a round-robin fashion). |
memoryQueueMaxRowsOnStartup |
int |
64 |
Topic |
The maximum number of messages to initially select from the database into the memory queue. |
Note that every property is relevant for a particular JMS resource type. If a property is relevant for Destination, it means it is applicable to both Queue and Topic. Any properties that are not recognized will be ignored during deployment.
Example
Here is an example that illustrates the optional property elements of the JMS resources schema.
<?xml version="1.0" encoding="UTF-8"?> <jms-resources xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="D:\Develop\JMS\Test\AdminTest\jms-resources.xsd"> <application-name>MyApplication</application-name> <connection-factory> <name>MyQueueFactory</name> <sap-local-factory-type> <type>javax.jms.QueueConnectionFactory</type> <virtual-provider>default</virtual-provider> <property> <description>Client ID</description> <config-property-name>clientID</config-property-name> <config-property-value> myClientApp </config-property-value> </property> </sap-local-factory-type> </connection-factory> <destination> <name>MyQueue</name> <type>javax.jms.Queue</type> <sap-local-destination-type> <virtual-provider>default</virtual-provider> <property> <description>Maximum Delivery Attempts</description> <config-property-name> maxDeliveryAttempts </config-property-name> <config-property-value>30</config-property-value> </property> <property> <description>Load Balance Behavior</description> <config-property-name> loadBalanceBehavior </config-property-name> <config-property-value>1</config-property-value> </property> </sap-local-destination-type> </destination> </jms-resources> |