|
| |
| Sun Java System Message Queue 3 2005Q1 Administration Guide | |
Chapter 17
JMS Resource Adapter Attribute ReferenceThe Message Queue JMS resource adapter (JMS RA) enables you to integrate Sun Java System Message Queue with any J2EE 1.4 application server, by means of the standard J2EE connector architecture (JCA). When the Message Queue JMS resource adapter is plugged into an application server, an application deployed in that application server can use Message Queue to send and receive JMS messages.
The Message Queue JMS resource adapter exposes its configuration attributes through three JavaBean components:
- ResourceAdapter configuration affects the behavior of the resource adapter as a whole.
- ManagedConnectionFactory configuration affects connections created by he resource adapter for use by message-driven beans (MDBs).
- ActivationSpec configuration affects message endpoints that represent message driven beans MDBs in their interactions with the messaging system.
To set attribute values for these entities, you use the tools that your application server provides for configuration and deployment of the resource adapter and for deployment of MDBs.
This chapter lists and describes the configuration attributes of the Message Queue JMS resource adapter. It contains the following sections:
ResourceAdapter JavaBeanThe ResourceAdapter configuration configures the default JMS resource adapter behavior. Table 17-1 lists and describes the attributes with which you can configure this JavaBean. A footnote marks each required property.
Table 17-1 Resource Adapter Attributes
Name
Description
Default
addressList1
The connection that the resource adapter makes to the Message Queue service, specified using the message service address format.
The resource adapter supplies the default value.
This attribute name, addressList, is specific to Sun Java System Message Queue, but has the same meaning as the standard attribute connectionURL. Sun Java System Message Queue provides both attribute names. You must set either connectionURL or addressList; they are equivalent.
mq://localhost:7676
/jmsaddressListBehavior
A string specifying how the resource adapter connects to the Message Queue service. The value is PRIORITY or RANDOM.
A PRIORITY connection selects a Message Queue broker by choosing the first specified in the address list (addressList).
A RANDOM connection selects a Message Queue broker randomly from the address list.
Reconnection after a connection failure is the same for PRIORITY and RANDOM. A reconnection attempt starts with the broker whose connection failed. If that attempt is unsuccessful, the resource adapter proceeds sequentially through the active address list.
PRIORITY
addressListIterations
The number of times to iterate through the address list. This value applies to the initial connection and to subsequent reconnection attempts.
1
connectionURL
The connection that the resource adapter makes to the Message Queue service, specified using the message service address format.
Equivalent to the addressList attribute; see description above for further details.
mq://localhost:7676
/jms
userName1
The default user name with which the resource adapter connects to the Message Queue service.
The resource adapter supplies the default value.
guest
password1
The default password with which the resource adapter connects to the Message Queue service.
The resource adapter supplies the default value.
guest
reconnectAttempts
The number of times to attempt reconnection to a single entry in the address list. This attribute is used when reconnectEnabled is set to true.
6
reconnectEnabled
A boolean value specifying whether to attempt reconnection after a connection failure.
The behavior of a reconnection attempt is governed by the values for reconnectInterval and reconnectAttempts.
false
reconnectInterval
The interval between reconnection attempts, in milliseconds. This attribute is used when reconnectEnabled is set to true.
30000
1This property is required.
ManagedConnectionFactory JavaBeanA managed connection factory provides and defines the connections that the resource adapter provides to a message-driven bean. If you set an attribute for which the ResourceAdapter JavaBean has an analogous attribute, the setting supersedes the analogous value specified for the ResourceAdapter bean.
Table 17-2 lists and describes the configurable attributes of a managed connection factory provided by the Message Queue resource adapter.
Table 17-2 Managed Connection Factory Attributes
Name
Description
Default
addressList
A list of connections derived from this managed connection factory.
The format of this property adheres to the Message Service addressList, as described in Table 17-1. If this value is not set, connections use the addressList value specified for the ResourceAdapter JavaBean and described in that table.
None
addressListBehavior
A string specifying how the resource adapter connects to the Message Queue service. The value is PRIORITY or RANDOM.
A PRIORITY connection selects a Message Queue broker by choosing the first specified in the address list (addressList).
A RANDOM connection selects a Message Queue broker randomly from the address list.
Reconnection after a connection failure is the same for PRIORITY and RANDOM. A reconnection attempt starts with the broker whose connection failed. If that is unsuccessful, the connection attempts proceed sequentially through the active address list.
PRIORITY
addressListIterations
The number of times to iterate through the address list. This value applies to the initial connection and to subsequent reconnection attempts.
1
clientID
The client identifier to use for connections derived from this managed connection factory.
None
password
(Optional) The password for connections.
If this value is not set, connections use the password specified for the ResourceAdapter JavaBean, as described in Table 17-1.
guest
reconnectAttempts
The number of times to attempt reconnection to a single entry in the address list.
6
reconnectEnabled
A boolean value specifying whether to attempt reconnection after failure of a connection or a new connection attempt.
The reconnection attempt is governed by the reconnectInterval and reconnectAttempts properties.
false
reconnectInterval
The minimum number of milliseconds to wait between attempts to reconnect to the Message Queue service.
30000
userName
(Optional) The user name for connections.
If this value is not set, connections use the user name specified for the ResourceAdapter JavaBean, as described in Table 17-1.
guest
ActivationSpec JavaBeanActivationSpec JavaBean properties are used by the application server when it instructs the resource adapter to activate a message endpoint and associate the message endpoint with a message-driven bean.
Table 17-3 lists and describes the configurable attributes for a message endpoint activation specification. The table indicates the properties that are specific to the Message Queue resource adapter and the properties that are specific to the Enterprise JavaBean 2.1 standard or J2EE Connector Architecture (J2EE CA) 1.5 standard.