org.jahia.services.usermanager

Class JahiaGroupManagerProvider

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.usermanager.JahiaGroupManagerProvider

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

Deprecated.

@Deprecated
public abstract class JahiaGroupManagerProvider
extends JahiaService
implements org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

This class is keep to maintain compatibility with olds users/groups providers

Author:

kevan

Field Summary

Fields

Modifier and Type	Field and Description
protected JahiaGroupManagerService	groupManagerService Deprecated.

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JahiaGroupManagerProvider() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Deprecated.
abstract JahiaGroup	createGroup(int siteID, String name, Properties properties, boolean hidden) Deprecated. Create a new group in the system.
abstract boolean	deleteGroup(JahiaGroup g) Deprecated.
void	destroy() Deprecated.
void	flushCache() Deprecated.
abstract List<JahiaSite>	getAdminGrantedSites(JahiaUser user) Deprecated. Get all JahiaSite objects where the user has an access.
abstract JahiaGroup	getAdministratorGroup(int siteID) Deprecated.
abstract List<String>	getGroupList() Deprecated. Return a ListString representing all the group keys of a site.
abstract List<String>	getGroupList(int siteID) Deprecated. Return a ListString representing all the group keys of a site.
protected JahiaGroupManagerService	getGroupManagerService() Deprecated. Returns an instance of the group manager.
abstract List<String>	getGroupnameList() Deprecated. Return a ListString representing all the group names.
abstract List<String>	getGroupnameList(int siteID) Deprecated. Return a ListString representing all the group names of a site.
protected static Pattern	getGroupNamePattern() Deprecated.
abstract JahiaGroup	getGuestGroup(int siteID) Deprecated. Return an instance of the guest group
String	getKey() Deprecated.
int	getPriority() Deprecated.
abstract List<String>	getUserMembership(JahiaUser user) Deprecated. Return the list of groups to which the specified user has access.
abstract JahiaGroup	getUsersGroup(int siteID) Deprecated. Return an instance of the users group.
abstract boolean	groupExists(int siteID, String name) Deprecated. This function checks on a given site if the groupname has already been assigned to another group.
boolean	isDefaultProvider() Deprecated.
boolean	isGroupNameSyntaxCorrect(String name) Deprecated. Validates provided group name against a regular expression pattern, specified in the Jahia configuration.
boolean	isReadOnly() Deprecated.
abstract JahiaGroup	lookupGroup(int siteID, String name) Deprecated. Lookup the group information from the underlying system (DB, LDAP, ...
abstract JahiaGroup	lookupGroup(String groupKey) Deprecated. Lookup the group information from the underlying system (DB, LDAP, ...
abstract boolean	removeUserFromAllGroups(JahiaUser user) Deprecated. Remove the specified user from all the membership lists of all the groups.
abstract Set<JahiaGroup>	searchGroups(int siteID, Properties searchCriterias) Deprecated.
void	setDefaultProvider(boolean defaultProvider) Deprecated. There can be only one...
void	setGroupManagerService(JahiaGroupManagerService groupManagerService) Deprecated. Injects the group management service instance.
void	setKey(String key) Deprecated.
void	setPriority(int priority) Deprecated.
void	setReadOnly(boolean readOnly) Deprecated.
abstract void	updateCache(JahiaGroup jahiaGroup) Deprecated. This method indicates that any internal cache for a provider should be updated because the value has changed and needs to be transmitted to the other nodes in a clustering environment.

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groupManagerService

protected JahiaGroupManagerService groupManagerService

Deprecated.

Constructor Detail

JahiaGroupManagerProvider

public JahiaGroupManagerProvider()

Deprecated.

Method Detail

getGroupNamePattern

protected static Pattern getGroupNamePattern()

Deprecated.

isGroupNameSyntaxCorrect

public boolean isGroupNameSyntaxCorrect(String name)

Deprecated.

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

getKey

public String getKey()

Deprecated.

setKey

public void setKey(String key)

Deprecated.

getPriority

public int getPriority()

Deprecated.

setPriority

public void setPriority(int priority)

Deprecated.

isDefaultProvider

public boolean isDefaultProvider()

Deprecated.

setDefaultProvider

public void setDefaultProvider(boolean defaultProvider)

Deprecated.

There can be only one... default provider

Parameters:

defaultProvider -

isReadOnly

public boolean isReadOnly()

Deprecated.

setReadOnly

public void setReadOnly(boolean readOnly)

Deprecated.

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Deprecated.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

destroy

public void destroy()

Deprecated.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

createGroup

public abstract JahiaGroup createGroup(int siteID,
                                       String name,
                                       Properties properties,
                                       boolean hidden)

Deprecated.

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 abstract boolean deleteGroup(JahiaGroup g)

Deprecated.

getAdminGrantedSites

public abstract List<JahiaSite> getAdminGrantedSites(JahiaUser user)

Deprecated.

Get all JahiaSite objects where the user has an access.

Parameters:

user, - the user you want to get his access grants sites list.

Returns:

Return a List containing all JahiaSite objects where the user has an access.

getAdministratorGroup

public abstract JahiaGroup getAdministratorGroup(int siteID)

Deprecated.

getGroupList

public abstract List<String> getGroupList()

Deprecated.

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

Returns:

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

getGroupList

public abstract List<String> getGroupList(int siteID)

Deprecated.

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

Returns:

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

getGroupnameList

public abstract List<String> getGroupnameList()

Deprecated.

Return a ListString representing all the group names.

Returns:

Return a List of strings containing all the group names.

getGroupnameList

public abstract List<String> getGroupnameList(int siteID)

Deprecated.

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

Returns:

Return a List of strings containing all the group names.

getGuestGroup

public abstract JahiaGroup getGuestGroup(int siteID)

Deprecated.

Return an instance of the guest group

Returns:

Return the instance of the guest group. Return null on any failure.

getUserMembership

public abstract List<String> getUserMembership(JahiaUser user)

Deprecated.

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

Parameters:

user - Valid reference on an existing group.

Returns:

Return a List of strings holding all the group names to which the user as access. On any error, the returned List might be null.

getUsersGroup

public abstract JahiaGroup getUsersGroup(int siteID)

Deprecated.

Return an instance of the users group.

Returns:

Return the instance of the users group. Return null on any failure

groupExists

public abstract boolean groupExists(int siteID,
                                    String name)

Deprecated.

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

Parameters:

siteID - siteID the site id

name - String representing the unique group name.

Returns:

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

lookupGroup

public abstract JahiaGroup lookupGroup(String groupKey)

Deprecated.

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:

groupKey - Group's unique identification key.

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 abstract JahiaGroup lookupGroup(int siteID,
                                       String name)

Deprecated.

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:

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

removeUserFromAllGroups

public abstract boolean removeUserFromAllGroups(JahiaUser user)

Deprecated.

Remove the specified user from all the membership lists of all the groups.

Parameters:

user - Reference on an existing user.

Returns:

Return true on success, or false on any failure.

searchGroups

public abstract Set<JahiaGroup> searchGroups(int siteID,
                                             Properties searchCriterias)

Deprecated.

updateCache

public abstract void updateCache(JahiaGroup jahiaGroup)

Deprecated.

This method indicates that any internal cache for a provider should be updated because the value has changed and needs to be transmitted to the other nodes in a clustering environment.

Parameters:

jahiaGroup - JahiaGroup the group to be updated in the cache.

getGroupManagerService

protected JahiaGroupManagerService getGroupManagerService()

Deprecated.

Returns an instance of the group manager.

Returns:

an instance of the group manager

setGroupManagerService

public void setGroupManagerService(JahiaGroupManagerService groupManagerService)

Deprecated.

Injects the group management service instance.

Parameters:

groupManagerService - an instance of the group management service

flushCache

public void flushCache()

Deprecated.