org.jahia.services.usermanager

Class JahiaUserManagerProvider

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.usermanager.JahiaUserManagerProvider

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public abstract class JahiaUserManagerProvider
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 JahiaUserManagerService	userManagerService Deprecated.

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
JahiaUserManagerProvider() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Deprecated.
abstract JahiaUser	createUser(String name, String password, Properties properties) Deprecated. This is the method that creates a new user in the system, with all the specified attributes.
abstract boolean	deleteUser(JahiaUser user) Deprecated. This method removes a user from the system.
void	destroy() Deprecated.
String	getKey() Deprecated.
abstract int	getNbUsers() Deprecated. Return the number of user in the system.
int	getPriority() Deprecated.
abstract List<String>	getUserList() Deprecated. This method return all users' keys in the system.
protected JahiaUserManagerService	getUserManagerService() Deprecated. Returns an instance of the user manager.
abstract List<String>	getUsernameList() Deprecated. This method returns the list of all the user names registed into the system.
boolean	isDefaultProvider() Deprecated.
boolean	isReadOnly() Deprecated.
boolean	isUsernameSyntaxCorrect(String name) Deprecated. Validates provided user name against a regular expression pattern, specified in the Jahia configuration.
abstract boolean	login(String userKey, String userPassword) Deprecated. Performs a login of the specified user.
abstract JahiaUser	lookupUser(String name) Deprecated. Load all the user data and attributes.
abstract JahiaUser	lookupUserByKey(String userKey) Deprecated. Load all the user data and attributes.
abstract Set<JahiaUser>	searchUsers(Properties searchCriterias) Deprecated. Find users according to a table of name=value properties.
void	setDefaultProvider(boolean defaultProvider) Deprecated. There can be only one...
void	setKey(String key) Deprecated.
void	setPriority(int priority) Deprecated.
void	setReadOnly(boolean readOnly) Deprecated.
void	setUserManagerService(JahiaUserManagerService userManagerService) Deprecated. Injects the user management service instance.
abstract void	updateCache(JahiaUser jahiaUser) 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.
abstract boolean	userExists(String name) Deprecated. This function checks into the system if the username has already been assigned to another user.

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

userManagerService

protected JahiaUserManagerService userManagerService

Deprecated.

Constructor Detail

JahiaUserManagerProvider

public JahiaUserManagerProvider()

Deprecated.

Method Detail

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

Deprecated.

Specified by:

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

destroy

public void destroy()
             throws Exception

Deprecated.

Specified by:

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

Throws:

Exception

createUser

public abstract JahiaUser createUser(String name,
                                     String password,
                                     Properties properties)

Deprecated.

This is the method that creates a new user in the system, with all the specified attributes.

Parameters:

password - User password

deleteUser

public abstract boolean deleteUser(JahiaUser user)

Deprecated.

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:

user - reference on the user to be deleted.

getNbUsers

public abstract int getNbUsers()

Deprecated.

Return the number of user in the system.

Returns:

Return the number of users in the system.

getUserList

public abstract List<String> getUserList()

Deprecated.

This method return all users' keys in the system.

Returns:

Return a List of strings holding the user identification key .

getUsernameList

public abstract List<String> getUsernameList()

Deprecated.

This method returns the list of all the user names registed into the system.

Returns:

Return a List of strings holding the user identification names.

login

public abstract boolean login(String userKey,
                              String userPassword)

Deprecated.

Performs a login of the specified user.

Parameters:

userKey - the user identifier defined in this service properties

userPassword - the password of the user

Returns:

boolean true if the login succeeded, false otherwise

isUsernameSyntaxCorrect

public boolean isUsernameSyntaxCorrect(String name)

Deprecated.

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

lookupUserByKey

public abstract JahiaUser lookupUserByKey(String userKey)

Deprecated.

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 jahiaUser object.

lookupUser

public abstract JahiaUser lookupUser(String name)

Deprecated.

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 jahiaUser object.

searchUsers

public abstract Set<JahiaUser> searchUsers(Properties searchCriterias)

Deprecated.

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:

Set a set of JahiaUser elements that correspond to those search criterias

updateCache

public abstract void updateCache(JahiaUser jahiaUser)

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:

jahiaUser - JahiaUser the group to be updated in the cache.

userExists

public abstract boolean userExists(String name)

Deprecated.

This function checks into the system if the username has already been assigned to another user.

Returns:

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

getUserManagerService

protected JahiaUserManagerService getUserManagerService()

Deprecated.

Returns an instance of the user manager.

Returns:

an instance of the user manager

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userManagerService)

Deprecated.

Injects the user management service instance.

Parameters:

userManagerService - an instance of the user management service