org.wso2.carbon.registry.core.jdbc.realm
Class RegistryUserStoreManager

java.lang.Object
  extended by org.wso2.carbon.registry.core.jdbc.realm.RegistryUserStoreManager
All Implemented Interfaces:
org.wso2.carbon.user.api.UserStoreManager

Deprecated.

@Deprecated
public class RegistryUserStoreManager
extends Object
implements org.wso2.carbon.user.core.UserStoreManager

Registry wrapper of the user store admin. This will provide registry level validation for some of the functions in user store management.


Constructor Summary
RegistryUserStoreManager(org.wso2.carbon.user.core.UserRealm coreRealm)
          Deprecated. Constructs the Registry User Store Admin
 
Method Summary
 void addRememberMe(String userName, String token)
          Deprecated.  
 void addRole(String roleName, String[] userList, org.wso2.carbon.user.core.Permission[] permissions)
          Deprecated. Method to add role.
 void addRole(String roleName, String[] userList, org.wso2.carbon.user.api.Permission[] permissions)
          Deprecated.  
 void addUser(String userName, Object credential, String[] roleList, Map<String,String> claims, String profileName)
          Deprecated. Method to add user.
 void addUser(String userName, Object credential, String[] roleList, Map<String,String> claims, String profileName, boolean requirePasswordChange)
          Deprecated. Method to add user.
 boolean authenticate(String userName, Object credential)
          Deprecated. Authenticate the user
 void deleteRole(String roleName)
          Deprecated. Delete role.
 void deleteUser(String userName)
          Deprecated. Delete user.
 void deleteUserClaimValue(String userName, String claimURI, String profileName)
          Deprecated. Delete the user claim value.
 void deleteUserClaimValues(String userName, String[] claims, String profileName)
          Deprecated. Delete the user claim values
 String[] getAllProfileNames()
          Deprecated. Get all profile names.
 String[] getHybridRoles()
          Deprecated. Method to return the the hybrid roles.
 Date getPasswordExpirationTime(String userName)
          Deprecated. Method to get the password expiration time.
 String[] getProfileNames(String userName)
          Deprecated. Get profile names.
 Map<String,String> getProperties(org.wso2.carbon.user.api.Tenant tenant)
          Deprecated.  
 Map<String,String> getProperties(org.wso2.carbon.user.core.tenant.Tenant tenant)
          Deprecated.  
 String[] getRoleListOfUser(String userName)
          Deprecated. Method to get the role list of user.
 String[] getRoleNames()
          Deprecated. Get the role names.
 int getTenantId()
          Deprecated. Method to get the tenant id of the current user store manager instance.
 int getTenantId(String userName)
          Deprecated. Method to get the tenant id from a given user name.
 String getUserClaimValue(String userName, String claim, String profileName)
          Deprecated. Get the claim value of a user.
 org.wso2.carbon.user.core.claim.Claim[] getUserClaimValues(String userName, String profileName)
          Deprecated. Method to get the user claim values.
 Map<String,String> getUserClaimValues(String userName, String[] claims, String profileName)
          Deprecated. Method to get the user claim values.
 int getUserId(String userName)
          Deprecated. Method to get the user id.
 String[] getUserList(String claim, String claimValue, String profileName)
          Deprecated.  
 String[] getUserListOfRole(String roleName)
          Deprecated. Method to return the user list of a role.
 boolean isBulkImportSupported()
          Deprecated.  
 boolean isExistingRole(String roleName)
          Deprecated. Method to check whether the role exist or not.
 boolean isExistingUser(String userName)
          Deprecated. Method to check whether the user exist or not.
 boolean isMultipleProfilesAllowed()
          Deprecated. This method is to check whether multiple profiles are allowed with a particular user-store.
 boolean isReadOnly()
          Deprecated. Method to check whether the registry is readonly or not.
 boolean isValidRememberMeToken(String userName, String token)
          Deprecated.  
 String[] listUsers(String filter, int maxItemLimit)
          Deprecated. Method to list the
 void setUserClaimValue(String userName, String claimURI, String claimValue, String profileName)
          Deprecated. Set a claim value
 void setUserClaimValues(String userName, Map<String,String> claims, String profileName)
          Deprecated. Set the user claim values.
 void updateCredential(String userName, Object newCredential, Object oldCredential)
          Deprecated. Update the credential.
 void updateCredentialByAdmin(String userName, Object newCredential)
          Deprecated. Update the credential by an admin
 void updateRoleListOfUser(String userName, String[] deletedRoles, String[] newRoles)
          Deprecated. Update the role list of a user.
 void updateRoleName(String roleName, String newRoleName)
          Deprecated. Update Role Name.
 void updateUserListOfRole(String roleName, String[] deletedUsers, String[] newUsers)
          Deprecated. Update the user list of a role
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegistryUserStoreManager

