Package org.apache.fulcrum.security.hibernate

Class HibernateUserManagerImpl

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.fulcrum.security.spi.AbstractManager

org.apache.fulcrum.security.spi.AbstractEntityManager

org.apache.fulcrum.security.spi.AbstractUserManager

org.apache.fulcrum.security.hibernate.HibernateUserManagerImpl

All Implemented Interfaces:

Serializable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.thread.ThreadSafe, UserManager

public class HibernateUserManagerImpl
extends AbstractUserManager

This implementation persists to a database via Hibernate.

Version:

$Id$

Author:

Eric Pugh

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.fulcrum.security.spi.AbstractManager

manager

Fields inherited from interface org.apache.fulcrum.security.UserManager

ROLE

Constructor Summary

Constructors

Constructor	Description
HibernateUserManagerImpl()

Method Summary

Modifier and Type	Method	Description
boolean	checkExists(String userName)	Check whether a specified user's account exists.
UserSet	getAllUsers()	Retrieves all users defined in the system.
PersistenceHelper	getPersistenceHelper()
User	getUser(String userName)	Retrieve a user from persistent storage using username as the key.
User	getUserById(Object id)	Retrieve a User object with specified id.
User	persistNewUser(User user)	Creates new user account with specified attributes.
void	removeUser(User user)	Removes an user account from the system.
void	saveUser(User user)	Stores User attributes.

Methods inherited from class org.apache.fulcrum.security.spi.AbstractUserManager

addUser, authenticate, changePassword, checkExists, forcePassword, getACL, getACLFactory, getUser, getUserInstance, getUserInstance

Methods inherited from class org.apache.fulcrum.security.spi.AbstractEntityManager

configure, getClassName, setClassName

Methods inherited from class org.apache.fulcrum.security.spi.AbstractManager

dispose, getGroupManager, getPermissionManager, getRoleManager, getServiceManager, getUserManager, release, resolve, service

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

Constructor Detail

HibernateUserManagerImpl

public HibernateUserManagerImpl()

Method Detail

checkExists

public boolean checkExists(String userName)
                    throws DataBackendException

Check whether a specified user's account exists. The login name is used for looking up the account.

Parameters:

userName - The name of the user to be checked.

Returns:

true if the specified account exists

Throws:

DataBackendException - if there was an error accessing the data backend.

getUser

public User getUser(String userName)
             throws UnknownEntityException,
                    DataBackendException

Retrieve a user from persistent storage using username as the key.

Specified by:

getUser in interface UserManager

Overrides:

getUser in class AbstractUserManager

Parameters:

userName - the name of the user.

Returns:

an User object.

Throws:

UnknownEntityException - if the user's account does not exist in the database.

DataBackendException - if there is a problem accessing the storage.

getAllUsers

public UserSet getAllUsers()
                    throws DataBackendException

Retrieves all users defined in the system.

Returns:

the names of all users defined in the system.

Throws:

DataBackendException - if there was an error accessing the data backend.

removeUser

public void removeUser(User user)
                throws DataBackendException,
                       UnknownEntityException

Removes an user account from the system.

Parameters:

user - the object describing the account to be removed.

Throws:

DataBackendException - if there was an error accessing the data backend.

UnknownEntityException - if the user account is not present.

persistNewUser

public User persistNewUser(User user)
                    throws DataBackendException

Creates new user account with specified attributes.

Specified by:

persistNewUser in class AbstractUserManager

Parameters:

user - the object describing account to be created.

Returns:

a User object

Throws:

DataBackendException - if there was an error accessing the data backend.

saveUser

public void saveUser(User user)
              throws DataBackendException,
                     UnknownEntityException

Stores User attributes. The User is required to exist in the system.

Parameters:

user - The User to be stored.

Throws:

DataBackendException - if there was an error accessing the data backend.

UnknownEntityException - if the role does not exist.

getPersistenceHelper

public PersistenceHelper getPersistenceHelper()

Returns:

Returns the persistenceHelper.

getUserById

public User getUserById(Object id)
                 throws DataBackendException,
                        UnknownEntityException

Retrieve a User object with specified id.

Specified by:

getUserById in interface UserManager

Overrides:

getUserById in class AbstractUserManager

Parameters:

id - the id of the User.

Returns:

an object representing the User with specified id.

Throws:

DataBackendException - if there was an error accessing the data backend.

UnknownEntityException - if the user does not exist.