QPID-2824: Use toLogString rather than toString on LogSubject(s)

Applied patch from Sorin Suciu <ssuciu@gmail.com>


git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@990820 13f79535-47bb-0310-9956-ffa450edef68

15 files changed, 35 insertions, 24 deletions

diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/LogSubject.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/LogSubject.java
index e53ef364bf..09a277e520 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/LogSubject.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/LogSubject.java
@@ -24,14 +24,13 @@ package org.apache.qpid.server.logging;
  * Each LogSubject that wishes to be logged will implement this to provide their
  * own display representation.
  *
- * The display representation is retrieved through the toString() method.
  */
 public interface LogSubject 
 {
     /**
-     * Logs the message as provided by String.valueOf(message).
+     * Provides the log message as as String.
      *
      * @returns String the display representation of this LogSubject
      */
-    public String toString();
+    public String toLogString();
 }
\ No newline at end of file
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPChannelActor.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPChannelActor.java
index d961836acc..9c7ffcc5f8 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPChannelActor.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPChannelActor.java
@@ -58,7 +58,7 @@ public class AMQPChannelActor extends AbstractActor
 
     public String getLogMessage()
     {
-        return _logString.toString();
+        return _logString.toLogString();
     }
 }
 
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPConnectionActor.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPConnectionActor.java
index 4149aed529..1b4bc91bc1 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPConnectionActor.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AMQPConnectionActor.java
@@ -48,7 +48,7 @@ public class AMQPConnectionActor extends AbstractActor
 
     public String getLogMessage()
     {
-        return _logSubject.toString();
+        return _logSubject.toLogString();
     }
 }
 
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AbstractActor.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AbstractActor.java
index 05ac8c4b7e..a94e4b84e2 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AbstractActor.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/AbstractActor.java
@@ -44,7 +44,7 @@ public abstract class AbstractActor implements LogActor
     {
         if (_rootLogger.isMessageEnabled(this, subject, message.getLogHierarchy()))
         {
-            _rootLogger.rawMessage(DEFAULT_MSG_PREFIX + getLogMessage() + String.valueOf(subject) + message, message.getLogHierarchy());
+            _rootLogger.rawMessage(DEFAULT_MSG_PREFIX + getLogMessage() + subject.toLogString() + message, message.getLogHierarchy());
         }
     }
 
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/QueueActor.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/QueueActor.java
index 7d81b03de4..3364365b61 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/QueueActor.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/QueueActor.java
@@ -49,7 +49,7 @@ public class QueueActor extends AbstractActor
 
     public String getLogMessage()
     {
-        return _logSubject.toString();
+        return _logSubject.toLogString();
     }
 }
     
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/SubscriptionActor.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/SubscriptionActor.java
index 612074fbe9..a2dbf2f6ee 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/SubscriptionActor.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/actors/SubscriptionActor.java
@@ -41,6 +41,6 @@ public class SubscriptionActor extends AbstractActor
 
     public String getLogMessage()
     {
-        return _logSubject.toString();
+        return _logSubject.toLogString();
     }
 }
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/AbstractLogSubject.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/AbstractLogSubject.java
index d7be9ea4c7..779db01601 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/AbstractLogSubject.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/AbstractLogSubject.java
@@ -34,7 +34,7 @@ import java.text.MessageFormat;
 public abstract class AbstractLogSubject implements LogSubject
 {
     /**
-     * The logString that will be returned via toString
+     * The logString that will be returned via toLogString
      */
     protected String _logString;
 
@@ -50,13 +50,12 @@ public abstract class AbstractLogSubject implements LogSubject
     }
 
     /**
-     * ToString is how the Logging infrastructure will get the text for this
+     * toLogString is how the Logging infrastructure will get the text for this
      * LogSubject
      *
      * @return String representing this LogSubject
      */
-    @Override
-    public String toString()
+    public String toLogString()
     {
         return _logString;
     }
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/ConnectionLogSubject.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/ConnectionLogSubject.java
index f3df87c432..6c41718177 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/ConnectionLogSubject.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/ConnectionLogSubject.java
@@ -128,10 +128,9 @@ public class ConnectionLogSubject extends AbstractLogSubject
         }
     }
 
