public class

DefaultMessageListenerContainer102

extends DefaultMessageListenerContainer

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.DefaultMessageListenerContainer102

This class is deprecated.
as of Spring 3.0, in favor of the JMS 1.1 based DefaultMessageListenerContainer

Class Overview

A subclass of DefaultMessageListenerContainer for the JMS 1.0.2 specification, not relying on JMS 1.1 methods like SimpleMessageListenerContainer itself.

This class can be used for JMS 1.0.2 providers, offering the same facility as DefaultMessageListenerContainer does for JMS 1.1 providers.

Summary

[Expand]

Inherited Constants

From class org.springframework.jms.listener.DefaultMessageListenerContainer

From class org.springframework.jms.listener.AbstractPollingMessageListenerContainer

[Expand]

Inherited Fields

From class org.springframework.jms.listener.DefaultMessageListenerContainer

From class org.springframework.jms.listener.AbstractJmsListeningContainer

From class org.springframework.jms.support.JmsAccessor

Public Constructors
	DefaultMessageListenerContainer102()

Protected Methods
Connection	createConnection() This implementation overrides the superclass method to use JMS 1.0.2 API.
MessageConsumer	createConsumer(Session session, Destination destination) This implementation overrides the superclass method to use JMS 1.0.2 API.
Session	createSession(Connection con) This implementation overrides the superclass method to use JMS 1.0.2 API.
Connection	getConnection(JmsResourceHolder holder) This implementation overrides the superclass method to accept either a QueueConnection or a TopicConnection, depending on the domain.
Session	getSession(JmsResourceHolder holder) This implementation overrides the superclass method to accept either a QueueSession or a TopicSession, depending on the domain.
boolean	isClientAcknowledge(Session session) This implementation overrides the superclass method to avoid using JMS 1.1's Session `getAcknowledgeMode()` method.

[Expand]

Inherited Methods

From class org.springframework.jms.listener.DefaultMessageListenerContainer

TaskExecutor	createDefaultTaskExecutor() Create a default TaskExecutor.
void	doInitialize() Creates the specified number of concurrent consumers, in the form of a JMS Session plus associated MessageConsumer running in a separate thread.
void	doRescheduleTask(Object task) Re-executes the given task via this listener container's TaskExecutor.
void	doShutdown() Destroy the registered JMS Sessions and associated MessageConsumers.
void	establishSharedConnection() Overridden to accept a failure in the initial setup - leaving it up to the asynchronous invokers to establish the shared Connection on first access.
final int	getActiveConsumerCount() Return the number of currently active consumers.
int	getCacheLevel() Return the level of caching that this listener container is allowed to apply.
final int	getConcurrentConsumers() Return the "concurrentConsumer" setting.
final int	getIdleConsumerLimit() Return the limit for the number of idle consumers.
final int	getIdleTaskExecutionLimit() Return the limit for idle executions of a consumer task.
final int	getMaxConcurrentConsumers() Return the "maxConcurrentConsumer" setting.
final int	getMaxMessagesPerTask() Return the maximum number of messages to process in one task.
final int	getScheduledConsumerCount() Return the number of currently scheduled consumers.
void	handleListenerSetupFailure(Throwable ex, boolean alreadyRecovered) Handle the given exception that arose during setup of a listener.
void	initialize() Initialize this container.
boolean	isRegisteredWithDestination() Return whether at lease one consumer has entered a fixed registration with the target destination.
void	messageReceived(Object invoker, Session session) Tries scheduling a new invoker, since we know messages are coming in...
void	noMessageReceived(Object invoker, Session session) Marks the affected invoker as idle.
void	recoverAfterListenerSetupFailure() Recover this listener container after a listener failed to set itself up, for example reestablishing the underlying Connection.
void	refreshConnectionUntilSuccessful() Refresh the underlying Connection, not returning before an attempt has been successful.
void	refreshDestination() Refresh the JMS destination that this listener container operates on.
void	scheduleNewInvokerIfAppropriate() Schedule a new invoker, increasing the total number of scheduled invokers for this listener container, but only if the specified "maxConcurrentConsumers" limit has not been reached yet, and only if the specified "idleConsumerLimit" has not been reached either.
void	setCacheLevel(int cacheLevel) Specify the level of caching that this listener container is allowed to apply.
void	setCacheLevelName(String constantName) Specify the level of caching that this listener container is allowed to apply, in the form of the name of the corresponding constant: e.g.
void	setConcurrency(String concurrency) Specify concurrency limits via a "lower-upper" String, e.g.
void	setConcurrentConsumers(int concurrentConsumers) Specify the number of concurrent consumers to create.
void	setIdleConsumerLimit(int idleConsumerLimit) Specify the limit for the number of consumers that are allowed to be idle at any given time.
void	setIdleTaskExecutionLimit(int idleTaskExecutionLimit) Specify the limit for idle executions of a consumer task, not having received any message within its execution.
void	setMaxConcurrentConsumers(int maxConcurrentConsumers) Specify the maximum number of concurrent consumers to create.
void	setMaxMessagesPerTask(int maxMessagesPerTask) Specify the maximum number of messages to process in one task.
void	setRecoveryInterval(long recoveryInterval) Specify the interval between recovery attempts, in milliseconds.
void	setTaskExecutor(Executor taskExecutor) Set the Spring TaskExecutor to use for running the listener threads.
final boolean	sharedConnectionEnabled() Use a shared JMS Connection depending on the "cacheLevel" setting.
void	sleepInbetweenRecoveryAttempts() Sleep according to the specified recovery interval.
void	start() Overridden to reset the stop callback, if any.
void	startSharedConnection() This implementations proceeds even after an exception thrown from `Connection.start()`, relying on listeners to perform appropriate recovery.
void	stop(Runnable callback) Stop this listener container, invoking the specific callback once all listener processing has actually stopped.
void	stopSharedConnection() This implementations proceeds even after an exception thrown from `Connection.stop()`, relying on listeners to perform appropriate recovery after a restart.
void	validateConfiguration() Validate the configuration of this container.

