| org.apache.james.services.UsersRepository
All known Subclasses: org.apache.james.userrepository.AbstractUsersRepository, org.apache.james.userrepository.UsersLDAPRepository, org.apache.james.userrepository.UsersFileRepository, org.apache.james.userrepository.MockUsersRepository, org.apache.james.core.LocalUsersRepository,
| UsersRepository | | public interface UsersRepository (Code) | | Interface for a repository of users. A repository represents a logical
grouping of users, typically by common purpose. E.g. the users served by an
email server or the members of a mailing list.
version:
$Revision: 494012 $ |
| ROLE | | String ROLE(Code) | | The component role used by components implementing this service
|
| addUser | | boolean addUser(User user)(Code) | | Adds a user to the repository with the specified User object.
Parameters:
user - the user to be added true if succesful, false otherwise
since:
James 1.2.2 |
| addUser | | void addUser(String name, Object attributes)(Code) | | Adds a user to the repository with the specified attributes. In current
implementations, the Object attributes is generally a String password.
Parameters:
name - the name of the user to be added
Parameters:
attributes - see decription |
| addUser | | boolean addUser(String username, String password)(Code) | | Adds a user to the repository with the specified password
Parameters:
username - the username of the user to be added
Parameters:
password - the password of the user to add true if succesful, false otherwise
since:
James 2.3.0 |
| contains | | boolean contains(String name)(Code) | | Returns whether or not this user is in the repository
Parameters:
name - the name to check in the repository whether the user is in the repository |
| containsCaseInsensitive | | boolean containsCaseInsensitive(String name)(Code) | | Returns whether or not this user is in the repository. Names are
matched on a case insensitive basis.
Parameters:
name - the name to check in the repository whether the user is in the repository |
| countUsers | | int countUsers()(Code) | | Returns a count of the users in the repository.
the number of users in the repository |
| getRealName | | String getRealName(String name)(Code) | | Returns the user name of the user matching name on an equalsIgnoreCase
basis. Returns null if no match.
Parameters:
name - the name to case-correct the case-correct name of the user, null if the user doesn't exist |
| getUserByName | | User getUserByName(String name)(Code) | | Get the user object with the specified user name. Return null if no
such user.
Parameters:
name - the name of the user to retrieve the user being retrieved, null if the user doesn't exist
since:
James 1.2.2 |
| getUserByNameCaseInsensitive | | User getUserByNameCaseInsensitive(String name)(Code) | | Get the user object with the specified user name. Match user naems on
a case insensitive basis. Return null if no such user.
Parameters:
name - the name of the user to retrieve the user being retrieved, null if the user doesn't exist
since:
James 1.2.2 |
| list | | Iterator list()(Code) | | List users in repository.
Iterator over a collection of Strings, each being one user in the repository. |
| removeUser | | void removeUser(String name)(Code) | | Removes a user from the repository
Parameters:
name - the user to remove from the repository |
| test | | boolean test(String name, String password)(Code) | | Test if user with name 'name' has password 'password'.
Parameters:
name - the name of the user to be tested
Parameters:
password - the password to be tested true if the test is successful, false if the userdoesn't exist or if the password is incorrect
since:
James 1.2.2 |
| updateUser | | boolean updateUser(User user)(Code) | | Update the repository with the specified user object. A user object
with this username must already exist.
true if successful. |
|
|