Listener port settings

A listener port is used to simplify administration of the association between a connection factory, destination, and deployed message-driven bean.

Use this panel to view or change the configuration properties of the selected listener port.

To view this administrative console page, click Servers > Application Servers > application_server > [Communications] Messaging > Message Listener Service > Listener Ports > listener_port

Name

The name by which the listener port is known for administrative purposes.

Data type String
Default Null

Initial state

The state that you want the listener port to have when the application server is next restarted

Data type Enum
Units Not applicable
Default Started
Range
Started
When the application server is next started, the listener port is started automatically.
Stopped
When the application server is next started, the listener port is not started automatically. If message-driven beans are to use this listener port on the application server, the system administrator must start the port manually or select the Started value of this property then restart the application server.

Description

A description of the listener port, for administrative purposes within IBM WebSphere Application Server.

Data type String
Default Null

Connection factory JNDI name

The JNDI name for the JMS connection factory to be used by the listener port; for example, jms/connFactory1.

Data type String
Default Null

Destination JNDI name

The JNDI name for the destination to be used by the listener port; for example, jms/destn1.

You cannot use a temporary destination for late responses.

Data type String
Default Null

Maximum sessions

The maximum number of concurrent sessions that a listener can have with the JMS server to process messages.

Each session corresponds to a separate listener thread and therefore controls the number of concurrently processed messages. Adjust this parameter when the server does not fully use the available capacity of the machine and if you do not need to process messages in a specific message order.

Data type Integer
Units Sessions
Default 1
Range 1 through 2147483647
Recommended
  • To process messages in a strict message order, set this property to 1, so that only one thread is ever processing messages.
  • For message concurrency, that is to process multiple messages simultaneously, set this property to a value greater than 1. Keep this value as low as possible to prevent overloading client applications. A good starting point for a 100% JMS workload with short transaction times is 2 to 4 sessions per processor. If longer running transactions exist, you might need more sessions, which should be determined by experimentation.

    The total number of sessions specified in the Maximum Sessions property of all configured listener ports must be less than or equal to the number of threads specified for the Maximum Size property of the message listener service thread pool.

Maximum retries

The maximum number of times that the listener tries to deliver a message before the listener is stopped, in the range 0 through 2147483647.

Every message has a delivery count associated with it, which is incremented if the message cannot be delivered, or is delivered successfully to a message-driven bean instance and then rolled back. When the delivery count of a message equals the value of this property, the listener is stopped.

Note: When the listener's Maximum sessions property is set to a value greater than 1, it is possible that a message which cannot be delivered or has been rolled back might be processed more than the value of Maximum retries before the listener is shut down. If WebSphere MQ is being used as the JMS provider, this can be prevented by ensuring the WebSphere MQ queue properties Backout threshold (BOTHRESH) and Backout requeue queue (BOQUEUE) have been defined, and that the Backout threshold is less than Maximum retries. For more information on how WebSphere MQ handles messages that cannot be delivered or processed, see the WebSphere MQ Using Java book, which is available from the WebSphere MQ library at http://www.ibm.com/software/integration/wmq/library.
Data type Integer
Units Retry attempts
Default 0 (no retries)
Range

Recommended

0 (no retries) through 2147483647.

When using WebSphere MQ as the JMS provider, this property should be greater than the value of the WebSphere MQ queue property Backout threshold (BOTHRESH). This allows WebSphere MQ to remove the message from the queue without the need to shut down the listener.

Maximum messages

The maximum number of messages that the listener can process in one transaction.

If the queue is empty, the listener processes each message when it arrives. Each message is processed within a separate transaction.

For the WebSphere V5 default messaging provider or WebSphere MQ as the JMS provider, if messages start accumulating on the queue then the listener can start processing messages in batches. For generic JMS providers, this property value is passed to the JMS provider but the effect depends on the JMS provider.

Data type Integer
Units Number of messages
Default 1
Range 1 through 2147483647
Recommended
For the WebSphere default messaging providers or WebSphere MQ as the JMS provider, to process multiple messages in a single transaction, set this value to more than 1. If messages start accumulating on the queue, a value greater than 1 enables multiple messages to be batch-processed into a single transaction, and eliminates much of the overhead of transactions on JMS messages.
CAUTION:
  • If one message in the batch fails processing with an exception, the entire batch of messages is put back on the queue for processing.
  • Any resource lock held by any of the interactions for the individual messages are held for the duration of the entire batch.
  • Depending on the amount of processing that messages need, and if XA transactions are being used, setting a value greater than 1 can cause the transaction to time out. If an XA transaction does time out routinely because processing multiple messages exceeds the transaction timeout, reduce this property to 1 (to limit processing to one message per transaction) or increase your transaction timeout.



Related concepts
Message-driven beans - listener port components
Related tasks
Creating a new listener port
Configuring the message listener service
Tuning the application serving environment
Related reference
Message listener port collection
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 4:28:44 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-mp&topic=ListenerPort
File name: umb_prolp.html