From class org.springframework.jms.listener.AbstractPollingMessageListenerContainer

MessageConsumer	createConsumer(Session session, Destination destination) Create a JMS MessageConsumer for the given Session and Destination.
MessageConsumer	createListenerConsumer(Session session) Create a MessageConsumer for the given JMS Session, registering a MessageListener for the specified listener.
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.
Connection	getConnection(JmsResourceHolder holder) Fetch an appropriate Connection from the given JmsResourceHolder.
Session	getSession(JmsResourceHolder holder) Fetch an appropriate Session from the given JmsResourceHolder.
final PlatformTransactionManager	getTransactionManager() Return the Spring PlatformTransactionManager to use for transactional wrapping of message reception plus listener execution.
void	initialize() Initialize this container.
boolean	isPubSubNoLocal() Return whether to inhibit the delivery of messages published by its own connection.
boolean	isSessionLocallyTransacted(Session session) This implementation checks whether the Session is externally synchronized.
void	messageReceived(Object invoker, Session session) Template method that gets called right when a new message has been received, before attempting to process it.
void	noMessageReceived(Object invoker, Session session) Template method that gets called when no message has been received, before returning to the receive loop again.
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.
Message	receiveMessage(MessageConsumer consumer) Receive a message from the given consumer.
void	setPubSubNoLocal(boolean pubSubNoLocal) Set whether to inhibit the delivery of messages published by its own connection.
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 JMS Session.
void	setTransactionManager(PlatformTransactionManager transactionManager) Specify the Spring `PlatformTransactionManager` 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.
boolean	shouldCommitAfterNoMessageReceived(Session session) Determine whether to trigger a commit after no message has been received.

From class org.springframework.jms.listener.AbstractMessageListenerContainer

