QPID-6454 : Add page summarizing all api paths

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

4 files changed, 28 insertions, 4 deletions

diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Exchange.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Exchange.java
index 52c40fe123..00e78b46e0 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Exchange.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Exchange.java
@@ -25,9 +25,14 @@ import java.util.Map;
 
 import org.apache.qpid.server.message.MessageDestination;
 
-@ManagedObject
+@ManagedObject( description = Exchange.CLASS_DESCRIPTION )
 public interface Exchange<X extends Exchange<X>> extends ConfiguredObject<X>, MessageDestination
 {
+    String CLASS_DESCRIPTION = "<p>An Exchange is a named entity within the Virtualhost which receives messages from "
+                               + "producers and routes them to matching Queues within the Virtualhost.</p>"
+                               + "<p>The server provides a set of exchange types with each exchange type implementing "
+                               + "a different routing algorithm.</p>";
+
     String ALTERNATE_EXCHANGE                   = "alternateExchange";
 
     // Attributes
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Port.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Port.java
index 999a3594b4..a2b052e56a 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Port.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Port.java
@@ -25,9 +25,17 @@ import java.util.Set;
 
 import com.google.common.util.concurrent.ListenableFuture;
 
-@ManagedObject
+@ManagedObject( description = Port.CLASS_DESCRIPTION )
 public interface Port<X extends Port<X>> extends ConfiguredObject<X>
 {
+    String CLASS_DESCRIPTION = "<p>The Broker supports configuration of Ports to specify the particular AMQP messaging "
+                               + "and HTTP/JMX management connectivity it offers for use.</p>"
+                               + "<p>Each Port is configured with the particular Protocols and Transports it supports, "
+                               + "as well as the Authentication Provider to be used to authenticate connections. Where "
+                               + "SSL is in use, the Port configuration also defines which Keystore to use and (where "
+                               + "supported) which TrustStore(s) and whether Client Certificates should be "
+                               + "requested/required.</p>";
+
     String BINDING_ADDRESS                      = "bindingAddress";
     String PORT                                 = "port";
     String PROTOCOLS                            = "protocols";
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
index ba1f262cfc..fe3c8de4ac 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/Queue.java
@@ -27,9 +27,14 @@ import java.util.Map;
 import org.apache.qpid.server.queue.QueueEntryVisitor;
 import org.apache.qpid.server.store.MessageDurability;
 
-@ManagedObject( defaultType = "standard" )
+@ManagedObject( defaultType = "standard", description = Queue.CLASS_DESCRIPTION )
 public interface Queue<X extends Queue<X>> extends ConfiguredObject<X>
 {
+    String CLASS_DESCRIPTION = "<p>Queues are named entities within a VirtualHost that hold/buffer messages for later "
+                               + "delivery to consumer applications. Consumers subscribe to a queue in order to receive "
+                               + "messages for it.</p>"
+                               + "<p>The Broker supports different queue types, each with different delivery semantics. "
+                               + "It also allows for messages on a queue to be treated as a group.</p>";
 
     String ALERT_REPEAT_GAP = "alertRepeatGap";
     String ALERT_THRESHOLD_MESSAGE_AGE = "alertThresholdMessageAge";
diff --git a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/VirtualHost.java b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/VirtualHost.java
index 24e8900b9e..843b300413 100644
--- a/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/VirtualHost.java
+++ b/qpid/java/broker-core/src/main/java/org/apache/qpid/server/model/VirtualHost.java
@@ -31,9 +31,15 @@ import org.apache.qpid.server.message.MessageInstance;
 import org.apache.qpid.server.model.port.AmqpPort;
 import org.apache.qpid.server.store.MessageStore;
 
-@ManagedObject( defaultType = "ProvidedStore")
+@ManagedObject( defaultType = "ProvidedStore", description = VirtualHost.CLASS_DESCRIPTION)
 public interface VirtualHost<X extends VirtualHost<X, Q, E>, Q extends Queue<?>, E extends Exchange<?> > extends ConfiguredObject<X>
 {
+    String CLASS_DESCRIPTION = "<p>A virtualhost is a namespace in which messaging is performed. Virtualhosts are "
+                               + "independent; the messaging goes on a within a virtualhost is independent of any "
+                               + "messaging that goes on in another virtualhost. For instance, a queue named <i>foo</i> "
+                               + "defined in one virtualhost is completely independent of a queue named <i>foo</i> in "
+                               + "another virtualhost.</p>"
+                               + "<p>A virtualhost is backed by storage which is used to store the messages.</p>";
 
     String QUEUE_DEAD_LETTER_QUEUE_ENABLED            = "queue.deadLetterQueueEnabled";