Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.wso2.carbon.um.ws.api
Class WSUserStoreManager

java.lang.Object
  extended by org.wso2.carbon.um.ws.api.WSUserStoreManager
All Implemented Interfaces:
org.wso2.carbon.user.api.UserStoreManager
public class WSUserStoreManager
extends Object
implements org.wso2.carbon.user.core.UserStoreManager

Constructor Summary
WSUserStoreManager(String serverUrl, String cookie, org.apache.axis2.context.ConfigurationContext configCtxt)
           
 
Method Summary
 void addRememberMe(String userName, String token)
           
 void addRole(String roleName, String[] userList, org.wso2.carbon.user.core.Permission[] permissions)
           
 void addRole(String roleName, String[] userList, org.wso2.carbon.user.api.Permission[] permissions)
           
 void addRole(String roleName, String[] userList, org.wso2.carbon.user.api.Permission[] permissions, boolean isSharedRole)
           
 void addSecondaryUserStoreManager(String s, org.wso2.carbon.user.core.UserStoreManager userStoreManager)
           
 void addUser(String userName, Object credential, String[] roleList, Map<String,String> claims, String profileName)
           
 void addUser(String userName, Object credential, String[] roleList, Map<String,String> claims, String profileName, boolean requirePasswordChange)
           
 void addUserClaimValue(String userName, String claimURI, String claimValue, String profileName)
           
 void addUserClaimValues(String userName, Map<String,String> claims, String profileName)
           
 boolean authenticate(String userName, Object credential)
           
 void deleteRole(String roleName)
           
 void deleteUser(String userName)
           
 void deleteUserClaimValue(String userName, String claimURI, String profileName)
           
 void deleteUserClaimValues(String userName, String[] claims, String profileName)
           
 String[] getAllProfileNames()
           
 String[] getAllSecondaryRoles()
           
 org.wso2.carbon.user.api.ClaimManager getClaimManager()
           
 org.wso2.carbon.user.api.Properties getDefaultUserStoreProperties()
           
 String[] getHybridRoles()
           
 Date getPasswordExpirationTime(String username)
           
 String[] getProfileNames(String userName)
           
 Map<String,String> getProperties(org.wso2.carbon.user.core.tenant.Tenant tenant)
           
 Map<String,String> getProperties(org.wso2.carbon.user.api.Tenant tenant)
           
 org.wso2.carbon.user.api.RealmConfiguration getRealmConfiguration()
           
 String[] getRoleListOfUser(String userName)
           
 String[] getRoleNames()
           
 String[] getRoleNames(boolean b)
           
 org.wso2.carbon.user.core.UserStoreManager getSecondaryUserStoreManager()
           
 org.wso2.carbon.user.core.UserStoreManager getSecondaryUserStoreManager(String s)
           
 int getTenantId()
           
 int getTenantId(String username)
           
 String getUserClaimValue(String userName, String claim, String profileName)
           
 org.wso2.carbon.user.core.claim.Claim[] getUserClaimValues(String userName, String profileName)
           
 Map<String,String> getUserClaimValues(String userName, String[] claims, String profileName)
           
 int getUserId(String username)
           
 String[] getUserList(String claim, String claimValue, String profileName)
           
 String[] getUserListOfRole(String roleName)
           
 boolean isBulkImportSupported()
           
 boolean isExistingRole(String roleName)
           
 boolean isExistingRole(String roleName, boolean isSharedRole)
           
 boolean isExistingUser(String userName)
           
 boolean isMultipleProfilesAllowed()
          This method is to check whether multiple profiles are allowed with a particular user-store.
 boolean isReadOnly()
           
 boolean isSCIMEnabled()
           
 boolean isSharedGroupEnabled()
           
 boolean isValidRememberMeToken(String userName, String token)
           
 String[] listUsers(String filter, int maxItemLimit)
           
 void setSecondaryUserStoreManager(org.wso2.carbon.user.core.UserStoreManager userStoreManager)
           
 void setUserClaimValue(String userName, String claimURI, String claimValue, String profileName)
           
 void setUserClaimValues(String userName, Map<String,String> claims, String profileName)
           
 void updateCredential(String userName, Object newCredential, Object oldCredential)
           
 void updateCredentialByAdmin(String userName, Object newCredential)
           
 void updateRoleListOfUser(String userName, String[] deletedRoles, String[] newRoles)
           
 void updateRoleName(String roleName, String newRoleName)
           
 void updateUserListOfRole(String roleName, String[] deletedUsers, String[] newUsers)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSUserStoreManager

