Author: prabath
Date: Thu Feb 21 09:06:39 2008
New Revision: 14002

Log:

comments & code formatting

Modified:
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDServerManager.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/UserInfoServlet.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreAdmin.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreReader.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
   
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
     (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDProvider.java
     Thu Feb 21 09:06:39 2008
@@ -339,7 +339,7 @@
      * 
      * @param user
      *                User
-     * @return
+     * @return Generated OpenID
      */
     public static String generateOpenID(String user) {
 
@@ -383,6 +383,10 @@
         return opAddress;
     }
 
+    /**
+     * 
+     * @return ServerManager instance.
+     */
     public static ServerManager getManager() {
         return manager;
     }

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDServerManager.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDServerManager.java
        (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/OpenIDServerManager.java
        Thu Feb 21 09:06:39 2008
@@ -1,7 +1,5 @@
 package org.wso2.solutions.identity.openid;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.openid4java.OpenIDException;
 import org.openid4java.association.Association;
 import org.openid4java.association.AssociationException;
@@ -17,8 +15,6 @@
 
 public class OpenIDServerManager extends ServerManager {
 
-    private static Log log = LogFactory.getLog(OpenIDServerManager.class);
-
     /**
      * 
      */
@@ -26,10 +22,7 @@
         boolean isVersion2 = requestParams
                 .hasParameter(IdentityConstants.OpenId.ATTR_NS);
 
-        log.info("Processing association request...");
-
         try {
-            // build request message from response params (+ integrity check)
             AssociationRequest assocReq = AssociationRequest
                     .createAssociationRequest(requestParams);
 
@@ -45,29 +38,19 @@
                         "Unable create association for: "
                                 + type.getSessionType() + " / "
                                 + type.getAssociationType());
-            } else // all ok, go ahead
-            {
+            } else {
                 Association assoc = getPrivateAssociations().generate(
                         type.getAssociationType(), getExpireIn());
-
-                log.info("Returning private association; handle: "
-                        + assoc.getHandle());
-
                 return AssociationResponse.createAssociationResponse(assocReq,
                         assoc);
             }
         } catch (OpenIDException e) {
             // association failed, respond accordingly
             if (isVersion2) {
-                log.warn("Cannot establish association, "
-                        + "responding with an OpenID2 association error.", e);
-
                 return AssociationError.createAssociationError(e.getMessage(),
                         getPrefAssocSessEnc());
             } else {
-                log.warn("Error processing an OpenID1 association request: "
-                        + e.getMessage()
-                        + " Responding with a dummy association.", e);
+
                 try {
                     // generate dummy association & no-encryption response
                     // for compatibility mode
@@ -79,17 +62,10 @@
 
                     return AssociationResponse.createAssociationResponse(
                             dummyRequest, dummyAssoc);
-                } catch (OpenIDException ee) {
-                    log
-                            .error(
-                                    "Error creating negative OpenID1 
association response.",
-                                    e);
+                } catch (OpenIDException ex) {
                     return null;
                 }
-
             }
-
         }
     }
-
 }

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/UserInfoServlet.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/UserInfoServlet.java
    (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/UserInfoServlet.java
    Thu Feb 21 09:06:39 2008
@@ -82,9 +82,7 @@
             String user = null;
 
             while (iterator.hasNext()) {
-
                 user = (String) iterator.next();
-
                 if (user.equals(userName))
                     return true;
             }
@@ -94,5 +92,4 @@
 
         return false;
     }
