|
| |
|
| com.jcorporate.expresso.core.security.UserInfo
All known Subclasses: com.jcorporate.expresso.services.dbobj.DefaultUserInfo, com.jcorporate.expresso.core.security.MapBasedUserInfo, com.jcorporate.expresso.ext.dbobj.SingleDBUserInfo, com.jcorporate.expresso.ext.ldap.UserLDAP,
| UserInfo | | public interface UserInfo extends LookupInterface(Code) | | UserInfo defines the interface to an object that provides information about a user
this object may get it's information from LDAP, Database, or any other source
author:
Michael Nash |
| delete | | public void delete() throws DBException(Code) | | Deletes the current UserInfo object from the repository
throws:
DBException - If the delete fails |
| find | | public boolean find() throws DBException(Code) | | Find a UserInfo object in the repository that matches the non-empty properties filled in the current UserInfo object
true if the user is found
throws:
DBException - If the find fails |
| getAccountStatus | | public String getAccountStatus() throws DBException(Code) | | Retrieve the current account status. Valid values are "A" (active), "I" (inactive), "D" (disabled)
java.lang.String
throws:
DBException - If the find fails |
| getAllUsers | | public Vector getAllUsers() throws DBException(Code) | | Returns a Vector of all the UserInfo objects in the repository
java.util.Vector
throws:
DBException - If there is an error during the retrieval |
| getCreateDate | | public String getCreateDate() throws DBException(Code) | | Returns the date that this UserInfo object was created
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getDBName | | public String getDBName()(Code) | | gets the DB context; can return null
|
| getDataContext | | public String getDataContext()(Code) | | gets the DB context; can return null
|
| getEmail | | public String getEmail() throws DBException(Code) | | Returns the email address for this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getEmailAuthCode | | public String getEmailAuthCode() throws DBException(Code) | | Returns the email auth code previously set for this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getEmailValCode | | public String getEmailValCode() throws DBException(Code) | | Retrieve the validation code required for authorization by email
java.lang.String
throws:
DBException - If the find fails |
| getField | | public String getField(String fieldName) throws DBException(Code) | | Return a vector of the group names that this user belongs to
Parameters:
fieldName - The field to retrieve Vector Group names that this user belongs to
throws:
DBException - If an error occurs when the group info is read |
| getGroups | | public Vector getGroups() throws DBException(Code) | | Return a vector of the group names that this user belongs to
Vector Group names that this user belongs to
throws:
DBException - If an error occurs when the group info is read |
| getLoginName | | public String getLoginName() throws DBException(Code) | | Returns the login name of this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getPassword | | public String getPassword() throws DBException(Code) | | Returns the password for this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| 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 |
| getRegComplete | | public boolean getRegComplete() throws DBException(Code) | | Returns the status of whether extended registration has been completed or not
Valid values are "Y" or "N"
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getUid | | public int getUid() throws DBException(Code) | | Returns the user id for this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getUpdateDate | | public String getUpdateDate() throws DBException(Code) | | Returns the date that this UserInfo object was last modified
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| getUserName | | public String getUserName() throws DBException(Code) | | Returns the descriptive string for this user
java.lang.String
throws:
DBException - If there is an error during the retrieval |
| hashEncodePassword | | public String hashEncodePassword(String password) throws DBException(Code) | | this returns an appropriately hashed password.
appropriately hashed password. |
| passwordEquals | | public boolean passwordEquals(String testPassword) throws DBException(Code) | | Checks if the given password equals what we have on file. We don't
directly compare userInfo fields because often we store the password
in a hash instead of a normal string so we have to take the testPassword,
hash it and compare the two hashes.
Parameters:
testPassword - The string to test if it's a correct password true if the testPassword equals the password on file.
throws:
DBException - If an error occurs when the group info is read |
| retrieve | | public void retrieve() throws DBException(Code) | | Retrieves the current user from the repository
throws:
DBException - If the add fails |
| setAccountStatus | | public void setAccountStatus(String accountStatus) throws DBException(Code) | | Sets the current status of the account - "A" (active), "D" (disabled), "I" (inactive)
Parameters:
accountStatus - java.lang.String
throws:
DBException - If there is an error |
| setDBName | | public void setDBName(String newDBName) throws DBException(Code) | | Sets the DB context
Parameters:
newDBName - java.lang.String
throws:
DBException - If there is an error |
| setEmailValCode | | public void setEmailValCode(String code) throws DBException(Code) | | Sets the code required for auth. via email
Parameters:
code - java.lang.String
throws:
DBException - If there is an error |
| setLoginName | | public void setLoginName(String loginName) throws DBException(Code) | | Sets the login name
Parameters:
loginName - java.lang.String
throws:
DBException - If there is an error |
| setPassword | | public void setPassword(String password) throws DBException(Code) | | Sets the password
Parameters:
password - java.lang.String
throws:
DBException - If there is an error |
| setRegComplete | | public void setRegComplete(boolean status) throws DBException(Code) | | Sets the extended registration complete flag - "Y" or "N"
Parameters:
status - java.lang.String
throws:
DBException - If there is an error |
| setUid | | public void setUid(int uid) throws DBException(Code) | | Sets the user UID
Parameters:
uid - The uid of the user
throws:
DBException - If there is an error |
| update | | public void update() throws DBException(Code) | | Update the user in the repository with modified properties
throws:
DBException - If the add fails |
|
|
|