Package org.jivesoftware.openfire.group

Class MappedGroupProvider

java.lang.Object

org.jivesoftware.openfire.group.GroupMultiProvider

org.jivesoftware.openfire.group.MappedGroupProvider

All Implemented Interfaces:

GroupProvider

public class MappedGroupProvider
extends GroupMultiProvider

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

• provider.group.className = org.jivesoftware.openfire.group.MappedGroupProvider

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

Author:

Guus der Kinderen, guus@goodbytes.nl

See Also:

• GroupProviderMapper

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
MappedGroupProvider()

Method Summary

Modifier and Type	Method	Description
GroupProvider	getGroupProvider(String groupname)
Collection<GroupProvider>	getGroupProviders()

Methods inherited from class org.jivesoftware.openfire.group.GroupMultiProvider

addMember, createGroup, deleteGroup, deleteMember, getGroup, getGroupCount, getGroupNames, getGroupNames, getGroupNames, getPublicSharedGroupNames, getSharedGroupNames, getSharedGroupNames, getVisibleGroupNames, instantiate, instantiate, isReadOnly, isSearchSupported, isSharingSupported, loadProperties, search, search, search, setDescription, setName, updateMember

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 GroupProviderMapper instance to be used by instances of this class.

See Also:

• Constant Field Values

mapper

protected final GroupProviderMapper mapper

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

Constructor Details

MappedGroupProvider

public MappedGroupProvider()

Method Details

getGroupProviders

public Collection<GroupProvider> getGroupProviders()

getGroupProvider

public GroupProvider getGroupProvider(String groupname)