com.atomikos.spring

Class BatchingMessageListenerContainer

java.lang.Object

org.springframework.jms.support.JmsAccessor

org.springframework.jms.support.destination.JmsDestinationAccessor

org.springframework.jms.listener.AbstractJmsListeningContainer

org.springframework.jms.listener.AbstractMessageListenerContainer

org.springframework.jms.listener.AbstractPollingMessageListenerContainer

org.springframework.jms.listener.DefaultMessageListenerContainer

com.atomikos.spring.BatchingMessageListenerContainer

All Implemented Interfaces:

com.atomikos.icatch.OrderedLifecycleComponent, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.jms.listener.MessageListenerContainer

public class BatchingMessageListenerContainer
extends org.springframework.jms.listener.DefaultMessageListenerContainer
implements com.atomikos.icatch.OrderedLifecycleComponent

LICENSED TO CUSTOMERS OF A COMMERCIAL SUBSCRIPTION ONLY! Specialized container for batching JMS messages for high performance. For maximum performance, make sure to set the "supportsTmJoin" flag to false on the connection factory as well as on any datasources you are using to process the messages. IMPORTANT: if you are using JPA or Hibernate in your MessageListener then make sure to configure the ORM so connections are released early (i.e. before transaction commit time). Otherwise your batch may run into blocks / locks / deadlocks in the DB.

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer

org.springframework.jms.listener.AbstractJmsListeningContainer.SharedConnectionNotInitializedException

Field Summary

Fields inherited from class org.springframework.jms.listener.DefaultMessageListenerContainer

CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, CACHE_SESSION, DEFAULT_RECOVERY_INTERVAL, DEFAULT_THREAD_NAME_PREFIX

Fields inherited from class org.springframework.jms.listener.AbstractPollingMessageListenerContainer

DEFAULT_RECEIVE_TIMEOUT

Fields inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer

lifecycleMonitor, sharedConnectionMonitor

Fields inherited from class org.springframework.jms.support.JmsAccessor

logger

Constructor Summary

Constructors

Constructor and Description
BatchingMessageListenerContainer()

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	doInvokeListener(javax.jms.MessageListener listener, javax.jms.Message message)
protected void	doInvokeListener(org.springframework.jms.listener.SessionAwareMessageListener listener, javax.jms.Session session, javax.jms.Message message)
int	getBatchSize()
protected int	getCurrentBatchSize()
void	init()
protected javax.jms.Message	receiveMessage(javax.jms.MessageConsumer consumer)
void	setBatchSize(int size) The (maximum) batch size that the batch can grow towards.
void	setConnectionFactory(javax.jms.ConnectionFactory connectionFactory)

Methods inherited from class org.springframework.jms.listener.DefaultMessageListenerContainer

applyBackOffTime, createDefaultTaskExecutor, doInitialize, doRescheduleTask, doShutdown, establishSharedConnection, getActiveConsumerCount, getCacheLevel, getConcurrentConsumers, getIdleConsumerLimit, getIdleTaskExecutionLimit, getMaxConcurrentConsumers, getMaxMessagesPerTask, getScheduledConsumerCount, handleListenerSetupFailure, initialize, isRecovering, isRegisteredWithDestination, messageReceived, noMessageReceived, recoverAfterListenerSetupFailure, refreshConnectionUntilSuccessful, refreshDestination, scheduleNewInvokerIfAppropriate, setBackOff, setCacheLevel, setCacheLevelName, setConcurrency, setConcurrentConsumers, setIdleConsumerLimit, setIdleTaskExecutionLimit, setMaxConcurrentConsumers, setMaxMessagesPerTask, setRecoveryInterval, setTaskExecutor, sharedConnectionEnabled, start, startSharedConnection, stop, stopSharedConnection

Methods inherited from class org.springframework.jms.listener.AbstractPollingMessageListenerContainer

createListenerConsumer, doReceiveAndExecute, getConnection, getSession, getTransactionManager, isSessionLocallyTransacted, receiveAndExecute, setReceiveTimeout, setSessionTransacted, setTransactionManager, setTransactionName, setTransactionTimeout, shouldCommitAfterNoMessageReceived

