From 5fbfcb0795ad20e6831164d9d8d826e51faf50a3 Mon Sep 17 00:00:00 2001
From: markpollack <mark.pollack@springsource.com>
Date: Wed, 16 Jul 2008 18:15:40 +0000
Subject: [PATCH] simple code cleanup

---
 .../Nms/Connections/NmsResourceHolder.cs      | 22 ++++++-------------
 .../AbstractMessageListenerContainer.cs       | 16 ++++++++++++++
 .../SimpleMessageListenerContainer.cs         |  7 ++++++
 .../Messaging/Nms/NmsTemplate.cs              |  4 ++--
 .../Destinations/NmsDestinationAccessor.cs    |  7 ++++++
 5 files changed, 39 insertions(+), 17 deletions(-)

diff --git a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Connections/NmsResourceHolder.cs b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Connections/NmsResourceHolder.cs
index 868f6305..adb83d62 100644
--- a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Connections/NmsResourceHolder.cs
+++ b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Connections/NmsResourceHolder.cs
@@ -164,28 +164,20 @@ namespace Spring.Messaging.Nms.IConnections
             //return (ISession)CollectionUtils.FindValueOfType(sessions, sessionType);
         }
 
+        /// <summary>
+        /// Commits all sessions.
+        /// </summary>
         public virtual void CommitAll()
         {
             foreach (ISession session in sessions)
             {
 				session.Commit();
-				
-				// TODO are these exceptions valid?
-//                try
-//                {
-//                    session.Commit();
-//                }
-//                catch (TransactionInProgressException ex)
-//                {
-//                    // Ignore -> can only happen in case of a distributed transaction.
-//                }
-//                catch (IllegalStateException ex)
-//                {
-//                    // Ignore -> can only happen in case of a distributed transaction.
-//                }
             }
         }
-        
+
+        /// <summary>
+        /// Closes all sessions then stops and closes all connections, in that order.
+        /// </summary>
         public virtual void CloseAll()
         {
             foreach (ISession session in sessions)
diff --git a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/AbstractMessageListenerContainer.cs b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/AbstractMessageListenerContainer.cs
index 37a539f1..238372e4 100644
--- a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/AbstractMessageListenerContainer.cs
+++ b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/AbstractMessageListenerContainer.cs
@@ -372,11 +372,27 @@ namespace Spring.Messaging.Nms.Listener
             }
         }
 
+        /// <summary>
+        /// Invoke the specified listener as standard JMS MessageListener.
+        /// </summary>
+        /// <remarks>Default implementation performs a plain invocation of the
+        /// <code>OnMessage</code> methods</remarks>
+        /// <param name="listener">The listener to invoke.</param>
+        /// <param name="message">The received message.</param>
+        /// <exception cref="NMSException">if thronw by the underlying NMS APIs</exception>
         protected virtual void DoInvokeListener(IMessageListener listener, IMessage message)
         {
             listener.OnMessage(message);
         }
 
+        /// <summary>
+        /// Invoke the specified listener as Spring SessionAwareMessageListener,
+        /// exposing a new NMS Session (potentially with its own transaction)
+        /// to the listener if demanded.
+        /// </summary>
+        /// <param name="listener">The Spring ISessionAwareMessageListener to invoke.</param>
+        /// <param name="session">The session to operate on.</param>
+        /// <param name="message">The received message.</param>
         protected virtual void DoInvokeListener(ISessionAwareMessageListener listener, ISession session, IMessage message)
         {
             IConnection conToClose = null;
diff --git a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/SimpleMessageListenerContainer.cs b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/SimpleMessageListenerContainer.cs
index d3a67a61..e3214354 100644
--- a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/SimpleMessageListenerContainer.cs
+++ b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Listener/SimpleMessageListenerContainer.cs
@@ -62,6 +62,10 @@ namespace Spring.Messaging.Nms.Listener
             return consumer;
         }
 
+        /// <summary>
+        /// Close the message consumers and sessions.
+        /// </summary>
+        /// <throws>NMSException if destruction failed </throws>
         protected override void DestroyListener()
         {
             logger.Debug("Closing NMS IMessageConsumers");
@@ -76,6 +80,9 @@ namespace Spring.Messaging.Nms.Listener
             }
         }
 
+        /// <summary>
+        /// Afters the properties set.
+        /// </summary>
         public override void AfterPropertiesSet()
         {
             if (this.concurrentConsumers <= 0)
diff --git a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/NmsTemplate.cs b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/NmsTemplate.cs
index 05cacfd2..33b7c917 100644
--- a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/NmsTemplate.cs
+++ b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/NmsTemplate.cs
@@ -87,9 +87,9 @@ namespace Spring.Messaging.Nms
 
         /// <summary> Create a new NmsTemplate.</summary>
         /// <remarks>
-        /// <p>Note: The IConnectionFactory has to be set before using the instance.
+        /// <para>Note: The IConnectionFactory has to be set before using the instance.
         /// This constructor can be used to prepare a NmsTemplate via an ObjectFactory,
-        /// typically setting the IConnectionFactory.</p>
+        /// typically setting the IConnectionFactory.</para>
         /// </remarks>
         public NmsTemplate()
         {
diff --git a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Support/Destinations/NmsDestinationAccessor.cs b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Support/Destinations/NmsDestinationAccessor.cs
index 08e75221..83d65c89 100644
--- a/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Support/Destinations/NmsDestinationAccessor.cs
+++ b/src/Spring/Spring.Messaging.Nms/Messaging/Nms/Support/Destinations/NmsDestinationAccessor.cs
@@ -95,6 +95,13 @@ namespace Spring.Messaging.Nms.Support.IDestinations
 		
         #endregion
 
+        /// <summary>
+        /// Resolves the given destination name to a NMS destination.
+        /// </summary>
+        /// <param name="session">The current session.</param>
+        /// <param name="destinationName">Name of the destination.</param>
+        /// <returns>The located IDestination</returns>
+        /// <exception cref="NMSException">If resolution failed.</exception>
         public virtual IDestination ResolveDestinationName(ISession session, System.String destinationName)
         {
             return DestinationResolver.ResolveDestinationName(session, destinationName, PubSubDomain);