Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Class MockUser

java.lang.Object
  extended by com.jivesoftware.base.MockUser
All Implemented Interfaces:
User

public class MockUser
extends java.lang.Object
implements User

A mock implementation of the User interface - developers should subclass this class to provide more functionality in their test cases.


Constructor Summary
MockUser(long id)
           
 
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 getPassword()
           
 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.
 void setUsername(java.lang.String username)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MockUser

public MockUser(long id)
Method Detail

getID

public long getID()
Description copied from interface: User
Returns the user's id. All ids must be unique in the system.

Specified by:
getID in interface User
Returns:
the user's id.

getUsername

public java.lang.String getUsername()
Description copied from interface: User
Returns the user's username. All usernames must be unique in the system.

Specified by:
getUsername in interface User
Returns:
the username of the user.

setUsername

public void setUsername(java.lang.String username)

getName

public java.lang.String getName()
Description copied from interface: User
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.

Specified by:
getName in interface User
Returns:
the name of the user.

setName

public void setName(java.lang.String name)
             throws UnauthorizedException
Description copied from interface: User
Sets the user's name. The user's name does not have to be to be unique in the system.

Specified by:
setName in interface User
Parameters:
name - new name for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

isNameVisible

public boolean isNameVisible()
Description copied from interface: User
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.

Specified by:
isNameVisible in interface User
Returns:
true if the name is visible to other users.

setNameVisible

public void setNameVisible(boolean visible)
                    throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setNameVisible in interface User
Parameters:
visible - boolean value to determin if the name should be visible.
Throws:
UnauthorizedException - if does not have administrator permissions.

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)
                 throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setPassword in interface User
Parameters:
password - new password for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

getPasswordHash

public java.lang.String getPasswordHash()
                                 throws UnauthorizedException
Description copied from interface: 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.

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

Specified by:
getPasswordHash in interface User
Returns:
the hashed password.
Throws:
UnauthorizedException - if does not have administrator permissions.

setPasswordHash

public void setPasswordHash(java.lang.String passwordHash)
                     throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setPasswordHash in interface User
Parameters:
passwordHash - the hashedPassword for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

getEmail

public java.lang.String getEmail()
Description copied from interface: User
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.

Specified by:
getEmail in interface User
Returns:
the email address of the user.

setEmail

public void setEmail(java.lang.String email)
              throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setEmail in interface User
Parameters:
email - new email address for the user.
Throws:
UnauthorizedException - if does not have administrator permissions.

isEmailVisible

public boolean isEmailVisible()
Description copied from interface: User
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.

Specified by:
isEmailVisible in interface User
Returns:
true if the name is visible to other users.

setEmailVisible

public void setEmailVisible(boolean visible)
                     throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setEmailVisible in interface User
Parameters:
visible - boolean value to determin if the name should be visible.
Throws:
UnauthorizedException - if does not have administrator permissions.

getCreationDate

public java.util.Date getCreationDate()
Description copied from interface: User
Returns the date that the user was created.

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

Specified by:
getCreationDate in interface User
Returns:
the date the user was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)
                     throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setCreationDate in interface User
Parameters:
creationDate - the date the user was created.
Throws:
UnauthorizedException - if does not have administrator permissions.

getModificationDate

public java.util.Date getModificationDate()
Description copied from interface: User
Returns the date that the user was last modified.

Specified by:
getModificationDate in interface User
Returns:
the date the user record was last modified.

setModificationDate

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

Specified by:
setModificationDate in interface User
Parameters:
modificationDate - the date the user was modified.
Throws:
UnauthorizedException - if does not have administrator permissions.

getProperty

public java.lang.String getProperty(java.lang.String name)
Description copied from interface: User
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.

Specified by:
getProperty in interface User
Parameters:
name - the name of the property to get.
Returns:
the value of the property

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws UnauthorizedException
Description copied from interface: User
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.

Specified by:
setProperty in interface User
Parameters:
name - the name of the property to set.
value - the new value for the property.
Throws:
UnauthorizedException - if not allowed to edit.

deleteProperty

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

Specified by:
deleteProperty in interface User
Parameters:
name - the name of the property to delete.
Throws:
UnauthorizedException - if not allowed to edit.

getPropertyNames

public java.util.Iterator getPropertyNames()
Description copied from interface: User
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);
 }

Specified by:
getPropertyNames in interface User
Returns:
an Iterator for the property names.

getPermissions

public Permissions getPermissions(AuthToken authToken)
Description copied from interface: User
Returns the permissions for the user that correspond to the passed-in AuthToken.

Specified by:
getPermissions in interface User
Parameters:
authToken - the auth token to look up permissions with.

isAuthorized

public boolean isAuthorized(long permissionType)
Description copied from interface: User
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;
.

Specified by:
isAuthorized in interface User
Parameters:
permissionType - the permission to check for.
See Also:
Permissions

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.