public WSUserStoreManager(String serverUrl,
                          String cookie,
                          org.apache.axis2.context.ConfigurationContext configCtxt)
                   throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException
Method Detail

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
Specified by:
addUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

addRole

public void addRole(String roleName,
                    String[] userList,
                    org.wso2.carbon.user.core.Permission[] permissions)
             throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException

addUser

public void addUser(String userName,
                    Object credential,
                    String[] roleList,
                    Map<String,String> claims,
                    String profileName)
             throws org.wso2.carbon.user.core.UserStoreException
Specified by:
addUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

authenticate

public boolean authenticate(String userName,
                            Object credential)
                     throws org.wso2.carbon.user.core.UserStoreException
Specified by:
authenticate in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

deleteRole

public void deleteRole(String roleName)
                throws org.wso2.carbon.user.core.UserStoreException
Specified by:
deleteRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

deleteUser

public void deleteUser(String userName)
                throws org.wso2.carbon.user.core.UserStoreException
Specified by:
deleteUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

deleteUserClaimValue

public void deleteUserClaimValue(String userName,
                                 String claimURI,
                                 String profileName)
                          throws org.wso2.carbon.user.core.UserStoreException
Specified by:
deleteUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

deleteUserClaimValues

public void deleteUserClaimValues(String userName,
                                  String[] claims,
                                  String profileName)
                           throws org.wso2.carbon.user.core.UserStoreException
Specified by:
deleteUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getAllProfileNames

public String[] getAllProfileNames()
                            throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getAllProfileNames in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getHybridRoles

public String[] getHybridRoles()
                        throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getHybridRoles in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getAllSecondaryRoles

public String[] getAllSecondaryRoles()
                              throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException

getPasswordExpirationTime

public Date getPasswordExpirationTime(String username)
                               throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getPasswordExpirationTime in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getProfileNames

public String[] getProfileNames(String userName)
                         throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getProfileNames in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getRoleListOfUser

public String[] getRoleListOfUser(String userName)
                           throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getRoleListOfUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getRoleNames

public String[] getRoleNames()
                      throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getRoleNames in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getRoleNames

public String[] getRoleNames(boolean b)
                      throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException

getTenantId

public int getTenantId()
                throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getTenantId in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getTenantId

public int getTenantId(String username)
                throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getTenantId in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserClaimValue

public String getUserClaimValue(String userName,
                                String claim,
                                String profileName)
                         throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserClaimValues

public org.wso2.carbon.user.core.claim.Claim[] getUserClaimValues(String userName,
                                                                  String profileName)
                                                           throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserClaimValues

public Map<String,String> getUserClaimValues(String userName,
                                             String[] claims,
                                             String profileName)
                                      throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserId

public int getUserId(String username)
              throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getUserId in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserListOfRole

public String[] getUserListOfRole(String roleName)
                           throws org.wso2.carbon.user.core.UserStoreException
Specified by:
getUserListOfRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

isExistingRole

public boolean isExistingRole(String roleName,
                              boolean isSharedRole)
                       throws org.wso2.carbon.user.core.UserStoreException
Specified by:
isExistingRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

isExistingUser

public boolean isExistingUser(String userName)
                       throws org.wso2.carbon.user.core.UserStoreException
Specified by:
isExistingUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

isReadOnly

public boolean isReadOnly()
                   throws org.wso2.carbon.user.core.UserStoreException
Specified by:
isReadOnly in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

listUsers

public String[] listUsers(String filter,
                          int maxItemLimit)
                   throws org.wso2.carbon.user.core.UserStoreException
