|
| |
|
| java.lang.Object
 net.jforum.entities.UserSession
| UserSession | | public class UserSession implements Serializable(Code) | | Stores information about user's session.
author:
Rafael Steil
version:
$Id: UserSession.java,v 1.37 2007/09/10 01:17:20 rafaelsteil Exp $ |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| UserSession | | public UserSession()(Code) | | |
| createNewCaptcha | | public void createNewCaptcha()(Code) | | create a new image captcha
|
| dataToUser | | public void dataToUser(User user)(Code) | | Sets a new user session information using information from an User instance.
This method sets the user id, username, the number of private messages, the session's start
time ( set to the current date and time ) and the language.
Parameters:
user - The User instance to get data from |
| destroyCaptcha | | public void destroyCaptcha()(Code) | | Destroy the current captcha validation is done
|
| getAutoLogin | | public boolean getAutoLogin()(Code) | | Gets auto-login status
true if auto-login is enabled, or false if disabled. |
| getCaptchaImage | | public BufferedImage getCaptchaImage()(Code) | | Get the captcha image to challenge the user
BufferedImage the captcha image to challenge the user |
| getLastVisit | | public Date getLastVisit()(Code) | | Gets user's last visit time
Time in miliseconds |
| getPrivateMessages | | public int getPrivateMessages()(Code) | | Returns the privateMessages. |
| getSessionId | | public String getSessionId()(Code) | | Gets the session id related to this user session
A string with the session id |
| getSessionTime | | public long getSessionTime()(Code) | | Gets the session time.
The session time |
| getStartTime | | public Date getStartTime()(Code) | | Gets user's session start time
Start time in miliseconds |
| getUserId | | public int getUserId()(Code) | | Gets user's id
The user id |
| getUsername | | public String getUsername()(Code) | | Gets the username
The username |
| isAdmin | | public boolean isAdmin()(Code) | | Checks if the user is an administrator
true if the user is an administrator |
| isBot | | public boolean isBot()(Code) | | true if this user session is from any robot |
| isModerator | | public boolean isModerator()(Code) | | Checks if the user is a moderator
true if the user has moderations rights |
| isModerator | | public boolean isModerator(int forumId)(Code) | | Checks if the user can moderate a forum
Parameters:
forumId - the forum's id to check for moderation rights true if the user has moderations rights |
| makeAnonymous | | public void makeAnonymous()(Code) | | Makes the user's session "anoymous" - eg, the user. This method sets the session's start and
last visit time to the current datetime, the user id to the return of a call to
SystemGlobals.getIntValue(ConfigKeys.ANONYMOUS_USER_ID) and finally sets
session attribute named "logged" to "0" will be considered a non-authenticated / anonymous
user
|
| registerBasicInfo | | public void registerBasicInfo()(Code) | | Sets the startup and last visit time to now, as well set the
user id to Anonymous. This method is usually called when the
user hits the forum for the first time.
|
| sessionLastUpdate | | public Date sessionLastUpdate()(Code) | | |
| setAutoLogin | | public void setAutoLogin(boolean autoLogin)(Code) | | Enable or disable auto-login.
Parameters:
autoLogin - true or false to represent auto-login status |
| setLastVisit | | public void setLastVisit(Date lastVisit)(Code) | | Set session last visit time.
Parameters:
lastVisit - Time in miliseconds |
| setPrivateMessages | | public void setPrivateMessages(int privateMessages)(Code) | |
Parameters:
privateMessages - The privateMessages to set. |
| setSessionId | | public void setSessionId(String sessionId)(Code) | | |
| setSessionTime | | public void setSessionTime(long sessionTime)(Code) | | |
| setStartTime | | public void setStartTime(Date startTime)(Code) | | Set session's start time.
Parameters:
startTime - Start time in miliseconds |
| setUserId | | public void setUserId(int userId)(Code) | | Set user's id
Parameters:
userId - The user id |
| setUsername | | public void setUsername(String username)(Code) | | Set user's name
Parameters:
username - The username |
| updateSessionTime | | public void updateSessionTime()(Code) | | Update the session time.
|
| validateCaptchaResponse | | public boolean validateCaptchaResponse(String userResponse)(Code) | | Validate the captcha response of user
Parameters:
userResponse - String the captcha response from user boolean true if the answer is valid, otherwise return false |
|
|
|