com.jcorporate.expresso.services.dbobj
Class UserDBObj

java.lang.Object
  com.jcorporate.expresso.core.dataobjects.BaseDataObject
      com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject
          com.jcorporate.expresso.core.dbobj.DBObject
              com.jcorporate.expresso.core.dbobj.SecuredDBObject
                  com.jcorporate.expresso.services.dbobj.UserDBObj

All Implemented Interfaces:

Cacheable, ContextNested, DataObject, LookupInterface, Securable, Serializable, UserInfo

Deprecated. Use DefaultUserInfo instead Since Expresso 4.0

public class UserDBObj

extends SecuredDBObject

implements UserInfo

Author:

Michael Nash

See Also:

DefaultUserInfo, Serialized Form

Nested Class Summary

Nested classes inherited from class com.jcorporate.expresso.core.dbobj.DBObject

DBObject.FieldError, DBObject.FieldUpdate

Field Summary

static String	ACCOUNT_STATUS Deprecated.
static String	CREATION_DATE Deprecated.
static String	DESCRIPTION Deprecated.
static String	EMAIL Deprecated.
static String	EMAIL_VALIDATION_CODE Deprecated.
static String	EXPUID Deprecated.
static String	FIRSTNAME Deprecated.
static String	LASTNAME Deprecated.
static String	PASSWORD Deprecated.
static String	USERNAME Deprecated.

Fields inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

ADD, ALL_FUNCTIONS, CACHE_NAME, CACHE_TTY, DELETE, SEARCH, SYSTEM_ACCOUNT, SYSTEM_ACCOUNT_NAME, UPDATE

Fields inherited from class com.jcorporate.expresso.core.dbobj.DBObject

ATTRIBUTE_ERROR, ATTRIBUTE_ERROR_MESSAGE, ATTRIBUTE_PAGE_LIMIT, BIG_DECIMAL_ZERO, EMAIL_MASK, FLOAT_MASK, INT_MASK, IS_CHECK_RELATIONAL_INTEGRITY

Fields inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

anyFieldsDistinct, anyFieldsToRetrieve, appendCustomWhere, caseSensitiveQuery, customWhereClause, dbKey, distinctFields, localConnection, maxRecords, myClassName, myUpdates, offsetRecord, recordSet, retrieveFields, sMetadataMap, sortKeys

Fields inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

currentStatus

Fields inherited from interface com.jcorporate.expresso.core.dataobjects.DataObject

STATUS_CURRENT, STATUS_DELETED, STATUS_NEW, STATUS_UPDATED

Constructor Summary

UserDBObj()
Deprecated.

UserDBObj(ControllerRequest request)
Deprecated. For using DBObjects within Controllers.

UserDBObj(DBConnection dbConnection)
Deprecated. Constructor Creation date: (8/9/00 5:44:22 PM)

UserDBObj(int uid)
Deprecated. Use over (String) constructor.

Method Summary

void	add() Deprecated. Encode the password before adding the record to the database
void	delete() Deprecated. When a user entry is deleted, the corresponding entries in the group members table must also be deleted
String	getAccountStatus() Deprecated. Retrieve the current account status.
Vector	getAllUsers() Deprecated. to be deprecated soon.
ArrayList	getAllUsersList() Deprecated. Returns a list of all users on the UserDBOBject table.
String	getCreateDate() Deprecated. Returns the date that this UserInfo object was created
String	getEmail() Deprecated. Returns the email address for this user
String	getEmailAuthCode() Deprecated. Here we generate an authorization code that would be hard for someone to guess.
String	getEmailValCode() Deprecated. Retrieve the validation code required for authorization by email
Vector	getGroups() Deprecated. Return a vector of the group names that this user belongs to
String	getLoginName() Deprecated. Returns the login name of this user
String	getPassword() Deprecated. Returns the password for this user
String	getPrimaryGroup() Deprecated. the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission
boolean	getRegComplete() Deprecated. Returns the status of whether extended registration has been completed or not Valid values are "Y" or "N"
String	getRegistrationDomain() Deprecated. Returns the unique integer for the registration domain that this user belongs to
int	getUid() Deprecated. Returns the user id for this user
String	getUpdateDate() Deprecated. Returns the date that this UserInfo object was last modified
String	getUserName() Deprecated. Returns the descriptive string for this user
Vector	getValidValues(String fieldName) Deprecated. New method to replace getValues with a structure of valid values and descriptions.
void	notify(String subject, String message) Deprecated. Send this user a notification via e-mail.
boolean	passwordEquals(String tryPassword) Deprecated. passwordEquals - feed it a password and it will tell you if the hash of it matches the one on file.
void	postLogin() Deprecated. Called by the various objects that can log in a user to do post-login tasks
String	randomPassword() Deprecated. Generate a Random Password
void	sendAuthEmail() Deprecated. Sends an Authorization Email to a new User.
void	sendFileTo(String subject, String message, Vector fileNames) Deprecated. Send this user an e-mail with file attachments.
void	sendFollowUpEmail() Deprecated. Once a user has validated his email address through the email validation servlet, the user will receive this message giving previously requested username/password.
void	setAccountStatus(String accountStatus) Deprecated. Sets the current status of the account - "A" (active), "D" (disabled), "I" (inactive)
void	setEmail(String email) Deprecated. Sets the email address
void	setEmailValCode(String code) Deprecated. Sets the code required for auth. via email
void	setLoginName(String loginName) Deprecated. Sets the login name
void	setPassword(String password) Deprecated. Sets the password
void	setPasswordField(String data) Deprecated. Hash the password before writing it to the database
void	setRegComplete(boolean status) Deprecated. Sets the extended registration complete flag - "Y" or "N"
void	setRegistrationDomain(String domain) Deprecated. Sets the registration domain
void	setUid(int uid) Deprecated. Sets the user UID
void	setupFields() Deprecated. Method to set up the fields for this database object.
void	setUserName(String name) Deprecated. Sets the user name
void	update() Deprecated. Update the user in the repository with modified properties

