com.jivesoftware.base
Interface AdvancedUserManager

public interface AdvancedUserManager

An advanced user manager which currently has a single method to retrieve a user from a given email address.

See Also:

User

Method Summary

User	getUserFromEmailAddress(java.lang.String email) Returns a user object corresponding to the email address given.
java.util.Iterator	getUsersFromEmailAddress(java.lang.String email) Returns an iterator of user objects corresponding to the email address given.

Method Detail

getUserFromEmailAddress

User getUserFromEmailAddress(java.lang.String email)

Returns a user object corresponding to the email address given. If no user is found which corresponds to the given email address null should be returned. If more than one user corresponds to the given email address it is up to the implementation to decide what to do (i.e. return one of the users or return null).

Parameters:

email - the email address to get a user object for.

Returns:

a user object corresponding to the given email address.

getUsersFromEmailAddress

java.util.Iterator getUsersFromEmailAddress(java.lang.String email)

Returns an iterator of user objects corresponding to the email address given. There is not a uniqueness contraint on the email id ofr a user object, so multiples may be returned. If no users are found which correspond to the given email address, an empty iterator should be returned.

Parameters:

email - the email address to get a user object for.

Returns:

an iterator of user objects corresponding to the given email address.