jmsActivationSpec - JMS Activation Specification (jmsActivationSpec)

Defines a JMS activation specification configuration.

NameTypeDefaultDescription
idstringA unique configuration ID.
authDataRefA reference to top level authData element (string).Default authentication data for an activation specification.
maxEndpointsint
Min: 0
500The maximum number of endpoints to dispatch to.

authData

Default authentication data for an activation specification.

NameTypeDefaultDescription
userstringName of the user to use when connecting to the EIS.
passwordReversably encoded password (string)Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.

properties.wasJms

A JMS activation specification is associated with one or more message-driven beans and provides the configuration necessary for them to receive messages.

NameTypeDefaultDescription
acknowledgeMode
  • Dups-ok-acknowledge
  • Auto-acknowledge
Auto-acknowledgeThe acknowledge mode indicates how a message received by a message-driven bean should be acknowledged.
Dups-ok-acknowledge
Dups-ok-acknowledge
Auto-acknowledge
Auto-acknowledge
busNamestringdefaultBusThe name of a bus when connecting to the service integration bus in a full profile server.
destinationType
  • javax.jms.Topic
  • javax.jms.Queue
javax.jms.QueueThe type of the destination, which is javax.jms.Queue or javax.jms.Topic.
javax.jms.Topic
javax.jms.Topic
javax.jms.Queue
javax.jms.Queue
maxConcurrencyint
Min: 1

Max: 2147483647
5The maximum number of endpoints to which the messages are delivered concurrently. The increase in the number can improve the performance, but it also increases the number of threads that are in use at the specified time. If the message order must be retained for all the failed deliveries, set the maximum concurrent endpoints value to 1.
readAhead
  • AlwaysOff
  • Default
  • AlwaysOn
DefaultRead ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.
AlwaysOff
AlwaysOff
Default
Default
AlwaysOn
AlwaysOn
retryIntervalA period of time with second precision30sThe delay (in seconds) between attempts to connect to a messaging engine, both for the initial connection, and any subsequent attempts to establish a better connection. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
subscriptionDurability
  • DurableShared
  • Durable
  • NonDurable
  • NonDurableShared
NonDurableType of MS topic subscription. The value can be any of following values: Durable DurableShared NonDurable NonDurableShared
DurableShared
DurableShared
Durable
Durable
NonDurable
NonDurable
NonDurableShared
NonDurableShared
targetTransportChain
  • InboundSecureMessaging
  • InboundBasicMessaging
InboundBasicMessagingTransport chains specify the communication protocols that can be used to communicate with the service integration bus in a full profiles server.
InboundSecureMessaging
InboundSecureMessaging
InboundBasicMessaging
InboundBasicMessaging
clientIdstringThe JMS client identifier needed for durable(and for shared non-durable) topic subscriptions on all connections. This identifier is required if the application is doing durable(and for shared non-durable) publish/subscribe messaging.
connectionFactoryLookupstringThis property can be used to specify the lookup name of an administratively-defined javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory object that is used to connect to the JMS provider from which the endpoint (message-driven bean) can receive messages.
destinationstringReference to a JMS destination
destinationLookupstringThis property can be used to specify the lookup name of the administratively-defined javax.jms.Queue or javax.jms.Topic objects that define the JMS queue or topic from which the endpoint (message-driven bean) can receive messages.
destinationRefA reference to top level adminObject element (string).Reference to a JMS destination
maxBatchSizeint
Min: 1

Max: 2147483647
The maximum number of messages received from the messaging engine in a single batch.
messageSelectorstringThe JMS message selector used to determine which messages the message-driven bean receives. The value is a string that is used to select a subset of the available messages.
remoteServerAddressstringThe remote server address that has triplets separated by a comma, with the syntax hostName:portNumber:chainName, used to connect to a bootstrap server. For example, Merlin:7276:BootstrapBasicMessaging. If hostName is not specified, the default is localhost. If portNumber is not specified, the default is 7276. If chainName is not specified, the default is BootstrapBasicMessaging. Refer to the information center for more information.
shareDurableSubscriptionstringControls whether or not durable subscription can be shared across connections.
subscriptionNamestringThe subscription name needed for durable(and for shared non-durable). Required field when using a durable(and for shared non-durable) topic subscription.This subscription name must be unique within a given client identifier.

