Adding comments to StratosUserManager
Project: http://git-wip-us.apache.org/repos/asf/stratos/repo Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/de345824 Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/de345824 Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/de345824 Branch: refs/heads/master Commit: de3458249aca92dc73c22a72335266106eff9851 Parents: 6190ada Author: lasinducharith <[email protected]> Authored: Thu Sep 18 17:00:59 2014 +0530 Committer: Nirmal Fernando <[email protected]> Committed: Wed Sep 24 17:00:43 2014 +0530 ---------------------------------------------------------------------- .../stratos/manager/user/mgt/StratosUserManager.java | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/stratos/blob/de345824/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/user/mgt/StratosUserManager.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/user/mgt/StratosUserManager.java b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/user/mgt/StratosUserManager.java index 2e4961d..59c2d8e 100644 --- a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/user/mgt/StratosUserManager.java +++ b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/user/mgt/StratosUserManager.java @@ -37,6 +37,10 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +/** + * This Class provides the operations related to adding/updating/deleting and listing users using + * the carbon UserStoreManager in the particular tenant space + */ public class StratosUserManager { private transient static final Log log = LogFactory.getLog(StratosUserManager.class); @@ -44,7 +48,7 @@ public class StratosUserManager { private static final String GET_ALL_USERS_WILD_CARD = "*"; /** - * Add a user to the user-store + * Add a user to the user-store of the particular tenant * * @param userStoreManager * @param userInfoBean @@ -79,7 +83,7 @@ public class StratosUserManager { } /** - * Delete the user with the given username + * Delete the user with the given username in the relevant tenant space * * @param userStoreManager * @param userName @@ -98,7 +102,7 @@ public class StratosUserManager { /** - * Updates the user info + * Updates the user info given the new UserInfoBean * * @param userStoreManager * @param userInfoBean @@ -136,7 +140,7 @@ public class StratosUserManager { } /** - * Get a List of usernames and associated Roles + * Get a List of usernames and associated Roles as a UserInfoBean * * @param userStoreManager UserStoreManager * @return List<UserInfoBean>