-
 }

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
      (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/openid/infocard/OpenIDInfoCardHeader.java
      Thu Feb 21 09:06:39 2008
@@ -30,11 +30,15 @@
     }
 
     /**
+     * Build the OpenIDToken header with the provided parameters.
      * 
      * @param openID
+     *                OpenID Url
      * @param opAddress
+     *                OpenID Provider server Url
      * @param appliesTo
-     * @return
+     *                true/false
+     * @return OpenIDToken header
      * @throws IdentityProviderException
      */
     public ParameterList buildHeader(String openID, String opAddress,
@@ -126,8 +130,8 @@
      */
     private String getSignature(boolean compatibilty) throws MessageException,
             AssociationException {
-        AuthSuccess openidResp;
-   
+        AuthSuccess openidResp =  null;
+
         openidResp = AuthSuccess.createAuthSuccess(opAdress, openID, openID,
                 compatibilty, returnTo, nonce, null, assoc, true);
 

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
   (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/persistence/dao/OpenIDUserRPDAO.java
   Thu Feb 21 09:06:39 2008
@@ -11,7 +11,6 @@
     public OpenIDUserRPDAO(
             org.wso2.solutions.identity.persistence.HibernateConfig config) {
         super(config);
-        // TODO Auto-generated constructor stub
     }
 
     /**
@@ -31,7 +30,7 @@
             Query query = session.createQuery(stmt);
             List lst = query.list();
             rpdo = (OpenIDUserRPDO[]) lst
-                    .toArray(new OpenIDUserRPDO[lst.size()]);       
+                    .toArray(new OpenIDUserRPDO[lst.size()]);
         } catch (Throwable e) {
             String msg = messages.getMessage("errorQuerryingOpenIDUserRP");
             throw new RuntimeException(msg, e);
@@ -78,7 +77,7 @@
 
         Session session = hbConfig.getCurrentSession();
         String stmt = "select c.defaultProfileName from OpenIDUserRPDO as c 
where c.userName='"
-                + userName + "' and c.rpUrl='"+rpUrl+"'";
+                + userName + "' and c.rpUrl='" + rpUrl + "'";
         String[] profileId = new String[0];
 
         try {

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
        (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultRealm.java
        Thu Feb 21 09:06:39 2008
@@ -3,10 +3,16 @@
 import org.wso2.usermanager.UserManagerException;
 import org.wso2.usermanager.readwrite.DefaultRealm;
 
+/**
+ * 
+ * Extends base class functionality to introduce multiple profile support.
+ * 
+ */
 public class IdentityDefaultRealm extends DefaultRealm {
 
     /**
-     * 
+     * Overrides the base functionality set our own UserStoreAdmin and
+     * UserStoreReader.
      */
     public void init(Object configBean) throws UserManagerException {
         super.init(configBean);
@@ -17,7 +23,7 @@
 
     /**
      * 
-     * @return
+     * @return IdentityUserStoreAdmin
      */
     public IdentityUserStoreAdmin getIdentityUserStoreAdmin() {
         return (IdentityUserStoreAdmin) usAdmin;
@@ -25,7 +31,7 @@
 
     /**
      * 
-     * @return
+     * @return IdentityUserStoreReader
      */
     public IdentityUserStoreReader getIdentityUserStoreReader() {
         return (IdentityUserStoreReader) usReader;

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreAdmin.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreAdmin.java
       (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreAdmin.java
       Thu Feb 21 09:06:39 2008
@@ -25,18 +25,23 @@
     private static Log log = LogFactory.getLog(DefaultUserStoreAdmin.class);
 
     /**
+     * Class constructor specifying the data-source
      * 
      * @param dataSource
+     *                DataSource
      */
     public IdentityDefaultUserStoreAdmin(DataSource dataSource) {
         super(dataSource);
-        // TODO Auto-generated constructor stub
+
     }
 
     /**
+     * Class constructor specifying the data-source and the default strategy
      * 
      * @param dataSource
+     *                DataSource
      * @param store
+     *                DefaultStrategy
      */
     public IdentityDefaultUserStoreAdmin(DataSource dataSource,
             DefaultStrategy store) {
@@ -53,10 +58,6 @@
 
     /**
      * 
-     * @param userName
-     * @param properties
-     * @param profileName
-     * @throws UserManagerException
      */
     public void setUserProperties(String userName, Map properties,
             String profileName) throws UserManagerException {
@@ -151,11 +152,16 @@
     }
 
     /**
+     * Add a new profile for a given user.
      * 
      * @param userId
+     *                User Id
      * @param profileId
+     *                Profile Id
      * @param isDefault
+     *                Indicates whether the given profile is default or not
      * @param profileName
+     *                Name of the profile
      * @throws UserManagerException
      */
     protected void addUserProfile(String userId, String profileId,

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreReader.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreReader.java
      (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityDefaultUserStoreReader.java
      Thu Feb 21 09:06:39 2008
@@ -25,18 +25,23 @@
             .getLog(IdentityDefaultUserStoreReader.class);
 
     /**
+     * Class constructor specifying the data-source
      * 
      * @param dataSource
+     *                DataSource
      */
     public IdentityDefaultUserStoreReader(DataSource dataSource) {
         super(dataSource);
-        // TODO Auto-generated constructor stub
+
     }
 
     /**
+     * Class constructor specifying the data-source and the default strategy
      * 
      * @param dataSource
+     *                DataSource
      * @param store
+     *                DefaultStrategy
      */
     public IdentityDefaultUserStoreReader(DataSource dataSource,
             DefaultStrategy store) {
@@ -245,6 +250,9 @@
         return profileNames;
     }
 
+    /**
+     * 
+     */
     public Map getUserProperties(String userName, String profileName)
             throws UserManagerException {
 
@@ -295,6 +303,9 @@
         return props;
     }
 
+    /**
+     * 
+     */
     public boolean isExistingUserProfile(String userName, String profileName)
             throws UserManagerException {
 

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
      (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreAdmin.java
      Thu Feb 21 09:06:39 2008
@@ -4,13 +4,27 @@
 
 import org.wso2.usermanager.UserManagerException;
 
+/**
+ * 
+ * This interface adds the functionality related to multiple profiles. A given
+ * user can have multiple profiles with different attribute values. This
+ * contains methods corresponding to adding attribute values to user profiles.
+ * 
+ */
 public interface IdentityUserStoreAdmin {
 
     /**
+     * This sets user properties corresponding to the given user name and the
+     * profile name.
      * 
      * @param userName
+     *                Unique user name
      * @param properties
+     *                Profile properties
      * @param profileName
+     *                Name of the profile
+     * 
+     * @throws UserManagerException
      */
     public void setUserProperties(String userName, Map properties,
             String profileName) throws UserManagerException;

Modified: 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
==============================================================================
--- 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
     (original)
+++ 
trunk/solutions/identity/modules/identity-provider/src/main/java/org/wso2/solutions/identity/users/IdentityUserStoreReader.java
     Thu Feb 21 09:06:39 2008
@@ -5,17 +5,67 @@
 
 import org.wso2.usermanager.UserManagerException;
 
+/**
+ * This interface adds the functionality related to multiple profiles. A given
+ * user can have multiple profiles with different attribute values. This
+ * contains methods corresponding to reading attribute values from user
+ * profiles.
+ * 
+ */
 public interface IdentityUserStoreReader {
 
+    /**
+     * Get the user properties corresponding to the given user name and the
+     * profile name.
+     * 
+     * @param userName
+     *                Unique user name
+     * @param profileName
+     *                Profile name, unique to a given user
+     * @return User properties corresponding to the given user name and the
+     *         profile name
+     * @throws UserManagerException
+     */
     public Map getUserProperties(String userName, String profileName)
             throws UserManagerException;
 
+    /**
+     * A given user can have multiple profiles. This returns all the profile
+     * names for a given user.
+     * 
+     * @param userName
+     *                Unique user name
+     * @return Profile names corresponding to the given user name.
+     * @throws UserManagerException
+     */
     public List getUserProfileNames(String userName)
             throws UserManagerException;
 
+    /**
+     * A given user should have a default profile name. This returns the name 
of
+     * the default profile for a given user.
+     * 
+     * @param userName
+     *                Unique user name
+     * @return Default profile name corresponding to the given user name.
+     * @throws UserManagerException
+     */
     public String getDefaultUserProfileName(String userName)
             throws UserManagerException;
 
+    /**
+     * Profile name for a given user should be unique. A single user cannot 
have
+     * multiple profiles with the same profile name. This checks whether the
+     * given user have a profile of the provided profile name.
+     * 
+     * @param userName
+     *                Unique user name
+     * @param profileName
+     *                Profile name
+     * @return True, if the given user does have a profile with the same name,
+     *         else false
+     * @throws UserManagerException
+     */
     public boolean isExistingUserProfile(String userName, String profileName)
             throws UserManagerException;
 }

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

Reply via email to