org.wandora.modules.usercontrol

Class SimpleUser

java.lang.Object

org.wandora.modules.usercontrol.User

org.wandora.modules.usercontrol.SimpleUser

Direct Known Subclasses:

DatabaseUserStore.DBUser

public class SimpleUser
extends User

A basic user implementation. Implements all the methods of the abstract base class. Roles and options are stored in memory in a simple ArrayList and a HashMap, respectively.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changed
protected java.util.HashMap<java.lang.String,java.lang.String>	options
protected java.util.ArrayList<java.lang.String>	roles
protected java.lang.String	userName
protected UserStore	userStore

Constructor Summary

Constructors

Constructor and Description
SimpleUser()
SimpleUser(java.lang.String userName)
SimpleUser(java.lang.String userName, java.util.HashMap<java.lang.String,java.lang.String> options, java.util.ArrayList<java.lang.String> roles)
SimpleUser(java.lang.String userName, java.util.HashMap<java.lang.String,java.lang.String> options, java.util.ArrayList<java.lang.String> roles, UserStore userStore)

Method Summary

Modifier and Type	Method and Description
void	addRole(java.lang.String role) Adds a role to this user.
SimpleUser	duplicate()
java.lang.String	getOption(java.lang.String optionKey) Gets one of the stored options.
java.util.Collection<java.lang.String>	getOptionKeys() Gets all stored option keys.
java.util.HashMap<java.lang.String,java.lang.String>	getOptions()
java.util.Collection<java.lang.String>	getRoles() Gets all the roles this user belongs to.
java.lang.String	getUserName() Gets the user name.
UserStore	getUserStore()
boolean	isChanged()
void	removeOption(java.lang.String optionKey) Removes a stored option from the options map.
void	removeRole(java.lang.String role) Removes a role from this user.
void	resetChanged()
boolean	saveUser() Saves any changes made to the user into the persistent user store where this user object originally came from.
void	setOption(java.lang.String optionKey, java.lang.String value) Sets a stored option.
void	setOptions(java.util.HashMap<java.lang.String,java.lang.String> options)
void	setRoles(java.util.Collection<java.lang.String> roles)
void	setUserName(java.lang.String s)
void	setUserStore(UserStore userStore)

Methods inherited from class org.wandora.modules.usercontrol.User

isOfRole

Methods inherited from class java.lang.Object

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

Field Detail

userName

protected java.lang.String userName

options

protected java.util.HashMap<java.lang.String,java.lang.String> options

roles

protected java.util.ArrayList<java.lang.String> roles

changed

protected boolean changed

userStore

protected UserStore userStore

Constructor Detail

SimpleUser

public SimpleUser()

SimpleUser

public SimpleUser(java.lang.String userName)

SimpleUser

public SimpleUser(java.lang.String userName,
                  java.util.HashMap<java.lang.String,java.lang.String> options,
                  java.util.ArrayList<java.lang.String> roles)

SimpleUser

public SimpleUser(java.lang.String userName,
                  java.util.HashMap<java.lang.String,java.lang.String> options,
                  java.util.ArrayList<java.lang.String> roles,
                  UserStore userStore)

Method Detail

setUserName

public void setUserName(java.lang.String s)

getUserName

public java.lang.String getUserName()

Description copied from class: User

Gets the user name.

Specified by:

getUserName in class User

Returns:

The user name.

getOptions

public java.util.HashMap<java.lang.String,java.lang.String> getOptions()

getOptionKeys

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

Description copied from class: User

Gets all stored option keys.

Specified by:

getOptionKeys in class User

Returns:

A collection containing all stored option keys.

setOptions

public void setOptions(java.util.HashMap<java.lang.String,java.lang.String> options)

removeOption

public void removeOption(java.lang.String optionKey)

Description copied from class: User

Removes a stored option from the options map.

Specified by:

removeOption in class User

Parameters:

optionKey - The key of the stored option to remove.

getOption

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

Description copied from class: User

Gets one of the stored options.

Specified by:

getOption in class User

Parameters:

optionKey - The key of the property.

Returns:

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

setRoles

public void setRoles(java.util.Collection<java.lang.String> roles)

getRoles

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

Description copied from class: User

Gets all the roles this user belongs to.

Specified by:

getRoles in class User

Returns:

A collection of role identifiers.

addRole

public void addRole(java.lang.String role)

Description copied from class: User

Adds a role to this user.

Specified by:

addRole in class User

Parameters:

role - The role to add.

removeRole

public void removeRole(java.lang.String role)

Description copied from class: User

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

Specified by:

removeRole in class User

Parameters:

role - The role to remove.

setOption

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

Description copied from class: User

Sets a stored option.

Specified by:

setOption in class User

Parameters:

optionKey - The option key.

value - The value of the option.

resetChanged

public void resetChanged()

isChanged

public boolean isChanged()

saveUser

public boolean saveUser()
                 throws UserStoreException

Description copied from class: User

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

Specified by:

saveUser in class User

Returns:

True if the saving succeeded, false otherwise.

Throws:

UserStoreException

getUserStore

public UserStore getUserStore()

setUserStore

public void setUserStore(UserStore userStore)

duplicate

public SimpleUser duplicate()