org.jahia.services.usermanager

Class JahiaGroupManagerService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.usermanager.JahiaGroupManagerService

public class JahiaGroupManagerService
extends JahiaService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINISTRATORS_GROUPNAME
static String	GUEST_GROUPNAME
static String	GUEST_GROUPPATH
static Set<String>	POWERFUL_GROUPS
static String	PRIVILEGED_GROUPNAME
static Set<String>	PROTECTED_GROUPS
static String	SITE_ADMINISTRATORS_GROUPNAME
static String	SITE_PRIVILEGED_GROUPNAME
static String	SITE_USERS_GROUPNAME
static String	USERS_GROUPNAME
static String	USERS_GROUPPATH

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JahiaGroupManagerService()

Method Summary

Modifier and Type	Method and Description
void	clearNonExistingGroupsCache() Remove all cache entries for non existing groups
JCRGroupNode	createGroup(String siteKey, String name, Properties properties, boolean hidden, JCRSessionWrapper session) Create a new group in the system.
boolean	deleteGroup(String groupPath, JCRSessionWrapper session) Delete a group from the system.
void	flushMembershipCache(String memberPath, JCRSessionWrapper session)
JCRGroupNode	getAdministratorGroup(String siteKey) Get administrator or site administrator group
JCRGroupNode	getAdministratorGroup(String siteKey, JCRSessionWrapper session) Get administrator or site administrator group
List<String>	getGroupList() Return a ListString representing all the group keys in the system.
List<String>	getGroupList(String siteKey) Return a ListString representing all the group keys of a site.
List<String>	getGroupnameList() Return a ListString representing all the group names.
String	getGroupPath(String siteKey, String name)
static JahiaGroupManagerService	getInstance()
List<String>	getMembershipByPath(String principalPath) Return the list of groups to which the specified user has access.
JahiaGroupManagerProvider	getProvider(String key) Deprecated.
JCRStoreProvider	getProvider(String siteKey, String providerKey, JCRSessionWrapper session) Retrieve the group provider corresponding to a given key
List<? extends JahiaGroupManagerProvider>	getProviderList() Deprecated.
List<JCRStoreProvider>	getProviderList(String siteKey, JCRSessionWrapper session) Provide the list of all available groups providers
List<JCRStoreProvider>	getProviders(String siteKey, String[] providerKeys, JCRSessionWrapper session) Provide the list of groups providers matching given keys
List<String>	getUserMembership(String userName, String site)
boolean	groupExists(String siteKey, String name) This function checks on a gived site if the group name has already been assigned to another group.
boolean	isAdminMember(String username, String siteKey)
boolean	isAdminMember(String username, String userSite, String siteKey)
boolean	isGroupNameSyntaxCorrect(String name) Validates provided group name against a regular expression pattern, specified in the Jahia configuration.
boolean	isMember(String username, String groupname, String groupSite)
boolean	isMember(String username, String userSite, String groupname, String groupSite)
JCRGroupNode	lookupGroup(String groupPath) Deprecated. use lookupGroupByPath() instead
JCRGroupNode	lookupGroup(String siteKey, String name) Lookup the group information from the underlaying system (DB, LDAP, ...
JCRGroupNode	lookupGroup(String siteKey, String name, JCRSessionWrapper session) Lookup the group information from the underlaying system (DB, LDAP, ...
JCRGroupNode	lookupGroupByPath(String groupPath) Lookup the group information from the underlying system (DB, LDAP, ...
JCRGroupNode	lookupGroupByPath(String groupPath, JCRSessionWrapper session) Lookup the group information from the underlaying system (DB, LDAP, ...
void	registerProvider(JahiaGroupManagerProvider jahiaGroupManagerProvider) Deprecated.
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias) Find groups according to a table of name=value properties.
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias, JCRSessionWrapper session) Find groups according to a table of name=value properties.
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias, String[] providers) Find groups according to a table of name=value properties.
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias, String[] providers, boolean excludeProtected, JCRSessionWrapper session)
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias, String[] providers, JCRSessionWrapper session) Find groups according to a table of name=value properties.
Set<JCRGroupNode>	searchGroups(String siteKey, Properties searchCriterias, String providerKey, boolean excludeProtected, JCRSessionWrapper session)
void	setCacheHelper(GroupCacheHelper cacheHelper)
void	setUserManagerService(JahiaUserManagerService userManagerService)
void	start()
void	stop()
void	unregisterProvider(JahiaGroupManagerProvider jahiaGroupManagerProvider) Deprecated.
void	updatePathCacheAdded(String groupPath)
void	updatePathCacheRemoved(String groupPath)

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

USERS_GROUPNAME

public static final String USERS_GROUPNAME

See Also:

Constant Field Values

SITE_USERS_GROUPNAME

