Java Doc for SampleUserDirectoryProvider.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » provider » user » 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 » ERP CRM Financial » sakai » org.sakaiproject.provider.user 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.sakaiproject.provider.user.SampleUserDirectoryProvider

SampleUserDirectoryProvider
public class SampleUserDirectoryProvider implements UserDirectoryProvider,UsersShareEmailUDP,DisplayAdvisorUDP(Code)

SampleUserDirectoryProvider is a samaple UserDirectoryProvider.


Inner Class :protected class Info

Field Summary
protected  intm_courseStudents
     how many students to recognize (1..
protected  Hashtablem_info
     A collection of user ids/names.

Constructor Summary
public  SampleUserDirectoryProvider()
     Construct.

Method Summary
public  booleanauthenticateUser(String userId, UserEdit edit, String password)
     Authenticate a user / password.
public  booleanauthenticateWithProviderFirst(String id)
    
public  booleancreateUserRecord(String id)
    
public  voiddestroy()
     Returns to uninitialized state.
public  voiddestroyAuthentication()
    
public  booleanfindUserByEmail(UserEdit edit, String email)
     Find a user object who has this email address.
public  CollectionfindUsersByEmail(String email, UserFactory factory)
     Find all user objects which have this email address.
Parameters:
  email - The email address string.
Parameters:
  factory - Use this factory's newUser() method to create all the UserEdit objects you populate and return in the return collection.
public  StringgetDisplayId(User user)
    
public  StringgetDisplayName(User user)
    
public  booleangetUser(UserEdit edit)
     Access a user object.
public  voidgetUsers(Collection users)
     Access a collection of UserEdit objects; if the user is found, update the information, otherwise remove the UserEdit object from the collection.
public  voidinit()
     Final initialization, once all dependencies are set.
public  voidsetCourseStudents(String count)
     Set how many students to recognize.
public  booleanupdateUserAfterAuthentication()
     Will this provider update user records on successfull authentication? If so, the UserDirectoryService will cause these updates to be stored.
public  booleanuserExists(String userId)
     See if a user by this id exists.
Parameters:
  userId - The user id string.

Field Detail
m_courseStudents
protected int m_courseStudents(Code)
how many students to recognize (1.. this).



m_info
protected Hashtable m_info(Code)
A collection of user ids/names.




Constructor Detail
SampleUserDirectoryProvider
public SampleUserDirectoryProvider()(Code)
Construct.




Method Detail
authenticateUser
public boolean authenticateUser(String userId, UserEdit edit, String password)(Code)
Authenticate a user / password. If the user edit exists it may be modified, and will be stored if...
Parameters:
  id - The user id.
Parameters:
  edit - The UserEdit matching the id to be authenticated (and updated) if we have one.
Parameters:
  password - The password. true if authenticated, false if not.



authenticateWithProviderFirst
public boolean authenticateWithProviderFirst(String id)(Code)



createUserRecord
public boolean createUserRecord(String id)(Code)



destroy
public void destroy()(Code)
Returns to uninitialized state. You can use this method to release resources thet your Service allocated when Turbine shuts down.



destroyAuthentication
public void destroyAuthentication()(Code)



findUserByEmail
public boolean findUserByEmail(UserEdit edit, String email)(Code)
Find a user object who has this email address. Update the object with the information found.
Note: this method won't be used, because we are a UsersShareEmailUPD.
This is the sort of method to provide if your external source has only a single user for any email address.
Parameters:
  email - The email address string. true if the user object was found and information updated, false if not.



findUsersByEmail
public Collection findUsersByEmail(String email, UserFactory factory)(Code)
Find all user objects which have this email address.
Parameters:
  email - The email address string.
Parameters:
  factory - Use this factory's newUser() method to create all the UserEdit objects you populate and return in the return collection. Collection (UserEdit) of user objects that have this email address, or an empty Collection if there are none.



getDisplayId
public String getDisplayId(User user)(Code)



getDisplayName
public String getDisplayName(User user)(Code)



getUser
public boolean getUser(UserEdit edit)(Code)
Access a user object. Update the object with the information found.
Parameters:
  edit - The user object (id is set) to fill in. true if the user object was found and information updated, false if not.



getUsers
public 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 id set) to fill in or remove.



init
public void init()(Code)
Final initialization, once all dependencies are set.



setCourseStudents
public void setCourseStudents(String count)(Code)
Set how many students to recognize.
Parameters:
  count - How many students to recognize.



updateUserAfterAuthentication
public 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
public boolean userExists(String userId)(Code)
See if a user by this id exists.
Parameters:
  userId - The user id string. true if a user by this id exists, false if not.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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