| com.ecyrd.jspwiki.auth.user.UserProfile
All known Subclasses: com.ecyrd.jspwiki.auth.user.DefaultUserProfile,
| UserProfile | | public interface UserProfile (Code) | | Class for representing wiki user information, such as the login name, full
name, wiki name, and e-mail address. Note that since 2.6 the wiki name is
required to be automatically computed from the full name.
author:
Andrew Jaquith
since:
2.3 |
| getCreated | | public Date getCreated()(Code) | | Returns the creation date.
the creation date |
| getEmail | | public String getEmail()(Code) | | Returns the user's e-mail address.
the e-mail address |
| getFullname | | public String getFullname()(Code) | | Returns the user's full name.
the full name |
| getLastModified | | public Date getLastModified()(Code) | | Returns the last-modified date.
the date and time of last modification |
| getLoginName | | public String getLoginName()(Code) | | Returns the user's login name.
the login name |
| getPassword | | public String getPassword()(Code) | | Returns the user password for use with custom authentication. Note that
the password field is not meaningful for container authentication; the
user's private credentials are generally stored elsewhere. While it
depends on the
UserDatabase implementation, in most cases the
value returned by this method will be a password hash, not the password
itself.
the password |
| getWikiName | | public String getWikiName()(Code) | | Returns the user's wiki name, based on the full name with all
whitespace removed.
the wiki name. |
| isNew | | public boolean isNew()(Code) | | Returns true if the profile has never been
saved before. Implementing classes might check the
last modified date, for example, to determine this.
whether the profile is new |
| setCreated | | public void setCreated(Date date)(Code) | | Sets the created date.
Parameters:
date - the creation date |
| setEmail | | public void setEmail(String email)(Code) | | Sets the user's e-mail address.
Parameters:
email - the e-mail address |
| setFullname | | public void setFullname(String arg)(Code) | | Sets the user's full name. For example, "Janne Jalkanen."
Parameters:
arg - the full name |
| setLastModified | | public void setLastModified(Date date)(Code) | | Sets the last-modified date
Parameters:
date - the last-modified date |
| setPassword | | public void setPassword(String arg)(Code) | | Sets the user's password for use with custom authentication. It is
not the responsibility of implementing classes to hash the
password; that responsibility is borne by the UserDatabase implementation
during save operations (see
UserDatabase.save(UserProfile) ).
Note that the password field is not meaningful for container
authentication; the user's private credentials are generally stored
elsewhere.
Parameters:
arg - the password |
| setWikiName | | public void setWikiName(String name)(Code) | | No-op method. In previous versions of JSPWiki, the method
set the user's wiki name directly. Now, the wiki name is automatically
calculated based on the full name.
Parameters:
name - the wiki name |
| toString | | public String toString()(Code) | | Returns a string representation of this user profile.
the string |
|
|