Chapter 17 JMS Resource
Adapter Property Reference
This chapter
describes the configuration properties of the Message QueueTM JMS Resource Adapter (JMS RA), which enables
you to integrate Sun Java SystemTM Message Queue with any J2EE 1.4
application server by means of the standard J2EE connector architecture (JCA).
When plugged into an application server, the Resource Adapter allows applications deployed in
that application server to use Message Queue to
send and receive JMS messages.
The Message Queue JMS Resource Adapter exposes its
configuration properties through three JavaBean components:
-
The ResourceAdapter JavaBean (ResourceAdapter JavaBean) affects the behavior of the Resource Adapter
as a whole.
-
The ManagedConnectionFactory JavaBean (ManagedConnectionFactory JavaBean) affects connections created by the Resource
Adapter for use by message-driven beans (MDBs).
-
The ActivationSpec JavaBean (ActivationSpec JavaBean) affects message endpoints that represent MDBs
in their interactions with the messaging system.
To set property values for these entities, you use the tools provided by your application
server 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
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.
Table 17–1 Resource
Adapter Properties
|
Property
|
Type
|
Default
|
Description
|
|
addressList
|
String
|
mq://localhost:7676/jms
|
(Required) Message service address for connecting to Message Queue service
Equivalent to connectionURL (below); you must set one or the other.
|
|
connectionURL
|
String
|
mq://localhost:7676/jms
|
Message
service address for connecting to the Message Queue service
Equivalent
to addressList(above); you must set one or the other.
|
|
userName
|
String
|
guest
|
(Required) Default user name for connecting to Message Queue service
|
|
password
|
String
|
guest
|
(Required) Default password for connecting to Message Queue service
|
|
addressListBehavior
|
String
|
PRIORITY
|
Order in which to attempt connection to Message Queue service:
Note –
Reconnection attempts after a connection failure start with the broker whose
connection failed and proceed sequentially through
the address
list, regardless of
the value set for this property.
|
|
addressListIterations
|
Integer
|
1
|
Number of times
to iterate through address list attempting to establish or reestablish a connection
|
|
reconnectEnabled
|
Boolean
|
false
|
Attempt to reestablish a lost connection?
|
|
reconnectAttempts
|
Integer
|
6
|
Number
of times to attempt reconnection to each address in address list before moving on to next
|
|
reconnectInterval
|
Long integer
|
30000
|
Interval, in milliseconds,
between reconnection attempts
|
ManagedConnectionFactory JavaBean
A managed connection factory defines the
connections that the Resource Adapter provides to a message-driven bean. Table 17–2 shows the properties of the ManagedConnectionFactory JavaBean; if set, these properties override the corresponding
properties of the ResourceAdapter JavaBean.
Table 17–2 Managed
Connection Factory Properties
|
Property
|
Type
|
Default
|
Description
|
|
addressList
|
String
|
Inherited from ResourceAdapter JavaBean (see Table 17–1)
|
List of message service addresses for connecting to Message Queue service
|
|
userName
|
String
|
guest
|
(Optional) User name for connecting to Message Queue service
|
|
password
|
String
|
guest
|
(Optional) Password for connecting to Message Queue service
|
|
clientID
|
String
|
None
|
Client identifier for connections to Message Queue service
|
|
addressListBehavior
|
String
|
PRIORITY
|
Order in which to attempt connection to Message Queue service:
Note –
Reconnection attempts after a connection failure start with the broker whose
connection failed and proceed sequentially
through the address list,
regardless of the value set for this property.
|
|
addressListIterations
|
Integer
|
1
|
Number of times
to iterate through address list attempting to establish or reestablish a connection
|
|
reconnectEnabled
|
Boolean
|
false
|
Attempt to reestablish a lost connection?
|
|
reconnectAttempts
|
Integer
|
6
|
Number of times to attempt reconnection
to each address in address list
before moving on to next
|
|
reconnectInterval
|
Long integer
|
30000
|
Interval,
in milliseconds, between reconnection attempts
|
ActivationSpec JavaBean
Table 17–3 shows the configurable properties
of the ActivationSpec JavaBean. These properties are used
by the application server when instructing the Resource Adapter to activate a message
endpoint and associate it with a message-driven bean.
Table 17–3 Activation
Specification Properties
|
Property
|
Type
|
Default
|
Description
|
|
addressList [Property specific to Message Queue JMS Resource Adapter]
|
String
|
Inherited from ResourceAdapter JavaBean
|
(Optional) Message service address for connecting
to Message Queue service
|
|
destination [Standard Enterprise JavaBean (EJB) and J2EE Connector
Architecture (CA) property]
|
String
|
None
|
(Required) Name of destination from which to consume
messages
The value must be that of the destinationName property
for a Message Queue destination administered object.
|
|
destinationType
|
String
|
None
|
(Required) Type of destination specified by destination property:
javax.jms.Queue: Queue destination
javax.jms.Topic: Topic destination
|
|
messageSelector
|
String
|
None
|
(Optional) Message selector for filtering messages
delivered to consumer
|
|
subscriptionName
|
String
|
None
|
Name for durable subscriptions
This property must be set if subscriptionDurability is set to Durable.
|
|
subscriptionDurability
|
String
|
NonDurable
|
Durability of consumer for topic destination:
Durable: Durable consumer
NonDurable: Nondurable consumer
This property is valid only if destinationType is set to javax.jms.Topic, and is optional for nondurable subscriptions and required for
durable ones. If set to Durable, the clientID and subscriptionName properties must also be
set.
|
|
clientId
|
String
|
None
|
Client ID for connections to Message Queue service
This
property must be set if subscriptionDurability is set to Durable.
|
|
acknowledgeMode
|
String
|
Auto-acknowledge
|
(Optional) Acknowledgment mode:
Auto-acknowledge: Auto-acknowledge mode
Dups-ok-acknowledge: Dups-OK-acknowledge
mode
|
|
customAcknowledgeMode
|
String
|
None
|
Acknowledgment mode for MDB message consumption
Valid values are No_acknowledge or null.
You can use no-acknowledge mode only
for a nontransacted, nondurable topic
subscription; if you use
this setting with a transacted subscription or a durable subscription, subscription
activation will fail.
|
|
endpointExceptionRedeliveryAttempts
|
Integer
|
6
|
Number of times
to redeliver a message when MDB throws
an exception during message delivery
|
|
sendUndeliverableMsgsToDMQ
|
Boolean
|
true
|
Place message in dead message queue
when MDB throws a runtime exception and 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.
|
