Package 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	Description
protected final UserProviderMapper	mapper	Used to determine what provider is to be used to operate on a particular user.
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.

Constructor Summary

Constructors

Constructor	Description
MappedUserProvider()

Method Summary

Modifier and Type	Method	Description
UserProvider	getUserProvider(String username)
Collection<UserProvider>	getUserProviders()

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

createUser, deleteUser, findUsers, findUsers, getSearchFields, getUserCount, getUsernames, getUsers, getUsers, instantiate, instantiate, instantiate, isEmailRequired, isNameRequired, isReadOnly, loadUser, setCreationDate, setEmail, setModificationDate, setName

Methods inherited from class java.lang.Object

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

Field Details

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 Details

MappedUserProvider

public MappedUserProvider()

Method Details

getUserProviders

public Collection<UserProvider> getUserProviders()

getUserProvider

public UserProvider getUserProvider(String username)