org.wandora.modules.usercontrol

Class User

java.lang.Object

org.wandora.modules.usercontrol.User

Direct Known Subclasses:

SimpleUser

public abstract class User
extends java.lang.Object

A basis for users. This sets some very basic features all users objects should have. The three main things are: a user name, a set of roles and a set of other options and properties. The user name identifies the user and should be unique. The set of roles are used to specify what types of actions the user is allowed to perform. Everything else is stored in the generic options map, which is a collection of key value pairs.

Note that a password would be stored in the options map. This class does not specify how or with what key it would be stored. That's up to whatever performs user authentication. Some might store it in plain text (usually not a good idea) while some others could use different hashing methods to store it and authenticate a user.

You typically get users from a UserStore. Any changes to the user object can also be saved to the store where the user originally came from with the saveUser method.

Author:

olli

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
abstract void	addRole(java.lang.String role) Adds a role to this user.
abstract java.lang.String	getOption(java.lang.String optionKey) Gets one of the stored options.
abstract java.util.Collection<java.lang.String>	getOptionKeys() Gets all stored option keys.
abstract java.util.Collection<java.lang.String>	getRoles() Gets all the roles this user belongs to.
abstract java.lang.String	getUserName() Gets the user name.
boolean	isOfRole(java.lang.String role) Checks if this user is of a specified role.
abstract void	removeOption(java.lang.String optionKey) Removes a stored option from the options map.
abstract void	removeRole(java.lang.String role) Removes a role from this user.
abstract boolean	saveUser() Saves any changes made to the user into the persistent user store where this user object originally came from.
abstract void	setOption(java.lang.String optionKey, java.lang.String value) Sets a stored option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User()

Method Detail

getUserName

public abstract java.lang.String getUserName()

Gets the user name.

Returns:

The user name.

getOption

public abstract java.lang.String getOption(java.lang.String optionKey)

Gets one of the stored options.

Parameters:

optionKey - The key of the property.

Returns:

The value of the property, or null if it doesn't exist.

getOptionKeys

public abstract java.util.Collection<java.lang.String> getOptionKeys()

Gets all stored option keys.

Returns:

A collection containing all stored option keys.

setOption

public abstract void setOption(java.lang.String optionKey,
                               java.lang.String value)

Sets a stored option.

Parameters:

optionKey - The option key.

value - The value of the option.

removeOption

public abstract void removeOption(java.lang.String optionKey)

Removes a stored option from the options map.

Parameters:

optionKey - The key of the stored option to remove.

getRoles

public abstract java.util.Collection<java.lang.String> getRoles()

Gets all the roles this user belongs to.

Returns:

A collection of role identifiers.

removeRole

public abstract void removeRole(java.lang.String role)

Removes a role from this user. The user will not be part of that role anymore.

Parameters:

role - The role to remove.

addRole

public abstract void addRole(java.lang.String role)

Adds a role to this user.

Parameters:

role - The role to add.

saveUser

public abstract boolean saveUser()
                          throws UserStoreException

Saves any changes made to the user into the persistent user store where this user object originally came from.

Returns:

True if the saving succeeded, false otherwise.

Throws:

UserStoreException

isOfRole

public boolean isOfRole(java.lang.String role)

Checks if this user is of a specified role.

Parameters:

role - The role identifier to check against.

Returns:

True if the user is of the specified role.