Defines a JMS activation specification configuration.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
authDataRef | A reference to top level authData element (string). | Default authentication data for an activation specification. | |
maxEndpoints | int Min: 0 | 500 | The maximum number of endpoints to dispatch to. |
Default authentication data for an activation specification.
Name | Type | Default | Description |
---|---|---|---|
user | string | Name of the user to use when connecting to the EIS. | |
password | Reversably 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. |
A JMS activation specification is associated with one or more message-driven beans and provides the configuration necessary for them to receive messages.
Name | Type | Default | Description |
---|---|---|---|
acknowledgeMode |
| Auto-acknowledge | The 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 |
busName | string | defaultBus | The name of a bus when connecting to the service integration bus in a full profile server. |
destinationType |
| javax.jms.Queue | The 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 |
maxConcurrency | int Min: 1 Max: 2147483647 | 5 | The 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 |
| Default | Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster. AlwaysOff AlwaysOff Default Default AlwaysOn AlwaysOn |
retryInterval | A period of time with second precision | 30s | The 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 |
| NonDurable | Type 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 |
| InboundBasicMessaging | Transport 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 |
clientId | string | The 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. | |
connectionFactoryLookup | string | This 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. | |
destination | string | Reference to a JMS destination | |
destinationLookup | string | This 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. | |
destinationRef | A reference to top level adminObject element (string). | Reference to a JMS destination | |
maxBatchSize | int Min: 1 Max: 2147483647 | The maximum number of messages received from the messaging engine in a single batch. | |
messageSelector | string | The 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. | |
remoteServerAddress | string | The 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. | |
shareDurableSubscription | string | Controls whether or not durable subscription can be shared across connections. | |
subscriptionName | string | The 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. |
WebSphere MQ JMS activation specification
Name | Type | Default | Description |
---|---|---|---|
destinationRef | A reference to top level adminObject element (string). | Destination | |
CCSID | int Min: 1 | 819 | The coded character set identifier for a connection. |
channel | string | SYSTEM.DEF.SVRCONN | The name of the MQI channel to use. |
cloneSupport |
| DISABLED | Whether two or more instances of the same durable topic subscriber can run simultaneously ENABLED ENABLED DISABLED DISABLED |
destinationType |
| javax.jms.Queue | The type of destination - javax.jms.Queue or javax.jms.Topic javax.jms.Topic javax.jms.Topic javax.jms.Queue javax.jms.Queue |
headerCompression |
| NONE | A list of the techniques that can be used for compressing header data on a connection SYSTEM SYSTEM NONE NONE |
hostName | string | localhost | The 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 |
| NONE | A list of the techniques that can be used for compressing message data on a connection RLE RLE NONE NONE |
pollingInterval | A period of time with millisecond precision | 5s | If 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. |
poolTimeout | A period of time with millisecond precision | 5m | The 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. |
port | int Min: 1 | 1414 | The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified. |
providerVersion |
| unspecified | The version, release, modification level and fix pack of the queue manager to which the application intends to connect. 7 7 6 6 unspecified unspecified |
rescanInterval | A period of time with millisecond precision | 5s | When 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. |
shareConvAllowed | boolean | true | Whether 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 |
startTimeout | A period of time with millisecond precision | 10s | Configures 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 | Whether a connection to a queue manager uses client mode or bindings mode. CLIENT CLIENT BINDINGS BINDINGS |
failIfQuiesce | boolean | true | Whether calls to certain methods fail if the queue manager is in a quiescing state. |
maxMessages | int Min: 0 | 1 | The 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. |
maxPoolDepth | int Min: 0 | 10 | The 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 | Determines whether message selection is done by WebSphere MQ classes for JMS or by the broker. CLIENT CLIENT BROKER BROKER |
receiveCCSID | int Min: 0 | 0 | Destination 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 |
| CLIENT_MSG | Destination property that determines if data conversion is going to be performed by the queue manager. QMGR QMGR CLIENT_MSG CLIENT_MSG |
sslResetCount | int Min: 0 Max: 999999999 | 0 | The total number of bytes sent and received by an SSL connection before the secret keys used by SSL are renegotiated |
cleanupLevel |
| SAFE | The cleanup level for a broker-based subscription store. SAFE SAFE FORCE FORCE NONDUR NONDUR NONE NONE STRONG STRONG |
sparseSubscriptions | boolean | false | Controls the message retrieval policy of a TopicSubscriber object |
statusRefreshInterval | A period of time with millisecond precision | 1m | The 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 |
| BROKER | Determines where WebSphere MQ classes for JMS stores persistent data about active subscriptions MIGRATE MIGRATE BROKER BROKER QUEUE QUEUE |
wildcardFormat |
| TOPIC | Which version of wildcard syntax is to be used. CHAR CHAR TOPIC TOPIC |
applicationName | string | The name by which an application is registered with the queue manager. | |
ccdtURL | string | A 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. | |
clientId | string | The client identifier for a connection | |
connectionNameList | string | A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties. | |
localAddress | string | For 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 | |
messageBatchSize | int Min: 0 | Maximimum number of messages to process in one batch. | |
queueManager | string | The name of the queue manager to connect to | |
subscriptionDurability |
| Whether a durable or nondurable subscription is used to deliver messages to an MDB subscribing to the topic Durable Durable NonDurable NonDurable | |
subscriptionName | string | The name of the durable subscription | |
messageRetention | boolean | Whether the connection consumer keeps unwanted messages on the input queue | |
messageSelector | string | Determines 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 | |
sslCertStores | string | The Lightweight Directory Access Protocol (LDAP) servers that hold certificate revocation lists (CRLs) for use on an SSL connection | |
sslCipherSuite | string | The CipherSuite to use for an SSL connection | |
sslFipsRequired | boolean | Whether an SSL connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS). | |
sslPeerName | string | For an SSL connection, a template that is used to check the distinguished name in the digital certificate provided by the queue manager | |
brokerCCDurSubQueue | string | The name of the queue from which non-durable subscription messages are retrieved for a ConnectionConsumer | |
brokerCCSubQueue | string | The name of the queue from which a connection consumer receives nondurable subscription messages | |
brokerControlQueue | string | The name of the broker control queue | |
brokerPubQueue | string | The name of the queue where published messages are sent (the stream queue) | |
brokerQueueManager | string | The name of the queue manager on which the broker is running | |
brokerSubQueue | string | The name of the queue from which a nondurable message consumer receives messages | |
brokerVersion |
| The version of the broker being used 2 2 1 1 | |
cleanupInterval | A period of time with millisecond precision | The 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. | |
receiveExit | string | Identifies a channel receive exit program, or a sequence of receive exit programs to be run in succession | |
receiveExitInit | string | The user data that is passed to channel receive exit programs when they are called | |
securityExit | string | Identifies a channel security exit program | |
securityExitInit | string | The user data that is passed to a channel security exit program when it is called | |
sendExit | string | Identifies a channel send exit program, or a sequence of send exit programs to be run in succession | |
sendExitInit | string | The user data that is passed to channel send exit programs when they are called |