-    @Override
-    public String toString()
+    public String toLogString()
     {
         updateLogString();
-        return super.toString();
+        return super.toLogString();
     }
 }
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/QueueLogSubject.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/QueueLogSubject.java
index fd97318e8b..b132d9e93f 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/QueueLogSubject.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/QueueLogSubject.java
@@ -40,6 +40,6 @@ public class QueueLogSubject extends AbstractLogSubject
     {
         setLogStringWithFormat(LOG_FORMAT,
                                queue.getVirtualHost().getName(),
-                               queue.getNameShortString());
+                               queue.getName());
     }
 }
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/SubscriptionLogSubject.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/SubscriptionLogSubject.java
index 2dde1b6b41..0683c8e361 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/SubscriptionLogSubject.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/logging/subjects/SubscriptionLogSubject.java
@@ -29,8 +29,8 @@ public class SubscriptionLogSubject extends AbstractLogSubject
 
     /**
      * LOG FORMAT for the SubscriptionLogSubject,
-     * Uses a MessageFormat call to insert the requried values according to
-     * these indicies:
+     * Uses a MessageFormat call to insert the required values according to
+     * these indices:
      *
      * 0 - Subscription ID
      */
@@ -47,7 +47,7 @@ public class SubscriptionLogSubject extends AbstractLogSubject
         // log string format is:
         // [ sub:<id>(vh(<vhost>)/qu(<queue>)) ]
 
-        String queueString = new QueueLogSubject(subscription.getQueue()).toString();
+        String queueString = new QueueLogSubject(subscription.getQueue()).toLogString();
 
         _logString = "[" + MessageFormat.format(SubscriptionLogSubject.SUBSCRIPTION_FORMAT,
                                                 subscription.getSubscriptionID())
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/transport/ServerSession.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/transport/ServerSession.java
index 17a8ce8a43..42ccee3b3f 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/transport/ServerSession.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/transport/ServerSession.java
@@ -575,7 +575,14 @@ public class ServerSession extends Session implements PrincipalHolder, SessionCo
 
     public LogSubject getLogSubject()
     {
-        return null;
+        return new LogSubject()
+        {
+            public String toLogString()
+            {
+                return "[ ]";
+            }
+
+        };
     }
 
 }
diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/AMQPConnectionActorTest.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/AMQPConnectionActorTest.java
index 2cb950ee30..71d06f81ae 100644
--- a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/AMQPConnectionActorTest.java
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/AMQPConnectionActorTest.java
@@ -113,7 +113,7 @@ public class AMQPConnectionActorTest extends BaseConnectionActorTestCase
 
         _amqpActor.message(new LogSubject()
         {
-            public String toString()
+            public String toLogString()
             {
                 return "[AMQPActorTest]";
             }
diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/BaseActorTestCase.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/BaseActorTestCase.java
index 6a72a7aaf9..3d4ded5898 100644
--- a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/BaseActorTestCase.java
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/actors/BaseActorTestCase.java
@@ -69,7 +69,7 @@ public class BaseActorTestCase extends InternalBrokerBaseCase
     {
         actor.message(new LogSubject()
         {
-            public String toString()
+            public String toLogString()
             {
                 return message;
             }
diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
index 5bd8f52d70..e253881d09 100644
--- a/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/logging/messages/AbstractTestMessages.java
@@ -83,7 +83,7 @@ public abstract class AbstractTestMessages extends InternalBrokerBaseCase
         // Simple switch to print out all the logged messages 
         //System.err.println(log);
 
-        int msgIndex = log.indexOf(_logSubject.toString())+_logSubject.toString().length();
+        int msgIndex = log.indexOf(_logSubject.toLogString())+_logSubject.toLogString().length();
 
         assertTrue("Unable to locate Subject:" + log, msgIndex != -1);
 
diff --git a/qpid/java/broker/src/test/java/org/apache/qpid/server/queue/MockAMQQueue.java b/qpid/java/broker/src/test/java/org/apache/qpid/server/queue/MockAMQQueue.java
index 9bbae6df01..888a16053c 100644
--- a/qpid/java/broker/src/test/java/org/apache/qpid/server/queue/MockAMQQueue.java
+++ b/qpid/java/broker/src/test/java/org/apache/qpid/server/queue/MockAMQQueue.java
@@ -91,7 +91,14 @@ public class MockAMQQueue implements AMQQueue
 
     public LogSubject getLogSubject()
     {
-        return null; 
+       return new LogSubject()
+        {
+            public String toLogString()
+            {
+                return "[MockAMQQueue]";
+            }
+
+        }; 
     }
 
     public ConfigStore getConfigStore()