Package org.jivesoftware.openfire.group
Interface GroupProviderMapper
public interface GroupProviderMapper
Implementations are used to determine what GroupProvider is to be used for a particular group name.
Note that the provided group name need not reflect a pre-existing group (the instance might be used to determine in
which provider a new group is to be created).
Implementation must have a no-argument constructor.
- Author:
- Guus der Kinderen, guus@goodbytes.nl
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetGroupProvider
(String groupname) Finds a suitable GroupProvider for the group.Returns all providers that are used by this instance.
-
Method Details
-
getGroupProvider
Finds a suitable GroupProvider for the group. Note that the provided group name need not reflect a pre-existing group (the instance might be used to determine in which provider a new group is to be created). Implementations are expected to be able to find a GroupProvider for any group name. If an implementation fails to do so, such a failure is assumed to be the result of a problem in implementation or configuration.- Parameters:
groupname
- A group identifier (cannot be null or empty).- Returns:
- A GroupProvider for the group (never null).
-
getGroupProviders
Set<GroupProvider> getGroupProviders()Returns all providers that are used by this instance. The returned collection should have a consistent, predictable iteration order.- Returns:
- all providers (never null).
-