activemq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chir...@apache.org
Subject svn commit: r1126512 - /activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java
Date Mon, 23 May 2011 14:26:59 GMT
Author: chirino
Date: Mon May 23 14:26:58 2011
New Revision: 1126512

URL: http://svn.apache.org/viewvc?rev=1126512&view=rev
Log:
Better api doco.

Modified:
    activemq/activemq-apollo/trunk/apollo-dto/src/main/java/org/apache/activemq/apollo/dto/AddUserHeaderDTO.java

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=1126512&r1=1126511&r2=1126512&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
Mon May 23 14:26:58 2011
@@ -30,12 +30,27 @@ import javax.xml.bind.annotation.XmlValu
 @XmlAccessorType(XmlAccessType.FIELD)
 public class AddUserHeaderDTO {
 
+    /**
+     * The name of the header to set
+     */
     @XmlValue
     public String name;
 
+    /**
+     * If the user has multiple principals which match
+     * then they will all be listed in the value of the header
+     * entry separated by the configured separator value.  If the
+     * separator is not set, then only the first matching principal
+     * will be used in the value of the header entry.
+     */
     @XmlAttribute(name="separator")
     public String separator;
 
+    /**
+     * The user sending the message may have many principals,
+     * setting the kind will only select those principals who's
+     * class name matches the kind.
+     */
     @XmlAttribute(name="kind")
     public String kind;
 



Mime
View raw message