public RegistryUserStoreManager(org.wso2.carbon.user.core.UserRealm coreRealm)
Deprecated. 
Constructs the Registry User Store Admin

Parameters:
coreRealm - the realm which got wrapped by the registry realm.
Method Detail

authenticate

public boolean authenticate(String userName,
                            Object credential)
                     throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Authenticate the user

Specified by:
authenticate in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
credential - the credential to authenticate.
Returns:
true if the authenticate successful, false otherwise.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

addRole

public void addRole(String roleName,
                    String[] userList,
                    org.wso2.carbon.user.core.Permission[] permissions)
             throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to add role.

Parameters:
roleName - the role name.
userList - the users list to add to the role.
permissions - the permission list corresponding to the users list
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

addUser

public void addUser(String userName,
                    Object credential,
                    String[] roleList,
                    Map<String,String> claims,
                    String profileName)
             throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to add user.

Specified by:
addUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
credential - the credential to authenticate.
roleList - the role list.
claims - the claims list corresponding to the roles list.
profileName - the profile name.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

addUser

public void addUser(String userName,
                    Object credential,
                    String[] roleList,
                    Map<String,String> claims,
                    String profileName,
                    boolean requirePasswordChange)
             throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to add user.

Specified by:
addUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
credential - the credential of the user.
roleList - the roles list the users belong to
claims - associated with of the user
profileName - the name of the profile
requirePasswordChange - whether the password change required.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

deleteRole

public void deleteRole(String roleName)
                throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Delete role.

Specified by:
deleteRole in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
roleName - the role name to deleted.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

updateRoleName

public void updateRoleName(String roleName,
                           String newRoleName)
                    throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Update Role Name.

Specified by:
updateRoleName in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
roleName - the role name to update
newRoleName - the new role name
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

isMultipleProfilesAllowed

public boolean isMultipleProfilesAllowed()
Deprecated. 
This method is to check whether multiple profiles are allowed with a particular user-store. For an example, currently, JDBC user store supports multiple profiles and where as ApacheDS does not allow.

Specified by:
isMultipleProfilesAllowed in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
boolean

deleteUser

public void deleteUser(String userName)
                throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Delete user.

Specified by:
deleteUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

addRole

public void addRole(String roleName,
                    String[] userList,
                    org.wso2.carbon.user.api.Permission[] permissions)
             throws org.wso2.carbon.user.api.UserStoreException
Deprecated. 
Specified by:
addRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

deleteUserClaimValue

public void deleteUserClaimValue(String userName,
                                 String claimURI,
                                 String profileName)
                          throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Delete the user claim value.

Specified by:
deleteUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
claimURI - the claim uri string.
profileName - the profile name.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

deleteUserClaimValues

public void deleteUserClaimValues(String userName,
                                  String[] claims,
                                  String profileName)
                           throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Delete the user claim values

Specified by:
deleteUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name
claims - the claims to delete.
profileName - the profile name.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

setUserClaimValue

public void setUserClaimValue(String userName,
                              String claimURI,
                              String claimValue,
                              String profileName)
                       throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Set a claim value

Specified by:
setUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
claimURI - the claim uri.
claimValue - the claim value.
profileName - the profile name.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

setUserClaimValues

public void setUserClaimValues(String userName,
                               Map<String,String> claims,
                               String profileName)
                        throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Set the user claim values.

Specified by:
setUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
claims - the claims
profileName - the profile name.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

updateCredential

public void updateCredential(String userName,
                             Object newCredential,
                             Object oldCredential)
                      throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Update the credential.

Specified by:
updateCredential in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
newCredential - the new credential.
oldCredential - the old credential.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

updateCredentialByAdmin

public void updateCredentialByAdmin(String userName,
                                    Object newCredential)
                             throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Update the credential by an admin

Specified by:
updateCredentialByAdmin in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name
newCredential - the credential
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

updateRoleListOfUser

public void updateRoleListOfUser(String userName,
                                 String[] deletedRoles,
                                 String[] newRoles)
                          throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Update the role list of a user.

Specified by:
updateRoleListOfUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
deletedRoles - the deleted roles.
newRoles - the new role list
Throws:
org.wso2.carbon.user.core.UserStoreException - if the operation failed.

updateUserListOfRole

public void updateUserListOfRole(String roleName,
                                 String[] deletedUsers,
                                 String[] newUsers)
                          throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Update the user list of a role

Specified by:
updateUserListOfRole in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
roleName - the role name.
deletedUsers - the deleted users.
newUsers - the new users.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getHybridRoles

public String[] getHybridRoles()
                        throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to return the the hybrid roles.