void	checkMessageListener(Object messageListener) Check the given message listener, throwing an exception if it does not correspond to a supported listener type.
void	commitIfNecessary(Session session, Message message) Perform a commit or message acknowledgement, as appropriate.
void	doExecuteListener(Session session, Message message) Execute the specified listener, committing or rolling back the transaction afterwards (if necessary).
void	doInvokeListener(SessionAwareMessageListener listener, Session session, Message message) Invoke the specified listener as Spring SessionAwareMessageListener, exposing a new JMS Session (potentially with its own transaction) to the listener if demanded.
void	doInvokeListener(MessageListener listener, Message message) Invoke the specified listener as standard JMS MessageListener.
void	executeListener(Session session, Message message) Execute the specified listener, committing or rolling back the transaction afterwards (if necessary).
String	getDefaultSubscriptionName(Object messageListener) Determine the default subscription name for the given message listener.
Destination	getDestination() Return the destination to receive messages from.
String	getDestinationDescription() Return a descriptive String for this container's JMS destination (never `null`).
String	getDestinationName() Return the name of the destination to receive messages from.
String	getDurableSubscriptionName() Return the name of a durable subscription to create, if any.
ExceptionListener	getExceptionListener() Return the JMS ExceptionListener to notify in case of a JMSException thrown by the registered message listener or the invocation infrastructure, if any.
Object	getMessageListener() Return the message listener object to register.
String	getMessageSelector() Return the JMS message selector expression (or `null` if none).
void	handleListenerException(Throwable ex) Handle the given exception that arose during listener execution.
void	invokeErrorHandler(Throwable ex) Invoke the registered ErrorHandler, if any.
void	invokeExceptionListener(JMSException ex) Invoke the registered JMS ExceptionListener, if any.
void	invokeListener(Session session, Message message) Invoke the specified listener: either as standard JMS MessageListener or (preferably) as Spring SessionAwareMessageListener.
boolean	isAcceptMessagesWhileStopping() Return whether to accept received messages while the listener container in the process of stopping.
boolean	isExposeListenerSession() Return whether to expose the listener JMS Session to a registered `SessionAwareMessageListener`.
boolean	isSessionLocallyTransacted(Session session) Check whether the given Session is locally transacted, that is, whether its transaction is managed by this listener container's Session handling and not by an external transaction coordinator.
boolean	isSubscriptionDurable() Return whether to make the subscription durable.
void	rollbackIfNecessary(Session session) Perform a rollback, if appropriate.
void	rollbackOnExceptionIfNecessary(Session session, Throwable ex) Perform a rollback, handling rollback exceptions properly.
void	setAcceptMessagesWhileStopping(boolean acceptMessagesWhileStopping) Set whether to accept received messages while the listener container in the process of stopping.
void	setDestination(Destination destination) Set the destination to receive messages from.
void	setDestinationName(String destinationName) Set the name of the destination to receive messages from.
void	setDurableSubscriptionName(String durableSubscriptionName) Set the name of a durable subscription to create.
void	setErrorHandler(ErrorHandler errorHandler) Set an ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.
void	setExceptionListener(ExceptionListener exceptionListener) Set the JMS ExceptionListener to notify in case of a JMSException thrown by the registered message listener or the invocation infrastructure.
void	setExposeListenerSession(boolean exposeListenerSession) Set whether to expose the listener JMS Session to a registered `SessionAwareMessageListener` as well as to `JmsTemplate` calls.
void	setMessageListener(Object messageListener) Set the message listener implementation to register.
void	setMessageSelector(String messageSelector) Set the JMS message selector expression (or `null` if none).
void	setSubscriptionDurable(boolean subscriptionDurable) Set whether to make the subscription durable.
void	validateConfiguration() Validate the configuration of this container.

From class org.springframework.jms.listener.AbstractJmsListeningContainer

void	afterPropertiesSet() Delegates to `validateConfiguration()` and `initialize()`.
Connection	createSharedConnection() Create a shared Connection for this container.
void	destroy() Calls `shutdown()` when the BeanFactory destroys the container instance.
abstract void	doInitialize() Register any invokers within this container.
void	doRescheduleTask(Object task) Reschedule the given task object immediately.
abstract void	doShutdown() Close the registered invokers.
void	doStart() Start the shared Connection, if any, and notify all invoker tasks.
void	doStop() Notify all invoker tasks and stop the shared Connection, if any.
void	establishSharedConnection() Establish a shared Connection for this container.
final String	getBeanName() Return the bean name that this listener container has been assigned in its containing bean factory, if any.
String	getClientId() Return the JMS client ID for the shared Connection created and used by this container, if any.
int	getPausedTaskCount() Determine the number of currently paused tasks, if any.
int	getPhase() Return the phase in which this container will be started and stopped.
final Connection	getSharedConnection() Return the shared JMS Connection maintained by this container.
void	initialize() Initialize this container.
final boolean	isActive() Return whether this container is currently active, that is, whether it has been set up but not shut down yet.
boolean	isAutoStartup() Return whether this Lifecycle component should be started automatically by the container when the ApplicationContext is refreshed.
final boolean	isRunning() Determine whether this container is currently running, that is, whether it has been started and not stopped yet.
void	logRejectedTask(Object task, RuntimeException ex) Log a task that has been rejected by `doRescheduleTask(Object)`.
void	prepareSharedConnection(Connection connection) Prepare the given Connection, which is about to be registered as shared Connection for this container.
final void	refreshSharedConnection() Refresh the shared Connection that this container holds.
final boolean	rescheduleTaskIfNecessary(Object task) Take the given task object and reschedule it, either immediately if this container is currently running, or later once this container has been restarted.
void	resumePausedTasks() Try to resume all paused tasks.
boolean	runningAllowed() Check whether this container's listeners are generally allowed to run.
void	setAutoStartup(boolean autoStartup) Set whether to automatically start the container after initialization.
void	setBeanName(String beanName) Set the name of the bean in the bean factory that created this bean.
void	setClientId(String clientId) Specify the JMS client id for a shared Connection created and used by this container.
void	setPhase(int phase) Specify the phase in which this container should be started and stopped.
abstract boolean	sharedConnectionEnabled() Return whether a shared JMS Connection should be maintained by this container base class.
void	shutdown() Stop the shared Connection, call `doShutdown()`, and close this container.
void	start() Start this container.
void	startSharedConnection() Start the shared Connection.
void	stop() Stop this container.
void	stop(Runnable callback) Indicates that a Lifecycle component must stop if it is currently running.
void	stopSharedConnection() Stop the shared Connection.
void	validateConfiguration() Validate the configuration of this container.

