org.jivesoftware.openfire.user

Class MappedUserProvider

java.lang.Object

org.jivesoftware.openfire.user.UserMultiProvider

org.jivesoftware.openfire.user.MappedUserProvider

All Implemented Interfaces:

UserProvider

public class MappedUserProvider
extends UserMultiProvider

A UserProvider that delegates to a user-specific UserProvider. This class related to, but is distinct from HybridUserProvider. The Hybrid variant of the provider iterates over providers, operating on the first applicable instance. This Mapped variant, however, maps each user to exactly one provider. To use this provider, use the following system property definition:

• provider.user.className = org.jivesoftware.openfire.user.MappedUserProvider

To be usable, a UserProviderMapper must be configured using the mappedUserProvider.mapper.className system property. It is of importance to note that most UserProviderMapper implementations will require additional configuration.

Author:

Guus der Kinderen, guus@goodbytes.nl

See Also:

MappedAuthProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected UserProviderMapper	mapper Used to determine what provider is to be used to operate on a particular user.
static String	PROPERTY_MAPPER_CLASSNAME Name of the property of which the value is expected to be the classname of the UserProviderMapper instance to be used by instances of this class.

Constructor Summary

Constructors

Constructor and Description
MappedUserProvider()

Method Summary

Modifier and Type	Method and Description
User	createUser(String username, String password, String name, String email) Creates a new user.
void	deleteUser(String username) Delets a user.
UserProvider	getUserProvider(String username) Returns the 'backing' provider that serves the provided user.
Collection<UserProvider>	getUserProviders() Returns all UserProvider instances that serve as 'backing' providers.
User	loadUser(String username) Loads the specified user by username.
void	setCreationDate(String username, Date creationDate) Sets the date the user was created.
void	setEmail(String username, String email) Sets the user's email address.
void	setModificationDate(String username, Date modificationDate) Sets the date the user was last modified.
void	setName(String username, String name) Sets the user's name.

Methods inherited from class org.jivesoftware.openfire.user.UserMultiProvider

findUsers, findUsers, getSearchFields, getUserCount, getUsernames, getUsers, getUsers, instantiate, isEmailRequired, isNameRequired, isReadOnly

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_MAPPER_CLASSNAME

public static final String PROPERTY_MAPPER_CLASSNAME

Name of the property of which the value is expected to be the classname of the UserProviderMapper instance to be used by instances of this class.

See Also:

Constant Field Values

mapper

protected final UserProviderMapper mapper

Used to determine what provider is to be used to operate on a particular user.

Constructor Detail

MappedUserProvider

public MappedUserProvider()

Method Detail

getUserProviders

public Collection<UserProvider> getUserProviders()

Description copied from class: UserMultiProvider

Returns all UserProvider instances that serve as 'backing' providers.

Returns:

A collection of providers (never null).

getUserProvider

public UserProvider getUserProvider(String username)

Description copied from class: UserMultiProvider

Returns the 'backing' provider that serves the provided user. Note that the user need not exist. Finds a suitable UserProvider for the user. Note that the provided username need not reflect a pre-existing user (the instance might be used to determine in which provider a new user is to be created). Implementations are expected to be able to find a UserProvider for any username. If an implementation fails to do so, such a failure is assumed to be the result of a problem in implementation or configuration.

Parameters:

username - A user identifier (cannot be null or empty).

Returns:

A UserProvider for the user (never null).

loadUser

public User loadUser(String username)
              throws UserNotFoundException

Description copied from interface: UserProvider

Loads the specified user by username.

Parameters:

username - the username

Returns:

the User.

Throws:

UserNotFoundException - if the User could not be loaded.

createUser

public User createUser(String username,
                       String password,
                       String name,
                       String email)
                throws UserAlreadyExistsException

Description copied from interface: UserProvider

Creates a new user. This method should throw an UnsupportedOperationException if this operation is not supporte by the backend user store.

Parameters:

username - the username.

password - the plain-text password.

name - the user's name, which can be null, unless isNameRequired is set to true.

email - the user's email address, which can be null, unless isEmailRequired is set to true.

Returns:

a new User.

Throws:

UserAlreadyExistsException - if the username is already in use.

deleteUser

public void deleteUser(String username)

Description copied from interface: UserProvider

Delets a user. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username to delete.

setName

public void setName(String username,
                    String name)
             throws UserNotFoundException

Description copied from interface: UserProvider

Sets the user's name. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username.

name - the name.

Throws:

UserNotFoundException - if the user could not be found.

setEmail

public void setEmail(String username,
                     String email)
              throws UserNotFoundException

Description copied from interface: UserProvider

Sets the user's email address. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username.

email - the email address.

Throws:

UserNotFoundException - if the user could not be found.

setCreationDate

public void setCreationDate(String username,
                            Date creationDate)
                     throws UserNotFoundException

Description copied from interface: UserProvider

Sets the date the user was created. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username.

creationDate - the date the user was created.

Throws:

UserNotFoundException - if the user could not be found.

setModificationDate

public void setModificationDate(String username,
                                Date modificationDate)
                         throws UserNotFoundException

Description copied from interface: UserProvider

Sets the date the user was last modified. This method should throw an UnsupportedOperationException if this operation is not supported by the backend user store.

Parameters:

username - the username.

modificationDate - the date the user was last modified.

Throws:

UserNotFoundException - if the user could not be found.