Methods inherited from class com.jcorporate.expresso.core.dbobj.SecuredDBObject

canRequesterAdd, canRequesterDelete, canRequesterRead, canRequesterUpdate, checkAllowed, copyAttributes, count, createSecurityCache, deleteAll, find, getCharset, getDescription, getDescription, getRequestingUid, getString, getString, getString, getString, getString, getString, getSystemUid, getUser, instantiate, isAllowed, retrieve, search, searchAndRetrieveList, searchAndRetrieveList, setRequestingUid, setUser

Methods inherited from class com.jcorporate.expresso.core.dbobj.DBObject

addCacheEventListener, addDetail, addField, addField, addFieldError, addFoundKeys, addIfNeeded, addIndex, addKey, addOrUpdate, addSortKey, addToCache, addTransition, addVirtualField, addVirtualField, addVirtualField, addVirtualField, allowsNull, average, basicAdd, checkAllReferredToBy, checkAllRefs, checkAllRefsPublic, checkDeleteDetailPerm, checkField, checkRef, checkRef, clear, clearDistinctFields, clearError, clearFieldsToRetrieve, clearSortKeys, containsWildCards, delete, deleteDetails, denotesRange, disableLogging, enableLogging, equals, forKey, formatDateTime, get, getAllAttributes, getAllDBFields, getAllFields, getAllFieldsIterator, getAllFieldsMap, getAllKeys, getAllKeysIterator, getAllKeysMap, getAttribute, getAttribute, getAttributesIterator, getBinaryField, getBooleanFieldValue, getCacheSize, getCacheStats, getCacheStatsMap, getCheckZeroUpdate, getCustomWhereClause, getDataContext, getDataField, getDataTransferObject, getDBName, getDefaultValue, getDetailFieldsForeign, getDetailFieldsLocal, getDetails, getDistinctFieldCount, getDistinctFieldList, getDistinctFields, getField, getFieldBigDecimal, getFieldBoolean, getFieldByte, getFieldData, getFieldDate, getFieldDecimalFormatted, getFieldDouble, getFieldErrorMessage, getFieldFloat, getFieldInt, getFieldList, getFieldListArray, getFieldListIterator, getFieldLong, getFieldMetaData, getFields, getFieldShort, getFieldsToRetrieveCount, getFilterClass, getFoundCount, getFoundKeys, getFoundKeysArray, getIndexArray, getISOValuesDefault, getISOValuesDefault, getISOValuesDefault, getKey, getKeyFieldList, getKeyFieldListArray, getKeyFieldListIterator, getLength, getLengthInt, getLimitationPosition, getLimitationSyntax, getLocalConnection, getLocale, getLookupObject, getMax, getMax, getMaxRecords, getMyKeys, getMyUpdates, getMyUpdatesArray, getName, getOffsetRecord, getOriginalDBName, getPatternMatcher, getPrecision, getRecordSet, getRecordSetArrayList, getSchema, getSerializedForm, getStringFilter, getTableName, getTargetTable, getThisDBbj, getThisDBObj, getTransitionsIterator, getType, getValidValueDescrip, getValidValuesList, getValues, getValuesDefault, getValuesDefault, getValuesDefault, hasError, hasErrors, hasField, hasIndex, haveAllKeys, initialize, isCached, isDateType, isDistinct, isEmpty, isField, isFieldDistinct, isFieldIgnoreCase, isFieldNull, isFieldsToRetrieve, isFieldToRetrieve, isMultiValued, isNumericType, isQuotedType, isReadOnly, isSecret, isVirtual, loadFromConnection, logChange, max, min, newInstance, noNewLine, noQuotes, notifyListeners, populateDefaultValues, referredToBy, removeAttribute, removeAttribute, removeFromCache, retrieveFromCache, saveBinaryField, saveBinaryField, search, set, setAttribute, setAttribute, setCacheSize, setCharset, setCheckZeroUpdate, setConnection, setConnection, setCustomWhereClause, setCustomWhereClause, setDataContext, setDataField, setDataTransferObject, setDefaultValue, setDescription, setField, setField, setField, setField, setField, setField, setField, setField, setField, setFieldData, setFieldDistinct, setFieldsToRetrieve, setFilterClass, setFilterClass, setKeys, setLocale, setLookupField, setLookupObject, setMask, setMaxRecords, setMultiValued, setName, setOffsetRecord, setReadOnly, setSchema, setSchema, setSecret, setSortKey, setStringFilter, setStringFiltersOnAll, setTargetTable, sqlAggrFunction, sum, toDebugString, update, verify