properties.wmqJms

WebSphere MQ JMS activation specification

NameTypeDefaultDescription
destinationRefA reference to top level adminObject element (string).Destination
CCSIDint
Min: 1
819The coded character set identifier for a connection.
channelstringSYSTEM.DEF.SVRCONNThe name of the MQI channel to use.
cloneSupport
  • ENABLED
  • DISABLED
DISABLEDWhether two or more instances of the same durable topic subscriber can run simultaneously
ENABLED
ENABLED
DISABLED
DISABLED
destinationType
  • javax.jms.Topic
  • javax.jms.Queue
javax.jms.QueueThe type of destination - javax.jms.Queue or javax.jms.Topic
javax.jms.Topic
javax.jms.Topic
javax.jms.Queue
javax.jms.Queue
headerCompression
  • SYSTEM
  • NONE
NONEA list of the techniques that can be used for compressing header data on a connection
SYSTEM
SYSTEM
NONE
NONE
hostNamestringlocalhostThe host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
messageCompression
  • RLE
  • NONE
NONEA list of the techniques that can be used for compressing message data on a connection
RLE
RLE
NONE
NONE
pollingIntervalA period of time with millisecond precision5sIf each message listener within a session has no suitable message on its queue, this value is the maximum interval, in milliseconds, that elapses before each message listener tries again to get a message from its queue. If it frequently happens that no suitable message is available for any of the message listeners in a session, consider increasing the value of this property. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
poolTimeoutA period of time with millisecond precision5mThe time, in milliseconds, that an unused server session is held open in the server session pool before being closed due to inactivity. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
portint
Min: 1
1414The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
providerVersion
  • 7
  • 6
  • unspecified
unspecifiedThe version, release, modification level and fix pack of the queue manager to which the application intends to connect.
7
7
6
6
unspecified
unspecified
rescanIntervalA period of time with millisecond precision5sWhen a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, WebSphere MQ classes for JMS searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When WebSphere MQ classes for JMS finds a suitable message and delivers it to the consumer, WebSphere MQ classes for JMS resumes the search for the next suitable message from its current position in the queue. WebSphere MQ classes for JMS continues to search the queue in this way until it reaches the end of the queue, or until the interval of time in milliseconds, as determined by the value of this property, has expired. In each case, WebSphere MQ classes for JMS returns to the beginning of the queue to continue its search, and a new time interval commences. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
shareConvAllowedbooleantrueWhether a client connection can share its socket with other top-level JMS connections from the same process to the same queue manager, if the channel definitions match
startTimeoutA period of time with millisecond precision10sConfigures the time duration (in milliseconds) within which the execution must start. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
transportType
  • CLIENT
  • BINDINGS
CLIENTWhether a connection to a queue manager uses client mode or bindings mode.
CLIENT
CLIENT
BINDINGS
BINDINGS
failIfQuiescebooleantrueWhether calls to certain methods fail if the queue manager is in a quiescing state.
maxMessagesint
Min: 0
1The maximum number of messages that can be assigned to a server session at one time. If the activation spec is delivering messages to an MDB in an XA transaction, a value of 1 is used regardless of the setting of this property.
maxPoolDepthint
Min: 0
10The maxPoolDepth property on the activation specification defines the number of available MDB (Message Driven Bean) instances. Decreasing the value of this property decreases the number of messages that can be delivered concurrently.
messageSelection
  • CLIENT
  • BROKER
