org.wandora.modules.usercontrol

Class DatabaseUserStore

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.usercontrol.DatabaseUserStore

All Implemented Interfaces:

Module, ModifyableUserStore, UserStore

public class DatabaseUserStore
extends AbstractModule
implements ModifyableUserStore

A user store which stores users in a relational database. Needs a module implementing the DatabaseInterface to work. The user data is stored in three tables, which need to be created beforehand. Following sql script will generate the tables on MySQL, you may need to adjust it slightly for other database systems.

create table USERS(
  ID bigint AUTO_INCREMENT primary key,
  USERNAME varchar(256) not null collate utf8_bin
);
 
create table USER_ROLES(
  USERID bigint not null references USERS(ID),
  ROLE varchar(256) not null collate utf8_bin
);
 
create table USER_PROPS(
  USERID bigint not null references USERS(ID),
  PROPKEY varchar(256) not null collate utf8_bin,
  PROPVALUE varchar(2048) collate utf8_bin
);

You may prefix each table with a prefix of your choosing. Specify it in the initialisation parameters with tablePrefix.

Any changes to the user store are immediately stored in the database when saveUser is called.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DatabaseUserStore.DBUser

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseInterface	database
private java.lang.Object	modifyLock
protected java.lang.String	tablePrefix
protected java.util.HashMap<java.lang.String,DatabaseUserStore.DBUser>	users

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
DatabaseUserStore()

Method Summary

Modifier and Type	Method and Description
protected boolean	commitDeleteUser(java.lang.String userName)
protected DatabaseUserStore.DBUser	commitNewUser(java.lang.String userName)
protected boolean	commitUser(DatabaseUserStore.DBUser user)
boolean	deleteUser(java.lang.String user) Deletes a user from this user store.
protected void	fetchUsers()
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.
protected void	handleSQLException(java.sql.SQLException sqle)
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
User	newUser(java.lang.String user) Creates a new user in the user store.
boolean	saveUser(User user) Saves a user which originates from this database.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, 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

Field Detail

tablePrefix

protected java.lang.String tablePrefix

database

protected DatabaseInterface database

users

protected final java.util.HashMap<java.lang.String,DatabaseUserStore.DBUser> users

modifyLock

private final java.lang.Object modifyLock

Constructor Detail

DatabaseUserStore

public DatabaseUserStore()

Method Detail

handleSQLException

protected void handleSQLException(java.sql.SQLException sqle)
                           throws UserStoreException

Throws:

UserStoreException

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

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class AbstractModule

Parameters:

manager - The module manager handling this module.

deleteUser

public boolean deleteUser(java.lang.String user)
                   throws UserStoreException

Description copied from interface: ModifyableUserStore

Deletes a user from this user store.

Specified by:

deleteUser in interface ModifyableUserStore

Parameters:

user - The user name of the user to delete.

Returns:

True if the operation succeeded.

Throws:

UserStoreException

newUser

public User newUser(java.lang.String user)
             throws UserStoreException

Description copied from interface: ModifyableUserStore

Creates a new user in the user store. More information about the user can then be added using the returned user object. Will throw an exception if a user with that name already exists, or if the user cannot be created for any other reason.

Specified by:

newUser in interface ModifyableUserStore

Parameters:

user - The user name of the new user.

Returns:

A user object representing the new user.

Throws:

UserStoreException

saveUser

public boolean saveUser(User user)
                 throws UserStoreException

Description copied from interface: ModifyableUserStore

Saves a user which originates from this database. Note that you cannot give just any user object, the parameter must be a user object you originally got from this user store. Use getUser to get an existing user or newUser to create a new one.

Specified by:

saveUser in interface ModifyableUserStore

Parameters:

user - The user object to save.

Returns:

True if the operation succeeded.

Throws:

UserStoreException

findUsers

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

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.

Throws:

UserStoreException

fetchUsers

protected void fetchUsers()
                   throws UserStoreException

Throws:

UserStoreException

commitUser

protected boolean commitUser(DatabaseUserStore.DBUser user)
                      throws UserStoreException

Throws:

UserStoreException

commitDeleteUser

protected boolean commitDeleteUser(java.lang.String userName)
                            throws UserStoreException

Throws:

UserStoreException

commitNewUser

protected DatabaseUserStore.DBUser commitNewUser(java.lang.String userName)
                                          throws UserStoreException

Throws:

UserStoreException

getAllUsers

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

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.

Throws:

UserStoreException

getUser

public User getUser(java.lang.String user)
             throws UserStoreException

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.

Throws:

UserStoreException