Java Doc for User.java in » Web-Framework » TURBINE » org » apache » turbine » om » security » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.om.security

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.turbine.om.security .User

All known Subclasses:   org.apache.turbine.services.security.ldap .LDAPUser,  org.apache.turbine.services.security.torque .TorqueUser,
User
public interface User extends HttpSessionBindingListener,Serializable,SecurityEntity(Code)
This interface represents functionality that all users of the Turbine system require.
author:
   Frank Y. Kim
author:
   John D. McNally
author:
   Jon S. Stevens
author:
   Craig D. Berry
author:
   Henning P. Schmiedehausen
version:
   $Id: User.java 534527 2007-05-02 16:10:59Z tv $

Field Summary
String ACCESS_COUNTER
     The 'perm storage' key name for the access counter.
String CONFIRM_DATA

String CONFIRM_VALUE
     The 'perm storage' key for the confirm_value field.
String EMAIL
     The 'perm storage' key for the email field.
String FIRST_NAME
     The 'perm storage' key name for the first name.
String HAS_LOGGED_IN

String LAST_LOGIN
     The 'perm storage' key name for the last_login field.
String LAST_NAME
     The 'perm storage' key name for the last name.
String PASSWORD
     The 'perm storage' key name for the password field.
String SESSION_ACCESS_COUNTER

String SESSION_KEY
     The session key for the User object.
String USERNAME
     The 'perm storage' key name for the username field.

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.
String getConfirmed()
     Gets the confirmation value.
java.util.Date getCreateDate()
     Gets the create date for this User.
String getEmail()
     Returns the email address for this user.
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()
     Returns the user's last login date.
String getLastName()
     Returns the last name for this user.
String getPassword()
     Returns the user's password.
Object getPerm(String name)
     Get an object from permanent storage.
Parameters:
  name - The object's name.
Object getPerm(String name, Object def)
     Get an object from permanent storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return.
Hashtable getPermStorage()
     This should only be used in the case where we want to save the data to the database.
Object getTemp(String name)
     Get an object from temporary storage.
Parameters:
  name - The object's name.
Object getTemp(String name, Object def)
     Get an object from temporary storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return.
Hashtable getTempStorage()
     This should only be used in the case where we want to save the data to the database.
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 TurbineUserPeer.CONFIRM_VALUE column to see if it is equal to CONFIRM_DATA.
Object removeTemp(String name)
     Remove an object from temporary storage and return the object.
Parameters:
  name - The name of the object to remove.
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(String value)
     Sets the confirmation value.
void setCreateDate(java.util.Date date)
     Sets the creation date for this user.
void setEmail(String address)
     Sets the email address.
void setFirstName(String firstName)
     Sets the first name for this user.
void setHasLoggedIn(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 lastLogin)
     Set last login date/time.
void setLastName(String lastName)
     Sets the last name for this user.
void setPassword(String password)
     Set password.
void setPerm(String name, Object value)
     Put an object into permanent storage.
void setPermStorage(Hashtable storage)
     This should only be used in the case where we want to save the data to the database.
void setTemp(String name, Object value)
     Put an object into temporary storage.
void setTempStorage(Hashtable storage)
     This should only be used in the case where we want to save the data to the database.
void setUserName(String username)
     Sets the username for this user.
void updateLastLogin()
     Updates the last login date in the database.

Field Detail
ACCESS_COUNTER
String ACCESS_COUNTER(Code)
The 'perm storage' key name for the access counter.

CONFIRM_DATA
String CONFIRM_DATA(Code)
This is the value that is stored in the database for confirmed users

CONFIRM_VALUE
String CONFIRM_VALUE(Code)
The 'perm storage' key for the confirm_value field.

EMAIL
String EMAIL(Code)
The 'perm storage' key for the email field.

FIRST_NAME
String FIRST_NAME(Code)
The 'perm storage' key name for the first name.

HAS_LOGGED_IN
String HAS_LOGGED_IN(Code)
The 'temp storage' key name for the 'has logged in' flag

LAST_LOGIN
String LAST_LOGIN(Code)
The 'perm storage' key name for the last_login field.

LAST_NAME
String LAST_NAME(Code)
The 'perm storage' key name for the last name.

PASSWORD
String PASSWORD(Code)
The 'perm storage' key name for the password field.

SESSION_ACCESS_COUNTER
String SESSION_ACCESS_COUNTER(Code)
The 'temp storage' key name for the session access counter

SESSION_KEY
String SESSION_KEY(Code)
The session key for the User object.

USERNAME
String USERNAME(Code)
The 'perm storage' key name for the username field.

Method Detail
getAccessCounter
int getAccessCounter()(Code)
Gets the access counter for a user from perm storage. The access counter for the user.

getAccessCounterForSession
int getAccessCounterForSession()(Code)
Gets the access counter for a user during a session. The access counter for the user for the session.

getConfirmed
String getConfirmed()(Code)
Gets the confirmation value. The confirmed value

getCreateDate
java.util.Date getCreateDate()(Code)
Gets the create date for this User. This is the time at which the user object was created. A Java Date with the date of creation for the user.

getEmail
String getEmail()(Code)
Returns the email address for this user. A String with the user's email address.

