org.wandora.modules.usercontrol

Interface UserStore

All Superinterfaces:

Module

All Known Subinterfaces:

ModifyableUserStore

All Known Implementing Classes:

DatabaseUserStore, FileUserStore, StaticUserStore

public interface UserStore
extends Module

The base interface for a UserStore. Has basic methods to retrieve users and nothing else. ModifyableUserStore extends this interface with methods that allow users to be also modified. Any user store which is not modifyable is assumed to be set up and modified by editing some files while the user store is not running.

Author:

olli

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.
User	getUser(java.lang.String user) Finds a user with a user name.

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

getUser

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

Finds a user with a user name.

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

getAllUsers

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

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.

Returns:

A collection containing all users.

Throws:

UserStoreException

findUsers

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

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

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