Class AbstractPollingMessageListenerContainer

Field Detail

• DEFAULT_RECEIVE_TIMEOUT

  public static final long DEFAULT_RECEIVE_TIMEOUT

  The default receive timeout: 1000 ms = 1 second.

  See Also:

  Constant Field Values

Constructor Detail

• AbstractPollingMessageListenerContainer

  public AbstractPollingMessageListenerContainer()

Method Detail

• setSessionTransacted

  public void setSessionTransacted​(boolean sessionTransacted)

  Description copied from class: JmsAccessor
  Set the transaction mode that is used when creating a JMS Session. Default is "false".

  Note that within a JTA transaction, the parameters passed to create(Queue/Topic)Session(boolean transacted, int acknowledgeMode) method are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since the accessor operates on an existing JMS Session in this case.

  Setting this flag to "true" will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction.

  Overrides:

  setSessionTransacted in class JmsAccessor

  See Also:

  Connection.createSession(boolean, int)

• setTransactionManager

  public void setTransactionManager​(PlatformTransactionManager transactionManager)

  Specify the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution.

  Default is none, not performing any transactional wrapping. If specified, this will usually be a Spring JtaTransactionManager or one of its subclasses, in combination with a JTA-aware ConnectionFactory that this message listener container obtains its Connections from.

  Note: Consider the use of local JMS transactions instead. Simply switch the "sessionTransacted" flag to "true" in order to use a locally transacted JMS Session for the entire receive processing, including any Session operations performed by a SessionAwareMessageListener (e.g. sending a response message). This allows for fully synchronized Spring transactions based on local JMS transactions, similar to what JmsTransactionManager provides. Check AbstractMessageListenerContainer's javadoc for a discussion of transaction choices and message redelivery scenarios.

  See Also:

  setSessionTransacted(boolean), JtaTransactionManager, JmsTransactionManager

• getTransactionManager

  protected final PlatformTransactionManager getTransactionManager()

  Return the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution.

• setTransactionName

  public void setTransactionName​(String transactionName)

  Specify the transaction name to use for transactional wrapping. Default is the bean name of this listener container, if any.

  See Also:

  TransactionDefinition.getName()

• setTransactionTimeout

  public void setTransactionTimeout​(int transactionTimeout)

  Specify the transaction timeout to use for transactional wrapping, in seconds. Default is none, using the transaction manager's default timeout.

  See Also:

  TransactionDefinition.getTimeout(), setReceiveTimeout(long)

• setReceiveTimeout

  public void setReceiveTimeout​(long receiveTimeout)

  Set the timeout to use for receive calls, in milliseconds. The default is 1000 ms, that is, 1 second.

  NOTE: This value needs to be smaller than the transaction timeout used by the transaction manager (in the appropriate unit, of course). 0 indicates no timeout at all; however, this is only feasible if not running within a transaction manager and generally discouraged since such a listener container cannot cleanly shut down. A negative value such as -1 indicates a no-wait receive operation.

  See Also:

  JmsDestinationAccessor.receiveFromConsumer(MessageConsumer, long), MessageConsumer.receive(long), MessageConsumer.receiveNoWait(), MessageConsumer.receive(), setTransactionTimeout(int)

• getReceiveTimeout

  protected long getReceiveTimeout()

  Return the receive timeout (ms) configured for this listener container.

  Since:

  4.2

