org.wandora.modules.usercontrol

Interface ModifyableUserStore

All Superinterfaces:

Module, UserStore

All Known Implementing Classes:

DatabaseUserStore, FileUserStore

public interface ModifyableUserStore
extends UserStore

An interface that adds to the basic UserBase interface methods which allow users to be modified.

Author:

olli

Method Summary

Modifier and Type	Method and Description
boolean	deleteUser(java.lang.String user) Deletes a user from this user store.
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.

Methods inherited from interface org.wandora.modules.usercontrol.UserStore

findUsers, getAllUsers, getUser

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

newUser

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

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.

Parameters:

user - The user name of the new user.

Returns:

A user object representing the new user.

Throws:

UserStoreException

saveUser

boolean saveUser(User user)
          throws UserStoreException

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.

Parameters:

user - The user object to save.

Returns:

True if the operation succeeded.

Throws:

UserStoreException

deleteUser

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

Deletes a user from this user store.

Parameters:

user - The user name of the user to delete.

Returns:

True if the operation succeeded.

Throws:

UserStoreException