activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r1237311 - /activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/
Date Sun, 29 Jan 2012 15:14:10 GMT
Author: chirino
Date: Sun Jan 29 15:14:08 2012
New Revision: 1237311

URL: http://svn.apache.org/viewvc?rev=1237311&view=rev
Log:
Fixes APLO-142 : Java doc clean up for org.apache.activemq.apollo.dto

Contributed by Jason Sherman.  Thanks!

Modified:
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AcceptingConnectorDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AccessRuleDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AuthenticationDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/BrokerDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ConnectorTypeDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/DestMetricsDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/KeyStorageDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ServiceDTO.java
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/WebAdminDTO.java

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AcceptingConnectorDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AcceptingConnectorDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AcceptingConnectorDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AcceptingConnectorDTO.java
Sun Jan 29 15:14:08 2012
@@ -21,6 +21,10 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
+ * <p>
+ * A broker connector is used to accept new connections to the broker.
+ * </p>
+ *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
  */
 @XmlRootElement(name = "connector")
@@ -28,13 +32,14 @@ import java.util.List;
 public class AcceptingConnectorDTO extends ConnectorTypeDTO {
 
   /**
-   * The transport uri which it will accept connections on.
+   * The transport that the connector will listen on, it includes the ip address and port
that it will bind to.
+   * Transports are specified using a URI syntax.
    */
   @XmlAttribute
   public String bind;
 
   /**
-   * The protocol that the transport will use.
+   * Defaults to 'any' which means that any of the broker's supported protocols can connect
via this transport.
    */
   @XmlAttribute
   public String protocol;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AccessRuleDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AccessRuleDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AccessRuleDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AccessRuleDTO.java
Sun Jan 29 15:14:08 2012
@@ -23,6 +23,8 @@ import javax.xml.bind.annotation.XmlRoot
 
 /**
  * <p>
+ * User authorization to broker resources is accomplished by configuring access control rules.
The rules define
+ * which principals are allowed or denied access to perform actions against server resources.
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
@@ -32,16 +34,16 @@ import javax.xml.bind.annotation.XmlRoot
 public class AccessRuleDTO {
 
     /**
-     * The class name of the JAAS principle that this rule will mach against.  If not set
-     * the this defaults to the default principal kinds configured on the broker or virtual
host.
-     * If set to "*" then it matches all principal classes.
+     * A space separated list of class names of which will be matched against the principle
type. If set to *
+     * then it matches all principal classes. Defaults to the default principal kinds configured
on the broker
+     * or virtual host.
      */
     @XmlAttribute(name = "principal_kind")
     public String principal_kind;
 
     /**
      * The principal which are allowed access to the action.  If set to "+" then it matches
all principals
-     * but requires at at least one.  If set to "*" the it matches all principals and even
matches
+     * but requires at at least one.  If set to "*" then it matches all principals and even
matches
      * the case where there are no principals associated with the subject.
      */
     @XmlAttribute
@@ -49,7 +51,7 @@ public class AccessRuleDTO {
 
     /**
      * The principal which are denied access to the action  If set to "+" then it matches
all principals
-     * but requires at at least one.  If set to "*" the it matches all principals and even
matches
+     * but requires at at least one.  If set to "*" then it matches all principals and even
matches
      * the case where there are no principals associated with the subject.
      */
     @XmlAttribute
@@ -70,15 +72,16 @@ public class AccessRuleDTO {
     public String action;
 
     /**
-     * The kind of broker resource which matches this rule.  You can use "*" to match all
types.  If not set
-     * it defaults to "*"
+     * A space separated list of broker resource types that will match this rule. You can
use * to match all key.
+     * Example values 'broker queue'. Defaults to *.
      */
     @XmlAttribute
     public String kind;
 
     /**
-     * The identifier of the resource which matches this rule.  You can use "*" to match
all resources.  If not set
-     * it defaults to "*"
+     * The identifier of the resource that will match this rule. You can use * to match all
resources. If the
+     * kind is set to queue or topic the your can use a destination wild card to match against
the destination
+     * id. Defaults to *.
      */
     @XmlAttribute
     public String id;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java
Sun Jan 29 15:14:08 2012
@@ -23,6 +23,7 @@ import javax.xml.bind.annotation.XmlValu
 
 /**
  * <p>
+ * This class is used to more finely control how user headers are added to received STOMP
messages.
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
@@ -49,7 +50,7 @@ public class AddUserHeaderDTO {
     /**
      * The user sending the message may have many principals,
      * setting the kind will only select those principals who's
-     * class name matches the kind.
+     * class name matches the kind.  Defaults to *.
      */
     @XmlAttribute(name="kind")
     public String kind;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateConnectionMetricsDTO.java
Sun Jan 29 15:14:08 2012
@@ -25,6 +25,7 @@ import javax.xml.bind.annotation.XmlRoot
 
 /**
  * <p>
+ * Collects aggregated metrics on all connections.
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AggregateDestMetricsDTO.java
Sun Jan 29 15:14:08 2012
@@ -20,6 +20,7 @@ import javax.xml.bind.annotation.*;
 
 /**
  * <p>
+ * Collects aggregated metrics on all destinations
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AuthenticationDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AuthenticationDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AuthenticationDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AuthenticationDTO.java
Sun Jan 29 15:14:08 2012
@@ -25,6 +25,7 @@ import java.util.List;
 
 /**
  * <p>
+ * Sets the JAAS authentication used to access the broker.
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
@@ -32,9 +33,15 @@ import java.util.List;
 @XmlAccessorType(XmlAccessType.FIELD)
 public class AuthenticationDTO {
 
+    /**
+     * Used to enable/disable authentication in a virtual host.
+     */
     @XmlAttribute
     public Boolean enabled;
 
+    /**
+     * Specifies the name of the JAAS domain.
+     */
     @XmlAttribute
     public String domain;
 

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/BrokerDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/BrokerDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/BrokerDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/BrokerDTO.java
Sun Jan 29 15:14:08 2012
@@ -48,28 +48,41 @@ public class BrokerDTO {
     public List<ConnectorTypeDTO> connectors = new ArrayList<ConnectorTypeDTO>();
 
     /**
-     * The clients should use to connect to this
+     * The address clients should use to connect to this
      * broker.
      */
     @XmlElement(name="client_address")
     public String client_address;
 
     /**
-     * The base data directory of the broker.  It will store
-     * persistent data under it.
+     * Specifies the key store data object
      */
     @XmlElementRef
     public KeyStorageDTO key_storage;
 
+    /**
+     *   List of AccessRulesDTO objects which contain information about
+     *   user authorization to broker resources
+     */
     @XmlElement(name="access_rule")
     public List<AccessRuleDTO> access_rules = new ArrayList<AccessRuleDTO>();
 
+    /**
+     * List of WebAdminDTO objects which contain address and port information
+     * to bind to the web interface
+     */
     @XmlElement(name="web_admin")
     public List<WebAdminDTO> web_admins = new ArrayList<WebAdminDTO>();
 
+    /**
+     * List of AuthenticationDTO objects which contain JAAS authentication information
+     */
     @XmlElement(name="authentication")
     public AuthenticationDTO authentication;
 
+    /**
+     * List of LogCategoryDTO objects which configure logging
+     */
     @XmlElement(name="log_category")
     public LogCategoryDTO log_category;
 
@@ -81,8 +94,10 @@ public class BrokerDTO {
     public List<CustomServiceDTO> services = new ArrayList<CustomServiceDTO>();
 
     /**
-     * If set to strict, then the broker will not start up if there
-     * are any validation errors in the configuration file.
+     * When a broker is first started up, it will validate the configuration file against
+     * the the XSD Schema and report any errors/warnings it finds but it will continue to
+     * start the broker even it finds problems. If set to strict, then the broker will not
+     * start up if there are any validation errors in the configuration file.
      */
     @XmlAttribute(name="validation")
     public String validation;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ConnectorTypeDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ConnectorTypeDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ConnectorTypeDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ConnectorTypeDTO.java
Sun Jan 29 15:14:08 2012
@@ -30,6 +30,10 @@ import java.util.List;
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property =
"@class")
 abstract public class ConnectorTypeDTO extends ServiceDTO {
 
+    /**
+     *  The maximum number of concurrently open connections this connector will accept before
it stops accepting
+     *  additional connections. If not set, then there is no limit.
+     */
     @XmlAttribute(name = "connection_limit")
     public Integer connection_limit;
 

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/DestMetricsDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/DestMetricsDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/DestMetricsDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/DestMetricsDTO.java
Sun Jan 29 15:14:08 2012
@@ -24,13 +24,13 @@ import javax.xml.bind.annotation.XmlRoot
 
 /**
  * <p>
- *     Collects metrics about the status of a queue since the
- *     time a broker gets started.
+ *     Collects metrics about the status of a destination since the
+ *     time the broker was started.
  * </p>
  *
  * <p>
- *     Note that you may need to do a little math to compute how much
- *     the number of message swapped on disk:
+ *     Note: To compute the total size in bytes of messages that are in persistent
+ *     storage use the following algorithm:
  *
  *     swapped_out_size = queue_size - swapped_in_size
  *
@@ -80,7 +80,7 @@ public class DestMetricsDTO {
     public long dequeue_size_counter;
 
     /**
-     * The time stamp of when the last dequeue to a consumers occurred.
+     * The time stamp of when the last dequeue to consumers occurred.
      */
     @XmlAttribute(name="dequeue_ts")
     public long dequeue_ts;
@@ -108,7 +108,7 @@ public class DestMetricsDTO {
     public long producer_count;
 
     /**
-     * The current number of producers consuming from the destination.
+     * The current number of consumers consuming from the destination.
      */
     @XmlAttribute(name="consumer_count")
     public long consumer_count;
@@ -188,7 +188,7 @@ public class DestMetricsDTO {
 
     /**
      * The total size in bytes of messages that are being
-     * loaded from persistent storage into RAM
+     * loaded from persistent storage into RAM.
      */
     @XmlAttribute(name="swapping_in_size")
     public long swapping_in_size;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/KeyStorageDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/KeyStorageDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/KeyStorageDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/KeyStorageDTO.java
Sun Jan 29 15:14:08 2012
@@ -23,7 +23,7 @@ import javax.xml.bind.annotation.XmlRoot
 import java.io.File;
 
 /**
- *
+ *  Used to specify the location of key store and key store access
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
  */
@@ -38,7 +38,7 @@ public class KeyStorageDTO {
     public File file;
 
     /**
-     * The key store password
+     * The key store password.
      */
     @XmlAttribute
     public String password;
@@ -50,19 +50,19 @@ public class KeyStorageDTO {
     public String key_password;
 
     /**
-     * The type of key store.  If not set, defaults to JKS
+     * The type of key store.  If not set, defaults to JKS.
      */
     @XmlAttribute(name="store_type")
     public String store_type;
 
     /**
-     * The trust management algorithm.  If not set, defaults to SunX509
+     * The trust management algorithm.  If not set, defaults to SunX509.
      */
     @XmlAttribute(name="trust_algorithm")
     public String trust_algorithm;
 
     /**
-     * The key management algorithm.  If not set, defaults to SunX509
+     * The key management algorithm.  If not set, defaults to SunX509.
      */
     @XmlAttribute(name="key_algorithm")
     public String key_algorithm;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ServiceDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ServiceDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ServiceDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/ServiceDTO.java
Sun Jan 29 15:14:08 2012
@@ -30,7 +30,8 @@ import javax.xml.bind.annotation.XmlRoot
 abstract public class ServiceDTO extends StringIdDTO {
 
     /**
-     * Should this service be running?
+     * If set to true, then the connector host will be enabled.
+     * If set to false, then the connector host will be disabled.
      */
     @XmlAttribute
     public Boolean enabled;

Modified: activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/WebAdminDTO.java
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/WebAdminDTO.java?rev=1237311&r1=1237310&r2=1237311&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/WebAdminDTO.java
(original)
+++ activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/WebAdminDTO.java
Sun Jan 29 15:14:08 2012
@@ -25,6 +25,7 @@ import java.util.Set;
 
 /**
  * <p>
+ * Holds the address and port to bind the web interface
  * </p>
  *
  * @author <a href="http://hiramchirino.com">Hiram Chirino</a>
@@ -32,6 +33,9 @@ import java.util.Set;
 @XmlAccessorType(XmlAccessType.FIELD)
 public class WebAdminDTO {
 
+    /**
+     * The address and port to bind the web interface on in URL syntax.
+     */
     @XmlAttribute
     public String bind;
 



Mime
View raw message