Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Interface User

All Known Subinterfaces:
IntrospectiveUser
All Known Implementing Classes:
DbUser, LdapUser, MockUser, SimpleUserAdapter, UserProxy

public interface User

The User interface provides information about and services for users of the system. Users can be identified by a unique id or username. Users can also be organized into groups for easier management of permissions.

The name and email field will normally be required fields when creating user accounts for most implementations. 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 administrator permissions.

Security for User objects is provide by UserProxy protection proxy objects.

Instructions for those that wish to implement this interface to provide a custom User implementation appear in red.

See Also:
Group

Method Summary
 void deleteProperty(java.lang.String name)
          Deletes an extended property.
 java.util.Date getCreationDate()
          Returns the date that the user was created.
 java.lang.String getEmail()
          Returns the user's email address.
 long getID()
          Returns the user's id.
 java.util.Date getModificationDate()
          Returns the date that the user was last modified.
 java.lang.String getName()
          Returns the user's name.
 java.lang.String getPasswordHash()
          Returns the user's password in hashed form.
 Permissions getPermissions(AuthToken authToken)
          Returns the permissions for the user that correspond to the passed-in AuthToken.
 java.lang.String getProperty(java.lang.String name)
          Returns an extended property of the user.
 java.util.Iterator getPropertyNames()
          Returns an Iterator for all the names of the extended user properties.
 java.lang.String getUsername()
          Returns the user's username.
 boolean isAuthorized(long permissionType)
          Returns true if the handle on the object has the permission specified.
 boolean isEmailVisible()
          Returns true if the user has chosen to make her email visible to other users.
 boolean isNameVisible()
          Returns true if the user has chosen to make her name visible to other users.
 void setCreationDate(java.util.Date creationDate)
          Sets the creation date of the user.
 void setEmail(java.lang.String email)
          Sets the user's email address.
 void setEmailVisible(boolean visible)
          Sets whether a user's email is visible to other users.
 void setModificationDate(java.util.Date modificationDate)
          Sets the date the user was last modified.
 void setName(java.lang.String name)
          Sets the user's name.
 void setNameVisible(boolean visible)
          Sets whether a user's name is visible to other users.
 void setPassword(java.lang.String password)
          Sets the users's password.
 void setPasswordHash(java.lang.String passwordHash)
          Sets the user's password in hashed form.
 void setProperty(java.lang.String name, java.lang.String value)
          Sets an extended property of the user.
 

Method Detail

getID

long getID()
Returns the user's id. All ids must be unique in the system.

Returns:
the user's id.

getUsername

java.lang.String getUsername()
Returns the user's username. All usernames must be unique in the system.

Returns:
the username of the user.

getName

java.lang.String getName()
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.

Returns:
the name of the user.

setName

void setName(java.lang.String name)
             throws UnauthorizedException
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 administrator permissions.

isNameVisible

boolean isNameVisible()
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.

Returns:
true if the name is visible to other users.

setNameVisible

void setNameVisible(boolean visible)
                    throws UnauthorizedException
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 administrator permissions.

setPassword

void setPassword(java.lang.String password)
                 throws UnauthorizedException
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 administrator permissions.

getPasswordHash

java.lang.String getPasswordHash()
                                 throws UnauthorizedException
Returns the user's password in hashed form. This method is only intended for system administration functions and can be ignored by skin writers.

If your back-end user store does not support this operation, throw an UnsupportedOperationException.

Returns:
the hashed password.
Throws:
UnauthorizedException - if does not have administrator permissions.

setPasswordHash

void setPasswordHash(java.lang.String passwordHash)
                     throws UnauthorizedException
Sets the user's password in hashed form. This method is only intended for system administration functions and can be ignored by skin writers.

If your back-end user store does not support this operation, throw an UnsupportedOperationException.

Parameters:
passwordHash - the hashedPassword for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

getEmail

java.lang.String getEmail()
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.

If your back-end user store does not support this operation, always return null.

Returns:
the email address of the user.

setEmail

void setEmail(java.lang.String email)
              throws UnauthorizedException
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.

If your back-end user store does not support this operation, throw an UnsupportedOperationException.

Parameters:
email - new email address for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

isEmailVisible

boolean isEmailVisible()
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.

Returns:
true if the name is visible to other users.

setEmailVisible

void setEmailVisible(boolean visible)
                     throws UnauthorizedException
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 administrator permissions.

getCreationDate

java.util.Date getCreationDate()
Returns the date that the user was created.

If your back-end user store does not support this operation, throw an UnsupportedOperationException.

Returns:
the date the user was created.

setCreationDate

void setCreationDate(java.util.Date creationDate)
                     throws UnauthorizedException
Sets the creation date of the user. In most cases, the creation date will default to when the user was entered into the system. However, the date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.

Parameters:
creationDate - the date the user was created.
Throws:
UnauthorizedException - if does not have administrator permissions.

getModificationDate

java.util.Date getModificationDate()
Returns the date that the user was last modified.

Returns:
the date the user record was last modified.

setModificationDate

void setModificationDate(java.util.Date modificationDate)
                         throws UnauthorizedException
Sets the date the user was last modified. Skin authors should ignore this method since it only intended for system maintenance.

Parameters:
modificationDate - the date the user was modified.
Throws:
UnauthorizedException - if does not have administrator permissions.

getProperty

java.lang.String getProperty(java.lang.String name)
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.
Returns:
the value of the property

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)
                 throws UnauthorizedException
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. Property names and values must be valid Strings. If null or an empty length String is used, a NullPointerException will be thrown.

Parameters:
name - the name of the property to set.
value - the new value for the property.
Throws:
UnauthorizedException - if not allowed to edit.

deleteProperty

void deleteProperty(java.lang.String name)
                    throws UnauthorizedException
Deletes an extended property. If the property specified by name does not exist, this method will do nothing.

Parameters:
name - the name of the property to delete.
Throws:
UnauthorizedException - if not allowed to edit.

getPropertyNames

java.util.Iterator getPropertyNames()
Returns an Iterator for all the names of the extended user properties.

This method should typically be implemented as:

 if (auth.getUserID() == id) {
     return new Permissions(Permissions.USER_ADMIN);
 }
 else {
     return new Permissions(Permissions.NONE);
 }

Returns:
an Iterator for the property names.

getPermissions

Permissions getPermissions(AuthToken authToken)
Returns the permissions for the user that correspond to the passed-in AuthToken.

Parameters:
authToken - the auth token to look up permissions with.

isAuthorized

boolean isAuthorized(long permissionType)
Returns true if the handle on the object has the permission specified. A list of possible permissions can be found in the Permissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.

Because proxy objects will implement real security checking, this method should be implemented as:
return true;
.

Parameters:
permissionType - the permission to check for.
See Also:
Permissions

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.