getFirstName
String getFirstName()(Code)
Returns the first name for this user. A String with the user's first name.

getLastAccessDate
java.util.Date getLastAccessDate()(Code)
Gets the last access date for this User. This is the last time that the user object was referenced. A Java Date with the last access date for the user.

getLastLogin
java.util.Date getLastLogin()(Code)
Returns the user's last login date. A Java Date with the last login date for the user.

getLastName
String getLastName()(Code)
Returns the last name for this user. A String with the user's last name.

getPassword
String getPassword()(Code)
Returns the user's password. This method should not be used by the application directly, because it's meaning depends upon the implementation of UserManager that manages this particular user object. Some implementations will use this attribute for storing a password encrypted in some way, other will not use it at all, when user entered password is presented to some external authority (like NT domain controller) to validate it. See also org.apache.turbine.services.security.UserManager.authenticate(UserString) . A String with the password for the user.

getPerm
Object getPerm(String name)(Code)
Get an object from permanent storage.
Parameters:
  name - The object's name. An Object with the given name.

getPerm
Object getPerm(String name, Object def)(Code)
Get an object from permanent storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return. An Object with the given name.

getPermStorage
Hashtable getPermStorage()(Code)
This should only be used in the case where we want to save the data to the database. A Hashtable.

getTemp
Object getTemp(String name)(Code)
Get an object from temporary storage.
Parameters:
  name - The object's name. An Object with the given name.

getTemp
Object getTemp(String name, Object def)(Code)
Get an object from temporary storage; return default if value is null.
Parameters:
  name - The object's name.
Parameters:
  def - A default value to return. An Object with the given name.

getTempStorage
Hashtable getTempStorage()(Code)
This should only be used in the case where we want to save the data to the database. A Hashtable.

getUserName
String getUserName()(Code)
Returns the username for this user. A String with the username.

hasLoggedIn
boolean hasLoggedIn()(Code)
The user is considered logged in if they have not timed out. True if the user has logged in.

incrementAccessCounter
void incrementAccessCounter()(Code)
Increments the permanent hit counter for the user.

incrementAccessCounterForSession
void incrementAccessCounterForSession()(Code)
Increments the session hit counter for the user.

isConfirmed
boolean isConfirmed()(Code)
This method reports whether or not the user has been confirmed in the system by checking the TurbineUserPeer.CONFIRM_VALUE column to see if it is equal to CONFIRM_DATA. True if the user has been confirmed.

removeTemp
Object removeTemp(String name)(Code)
Remove an object from temporary storage and return the object.
Parameters:
  name - The name of the object to remove. An Object.

setAccessCounter
void setAccessCounter(int cnt)(Code)
Sets the access counter for a user, saved in perm storage.
Parameters:
  cnt - The new count.

setAccessCounterForSession
void setAccessCounterForSession(int cnt)(Code)
Sets the session access counter for a user, saved in temp storage.
Parameters:
  cnt - The new count.

setConfirmed
void setConfirmed(String value)(Code)
Sets the confirmation value.
Parameters:
  value - The confirmation key value.

setCreateDate
void setCreateDate(java.util.Date date)(Code)
Sets the creation date for this user.
Parameters:
  date - Creation date

setEmail
void setEmail(String address)(Code)
Sets the email address.
Parameters:
  address - The email address.

setFirstName
void setFirstName(String firstName)(Code)
Sets the first name for this user.
Parameters:
  firstName - User's first name.

setHasLoggedIn
void setHasLoggedIn(Boolean value)(Code)
This sets whether or not someone has logged in. hasLoggedIn() returns this value.
Parameters:
  value - Whether someone has logged in or not.

setLastAccessDate
void setLastAccessDate()(Code)
Sets the last access date for this User. This is the last time that the user object was referenced.

setLastLogin
void setLastLogin(java.util.Date lastLogin)(Code)
Set last login date/time.
Parameters:
  lastLogin - The last login date.

setLastName
void setLastName(String lastName)(Code)
Sets the last name for this user.
Parameters:
  lastName - User's last name.

setPassword
void setPassword(String password)(Code)
Set password. Application should not use this method directly, see User.getPassword() . See also org.apache.turbine.services.security.UserManager.changePassword(UserStringString) .
Parameters:
  password - The new password.

setPerm
void setPerm(String name, Object value)(Code)
Put an object into permanent storage.
Parameters:
  name - The object's name.
Parameters:
  value - The object.

setPermStorage
void setPermStorage(Hashtable storage)(Code)
This should only be used in the case where we want to save the data to the database.
Parameters:
  storage - A Hashtable.

setTemp
void setTemp(String name, Object value)(Code)
Put an object into temporary storage.
Parameters:
  name - The object's name.
Parameters:
  value - The object.

setTempStorage
void setTempStorage(Hashtable storage)(Code)
This should only be used in the case where we want to save the data to the database.
Parameters:
  storage - A Hashtable.

setUserName
void setUserName(String username)(Code)
Sets the username for this user.
Parameters:
  username - The user's username.

updateLastLogin
void updateLastLogin() throws Exception(Code)
Updates the last login date in the database.
exception:
  Exception - A generic exception.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.