Methods inherited from class com.jcorporate.expresso.core.dataobjects.jdbc.JDBCDataObject

buildWhereClause, buildWhereClauseBuffer, checkZeroUpdate, constructNewMetaData, createAndExecuteSearch, getConnectionPool, getCustomStringFieldValue, getDef, getDistinctFieldArrayList, getExecutor, getFieldsToRetrieveIterator, getJDBCMetaData, getJDBCUtil, getMappedDataContext, getMetaData, getQueryInterface, getSerialForm, loadFromConnection, makeLimitationStub, quoteIfNeeded, selectFieldString, setCaseSensitiveQuery, setDBConnectionPool, setDBName, setMappedDataContext, setOriginalDBName

Methods inherited from class com.jcorporate.expresso.core.dataobjects.BaseDataObject

getStatus, setStatus

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jcorporate.expresso.core.security.UserInfo

find, getDataContext, getDBName, getField, retrieve, setDBName

Methods inherited from interface com.jcorporate.expresso.core.dbobj.LookupInterface

getValues

Field Detail

EXPUID

public static final String EXPUID

Deprecated.

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

Deprecated.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Deprecated.

See Also:

Constant Field Values

LASTNAME

public static final String LASTNAME

Deprecated.

See Also:

Constant Field Values

FIRSTNAME

public static final String FIRSTNAME

Deprecated.

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

Deprecated.

See Also:

Constant Field Values

EMAIL

public static final String EMAIL

Deprecated.

See Also:

Constant Field Values

ACCOUNT_STATUS

public static final String ACCOUNT_STATUS

Deprecated.

See Also:

Constant Field Values

CREATION_DATE

public static final String CREATION_DATE

Deprecated.

See Also:

Constant Field Values

EMAIL_VALIDATION_CODE

public static final String EMAIL_VALIDATION_CODE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

UserDBObj

public UserDBObj()
          throws DBException

Deprecated.

Throws:

DBException

See Also:

SecuredDBObject.SecuredDBObject(java.lang.String, int)

UserDBObj

public UserDBObj(DBConnection dbConnection)
          throws DBException

Deprecated.

Constructor Creation date: (8/9/00 5:44:22 PM)

Parameters:

dbConnection - com.jcorporate.expresso.core.db.DBConnection

Throws:

DBException

UserDBObj

public UserDBObj(int uid)
          throws DBException

Deprecated.

Use over (String) constructor. Initializes the object in the context of the user who's uid belongs to the parameter.

Parameters:

uid - the Uid of the user context

Throws:

DBException - if there's an initialization problem

UserDBObj

public UserDBObj(ControllerRequest request)
          throws DBException

Deprecated.

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.

Throws:

DBException

Method Detail

add

public void add()
         throws DBException

Deprecated.

Encode the password before adding the record to the database

Specified by:

add in interface UserInfo

Overrides:

add in class SecuredDBObject

