Author: prabath
Date: Tue Jan 22 21:10:13 2008
New Revision: 12725

Log:

added method header comments

Modified:
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
        (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardProviderData.java
        Tue Jan 22 21:10:13 2008
@@ -11,59 +11,87 @@
 import org.wso2.solutions.identity.UserStore;
 import org.wso2.solutions.identity.persistence.dataobject.ClaimDO;
 import org.wso2.solutions.identity.sts.IdentityProviderData;
-import org.wso2.solutions.identity.sts.IdentityProviderData.RequestedClaimData;
 
 public class OpenIDInfoCardProviderData extends IdentityProviderData {
 
     /**
+     * Populate CardSpace specific meta-data.
      * 
      * @param data
+     *                WS-Trust information in the issue request.
      * @throws IdentityProviderException
      * @throws ClassNotFoundException
      */
     public OpenIDInfoCardProviderData(RahasData data)
             throws IdentityProviderException, ClassNotFoundException {
         super(data);
-        // TODO Auto-generated constructor stub
     }
 
     /**
-     * 
+     * This overrides the base class functionality to suit the OpenID related
+     * functionality.
      */
     protected void populateClaimValues(RahasData rahasData)
             throws IdentityProviderException {
 
-        UserStore connector = UserStore.getInstance();
-
-        // get the column names for the URIs
-        Iterator ite = requestedClaims.values().iterator();
-        List lst = new ArrayList();
-        while (ite.hasNext()) {
-            OpenIDRequestedClaimData temp = (OpenIDRequestedClaimData) 
ite.next();
-            ClaimDO claimObj = (ClaimDO) claimObjs.get(temp.uri);
-            if (claimObj != null
-                    && 
!claimObj.getUri().equals(IdentityConstants.CLAIM_PPID)) {
-                lst.add(claimObj.getAttrId());
+        UserStore connector = null;
+        Iterator iterator = null;
+        List list = null;
+        OpenIDRequestedClaimData requestedClaimData = null;
+        String userId = null;
+        Map mapValues = null;
+        ClaimDO claimDO = null;
+        String attrId = null;
+        String claimVal = null;
+        ClaimDO claim = null;
+
+        connector = UserStore.getInstance();
+        // Get the column names for the URIs
+        iterator = requestedClaims.values().iterator();
+        list = new ArrayList();
+
+        // First we need to figure-out which attributed we need to retrieve 
from
+        // the user store.
+        while (iterator.hasNext()) {
+            requestedClaimData = (OpenIDRequestedClaimData) iterator.next();
+            claim = (ClaimDO) claimObjs.get(requestedClaimData.uri);
+            if (claim != null
+                    && !claim.getUri().equals(IdentityConstants.CLAIM_PPID)) {
+                list.add(claim.getAttrId());
             }
         }
 
-        String userId = getUserIdentifier();
-        Map mapValues = connector.getClaimValues(userId, lst);
-        ite = requestedClaims.values().iterator();
-        while (ite.hasNext()) {
-            OpenIDRequestedClaimData temp = (OpenIDRequestedClaimData) 
ite.next();
-            ClaimDO claimDO = ((ClaimDO) this.claimObjs.get(temp.uri));
-            String attrId = claimDO.getAttrId();
-            String claimVal = (String) mapValues.get(attrId);
-            temp.value = claimVal;
-            temp.openIDTag = claimDO.getOpenIDTag();
+        // Get the user id.
+        userId = getUserIdentifier();
+
+        // Get the claims values corresponding to the user from the user store.
+        mapValues = connector.getClaimValues(userId, list);
+        iterator = requestedClaims.values().iterator();
+
+        // Iterate through the claim values retrieved and requestedClaims will
+        // be populated with the corresponding values.
+        while (iterator.hasNext()) {
+            requestedClaimData = (OpenIDRequestedClaimData) iterator.next();
+            claimDO = ((ClaimDO) this.claimObjs.get(requestedClaimData.uri));
+            attrId = claimDO.getAttrId();
+            claimVal = (String) mapValues.get(attrId);
+            requestedClaimData.value = claimVal;
+            requestedClaimData.openIDTag = claimDO.getOpenIDTag();
         }
     }
 
+    /**
+     * This overrides the base class functionality to suit the OpenID related
+     * functionality.
+     */
     protected RequestedClaimData getRequestedClaim() {
         return new OpenIDRequestedClaimData();
     }
 
+    /**
+     * This class is related to the OpenID functionality. All the claims which
+     * support OpenID should have OpenIDTag defined for it.
+     */
     public class OpenIDRequestedClaimData extends RequestedClaimData {
 
         public String openIDTag;

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
       (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardToken.java
       Tue Jan 22 21:10:13 2008
@@ -3,22 +3,24 @@
 import org.openid4java.infocard.OpenIDToken;
 import org.openid4java.message.Message;
 
-public class OpenIDInfoCardToken extends OpenIDToken{
+public class OpenIDInfoCardToken extends OpenIDToken {
 
     /**
-     * 
-     * @param openidMessage
+     * Constructs an OpenID token encapsulating the provided OpenID Message.
+     * Should be used on the OP/STS side to generate a RSTR.
+     *
+     * @param openidMessage     The OpenID message obtained from
+     *                          ServerManager.authResponse().
      */
     public OpenIDInfoCardToken(Message openidMessage) {
         super(openidMessage);
-       
+
     }
-    
+
     /**
-     * 
+     * Returns a well-formatted string token corresponding to the parameter 
list.
      */
-    public String getToken()
-    {
+    public String getToken() {
         return getOpenIDMessage().keyValueFormEncoding();
     }
 

_______________________________________________
Identity-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/identity-dev

Reply via email to