|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserProfile
Class for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.
Method Summary | |
---|---|
boolean |
equals(Object o)
|
Date |
getCreated()
Returns the creation date. |
String |
getEmail()
Returns the user's e-mail address. |
String |
getFullname()
Returns the user's full name. |
Date |
getLastModified()
Returns the last-modified date. |
String |
getLoginName()
Returns the user's login name. |
String |
getPassword()
Returns the user password for use with custom authentication. |
String |
getWikiName()
Returns the user's wiki name. |
boolean |
isNew()
Returns true if the profile has never been
saved before. |
void |
setCreated(Date date)
Sets the created date. |
void |
setEmail(String email)
Sets the user's e-mail address. |
void |
setFullname(String arg)
Sets the user's full name. |
void |
setLastModified(Date date)
Sets the last-modified date |
void |
setLoginName(String name)
Sets the name by which the user logs in. |
void |
setPassword(String arg)
Sets the user's password for use with custom authentication. |
void |
setWikiName(String name)
Sets the user's wiki name. |
String |
toString()
Returns a string representation of this user profile. |
Method Detail |
---|
boolean equals(Object o)
equals
in class Object
Date getCreated()
String getEmail()
String getFullname()
Date getLastModified()
String getLoginName()
String getPassword()
UserDatabase
implementation, in most cases the
value returned by this method will be a password hash, not the password
itself.
String getWikiName()
boolean isNew()
true
if the profile has never been
saved before. Implementing classes might check the
last modified date, for example, to determine this.
void setCreated(Date date)
date
- the creation datevoid setEmail(String email)
email
- the e-mail addressvoid setFullname(String arg)
arg
- the full namevoid setLastModified(Date date)
date
- the last-modified datevoid setLoginName(String name)
AuthenticationManager.login(WikiSession, String, String)
,
UserDatabaseLoginModule
). The login
name is typically a short name ("jannej"). In contrast, the wiki name is
typically of type FirstnameLastName ("JanneJalkanen").
name
- the login namevoid setPassword(String arg)
UserDatabase.save(UserProfile)
).
Note that the password field is not meaningful for container
authentication; the user's private credentials are generally stored
elsewhere.
arg
- the passwordvoid setWikiName(String name)
name
- the wiki nameString toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |