JahiaUserManagerService (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.JahiaService
- - org.jahia.services.usermanager.JahiaUserManagerService

All Implemented Interfaces:

JahiaAfterInitializationService, org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware
```
public class JahiaUserManagerService
extends JahiaService
implements JahiaAfterInitializationService, org.springframework.web.context.ServletContextAware
```
The user manager is responsible to manage all the users in the Jahia environment. The is the general interface that Jahia code uses to offer user management services throughout the product (administration, login, ACL popups, etc..)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COUNT_LIMIT`
`static String`	`GUEST_USERNAME` Guest user unique identification name.
`static String`	`GUEST_USERPATH`
`static String`	`MULTI_CRITERIA_SEARCH_OPERATION`

Fields inherited from class org.jahia.services.JahiaService
settingsBean

Constructor Summary

Constructors
Constructor and Description

JahiaUserManagerService()

Constructors
Constructor and Description
`JahiaUserManagerService()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearNonExistingUsersCache()` Remove all cache entries for non existing groups
`JCRUserNode`	`createUser(String name, String password, Properties properties, JCRSessionWrapper session)` This is the method that creates a new user in the system, with all the specified properties.
`JCRUserNode`	`createUser(String name, String siteKey, String password, Properties properties, JCRSessionWrapper session)` This is the method that creates a new user in the system, with all the specified properties.
`boolean`	`deleteUser(String userPath, JCRSessionWrapper session)` This method removes a user from the system.
`static String`	`encryptPassword(String password)` Deprecated. since 7.1.0.1 use `PasswordService.digest(String)` instead
`static JahiaUserManagerService`	`getInstance()`
`JahiaUserManagerProvider`	`getProvider(String key)` Deprecated.
`JCRStoreProvider`	`getProvider(String providerKey, JCRSessionWrapper session)` Retrieve the user provider corresponding to a given key
`JCRStoreProvider`	`getProvider(String siteKey, String providerKey, JCRSessionWrapper session)`
`List<? extends JahiaUserManagerProvider>`	`getProviderList()` Deprecated.
`List<JCRStoreProvider>`	`getProviderList(JCRSessionWrapper session)` Provide the list of all available users providers
`List<JCRStoreProvider>`	`getProviderList(String siteKey, JCRSessionWrapper session)`
`List<JCRStoreProvider>`	`getProviders(String[] providerKeys, JCRSessionWrapper session)` Provide the list of users providers matching given keys
`List<JCRStoreProvider>`	`getProviders(String siteKey, String[] providerKeys, JCRSessionWrapper session)`
`String`	`getRootUserName()` Returns the system root user name (cached)
`List<String>`	`getUserList()` This method return all users' keys in the system.
`List<String>`	`getUserList(String siteKey)`
`List<String>`	`getUsernameList()` This method returns the list of all the user names registered in the system.
`List<String>`	`getUsernameList(String siteKey)` This method returns the list of all the user names registered in the system.
`String`	`getUserPath(String name)`
`String`	`getUserPath(String name, String site)`
`JahiaUserSplittingRule`	`getUserSplittingRule()`
`void`	`initAfterAllServicesAreStarted()`
`static boolean`	`isGuest(JahiaUser user)` Returns `true` if the specified user is `null` or a guest user.
`static boolean`	`isGuest(JCRUserNode user)` Returns `true` if the specified user is `null` or a guest user.
`boolean`	`isUsernameSyntaxCorrect(String name)` Validates provided user name against a regular expression pattern, specified in the Jahia configuration.
`JCRUserNode`	`lookup(String lookupKey)` Performs the lookup of the user, detecting the type of the provided lookup key (either a JCR path, a user name or a legacy user key).
`JCRUserNode`	`lookupRootUser()` Returns the system root user (not cached).
`JCRUserNode`	`lookupRootUser(JCRSessionWrapper session)` Returns the system root user (not cached).
`JCRUserNode`	`lookupUser(String name)` Load all the user data and attributes.
`JCRUserNode`	`lookupUser(String name, JCRSessionWrapper session)` Load all the user data and attributes.
`JCRUserNode`	`lookupUser(String name, String site)`
`JCRUserNode`	`lookupUser(String name, String site, boolean checkSiteAndGlobalUsers)`
`JCRUserNode`	`lookupUser(String name, String site, JCRSessionWrapper session)` Load all the user data and attributes.
`JCRUserNode`	`lookupUserByKey(String userKey)` Deprecated. use lookupUserByPath() instead
`JCRUserNode`	`lookupUserByPath(String path)` Load all the user data and attributes.
`JCRUserNode`	`lookupUserByPath(String userKey, JCRSessionWrapper session)` Load all the user data and attributes.
`void`	`registerProvider(JahiaUserManagerProvider jahiaUserManagerProvider)` Deprecated.
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias)` Find users according to a table of name=value properties.
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, JCRSessionWrapper session)` Find users according to a table of name=value properties.
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, String[] providers)` Find users according to a table of name=value properties.
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, String[] providerKeys, JCRSessionWrapper session)`
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, String siteKey, String[] providerKeys, boolean excludeProtected, JCRSessionWrapper session)`
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, String siteKey, String[] providerKeys, JCRSessionWrapper session)`
`Set<JCRUserNode>`	`searchUsers(Properties searchCriterias, String siteKey, String providerKey, boolean excludeProtected, JCRSessionWrapper session)`
`void`	`setCacheHelper(UserCacheHelper userPathCache)`
`void`	`setPasswordService(PasswordService passwordService)`
`void`	`setServletContext(javax.servlet.ServletContext servletContext)`
`void`	`setUserSplittingRule(JahiaUserSplittingRule userSplittingRule)`
`void`	`start()`
`void`	`stop()`
`void`	`unregisterProvider(JahiaUserManagerProvider jahiaUserManagerProvider)` Deprecated.
`void`	`updatePathCacheAdded(String userPath)`
`void`	`updatePathCacheRemoved(String userPath)`
`boolean`	`userExists(String name)` This function checks into the system if the username has already been assigned to another user.
`boolean`	`userExists(String name, String siteKey)`

Methods inherited from class org.jahia.services.JahiaService
getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GUEST_USERNAME
```
public static final String GUEST_USERNAME
```
    Guest user unique identification name. Each usermanager should create this special user, who is assigned automatically for each anonymous session internally in Jahia.
    
    See Also:
    
    Constant Field Values
  - GUEST_USERPATH
```
public static final String GUEST_USERPATH
```
    See Also:
    
    Constant Field Values
  - MULTI_CRITERIA_SEARCH_OPERATION
```
public static final String MULTI_CRITERIA_SEARCH_OPERATION
```
    See Also:
    
    Constant Field Values
  - COUNT_LIMIT
```
public static final String COUNT_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JahiaUserManagerService
```
public JahiaUserManagerService()
```
- Method Detail
  - getInstance
```
public static JahiaUserManagerService getInstance()
```
  - getUserSplittingRule
```
public JahiaUserSplittingRule getUserSplittingRule()
```
  - setUserSplittingRule
```
public void setUserSplittingRule(JahiaUserSplittingRule userSplittingRule)
```
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    setServletContext in interface org.springframework.web.context.ServletContextAware
  - start
```
public void start()
           throws JahiaInitializationException
```
    Specified by:
    
    start in class JahiaService
    
    Throws:
    
    JahiaInitializationException
  - stop
```
public void stop()
          throws JahiaException
```
    Specified by:
    
    stop in class JahiaService
    
    Throws:
    
    JahiaException
  - lookupUserByKey
```
public JCRUserNode lookupUserByKey(String userKey)
```
    Deprecated. use lookupUserByPath() instead
    
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - lookupUserByPath
```
public JCRUserNode lookupUserByPath(String path)
```
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - lookupUserByPath
```
public JCRUserNode lookupUserByPath(String userKey,
                                    JCRSessionWrapper session)
```
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - lookupUser
```
public JCRUserNode lookupUser(String name)
```
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Parameters:
    
    name - User's identification name.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - lookupUser
```
public JCRUserNode lookupUser(String name,
                              String site)
```
  - lookupUser
```
public JCRUserNode lookupUser(String name,
                              String site,
                              boolean checkSiteAndGlobalUsers)
```
  - lookupUser
```
public JCRUserNode lookupUser(String name,
                              JCRSessionWrapper session)
```
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Parameters:
    
    name - User's identification name.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - lookupUser
```
public JCRUserNode lookupUser(String name,
                              String site,
                              JCRSessionWrapper session)
```
    Load all the user data and attributes. On success a reference on the user is returned, otherwise NULL is returned.
    
    Parameters:
    
    name - User's identification name.
    
    Returns:
    
    Return a reference on a new created JCRUserNode object.
  - getUserPath
```
public String getUserPath(String name)
```
  - getUserPath
```
public String getUserPath(String name,
                          String site)
```
  - userExists
```
public boolean userExists(String name)
```
    This function checks into the system if the username has already been assigned to another user.
    
    Parameters:
    
    name - User login name.
    
    Returns:
    
    Return true if the specified username has not been assigned yet, return false on any failure.
  - userExists
```
public boolean userExists(String name,
                          String siteKey)
```
  - getRootUserName
```
public String getRootUserName()
```
    Returns the system root user name (cached)
    
    Returns:
    
    the system root user name (cached)
  - lookupRootUser
```
public JCRUserNode lookupRootUser()
```
    Returns the system root user (not cached).
    
    Returns:
    
    the system root user (not cached)
  - lookupRootUser
```
public JCRUserNode lookupRootUser(JCRSessionWrapper session)
```
    Returns the system root user (not cached).
    
    Returns:
    
    the system root user (not cached)
  - getUserList
```
public List<String> getUserList()
```
    This method return all users' keys in the system.
    
    Returns:
    
    Return a List of strings holding the user identification key .
  - getUserList
```
public List<String> getUserList(String siteKey)
```
  - getUsernameList
```
public List<String> getUsernameList()
```
    This method returns the list of all the user names registered in the system.
    
    Returns:
    
    Return a List of strings holding the user identification names.
  - getUsernameList
```
public List<String> getUsernameList(String siteKey)
```
    This method returns the list of all the user names registered in the system.
    
    Returns:
    
    Return a List of strings holding the user identification names.
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias)
```
    Find users according to a table of name=value properties. If the left side value is "*" for a property then it will be tested against all the properties. ie *=test* will match every property that starts with "test"
    
    Parameters:
    
    searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "username"="*test*") or null to search without criterias
    
    Returns:
    
    a Set of JCRUserNode elements that correspond to those search criterias
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    String[] providers)
```
    Find users according to a table of name=value properties. If the left side value is "*" for a property then it will be tested against all the properties. ie *=test* will match every property that starts with "test"
    
    Parameters:
    
    searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "username"="*test*") or null to search without criterias
    
    Returns:
    
    a Set of JCRUserNode elements that correspond to those search criterias
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    JCRSessionWrapper session)
```
    Find users according to a table of name=value properties. If the left side value is "*" for a property then it will be tested against all the properties. ie *=test* will match every property that starts with "test"
    
    Parameters:
    
    searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "username"="*test*") or null to search without criterias
    
    Returns:
    
    a Set of JCRUserNode elements that correspond to those search criterias
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    String[] providerKeys,
                                    JCRSessionWrapper session)
```
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    String siteKey,
                                    String[] providerKeys,
                                    JCRSessionWrapper session)
```
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    String siteKey,
                                    String[] providerKeys,
                                    boolean excludeProtected,
                                    JCRSessionWrapper session)
```
  - searchUsers
```
public Set<JCRUserNode> searchUsers(Properties searchCriterias,
                                    String siteKey,
                                    String providerKey,
                                    boolean excludeProtected,
                                    JCRSessionWrapper session)
```
  - getProviderList
```
public List<JCRStoreProvider> getProviderList(JCRSessionWrapper session)
```
    Provide the list of all available users providers
    
    Parameters:
    
    session - the session used
    
    Returns:
    
    list of JCRStoreProvider
  - getProviderList
```
public List<JCRStoreProvider> getProviderList(String siteKey,
                                              JCRSessionWrapper session)
```
  - getProviders
```
public List<JCRStoreProvider> getProviders(String[] providerKeys,
                                           JCRSessionWrapper session)
```
    Provide the list of users providers matching given keys
    
    Parameters:
    
    providerKeys - the keys
    
    session - the session used
    
    Returns:
    
    list of JCRStoreProvider
  - getProviders
```
public List<JCRStoreProvider> getProviders(String siteKey,
                                           String[] providerKeys,
                                           JCRSessionWrapper session)
```
  - getProvider
```
public JCRStoreProvider getProvider(String providerKey,
                                    JCRSessionWrapper session)
```
    Retrieve the user provider corresponding to a given key
    
    Parameters:
    
    providerKey - the key
    
    session - the session used
    
    Returns:
    
    JCRStoreProvider if it exist or null
  - getProvider
```
public JCRStoreProvider getProvider(String siteKey,
                                    String providerKey,
                                    JCRSessionWrapper session)
```
  - createUser
```
public JCRUserNode createUser(String name,
                              String password,
                              Properties properties,
                              JCRSessionWrapper session)
```
    This is the method that creates a new user in the system, with all the specified properties.
    
    Parameters:
    
    name - User identification name.
    
    password - User password
    
    properties - User additional parameters. If the user has no additional
    
    session -
  - createUser
```
public JCRUserNode createUser(String name,
                              String siteKey,
                              String password,
                              Properties properties,
                              JCRSessionWrapper session)
```
    This is the method that creates a new user in the system, with all the specified properties.
    
    Parameters:
    
    name - User identification name.
    
    password - User password
    
    properties - User additional parameters. If the user has no additional
    
    session -
  - deleteUser
