Java Doc for AbstractUsersRepository.java in  » Web-Mail » james-2.3.1 » org » apache » james » userrepository » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Mail » james 2.3.1 » org.apache.james.userrepository 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.james.userrepository.AbstractUsersRepository

All known Subclasses:   org.apache.james.userrepository.AbstractJdbcUsersRepository,
AbstractUsersRepository
abstract public class AbstractUsersRepository extends AbstractLogEnabled implements UsersRepository,Component(Code)
A partial implementation of a Repository to store users.

This implements common functionality found in different UsersRespository implementations, and makes it easier to create new User repositories.





Method Summary
public  booleanaddUser(User user)
     Adds a user to the repository with the specified User object.
public  voidaddUser(String name, Object attributes)
     Adds a user to the repository with the specified attributes.
public  booleanaddUser(String username, String password)
    
public  booleancontains(String name)
    
public  booleancontainsCaseInsensitive(String name)
     Returns whether or not this user is in the repository.
public  intcountUsers()
     Returns a count of the users in the repository.
abstract protected  voiddoAddUser(User user)
     Adds a user to the underlying Repository.
abstract protected  voiddoRemoveUser(User user)
     Removes a user from the underlying repository.
abstract protected  voiddoUpdateUser(User user)
     Updates a user record to match the supplied User.
public  StringgetRealName(String name)
     Returns the user name of the user matching name on an equalsIgnoreCase basis.
protected  UsergetUserByName(String name, boolean ignoreCase)
     Gets a user by name, ignoring case if specified.
public  UsergetUserByName(String name)
     Get the user object with the specified user name.
public  UsergetUserByNameCaseInsensitive(String name)
     Get the user object with the specified user name.
public  Iteratorlist()
     List users in repository.
abstract protected  IteratorlistAllUsers()
     Returns a list populated with all of the Users in the repository.
protected  ListlistUserNames()
     Produces the complete list of User names, with correct case.
public  voidremoveUser(String name)
    
public  booleantest(String name, String password)
     Test if user with name 'name' has password 'password'.
public  booleanupdateUser(User user)
     Update the repository with the specified user object.



Method Detail
addUser
public boolean addUser(User user)(Code)
Adds a user to the repository with the specified User object. Users names must be unique-case-insensitive in the repository.
Parameters:
  user - the user to be added true if succesful, false otherwise
since:
   James 1.2.2



addUser
public 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 - the password value as a String



addUser
public boolean addUser(String username, String password)(Code)

See Also:   org.apache.james.services.UsersRepository.addUser(java.lang.Stringjava.lang.String)



contains
public boolean contains(String name)(Code)
Returns whether or not this user is in the repository



containsCaseInsensitive
public boolean containsCaseInsensitive(String name)(Code)
Returns whether or not this user is in the repository. Names are matched on a case insensitive basis.



countUsers
public int countUsers()(Code)
Returns a count of the users in the repository. the number of users in the repository



doAddUser
abstract protected void doAddUser(User user)(Code)
Adds a user to the underlying Repository. The user name must not clash with an existing user.



doRemoveUser
abstract protected void doRemoveUser(User user)(Code)
Removes a user from the underlying repository. If the user doesn't exist, returns ok.



doUpdateUser
abstract protected void doUpdateUser(User user)(Code)
Updates a user record to match the supplied User.



getRealName
public 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 of the user to retrieve the correct case sensitive name of the user



getUserByName
protected User getUserByName(String name, boolean ignoreCase)(Code)
Gets a user by name, ignoring case if specified. This implementation gets the entire set of users, and scrolls through searching for one matching name.
Parameters:
  name - the name of the user being retrieved
Parameters:
  ignoreCase - whether the name is regarded as case-insensitive the user being retrieved, null if the user doesn't exist



getUserByName
public 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 if found, null otherwise
since:
   James 1.2.2



getUserByNameCaseInsensitive
public 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 if found, null otherwise
since:
   James 1.2.2



list
public Iterator list()(Code)
List users in repository. Iterator over a collection of Strings, each being one user in the repository.



listAllUsers
abstract protected Iterator listAllUsers()(Code)
Returns a list populated with all of the Users in the repository. an Iterator of Users.



listUserNames
protected List listUserNames()(Code)
Produces the complete list of User names, with correct case. a List of Strings representinguser names.



removeUser
public void removeUser(String name)(Code)
Removes a user from the repository
Parameters:
  user - the user to be removed



test
public 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 thepassword is incorrect or the user doesn'texist
since:
   James 1.2.2



updateUser
public boolean updateUser(User user)(Code)
Update the repository with the specified user object. A user object with this username must already exist.
Parameters:
  user - the user to be updated true if successful.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.