public static final String SITE_USERS_GROUPNAME

See Also:

Constant Field Values

ADMINISTRATORS_GROUPNAME

public static final String ADMINISTRATORS_GROUPNAME

See Also:

Constant Field Values

PRIVILEGED_GROUPNAME

public static final String PRIVILEGED_GROUPNAME

See Also:

Constant Field Values

SITE_PRIVILEGED_GROUPNAME

public static final String SITE_PRIVILEGED_GROUPNAME

See Also:

Constant Field Values

SITE_ADMINISTRATORS_GROUPNAME

public static final String SITE_ADMINISTRATORS_GROUPNAME

See Also:

Constant Field Values

GUEST_GROUPNAME

public static final String GUEST_GROUPNAME

See Also:

Constant Field Values

GUEST_GROUPPATH

public static final String GUEST_GROUPPATH

See Also:

Constant Field Values

USERS_GROUPPATH

public static final String USERS_GROUPPATH

See Also:

Constant Field Values

POWERFUL_GROUPS

public static final Set<String> POWERFUL_GROUPS

PROTECTED_GROUPS

public static final Set<String> PROTECTED_GROUPS

Constructor Detail

JahiaGroupManagerService

public JahiaGroupManagerService()

Method Detail

getInstance

public static JahiaGroupManagerService getInstance()

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userManagerService)

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

lookupGroup

public JCRGroupNode lookupGroup(String groupPath)

Deprecated. use lookupGroupByPath() instead

lookupGroupByPath

public JCRGroupNode lookupGroupByPath(String groupPath)

Lookup the group information from the underlying system (DB, LDAP, ... ) Try to lookup the group into the cache, if it's not in the cache, then load it into the cache from the database.

Parameters:

groupPath - Group's path

Returns:

Return a reference on a the specified group name. Return null if the group doesn't exist or when any error occurred.

lookupGroupByPath

public JCRGroupNode lookupGroupByPath(String groupPath,
                                      JCRSessionWrapper session)

Lookup the group information from the underlaying system (DB, LDAP, ... ) Try to lookup the group into the cache, if it's not in the cache, then load it into the cahce from the database.

Parameters:

groupPath - Group's path

Returns:

Return a reference on a the specified group name. Return null if the group doesn't exist or when any error occurred.

lookupGroup

public JCRGroupNode lookupGroup(String siteKey,
                                String name)

Lookup the group information from the underlaying system (DB, LDAP, ... ) Try to lookup the group into the cache, if it's not in the cache, then load it into the cahce from the database.

Parameters:

siteKey - siteKey the site id

name - Group's unique identification name.

Returns:

Return a reference on a the specified group name. Return null if the group doesn't exist or when any error occured.

lookupGroup

public JCRGroupNode lookupGroup(String siteKey,
                                String name,
                                JCRSessionWrapper session)

Lookup the group information from the underlaying system (DB, LDAP, ... ) Try to lookup the group into the cache, if it's not in the cache, then load it into the cahce from the database.

Parameters:

siteKey - siteKey the site id

name - Group's unique identification name.

Returns:

Return a reference on a the specified group name. Return null if the group doesn't exist or when any error occured.

getGroupPath

public String getGroupPath(String siteKey,
                           String name)

groupExists

public boolean groupExists(String siteKey,
                           String name)

This function checks on a gived site if the group name has already been assigned to another group.

Parameters:

siteKey - siteKey the site key

name - String representing the unique group name.

Returns:

Return true if the specified group name has not been assigned yet, return false on any failure.

getAdministratorGroup

public JCRGroupNode getAdministratorGroup(String siteKey)
                                   throws javax.jcr.RepositoryException

Get administrator or site administrator group

Throws:

javax.jcr.RepositoryException

getAdministratorGroup

public JCRGroupNode getAdministratorGroup(String siteKey,
                                          JCRSessionWrapper session)
                                   throws javax.jcr.RepositoryException

Get administrator or site administrator group

Throws:

javax.jcr.RepositoryException

getGroupList

public List<String> getGroupList()

Return a ListString representing all the group keys in the system.

Returns:

Return a List of identifier of all groups of this system.

getGroupList

public List<String> getGroupList(String siteKey)

Return a ListString representing all the group keys of a site.

Parameters:

siteKey - the key of the site from which you wish to retrieve the list of group

Returns:

Return a List of identifier of all groups of this site.

getGroupnameList

public List<String> getGroupnameList()

Return a ListString representing all the group names.

Returns:

Return a List of strings containing all the group names.

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias)

Find groups 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:

siteKey - site identifier

searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "groupname"="*test*") or null to search without criterias

Returns:

a Set of JCRGroupNode elements that correspond to those search criterias

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias,
                                      String[] providers)

Find groups 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:

siteKey - site identifier

searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "groupname"="*test*") or null to search without criterias

providers - the providers key to search on

Returns:

a Set of JCRGroupNode elements that correspond to those search criterias

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias,
                                      JCRSessionWrapper session)

Find groups 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:

siteKey - site identifier

searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "groupname"="*test*") or null to search without criterias

Returns:

a Set of JCRGroupNode elements that correspond to those search criterias

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias,
                                      String[] providers,
                                      JCRSessionWrapper session)

Find groups 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:

siteKey - site identifier

searchCriterias - a Properties object that contains search criterias in the format name,value (for example "*"="*" or "groupname"="*test*") or null to search without criterias

providers - the providers key to search on

Returns:

a Set of JCRGroupNode elements that correspond to those search criterias

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias,
                                      String[] providers,
                                      boolean excludeProtected,
                                      JCRSessionWrapper session)

searchGroups

public Set<JCRGroupNode> searchGroups(String siteKey,
                                      Properties searchCriterias,
                                      String providerKey,
                                      boolean excludeProtected,
                                      JCRSessionWrapper session)

getProviderList

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

Provide the list of all available groups providers

Parameters:

siteKey - the site to lookup on, if provided lookup under /sites/{siteKey}/groups/providers else the lookup is made under /groups/providers)

session - the session used

Returns:

list of JCRStoreProvider

getProviders

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

Provide the list of groups providers matching given keys

Parameters:

siteKey - the site to lookup on, if provided lookup under /sites/{siteKey}/groups/providers else the lookup is made under /groups/providers)

providerKeys - the keys

session - the session used

Returns:

list of JCRStoreProvider

getProvider

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

Retrieve the group provider corresponding to a given key

Parameters:

siteKey - the site to lookup on, if provided lookup under /sites/{siteKey}/groups/providers else the lookup is made under /groups/providers)

providerKey - the key

session - the session used

Returns:

JCRStoreProvider if it exist or null

getUserMembership

public List<String> getUserMembership(String userName,
                                      String site)

isMember

public boolean isMember(String username,
                        String groupname,
                        String groupSite)

isMember

public boolean isMember(String username,
                        String userSite,
                        String groupname,
                        String groupSite)

isAdminMember

public boolean isAdminMember(String username,
                             String siteKey)

isAdminMember

public boolean isAdminMember(String username,
                             String userSite,
                             String siteKey)

createGroup

public JCRGroupNode createGroup(String siteKey,
                                String name,
                                Properties properties,
                                boolean hidden,
                                JCRSessionWrapper session)

Create a new group in the system.

Parameters:

hidden -

Returns:

a reference on a group object on success, or if the groupname already exists or another error occured, null is returned.

deleteGroup

public boolean deleteGroup(String groupPath,
                           JCRSessionWrapper session)

Delete a group from the system. Updates the database automatically, and signal the ACL Manager that the group no longer exists.

Parameters:

groupPath - Path of the group to delete

Returns:

Return true on success, or false on any failure.

isGroupNameSyntaxCorrect

public boolean isGroupNameSyntaxCorrect(String name)

Validates provided group name against a regular expression pattern, specified in the Jahia configuration.

Parameters:

name - the group name to be validated

Returns:

true if the specified group name matches the validation pattern

flushMembershipCache

public void flushMembershipCache(String memberPath,
                                 JCRSessionWrapper session)

updatePathCacheAdded

public void updatePathCacheAdded(String groupPath)

updatePathCacheRemoved

public void updatePathCacheRemoved(String groupPath)

getProviderList

@Deprecated
public List<? extends JahiaGroupManagerProvider> getProviderList()

Deprecated.

get the list of olds group providers this method is used to maintain compatibility with old groups providers

getProvider

@Deprecated
public JahiaGroupManagerProvider getProvider(String key)

Deprecated.

get the provider corresponding to a given key this method is used to maintain compatibility with old groups providers

registerProvider

@Deprecated
public void registerProvider(JahiaGroupManagerProvider jahiaGroupManagerProvider)

Deprecated.

register a group provider this method is used to maintain compatibility with old groups providers

unregisterProvider

@Deprecated
public void unregisterProvider(JahiaGroupManagerProvider jahiaGroupManagerProvider)

Deprecated.

unregister a group provider this method is used to maintain compatibility with old groups providers

setCacheHelper

public void setCacheHelper(GroupCacheHelper cacheHelper)

clearNonExistingGroupsCache

public void clearNonExistingGroupsCache()

Remove all cache entries for non existing groups

getMembershipByPath

public List<String> getMembershipByPath(String principalPath)

Return the list of groups to which the specified user has access.

Parameters:

principalPath - The user/group path

Returns:

Return a List of strings holding all the group path to which the user as access.