deprecated support for JMS 1.0.2 providers

Author: jhoeller

org.springframework.jms/src/main/java/org/springframework/jms/connection/CachingConnectionFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -201,7 +201,7 @@ public void resetConnection() {
 	 * Checks for a cached Session for the given mode.
 	 */
 	protected Session getSession(Connection con, Integer mode) throws JMSException {
-		LinkedList<Session> sessionList = null;
+		LinkedList<Session> sessionList;
 		synchronized (this.cachedSessions) {
 			sessionList = this.cachedSessions.get(mode);
 			if (sessionList == null) {
@@ -429,7 +429,7 @@ private void physicalClose() throws JMSException {
 
 	/**
 	 * Simple wrapper class around a Destination and other consumer attributes.
-	 * Used as the key when caching consumers.
+	 * Used as the cache key when caching MessageConsumer objects.
 	 */
 	private static class ConsumerCacheKey {
 

org.springframework.jms/src/main/java/org/springframework/jms/connection/JmsTransactionManager.java

@@ -40,10 +40,6 @@
  * Connection/Session pair from the specified ConnectionFactory to the thread,
  * potentially allowing for one thread-bound Session per ConnectionFactory.
  *
- * <p><b>NOTE:</b> This class requires a JMS 1.1+ provider because it builds on
- * the domain-independent API. <b>Use the {@link JmsTransactionManager102} subclass
- * for a JMS 1.0.2 provider, e.g. when running on a J2EE 1.3 server.</b>
- *
  * <p>This local strategy is an alternative to executing JMS operations within
  * JTA transactions. Its advantage is that it is able to work in any environment,
  * for example a standalone application or a test suite, with any message broker

org.springframework.jms/src/main/java/org/springframework/jms/connection/JmsTransactionManager102.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2007 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,7 +39,9 @@
  * @since 1.1
  * @see #setConnectionFactory
  * @see #setPubSubDomain
+ * @deprecated as of Spring 3.0, in favor of the JMS 1.1 based {@link JmsTransactionManager}
  */
+@Deprecated
 public class JmsTransactionManager102 extends JmsTransactionManager {
 
 	private boolean pubSubDomain = false;

org.springframework.jms/src/main/java/org/springframework/jms/connection/SingleConnectionFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,6 @@
 import java.lang.reflect.Proxy;
 import java.util.ArrayList;
 import java.util.List;
-
 import javax.jms.Connection;
 import javax.jms.ConnectionFactory;
 import javax.jms.ExceptionListener;
@@ -49,8 +48,7 @@
  *
  * <p>You can either pass in a specific JMS Connection directly or let this
  * factory lazily create a Connection via a given target ConnectionFactory.
- * This factory generally works with JMS 1.1 as well as JMS 1.0.2; use
- * {@link SingleConnectionFactory102} for strict JMS 1.0.2 only usage.
+ * This factory generally works with JMS 1.1 as well as the JMS 1.0.2 API.
  *
  * <p>Note that when using the JMS 1.0.2 API, this ConnectionFactory will switch
  * into queue/topic mode according to the JMS API methods used at runtime:

org.springframework.jms/src/main/java/org/springframework/jms/connection/SingleConnectionFactory102.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2007 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,7 +36,9 @@
  * @since 1.1
  * @see #setTargetConnectionFactory
  * @see #setPubSubDomain
+ * @deprecated as of Spring 3.0, in favor of the JMS 1.1 based {@link SingleConnectionFactory}
  */
+@Deprecated
 public class SingleConnectionFactory102 extends SingleConnectionFactory {
 
 	private boolean pubSubDomain = false;

org.springframework.jms/src/main/java/org/springframework/jms/core/JmsTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,14 +41,10 @@
 /**
  * Helper class that simplifies synchronous JMS access code.
  *
- * <p><b>NOTE:</b> This class requires a JMS 1.1+ provider because it builds
- * on the domain-independent API. <b>Use the {@link JmsTemplate102} subclass
- * for a JMS 1.0.2 provider, e.g. when running on a J2EE 1.3 server.</b>
- *
  * <p>If you want to use dynamic destination creation, you must specify
  * the type of JMS destination to create, using the "pubSubDomain" property.
  * For other operations, this is not necessary, in contrast to when working
- * with JmsTemplate102. Point-to-Point (Queues) is the default domain.
+ * with {@link JmsTemplate102}. Point-to-Point (Queues) is the default domain.
  *
  * <p>Default settings for JMS Sessions are "not transacted" and "auto-acknowledge".
  * As defined by the J2EE specification, the transaction and acknowledgement
@@ -83,7 +79,6 @@
  * @see #setPubSubDomain
  * @see #setDestinationResolver
  * @see #setMessageConverter
- * @see JmsTemplate102
  * @see javax.jms.MessageProducer
  * @see javax.jms.MessageConsumer
  */
@@ -536,7 +531,7 @@ public void send(MessageCreator messageCreator) throws JmsException {
 	}
 
 	public void send(final Destination destination, final MessageCreator messageCreator) throws JmsException {
-		execute(new SessionCallback() {
+		execute(new SessionCallback<Object>() {
 			public Object doInJms(Session session) throws JMSException {
 				doSend(session, destination, messageCreator);
 				return null;
@@ -545,7 +540,7 @@ public Object doInJms(Session session) throws JMSException {
 	}
 
 	public void send(final String destinationName, final MessageCreator messageCreator) throws JmsException {
-		execute(new SessionCallback() {
+		execute(new SessionCallback<Object>() {
 			public Object doInJms(Session session) throws JMSException {
 				Destination destination = resolveDestinationName(session, destinationName);
 				doSend(session, destination, messageCreator);
@@ -697,16 +692,16 @@ public Message receiveSelected(String messageSelector) throws JmsException {
 	}
 
 	public Message receiveSelected(final Destination destination, final String messageSelector) throws JmsException {
-		return (Message) execute(new SessionCallback() {
-			public Object doInJms(Session session) throws JMSException {
+		return execute(new SessionCallback<Message>() {
+			public Message doInJms(Session session) throws JMSException {
 				return doReceive(session, destination, messageSelector);
 			}
 		}, true);
 	}
 
 	public Message receiveSelected(final String destinationName, final String messageSelector) throws JmsException {
-		return (Message) execute(new SessionCallback() {
-			public Object doInJms(Session session) throws JMSException {
+		return execute(new SessionCallback<Message>() {
+			public Message doInJms(Session session) throws JMSException {
 				Destination destination = resolveDestinationName(session, destinationName);
 				return doReceive(session, destination, messageSelector);
 			}
@@ -730,7 +725,7 @@ protected Message doReceive(Session session, Destination destination, String mes
 	/**
 	 * Actually receive a JMS message.
 	 * @param session the JMS Session to operate on
-	 * @param consumer the JMS MessageConsumer to send with
+	 * @param consumer the JMS MessageConsumer to receive with
 	 * @return the JMS Message received, or <code>null</code> if none
 	 * @throws JMSException if thrown by JMS API methods
 	 */
@@ -743,18 +738,7 @@ protected Message doReceive(Session session, MessageConsumer consumer) throws JM
 			if (resourceHolder != null && resourceHolder.hasTimeout()) {
 				timeout = resourceHolder.getTimeToLiveInMillis();
 			}
-			
-			Message message = null;
-			if (timeout == RECEIVE_TIMEOUT_NO_WAIT) {
-				message = consumer.receiveNoWait();
-			}
-			else if (timeout > 0) {
-				message = consumer.receive(timeout);
-			}
-			else {
-				message = consumer.receive();
-			}
-
+			Message message = doReceive(consumer, timeout);
 			if (session.getTransacted()) {
 				// Commit necessary - but avoid commit call within a JTA transaction.
 				if (isSessionLocallyTransacted(session)) {
@@ -775,6 +759,25 @@ else if (isClientAcknowledge(session)) {
 		}
 	}
 
+	/**
+	 * Actually receive a message from the given consumer.
+	 * @param consumer the JMS MessageConsumer to receive with
+	 * @param timeout the receive timeout
+	 * @return the JMS Message received, or <code>null</code> if none
+	 * @throws JMSException if thrown by JMS API methods
+	 */
+	private Message doReceive(MessageConsumer consumer, long timeout) throws JMSException {
+		if (timeout == RECEIVE_TIMEOUT_NO_WAIT) {
+			return consumer.receiveNoWait();
+		}
+		else if (timeout > 0) {
+			return consumer.receive(timeout);
+		}
+		else {
+			return consumer.receive();
+		}
+	}
+
 
 	//-------------------------------------------------------------------------
 	// Convenience methods for receiving auto-converted messages

org.springframework.jms/src/main/java/org/springframework/jms/core/JmsTemplate102.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -73,7 +73,9 @@
  * @see javax.jms.TopicPublisher
  * @see javax.jms.QueueReceiver
  * @see javax.jms.TopicSubscriber
+ * @deprecated as of Spring 3.0, in favor of the JMS 1.1 based {@link JmsTemplate}
  */
+@Deprecated
 public class JmsTemplate102 extends JmsTemplate {
 
 	/**

org.springframework.jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java

@@ -1,12 +1,12 @@
 /*
- * Copyright 2002-2005 the original author or authors.
- * 
+ * Copyright 2002-2009 the original author or authors.
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,8 +31,8 @@
  * <p>Requires a ConnectionFactory or a JmsTemplate instance to be set.
  * It will create its own JmsTemplate if a ConnectionFactory is passed in.
  * A custom JmsTemplate instance can be created for a given ConnectionFactory
- * through overriding the <code>createJmsTemplate</code> method.
- * 
+ * through overriding the {@link #createJmsTemplate} method.
+ *
  * @author Mark Pollack
  * @since 1.1.1
  * @see #setConnectionFactory
@@ -42,6 +42,7 @@
  */
 public abstract class JmsGatewaySupport implements InitializingBean {
 
+	/** Logger available to subclasses */
 	protected final Log logger = LogFactory.getLog(getClass());
 
 	private JmsTemplate jmsTemplate;
@@ -92,12 +93,12 @@ public final void setJmsTemplate(JmsTemplate jmsTemplate) {
 	 * Return the JmsTemplate for the gateway.
 	 */
 	public final JmsTemplate getJmsTemplate() {
-		return jmsTemplate;
+		return this.jmsTemplate;
 	}
 
 	public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
 		if (this.jmsTemplate == null) {
-			throw new IllegalArgumentException("connectionFactory or jmsTemplate is required");
+			throw new IllegalArgumentException("'connectionFactory' or 'jmsTemplate' is required");
 		}
 		try {
 			initGateway();

org.springframework.jms/src/main/java/org/springframework/jms/core/support/package.html

@@ -1,7 +1,7 @@
 <html>
 <body>
 
-Classes supporting the org.springframework.jms.core package.
+Classes supporting the <code>org.springframework.jms.core</code> package.
 Contains a base class for JmsTemplate usage.
 
 </body>

org.springframework.jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java

@@ -43,10 +43,6 @@
  * Designed to work in a native JMS environment as well as in a J2EE environment,
  * with only minimal differences in configuration.
  *
- * <p><b>NOTE:</b> This class requires a JMS 1.1+ provider, because it builds on
- * the domain-independent API. <b>Use the {@link DefaultMessageListenerContainer102}
- * subclass for a JMS 1.0.2 provider, e.g. when running on a J2EE 1.3 server.</b>
- *
  * <p>This is a simple but nevertheless powerful form of message listener container.
  * On startup, it obtains a fixed number of JMS Sessions to invoke the listener,
  * and optionally allows for dynamic adaptation at runtime (up until a maximum number).