| org.sakaiproject.user.api.UserDirectoryProvider
All known Subclasses: org.sakaiproject.component.imsent.user.IMSEntUserDirectoryProvider, edu.amc.sakai.user.JLDAPDirectoryProvider, es.udl.asic.user.OpenLdapDirectoryProvider, org.sakaiproject.provider.user.SampleUserDirectoryProvider, org.sakaiproject.component.kerberos.user.KerberosUserDirectoryProvider, org.sakaiproject.provider.user.FilterUserDirectoryProvider,
| UserDirectoryProvider | | public interface UserDirectoryProvider (Code) | |
UserDirectoryProvider feeds external user information to the UserDirectoryService.
|
| authenticateUser | | boolean authenticateUser(String eid, UserEdit edit, String password)(Code) | | Authenticate a user / password. If the user edit exists it may be modified, and will be stored if...
Parameters:
eid - The user eid.
Parameters:
edit - The UserEdit matching the eid to be authenticated (may be updated by the provider).
Parameters:
password - The password. true if authenticated, false if not. |
| authenticateWithProviderFirst | | boolean authenticateWithProviderFirst(String eid)(Code) | | Whether to check provider or internal data first when authenticating a user
Parameters:
eid - The user eid. true if provider data is checked first, false if otherwise |
| createUserRecord | | boolean createUserRecord(String eid)(Code) | | Does the provider wish for the service to create an internal User record for this user?
Parameters:
eid - The user eid. |
| destroyAuthentication | | void destroyAuthentication()(Code) | | Remove any authentication traces for the current user / request
|
| findUserByEmail | | boolean findUserByEmail(UserEdit edit, String email)(Code) | | Find a user object who has this email address. Update the object with the information found.
Parameters:
email - The email address string. true if the user object was found and information updated, false if not. |
| getUser | | boolean getUser(UserEdit edit)(Code) | | Access a user object. Update the object with the information found.
Parameters:
edit - The user object (eid is set) to fill in. true if the user object was found and information updated, false if not. |
| getUsers | | void getUsers(Collection users)(Code) | | Access a collection of UserEdit objects; if the user is found, update the information, otherwise remove the UserEdit object from the collection.
Parameters:
users - The UserEdit objects (with eid set) to fill in or remove. |
| updateUserAfterAuthentication | | boolean updateUserAfterAuthentication()(Code) | | Will this provider update user records on successfull authentication? If so, the UserDirectoryService will cause these updates to be stored.
true if the user record may be updated after successfull authentication, false if not. |
| userExists | | boolean userExists(String eid)(Code) | | See if a user by this eid is known to the provider.
Parameters:
eid - The user eid string. true if a user by this id exists, false if not. |
|
|