The User interface provides information about and services for users
of the forum system. Users can be identified by a unique id or username.
Users can also be organized into Groups for easier management of
permissions at the forum level.
The name and email field will normally be required fields when creating
user accounts for most implementations of forums. However, some users may
wish to keep that information private. Therefore, there are two flags to
set if the name and email fields should be made visible to other users. If
the flags are set to deny access, getName() and getEmail() will throw
UnauthorizedExceptions to users that don't have ADMIN permissions.
Security for User objects is provide by UserProxy protection proxy objects.
See Also:Group
hasPermission(int type) Returns true if the handle on the object has the permission specified.
A list of possible permissions can be found in the ForumPermissions
class.
public boolean
isAnonymous() Returns true if the User object is an anonymous user object.
public boolean
isEmailVisible() Returns true if the user has chosen to make her email visible to other
users.
public boolean
isNameVisible() Returns true if the user has chosen to make her name visible to other
users.
Returns the user's email address. Email should be considered to be
a required field of a user account since it is critical to many
user operations performing. If the user sets emailVisible to false,
this method will always return null.
the email address of the user.
Returns the user's last login date. This date is updated in the DbAuthorizationFactory
after the user successfully is validated.
the last date that user successfully logged in
Returns the user's name. The user's name does not have to be to be
unique in the system. Some users may opt to not let others see their
name for privacy reasons. In that case, the user can set nameVisible to
false. In that case, a call to this method will return null.
the name of the user.
Returns the user's password in hashed form. This method is only intended
for system administration functions and can be ignored by skin writers.
the hashed password. throws: UnauthorizedException - if does not have ADMIN permissions.
Returns the permissions for the user that correspond to the
passed-in Authorization.
Parameters: authorization - the auth token to look up permissions with.
Returns an extended property of the user. Each user can have an
arbitrary number of extended properties. This lets particular skins
or filters provide enhanced functionality that is not part of the base
interface.
Parameters: name - the name of the property to get. the value of the property
Returns the user's Time Zone. This would drive how the Yazd forum would display the dates
and in which language. If there is no time zone set by the user, it returns
the default time zone.
TimeZone
Returns true if the handle on the object has the permission specified.
A list of possible permissions can be found in the ForumPermissions
class. Certain methods of this class are restricted to certain
permissions as specified in the method comments.
See Also:ForumPermissions
Returns true if the user has chosen to make her email visible to other
users. If the email field is not visible, calling getEmail() will throw
an UnauthorizedException.
true if the name is visible to other users.
Returns true if the user has chosen to make her name visible to other
users. If the name is not visible, calling getName() will throw an
UnauthorizedException.
true if the name is visible to other users.
Sets the user's email address. Email should be considered to be
a required field of a user account since it is critical to many
user operations performing.
Parameters: email - new email address for the user. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets whether a user's email is visible to other users. If the field
is set to not be visible, calling getEmail() will throw an
UnauthorizedException.
Parameters: visible - boolean value to determin if the name should be visible. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets the user's name. The user's name does not have to be to be
unique in the system.
Parameters: name - new name for the user. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets whether a user's name is visible to other users. If the field
is set to not be visible, calling getName() will throw an
UnauthorizedException.
Parameters: visible - boolean value to determin if the name should be visible. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets the users's password. The password should be passed in as
plain text. The way the password is stored is implementation dependent.
However, it is recommended to at least hash passwords with an
algorithm such as MD5.
Parameters: password - new password for the user. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets the user's password in hashed form. This method is only intended
for system administration functions and can be ignored by skin writers.
Parameters: passwordHash - the hashedPassword for the user. throws: UnauthorizedException - if does not have ADMIN permissions.
Sets an extended property of the user. Each user can have an
arbitrary number of extended properties. This lets particular skins
or filters provide enhanced functionality that is not part of the base
interface.
Parameters: name - the name of the property to set. Parameters: value - the new value for the property.
Boolean value to determin if user wants to
subscribe to the threads that he posts messages in.
Parameters: emailReply - boolean value to determin if user wants toreceive email when a reply on his/her message occur. throws: UnauthorizedException - if does not have ADMIN permissions.