|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.om.BaseObject | +--org.apache.turbine.om.security.SecurityObject | +--org.apache.turbine.om.security.TurbineUser
A generic implementation of User interface.
This basic implementation contains the functionality that is
expected to be common among all User implementations.
You are welcome to extend this class if you wish to have
custom functionality in your user objects (like accessor methods
for custom attributes). Note* that implementing a different scheme
of user data storage involves writing an implementation of
UserManager
interface.
Field Summary | |
private java.util.Date |
createDate
|
private java.util.Date |
lastAccessDate
|
private java.util.Hashtable |
permStorage
This is data that will survive a servlet engine restart. |
private java.util.Hashtable |
tempStorage
This is data that will not survive a servlet engine restart. |
Fields inherited from class org.apache.turbine.om.security.SecurityObject |
attributes, name |
Fields inherited from class org.apache.turbine.om.BaseObject |
errMsg, is_new, modified, NEW_ID, primaryKey |
Fields inherited from interface org.apache.turbine.om.security.User |
ACCESS_COUNTER, CONFIRM_DATA, CONFIRM_VALUE, EMAIL, FIRST_NAME, HAS_LOGGED_IN, LAST_LOGIN, LAST_NAME, PASSWORD, SESSION_ACCESS_COUNTER, SESSION_KEY, USERNAME |
Constructor Summary | |
TurbineUser()
Constructor. |
Method Summary | |
int |
getAccessCounter()
Gets the access counter for a user from perm storage. |
int |
getAccessCounterForSession()
Gets the access counter for a user during a session. |
java.lang.String |
getConfirmed()
Gets the confirmation value. |
java.util.Date |
getCreateDate()
Gets the create date for this User. |
java.lang.String |
getEmail()
Returns the email address for this user. |
java.lang.String |
getFirstName()
Returns the first name for this user. |
private java.lang.Boolean |
getHasLoggedIn()
This gets whether or not someone has logged in. |
java.util.Date |
getLastAccessDate()
Gets the last access date for this User. |
java.util.Date |
getLastLogin()
Get last login date/time for this user. |
java.lang.String |
getLastName()
Returns the last name for this user. |
java.lang.String |
getPassword()
Get password for this user. |
java.lang.Object |
getPerm(java.lang.String name)
Get an object from permanent storage. |
java.lang.Object |
getPerm(java.lang.String name,
java.lang.Object def)
Get an object from permanent storage; return default if value is null. |
java.util.Hashtable |
getPermStorage()
This should only be used in the case where we want to save the data to the database. |
java.lang.Object |
getTemp(java.lang.String name)
Get an object from temporary storage. |
java.lang.Object |
getTemp(java.lang.String name,
java.lang.Object def)
Get an object from temporary storage; return default if value is null. |
java.util.Hashtable |
getTempStorage()
This should only be used in the case where we want to save the data to the database. |
java.lang.String |
getUserName()
Returns the username for this user. |
boolean |
hasLoggedIn()
The user is considered logged in if they have not timed out. |
void |
incrementAccessCounter()
Increments the permanent hit counter for the user. |
void |
incrementAccessCounterForSession()
Increments the session hit counter for the user. |
boolean |
isConfirmed()
This method reports whether or not the user has been confirmed in the system by checking the User.CONFIRM_VALUE column in the users record to see if it is equal to User.CONFIRM_DATA. |
java.lang.Object |
removeTemp(java.lang.String name)
Remove an object from temporary storage and return the object. |
void |
save()
Saves this object to the data store. |
void |
setAccessCounter(int cnt)
Sets the access counter for a user, saved in perm storage. |
void |
setAccessCounterForSession(int cnt)
Sets the session access counter for a user, saved in temp storage. |
void |
setConfirmed(java.lang.String value)
Sets the confirmation value. |
void |
setCreateDate(java.util.Date date)
Sets the create date for this User. |
void |
setEmail(java.lang.String address)
Sets the email address. |
void |
setFirstName(java.lang.String firstName)
Sets the first name for this user. |
void |
setHasLoggedIn(java.lang.Boolean value)
This sets whether or not someone has logged in. |
void |
setLastAccessDate()
Sets the last access date for this User. |
void |
setLastLogin(java.util.Date date)
Set last login date/time. |
void |
setLastName(java.lang.String lastName)
Sets the last name for this user. |
void |
setPassword(java.lang.String password)
Set password. |
void |
setPerm(java.lang.String name,
java.lang.Object value)
Put an object into permanent storage. |
void |
setPermStorage(java.util.Hashtable stuff)
This should only be used in the case where we want to save the data to the database. |
void |
setTemp(java.lang.String name,
java.lang.Object value)
Put an object into temporary storage. |
void |
setTempStorage(java.util.Hashtable storage)
This should only be used in the case where we want to save the data to the database. |
void |
setUserName(java.lang.String username)
Sets the username for this user. |
void |
updateLastLogin()
Updates the last login date in the database. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent hsbe)
Implement this method if you wish to be notified when the User has been Bound to the session. |
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent hsbe)
Implement this method if you wish to be notified when the User has been Unbound from the session. |
Methods inherited from class org.apache.turbine.om.security.SecurityObject |
compareTo, getAttribute, getAttributes, getName, setAttribute, setAttributes, setName, toString |
Methods inherited from class org.apache.turbine.om.BaseObject |
equals, equals, getByName, getByPeerName, getByPosition, getPrimaryKey, getPrimaryKeyAsBigDecimal, getPrimaryKeyAsInt, getPrimaryKeyAsLong, getPrimaryKeyAsString, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey |
Methods inherited from class java.lang.Object |
|
Methods inherited from interface org.apache.turbine.om.security.SecurityEntity |
getName, setName |
Field Detail |
private java.util.Date createDate
private java.util.Date lastAccessDate
private java.util.Hashtable permStorage
private java.util.Hashtable tempStorage
Constructor Detail |
public TurbineUser()
Method Detail |
public int getAccessCounterForSession()
getAccessCounterForSession
in interface User
public int getAccessCounter()
getAccessCounter
in interface User
public java.util.Date getCreateDate()
getCreateDate
in interface User
public java.util.Date getLastAccessDate()
getLastAccessDate
in interface User
public java.util.Date getLastLogin()
getLastLogin
in interface User
public java.lang.String getPassword()
getPassword
in interface User
public java.lang.Object getPerm(java.lang.String name)
getPerm
in interface User
name
- The object's name.public java.lang.Object getPerm(java.lang.String name, java.lang.Object def)
getPerm
in interface User
name
- The object's name.def
- A default value to return.public java.util.Hashtable getPermStorage()
getPermStorage
in interface User
public java.lang.Object getTemp(java.lang.String name)
getTemp
in interface User
name
- The object's name.public java.lang.Object getTemp(java.lang.String name, java.lang.Object def)
getTemp
in interface User
name
- The object's name.def
- A default value to return.public java.lang.String getUserName()
getUserName
in interface User
public java.lang.String getFirstName()
getFirstName
in interface User
public java.lang.String getLastName()
getLastName
in interface User
public boolean hasLoggedIn()
hasLoggedIn
in interface User
public java.lang.String getEmail()
getEmail
in interface User
public void incrementAccessCounter()
incrementAccessCounter
in interface User
public void incrementAccessCounterForSession()
incrementAccessCounterForSession
in interface User
public java.lang.Object removeTemp(java.lang.String name)
removeTemp
in interface User
name
- The name of the object to remove.public void setAccessCounter(int cnt)
setAccessCounter
in interface User
cnt
- The new count.public void setAccessCounterForSession(int cnt)
setAccessCounterForSession
in interface User
cnt
- The new count.public void setLastAccessDate()
setLastAccessDate
in interface User
public void setCreateDate(java.util.Date date)
setCreateDate
in interface User
date
- The create date.public void setLastLogin(java.util.Date date)
setLastLogin
in interface User
date
- The last login date.public void setPassword(java.lang.String password)
setPassword
in interface User
password
- The new password.public void setPerm(java.lang.String name, java.lang.Object value)
setPerm
in interface User
name
- The object's name.value
- The object.public void setPermStorage(java.util.Hashtable stuff)
setPermStorage
in interface User
stuff
- A Hashtable.public java.util.Hashtable getTempStorage()
getTempStorage
in interface User
public void setTempStorage(java.util.Hashtable storage)
setTempStorage
in interface User
storage
- A Hashtable.private java.lang.Boolean getHasLoggedIn()
public void setHasLoggedIn(java.lang.Boolean value)
setHasLoggedIn
in interface User
value
- Whether someone has logged in or not.public void setTemp(java.lang.String name, java.lang.Object value)
setTemp
in interface User
name
- The object's name.value
- The object.public void setUserName(java.lang.String username)
setUserName
in interface User
username
- The user's username.public void setFirstName(java.lang.String firstName)
setFirstName
in interface User
firstName
- User's first name.public void setLastName(java.lang.String lastName)
setLastName
in interface User
lastName
- User's last name.public void setEmail(java.lang.String address)
setEmail
in interface User
address
- The email address.public boolean isConfirmed()
isConfirmed
in interface User
public void setConfirmed(java.lang.String value)
setConfirmed
in interface User
value
- The confirmation key value.public java.lang.String getConfirmed()
getConfirmed
in interface User
public void updateLastLogin() throws java.lang.Exception
updateLastLogin
in interface User
Exception,
- a generic exception.public void valueBound(javax.servlet.http.HttpSessionBindingEvent hsbe)
valueBound
in interface javax.servlet.http.HttpSessionBindingListener
hsbe
- The HttpSessionBindingEvent.public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent hsbe)
valueUnbound
in interface javax.servlet.http.HttpSessionBindingListener
hsbe
- The HttpSessionBindingEvent.public void save() throws java.lang.Exception
save
in class BaseObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |