org.jahia.api.usermanager

Interface JahiaUserManagerService

All Known Implementing Classes:

JahiaUserManagerService

public interface JahiaUserManagerService

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..)

Method Summary

Modifier and Type	Method and Description
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.
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()
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)
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)

Method Detail

getUserSplittingRule

JahiaUserSplittingRule getUserSplittingRule()

lookupUserByKey

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

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

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

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

JCRUserNode lookupUser(String name,
                       String site)

lookupUser

JCRUserNode lookupUser(String name,
                       String site,
                       boolean checkSiteAndGlobalUsers)

lookupUser

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

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

String getUserPath(String name)

getUserPath

String getUserPath(String name,
                   String site)

userExists

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

boolean userExists(String name,
                   String siteKey)

getRootUserName

String getRootUserName()

Returns the system root user name (cached)

Returns:

the system root user name (cached)

lookupRootUser

JCRUserNode lookupRootUser()

Returns the system root user (not cached).

Returns:

the system root user (not cached)

lookupRootUser

JCRUserNode lookupRootUser(JCRSessionWrapper session)

Returns the system root user (not cached).

Returns:

the system root user (not cached)

getUserList

List<String> getUserList()

This method return all users' keys in the system.

Returns:

Return a List of strings holding the user identification key .

getUserList

List<String> getUserList(String siteKey)

getUsernameList

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

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

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

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

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

Set<JCRUserNode> searchUsers(Properties searchCriterias,
                             String[] providerKeys,
                             JCRSessionWrapper session)

searchUsers

Set<JCRUserNode> searchUsers(Properties searchCriterias,
                             String siteKey,
                             String[] providerKeys,
                             JCRSessionWrapper session)

searchUsers

Set<JCRUserNode> searchUsers(Properties searchCriterias,
                             String siteKey,
                             String[] providerKeys,
                             boolean excludeProtected,
                             JCRSessionWrapper session)

searchUsers

Set<JCRUserNode> searchUsers(Properties searchCriterias,
                             String siteKey,
                             String providerKey,
                             boolean excludeProtected,
                             JCRSessionWrapper session)

getProviderList

List<JCRStoreProvider> getProviderList(JCRSessionWrapper session)

Provide the list of all available users providers

Parameters:

session - the session used

Returns:

list of JCRStoreProvider

getProviderList

List<JCRStoreProvider> getProviderList(String siteKey,
                                       JCRSessionWrapper session)

getProviders

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

List<JCRStoreProvider> getProviders(String siteKey,
                                    String[] providerKeys,
                                    JCRSessionWrapper session)

getProvider

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

JCRStoreProvider getProvider(String siteKey,
                             String providerKey,
                             JCRSessionWrapper session)

createUser

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

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

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 -

isUsernameSyntaxCorrect

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

getProviderList

@Deprecated
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
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
void registerProvider(JahiaUserManagerProvider jahiaUserManagerProvider)

Deprecated.

register a user provider this method is used to maintain compatibility with old users providers

lookup

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