Class MappedUserPropertyProvider

java.lang.Object
org.jivesoftware.openfire.user.property.UserPropertyMultiProvider
org.jivesoftware.openfire.user.property.MappedUserPropertyProvider
All Implemented Interfaces:
UserPropertyProvider

public class MappedUserPropertyProvider extends UserPropertyMultiProvider
A UserPropertyProvider that delegates to a user-specific UserPropertyProvider. This implementation will explicitly verify if a user exists, when operating on its properties, but only if the corresponding mapped provider does so. If that is the case, then the methods of this implementation will throw UserNotFoundException. This class related to, but is distinct from HybridUserPropertyProvider. 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.userproperty.className = org.jivesoftware.openfire.user.MappedUserPropertyProvider
To be usable, a UserPropertyProviderMapper must be configured using the mappedUserPropertyProvider.mapper.className system property. It is of importance to note that most UserPropertyProviderMapper implementations will require additional configuration.
Author:
Guus der Kinderen, guus@goodbytes.nl
  • 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 UserPropertyProviderMapper instance to be used by instances of this class.
      See Also:
    • mapper

      protected final UserPropertyProviderMapper mapper
      Used to determine what provider is to be used to operate on a particular user.
  • Constructor Details

    • MappedUserPropertyProvider

      public MappedUserPropertyProvider()