Class AbstractPollingMessageListenerContainer
- All Implemented Interfaces:
Aware
,BeanNameAware
,DisposableBean
,InitializingBean
,Lifecycle
,Phased
,SmartLifecycle
,MessageListenerContainer
- Direct Known Subclasses:
DefaultMessageListenerContainer
MessageConsumer
,
optionally participating in externally managed transactions.
This listener container variant is built for repeated polling attempts,
each invoking the receiveAndExecute(java.lang.Object, jakarta.jms.Session, jakarta.jms.MessageConsumer)
method. The MessageConsumer used
may be reobtained fo reach attempt or cached in between attempts; this is up
to the concrete implementation. The receive timeout for each attempt can be
configured through the "receiveTimeout"
property.
The underlying mechanism is based on standard JMS MessageConsumer handling,
which is perfectly compatible with both native JMS and JMS in a Jakarta EE environment.
Neither the JMS MessageConsumer.setMessageListener
facility nor the JMS
ServerSessionPool facility is required. A further advantage of this approach is
full control over the listening process, allowing for custom scaling and throttling
and of concurrent message processing (which is up to concrete subclasses).
Message reception and listener execution can automatically be wrapped
in transactions through passing a Spring
PlatformTransactionManager
into the
"transactionManager"
property. This will usually
be a JtaTransactionManager
in a
Jakarta EE environment, in combination with a JTA-aware JMS ConnectionFactory
obtained from JNDI (check your application server's documentation).
This base class does not assume any specific mechanism for asynchronous
execution of polling invokers. Check out DefaultMessageListenerContainer
for a concrete implementation which is based on Spring's
TaskExecutor
abstraction,
including dynamic scaling of concurrent consumers and automatic self recovery.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer
AbstractJmsListeningContainer.SharedConnectionNotInitializedException
-
Field Summary
Modifier and TypeFieldDescriptionstatic final long
The default receive timeout: 1000 ms = 1 second.Fields inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer
lifecycleCondition, lifecycleLock, sharedConnectionLock
Fields inherited from class org.springframework.jms.support.destination.JmsDestinationAccessor
RECEIVE_TIMEOUT_INDEFINITE_WAIT, RECEIVE_TIMEOUT_NO_WAIT
Fields inherited from class org.springframework.jms.support.JmsAccessor
logger
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected MessageConsumer
createListenerConsumer
(Session session) Create a MessageConsumer for the given JMS Session, registering a MessageListener for the specified listener.protected boolean
doReceiveAndExecute
(Object invoker, Session session, MessageConsumer consumer, TransactionStatus status) Actually execute the listener for a message received from the given consumer, fetching all requires resources and invoking the listener.protected Connection
getConnection
(JmsResourceHolder holder) Fetch an appropriate Connection from the given JmsResourceHolder.protected long
Return the receive timeout (ms) configured for this listener container.protected Session
getSession
(JmsResourceHolder holder) Fetch an appropriate Session from the given JmsResourceHolder.protected final PlatformTransactionManager
Return the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution.void
Initialize this container.protected boolean
isSessionLocallyTransacted
(Session session) This implementation checks whether the Session is externally synchronized.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.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.protected boolean
receiveAndExecute
(Object invoker, Session session, MessageConsumer consumer) Execute the listener for a message received from the given consumer, wrapping the entire operation in an external transaction if demanded.protected Message
receiveMessage
(MessageConsumer consumer) Receive a message from the given consumer.void
setReceiveTimeout
(long receiveTimeout) Set the timeout to use for receive calls, in milliseconds.void
setSessionTransacted
(boolean sessionTransacted) Set the transaction mode that is used when creating a JMSSession
.void
setTransactionManager
(PlatformTransactionManager transactionManager) Specify the SpringPlatformTransactionManager
to use for transactional wrapping of message reception plus listener execution.void
setTransactionName
(String transactionName) Specify the transaction name to use for transactional wrapping.void
setTransactionTimeout
(int transactionTimeout) Specify the transaction timeout to use for transactional wrapping, in seconds.protected boolean
Determine whether to trigger a commit after no message has been received.Methods inherited from class org.springframework.jms.listener.AbstractMessageListenerContainer
checkMessageListener, commitIfNecessary, createConsumer, createObservation, doExecuteListener, doInvokeListener, doInvokeListener, executeListener, getDefaultSubscriptionName, getDestination, getDestinationDescription, getDestinationName, getDurableSubscriptionName, getErrorHandler, getExceptionListener, getMessageConverter, getMessageListener, getMessageSelector, getObservationRegistry, getReplyQosSettings, getSubscriptionName, handleListenerException, invokeErrorHandler, invokeExceptionListener, invokeListener, isAcceptMessagesWhileStopping, isExposeListenerSession, isPubSubNoLocal, isReplyPubSubDomain, isSubscriptionDurable, isSubscriptionShared, rollbackIfNecessary, rollbackOnExceptionIfNecessary, setAcceptMessagesWhileStopping, setConcurrency, setDestination, setDestinationName, setDurableSubscriptionName, setErrorHandler, setExceptionListener, setExposeListenerSession, setMessageConverter, setMessageListener, setMessageSelector, setObservationRegistry, setPubSubNoLocal, setReplyPubSubDomain, setReplyQosSettings, setSubscriptionDurable, setSubscriptionName, setSubscriptionShared, setupMessageListener, validateConfiguration
Methods inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer
afterPropertiesSet, createSharedConnection, destroy, doInitialize, doRescheduleTask, doShutdown, doStart, doStop, establishSharedConnection, getBeanName, getClientId, getPausedTaskCount, getPhase, getSharedConnection, isActive, isAutoStartup, isRunning, logRejectedTask, prepareSharedConnection, refreshSharedConnection, releaseSharedConnection, rescheduleTaskIfNecessary, resumePausedTasks, runningAllowed, setAutoStartup, setBeanName, setClientId, setPhase, sharedConnectionEnabled, shutdown, start, startSharedConnection, stop, stopSharedConnection
Methods inherited from class org.springframework.jms.support.destination.JmsDestinationAccessor
getDestinationResolver, isPubSubDomain, receiveFromConsumer, resolveDestinationName, setDestinationResolver, setPubSubDomain
Methods inherited from class org.springframework.jms.support.JmsAccessor
convertJmsAccessException, createConnection, createSession, getConnectionFactory, getSessionAcknowledgeMode, isClientAcknowledge, isSessionTransacted, obtainConnectionFactory, setConnectionFactory, setSessionAcknowledgeMode, setSessionAcknowledgeModeName
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.jms.listener.MessageListenerContainer
getDestinationResolver, isPubSubDomain
Methods inherited from interface org.springframework.context.SmartLifecycle
getPhase, isAutoStartup, stop
-
Field Details
-
DEFAULT_RECEIVE_TIMEOUT
public static final long DEFAULT_RECEIVE_TIMEOUTThe default receive timeout: 1000 ms = 1 second.- See Also:
-
-
Constructor Details
-
AbstractPollingMessageListenerContainer
public AbstractPollingMessageListenerContainer()
-
-
Method Details
-
setSessionTransacted
public void setSessionTransacted(boolean sessionTransacted) Description copied from class:JmsAccessor
Set the transaction mode that is used when creating a JMSSession
. 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 Jakarta 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 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 classJmsAccessor
- See Also:
-
setTransactionManager
Specify the SpringPlatformTransactionManager
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 aSessionAwareMessageListener
(for example, sending a response message). This allows for fully synchronized Spring transactions based on local JMS transactions, similar to whatJmsTransactionManager
provides. CheckAbstractMessageListenerContainer
's javadoc for a discussion of transaction choices and message redelivery scenarios. -
getTransactionManager
Return the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution. -
setTransactionName
Specify the transaction name to use for transactional wrapping. Default is the bean name of this listener container, if any.- See Also:
-
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. -
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.
-
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 callsAbstractJmsListeningContainer.doInitialize()
.- Overrides:
initialize
in classAbstractJmsListeningContainer
-
createListenerConsumer
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
protected boolean receiveAndExecute(Object invoker, @Nullable Session session, @Nullable 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 onconsumer
- the MessageConsumer to work on- Returns:
- whether a message has been received
- Throws:
JMSException
- if thrown by JMS methods- See Also:
-
doReceiveAndExecute
protected boolean doReceiveAndExecute(Object invoker, @Nullable Session session, @Nullable MessageConsumer consumer, @Nullable 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 onconsumer
- the MessageConsumer to work onstatus
- the TransactionStatus (may benull
)- Returns:
- whether a message has been received
- Throws:
JMSException
- if thrown by JMS methods- See Also:
-
isSessionLocallyTransacted
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 classAbstractMessageListenerContainer
- Parameters:
session
- the Session to check- Returns:
- whether the given Session is locally transacted
- See Also:
-
shouldCommitAfterNoMessageReceived
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(jakarta.jms.Session, jakarta.jms.Message)
on the given Session
-
receiveMessage
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
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
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
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
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
-