com.ecyrd.jspwiki.auth.user
Class DefaultUserProfile

java.lang.Object
  extended by com.ecyrd.jspwiki.auth.user.DefaultUserProfile
All Implemented Interfaces:
UserProfile

public class DefaultUserProfile
extends Object
implements UserProfile

Default implementation for representing wiki user information, such as the login name, full name, wiki name, and e-mail address.

Since:
2.3
Version:
$Revision: 1.6 $ $Date: 2005/12/12 05:51:43 $
Author:
Janne Jalkanen, Andrew Jaquith

Constructor Summary
DefaultUserProfile()
           
 
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 user profile is new.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DefaultUserProfile

public DefaultUserProfile()
Method Detail

equals

public boolean equals(Object o)
Specified by:
equals in interface UserProfile
Overrides:
equals in class Object

getCreated

public Date getCreated()
Returns the creation date

Specified by:
getCreated in interface UserProfile
Returns:
the creation date
See Also:
UserProfile.getCreated()

getEmail

public String getEmail()
Returns the user's e-mail address.

Specified by:
getEmail in interface UserProfile
Returns:
the e-mail address

getFullname

public String getFullname()
Returns the user's full name.

Specified by:
getFullname in interface UserProfile
Returns:
the full name

getLastModified

public Date getLastModified()
Returns the last-modified date.

Specified by:
getLastModified in interface UserProfile
Returns:
the last-modified date
See Also:
UserProfile.getLastModified()

getLoginName

public String getLoginName()
Returns the user's login name.

Specified by:
getLoginName in interface UserProfile
Returns:
the login name

getPassword

public String getPassword()
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 UserDatabaseimplementation, in most cases the value returned by this method will be a password hash, not the password itself.

Specified by:
getPassword in interface UserProfile
Returns:
the password

getWikiName

public String getWikiName()
Returns the user's wiki name.

Specified by:
getWikiName in interface UserProfile
Returns:
the wiki name.

isNew

public boolean isNew()
Returns true if the user profile is new. This implementation checks whether getLastModified() returns null to determine the status.

Specified by:
isNew in interface UserProfile
See Also:
UserProfile.isNew()

setCreated

public void setCreated(Date date)
Description copied from interface: UserProfile
Sets the created date.

Specified by:
setCreated in interface UserProfile
Parameters:
date - the creation date
See Also:
UserProfile.setCreated(java.util.Date)

setEmail

public void setEmail(String email)
Sets the user's e-mail address.

Specified by:
setEmail in interface UserProfile
Parameters:
email - the e-mail address

setFullname

public void setFullname(String arg)
Sets the user's full name. For example, "Janne Jalkanen."

Specified by:
setFullname in interface UserProfile
Parameters:
arg - the full name

setLastModified

public void setLastModified(Date date)
Sets the last-modified date.

Specified by:
setLastModified in interface UserProfile
Parameters:
date - the last-modified date
See Also:
UserProfile.setLastModified(java.util.Date)

setLoginName

public void setLoginName(String name)
Sets the name by which the user logs in. The login name is used as the username for custom authentication (see AuthenticationManager.login(WikiSession, String, String)). The login name is typically a short name ("jannej"). In contrast, the wiki name is typically of type FirstnameLastName ("JanneJalkanen").

Specified by:
setLoginName in interface UserProfile
Parameters:
name - the login name

setPassword

public void setPassword(String arg)
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.

Specified by:
setPassword in interface UserProfile
Parameters:
arg - the password

setWikiName

public void setWikiName(String name)
Sets the user's wiki name. This is typically of type FirstnameLastName ("JanneJalkanen").

Specified by:
setWikiName in interface UserProfile
Parameters:
name - the wiki name

toString

public String toString()
Returns a string representation of this user profile.

Specified by:
toString in interface UserProfile
Overrides:
toString in class Object
Returns:
the string