org.springframework.jms.listener

Class IkasanMessageListenerContainer

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

org.springframework.jms.listener.IkasanMessageListenerContainer

All Implemented Interfaces:

MessageProvider, IsExclusionServiceAware, Configured<SpringMessageConsumerConfiguration>, 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 IkasanMessageListenerContainer
extends org.springframework.jms.listener.DefaultMessageListenerContainer
implements MessageProvider, Configured<SpringMessageConsumerConfiguration>, IsExclusionServiceAware

Extend DefaultMessageListenerContainer to ensure standard defaults are set on the container being instantiated.

Author:

Ikasan Development Team

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
IkasanMessageListenerContainer() Constructor with preferred defaults.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Stop Spring from failing on deployment if we dont have an initial configuration - that's ok.
boolean	append(IkasanListMessage listMessage, javax.jms.Message message) Consumer messages until no more or batch limit is reached.
SpringMessageConsumerConfiguration	getConfiguration()
protected javax.jms.Message	receiveMessage(javax.jms.MessageConsumer consumer) Build up a faux JMS message containing multiple instances of JMS messages consumed from the destination.
void	recoverSharedConnection() Attempt to recover a shared connection, if its used
void	setConfiguration(SpringMessageConsumerConfiguration configuration)
void	setExclusionService(ExclusionService exclusionService)
void	start()

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, startSharedConnection, stop, stopSharedConnection

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

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

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

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

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

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, 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.ikasan.component.endpoint.jms.consumer.MessageProvider

isRunning, stop

Methods inherited from interface org.springframework.jms.listener.MessageListenerContainer

getDestinationResolver, 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

IkasanMessageListenerContainer

public IkasanMessageListenerContainer()

Constructor with preferred defaults.

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Stop Spring from failing on deployment if we dont have an initial configuration - that's ok.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class org.springframework.jms.listener.AbstractJmsListeningContainer

getConfiguration

public SpringMessageConsumerConfiguration getConfiguration()

Specified by:

getConfiguration in interface Configured<SpringMessageConsumerConfiguration>

setConfiguration

public void setConfiguration(SpringMessageConsumerConfiguration configuration)

Specified by:

setConfiguration in interface Configured<SpringMessageConsumerConfiguration>

start

public void start()

Specified by:

start in interface MessageProvider

Specified by:

start in interface org.springframework.context.Lifecycle

Overrides:

start in class org.springframework.jms.listener.DefaultMessageListenerContainer

recoverSharedConnection

public void recoverSharedConnection()
                             throws javax.jms.JMSException

Attempt to recover a shared connection, if its used

Throws:

javax.jms.JMSException - if the underlying provider cannot re-establish itself

See Also:

AbstractJmsListeningContainer.refreshSharedConnection()

receiveMessage

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

Build up a faux JMS message containing multiple instances of JMS messages consumed from the destination.

Overrides:

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

Parameters:

consumer -

Returns:

Throws:

javax.jms.JMSException

append

public boolean append(IkasanListMessage listMessage,
             javax.jms.Message message)

Consumer messages until no more or batch limit is reached.

Parameters:

listMessage -

message -

Returns:

setExclusionService

public void setExclusionService(ExclusionService exclusionService)

Specified by:

setExclusionService in interface IsExclusionServiceAware