Chapter 17 JMS Resource Adapter Property Reference

Chapter 17
JMS Resource Adapter Property Reference

The 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 properties through three JavaBean components:

ResourceAdapter configuration affects the behavior of the Resource Adapter as a whole.

ManagedConnectionFactory configuration affects connections created by the 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 property 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 properties of the Message Queue JMS Resource Adapter. It contains the following sections:

ResourceAdapter JavaBean

ManagedConnectionFactory JavaBean

ActivationSpec JavaBean

ResourceAdapter JavaBean

The ResourceAdapter configuration configures the default JMS Resource Adapter behavior. Table 17-1 lists and describes the properties with which you can configure this JavaBean. A footnote marks each required property.

Table 17-1 Resource Adapter Properties
Property	Default	Description
addressList1	mq://localhost:7676 /jms	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 property name, addressList, is specific to Sun Java System Message Queue, but has the same meaning as the standard property connectionURL. Sun Java System Message Queue provides both property names. You must set either connectionURL or addressList; they are equivalent.
addressListBehavior	PRIORITY	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.
addressListIterations	1	The number of times to iterate through the address list. This value applies to the initial connection and to subsequent reconnection attempts.
connectionURL	mq://localhost:7676 /jms	The connection that the Resource Adapter makes to the Message Queue service, specified using the message service address format. Equivalent to the addressList property; see description above for further details.
userName¹	guest	The default user name with which the Resource Adapter connects to the Message Queue service. The Resource Adapter supplies the default value.
password¹	guest	The default password with which the Resource Adapter connects to the Message Queue service. The Resource Adapter supplies the default value.
reconnectAttempts	6	The number of times to attempt reconnection to a single entry in the address list. This property is used when reconnectEnabled is set to true.
reconnectEnabled	false	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.
reconnectInterval	30000	The interval between reconnection attempts, in milliseconds. This property is used when reconnectEnabled is set to true.

1This property is required.

ManagedConnectionFactory JavaBean

A 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 property, 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
Attribute	Default	Description
addressList	None	A list of connections derived from this managed connection factory. The format of this attribute 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.
addressListBehavior	PRIORITY	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.
addressListIterations	1	The number of times to iterate through the address list. This value applies to the initial connection and to subsequent reconnection attempts.
clientID	None	The client identifier to use for connections derived from this managed connection factory.
password	guest	(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.
reconnectAttempts	6	The number of times to attempt reconnection to a single entry in the address list.
reconnectEnabled	false	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 attributes.
reconnectInterval	30000	The minimum number of milliseconds to wait between attempts to reconnect to the Message Queue service.
userName	guest	(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.

ActivationSpec JavaBean

ActivationSpec 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 properties 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.

Table 17-3 Activation Specification Properties
Property	Default	Description
acknowledgeMode	Auto-acknowledge	(Optional) The JMS session acknowledgment mode to use for the consumer. This is a standard EJB 2.1 and J2EE CA 1.5 property. The value can be Auto-acknowledge or Dups-ok-acknowledge.
addressList	Inherited from addressList in the ResourceAdapter JavaBean configuration	(Optional) The specification of the connection made by the Resource Adapter on behalf of the message endpoint. This property is specific to the Message Queue JMS Resource Adapter. The valid values must conform to the message service connection address syntax.
clientId	None	The JMS client ID to be used by the JMS connection created for this consumer. You must set this property if you set the subscriptionDurability property to Durable. This is a standard EJB 2.1 and J2EE CA 1.5 property.
customAcknowledgeMode	None	A string specifying the mode for MDB message consumption. The valid values for this property are No_acknowledge or null. You can use No_acknowledge mode only for a non-transacted, non-durable topic subscription. If you use this setting with a transacted subscription or a durable subscription, subscription activation fails.
destination	None	The name of the destination from which this MDB consumes messages. This is a required property. It is a standard EJB 2.1 and J2EE CA1.5 property. The value must be set to the value of the destinationName property for a Message Queue destination administered object.
destinationType	None	The type of destination specified by the destination property. Valid values are javax.jms.Queue or javax.jms.Topic. This is a required property. It is a standard EJB 2.1 and J2EE CA1.5 property.
endpointExceptionRedelivery Attempts	6	The number of times to redeliver a message to the MDB when the MDB throws an exception during message delivery.
messageSelector	None	(Optional) A JMS message selector to use for filtering the messages delivered to the consumer. The value is of type String. This is a standard EJB 2.1 and J2EE CA 1.5 property.
sendUndeliverableMsgsToDMQ	true	A boolean value specifying whether to place a message in the dead message queue when the MDB throws a runtime exception and the number of redelivery attempts exceeds the value of endpointExceptionRedeliveryAttempts. If false, the Message Queue broker will attempt redelivery of the message to any valid consumer, including the same MDB.
subscriptionDurability	NonDurable	A string specifying whether a consumer for a topic destination is durable or nondurable. The value can be NonDurable or Durable. This property is optional for nondurable subscriptions and required for durable subscriptions. If you set this value to Durable, you must also set the properties clientID and subscriptionName. This is a standard EJB 2.1 and J2EE CA1.5 property and is valid only if the destinationType property is set to avax.jms.Topic.
subscriptionName	None	A string to use to name durable subscriptions. You must set this property if you set subscriptionDurability property to Durable. This is a standard EJB 2.1 and J2EE CA 1.5 property.

Previous Contents Index Next

Previous Contents Index Next
Sun Java System Message Queue 3 2005Q4 Administration Guide