CLIENTDetermines whether message selection is done by WebSphere MQ classes for JMS or by the broker.
CLIENT
CLIENT
BROKER
BROKER
receiveCCSIDint
Min: 0
0Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receive conversion is set to WMQ_RECEIVE_CONVERSION_QMG
receiveConversion
  • QMGR
  • CLIENT_MSG
CLIENT_MSGDestination property that determines if data conversion is going to be performed by the queue manager.
QMGR
QMGR
CLIENT_MSG
CLIENT_MSG
sslResetCountint
Min: 0

Max: 999999999
0The total number of bytes sent and received by an SSL connection before the secret keys used by SSL are renegotiated
cleanupLevel
  • SAFE
  • FORCE
  • NONDUR
  • NONE
  • STRONG
SAFEThe cleanup level for a broker-based subscription store.
SAFE
SAFE
FORCE
FORCE
NONDUR
NONDUR
NONE
NONE
STRONG
STRONG
sparseSubscriptionsbooleanfalseControls the message retrieval policy of a TopicSubscriber object
statusRefreshIntervalA period of time with millisecond precision1mThe interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subscription store has the value QUEUE. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
subscriptionStore
  • MIGRATE
  • BROKER
  • QUEUE
BROKERDetermines where WebSphere MQ classes for JMS stores persistent data about active subscriptions
MIGRATE
MIGRATE
BROKER
BROKER
QUEUE
QUEUE
wildcardFormat
  • CHAR
  • TOPIC
TOPICWhich version of wildcard syntax is to be used.
CHAR
CHAR
TOPIC
TOPIC
applicationNamestringThe name by which an application is registered with the queue manager.
ccdtURLstringA URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
clientIdstringThe client identifier for a connection
connectionNameListstringA list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
localAddressstringFor a connection to a queue manager, this property specifies either or both of the following, (1) The local network interface to be used, (2) The local port, or range of local ports, to be used
messageBatchSizeint
Min: 0
Maximimum number of messages to process in one batch.
queueManagerstringThe name of the queue manager to connect to
subscriptionDurability
  • Durable
  • NonDurable
Whether a durable or nondurable subscription is used to deliver messages to an MDB subscribing to the topic
Durable
Durable
NonDurable
NonDurable
subscriptionNamestringThe name of the durable subscription
messageRetentionbooleanWhether the connection consumer keeps unwanted messages on the input queue
messageSelectorstringDetermines whether message selection is done by WebSphere MQ classes for JMS or by the broker. Message selection by the broker is not supported when brokerVersion has the value 1
sslCertStoresstringThe Lightweight Directory Access Protocol (LDAP) servers that hold certificate revocation lists (CRLs) for use on an SSL connection
sslCipherSuitestringThe CipherSuite to use for an SSL connection
sslFipsRequiredbooleanWhether an SSL connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).
sslPeerNamestringFor an SSL connection, a template that is used to check the distinguished name in the digital certificate provided by the queue manager
brokerCCDurSubQueuestringThe name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer
brokerCCSubQueuestringThe name of the queue from which a connection consumer receives nondurable subscription messages
brokerControlQueuestringThe name of the broker control queue
brokerPubQueuestringThe name of the queue where published messages are sent (the stream queue)
brokerQueueManagerstringThe name of the queue manager on which the broker is running
brokerSubQueuestringThe name of the queue from which a nondurable message consumer receives messages
brokerVersion
  • 2
  • 1
The version of the broker being used
2
2
1
1
cleanupIntervalA period of time with millisecond precisionThe interval, in milliseconds, between background runs of the publish/subscribe cleanup utility. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
receiveExitstringIdentifies a channel receive exit program, or a sequence of receive exit programs to be run in succession
receiveExitInitstringThe user data that is passed to channel receive exit programs when they are called
securityExitstringIdentifies a channel security exit program
securityExitInitstringThe user data that is passed to a channel security exit program when it is called
sendExitstringIdentifies a channel send exit program, or a sequence of send exit programs to be run in succession
sendExitInitstringThe user data that is passed to channel send exit programs when they are called