Methods inherited from class org.springframework.jms.listener.AbstractMessageListenerContainer

checkMessageListener, commitIfNecessary, createConsumer, doExecuteListener, executeListener, getDefaultSubscriptionName, getDestination, getDestinationDescription, getDestinationName, getDurableSubscriptionName, getErrorHandler, getExceptionListener, getMessageConverter, getMessageListener, getMessageSelector, getSubscriptionName, handleListenerException, invokeErrorHandler, invokeExceptionListener, invokeListener, isAcceptMessagesWhileStopping, isExposeListenerSession, isPubSubNoLocal, isSubscriptionDurable, isSubscriptionShared, rollbackIfNecessary, rollbackOnExceptionIfNecessary, setAcceptMessagesWhileStopping, setDestination, setDestinationName, setDurableSubscriptionName, setErrorHandler, setExceptionListener, setExposeListenerSession, setMessageConverter, setMessageListener, setMessageSelector, setPubSubNoLocal, setSubscriptionDurable, setSubscriptionName, setSubscriptionShared, setupMessageListener, validateConfiguration

Methods inherited from class org.springframework.jms.listener.AbstractJmsListeningContainer

afterPropertiesSet, createSharedConnection, destroy, doStart, doStop, getBeanName, getClientId, getPausedTaskCount, getPhase, getSharedConnection, isActive, isAutoStartup, isRunning, logRejectedTask, prepareSharedConnection, refreshSharedConnection, rescheduleTaskIfNecessary, resumePausedTasks, runningAllowed, setAutoStartup, setBeanName, setClientId, setPhase, shutdown, stop

Methods inherited from class org.springframework.jms.support.destination.JmsDestinationAccessor

getDestinationResolver, isPubSubDomain, resolveDestinationName, setDestinationResolver, setPubSubDomain

Methods inherited from class org.springframework.jms.support.JmsAccessor

convertJmsAccessException, createConnection, createSession, getConnectionFactory, getSessionAcknowledgeMode, isClientAcknowledge, isSessionTransacted, 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

isPubSubDomain

Methods inherited from interface org.springframework.context.SmartLifecycle

isAutoStartup

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, stop

Methods inherited from interface org.springframework.context.Phased

getPhase

Constructor Detail

BatchingMessageListenerContainer

public BatchingMessageListenerContainer()

Method Detail

setBatchSize

public void setBatchSize(int size)

The (maximum) batch size that the batch can grow towards. In case of exceptions, the batch size may not be reached immediately.

Parameters:

size - defaults to 50

getBatchSize

public int getBatchSize()

getCurrentBatchSize

protected int getCurrentBatchSize()

setConnectionFactory

public void setConnectionFactory(javax.jms.ConnectionFactory connectionFactory)

Overrides:

setConnectionFactory in class org.springframework.jms.support.JmsAccessor

receiveMessage

protected javax.jms.Message receiveMessage(javax.jms.MessageConsumer consumer)
                                    throws javax.jms.JMSException

Overrides:

receiveMessage in class org.springframework.jms.listener.AbstractPollingMessageListenerContainer

Throws:

javax.jms.JMSException

doInvokeListener

protected void doInvokeListener(org.springframework.jms.listener.SessionAwareMessageListener listener,
                                javax.jms.Session session,
                                javax.jms.Message message)
                         throws javax.jms.JMSException

Overrides:

doInvokeListener in class org.springframework.jms.listener.AbstractMessageListenerContainer

Throws:

javax.jms.JMSException

doInvokeListener

protected void doInvokeListener(javax.jms.MessageListener listener,
                                javax.jms.Message message)
                         throws javax.jms.JMSException

Overrides:

doInvokeListener in class org.springframework.jms.listener.AbstractMessageListenerContainer

Throws:

javax.jms.JMSException

init

public void init()
          throws Exception

Specified by:

init in interface com.atomikos.icatch.OrderedLifecycleComponent

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface com.atomikos.icatch.OrderedLifecycleComponent

Throws:

Exception