Code refactoring and adding comments
Project: http://git-wip-us.apache.org/repos/asf/stratos/repo Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/6f984da6 Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/6f984da6 Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/6f984da6 Branch: refs/heads/master Commit: 6f984da6ae74a8f05db6564b78b2269f20c2e857 Parents: 4c09e78 Author: lasinducharith <[email protected]> Authored: Tue Sep 16 13:21:32 2014 +0530 Committer: Nirmal Fernando <[email protected]> Committed: Wed Sep 24 17:00:43 2014 +0530 ---------------------------------------------------------------------- .../internal/ADCManagementServerComponent.java | 2 +- .../manager/listener/TenantUserRoleCreator.java | 4 +- .../manager/user/mgt/StratosUserManager.java | 70 +++++++++++++------- .../manager/utils/PermissionConstants.java | 2 + .../stratos/manager/utils/UserRoleCreator.java | 7 +- .../rest/endpoint/services/ServiceUtils.java | 2 +- 6 files changed, 55 insertions(+), 32 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/internal/ADCManagementServerComponent.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/internal/ADCManagementServerComponent.java b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/internal/ADCManagementServerComponent.java index 38ec2c5..30010e0 100644 --- a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/internal/ADCManagementServerComponent.java +++ b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/internal/ADCManagementServerComponent.java @@ -98,7 +98,7 @@ public class ADCManagementServerComponent { UserRealm realm = realmService.getBootstrapRealm(); UserStoreManager userStoreManager = realm.getUserStoreManager(); //Create a Internal/user Role at server start-up - UserRoleCreator.CreateTenantUserRole(userStoreManager); + UserRoleCreator.createTenantUserRole(userStoreManager); TenantUserRoleCreator tenantUserRoleCreator = new TenantUserRoleCreator(); componentContext.getBundleContext().registerService( http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/listener/TenantUserRoleCreator.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/listener/TenantUserRoleCreator.java b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/listener/TenantUserRoleCreator.java index 97d42dc..5bd9ba3 100644 --- a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/listener/TenantUserRoleCreator.java +++ b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/listener/TenantUserRoleCreator.java @@ -59,8 +59,8 @@ public class TenantUserRoleCreator implements TenantMgtListener { //Get tenant UserRealm & UserStoreManager UserRealm userRealm = DataHolder.getRealmService().getTenantUserRealm(tenantInfo.getTenantId()); UserStoreManager userStoreManager = userRealm.getUserStoreManager(); - - UserRoleCreator.CreateTenantUserRole(userStoreManager); + //Call Util class to create the user role + UserRoleCreator.createTenantUserRole(userStoreManager); } catch (UserStoreException e) { log.error(e.getMessage(), e); http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/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 1dcf8de..2e4961d 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 @@ -44,12 +44,14 @@ 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 * + * @param userStoreManager * @param userInfoBean - * @throws UserStoreException + * @throws UserManagementException */ - public void addUser(UserStoreManager userStoreManager, UserInfoBean userInfoBean) throws UserManagementException { + public void addUser(UserStoreManager userStoreManager, UserInfoBean userInfoBean) + throws UserManagementException { try { @@ -57,16 +59,18 @@ public class StratosUserManager { if (log.isDebugEnabled()) { log.debug("Creating new User: " + userInfoBean.getUserName()); } - } - String[] roles = new String[1]; - roles[0] = userInfoBean.getRole(); - Map<String, String> claims = new HashMap<String, String>(); + String[] roles = new String[1]; + roles[0] = userInfoBean.getRole(); + Map<String, String> claims = new HashMap<String, String>(); + + //set firstname, lastname and email as user claims + claims.put(UserCoreConstants.ClaimTypeURIs.EMAIL_ADDRESS, userInfoBean.getEmail()); + claims.put(UserCoreConstants.ClaimTypeURIs.GIVEN_NAME, userInfoBean.getFirstName()); + claims.put(UserCoreConstants.ClaimTypeURIs.SURNAME, userInfoBean.getLastName()); + userStoreManager.addUser(userInfoBean.getUserName(), userInfoBean.getCredential(), roles, claims, userInfoBean.getProfileName()); - claims.put(UserCoreConstants.ClaimTypeURIs.EMAIL_ADDRESS, userInfoBean.getEmail()); - claims.put(UserCoreConstants.ClaimTypeURIs.GIVEN_NAME, userInfoBean.getFirstName()); - claims.put(UserCoreConstants.ClaimTypeURIs.SURNAME, userInfoBean.getLastName()); - userStoreManager.addUser(userInfoBean.getUserName(), userInfoBean.getCredential(), roles, claims, userInfoBean.getProfileName()); + } } catch (UserStoreException e) { log.error(e.getMessage(), e); @@ -77,10 +81,12 @@ public class StratosUserManager { /** * Delete the user with the given username * - * @param userName The username - * @throws UserStoreException + * @param userStoreManager + * @param userName + * @throws UserManagementException */ - public void deleteUser(UserStoreManager userStoreManager, String userName) throws UserManagementException { + public void deleteUser(UserStoreManager userStoreManager, String userName) + throws UserManagementException { try { userStoreManager.deleteUser(userName); @@ -94,12 +100,19 @@ public class StratosUserManager { /** * Updates the user info * + * @param userStoreManager * @param userInfoBean + * @throws UserManagementException */ - public void updateUser(UserStoreManager userStoreManager, UserInfoBean userInfoBean) throws UserManagementException { + public void updateUser(UserStoreManager userStoreManager, UserInfoBean userInfoBean) + throws UserManagementException { try { if (userStoreManager.isExistingUser(userInfoBean.getUserName())) { + if (log.isDebugEnabled()) { + log.debug("Updating User: " + userInfoBean.getUserName()); + } + String[] newRoles = new String[1]; newRoles[0] = userInfoBean.getRole(); Map<String, String> claims = new HashMap<String, String>(); @@ -109,9 +122,9 @@ public class StratosUserManager { claims.put(UserCoreConstants.ClaimTypeURIs.SURNAME, userInfoBean.getLastName()); userStoreManager.updateRoleListOfUser(userInfoBean.getUserName(), getRefinedListOfRolesOfUser(userStoreManager, userInfoBean.getUserName()), newRoles); - userStoreManager.setUserClaimValue(userInfoBean.getUserName(),UserCoreConstants.ClaimTypeURIs.EMAIL_ADDRESS, userInfoBean.getEmail(),userInfoBean.getProfileName()); - userStoreManager.setUserClaimValue(userInfoBean.getUserName(),UserCoreConstants.ClaimTypeURIs.GIVEN_NAME, userInfoBean.getFirstName(),userInfoBean.getProfileName()); - userStoreManager.setUserClaimValue(userInfoBean.getUserName(),UserCoreConstants.ClaimTypeURIs.SURNAME, userInfoBean.getLastName(),userInfoBean.getProfileName()); + userStoreManager.setUserClaimValue(userInfoBean.getUserName(), UserCoreConstants.ClaimTypeURIs.EMAIL_ADDRESS, userInfoBean.getEmail(), userInfoBean.getProfileName()); + userStoreManager.setUserClaimValue(userInfoBean.getUserName(), UserCoreConstants.ClaimTypeURIs.GIVEN_NAME, userInfoBean.getFirstName(), userInfoBean.getProfileName()); + userStoreManager.setUserClaimValue(userInfoBean.getUserName(), UserCoreConstants.ClaimTypeURIs.SURNAME, userInfoBean.getLastName(), userInfoBean.getProfileName()); userStoreManager.updateCredentialByAdmin(userInfoBean.getUserName(), userInfoBean.getCredential()); } @@ -124,10 +137,13 @@ public class StratosUserManager { /** * Get a List of usernames and associated Roles + * + * @param userStoreManager UserStoreManager * @return List<UserInfoBean> * @throws UserManagementException */ - public List<UserInfoBean> getAllUsers(UserStoreManager userStoreManager) throws UserManagementException{ + public List<UserInfoBean> getAllUsers(UserStoreManager userStoreManager) + throws UserManagementException { String[] users = null; List<UserInfoBean> userList = new ArrayList<UserInfoBean>(); @@ -135,7 +151,8 @@ public class StratosUserManager { try { users = userStoreManager.listUsers(GET_ALL_USERS_WILD_CARD, -1); - for(String user: users){ + //Iterate through the list of users and retrieve their roles + for (String user : users) { UserInfoBean userInfoBean = new UserInfoBean(); userInfoBean.setUserName(user); userInfoBean.setRole(getRefinedListOfRolesOfUser(userStoreManager, user)[0]); @@ -152,11 +169,14 @@ public class StratosUserManager { /** * Get the List of userRoles except the everyone role - * @param username - * @return + * + * @param userStoreManager UserStoreManager + * @param username Username of the user + * @return String[] * @throws UserManagementException */ - private String[] getRefinedListOfRolesOfUser(UserStoreManager userStoreManager, String username) throws UserManagementException{ + private String[] getRefinedListOfRolesOfUser(UserStoreManager userStoreManager, String username) + throws UserManagementException { ArrayList<String> rolesWithoutEveryoneRole = new ArrayList<String>(); @@ -164,8 +184,8 @@ public class StratosUserManager { String[] allUserRoles = userStoreManager.getRoleListOfUser(username); - for(String role: allUserRoles){ - if(!role.equals(INTERNAL_EVERYONE_ROLE)){ + for (String role : allUserRoles) { + if (!role.equals(INTERNAL_EVERYONE_ROLE)) { rolesWithoutEveryoneRole.add(role); } } http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/PermissionConstants.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/PermissionConstants.java b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/PermissionConstants.java index 1235d5e..ac383fd 100644 --- a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/PermissionConstants.java +++ b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/PermissionConstants.java @@ -20,6 +20,7 @@ package org.apache.stratos.manager.utils; public class PermissionConstants { + public static final String ADD_SUBSCRIPTION = "/permission/admin/manage/add/subscription"; public static final String REST_LOGIN = "/permission/admin/restlogin"; public static final String ADD_GIT_SYNC = "/permission/admin/manage/add/sync"; @@ -33,4 +34,5 @@ public class PermissionConstants { public static final String VIEW_CLUSTER = "/permission/admin/manage/view/cluster"; public static final String VIEW_INSTANCE = "/permission/admin/manage/view/instance"; public static final String VIEW_KUBERNETES = "/permission/admin/manage/view/kubernetes"; + } http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/UserRoleCreator.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/UserRoleCreator.java b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/UserRoleCreator.java index 1e92359..a6021fa 100644 --- a/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/UserRoleCreator.java +++ b/components/org.apache.stratos.manager/src/main/java/org/apache/stratos/manager/utils/UserRoleCreator.java @@ -39,7 +39,7 @@ public class UserRoleCreator { /** * Creating a Internal/user Role at Carbon Server Start-up */ - public static void CreateTenantUserRole(UserStoreManager manager) throws UserManagementException{ + public static void createTenantUserRole(UserStoreManager manager) throws UserManagementException{ try { @@ -47,7 +47,8 @@ public class UserRoleCreator { if (log.isDebugEnabled()) { log.debug("Creating new role: " + userRole); } - Permission[] TenantUserPermissions = new Permission[]{ new Permission(PermissionConstants.VIEW_AUTOSCALING_POLICY, UserMgtConstants.EXECUTE_ACTION), + //Set permissions to the Internal/user role + Permission[] tenantUserPermissions = new Permission[]{ new Permission(PermissionConstants.VIEW_AUTOSCALING_POLICY, UserMgtConstants.EXECUTE_ACTION), new Permission(PermissionConstants.VIEW_DEPLOYMENT_POLICY, UserMgtConstants.EXECUTE_ACTION), new Permission(PermissionConstants.VIEW_CARTRIDGE, UserMgtConstants.EXECUTE_ACTION), new Permission(PermissionConstants.VIEW_SERVICE, UserMgtConstants.EXECUTE_ACTION), @@ -63,7 +64,7 @@ public class UserRoleCreator { }; String[] userList = new String[]{}; - manager.addRole(userRole, userList, TenantUserPermissions); + manager.addRole(userRole, userList, tenantUserPermissions); } } catch (UserStoreException e) { http://git-wip-us.apache.org/repos/asf/stratos/blob/6f984da6/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/services/ServiceUtils.java ---------------------------------------------------------------------- diff --git a/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/services/ServiceUtils.java b/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/services/ServiceUtils.java index a9b1dc7..d136afc 100644 --- a/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/services/ServiceUtils.java +++ b/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/services/ServiceUtils.java @@ -1325,7 +1325,7 @@ public class ServiceUtils { /** * Get Tenant aware UserStoreManager * - * @return + * @return UserStoreManager * @throws RestAPIException */ private static UserStoreManager getTenantUserStoreManager() throws RestAPIException {