• initialize

  public void initialize()

  Description copied from class: AbstractJmsListeningContainer
  Initialize this container.

  Creates a JMS Connection, starts the Connection (if "autoStartup" hasn't been turned off), and calls AbstractJmsListeningContainer.doInitialize().

  Overrides:

  initialize in class AbstractJmsListeningContainer

• createListenerConsumer

  protected MessageConsumer createListenerConsumer​(Session session)
                                            throws JMSException

  Create a MessageConsumer for the given JMS Session, registering a MessageListener for the specified listener.

  Parameters:

  session - the JMS Session to work on

  Returns:

  the MessageConsumer

  Throws:

  JMSException - if thrown by JMS methods

  See Also:

  receiveAndExecute(java.lang.Object, javax.jms.Session, javax.jms.MessageConsumer)

• receiveAndExecute

  protected boolean receiveAndExecute​(Object invoker,
                                      Session session,
                                      MessageConsumer consumer)
                               throws JMSException

  Execute the listener for a message received from the given consumer, wrapping the entire operation in an external transaction if demanded.

  Parameters:

  session - the JMS Session to work on

  consumer - the MessageConsumer to work on

  Returns:

  whether a message has been received

  Throws:

  JMSException - if thrown by JMS methods

  See Also:

  doReceiveAndExecute(java.lang.Object, javax.jms.Session, javax.jms.MessageConsumer, org.springframework.transaction.TransactionStatus)

• doReceiveAndExecute

  protected boolean doReceiveAndExecute​(Object invoker,
                                        Session session,
                                        MessageConsumer consumer,
                                        TransactionStatus status)
                                 throws JMSException

  Actually execute the listener for a message received from the given consumer, fetching all requires resources and invoking the listener.

  Parameters:

  session - the JMS Session to work on

  consumer - the MessageConsumer to work on

  status - the TransactionStatus (may be null)

  Returns:

  whether a message has been received

  Throws:

  JMSException - if thrown by JMS methods

  See Also:

  AbstractMessageListenerContainer.doExecuteListener(javax.jms.Session, javax.jms.Message)

• isSessionLocallyTransacted

  protected boolean isSessionLocallyTransacted​(Session session)

  This implementation checks whether the Session is externally synchronized. In this case, the Session is not locally transacted, despite the listener container's "sessionTransacted" flag being set to "true".

  Overrides:

  isSessionLocallyTransacted in class AbstractMessageListenerContainer

  Parameters:

  session - the Session to check

  Returns:

  whether the given Session is locally transacted

  See Also:

  JmsResourceHolder

• shouldCommitAfterNoMessageReceived

  protected boolean shouldCommitAfterNoMessageReceived​(Session session)

  Determine whether to trigger a commit after no message has been received. This is a good idea on any modern-day JMS provider.

  Parameters:

  session - the current JMS Session which received no message

  Returns:

  whether to call AbstractMessageListenerContainer.commitIfNecessary(javax.jms.Session, javax.jms.Message) on the given Session

• receiveMessage

  protected Message receiveMessage​(MessageConsumer consumer)
                            throws JMSException

  Receive a message from the given consumer.

  Parameters:

  consumer - the MessageConsumer to use

  Returns:

  the Message, or null if none

  Throws:

  JMSException - if thrown by JMS methods

• messageReceived

  protected void messageReceived​(Object invoker,
                                 Session session)

  Template method that gets called right when a new message has been received, before attempting to process it. Allows subclasses to react to the event of an actual incoming message, for example adapting their consumer count.

  Parameters:

  invoker - the invoker object (passed through)

  session - the receiving JMS Session

• noMessageReceived

  protected void noMessageReceived​(Object invoker,
                                   Session session)

  Template method that gets called when no message has been received, before returning to the receive loop again. Allows subclasses to react to the event of no incoming message, for example marking the invoker as idle.

  Parameters:

  invoker - the invoker object (passed through)

  session - the receiving JMS Session

• getConnection

  protected Connection getConnection​(JmsResourceHolder holder)

  Fetch an appropriate Connection from the given JmsResourceHolder.

  This implementation accepts any JMS 1.1 Connection.

  Parameters:

  holder - the JmsResourceHolder

  Returns:

  an appropriate Connection fetched from the holder, or null if none found

• getSession

  protected Session getSession​(JmsResourceHolder holder)

  Fetch an appropriate Session from the given JmsResourceHolder.

  This implementation accepts any JMS 1.1 Session.

  Parameters:

  holder - the JmsResourceHolder

  Returns:

  an appropriate Session fetched from the holder, or null if none found