```
public boolean deleteUser(String userPath,
                          JCRSessionWrapper session)
```
    This method removes a user from the system. All the user's attributes are remove, and also all the related objects belonging to the user. On success, true is returned and the user parameter is not longer valid. Return false on any failure.
    
    Parameters:
    
    userPath - reference on the user to be deleted.
    
    session -
  - isGuest
```
public static boolean isGuest(JCRUserNode user)
```
    Returns true if the specified user is null or a guest user.
    
    Parameters:
    
    user - the user to be tested
    
    Returns:
    
    true if the specified user is null or a guest user
  - isGuest
```
public static boolean isGuest(JahiaUser user)
```
    Returns true if the specified user is null or a guest user.
    
    Parameters:
    
    user - the user to be tested
    
    Returns:
    
    true if the specified user is null or a guest user
  - encryptPassword
```
@Deprecated
public static String encryptPassword(String password)
```
    Deprecated. since 7.1.0.1 use PasswordService.digest(String) instead
    
    Encrypt the specified password using the SHA algorithm.
    
    Parameters:
    
    password - String representation of a password.
    
    Returns:
    
    Return a String representation of the password encryption. Return null on any failure.
  - isUsernameSyntaxCorrect
```
public boolean isUsernameSyntaxCorrect(String name)
```
    Validates provided user name against a regular expression pattern, specified in the Jahia configuration.
    
    Parameters:
    
    name - the user name to be validated
    
    Returns:
    
    true if the specified user name matches the validation pattern
  - initAfterAllServicesAreStarted
```
public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException
```
    Specified by:
    
    initAfterAllServicesAreStarted in interface JahiaAfterInitializationService
    
    Throws:
    
    JahiaInitializationException
  - updatePathCacheAdded
```
public void updatePathCacheAdded(String userPath)
```
  - updatePathCacheRemoved
```
public void updatePathCacheRemoved(String userPath)
```
  - getProviderList
```
@Deprecated
public List<? extends JahiaUserManagerProvider> getProviderList()
```
    Deprecated.
    
    get the list of olds users providers this method is used to maintain compatibility with old users providers
  - getProvider
```
@Deprecated
public JahiaUserManagerProvider getProvider(String key)
```
    Deprecated.
    
    get the provider corresponding to a given key this method is used to maintain compatibility with old users providers
  - registerProvider
```
@Deprecated
public void registerProvider(JahiaUserManagerProvider jahiaUserManagerProvider)
```
    Deprecated.
    
    register a user provider this method is used to maintain compatibility with old users providers
  - unregisterProvider
```
@Deprecated
public void unregisterProvider(JahiaUserManagerProvider jahiaUserManagerProvider)
```
    Deprecated.
    
    unregister a user provider this method is used to maintain compatibility with old users providers
  - setCacheHelper
```
public void setCacheHelper(UserCacheHelper userPathCache)
```
  - clearNonExistingUsersCache
```
public void clearNonExistingUsersCache()
```
    Remove all cache entries for non existing groups
  - lookup
```
public JCRUserNode lookup(String lookupKey)
```
    Performs the lookup of the user, detecting the type of the provided lookup key (either a JCR path, a user name or a legacy user key).
    
    Parameters:
    
    lookupKey - the identifier to lookup the user (can be a JCR path, user name or legacy user key)
    
    Returns:
    
    the corresponding user node or null if no user can be found for the specified key
  - setPasswordService
```
public void setPasswordService(PasswordService passwordService)
```

Class JahiaUserManagerService

Field Summary

Fields inherited from class org.jahia.services.JahiaService

Constructor Summary

Method Summary

Methods inherited from class org.jahia.services.JahiaService

Methods inherited from class java.lang.Object

Field Detail

GUEST_USERNAME

GUEST_USERPATH

MULTI_CRITERIA_SEARCH_OPERATION

COUNT_LIMIT

Constructor Detail

JahiaUserManagerService

Method Detail

getInstance

getUserSplittingRule

setUserSplittingRule

setServletContext

start

stop

lookupUserByKey

lookupUserByPath

lookupUserByPath

lookupUser

lookupUser

lookupUser

lookupUser

lookupUser

getUserPath

getUserPath

userExists

userExists

getRootUserName

lookupRootUser

lookupRootUser

getUserList

getUserList

getUsernameList

getUsernameList

searchUsers

searchUsers

searchUsers

searchUsers

searchUsers

searchUsers

searchUsers

getProviderList

getProviderList

getProviders

getProviders

getProvider

getProvider

createUser

createUser

deleteUser

isGuest

isGuest

encryptPassword

isUsernameSyntaxCorrect

initAfterAllServicesAreStarted

updatePathCacheAdded

updatePathCacheRemoved

getProviderList

getProvider

registerProvider

unregisterProvider

setCacheHelper

clearNonExistingUsersCache

lookup

setPasswordService