com.jivesoftware.base.ext
Class SimpleUserAdapter

java.lang.Object
  com.jivesoftware.base.ext.SimpleUserAdapter

All Implemented Interfaces:

IntrospectiveUser, User, Cacheable, java.io.Serializable

public abstract class SimpleUserAdapter
extends java.lang.Object
implements IntrospectiveUser, Cacheable

An abstract adapter class to aid in creating custom user implementations. The "set" methods in this class throw UnsupportedOperationExceptions, which means the external user store will be read-only. You should extend this class to create your own User implementation and only override the methods of interest.

If your user store doesn't support all the fields present in the User interface (such as the name visible and email visible flags), you should use hardcoded values in your implementation or load and store these values from somewhere else.

User objects have "extended properties", which is a way to allow arbitrary data to be attached to users. It's generally advisable to use the jiveUserProp table that is built into the Jive database schema to store this information. This adapter class implements all the logic necessary to load and store properties from the jiveUserProp database table.

Important note: any extensions of this class must be Serializable, or clustering will not work correctly.

See Also:

Serialized Form

Field Summary

protected java.util.Date	creationDate The date the user was created.
protected java.lang.String	email The user's email address.
protected boolean	emailVisible Flag to indicate whether the user's email address should be visible to other users.
protected long	ID The user ID.
protected java.util.Date	modificationDate The date the user was last modified.
protected java.lang.String	name The user's full name.
protected boolean	nameVisible Flag to indicate whether the user's name should be visible to other users.
protected java.util.Map	properties Map of extended user properties.
protected java.lang.String	username The username.

Constructor Summary

SimpleUserAdapter()

Method Summary

void	deleteProperty(java.lang.String name) Deletes an extended property.
boolean	equals(java.lang.Object object)
int	getCachedSize() Returns the approximate size of the Object in bytes.
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.
int	hashCode()
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	isGetPasswordHashSupported() Indicates whether retrieving a password hash is supported for this user.
boolean	isNameVisible() Returns true if the user has chosen to make her name visible to other users.
boolean	isSetEmailSupported() Indicates whether setting the email address is supported for this user.
boolean	isSetEmailVisibleSupported() Indicates whether setting the visibility of the email address is supported for this user.
boolean	isSetNameSupported() Indicates whether setting the full name is supported for this user.
boolean	isSetNameVisibleSupported() Indicates whether setting the visibility of the name is supported for this user.
boolean	isSetPasswordHashSupported() Indicates whether modifying the hash of the user's password is supported for this user.
boolean	isSetPasswordSupported() Indicates whether modifying the user's password is supported.
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.jivesoftware.base.IntrospectiveUser

isPropertyEditSupported, isReadOnly

Field Detail

ID

protected long ID

The user ID.

username

protected java.lang.String username

The username.

name

protected java.lang.String name

The user's full name.

email

protected java.lang.String email

The user's email address.

nameVisible

protected boolean nameVisible

Flag to indicate whether the user's name should be visible to other users. This value is true by default.

emailVisible

protected boolean emailVisible

Flag to indicate whether the user's email address should be visible to other users. This value is false by default.

creationDate

protected java.util.Date creationDate

The date the user was created.

modificationDate

protected java.util.Date modificationDate

The date the user was last modified.

properties

protected java.util.Map properties

Map of extended user properties. By default, user properties are fully managed by the SimpleUserAdapater class and are stored in the jiveUserProp database table. Extensions of this class should only modify properties if they wish to store properties in some other location.

Constructor Detail

SimpleUserAdapter

public SimpleUserAdapter()

Method Detail

isSetPasswordSupported

public boolean isSetPasswordSupported()

Description copied from interface: IntrospectiveUser

Indicates whether modifying the user's password is supported.

Specified by:

isSetPasswordSupported in interface IntrospectiveUser

Returns:

true if modifying the user's password is supported.

isGetPasswordHashSupported

public boolean isGetPasswordHashSupported()

Description copied from interface: IntrospectiveUser

Indicates whether retrieving a password hash is supported for this user.

Specified by:

isGetPasswordHashSupported in interface IntrospectiveUser

Returns:

true if you can retrieve a password hash.

isSetPasswordHashSupported

public boolean isSetPasswordHashSupported()

Description copied from interface: IntrospectiveUser

Indicates whether modifying the hash of the user's password is supported for this user.

Specified by:

isSetPasswordHashSupported in interface IntrospectiveUser

Returns:

true if setting the hash is supported.

isSetNameSupported

public boolean isSetNameSupported()

Description copied from interface: IntrospectiveUser

Indicates whether setting the full name is supported for this user.

Specified by:

isSetNameSupported in interface IntrospectiveUser

Returns:

true if setting the name is supported.

isSetEmailSupported

public boolean isSetEmailSupported()

Description copied from interface: IntrospectiveUser

Indicates whether setting the email address is supported for this user.

Specified by:

isSetEmailSupported in interface IntrospectiveUser

Returns:

true if setting the email is supported.

isSetNameVisibleSupported

public boolean isSetNameVisibleSupported()

Description copied from interface: IntrospectiveUser

Indicates whether setting the visibility of the name is supported for this user.

Specified by:

isSetNameVisibleSupported in interface IntrospectiveUser

Returns:

true if setting the name visibility flag is supported.

isSetEmailVisibleSupported

public boolean isSetEmailVisibleSupported()

Description copied from interface: IntrospectiveUser

Indicates whether setting the visibility of the email address is supported for this user.

Specified by:

isSetEmailVisibleSupported in interface IntrospectiveUser

Returns:

true if setting the email visibility flag is supported.

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.

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)

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.

setPassword

public void setPassword(java.lang.String password)

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.

getPasswordHash

public java.lang.String getPasswordHash()

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.

setPasswordHash

public void setPasswordHash(java.lang.String passwordHash)

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.

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)

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.

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.

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.

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

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.

getCachedSize

public int getCachedSize()

Description copied from interface: Cacheable

Returns the approximate size of the Object in bytes. The size should be considered to be a best estimate of how much memory the Object occupies and may be based on empirical trials or dynamic calculations.

Specified by:

getCachedSize in interface Cacheable

Returns:

the size of the Object in bytes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object