Package org.jivesoftware.openfire.auth
Interface AuthProviderMapper
- All Known Implementing Classes:
AuthorizationBasedAuthProviderMapper
,PropertyBasedAuthProviderMapper
public interface AuthProviderMapper
Implementations are used to determine what AuthProvider is to be used for a particular username.
Implementation must have a no-argument constructor.
- Author:
- Guus der Kinderen, guus@goodbytes.nl
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetAuthProvider
(String username) Finds a suitable AuthProvider for the user.Returns all providers that are used by this instance.
-
Method Details
-
getAuthProvider
Finds a suitable AuthProvider for the user. Returns null when no AuthProvider can be found for the particular user.- Parameters:
username
- A user identifier (cannot be null or empty).- Returns:
- An AuthProvider for the user (possibly null).
-
getAuthProviders
Set<AuthProvider> getAuthProviders()Returns all providers that are used by this instance. The returned collection should have a consistent, predictable iteration order.- Returns:
- all providers (never null).
-