Minor javadoc addition for BucketPolicyStatement.setRawPrincipal to p…

…rovide a useful example value
EMCECS · Jun 6, 2022 · 3f8f03b · 3f8f03b
1 parent 749db85
commit 3f8f03b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/main/java/com/emc/object/s3/bean/BucketPolicyStatement.java b/src/main/java/com/emc/object/s3/bean/BucketPolicyStatement.java
@@ -77,6 +77,10 @@ public void setPrincipal(String principal) {
         else this.principal = principal;
     }
 
+    /**
+     * If you want to set the principal to something other than "*", you'll need to set a raw JSON value here.
+     * I.e. <code>"{\"AWS\":[\"arn:ecs:iam::ns:user/my-user\",\"arn:ecs:iam::ns:user/other-user\"]}"</code>
+     */
     public void setRawPrincipal(String principal) { this.principal = principal; }
 
     @XmlElement(name = "Action")