Skip to main content

[identity-api-spec commits] [identity-api-spec~git:602680c8] improved javadocs of constructors to describe how the Principal's name is

  • From: monzillo@...
  • To: commits@...
  • Subject: [identity-api-spec commits] [identity-api-spec~git:602680c8] improved javadocs of constructors to describe how the Principal's name is
  • Date: Mon, 26 Aug 2013 19:54:05 +0000

Project:    identity-api-spec
Repository: git
Revision:   602680c83a659ba75072ae1b917cac97611b3805
Author:     monzillo
Date:       2013-08-26 19:53:44 UTC
Link:       

Log Message:
------------
improved javadocs of constructors to describe how the Principal's name is 
established.


Revisions:
----------
602680c83a659ba75072ae1b917cac97611b3805


Modified Paths:
---------------
IdentityApiGit/src/main/java/javax/security/identity/auth/IDEntityReferencePrincipal.java


Diffs:
------
--- 
a/IdentityApiGit/src/main/java/javax/security/identity/auth/IDEntityReferencePrincipal.java
+++ 
b/IdentityApiGit/src/main/java/javax/security/identity/auth/IDEntityReferencePrincipal.java
@@ -34,20 +34,36 @@ public class IDEntityReferencePrincipal implements 
Principal, Serializable {
     IDAttributeValue<?> _attributeValue;
     IDEntityReference _reference;
 
+    /**
+     * Encapsulate an IDEntityReference within a java.security.Principal.
+     * 
+     * @param reference the IDEntityReference to be encapsulated.
+     * 
+     * The name of the resulting Principal is obtained by calling toString
+     * on the encapsulated reference.
+     */
     public IDEntityReferencePrincipal(IDEntityReference reference) {
         _reference = reference;
     }
 
     /**
+     * Encapsulate an IDEntityReference within a java.security.Principal,
+     * while assigning the name of the principal from a named attribute and
+     * value.
      * 
-     * @param reference
-     * @param attributeName
-     * @param attributeValue 
+     * @param reference the IDEntityReference to be encapsulated.
+     * @param attributeName an IDName containing the name of the attribute 
and
+     * used to scope the argument attributeValues. This parameter may be 
null;
+     * @param attributeValue an IDAttributeValue which will become the name 
of
+     * the Principal. If this value is null, the attributeName parameter is 
+     * ignored, and the value of the Principal is obtained by calling 
toString
+     * on the reference.
      * 
-     * Note attributeValue should be Serializable if Principal is to be
+     * <P><i>Note attributeValue should be Serializable if Principal is to be
      * Serializable, but relaxed constraint (at least until we figure out how
      * to figure out when an attribute value obtained from the 
attributeService
      * is Serializable.
+     * </i>
      */
     public IDEntityReferencePrincipal(IDEntityReference reference, 
             IDName attributeName, IDAttributeValue<?> attributeValue) {





[identity-api-spec commits] [identity-api-spec~git:602680c8] improved javadocs of constructors to describe how the Principal's name is

monzillo 08/26/2013
 
 
Close
loading
Please Confirm
Close