user.html

turbine教程

<PRE>
public static final java.lang.String <B>HAS_LOGGED_IN</B></PRE>
<DL>
<DD>The 'temp storage' key name for the 'has logged in' flag</DL>
<HR>

<A NAME="SESSION_KEY"><!-- --></A><H3>
SESSION_KEY</H3>
<PRE>
public static final java.lang.String <B>SESSION_KEY</B></PRE>
<DL>
<DD>The session key for the User object.</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getAccessCounter()"><!-- --></A><H3>
getAccessCounter</H3>
<PRE>
public int <B>getAccessCounter</B>()</PRE>
<DL>
<DD>Gets the access counter for a user from perm storage.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The access counter for the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getAccessCounterForSession()"><!-- --></A><H3>
getAccessCounterForSession</H3>
<PRE>
public int <B>getAccessCounterForSession</B>()</PRE>
<DL>
<DD>Gets the access counter for a user during a session.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The access counter for the user for the session.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastAccessDate()"><!-- --></A><H3>
getLastAccessDate</H3>
<PRE>
public java.util.Date <B>getLastAccessDate</B>()</PRE>
<DL>
<DD>Gets the last access date for this User. This is the last time
 that the user object was referenced.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Java Date with the last access date for the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getCreateDate()"><!-- --></A><H3>
getCreateDate</H3>
<PRE>
public java.util.Date <B>getCreateDate</B>()</PRE>
<DL>
<DD>Gets the create date for this User.  This is the time at which
 the user object was created.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Java Date with the date of creation for the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastLogin()"><!-- --></A><H3>
getLastLogin</H3>
<PRE>
public java.util.Date <B>getLastLogin</B>()</PRE>
<DL>
<DD>Returns the user's last login date.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Java Date with the last login date for the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getPassword()"><!-- --></A><H3>
getPassword</H3>
<PRE>
public java.lang.String <B>getPassword</B>()</PRE>
<DL>
<DD>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 <A HREF="../../../../../org/apache/turbine/services/security/UserManager.html#authenticate(org.apache.turbine.om.security.User, java.lang.String)"><CODE>UserManager.authenticate(User,String)</CODE></A>.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the password for the user.</DL>
</DD>
</DL>
<HR>

<A NAME="getPerm(java.lang.String)"><!-- --></A><H3>
getPerm</H3>
<PRE>
public java.lang.Object <B>getPerm</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Get an object from permanent storage.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The object's name.<DT><B>Returns:</B><DD>An Object with the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="getPerm(java.lang.String, java.lang.Object)"><!-- --></A><H3>
getPerm</H3>
<PRE>
public java.lang.Object <B>getPerm</B>(java.lang.String&nbsp;name,
                                java.lang.Object&nbsp;def)</PRE>
<DL>
<DD>Get an object from permanent storage; return default if value
 is null.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The object's name.<DD><CODE>def</CODE> - A default value to return.<DT><B>Returns:</B><DD>An Object with the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="getPermStorage()"><!-- --></A><H3>
getPermStorage</H3>
<PRE>
public java.util.Hashtable <B>getPermStorage</B>()</PRE>
<DL>
<DD>This should only be used in the case where we want to save the
 data to the database.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Hashtable.</DL>
</DD>
</DL>
<HR>

<A NAME="getTempStorage()"><!-- --></A><H3>
getTempStorage</H3>
<PRE>
public java.util.Hashtable <B>getTempStorage</B>()</PRE>
<DL>
<DD>This should only be used in the case where we want to save the
 data to the database.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A Hashtable.</DL>
</DD>
</DL>
<HR>

<A NAME="getTemp(java.lang.String)"><!-- --></A><H3>
getTemp</H3>
<PRE>
public java.lang.Object <B>getTemp</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Get an object from temporary storage.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The object's name.<DT><B>Returns:</B><DD>An Object with the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="getTemp(java.lang.String, java.lang.Object)"><!-- --></A><H3>
getTemp</H3>
<PRE>
public java.lang.Object <B>getTemp</B>(java.lang.String&nbsp;name,
                                java.lang.Object&nbsp;def)</PRE>
<DL>
<DD>Get an object from temporary storage; return default if value
 is null.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The object's name.<DD><CODE>def</CODE> - A default value to return.<DT><B>Returns:</B><DD>An Object with the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="getUserName()"><!-- --></A><H3>
getUserName</H3>
<PRE>
public java.lang.String <B>getUserName</B>()</PRE>
<DL>
<DD>Returns the username for this user.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the username.</DL>
</DD>
</DL>
<HR>

<A NAME="getFirstName()"><!-- --></A><H3>
getFirstName</H3>
<PRE>
public java.lang.String <B>getFirstName</B>()</PRE>
<DL>
<DD>Returns the first name for this user.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the user's first name.</DL>
</DD>
</DL>
<HR>

<A NAME="getLastName()"><!-- --></A><H3>
getLastName</H3>
<PRE>
public java.lang.String <B>getLastName</B>()</PRE>
<DL>
<DD>Returns the last name for this user.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the user's last name.</DL>
</DD>
</DL>
<HR>

<A NAME="getEmail()"><!-- --></A><H3>
getEmail</H3>
<PRE>
public java.lang.String <B>getEmail</B>()</PRE>
<DL>
<DD>Returns the email address for this user.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A String with the user's email address.</DL>
</DD>
</DL>
<HR>

<A NAME="setHasLoggedIn(java.lang.Boolean)"><!-- --></A><H3>
setHasLoggedIn</H3>
<PRE>
public void <B>setHasLoggedIn</B>(java.lang.Boolean&nbsp;value)</PRE>
<DL>
<DD>This sets whether or not someone has logged in.  hasLoggedIn()
 returns this value.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - Whether someone has logged in or not.</DL>
</DD>
</DL>
<HR>

<A NAME="hasLoggedIn()"><!-- --></A><H3>
hasLoggedIn</H3>
<PRE>
public boolean <B>hasLoggedIn</B>()</PRE>
<DL>
<DD>The user is considered logged in if they have not timed out.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>True if the user has logged in.</DL>
</DD>
</DL>
<HR>

<A NAME="incrementAccessCounter()"><!-- --></A><H3>
incrementAccessCounter</H3>
<PRE>
public void <B>incrementAccessCounter</B>()</PRE>
<DL>
<DD>Increments the permanent hit counter for the user.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="incrementAccessCounterForSession()"><!-- --></A><H3>
incrementAccessCounterForSession</H3>
<PRE>
public void <B>incrementAccessCounterForSession</B>()</PRE>
<DL>
<DD>Increments the session hit counter for the user.<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="removeTemp(java.lang.String)"><!-- --></A><H3>
removeTemp</H3>
<PRE>
public java.lang.Object <B>removeTemp</B>(java.lang.String&nbsp;name)</PRE>