|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.turbine.om.security.SecurityObject<User>
org.apache.turbine.om.security.TurbineUser
public class 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 normally involves writing an implementation of
UserManager interface.
| Field Summary |
|---|
| 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. |
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 |
getName()
Returns the name of 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<java.lang.String,java.lang.Object> |
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; return null if the object can't be found. |
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<java.lang.String,java.lang.Object> |
getTempStorage()
This should only be used in the case where we want to save the data to the database. |
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 |
save(java.sql.Connection conn)
not implemented |
void |
save(java.lang.String dbname)
not implemented |
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 |
setName(java.lang.String name)
Sets the name of 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<java.lang.String,java.lang.Object> permStorage)
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<java.lang.String,java.lang.Object> tempStorage)
This should only be used in the case where we want to save the data to the database. |
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, getId, getIdAsObj, setAttribute, setAttributes, setId, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.turbine.om.security.SecurityEntity |
|---|
getId, getIdAsObj, setId |
| Constructor Detail |
|---|
public TurbineUser()
| Method Detail |
|---|
public int getAccessCounterForSession()
getAccessCounterForSession in interface Userpublic int getAccessCounter()
getAccessCounter in interface Userpublic java.util.Date getCreateDate()
getCreateDate in interface Userpublic java.util.Date getLastAccessDate()
getLastAccessDate in interface Userpublic java.util.Date getLastLogin()
getLastLogin in interface Userpublic java.lang.String getPassword()
getPassword in interface Userpublic java.lang.Object getPerm(java.lang.String name)
getPerm in interface Username - The object's name.
public java.lang.Object getPerm(java.lang.String name,
java.lang.Object def)
getPerm in interface Username - The object's name.def - A default value to return.
public java.util.Hashtable<java.lang.String,java.lang.Object> getPermStorage()
getPermStorage in interface Userpublic java.lang.Object getTemp(java.lang.String name)
getTemp in interface Username - The object's name.
public java.lang.Object getTemp(java.lang.String name,
java.lang.Object def)
getTemp in interface Username - The object's name.def - A default value to return.
public java.lang.String getFirstName()
getFirstName in interface Userpublic java.lang.String getLastName()
getLastName in interface Userpublic boolean hasLoggedIn()
hasLoggedIn in interface Userpublic java.lang.String getEmail()
getEmail in interface Userpublic void incrementAccessCounter()
incrementAccessCounter in interface Userpublic void incrementAccessCounterForSession()
incrementAccessCounterForSession in interface Userpublic java.lang.Object removeTemp(java.lang.String name)
removeTemp in interface Username - The name of the object to remove.
public void setAccessCounter(int cnt)
setAccessCounter in interface Usercnt - The new count.public void setAccessCounterForSession(int cnt)
setAccessCounterForSession in interface Usercnt - The new count.public void setLastAccessDate()
setLastAccessDate in interface Userpublic void setCreateDate(java.util.Date date)
setCreateDate in interface Userdate - The create date.public void setLastLogin(java.util.Date date)
setLastLogin in interface Userdate - The last login date.public void setPassword(java.lang.String password)
setPassword in interface Userpassword - The new password.
public void setPerm(java.lang.String name,
java.lang.Object value)
setPerm in interface Username - The object's name.value - The object.public void setPermStorage(java.util.Hashtable<java.lang.String,java.lang.Object> permStorage)
setPermStorage in interface UserpermStorage - A Hashtable.public java.util.Hashtable<java.lang.String,java.lang.Object> getTempStorage()
getTempStorage in interface Userpublic void setTempStorage(java.util.Hashtable<java.lang.String,java.lang.Object> tempStorage)
setTempStorage in interface Userstorage - A Hashtable.public void setHasLoggedIn(java.lang.Boolean value)
setHasLoggedIn in interface Uservalue - Whether someone has logged in or not.
public void setTemp(java.lang.String name,
java.lang.Object value)
setTemp in interface Username - The object's name.value - The object.public void setFirstName(java.lang.String firstName)
setFirstName in interface UserfirstName - User's first name.public void setLastName(java.lang.String lastName)
setLastName in interface UserlastName - User's last name.public void setEmail(java.lang.String address)
setEmail in interface Useraddress - The email address.public boolean isConfirmed()
isConfirmed in interface Userpublic void setConfirmed(java.lang.String value)
setConfirmed in interface Uservalue - The confirmation key value.public java.lang.String getConfirmed()
getConfirmed in interface User
public void updateLastLogin()
throws java.lang.Exception
updateLastLogin in interface Userjava.lang.Exception - a generic exception.public void valueBound(javax.servlet.http.HttpSessionBindingEvent hsbe)
valueBound in interface javax.servlet.http.HttpSessionBindingListenerhsbe - The HttpSessionBindingEvent.public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent hsbe)
valueUnbound in interface javax.servlet.http.HttpSessionBindingListenerhsbe - The HttpSessionBindingEvent.
public void save()
throws java.lang.Exception
java.lang.Exception
public void save(java.sql.Connection conn)
throws java.lang.Exception
conn -
java.lang.Exception
public void save(java.lang.String dbname)
throws java.lang.Exception
dbname -
java.lang.Exceptionpublic java.lang.String getName()
getName in interface SecurityEntitygetName in class SecurityObject<User>public void setName(java.lang.String name)
setName in interface SecurityEntitysetName in class SecurityObject<User>name - The name of the object.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||