Java Doc for DefaultUserInfo.java in  » J2EE » Expresso » com » jcorporate » expresso » services » dbobj » 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 » J2EE » Expresso » com.jcorporate.expresso.services.dbobj 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.jcorporate.expresso.core.dbobj.SecuredDBObject
   com.jcorporate.expresso.services.dbobj.SecurityDBObject
      com.jcorporate.expresso.services.dbobj.DefaultUserInfo

DefaultUserInfo
public class DefaultUserInfo extends SecurityDBObject implements UserInfo(Code)
Default implementation of the UserInfo object. This is the class that comes for managing users and security with Expresso.
author:
   Michael Nash, adapted Larry Hamel, CodeGuild


Field Summary
final public static  StringACCOUNT_STATUS
    
final public static  StringCREATED_DATE
    
final public static  StringEMAIL_ADDRESS
    
final public static  intEMAIL_ADDRESS_LENGTH
    
final public static  StringEXPUID
    
final public static  StringFULL_NAME
     Field name for full name.
final public static  intFULL_NAME_LENGTH
    
final public static  StringIS_REG_COMPLETE
    
final public static  StringLOGIN
    
final public static  intLOGIN_LENGTH
    
final public static  StringNAME_2_ID_CACHE_NAME
    
final public static  StringPASSWORD
    
final public static  intPASSWORD_LENGTH
    
final public static  StringREGISTRATION_DOMAIN
     Field name for the registration domain id.
final public static  StringTHIS_CLASS
    
final public static  StringUPDATED_DATE
    
final public static  StringVALIDATION_CODE
    
final public static  intVALIDATION_CODE_LENGTH
    

Constructor Summary
public  DefaultUserInfo()
    
public  DefaultUserInfo(int uid)
    
public  DefaultUserInfo(DBConnection localConnection)
    
public  DefaultUserInfo(ControllerRequest request)
     For using DBObjects within Controllers.

Method Summary
public  voidadd()
     Override of add to check for duplicate emails.
protected  voidcheckAllRefs()
    
public  voiddelete()
    
public  booleanfind()
     Override to provide better performance.
public  StringgetAccountStatus()
    
public  VectorgetAllUsers()
     Retrieve a list of all users...
public  StringgetCreateDate()
    
public  StringgetEmail()
    
public  StringgetEmailAuthCode()
     Create an email authorization code.
public  StringgetEmailValCode()
    
public  StringgetFullName()
    
public  VectorgetGroups()
    
public  StringgetLoginName()
    
public  StringgetPassword()
    
public  StringgetPrimaryGroup()
    
public static  StringgetPrimaryGroup(UserInfo user)
    
public  booleangetRegComplete()
    
public  StringgetRegistrationDomain()
    
public  intgetUid()
    
public  StringgetUpdateDate()
    
public  StringgetUserName()
    
public synchronized  VectorgetValidValues(String fieldName)
     Get the valid values for various fields on this data object
Parameters:
  fieldName - The fieldname to retrieve the valid values for.
public  VectorgetValues()
    
public  StringhashEncodePassword(String plaintext)
     hashEncodePassword: If passed a plaintext string > 0 bytes, then this function will SHA1 hash the password, then Base64 encode it and return it as a string.
public  voidnotify(String subject, String message)
     Send this user a notification via e-mail.
public  booleanpasswordEquals(String tryPassword)
     passwordEquals - feed it a password and it will tell you if the hash of it matches the one on file.

Also, for backwards compatability and some other issues, this function will also accept a plaintext version of the password if it is sitting in the database.

public  voidpostLogin()
    
public  StringrandomPassword()
    
public  voidsendAuthEmail()
     Sends an Authorization Email to a new User.
public  voidsendFileTo(String subject, String message, Vector fileNames)
     Send this user an e-mail with file attachments.
public  voidsendFollowUpEmail()
     Once a user has validated his email address through the email validation servlet, the user will receive this message giving previously requested username/password.
public  voidsetAccountStatus(String accountStatus)
    
public  voidsetEmail(String email)
    
public  voidsetEmailValCode(String code)
    
public  voidsetLoginName(String loginName)
    
public  voidsetPassword(String password)
    
public  voidsetPrimaryGroup(UserGroup group)
     set the primary group of this user.
public  voidsetRegComplete(boolean status)
    
public  voidsetRegistrationDomain(String domain)
    
public  voidsetUid(String uid)
    
public  voidsetUid(int uid)
    
public  voidsetUserName(String name)
    
public  voidsetupFields()
    
public  voidupdate()
    

Field Detail
ACCOUNT_STATUS
final public static String ACCOUNT_STATUS(Code)
Field name for account status



CREATED_DATE
final public static String CREATED_DATE(Code)
Field name for created date



EMAIL_ADDRESS
final public static String EMAIL_ADDRESS(Code)
Field name for user's email



EMAIL_ADDRESS_LENGTH
final public static int EMAIL_ADDRESS_LENGTH(Code)
Email address length



EXPUID
final public static String EXPUID(Code)
Field name for the user id



FULL_NAME
final public static String FULL_NAME(Code)
Field name for full name.



FULL_NAME_LENGTH
final public static int FULL_NAME_LENGTH(Code)
Full name field length



IS_REG_COMPLETE
final public static String IS_REG_COMPLETE(Code)
Field name for registration complete flag



LOGIN
final public static String LOGIN(Code)
Field name for the login name



LOGIN_LENGTH
final public static int LOGIN_LENGTH(Code)
Login name length



NAME_2_ID_CACHE_NAME
final public static String NAME_2_ID_CACHE_NAME(Code)



PASSWORD
final public static String PASSWORD(Code)
Field name for the password



PASSWORD_LENGTH
final public static int PASSWORD_LENGTH(Code)
Password name length



REGISTRATION_DOMAIN
final public static String REGISTRATION_DOMAIN(Code)
Field name for the registration domain id.



THIS_CLASS
final public static String THIS_CLASS(Code)
Debugging information value



UPDATED_DATE
final public static String UPDATED_DATE(Code)
Field name for updated date



VALIDATION_CODE
final public static String VALIDATION_CODE(Code)
Field name for validation code



VALIDATION_CODE_LENGTH
final public static int VALIDATION_CODE_LENGTH(Code)
Validation code length




Constructor Detail
DefaultUserInfo
public DefaultUserInfo() throws DBException(Code)
Default constructor



DefaultUserInfo
public DefaultUserInfo(int uid) throws DBException(Code)
Constructor with UID
Parameters:
  uid - The User ID of the owner object
throws:
  DBException - upon error



DefaultUserInfo
public DefaultUserInfo(DBConnection localConnection) throws DBException(Code)
constructor for db transactions
Parameters:
  localConnection - the DB connection which should be used, typically because of an ongoing transaction



DefaultUserInfo
public DefaultUserInfo(ControllerRequest request) throws DBException(Code)
For using DBObjects within Controllers. Initializes based upon the current user and the requested db. [Of course this can be modified later]
Parameters:
  request - - The controller request handed to you by the framework.




Method Detail
add
public void add() throws DBException(Code)
Override of add to check for duplicate emails.
throws:
  DBException - upon error



checkAllRefs
protected void checkAllRefs() throws DBException(Code)
Extends the checkAllRefs method to check for valid Registration Domain Id
throws:
  DBException - If a referential integrity violation is found



delete
public void delete() throws DBException(Code)
Override of deleteMethod() to notify UserListeners of deltion
throws:
  DBException - upon error



find
public boolean find() throws com.jcorporate.expresso.core.db.DBException(Code)
Override to provide better performance. We cache recently used LoginNames into a cache. If we find the appropriate loginname, then we map the uid so that subsequent find() will perform a retrieve() so we can utilize the cache instead. true if successfully found the object
throws:
  DBException - if there's an error performing the find.



getAccountStatus
public String getAccountStatus() throws DBException(Code)
Retrieve the account status of the user java.lang.String : one of the account status codes
throws:
  DBException - upon error



getAllUsers
public Vector getAllUsers() throws DBException(Code)
Retrieve a list of all users... may get REALLY intensive! Vector of UserInfo objects
throws:
  DBException - upon database error



getCreateDate
public String getCreateDate() throws DBException(Code)
Get the account creation date java.lang.String as a date formatted string
throws:
  DBException - upon error



getEmail
public String getEmail() throws DBException(Code)
Retrieve the email address of the account java.lang.String
throws:
  DBException - upon error



getEmailAuthCode
public String getEmailAuthCode() throws DBException(Code)
Create an email authorization code. Used anymore?? java.lang.String
throws:
  DBException - upon error



getEmailValCode
public String getEmailValCode() throws DBException(Code)
Retrieve the email validation code java.lang.String



getFullName
public String getFullName() throws DBException(Code)
get descriptive, full name (first + last names) of person



getGroups
public Vector getGroups() throws DBException(Code)
Get the groups that below to this user Vector of strings
throws:
  DBException - upon database access error



getLoginName
public String getLoginName() throws DBException(Code)
get name used for login query that is accompanied by password



getPassword
public String getPassword() throws DBException(Code)



getPrimaryGroup
public String getPrimaryGroup() throws DBException(Code)
the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission name of the primary group of this user; null if no group is found
throws:
  DBException - upon database access error



getPrimaryGroup
public static String getPrimaryGroup(UserInfo user) throws DBException(Code)
the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission
Parameters:
  user - The userInfo object to query name of the primary group of this user; null if no group is primary
throws:
  DBException - upon database access error



getRegComplete
public boolean getRegComplete() throws DBException(Code)



getRegistrationDomain
public String getRegistrationDomain() throws DBException(Code)



getUid
public int getUid() throws DBException(Code)



getUpdateDate
public String getUpdateDate() throws DBException(Code)



getUserName
public String getUserName() throws DBException(Code)
get descriptive, full name



getValidValues
public synchronized Vector getValidValues(String fieldName) throws DBException(Code)
Get the valid values for various fields on this data object
Parameters:
  fieldName - The fieldname to retrieve the valid values for. a java.util.Vector of ValidValue objects
throws:
  com.jcorporate.expresso.core.db.DBException - The exception description.



getValues
public Vector getValues() throws DBException(Code)



hashEncodePassword
public String hashEncodePassword(String plaintext) throws DBException(Code)
hashEncodePassword: If passed a plaintext string > 0 bytes, then this function will SHA1 hash the password, then Base64 encode it and return it as a string.

If the password is zero length, then it will simply return a zero length string also.
Parameters:
  plaintext - - the password to process in this manner:
returnValue = Base64(SHA-1(plaintext)) a String representing a Base64 encoded Hashed Password




notify
public void notify(String subject, String message) throws DBException, LogException(Code)
Send this user a notification via e-mail.
Parameters:
  subject - Subject of the e-mail
Parameters:
  message - Message to send in body of e-mail
throws:
  DBException - If the mail message cannot be sent



passwordEquals
public boolean passwordEquals(String tryPassword) throws DBException(Code)
passwordEquals - feed it a password and it will tell you if the hash of it matches the one on file.

Also, for backwards compatability and some other issues, this function will also accept a plaintext version of the password if it is sitting in the database. However, if a plaintext match is encountered, then it will hash the password and re-write itself to the database record.
Parameters:
  tryPassword - The value the user input for an attempted login. true if the password equals




postLogin
public void postLogin() throws DBException, LogException(Code)
Called by the various objects that can log in a user to do post-login tasks



randomPassword
public String randomPassword()(Code)
a random generated password



sendAuthEmail
public void sendAuthEmail() throws DBException(Code)
Sends an Authorization Email to a new User. The user must click on the link encoded in this email before his account will be activated.



sendFileTo
public void sendFileTo(String subject, String message, Vector fileNames) throws DBException, LogException(Code)
Send this user an e-mail with file attachments.
Parameters:
  subject - Subject of the e-mail
Parameters:
  message - Message to send in body of e-mail
Parameters:
  fileNames - of the files to attach
throws:
  DBException - If the mail message cannot be sent



sendFollowUpEmail
public void sendFollowUpEmail() throws DBException(Code)
Once a user has validated his email address through the email validation servlet, the user will receive this message giving previously requested username/password.

Creation date: (8/8/00 11:44:26 PM) author Adam Rossi, PlatinumSolutions, Inc.
throws:
  com.jcorporate.expresso.core.db.DBException - The exception description.




setAccountStatus
public void setAccountStatus(String accountStatus) throws DBException(Code)



setEmail
public void setEmail(String email) throws DBException(Code)



setEmailValCode
public void setEmailValCode(String code) throws DBException(Code)



setLoginName
public void setLoginName(String loginName) throws DBException(Code)



setPassword
public void setPassword(String password) throws DBException(Code)



