20 JMS Resource Adapter Property Reference

connectionURL^Foot 1 

String

mq://localhost:7676/jms

Message service address for connecting to the Message Queue service

brokerInstanceName

String

imqbroker

Name of broker instance

brokerPort

Integer

7676

Port number for connecting to broker

brokerBindAddress

String

Null

Address to which broker binds on host machine

If null, the broker will bind to all addresses on the host machine.

userName^Foot 2 

String

guest

Default user name for connecting to Message Queue service

password^Footref 2

String

guest

Default password for connecting to Message Queue service

addressListBehavior

String

PRIORITY

Order in which to attempt connection to Message Queue service:

• PRIORITY: Order specified in address list

• RANDOM: Random order

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

brokerEnableHA

Boolean

false

Enable high availability?

clusterID

String

None

Cluster identifier

If specified, only brokers with the same cluster identifier can be clustered together. In the event of broker failure, client connections will fail over only to brokers with the same cluster identifier as the original broker. If not specified, client connections can fail over to any other broker with an unspecified cluster identifier.

For standalone brokers (those not belonging to a cluster), this property is ignored.

The identifier may contain only alphabetic letters (A-Z, a-z), numeric digits (0-9), and the underscore character (_).

brokerID

String

None

Broker identifier

For brokers using a JDBC-based persistent data store, this string is appended to the names of all database tables to make them unique in the case where more than one broker instance is using the same database. For brokers using a file-based data store, this property is ignored.

In an enhanced cluster, each broker must have a unique broker identifier.

The identifier may contain only alphabetic letters (A-Z, a-z), numeric digits (0-9), and the underscore character (_).

addressList

String

Value of connectionURL property of ResourceAdapter JavaBean (see Table 20-1)

List of message service addresses for connecting to Message Queue service

userName^Foot 1 

String

guest

User name for connecting to Message Queue service

password^Footref 1

String

guest

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:

• PRIORITY: Order specified in address list

• RANDOM: Random order

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

options^Footref 1

String

None

A list of additional connection factory properties to be used when creating connections to a Message Queue broker.

When specified, the value of options must be a comma-separated list of connection factory properties and their values, in the form:

propertyName=value

If value contains a comma or an equals sign, precede the symbol with a backslash (\) or enclose the entire value in quotes; for example:

prop1=comma\,val,prop2="equals=val"

The options property cannot specify properties that are configured internally or that have their own setter methods, specifically: imqReconnectEnabled, imqReconnectAttempts, imqReconnectInterval, imqDefaultUsername, imqDefaultPassword, imqAddressList, imqAddressListIterations. Any values specified in options for these properties are ignored.

useSharedSubscriptionInClusteredContainer

Boolean

true

Controls whether topic subscriptions created using this ManagedConnectionFactory will be shared when running in a clustered container, as described in About Shared Topic Subscriptions for Clustered Containers.

Set to true (the default) to share subscriptions. The clientID property must also be set, even if the subscription is nondurable.

Set to false to not share subscriptions. This setting should only be used for nondurable subscriptions. The clientID property does not need to be set.

addressList^{Foot 1 ,Foot 2} 

String

Value of connectionURL property of ResourceAdapter JavaBean (see Table 20-1)

Message service address for connecting to Message Queue service

userName^{Footref 1 ,Footref 2}

String

Inherited from ResourceAdapter JavaBean (see Table 20-1)

User name for connecting to Message Queue service.

password^{Footref 1 ,Footref 2}

String

Inherited from ResourceAdapter JavaBean (see Table 20-1)

Password for connecting to Message Queue service.

clientId^Foot 3 

String

None

Client ID for connections to Message Queue service

This property must be set if subscriptionDurability is set to Durable.

addressListBehavior^{Footref 1,Footref 2}

String

Inherited from ResourceAdapter JavaBean (see Table 20-1)

Order in which to attempt connection or reconnection to Message Queue service:

PRIORITY: order specified in address list

RANDOM: Random order

addressListIterations^{Footref 1,Footref 2}

Integer

Inherited from ResourceAdapter JavaBean (see Table 20-1)

Number of times to iterate through addressList attempting to establish or reestablish a connection.

When this limit is reached an exception will be thrown and a new connection attempt will begin, with no limit.

reconnectAttempts^{Footref 1 ,Footref 2}

Integer

Inherited from ResourceAdapter JavaBean (see Table 20-1)

Number of times to attempt connection or reconnection to each address in addressList before moving on to next.

reconnectInterval1^{Footref 1,Footref 2}

Integer

Inherited from ResourceAdapter JavaBean (see Table 20-1)

Interval, in milliseconds, between reconnection attempts

destination^Footref 3

String

None

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^Footref 3

String

None

Type of destination specified by destination property:

• javax.jms.Queue: Queue destination

• javax.jms.Topic: Topic destination

messageSelector^{Footref 1,Footref 3}

String

None

Message selector for filtering messages delivered to consumer

subscriptionName^Footref 3

String

None

Name for durable subscriptions

This property must be set if subscriptionDurability is set to Durable.

subscriptionDurability^Footref 3

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.

acknowledgeMode^{Footref 1,Footref 3}

String

Auto-acknowledge

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.

options^Footref 1

String

None

A list of additional connection factory properties to be used when creating connections to a Message Queue broker.

When specified, the value of options must be a comma-separated list of connection factory properties and their values, in the form:

propertyName=value

If value contains a comma or an equals sign, precede the symbol with a backslash (\) or enclose the entire value in quotes; for example:

prop1=comma\,val,prop2="equals=val"

The options property cannot be used to specify properties that are configured internally or that have their own setter methods, specifically: imqReconnectEnabled, imqReconnectAttempts, imqReconnectInterval, imqDefaultUsername, imqDefaultPassword, imqAddressList, imqAddressListIterations, imqAddressListBehavior. Any values specified in options for these properties are ignored.

useSharedSubscriptionInClusteredContainer

Boolean

true

Controls whether topic subscriptions created using this ActivationSpec will be shared when running in a clustered container, as described in About Shared Topic Subscriptions for Clustered Containers.

Set to true (the default) to share subscriptions.

Set to false to not share subscriptions. This setting should only be used for nondurable subscriptions.