From class org.springframework.jms.support.destination.JmsDestinationAccessor

From class org.springframework.jms.support.JmsAccessor

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
JmsException	convertJmsAccessException(JMSException ex) Convert the specified checked javax.jms.JMSException JMSException to a Spring runtime `JmsException` equivalent.
Connection	createConnection() Create a JMS Connection via this template's ConnectionFactory.
Session	createSession(Connection con) Create a JMS Session for the given Connection.
ConnectionFactory	getConnectionFactory() Return the ConnectionFactory that this accessor uses for obtaining JMS Connection Connections.
int	getSessionAcknowledgeMode() Return the acknowledgement mode for JMS Session sessions.
boolean	isClientAcknowledge(Session session) Determine whether the given Session is in client acknowledge mode.
boolean	isSessionTransacted() Return whether the JMS Session sessions used by this accessor are supposed to be transacted.
void	setConnectionFactory(ConnectionFactory connectionFactory) Set the ConnectionFactory to use for obtaining JMS Connection Connections.
void	setSessionAcknowledgeMode(int sessionAcknowledgeMode) Set the JMS acknowledgement mode that is used when creating a JMS Session to send a message.
void	setSessionAcknowledgeModeName(String constantName) Set the JMS acknowledgement mode by the name of the corresponding constant in the JMS Session interface, e.g.
void	setSessionTransacted(boolean sessionTransacted) Set the transaction mode that is used when creating a JMS Session.

From class java.lang.Object

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.DisposableBean

From interface org.springframework.beans.factory.InitializingBean

From interface org.springframework.context.Lifecycle

From interface org.springframework.context.Phased

From interface org.springframework.context.SmartLifecycle

Public Constructors

public DefaultMessageListenerContainer102 ()

Protected Methods

protected Connection createConnection ()

This implementation overrides the superclass method to use JMS 1.0.2 API.

Returns

the new JMS Connection

Throws

JMSException

protected MessageConsumer createConsumer (Session session, Destination destination)

This implementation overrides the superclass method to use JMS 1.0.2 API.

Parameters

session	the JMS Session to create a MessageConsumer for
destination	the JMS Destination to create a MessageConsumer for

Returns

the new JMS MessageConsumer

Throws

JMSException

protected Session createSession (Connection con)

This implementation overrides the superclass method to use JMS 1.0.2 API.

Parameters

con	the JMS Connection to create a Session for

Returns

the new JMS Session

Throws

JMSException

protected Connection getConnection (JmsResourceHolder holder)

This implementation overrides the superclass method to accept either a QueueConnection or a TopicConnection, depending on the domain.

Parameters

holder	the JmsResourceHolder

Returns

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

protected Session getSession (JmsResourceHolder holder)

This implementation overrides the superclass method to accept either a QueueSession or a TopicSession, depending on the domain.

Parameters

holder	the JmsResourceHolder

Returns

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

protected boolean isClientAcknowledge (Session session)

This implementation overrides the superclass method to avoid using JMS 1.1's Session getAcknowledgeMode() method. The best we can do here is to check the setting on the listener container.

Parameters

session	the JMS Session to check

Returns

whether the given Session is in client acknowledge mode

Throws

JMSException

Interfaces

Classes

Exceptions

DefaultMessageListenerContainer102

Class Overview

Summary

Public Constructors

public DefaultMessageListenerContainer102 ()

Protected Methods

protected Connection createConnection ()

Returns

Throws

protected MessageConsumer createConsumer (Session session, Destination destination)

Parameters

Returns

Throws

protected Session createSession (Connection con)

Parameters

Returns

Throws

protected Connection getConnection (JmsResourceHolder holder)

Parameters

Returns

protected Session getSession (JmsResourceHolder holder)

Parameters

Returns

protected boolean isClientAcknowledge (Session session)

Parameters

Returns

Throws