org.apache.lenya.ac.file
Class FileUserManager

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.lenya.ac.file.FileItemManager
          extended by org.apache.lenya.ac.file.FileUserManager
All Implemented Interfaces:
org.apache.avalon.framework.logger.LogEnabled, org.apache.lenya.ac.ItemManager, org.apache.lenya.ac.UserManager

public class FileUserManager
extends FileItemManager
implements org.apache.lenya.ac.UserManager

File-based user manager implementation.

Version:
$Id: FileUserManager.java 485769 2006-12-11 17:41:23Z andreas $

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.lenya.ac.file.FileItemManager
FileItemManager.DirectoryChangeNotifier
 
Field Summary
protected static java.lang.String SUFFIX
           
 
Method Summary
 void add(org.apache.lenya.ac.User user)
           
protected  java.lang.String getSuffix()
          Returns the file extension to be used.
 org.apache.lenya.ac.User getUser(java.lang.String userId)
          Get the user with the given user id.
 org.apache.lenya.ac.User[] getUsers()
          Get all users.
 org.apache.lenya.ac.UserType[] getUserTypes()
           
static FileUserManager instance(org.apache.lenya.ac.AccreditableManager mgr, java.io.File configurationDirectory, org.apache.lenya.ac.UserType[] userTypes, org.apache.avalon.framework.logger.Logger logger)
          Describe instance method here.
 void remove(org.apache.lenya.ac.User user)
           
 
Methods inherited from class org.apache.lenya.ac.file.FileItemManager
add, addItemManagerListener, configure, contains, getAccreditableManager, getConfigurationDirectory, getFileFilter, getItem, getItemConfiguration, getItems, loadItem, loadItems, notifyAdded, notifyRemoved, remove, removeItem, removeItemManagerListener, update
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.lenya.ac.ItemManager
addItemManagerListener, getAccreditableManager, removeItemManagerListener
 

Field Detail

SUFFIX

protected static final java.lang.String SUFFIX
See Also:
Constant Field Values
Method Detail

instance

public static FileUserManager instance(org.apache.lenya.ac.AccreditableManager mgr,
                                       java.io.File configurationDirectory,
                                       org.apache.lenya.ac.UserType[] userTypes,
                                       org.apache.avalon.framework.logger.Logger logger)
                                throws org.apache.lenya.ac.AccessControlException
Describe instance method here.

Parameters:
mgr - The accreditable manager.
configurationDirectory - a directory
userTypes - The supported user types.
logger - The logger.
Returns:
an UserManager value
Throws:
org.apache.lenya.ac.AccessControlException - if an error occurs

getUsers

public org.apache.lenya.ac.User[] getUsers()
Get all users.

Specified by:
getUsers in interface org.apache.lenya.ac.UserManager
Returns:
an Iterator to iterate over all users

add

public void add(org.apache.lenya.ac.User user)
         throws org.apache.lenya.ac.AccessControlException
Specified by:
add in interface org.apache.lenya.ac.UserManager
Throws:
org.apache.lenya.ac.AccessControlException
See Also:
UserManager.add(org.apache.lenya.ac.User)

remove

public void remove(org.apache.lenya.ac.User user)
            throws org.apache.lenya.ac.AccessControlException
Specified by:
remove in interface org.apache.lenya.ac.UserManager
Throws:
org.apache.lenya.ac.AccessControlException
See Also:
UserManager.remove(org.apache.lenya.ac.User)

getUser

public org.apache.lenya.ac.User getUser(java.lang.String userId)
Get the user with the given user id.

Specified by:
getUser in interface org.apache.lenya.ac.UserManager
Parameters:
userId - user id of requested user
Returns:
the requested user or null if there is no user with the given user id

getUserTypes

public org.apache.lenya.ac.UserType[] getUserTypes()
Specified by:
getUserTypes in interface org.apache.lenya.ac.UserManager
See Also:
UserManager.getUserTypes()

getSuffix

protected java.lang.String getSuffix()
Description copied from class: FileItemManager
Returns the file extension to be used.

Specified by:
getSuffix in class FileItemManager
Returns:
A string.
See Also:
FileItemManager.getSuffix()


Copyright $ Apache Software Foundation. All Rights Reserved.