Specified by:
listUsers in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

setUserClaimValue

public void setUserClaimValue(String userName,
                              String claimURI,
                              String claimValue,
                              String profileName)
                       throws org.wso2.carbon.user.core.UserStoreException
Specified by:
setUserClaimValue in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

setUserClaimValues

public void setUserClaimValues(String userName,
                               Map<String,String> claims,
                               String profileName)
                        throws org.wso2.carbon.user.core.UserStoreException
Specified by:
setUserClaimValues in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

addUserClaimValue

public void addUserClaimValue(String userName,
                              String claimURI,
                              String claimValue,
                              String profileName)
                       throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException

addUserClaimValues

public void addUserClaimValues(String userName,
                               Map<String,String> claims,
                               String profileName)
                        throws org.wso2.carbon.user.core.UserStoreException
Throws:
org.wso2.carbon.user.core.UserStoreException

updateCredential

public void updateCredential(String userName,
                             Object newCredential,
                             Object oldCredential)
                      throws org.wso2.carbon.user.core.UserStoreException
Specified by:
updateCredential in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

updateCredentialByAdmin

public void updateCredentialByAdmin(String userName,
                                    Object newCredential)
                             throws org.wso2.carbon.user.core.UserStoreException
Specified by:
updateCredentialByAdmin in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

updateRoleListOfUser

public void updateRoleListOfUser(String userName,
                                 String[] deletedRoles,
                                 String[] newRoles)
                          throws org.wso2.carbon.user.core.UserStoreException
Specified by:
updateRoleListOfUser in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

updateUserListOfRole

public void updateUserListOfRole(String roleName,
                                 String[] deletedUsers,
                                 String[] newUsers)
                          throws org.wso2.carbon.user.core.UserStoreException
Specified by:
updateUserListOfRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

updateRoleName

public void updateRoleName(String roleName,
                           String newRoleName)
                    throws org.wso2.carbon.user.core.UserStoreException
Specified by:
updateRoleName in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

isMultipleProfilesAllowed

public boolean isMultipleProfilesAllowed()
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:

getProperties

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

addRole

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

getProperties

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

addRememberMe

public void addRememberMe(String userName,
                          String token)
                   throws org.wso2.carbon.user.api.UserStoreException
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
Specified by:
isValidRememberMeToken in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

getClaimManager

public org.wso2.carbon.user.api.ClaimManager getClaimManager()
                                                      throws org.wso2.carbon.user.api.UserStoreException
Specified by:
getClaimManager in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.api.UserStoreException

isSCIMEnabled

public boolean isSCIMEnabled()
                      throws org.wso2.carbon.user.api.UserStoreException
Specified by:
isSCIMEnabled 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
Throws:
org.wso2.carbon.user.core.UserStoreException

getUserList

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

getSecondaryUserStoreManager

public org.wso2.carbon.user.core.UserStoreManager getSecondaryUserStoreManager()

getSecondaryUserStoreManager

public org.wso2.carbon.user.core.UserStoreManager getSecondaryUserStoreManager(String s)

addSecondaryUserStoreManager

public void addSecondaryUserStoreManager(String s,
                                         org.wso2.carbon.user.core.UserStoreManager userStoreManager)

setSecondaryUserStoreManager

public void setSecondaryUserStoreManager(org.wso2.carbon.user.core.UserStoreManager userStoreManager)

getRealmConfiguration

public org.wso2.carbon.user.api.RealmConfiguration getRealmConfiguration()

getDefaultUserStoreProperties

public org.wso2.carbon.user.api.Properties getDefaultUserStoreProperties()
Specified by:
getDefaultUserStoreProperties in interface org.wso2.carbon.user.api.UserStoreManager

addRole

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

isExistingRole

public boolean isExistingRole(String roleName)
                       throws org.wso2.carbon.user.core.UserStoreException
Specified by:
isExistingRole in interface org.wso2.carbon.user.api.UserStoreManager
Throws:
org.wso2.carbon.user.core.UserStoreException

isSharedGroupEnabled

public boolean isSharedGroupEnabled()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 WSO2. All rights reserved.