Package org.jivesoftware.openfire.user

Class HybridUserProvider

java.lang.Object

org.jivesoftware.openfire.user.UserMultiProvider

org.jivesoftware.openfire.user.HybridUserProvider

All Implemented Interfaces:

UserProvider

public class HybridUserProvider
extends UserMultiProvider

Delegate UserProvider operations among up to three configurable provider implementation classes. This class related to, but is distinct from MappedUserProvider. The Hybrid variant of the provider iterates over providers, operating on the first applicable instance. The Mapped variant, however, maps each user to exactly one provider.

Author:

Marc Seeger, Chris Neasbitt, Tom Evans, Guus der Kinderen

Field Summary

Fields

Modifier and Type	Field	Description
static final SystemProperty<Class>	PRIMARY_PROVIDER
static final SystemProperty<String>	PRIMARY_PROVIDER_CONFIG
static final SystemProperty<Class>	SECONDARY_PROVIDER
static final SystemProperty<String>	SECONDARY_PROVIDER_CONFIG
static final SystemProperty<Class>	TERTIARY_PROVIDER
static final SystemProperty<String>	TERTIARY_PROVIDER_CONFIG

Constructor Summary

Constructors

Constructor	Description
HybridUserProvider()

Method Summary

Modifier and Type	Method	Description
UserProvider	getUserProvider(String username)	Returns the first provider that contains the user, or the first provider that is not read-only when the user does not exist in any provider.
protected List<UserProvider>	getUserProviders()
User	loadUser(String username)	Loads a user from the first provider that contains the user.

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

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

Methods inherited from class java.lang.Object

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

Field Details

PRIMARY_PROVIDER

public static final SystemProperty<Class> PRIMARY_PROVIDER

PRIMARY_PROVIDER_CONFIG

public static final SystemProperty<String> PRIMARY_PROVIDER_CONFIG

SECONDARY_PROVIDER

public static final SystemProperty<Class> SECONDARY_PROVIDER

SECONDARY_PROVIDER_CONFIG

public static final SystemProperty<String> SECONDARY_PROVIDER_CONFIG

TERTIARY_PROVIDER

public static final SystemProperty<Class> TERTIARY_PROVIDER

TERTIARY_PROVIDER_CONFIG

public static final SystemProperty<String> TERTIARY_PROVIDER_CONFIG

Constructor Details

HybridUserProvider

public HybridUserProvider()

Method Details

getUserProviders

protected List<UserProvider> getUserProviders()

getUserProvider

public UserProvider getUserProvider(String username)

Returns the first provider that contains the user, or the first provider that is not read-only when the user does not exist in any provider.

Parameters:

username - the username (cannot be null or empty).

Returns:

The user provider (never null)

loadUser

public User loadUser(String username)
              throws UserNotFoundException

Loads a user from the first provider that contains the user.

Specified by:

loadUser in interface UserProvider

Overrides:

loadUser in class UserMultiProvider

Parameters:

username - the username (cannot be null or empty).

Returns:

The user (never null).

Throws:

UserNotFoundException - When none of the providers contains the user.