Specified by:
getHybridRoles in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
array of hybrid roles.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getUserListOfRole

public String[] getUserListOfRole(String roleName)
                           throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to return the user list of a role.

Specified by:
getUserListOfRole in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
roleName - the role name.
Returns:
array of users
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getAllProfileNames

public String[] getAllProfileNames()
                            throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Get all profile names.

Specified by:
getAllProfileNames in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
array of profile names.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getRoleNames

public String[] getRoleNames()
                      throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Get the role names.

Specified by:
getRoleNames in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
the array of roles.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getProfileNames

public String[] getProfileNames(String userName)
                         throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Get profile names.

Specified by:
getProfileNames in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
Returns:
the array of profile names
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getUserClaimValue

public String getUserClaimValue(String userName,
                                String claim,
                                String profileName)
                         throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Get the claim value of a user.

Specified by:
getUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
claim - the claim
profileName - the profile name
Returns:
the claim value of the user.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getUserClaimValues

public Map<String,String> getUserClaimValues(String userName,
                                             String[] claims,
                                             String profileName)
                                      throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the user claim values.

Specified by:
getUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
claims - the claims
profileName - the profile name.
Returns:
the user claim values.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getRoleListOfUser

public String[] getRoleListOfUser(String userName)
                           throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the role list of user.

Specified by:
getRoleListOfUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - user name.
Returns:
the role list of a user.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

isExistingRole

public boolean isExistingRole(String roleName)
                       throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to check whether the role exist or not.

Specified by:
isExistingRole in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
roleName - the role name.
Returns:
true, if the role exist. false, otherwise.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

isExistingUser

public boolean isExistingUser(String userName)
                       throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to check whether the user exist or not.

Specified by:
isExistingUser in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
Returns:
true, if the user exist, false otherwise
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

listUsers

public String[] listUsers(String filter,
                          int maxItemLimit)
                   throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to list the

Specified by:
listUsers in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
filter - the filter to list the users.
maxItemLimit - maximum item limit
Returns:
the filtered users list
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getUserId

public int getUserId(String userName)
              throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the user id.

Specified by:
getUserId in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
Returns:
the user id
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getTenantId

public int getTenantId()
                throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the tenant id of the current user store manager instance.

Specified by:
getTenantId in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
the tenant id
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getProperties

public Map<String,String> getProperties(org.wso2.carbon.user.api.Tenant tenant)
                                 throws org.wso2.carbon.user.api.UserStoreException
Deprecated. 
Specified by:
getProperties in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

getTenantId

public int getTenantId(String userName)
                throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the tenant id from a given user name.

Specified by:
getTenantId in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
Returns:
the tenant id.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

isReadOnly

public boolean isReadOnly()
                   throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to check whether the registry is readonly or not.

Specified by:
isReadOnly in interface org.wso2.carbon.user.api.UserStoreManager
Returns:
true, if the user store manager is read only, false otherwise.
Throws:
org.wso2.carbon.user.core.UserStoreException - throws if the operation failed.

getUserClaimValues

public org.wso2.carbon.user.core.claim.Claim[] getUserClaimValues(String userName,
                                                                  String profileName)
                                                           throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the user claim values.

Specified by:
getUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
profileName - the profile name.
Returns:
the claim values of the user.
Throws:
org.wso2.carbon.user.core.UserStoreException - throw if the operation failed.

getPasswordExpirationTime

public Date getPasswordExpirationTime(String userName)
                               throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Method to get the password expiration time.

Specified by:
getPasswordExpirationTime in interface org.wso2.carbon.user.api.UserStoreManager
Parameters:
userName - the user name.
Returns:
the password expiration time.
Throws:
org.wso2.carbon.user.core.UserStoreException - throw if the operation failed.

getProperties

public Map<String,String> getProperties(org.wso2.carbon.user.core.tenant.Tenant tenant)
                                 throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Throws:
org.wso2.carbon.user.core.UserStoreException

addRememberMe

public void addRememberMe(String userName,
                          String token)
                   throws org.wso2.carbon.user.api.UserStoreException
Deprecated. 
Specified by:
addRememberMe in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

isValidRememberMeToken

public boolean isValidRememberMeToken(String userName,
                                      String token)
                               throws org.wso2.carbon.user.api.UserStoreException
Deprecated. 
Specified by:
isValidRememberMeToken in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

isBulkImportSupported

public boolean isBulkImportSupported()
                              throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserList

public String[] getUserList(String claim,
                            String claimValue,
                            String profileName)
                     throws org.wso2.carbon.user.core.UserStoreException
Deprecated. 
Throws:
org.wso2.carbon.user.core.UserStoreException


Copyright © 2012 WSO2 Inc. All Rights Reserved.