QPID-1743: change maxMessageSize description to indicate it is in Bytes not KBytes, make size descriptions in other methods consistent

merged from trunk r755256


git-svn-id: https://svn.apache.org/repos/asf/qpid/branches/0.5-fix@764475 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 59 insertions, 3 deletions

diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/ManagedQueue.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/ManagedQueue.java
index 84a3bdc1e8..53e249f210 100644
--- a/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/ManagedQueue.java
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/ManagedQueue.java
@@ -131,7 +131,7 @@ public interface ManagedQueue
     void setMaximumMessageAge(Long age) throws IOException;
 
     /**
-     * Returns the maximum size of a message (in kbytes) allowed to be accepted by the
+     * Returns the maximum size of a message (in Bytes) allowed to be accepted by the
      * ManagedQueue. This is useful in setting notifications or taking
      * appropriate action, if the size of the message received is more than
      * the allowed size.
@@ -142,12 +142,12 @@ public interface ManagedQueue
     Long getMaximumMessageSize() throws IOException;
 
     /**
-     * Sets the maximum size of the message (in kbytes) that is allowed to be
+     * Sets the maximum size of the message (in Bytes) that is allowed to be
      * accepted by the Queue.
      * @param size  maximum size of message.
      * @throws IOException
      */
-    @MBeanAttribute(name="MaximumMessageSize", description="Threshold high value(KB) for a message size")
+    @MBeanAttribute(name="MaximumMessageSize", description="Threshold high value(Bytes) for a message size")
     void setMaximumMessageSize(Long size) throws IOException;
 
     /**
@@ -184,6 +184,62 @@ public interface ManagedQueue
     @MBeanAttribute(name="MaximumQueueDepth", description="The threshold high value(Bytes) for Queue Depth")
     void setMaximumQueueDepth(Long value) throws IOException;
 
+    /**
+     * View the limit on the memory that this queue will utilise.
+     *
+     * Used by Flow to Disk.
+     *
+     * @return The maximum memory(B) that the queue will occuy.
+     */
+    public Long getMemoryUsageMaximum();
+
+    /**
+     * Place a limit on the memory that this queue will utilise.
+     *
+     * Used by Flow to Disk
+     *
+     * @param maximumMemoryUsage The new maximum memory(B) to be used by this queue
+     */
+    @MBeanAttribute(name="MemoryUsageMaximum", description="The maximum memory(Bytes) that the queue will occupy.")
+    public void setMemoryUsageMaximum(Long maximumMemoryUsage);
+
+    /**
+     * View the minimum amount of memory that has been defined for this queue.
+     *
+     * Used by Flow to Disk
+     *
+     * @return The minimum amount of queue data(B) that the queue will attempt to keep in memory
+     */
+    public Long getMemoryUsageMinimum();
+
+    /**
+     * Set the minimum amount of memory that has been defined for this queue.
+     *
+     * Used by Flow to Disk
+     *
+     * @param minimumMemoryUsage The new minimum memory(B) level to be used by this queue
+     */
+    @MBeanAttribute(name="MemoryUsageMinimum", description="The minimum memory(Bytes) that the queue will occupy.")
+    public void setMemoryUsageMinimum(Long minimumMemoryUsage);
+
+    /**
+     * View the amount of memory(B) that this queue is using.
+     *
+     * @return The current memory(B) usage of this queue.
+     */
+    @MBeanAttribute(name="MemoryUsageCurrent", description="The current amount of memory(Bytes) used by this queue.")
+    public Long getMemoryUsageCurrent();
+
+    /**
+     * When a queue exceeds its MemoryUsageMaximum value then the Queue will start flowing to disk.
+     *
+     * This boolean is used to show that change in state.
+     *
+     * @return true if the Queue is currently flowing to disk
+     */
+    @MBeanAttribute(name="isFlowed", description="true if the queue is currently flowing to disk.")
+    public boolean isFlowed();
+
 
 
     //********** Operations *****************//