Interface UserProviderMapper

  • All Known Implementing Classes:
    AuthorizationBasedUserProviderMapper, PropertyBasedUserProviderMapper

    public interface UserProviderMapper
    Implementations are used to determine what UserProvider is to be used for a particular username. Note that the provided username need not reflect a pre-existing user (the instance might be used to determine in which provider a new user is to be created). Implementation must have a no-argument constructor.
    Author:
    Guus der Kinderen, guus@goodbytes.nl
    See Also:
    MappedUserProvider
    • Method Detail

      • getUserProvider

        UserProvider getUserProvider​(String username)
        Finds a suitable UserProvider for the user. Note that the provided username need not reflect a pre-existing user (the instance might be used to determine in which provider a new user is to be created). Implementations are expected to be able to find a UserProvider for any username. If an implementation fails to do so, such a failure is assumed to be the result of a problem in implementation or configuration.
        Parameters:
        username - A user identifier (cannot be null or empty).
        Returns:
        A UserProvider for the user (never null).
      • getUserProviders

        Set<UserProvider> getUserProviders()
        Returns all providers that are used by this instance. The returned collection should have a consistent, predictable iteration order.
        Returns:
        all providers (never null).