setPrimaryGroup
public void setPrimaryGroup(UserGroup group) throws DBException(Code)
set the primary group of this user. primary group is appropriate for unix-like purposes, such as setting the group for a file permission
Parameters:
  group - The UserGroup object to use.
throws:
  DBException - upon database access error



setRegComplete
public void setRegComplete(boolean status) throws DBException(Code)



setRegistrationDomain
public void setRegistrationDomain(String domain) throws DBException(Code)



setUid
public void setUid(String uid) throws DBException(Code)
Sets the uid of the userinfo object
Parameters:
  uid - the user id to set
throws:
  DBException - upon error



setUid
public void setUid(int uid) throws DBException(Code)
Sets the uid of the userinfo object
Parameters:
  uid - the user id to set
throws:
  DBException - upon error



setUserName
public void setUserName(String name) throws DBException(Code)



setupFields
public void setupFields() throws DBException(Code)

See Also:   com.jcorporate.expresso.core.dbobj.SecuredDBObject.setupFields



update
public void update() throws DBException(Code)
Override of add to check for duplicate emails, and handle empty fields
throws:
  DBException - upon error



Fields inherited from com.jcorporate.expresso.services.dbobj.SecurityDBObject
final public static String SECURITY_CONTEXT(Code)(Java Doc)
final public static String SECURITY_OBJECTS(Code)(Java Doc)

Methods inherited from com.jcorporate.expresso.services.dbobj.SecurityDBObject
protected void overrideDataContext(String newContext)(Code)(Java Doc)
public void setDBName(String newContext) throws DBException(Code)(Java Doc)
public void setDataContext(String newContext)(Code)(Java Doc)

Fields inherited from com.jcorporate.expresso.core.dbobj.SecuredDBObject
final public static String ADD(Code)(Java Doc)
final public static String[] ALL_FUNCTIONS(Code)(Java Doc)
final protected static String CACHE_NAME(Code)(Java Doc)
final protected static long CACHE_TTY(Code)(Java Doc)
final public static String DELETE(Code)(Java Doc)
final public static String SEARCH(Code)(Java Doc)
final public static int SYSTEM_ACCOUNT(Code)(Java Doc)
final public static String SYSTEM_ACCOUNT_NAME(Code)(Java Doc)
final public static String UPDATE(Code)(Java Doc)

Methods inherited from com.jcorporate.expresso.core.dbobj.SecuredDBObject
public void add() throws DBException(Code)(Java Doc)
public boolean canRequesterAdd() throws DBException(Code)(Java Doc)
public boolean canRequesterDelete() throws DBException(Code)(Java Doc)
public boolean canRequesterRead() throws DBException(Code)(Java Doc)
public boolean canRequesterUpdate() throws DBException(Code)(Java Doc)
public boolean checkAllowed(String requestedFunction) throws DBException(Code)(Java Doc)
public void copyAttributes(DBObject returnObj) throws DBException(Code)(Java Doc)
public synchronized int count() throws com.jcorporate.expresso.core.db.DBException(Code)(Java Doc)
protected synchronized void createSecurityCache() throws CacheException(Code)(Java Doc)
public void delete() throws DBException(Code)(Java Doc)
public synchronized void deleteAll() throws com.jcorporate.expresso.core.db.DBException(Code)(Java Doc)
public boolean find() throws DBException(Code)(Java Doc)
public int getRequestingUid()(Code)(Java Doc)
protected String getString(String stringCode, Object[] args) throws DBException(Code)(Java Doc)
protected String getString(String stringCode) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2, String arg3) throws DBException(Code)(Java Doc)
protected String getString(String stringCode, String arg1, String arg2, String arg3, String arg4) throws DBException(Code)(Java Doc)
public int getSystemUid()(Code)(Java Doc)
public static SecuredDBObject instantiate(String className) throws DBException(Code)(Java Doc)
public void isAllowed(String requestedFunction) throws SecurityException, DBException(Code)(Java Doc)
public void retrieve() throws DBException(Code)(Java Doc)
public synchronized void search() throws DBException(Code)(Java Doc)
public synchronized ArrayList searchAndRetrieveList() throws DBException(Code)(Java Doc)
public synchronized ArrayList searchAndRetrieveList(String sortKeys) throws DBException(Code)(Java Doc)
public void setRequestingUid(int newUid)(Code)(Java Doc)
public void update() throws DBException(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.