Package com.iizix.user
Interface IAuthenticatedUserProvider
- All Known Implementing Classes:
UserAuthentication
public interface IAuthenticatedUserProvider
Provider interface to retrieve an authenticated user for a client or application session.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IAuthenticatedUser
getUser(long id)
Gets the basic user info for a user from its unique user ID.IAuthenticatedUser
getUser(java.lang.String userName)
Gets the instance of a user with its information.java.util.List<UserLocation>
getUserLocations()
Finds locations of all users.
Method Detail
getUser
IAuthenticatedUser getUser(java.lang.String userName) throws NotFoundException
Gets the instance of a user with its information.- Parameters:
userName
- The user name.- Returns:
- The instance holding the potentially authenticated user.
- Throws:
java.lang.NullPointerException
- If theuserName
isnull
.NotFoundException
- If the user name is not found or an SQL exception occurred.
getUser
IAuthenticatedUser getUser(long id)
Gets the basic user info for a user from its unique user ID. The value comes from
.UserInfoBase.id
- Parameters:
id
- The unique user ID.- Returns:
- The user information, or null if not found.
getUserLocations
java.util.List<UserLocation> getUserLocations()
Finds locations of all users.