Throws:

DBException - If the add fails

delete

public void delete()
            throws DBException

Deprecated.

When a user entry is deleted, the corresponding entries in the group members table must also be deleted

Specified by:

delete in interface UserInfo

Overrides:

delete in class SecuredDBObject

Throws:

DBException - If the delete fails

getAccountStatus

public String getAccountStatus()
                        throws DBException

Deprecated.

Description copied from interface: UserInfo

Retrieve the current account status. Valid values are "A" (active), "I" (inactive), "D" (disabled)

Specified by:

getAccountStatus in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If the find fails

getAllUsers

public Vector getAllUsers()
                   throws DBException

Deprecated.

to be deprecated soon.

Specified by:

getAllUsers in interface UserInfo

Returns:

a Vector of all UserDBOBbj objects

Throws:

DBException

getAllUsersList

public ArrayList getAllUsersList()
                          throws DBException

Deprecated.

Returns a list of all users on the UserDBOBject table.

Returns:

an ArrayList of DBOBjects sorted by user name

Throws:

DBException

getCreateDate

public String getCreateDate()
                     throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the date that this UserInfo object was created

Specified by:

getCreateDate in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getEmail

public String getEmail()
                throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the email address for this user

Specified by:

getEmail in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getEmailAuthCode

public String getEmailAuthCode()
                        throws DBException

Deprecated.

Here we generate an authorization code that would be hard for someone to guess. The idea is that the person has to check the email sent to them to get this number, and then click on the specially encoded URL to ensure that he/she actually is checking the email account used at registration. The little trick of getting the time in milliseconds that the person registered, multiplying by some constant, and then rounding, is extremely weak. We need a better method of generating a unique code that will "play nice" in a query string.

Specified by:

getEmailAuthCode in interface UserInfo

Returns:

java.lang.String

Throws:

DBException

getEmailValCode

public String getEmailValCode()
                       throws DBException

Deprecated.

Description copied from interface: UserInfo

Retrieve the validation code required for authorization by email

Specified by:

getEmailValCode in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If the find fails

getGroups

public Vector getGroups()
                 throws DBException

Deprecated.

Return a vector of the group names that this user belongs to

Specified by:

getGroups in interface UserInfo

Returns:

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

Deprecated.

Description copied from interface: UserInfo

Returns the login name of this user

Specified by:

getLoginName in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getPassword

public String getPassword()
                   throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the password for this user

Specified by:

getPassword in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getRegComplete

public boolean getRegComplete()
                       throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the status of whether extended registration has been completed or not Valid values are "Y" or "N"

Specified by:

getRegComplete in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getRegistrationDomain

public String getRegistrationDomain()
                             throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the unique integer for the registration domain that this user belongs to

Specified by:

getRegistrationDomain in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If the underlying User implementation throws the same

getUid

public int getUid()
           throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the user id for this user

Specified by:

getUid in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getUpdateDate

public String getUpdateDate()
                     throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the date that this UserInfo object was last modified

Specified by:

getUpdateDate in interface UserInfo

Returns:

java.lang.String

Throws:

DBException - If there is an error during the retrieval

getUserName

public String getUserName()
                   throws DBException

Deprecated.

Description copied from interface: UserInfo

Returns the descriptive string for this user

Specified by:

getUserName in interface UserInfo

Overrides:

getUserName in class SecuredDBObject

Returns:

String: The user login name of the user accessing this object

Throws:

DBException - if the user name is invalid

getValidValues

public Vector getValidValues(String fieldName)
                      throws DBException

Deprecated.

Description copied from class: DBObject

New method to replace getValues with a structure of valid values and descriptions. Database objects should extend this method to return Vectors of ValidValue objects for multi-valued fields. A specific object can return it's own list of ValidValues, or it can call this super method to use the lookup object to get the list of valid values instead.

Overrides:

getValidValues in class DBObject

Parameters:

fieldName - the name of the field to retrieve

Returns:

java.util.Vector of ValidValueObjects

Throws:

DBException - The exception description.

notify

public void notify(String subject,
                   String message)
            throws DBException,
                   LogException

Deprecated.

Send this user a notification via e-mail.

Parameters:

subject - Subject of the e-mail

message - Message to send in body of e-mail

Throws:

DBException - If the mail message cannot be sent

LogException

passwordEquals

public boolean passwordEquals(String tryPassword)
                       throws DBException

Deprecated.

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.

Specified by:

passwordEquals in interface UserInfo

Parameters:

tryPassword - The value the user input for an attempted login.

Returns:

true if the password equals

Throws:

DBException

postLogin

public void postLogin()
               throws DBException,
                      LogException

Deprecated.

Called by the various objects that can log in a user to do post-login tasks

Throws:

DBException

LogException

randomPassword

public String randomPassword()

Deprecated.

Generate a Random Password

Returns:

Random String for a password

sendAuthEmail

public void sendAuthEmail()
                   throws DBException

Deprecated.

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.

Specified by:

sendAuthEmail in interface UserInfo

Throws:

DBException

sendFileTo

public void sendFileTo(String subject,
                       String message,
                       Vector fileNames)
                throws DBException,
                       LogException

Deprecated.

Send this user an e-mail with file attachments.

Parameters:

subject - Subject of the e-mail

message - Message to send in body of e-mail

fileNames - of the files to attach

Throws:

DBException - If the mail message cannot be sent

LogException

sendFollowUpEmail

public void sendFollowUpEmail()
                       throws DBException

Deprecated.

Once a user has validated his email address through the email validation servlet, the user will receive this message giving previously requested username/password.

Specified by:

sendFollowUpEmail in interface UserInfo

Throws:

DBException - The exception description.

setAccountStatus

public void setAccountStatus(String accountStatus)
                      throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the current status of the account - "A" (active), "D" (disabled), "I" (inactive)

Specified by:

setAccountStatus in interface UserInfo

Parameters:

accountStatus - java.lang.String

Throws:

DBException - If there is an error

setEmail

public void setEmail(String email)
              throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the email address

Specified by:

setEmail in interface UserInfo

Parameters:

email - java.lang.String

Throws:

DBException - If there is an error

setEmailValCode

public void setEmailValCode(String code)
                     throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the code required for auth. via email

Specified by:

setEmailValCode in interface UserInfo

Parameters:

code - java.lang.String

Throws:

DBException - If there is an error

setLoginName

public void setLoginName(String loginName)
                  throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the login name

Specified by:

setLoginName in interface UserInfo

Parameters:

loginName - java.lang.String

Throws:

DBException - If there is an error

setPassword

public void setPassword(String password)
                 throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the password

Specified by:

setPassword in interface UserInfo

Parameters:

password - java.lang.String

Throws:

DBException - If there is an error

setPasswordField

public void setPasswordField(String data)
                      throws DBException

Deprecated.

Hash the password before writing it to the database

Parameters:

data - The data to set for the password field

Throws:

DBException

setRegComplete

public void setRegComplete(boolean status)
                    throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the extended registration complete flag - "Y" or "N"

Specified by:

setRegComplete in interface UserInfo

Parameters:

status - java.lang.String

Throws:

DBException - If there is an error

setRegistrationDomain

public void setRegistrationDomain(String domain)
                           throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the registration domain

Specified by:

setRegistrationDomain in interface UserInfo

Parameters:

domain - java.lang.String

Throws:

DBException - If there is an error

See Also:

RegistrationDomain

setUid

public void setUid(int uid)
            throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the user UID

Specified by:

setUid in interface UserInfo

Parameters:

uid - The uid of the user

Throws:

DBException - If there is an error

setupFields

public void setupFields()
                 throws DBException

Deprecated.

Description copied from class: DBObject

Method to set up the fields for this database object. This method should be defined in the implementing object and should make calls to addField, addKey, setMultiValued, etc. as required to define the content of the DBObject. Each setupFields method should call "super.setupFields()" so that field definitions can be "inheritcable"

Overrides:

setupFields in class DBObject

Throws:

DBException

See Also:

DBObject.setupFields()

setUserName

public void setUserName(String name)
                 throws DBException

Deprecated.

Description copied from interface: UserInfo

Sets the user name

Specified by:

setUserName in interface UserInfo

Parameters:

name - java.lang.String

Throws:

DBException - If there is an error

update

public void update()
            throws DBException

Deprecated.

Description copied from interface: UserInfo

Update the user in the repository with modified properties

Specified by:

update in interface UserInfo

Overrides:

update in class SecuredDBObject

Throws:

DBException

getPrimaryGroup

public String getPrimaryGroup()
                       throws DBException

Deprecated.

Description copied from interface: UserInfo

the primary group of this user is appropriate for unix-like purposes, such as setting the group for a file permission

Specified by:

getPrimaryGroup in interface UserInfo

Returns:

name of the primary group of this user; null if no group is found

Throws:

DBException