org.wandora.modules.usercontrol

Class StaticUserStore

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.usercontrol.StaticUserStore

All Implemented Interfaces:

Module, UserStore

public class StaticUserStore
extends AbstractModule
implements UserStore

A very simple user store which reads user names and passwords and roles straight from the initialisation parameters. Does not support editing users or any other options than password and roles. As such, it's really only useful for rudimentary access control and even then, the passwords are stored in plain. Nevertheless, this can make an easy to set up user store for development which can then later be replaced with something more suitable.

The user data is read from the initialisation variable users. The contents of this is a list of users, each user on its own line. Each user line is of the following format:

 username;0;password;role1,role2,role3
 

The digit 0 is meant to indicate the format of the rest of the line, with the idea that in the future, this class could support more options on each user line. At the moment, this is the only supported format however. The last part may contain any number of roles, separated by commas.

The password is stored in the user object using BasicUserAuthenticator.PASSWORD_KEY as the key.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	userData
private java.util.regex.Pattern	userPattern1
private java.util.regex.Pattern	userPattern2
protected java.util.HashMap<java.lang.String,User>	users

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
StaticUserStore()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<User>	findUsers(java.lang.String key, java.lang.String value) Finds users based on a property value.
java.util.Collection<User>	getAllUsers() Returns a collection of all users.
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
User	getUser(java.lang.String user) Finds a user with a user name.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
protected void	parseUsers(java.lang.String userData)
void	start(ModuleManager manager) Starts the module.

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.modules.Module

isInitialized, isRunning, stop

Field Detail

users

protected java.util.HashMap<java.lang.String,User> users

userData

protected java.lang.String userData

userPattern1

private java.util.regex.Pattern userPattern1

userPattern2

private java.util.regex.Pattern userPattern2

Constructor Detail

StaticUserStore

public StaticUserStore()

Method Detail

parseUsers

protected void parseUsers(java.lang.String userData)

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class AbstractModule

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class AbstractModule

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class AbstractModule

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

getAllUsers

public java.util.Collection<User> getAllUsers()

Description copied from interface: UserStore

Returns a collection of all users. Note that in some cases the collection could be very big, or some implementations may simply not implement this method at all.

Specified by:

getAllUsers in interface UserStore

Returns:

A collection containing all users.

getUser

public User getUser(java.lang.String user)

Description copied from interface: UserStore

Finds a user with a user name.

Specified by:

getUser in interface UserStore

Parameters:

user - The user name.

Returns:

A user object which contains more details about the user, or null if the user is not found.

findUsers

public java.util.Collection<User> findUsers(java.lang.String key,
                                            java.lang.String value)

Description copied from interface: UserStore

Finds users based on a property value. Since there are no uniqueness constraints with any of the properties in general, may return multiple users.

Specified by:

findUsers in interface UserStore

Parameters:

key - The property key used for the search.

value - The value of the property.

Returns:

A collection of users matching the property, or an empty collection if none matched.